ReferenceExtractor parses Ruby files and returns the constants they reference, using your Zeitwerk autoloaders to resolve what lives where. It gives you a graph you can use for architecture rules like layering or dependency checks.
ReferenceExtractor is in prototype stage. It works in general but is not battle tested.
It is based on packwerk.
extractor = ReferenceExtractor::Extractor.new(
autoloaders: Rails.autoloaders,
root_path: Rails.root
)
# From a string snippet
extractor.references_from_string("Order.find(1)")
# => [#<ReferenceExtractor::Reference constant=#<ReferenceExtractor::ConstantContext name=\"::Order\" ...>>]
# From a file relative to root_path
extractor.references_from_file("app/models/user.rb")
# => [#<ReferenceExtractor::Reference ...>, ...]After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 the created tag, and push the .gem file to rubygems.org.
-
Update the version in
lib/reference_extractor/version.rb. Push / merge to main. -
Build the gem:
gem build reference_extractor.gemspec
This should produce
reference_extractor-<version>.gem. -
Sign in to RubyGems (only needed once):
gem signin
-
Push the built gem:
gem push reference_extractor-<version>.gem
-
Tag the release:
git tag v<version> && git push origin v<version>
Bug reports and pull requests are welcome on GitHub at https://github.com/exterm/reference_extractor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the ReferenceExtractor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.