Add fromSavedState handle method to generated nav args#122
Closed
simonschiller wants to merge 4 commits intoandroidx:androidx-mainfrom
Closed
Add fromSavedState handle method to generated nav args#122simonschiller wants to merge 4 commits intoandroidx:androidx-mainfrom
simonschiller wants to merge 4 commits intoandroidx:androidx-mainfrom
Conversation
danysantiago
requested changes
Jan 22, 2021
Member
danysantiago
left a comment
There was a problem hiding this comment.
Thanks for making this PR!
| addStatement("return $N", result) | ||
| }.build() | ||
|
|
||
| val fromSavedStateHandleMethod = MethodSpec.methodBuilder("fromSavedStateHandle").apply { |
Member
There was a problem hiding this comment.
There is a lot of shared code between this method spec and fromBundleMethod, lets try to combine it by creating a local function with the common code and then invoking it with the distinct, something like this:
fun MethodSpec.Builder.commonFromArgGetCode(
fromVariableName: String,
resultVariableName: String,
arg: Argument,
argGetBlock: MethodSpec.Builder.() -> Unit
) {
beginControlFlow("if ($N.contains($S))", fromVariableName, arg.name).apply {
argGetBlock()
addNullCheck(arg, arg.sanitizedName)
addStatement(
"$resultVariableName.$N.put($S, $N)",
specs.hashMapFieldSpec,
arg.name,
arg.sanitizedName
)
}
if (arg.defaultValue == null) {
nextControlFlow("else")
addStatement(
"throw new $T($S)", java.lang.IllegalArgumentException::class.java,
"Required argument \"${arg.name}\" is missing and does " +
"not have an android:defaultValue"
)
} else {
nextControlFlow("else")
addStatement(
"$resultVariableName.$N.put($S, $L)",
specs.hashMapFieldSpec,
arg.name,
arg.defaultValue.write()
)
}
endControlFlow()
}
then you can use it like this:
val fromSavedStateHandleMethod = MethodSpec.methodBuilder("fromSavedStateHandle").apply {
addAnnotation(annotations.NONNULL_CLASSNAME)
addModifiers(Modifier.PUBLIC, Modifier.STATIC)
addAnnotation(specs.suppressAnnotationSpec)
val savedStateHandle = "savedStateHandle"
addParameter(
ParameterSpec.builder(SAVED_STATE_HANDLE_CLASSNAME, savedStateHandle)
.addAnnotation(specs.androidAnnotations.NONNULL_CLASSNAME)
.build()
)
returns(className)
val result = "__result"
addStatement("$T $N = new $T()", className, result, className)
args.forEach { arg ->
commonFromArgGetCode(
fromVariableName = savedStateHandle,
resultVariableName = result,
arg= arg
) {
addStatement("$T $N", arg.type.typeName(), arg.sanitizedName)
addStatement("$N = $N.get($S)", arg.sanitizedName, savedStateHandle, arg.name)
}
}
addStatement("return $N", result)
}.build()
Contributor
Author
There was a problem hiding this comment.
Done for the JavaNavWriter.
I also checked the KotlinNavWriter and the only thing that could make sense here is the else branch where we read default values, but given that it's only ~7 lines I'd keep it duplicated because I think it makes it more readable that way.
| addStatement("$T $N = new $T()", className, result, className) | ||
| args.forEach { arg -> | ||
| beginControlFlow("if ($N.contains($S))", savedStateHandle, arg.name).apply { | ||
| addStatement("$T $N", arg.type.typeName(), arg.sanitizedName) |
Member
There was a problem hiding this comment.
Looks like the variable declaration and initialization can be done in the same statement
Contributor
Author
There was a problem hiding this comment.
Not anymore with the newest changes using the common addReadSingleArgBlock function 😄
jbw0033
approved these changes
Jan 25, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed Changes
fromSavedStatemethod for all nav args classes, similar to thefromBundleone.Testing
Test: Adapted existing tests to also include the new method
Issues Fixed
Fixes: 136967621