dbee 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6408442138aafff2ca06cd0161a5fd34a10270a773fb6bd90a9cde54c593b66
-  data.tar.gz: 8dfb19dc5001ba6e7718cac33e0041eaef49747343a189138dd165f82b825bfb
+  metadata.gz: a84b1a2e86f04be67850fa1bfe79aa9a52d1548db6ba8c76df551b5257a00bd8
+  data.tar.gz: 2c7d2d5b847e805f46c94019c72b6d7c79990ebd2d4b7d8a3d940278b267a904
 SHA512:
-  metadata.gz: d26d78a27695eb0c4ca15055ada5624c802d4f22c9d7a5fb110b940bcf1bdc56f1bdcb65f0c4754820439bf94fcc6ba029dd1f922c6e53f9a07698a862b5d897
-  data.tar.gz: 5074fbbc002af0e8e7335a2a1e25bfbaa25923cdbc6171d177de5ebee6147236248f2d7efd86ca4d398ac2abf2b4a4873d49d2cd2a38bfde8cbf46fc6e8bc7b8
+  metadata.gz: 83f756643490546309610118e1ff5efb501c3db51c0322e5a2bb7a0fe2bc96b5164362d9531e6ff11371fee8a6096ba38c04f5c269bf590670fa76c03d62bb45
+  data.tar.gz: 449063144c4ba5babd0358e7d8851686d4cf7520d2aef2a9444175e616cc9a9a01fe8c3596c941e24ce4dafa5c7e4aaa0fe8d8ac378953f61d97e2acbc4a36b8

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.6.5

data/.travis.yml

@@ -7,7 +7,7 @@ rvm:
   - 2.3.8
   - 2.4.6
   - 2.5.5
-  - 2.6.3
+  - 2.6.5
 cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 2.0.3 (January 7th, 2020)
+
+### Fixes:
+
+* Constant resolution will now explicitly set inherit to false when calling `Object#const_defined?` and `Object#const_get`.  This should equate to less false positives.  For example:
+
+```ruby
+class A; end
+
+module B
+  class A; end
+  class C; end
+end
+```
+
+If `B::A` is the desired class, it would not be suitable to just declare an association on `A` as that would resolve explicitly to `::A`.  It also means C cannot be auto-resolved without prefixing/sharing the namespace with parent association `A`.
+
 # 2.0.2 (November 7th, 2019)
 
 ### Additions:

data/dbee.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('pry', '~>0')
   s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~>0.76.0')
+  s.add_development_dependency('rubocop', '~>0.79.0')
   s.add_development_dependency('simplecov', '~>0.17.0')
-  s.add_development_dependency('simplecov-console', '~>0.5.0')
+  s.add_development_dependency('simplecov-console', '~>0.6.0')
 end

data/lib/dbee.rb

@@ -12,6 +12,7 @@ require 'dry/inflector'
 require 'forwardable'
 
 require_relative 'dbee/base'
+require_relative 'dbee/constant_resolver'
 require_relative 'dbee/key_chain'
 require_relative 'dbee/key_path'
 require_relative 'dbee/model'

data/lib/dbee/constant_resolver.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Dbee
+  # This class is responsible for turning strings and symbols into constants.
+  # It does not deal with inflection, simply just constant resolution.
+  class ConstantResolver
+    # Only use Module constant resolution if a string or symbol was passed in.
+    # Any other type is defined as an acceptable constant and is simply returned.
+    def constantize(value)
+      value.is_a?(String) || value.is_a?(Symbol) ? object_constant(value) : value
+    end
+
+    private
+
+    # If the constant has been loaded, we can safely use it through const_get.
+    # If the constant has not been loaded, we need to defer to const_missing to resolve it.
+    # If we blindly call const_get, it may return false positives for namespaced constants
+    # or anything nested.
+    def object_constant(value)
+      if Object.const_defined?(value, false)
+        Object.const_get(value, false)
+      else
+        Object.const_missing(value)
+      end
+    end
+  end
+end

data/lib/dbee/dsl/association.rb

@@ -19,16 +19,17 @@ module Dbee
         raise ArgumentError, 'inflector is required'      unless inflector
         raise ArgumentError, 'name is required'           if name.to_s.empty?
 
