Low commit activity in last 3 years
No release in over a year
Introspect methods, parameters, class macros, and constants without loading a parent class or any other dependencies.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.3
~> 10.0
~> 3.3

Runtime

>= 3.1.2.0
~> 0.4.9
 Project Readme

Dissociated Introspection

Build Status Code Climate Test Coverage

Introspect methods, parameters, class macros, and constants without loading a parent class or any other dependencies.

Installation

Add this line to your application's Gemfile:

gem 'dissociated_introspection'

And then execute:

$ bundle

Or install it yourself as:

$ gem install dissociated_introspection

Usage

Static Analysis

ruby_class_as_str <<-RUBY
  class A < B::C
    def method1(arg)
    end
  end
RUBY

ruby_class = DissociatedIntrospection::RubyClass.new(source: ruby_class_as_str)
ruby_class.class_name
    # => "A" 
    
ruby_class.parent_class_name
    # => "B::C"
    
new_ruby_class = ruby_class.modify_parent_class(:C)
new_ruby_class.parent_class_name
    # => "C"
    
new_ruby_class.source
    # => "class A < C\n  def method\n  end\nend"
    
ruby_class.defs.first.name
    # => :method1

ruby_class.defs.first.arguments
    # => "arg"

Sandboxed Analysis

# app/model/user.rb
class User < ActiveRecord::Base
  attr_accessor :baz
  scope :recent_users, -> { 'some SQL' }
  include UserHelpers
  def display_name
    "#{first_name} #{last_name}"
  end
end

ActiveRecord does not need to be loaded, it will be replaced with an alternate.

inspection = DissociatedIntrospection::Inspection.new(file: user_model_file)

inspection.class_macros
    # => [{ attr_accessor: [[:baz]]},
          { scope: [[:recent_users], #<Proc:0x0> ] },
          { include: [[#<Module:0x0>]]}]
          
inspection.missing_constants
    # => { UserHelpers: #<Module:0x0> }
    
# Removes meta-programmed methods from ActiveRecord
inspection.get_class.instance_methods(false)
    # => [ :method1 ]

Other methods

  • DissociatedIntrospection::Inspection#extended_modules
  • DissociatedIntrospection::Inspection#included_modules
  • DissociatedIntrospection::Inspection#prepend_modules
  • DissociatedIntrospection::Inspection#locally_defined_constants

Development

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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/dissociated_introspection/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request