constant_resolver 0.1.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c05074565a7f3112d32cf0a4968ea4193fbce4eafc41e4873279e3a1a9787f2
-  data.tar.gz: 4eab3c4e64102b05497709501bb1bab4b718be511b7ccfc31d2c7c919f86b131
+  metadata.gz: 814a147bad07ced23e5a73270dd1beb72818f32410557ca1c7482ba4ec07017b
+  data.tar.gz: c346b11e325b91221977faae415df878f2ea75849b7e0028fb90466c273c45a3
 SHA512:
-  metadata.gz: b3feb2e2646e09c6fc840dd406e36341fe5c3fac6d0ecd6f1dcf8e2e7aa2cd64d9cf659e3eb832b5b8240191bdf02ae1f5d9355362e8c36f3c684a314463d9d9
-  data.tar.gz: 16922c192716b2ddb615cdc43503a27b878d4bc798ad7869ad0fa319a442f64df01da1510fea8510b2fd2299e4ea75dd14c2f76be267574664c8b767d1d9d7ad
+  metadata.gz: 262e46796e4984468bbecb89666e3503f72585e950b3cfc5ec245344e2b578855f877a292c115018d339e815e8746fae00bee72771d408c1a9957dbaa5c3c4e9
+  data.tar.gz: 19f7b87f20f5af3e8e73491e5810371776d96d27c33219275198cff62258462d6d8cf61217a869fb0705e6528feaa7f1d8d85208d82425806bf801dbd17d8bcf

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly

data/.github/workflows/ci.yml

@@ -5,27 +5,31 @@ on: [push, pull_request]
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
     steps:
-      - uses: actions/checkout@v1
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
+      - uses: actions/checkout@50fbc622fc4ef5163becd7fab6573eac35f8462e # v1.2.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@e34163cd15f4bb403dcd72d98e295997e6a55798 # v1.238.0
         with:
-          ruby-version: 2.6.x
+          ruby-version: ${{ matrix.ruby }}
       - name: Run tests
         run: |
-          gem install bundler
           bundle install --jobs 4 --retry 3
           bundle exec rake
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: 2.6.x
+      - uses: actions/checkout@50fbc622fc4ef5163becd7fab6573eac35f8462e # v1.2.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@e34163cd15f4bb403dcd72d98e295997e6a55798 # v1.238.0
       - name: Run style checks
         run: |
-          gem install bundler
           bundle install --jobs 4 --retry 3
           bundle exec rubocop

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.gitignore

@@ -6,6 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-/Gemfile.lock
 /.bundle/
 /tmp/

data/.rubocop.yml

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

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/Gemfile

@@ -8,10 +8,11 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 group :deployment do
-  gem 'rake'
+  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'
+  gem "rubocop", require: false
+  gem "rubocop-performance", require: false
+  gem "rubocop-shopify", require: false
 end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    constant_resolver (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    minitest (5.22.3)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.0)
+    rexml (3.3.9)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-shopify (2.15.1)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  constant_resolver!
+  minitest (~> 5.0)
+  rake
+  rubocop
+  rubocop-performance
+  rubocop-shopify
+
+BUNDLED WITH
+   2.4.22

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Shopify Inc
+Copyright (c) 2019-present 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

data/README.md

@@ -36,6 +36,21 @@ resolver = ConstantResolver.new(
 )
 ```
 
+### Default namespaces
+
+If any load paths have a default namespace other than `Object`, these can be specified in a hash:
+
+```ruby
+resolver = ConstantResolver.new(
+  root_path: "/app",
+  load_paths: {
+    "/app/models" => "::Object",
+    "/app/services" => "::Object",
+    "/app/internal" => "::Business",
+  }
+)
+```
+
 ### Resolve a constant
 
 Resolve a constant from the contents of your load paths:
@@ -47,6 +62,23 @@ context.name     # => "::Some::Nested::Model"
 context.location # => "models/some/nested/model.rb"
 ```
 
+### Ignoring paths
+
+You may want to only resolve constants from certain sections of your application. If you want to leave any paths out, use `exclude`:
+
+```ruby
+resolver = ConstantResolver.new(
+  root_path: "/app",
+  load_paths: [
+    "/app/models",
+    "/some/engine/app/models",
+  ],
+  exclude: [
+    "some/engine/**/*"
+  ],
+)
+```
+
 ## Development
 
 After checking out the repo, run `bundle` to install dependencies. Then, run `rake test` to run the tests.

data/constant_resolver.gemspec

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "constant_resolver/version"
+require_relative "lib/constant_resolver/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "constant_resolver"
@@ -22,15 +20,21 @@ Gem::Specification.new do |spec|
     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"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
   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
