Add check_default_type!
#569
Merged
+53
−11
Conversation
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
matthewd
reviewed
Jul 6, 2017
lib/thor/base.rb
Outdated
| @@ -151,6 +151,21 @@ def check_unknown_options?(config) #:nodoc: | |||
| !!check_unknown_options | |||
| end | |||
|
|
|||
| # If you want to raise an error when the default value of an option does not match | |||
| # the type call check_default_type! | |||
| # This is disabled by default. | |||
CHANGELOG.md
Outdated
| @@ -1,4 +1,7 @@ | |||
| ## 0.20.0 | |||
| * Add `check_default_type!` to check if the deafault value of an option matches the defined type. | |||
| It removes the warning on usage and give the command authors the posibility to check for programing erros. | |||
There was a problem hiding this comment.
Few typos in here: default, possibility, errors
lib/thor/parser/option.rb
Outdated
| @@ -4,13 +4,14 @@ class Option < Argument #:nodoc: | |||
|
|
|||
| VALID_TYPES = [:boolean, :numeric, :hash, :array, :string] | |||
|
|
|||
| def initialize(name, options = {}) | |||
| def initialize(name, options = {}, check_default_type = false) | |||
There was a problem hiding this comment.
Should this be passed in options?
There was a problem hiding this comment.
Sounds like options is where it belongs, yeah.
andremedeiros
suggested changes
Jul 6, 2017
spec/thor_spec.rb
Outdated
| @@ -583,6 +583,24 @@ def unknown(*args) | |||
| expect(klass.start(%w(unknown foo --bar baz))).to eq(%w(foo)) | |||
| end | |||
|
|
|||
| it "does not checks the default type" do | |||
There was a problem hiding this comment.
it "does not check the default type when check_default_type! is not called" do
lib/thor/parser/option.rb
Outdated
| @@ -4,13 +4,14 @@ class Option < Argument #:nodoc: | |||
|
|
|||
| VALID_TYPES = [:boolean, :numeric, :hash, :array, :string] | |||
|
|
|||
| def initialize(name, options = {}) | |||
| def initialize(name, options = {}, check_default_type = false) | |||
There was a problem hiding this comment.
Sounds like options is where it belongs, yeah.
rafaelfranca
force-pushed
the
check_default_type
branch
3 times, most recently
from
bc27d59 to
d015cdc
Compare
|
Fixed all the points |
CHANGELOG.md
Outdated
| @@ -1,4 +1,7 @@ | |||
| ## 0.20.0 | |||
| * Add `check_default_type!` to check if the default value of an option matches the defined type. | |||
| It removes the warning on usage and give the command authors the possibility to check for programming errors. | |||
It check if the default value of an option matches the defined type. This removes the warning on usage since there is no much what the command users could do about it and give the command authors the possibility to check for programming errors.
rafaelfranca
force-pushed
the
check_default_type
branch
from
d015cdc to
52629bd
Compare
matthewd
approved these changes
Jul 6, 2017
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.
It check if the default value of an option matches the defined type.
This removes the warning on usage since there is no much what the command users could do about it and give the command authors the possibility to check for programming errors.