constant_resolver 0.1.5

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_from:
+  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+  UseCache: true
+  CacheRootDirectory: tmp/rubocop
+
+require: rubocop-performance

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opensource@shopify.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/constant_resolver.

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in constant_resolver.gemspec
+gemspec
+
+group :deployment do
+  gem 'rake'
+end
+
+group :development do
+  gem 'rubocop', '~> 0.75.1', require: false # 0.76 currently not compatible with shopify style guide
+  gem 'rubocop-performance'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Shopify Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# ConstantResolver [![Build Status](https://github.com/Shopify/constant_resolver/workflows/CI/badge.svg)](https://github.com/Shopify/constant_resolver/actions?query=workflow%3ACI)
+
+`ConstantResolver` resolves partially qualified constant reference to the fully qualified name and the path of the file defining it. It does not load the files to do that, its inference engine purely works on file paths and constant names.
+
+`ConstantResolver` uses the same assumptions as [Rails' code loader, `Zeitwerk`](https://github.com/fxn/zeitwerk) to infer constant locations. Please see Zeitwerk's documentation on [file structure](https://github.com/fxn/zeitwerk#file-structure) and [inflection](https://github.com/fxn/zeitwerk#zeitwerkinflector) for more information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'constant_resolver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install constant_resolver
+
+## Usage
+
+### Initialize the resolver
+
+Initialize a `ConstantResolver` with a root path and load paths:
+
+```ruby
+resolver = ConstantResolver.new(
+  root_path: "/app",
+  load_paths: [
+    "/app/models",
+    "/app/services",
+  ]
+)
+```
+
+### Resolve a constant
+
+Resolve a constant from the contents of your load paths:
+
+```ruby
+context = resolver.resolve("Some::Nested::Model")
+
+context.name     # => "::Some::Nested::Model"
+context.location # => "models/some/nested/model.rb"
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake test` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/constant_resolver.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task(default: :test)

data/constant_resolver.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "constant_resolver/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "constant_resolver"
+  spec.version       = ConstantResolver::VERSION
+  spec.authors       = ["Philip Müller"]
+  spec.email         = ["philip.mueller@shopify.com"]
+
+  spec.summary       = "Statically resolve any ruby constant"
+  spec.description   = <<~DESCRIPTION
+    Given a code base that adheres to certain conventions, ConstantResolver resolves any, even partially qualified,
+    constant to the path of the file that defines it.
+  DESCRIPTION
+  spec.homepage      = "https://github.com/Shopify/constant_resolver"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Shopify/constant_resolver"
+    spec.metadata["changelog_uri"] = "https://github.com/Shopify/constant_resolver/releases"
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency("rake", "~> 10.0")
+  spec.add_development_dependency("minitest", "~> 5.0")
+end

data/dev.yml

@@ -0,0 +1,19 @@
+name: constant-resolver
+
+type: ruby
+
+up:
+  - ruby: 2.6.2
+  - bundler
+
+commands:
+  test:
+    syntax:
+      argument: file
+      optional: args...
+    run: |
+      if [[ $# -eq 0 ]]; then
+        bundle exec rake test
+      else
+        bundle exec ruby -I test "$@"
+      fi

data/lib/constant_resolver.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require "constant_resolver/version"
+
+# Get information about (partially qualified) constants without loading the application code.
+# We infer the fully qualified name and the filepath.
+#
+# The implementation makes a few assumptions about the code base:
+# - `Something::SomeOtherThing` is defined in a path of either `something/some_other_thing.rb` or `something.rb`,
+#   relative to the load path. Constants that have their own file do not have all-uppercase names like MAGIC_NUMBER or
+#   all-uppercase parts like SomeID. Rails' `zeitwerk` autoloader makes the same assumption.
+# - It is OK to not always infer the exact file defining the constant. For example, when a constant is inherited, we
+#   have no way of inferring the file it is defined in. You could argue though that inheritance means that another
+#   constant with the same name exists in the inheriting class, and this view is sufficient for all our use cases.
+class ConstantResolver
+  class Error < StandardError; end
+  class ConstantContext < Struct.new(:name, :location); end
+
+  class DefaultInflector
+    def camelize(string)
+      string = string.sub(/^[a-z\d]*/, &:capitalize)
+      string.gsub!(%r{(?:_|(/))([a-z\d]*)}i) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
+      string.gsub!("/", "::")
+      string
+    end
+  end
+
+  private_constant :DefaultInflector
+
+  # @param root_path [String] The root path of the application to analyze
+  # @param load_paths [Array<String>] The autoload paths of the application.
+  # @param inflector [Object] Any object that implements a `camelize` function.
+  #
+  # @example usage in a Rails app
+  #   config = Rails.application.config
+  #   load_paths = (config.eager_load_paths + config.autoload_paths + config.autoload_once_paths)
+  #     .map { |p| Pathname.new(p).relative_path_from(Rails.root).to_s }
+  #   ConstantResolver.new(
+  #     root_path: Rails.root.to_s,
+  #     load_paths: load_paths
+  #   )
+  def initialize(root_path:, load_paths:, inflector: DefaultInflector.new)
+    root_path += "/" unless root_path.end_with?("/")
+    load_paths = load_paths.map { |p| p.end_with?("/") ? p : p + "/" }.uniq
+
+    @root_path = root_path
+    @load_paths = load_paths
+    @file_map = nil
+    @inflector = inflector
+  end
+
+  # Resolve a constant via its name.
+  # If the name is partially qualified, we need the current namespace path to correctly infer its full name
+  #
+  # @param const_name [String] The constant's name, fully or partially qualified.
+  # @param current_namespace_path [Array<String>] (optional) The namespace of the context in which the constant is
+  #   used, e.g. ["Apps", "Models"] for `Apps::Models`. Defaults to [] which means top level.
+  # @return [ConstantResolver::ConstantContext]
+  def resolve(const_name, current_namespace_path: [])
+    current_namespace_path = [] if const_name.start_with?("::")
+    inferred_name, location = resolve_constant(const_name.sub(/^::/, ""), current_namespace_path)
+
+    return unless inferred_name
+
+    ConstantContext.new(
+      inferred_name,
+      location,
+    )
+  end
+
+  # Maps constant names to file paths.
+  #
+  # @return [Hash<String, String>]
+  def file_map
+    return @file_map if @file_map
+    @file_map = {}
+    duplicate_files = {}
+
+    @load_paths.each do |load_path|
+      Dir[@root_path + load_path + "**/*.rb"].each do |file_path|
+        root_relative_path = file_path.delete_prefix!(@root_path)
+        const_name = @inflector.camelize(root_relative_path.delete_prefix(load_path).delete_suffix!(".rb"))
+        existing_entry = @file_map[const_name]
+
+        if existing_entry
+          duplicate_files[const_name] ||= [existing_entry]
+          duplicate_files[const_name] << root_relative_path
+        end
+        @file_map[const_name] = root_relative_path
+      end
+    end
+
+    unless duplicate_files.empty?
+      message = duplicate_files.map do |const_name, full_paths|
+        "ERROR: '#{const_name}' could refer to any of\n#{full_paths.map { |p| '  ' + p }.join("\n")}"
+      end.join("\n")
+      raise(Error, message)
+    end
+    raise(Error, "could not find any files") if @file_map.empty?
+    @file_map
+  end
+
+  # @api private
+  def config
+    {
+      root_path: @root_path,
+      load_paths: @load_paths,
+    }
+  end
+
+  private
+
+  def resolve_constant(const_name, current_namespace_path, original_name: const_name)
+    namespace, location = resolve_traversing_namespace_path(const_name, current_namespace_path)
+    if location
+      ["::" + namespace.push(original_name).join("::"), location]
+    elsif !const_name.include?("::")
+      # constant could not be resolved to a file in the given load paths
+      [nil, nil]
+    else
+      parent_constant = const_name.split("::")[0..-2].join("::")
+      resolve_constant(parent_constant, current_namespace_path, original_name: original_name)
+    end
+  end
+
+  def resolve_traversing_namespace_path(const_name, current_namespace_path)
+    fully_qualified_name_guess = (current_namespace_path + [const_name]).join("::")
+
+    location = file_map[fully_qualified_name_guess]
+    if location || fully_qualified_name_guess == const_name
+      [current_namespace_path, location]
+    else
+      resolve_traversing_namespace_path(const_name, current_namespace_path[0..-2])
+    end
+  end
+end

data/lib/constant_resolver/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ConstantResolver
+  VERSION = "0.1.5"
+end

data/service.yml

@@ -0,0 +1,6 @@
+---
+classification: library
+owners:
+- Shopify/component-patterns
+slack_channels:
+- architecture-patterns

data/shipit.yml

@@ -0,0 +1 @@
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: constant_resolver
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Philip Müller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |
+  Given a code base that adheres to certain conventions, ConstantResolver resolves any, even partially qualified,
+  constant to the path of the file that defines it.
+email:
+- philip.mueller@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/probots.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- constant_resolver.gemspec
+- dev.yml
+- lib/constant_resolver.rb
+- lib/constant_resolver/version.rb
+- service.yml
+- shipit.yml
+homepage: https://github.com/Shopify/constant_resolver
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Shopify/constant_resolver
+  source_code_uri: https://github.com/Shopify/constant_resolver
+  changelog_uri: https://github.com/Shopify/constant_resolver/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Statically resolve any ruby constant
+test_files: []