+  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.required_ruby_version = ">= 2.7.0"
+
   spec.add_development_dependency("minitest", "~> 5.0")
+  spec.add_development_dependency("rake", "~> 13.2")
 end

data/dev.yml

@@ -3,7 +3,7 @@ name: constant-resolver
 type: ruby
 
 up:
-  - ruby: 2.6.2
+  - ruby
   - bundler
 
 commands:

data/lib/constant_resolver/version.rb

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

data/lib/constant_resolver.rb

@@ -13,6 +13,8 @@ require "constant_resolver/version"
 #   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
+  RUBY_FILES_GLOB = "**/*.rb"
+
   class Error < StandardError; end
   class ConstantContext < Struct.new(:name, :location); end
 
@@ -25,10 +27,12 @@ class ConstantResolver
     end
   end
 
+  private_constant :RUBY_FILES_GLOB
   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 exclude [Array<String>] Paths to exclude to scan for constants.
   # @param inflector [Object] Any object that implements a `camelize` function.
   #
   # @example usage in a Rails app
@@ -39,14 +43,14 @@ class ConstantResolver
   #     root_path: Rails.root.to_s,
   #     load_paths: load_paths
   #   )
-  def initialize(root_path:, load_paths:, inflector: DefaultInflector.new)
+  def initialize(root_path:, load_paths:, exclude: [], 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
+    @load_paths = coerce_load_paths(load_paths)
     @file_map = nil
     @inflector = inflector
+    @exclude = exclude
   end
 
   # Resolve a constant via its name.
@@ -73,30 +77,44 @@ class ConstantResolver
   # @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|
+    @load_paths.each_pair do |load_path, default_ns|
+      Dir[glob_path(load_path)].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"))
+        const_name = "#{default_ns}::#{const_name}" unless default_ns == "Object"
         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
+
+        if allowed?(root_relative_path)
+          @file_map[const_name] = root_relative_path
+        end
       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)
+    if duplicate_files.any?
+      raise(Error, <<~MSG)
+        Ambiguous constant definition:
+
+        #{duplicate_files.map { |const_name, paths| ambiguous_constant_message(const_name, paths) }.join("\n")}
+      MSG
+    end
+
+    if @file_map.empty?
+      raise(Error, <<~MSG)
+        Could not find any ruby files. Searched in:
+
+        - #{@load_paths.keys.map { |load_path| glob_path(load_path) }.join("\n- ")}
+      MSG
     end
-    raise(Error, "could not find any files") if @file_map.empty?
+
     @file_map
   end
 
@@ -110,6 +128,30 @@ class ConstantResolver
 
   private
 
+  def allowed?(path)
+    !@exclude.any? { |glob| File.fnmatch(glob, path, File::FNM_EXTGLOB | File::FNM_PATHNAME) }
+  end
+
+  def coerce_load_paths(load_paths)
+    load_paths = Hash[load_paths.map { |p| [p, "Object"] }] unless load_paths.respond_to?(:transform_keys)
+
+    load_paths.transform_keys! { |p| p.end_with?("/") ? p : p + "/" }
+    load_paths.transform_values! { |ns| ns.to_s.delete_prefix("::") }
+
+    load_paths
+  end
+
+  def ambiguous_constant_message(const_name, paths)
+    <<~MSG.chomp
+      "#{const_name}" could refer to any of
+        #{paths.join("\n  ")}
+    MSG
+  end
+
+  def glob_path(path)
+    File.join(@root_path, path, RUBY_FILES_GLOB)
+  end
+
   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

data/service.yml

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

data/shipit.rubygems.yml

@@ -0,0 +1 @@
+# defaults

metadata

@@ -1,43 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: constant_resolver
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Philip Müller
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.2'
 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.
@@ -47,14 +46,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/probots.yml"
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
+- ".github/workflows/cla.yml"
 - ".gitignore"
-- ".rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml"
 - ".rubocop.yml"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -63,7 +64,7 @@ files:
 - lib/constant_resolver.rb
 - lib/constant_resolver/version.rb
 - service.yml
-- shipit.yml
+- shipit.rubygems.yml
 homepage: https://github.com/Shopify/constant_resolver
 licenses:
 - MIT
@@ -71,7 +72,7 @@ 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: 
+  allowed_push_host: https://rubygems.org
 rdoc_options: []
 require_paths:
 - lib
@@ -79,15 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Statically resolve any ruby constant
 test_files: []

data/.github/probots.yml

@@ -1,2 +0,0 @@
-enabled:
-  - cla