-        @on_class_name  = on_class_name
-        @inflector      = inflector
-        @name           = name.to_s
-        @opts           = opts || {}
+        @on_class_name     = on_class_name
+        @inflector         = inflector
+        @name              = name.to_s
+        @opts              = opts || {}
+        @constant_resolver = ConstantResolver.new
 
         freeze
       end
 
       def model_constant
-        constantize(class_name)
+        constant_resolver.constantize(class_name)
       end
 
       def constraints
@@ -37,6 +38,8 @@ module Dbee
 
       private
 
+      attr_reader :constant_resolver
+
       def class_name
         opts[:model] || relative_class_name
       end
@@ -47,20 +50,6 @@ module Dbee
       def relative_class_name
         (on_class_name.split('::')[0...-1] + [inflector.classify(name)]).join('::')
       end
-
-      # Only use Module constant resolution if a string or symbol was passed in.
-      # Any other type is defined as an acceptable constant and is simply returned.
-      def constantize(value)
-        value.is_a?(String) || value.is_a?(Symbol) ? object_constant(value) : value
-      end
-
-      # If the constant has been loaded, we can safely use it through const_get.
-      # If the constant has not been loaded, we need to defer to const_missing to resolve it.
-      # If we blindly call const_get, it may return false positives for namespaced constants
-      # or anything nested.
-      def object_constant(value)
-        Object.const_defined?(value) ? Object.const_get(value) : Object.const_missing(value)
-      end
     end
   end
 end

data/lib/dbee/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Dbee
-  VERSION = '2.0.2'
+  VERSION = '2.0.3'
 end

data/spec/dbee/constant_resolver_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe Dbee::ConstantResolver do
+  module A
+    class B; end
+    class E; end
+  end
+
+  class B; end
+
+  module C
+    class D; end
+    class E; end
+
+    module F
+      class G; end
+    end
+  end
+
+  it 'resolves nested constant with the same as an ancestor constants sibling' do
+    expect(subject.constantize('A::B')).to eq(::A::B)
+  end
+
+  it 'resolves root constant' do
+    expect(subject.constantize('B')).to eq(::B)
+  end
+
+  it 'does not resolve constant in a different parent module' do
+    expect { subject.constantize('C::B') }.to raise_error(NameError)
+  end
+
+  it 'does not resolve constant in a different parent module' do
+    expect { subject.constantize('D') }.to raise_error(NameError)
+  end
+
+  it 'resolves same leaf constants specific to their parents' do
+    expect(subject.constantize('A::E')).to eq(::A::E)
+    expect(subject.constantize('C::E')).to eq(::C::E)
+  end
+
+  it 'does not resolve constant without its parent' do
+    expect { subject.constantize('F') }.to raise_error(NameError)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbee
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 description: "    Dbee provides a simple-to-use data modeling and query API.  The
   query API can produce SQL using other ORMs, such as Arel/ActiveRecord.  The targeted
   use-case for Dbee is ad-hoc reporting, so the total SQL feature-set that Dbee supports
@@ -169,6 +169,7 @@ files:
 - dbee.gemspec
 - lib/dbee.rb
 - lib/dbee/base.rb
+- lib/dbee/constant_resolver.rb
 - lib/dbee/dsl/association.rb
 - lib/dbee/dsl/association_builder.rb
 - lib/dbee/dsl/methods.rb
@@ -203,6 +204,7 @@ files:
 - lib/dbee/query/sorters/descending.rb
 - lib/dbee/version.rb
 - spec/dbee/base_spec.rb
+- spec/dbee/constant_resolver_spec.rb
 - spec/dbee/key_chain_spec.rb
 - spec/dbee/key_path_spec.rb
 - spec/dbee/model/constraints/base_spec.rb
@@ -247,6 +249,7 @@ specification_version: 4
 summary: Adhoc Reporting SQL Generator
 test_files:
 - spec/dbee/base_spec.rb
+- spec/dbee/constant_resolver_spec.rb
 - spec/dbee/key_chain_spec.rb
 - spec/dbee/key_path_spec.rb
 - spec/dbee/model/constraints/base_spec.rb