Open
Conversation
| module Krypto | ||
| class Challenge | ||
| def self.generate(signing_key, challenge_id, challenge_data, request_data, timestamp: Time.now) | ||
| def self.generate(signing_key, challenge_id, challenge_data, request_data, timestamp = Time.now) |
Contributor
There was a problem hiding this comment.
Idiomatically, I'm thinking about this as having 4 required arguments, and then 1 optional timestamp. Potentially, in the future, there may be more optional arguments. Knowing that, do you want to move timestamp to positional?
Author
There was a problem hiding this comment.
Knowing that I would expect the method to look something like this
def self.generate(signing_key, challenge_id, challenge_data, request_data, **options)
options = { timestamp: Time.now.utc.to_i }.merge(options)
...
endor
def self.generate(signing_key:, challenge_id:, challenge_data:, request_data:, **options)
options = { timestamp: Time.now.utc.to_i }.merge(options)
...
endbut I don't think this 2nd one is Ruby 1.9 compatible.
Contributor
There was a problem hiding this comment.
I'm not sure we need ruby 1.9.
I think timestamp: Time.now gives us a better path to get to **options.
Thinking about it, I'm uncomfortable with optional positional arguments. I'd suggest moving to all named style, or leaving as is.
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
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.
#generate()uses positional arguments for everything but the lasttimestampkeyword argument. This change is more for consistency.Mixing positional and keyword arguments is normal. This method already has 4 existing positional arguments in front of this one which forces callers to reason more about how to use this method when the last argument is suddenly a keyword. 1
Footnotes
Another, arguably more expandable, approach would be a
**optionssplat and passtimestampin a hash. ↩