Fix enum writers when using integers #13542
Merged
Conversation
This file contains 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
| @@ -62,7 +67,7 @@ def enum(definitions) | |||
| _enum_methods_module.module_eval do | |||
| # def status=(value) self[:status] = STATUS[value] end | |||
| define_method("#{name}=") { |value| | |||
| unless enum_values.has_key?(value) | |||
| if !enum_values.has_key?(value) && !enum_values.has_value?(value) | |||
There was a problem hiding this comment.
we can change this to unless (enum_values.has_key?(value) && enum_values.has_value?(value))
to avoid double negation.
There was a problem hiding this comment.
Sorry, I should revert it back, the other tests fail if we change this.
There was a problem hiding this comment.
De Morgan's law is your friend :)
This would be !(enum_values.has_key?(value) || enum_values.has_value?(value)) but I actually prefer the version you have now anyway - much easy to read and hurts my brain less.
There was a problem hiding this comment.
Nvm! That's basically the same thing @vipulnsward said :P (Every time I read unless x && y || z ... my head still hurts a little)
|
Thanks for your feedback @vipulnsward, updated! |
Previously, the writer methods would simply check whether the passed argument was the symbol representing the integer value of an enum field. Therefore, it was not possible to specify the numeric value itself but the dynamically defined scopes generate where clauses relying on this kind of values so a chained call to a method like `find_or_initialize_by` would trigger an `ArgumentError`. Reference #13530
Add a mention about the automatic generation of scopes based on the allowed values of the field on the enum documentation.
rafaelfranca
added a commit
that referenced
this pull request
Jan 1, 2014
Fix enum writers when using integers
chancancode
added a commit
that referenced
this pull request
Jan 3, 2014
Previously, this would give an `ArgumentError`:
class Issue < ActiveRecord::Base
enum :status, [:open, :finished]
end
Issue.open.build # => ArgumentError: '0' is not a valid status
Issue.open.create # => ArgumentError: '0' is not a valid status
PR #13542 muted the error, but the issue remains. This commit fixes
the issue by allowing the enum value to be written directly via the
setter:
Issue.new.status = 0 # This now sets status to :open
Assigning a value directly via the setter like this is not part of the
documented public API, so users should not rely on this behavior.
Closes #13530.
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.
Hello,
This is just a little pull request that resolves some issues mentioned in #13530. Basically, the problem is described in this gist. Previously, a call to:
Would fail (an
ArgumentErrorwould be raised) because only the symbol version of the enum was checked when calling its writer method. I guess thatfind_or_initializeis calling it through theinitialize(new) method.I also added a mention about the scopes generated dynamically based on the allowed values of the field in the documentation.
I'm not really comfortable with Active Record and its internals so I'm certainly not very clear ; therefore, sorry. Let me know if I should update anything.
By the way, the issue mentioned above is not totally resolved since the
wheremethod doesn't generate the same queries with either a symbol or a numeric value on enum fields.Have a nice day.