constant_resolver 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c05074565a7f3112d32cf0a4968ea4193fbce4eafc41e4873279e3a1a9787f2
-  data.tar.gz: 4eab3c4e64102b05497709501bb1bab4b718be511b7ccfc31d2c7c919f86b131
+  metadata.gz: dbe8153c22d706203ca7a89f53e39748657e75c9c508ebb7614cf9d933970dfa
+  data.tar.gz: 77fb1450efa1027547b6e8a24c316d4624454a0b10bd3b636646e1e6eb6d8612
 SHA512:
-  metadata.gz: b3feb2e2646e09c6fc840dd406e36341fe5c3fac6d0ecd6f1dcf8e2e7aa2cd64d9cf659e3eb832b5b8240191bdf02ae1f5d9355362e8c36f3c684a314463d9d9
-  data.tar.gz: 16922c192716b2ddb615cdc43503a27b878d4bc798ad7869ad0fa319a442f64df01da1510fea8510b2fd2299e4ea75dd14c2f76be267574664c8b767d1d9d7ad
+  metadata.gz: 90c79e21790f1a952966df8113073ba863dd4f6fc41bf8800bf0232ee5e7ed8e0ba2034a476616147fc5947b1ff3f44987470f611772ce25c1b0b0c5c7221bae
+  data.tar.gz: 2be1c0dc66498943a093fcf3dc6cf6d2ee378486a704ee5f4d62db7454bf8aeb78c620852cd0b9489b72d79c81965e3e62502d689fbf5c03337097fcaed36dea

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:

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,6 +20,10 @@ 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.

data/lib/constant_resolver/version.rb

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

data/lib/constant_resolver.rb

@@ -41,10 +41,9 @@ class ConstantResolver
   #   )
   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
+    @load_paths = coerce_load_paths(load_paths)
     @file_map = nil
     @inflector = inflector
   end
@@ -76,10 +75,11 @@ class ConstantResolver
     @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
@@ -90,13 +90,22 @@ class ConstantResolver
       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 +119,26 @@ class ConstantResolver
 
   private
 
+  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)
+    @root_path + path + "**/*.rb"
+  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,2 @@
----
 classification: library
-owners:
-- Shopify/component-patterns
-slack_channels:
-- architecture-patterns
+ci_url: https://github.com/Shopify/constant_resolver/actions?query=workflow%3ACI

data/shipit.yml

@@ -1 +1 @@
-
+# defaults

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: constant_resolver
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Philip Müller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-18 00:00:00.000000000 Z
+date: 2022-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,6 +71,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
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -86,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Statically resolve any ruby constant