Cannot annotate model with rails 4.1 enum

[alex88]

Having this model:

class Team < ActiveRecord::Base
  # Gender enumerator
  enum gender: [:male, :female]
  # User ownership association
  belongs_to :owner, class_name: 'User'

  # Validations
  validates :name, :owner, presence: true
end

with a field gender of type integer, trying to annotate it gives:

Unable to annotate team.rb: You tried to define an enum named "gender" on the model "Team", but this will generate a instance method "gender=", which is already defined by another enum.

So I have to remove the enum thing in the model, run the annotation and add it back.

Is there a workaround for this?

[ctran]

I assume this is the same problem as #132 ?

[alex88]

Yeah sorry, let me close this one in favour of the other one

[abinoam]

Hi @alex88,

Answering here because @alex88 is not following the other issue (#132).

I have run into the same bug over here.

I have bypassed it like this...

  enum gender: [:male, :female] unless instance_methods.include? :gender

Try it over there and give me some feedback.

[kevinmccaughey]

What's happening with this issue? IT is closed, but another issue the same was closed referencing this issue. So we have 2 closed issues that are the same show stopping bug in Annotate for Rails 4.1, the current Rails.

Has the gem maybe stopped being updated?

[ctran]

I can't seem to reproduce this under Rails 4.1.1. Maybe there is another gem that caused this conflict?

[alex88]

On rails 4.1.1 with this model team.rb:

class Team < ActiveRecord::Base
  # Followable concern
  include Followable
  # Gender enumerator
  enum gender: [:male, :female]
  # User ownership association
  belongs_to :owner, class_name: 'User'
  ....
end

I get this error:

Unable to annotate team.rb: You tried to define an enum named "gender" on the model "Team", but this will generate a instance method "gender=", which is already defined by another enum.
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/activerecord-4.1.1/lib/active_record/enum.rb:189:in `detect_enum_conflict!'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/activerecord-4.1.1/lib/active_record/enum.rb:93:in `block (2 levels) in enum'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/activerecord-4.1.1/lib/active_record/enum.rb:91:in `module_eval'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/activerecord-4.1.1/lib/active_record/enum.rb:91:in `block in enum'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/activerecord-4.1.1/lib/active_record/enum.rb:82:in `each'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/activerecord-4.1.1/lib/active_record/enum.rb:82:in `enum'
    /Users/alessandro/Sites/project/app/models/team.rb:37:in `<class:Team>'
    /Users/alessandro/Sites/project/app/models/team.rb:33:in `<top (required)>'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/activesupport-4.1.1/lib/active_support/dependencies.rb:247:in `require'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/activesupport-4.1.1/lib/active_support/dependencies.rb:247:in `block in require'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/activesupport-4.1.1/lib/active_support/dependencies.rb:232:in `load_dependency'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/activesupport-4.1.1/lib/active_support/dependencies.rb:247:in `require'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/annotate-2.6.3/lib/annotate/annotate_models.rb:373:in `get_model_class'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/annotate-2.6.3/lib/annotate/annotate_models.rb:418:in `annotate_model_file'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/annotate-2.6.3/lib/annotate/annotate_models.rb:407:in `block in do_annotations'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/annotate-2.6.3/lib/annotate/annotate_models.rb:406:in `each'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/annotate-2.6.3/lib/annotate/annotate_models.rb:406:in `do_annotations'
    /usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/annotate-2.6.3/bin/annotate:148:in `<top (required)>'
    /usr/local/var/rbenv/versions/2.1.2/bin/annotate:23:in `load'
    /usr/local/var/rbenv/versions/2.1.2/bin/annotate:23:in `<main>'

Line 33 is the class definition and line 37 is this:

enum gender: [:male, :female]

[kevinmccaughey]

Um, you did put enum in, yes? Feel free to slap me, but just checking even though it might seem obvious.

I can contribute source if you still can't find it with the above example. Also using Rails 4.1.1

[ctran]

Yes, I did (see https://github.com/ctran/annotate_models/blob/develop/spec/integration/rails_4.1.1/app/models/task.rb). I suspect that another gem is causing the issue. Can you help narrow down the gems until the problem goes away?

[kevinmccaughey]

Can I put forward a likely candidate before I get a chance (at work now) to test this? I think it might be due to an interaction with Devise, as that is what created the model with enum in it. I did check the syntax and it's fine. Will try turning off gems when I get home.

[SimonKaluza]

I'm experiencing this issue without Devise.

[benatkin]

Also getting this issue. Not using Devise. I get more value out of annotate than I do out of enum so I just replaced my enum with a couple of methods.