ActiveRecordAnalyzer

ActiveRecordAnalyzer is a lib that gets you information about your ActiveRecord model attributes. You will be able to know whether an attribute is an association or not, and what kind of association.

Add this line to your application's Gemfile:

gem 'active_record_analyzer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install active_record_analyzer

You can analyze your ActiveRecord model with the analyzer:

analyzer = ActiveRecordAnalyzer::Reflector.new(User)

With the analyzer in place, given an attribute's name, you can get its type for the given class (User in the example):

attribute = analyzer.reflect(:name)
attribute.association?      # => false
attribute.simple_attribute? # => true

A Simple Attribute means basically every attribute except of foreign keys.

analyzer.reflect(:name).simple_attribute?       # => true
analyzer.reflect(:created_at).simple_attribute? # => true
analyzer.reflect(:company_id).simple_attribute? # => false
analyzer.reflect(:company).simple_attribute?    # => false
analyzer.reflect(:accounts).simple_attribute?   # => false

An Association means foreign keys and association names.

analyzer.reflect(:name).association?       # => false
analyzer.reflect(:created_at).association? # => false
analyzer.reflect(:company_id).association? # => true
analyzer.reflect(:company).association?    # => true
analyzer.reflect(:accounts).association?   # => true

analyzer.reflect(:company_id).one_to_many? # => true
analyzer.reflect(:company).one_to_many?    # => true
analyzer.reflect(:accounts).one_to_many?   # => false

analyzer.reflect(:company_id).has_many? # => false
analyzer.reflect(:company).has_many?    # => false
analyzer.reflect(:accounts).has_many?   # => true

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_record_analyzer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.