cannot annotate 'acronym classes'

[nbt]

Trying to annotate a class with a string of capital letters such as IRSDocuments in a file named "irs_documents.rb" will fail with the message:

Unable to annotate irs_documents.rb: #<NameError: uninitialized constant IrsDocuments>

• If there is no mechanism to handle this, it should be added
• If there is a mechanism to handle this, please excuse me, and it should be better documented.

[ctran]

What is your Rails application environment (http://localhost:3000/rails/info/properties)?

[nbt]

Ruby version 1.9.2 (x86_64-darwin10.6.0)
RubyGems version 1.3.7
Rack version 1.2
Rails version 3.0.5
Active Record version 3.0.5
Action Pack version 3.0.5
Active Resource version 3.0.5
Action Mailer version 3.0.5
Active Support version 3.0.5
Middleware
ActionDispatch::Static
Rack::Lock
ActiveSupport::Cache::Strategy::LocalCache
Rack::Runtime
Rails::Rack::Logger
ActionDispatch::ShowExceptions
ActionDispatch::RemoteIp
Rack::Sendfile
ActionDispatch::Callbacks
ActiveRecord::ConnectionAdapters::ConnectionManagement
ActiveRecord::QueryCache
ActionDispatch::Cookies
ActionDispatch::Session::CookieStore
ActionDispatch::Flash
ActionDispatch::ParamsParser
Rack::MethodOverride
ActionDispatch::Head
ActionDispatch::BestStandardsSupport
Warden::Manager
Application root /Users/r/Developer/bluedot
Environment development
Database adapter postgresql
Database schema version 20110621161403

[alexeymuranov]

I have probably a related issue. I have models Admin::User and Admin::KnownIP in files models/admin/user.rb and models/admin/known_ip.rb. I also use set_table_name :admin_known_ips in Admin::KnownIP class. The User model gets annotated fine, but not KnownIP, and i get the following message:

$ bundle exec annotate
Unable to annotate admin/known_ip.rb: #<TypeError: nil is not a symbol>
...

[nbt]

bump?

[KL-7]

In my own project I just hacked into the source of the gem to annotate models in CRM module, but I'm seriously thinking about surrendering and renaming it to Crm.

There was a pull request to Rails that added support for acronyms to ActiveSupport::Infrector. I doubt that's possible to use it directly as that will make annotate_models dependent on very high version of active_support, but may be smth similar can be added to the gem itself. Alternatively Infrector can be monkey-patched to work with earlier versions of active_support.

May be I could help with implementation, but I'm not sure what'd be the best interface for that. Should it be just an CLI option that will accept list of acronyms that will be later used to perform replacement in generated class names? Should it be list of words themselves (like xml, crm, etc.) or full class names?

Btw, may be there is a different way to retrieve name of the class defined in some file other than camelizing file name. It'd be nice to find one.

@ctran, care to share your thoughts on that?

[alexeymuranov]

My understanding was that there is no need to retrieve the name of the class from the name of the file, it is the other way around: if a file with a class definition was not explicitly required, then its name is inferred from the name of the class.

[KL-7]

@alexeymuranov, have a look at AnnotateModels.get_model_class method. It's used to retrieve classes from file names passed to annotate command.

[alexeymuranov]

Ok, i see, this is not nice. It would seem more reasonable to me to create some "sandbox" module, inside of it require active_record (with module_eval), then require the files, then see what ActiveRecord::Base classes have been defined and ask them their table names.

[ctran]

This has never been an issue for me so I procrastinated a bit :-).
Let me take a closer look at it this weekend since it seems enough people run into this problem.

[alexeymuranov]

If i may express my thought, there seem to be two approaches possible:

• either annotate_models gem annotates models, in this case probably some kind of ruby environment sandbox is needed so safely execute model files in it to learn model attributes,
• or models annotate themselves with the help of annotate_models gem, then models would be responsible themselves to run nicely.