dry-auto_inject 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46f037cd532619db63a95ff30c43c93b1146b4dbb8bccd2b803100d8fef8dff5
-  data.tar.gz: 8e9c7512c0ac99c16b8aa7a5308a241e1714b5239923f4a9876aaa3d9e47abc9
+  metadata.gz: 4d3bcb1fb6fde005af77e71608739263f5866bf4cd1b00c4ad7c9cd6d6a6d61a
+  data.tar.gz: b8eb767e090882f4a6102c594b7e1da1798c550ea0fbfa734a693c032ee2ba3e
 SHA512:
-  metadata.gz: 8a1f3de5df6540384bb87e915e471d0e8470b7848ac0cf29759e2ac9985d428885d733d1376185a2cfcc6d2afdcad7e2567a82dd2d07b9be7cecaeb5d22c740e
-  data.tar.gz: 07cacefa01e1802cad3290ce9ceee9a9e7611414bcb02593753844bc00ec7e05ff89f990454dc22e4d97cbbcc5f1fef93c96bf1a016689fa9ff4dd8d7226efe3
+  metadata.gz: fe6dc512e6e3d0de8ca362cb5d34c069dd3f88b1fd90f77056281c073d659003a687195637ef6fbac24763362dc41cc536a24f7ff98cb5225c34856b855ee431
+  data.tar.gz: a3c1629d8437135fd16c5e02599ed6acf1d6bb55fd114f139855cc1c7ea6275bca9f726a59a9e63668698fe2a7c410d7a5a26485a054936ea5f175b62f7186f7

data/.travis.yml

@@ -6,10 +6,10 @@ script:
 after_success:
   - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.5.0
-  - 2.4.3
-  - 2.3.6
-  - jruby-9.1.10.0
+  - 2.5.3
+  - 2.4.5
+  - 2.3.8
+  - jruby-9.2.4.1
 env:
   global:
     - COVERAGE=true

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# 0.6.0 / 2018-11-29
+
+### Changed
+
+- [BREAKING] 0.6.0 supports Ruby 2.3 and above. If you're on 2.3 keep in mind its EOL is scheduled at the end of March, 2019
+
+### Added
+
+- Enhanced support for integrating with existing constructors. The kwargs strategy will now pass dependencies up to the next constructor if it accepts an arbitrary number of arguments with `*args`. Note that this change may break existing code though we think it's unlikely to happen. If something doesn't work for you please report and we'll try to sort it out (flash-gordon + timriley in [#48](https://github.com/dry-rb/dry-auto_inject/pull/48))
+
+### Fixed
+
+- A couple of regressions were fixed along the way, see [#46](https://github.com/dry-rb/dry-auto_inject/issues/46) and [#49](https://github.com/dry-rb/dry-auto_inject/issues/49) (flash-gordon + timriley in [#48](https://github.com/dry-rb/dry-auto_inject/pull/48))
+
+[Compare v0.5.0...v0.6.0](https://github.com/dry-rb/dry-auto_inject/compare/v0.5.0...v0.6.0)
+
 # 0.5.0 / 2018-11-09
 
 ### Changed

data/dry-auto_inject.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 # frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
@@ -20,11 +19,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_runtime_dependency 'dry-container', '>= 0.3.4'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', '~> 3.8'
 end

data/lib/dry/auto_inject.rb

@@ -43,12 +43,4 @@ module Dry
   def self.AutoInject(container, options = {})
     AutoInject::Builder.new(container, options)
   end
-
-  module AutoInject
-    # @api private
-    def self.super_method(klass, method)
-      method = klass.instance_method(method)
-      method unless method.owner.equal?(klass)
-    end
-  end
 end

data/lib/dry/auto_inject/dependency_map.rb

@@ -29,11 +29,11 @@ module Dry
       end
 
       def names
-        @map.keys
+        @name ||= @map.keys
       end
 
       def to_h
-        @map.dup.to_h
+        @map.dup
       end
       alias_method :to_hash, :to_h
 

data/lib/dry/auto_inject/method_parameters.rb

@@ -0,0 +1,92 @@
+require 'set'
+
+module Dry
+  module AutoInject
+    # @api private
+    class MethodParameters
+      PASS_THROUGH = [[:rest]]
+
+      if RUBY_VERSION >= '2.4.4.' && !defined? JRUBY_VERSION
+        def self.of(obj, name)
+          Enumerator.new do |y|
+            begin
+              method = obj.instance_method(name)
+            rescue NameError
+            end
+
+            loop do
+              break if method.nil?
+
+              y << MethodParameters.new(method.parameters)
+              method = method.super_method
+            end
+          end
+        end
+      else
+        # see https://bugs.ruby-lang.org/issues/13973
+        def self.of(obj, name)
+          Enumerator.new do |y|
+            ancestors = obj.ancestors
+
+            loop do
+              klass = ancestors.shift
+              break if klass.nil?
+
+              begin
+                method = klass.instance_method(name)
+
+                next unless method.owner.equal?(klass)
+              rescue NameError
+                next
+              end
+
+              y << MethodParameters.new(method.parameters)
+            end
+          end
+        end
+      end
+
+      attr_reader :parameters
+
+      def initialize(parameters)
+        @parameters = parameters
+      end
+
+      def splat?
+        return @splat if defined? @splat
+        @splat = parameters.any? { |type, _| type == :rest }
+      end
+
+      def sequential_arguments?
+        return @sequential_arguments if defined? @sequential_arguments
+        @sequential_arguments = parameters.any? { |type, _|
+          type == :req || type == :opt
+        }
+      end
+
+      def keyword_names
+        @keyword_names ||= parameters.each_with_object(Set.new) { |(type, name), names|
+          names << name if type == :key || type == :keyreq
+        }
+      end
+
+      def keyword?(name)
+        keyword_names.include?(name)
+      end
+
+      def empty?
+        parameters.empty?
+      end
+
+      def length
+        parameters.length
+      end
+
+      def pass_through?
+        parameters.eql?(PASS_THROUGH)
+      end
+
+      EMPTY = new([])
+    end
+  end
+end

data/lib/dry/auto_inject/strategies/args.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'dry/auto_inject/strategies/constructor'
+require 'dry/auto_inject/method_parameters'
 
 module Dry
   module AutoInject
@@ -22,12 +23,15 @@ module Dry
         end
 
         def define_initialize(klass)
-          super_method = find_super(klass, :initialize)
+          super_parameters = MethodParameters.of(klass, :initialize).each do |ps|
+            # Look upwards past `def foo(*)` methods until we get an explicit list of parameters
+            break ps unless ps.pass_through?
+          end
 
-          if super_method.nil? || super_method.parameters.empty?
+          if super_parameters.empty?
             define_initialize_with_params
           else
-            define_initialize_with_splat(super_method)
+            define_initialize_with_splat(super_parameters)
           end
         end
 
@@ -42,31 +46,20 @@ module Dry
           RUBY
         end
 
-        def define_initialize_with_splat(super_method)
-          super_params = if super_method.parameters.any? { |type, _| type == :rest }
+        def define_initialize_with_splat(super_parameters)
+          super_pass = if super_parameters.splat?
             '*args'
           else
-            "*args[0..#{super_method.parameters.length - 1}]"
+            "*args.take(#{super_parameters.length})"
           end
 
           instance_mod.class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def initialize(*args)
               #{dependency_map.names.map.with_index { |name, i| "@#{name} = args[#{i}]" }.join("\n")}
-              super(#{super_params})
+              super(#{super_pass})
             end
           RUBY
         end
-
-        def find_super(klass, method_name)
-          super_method = Dry::AutoInject.super_method(klass, method_name)
-
-          # Look upwards past `def foo(*)` methods until we get an explicit list of parameters
-          while super_method && super_method.parameters == [[:rest]]
-            super_method = Dry::AutoInject.super_method(super_method.owner, :initialize)
-          end
-
-          super_method
-        end
       end
 
       register :args, Args

data/lib/dry/auto_inject/strategies/hash.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'dry/auto_inject/strategies/constructor'
+require 'dry/auto_inject/method_parameters'
 
 module Dry
   module AutoInject
@@ -22,13 +23,13 @@ module Dry
         end
 
         def define_initialize(klass)
-          super_method = Dry::AutoInject.super_method(klass, :initialize)
-          super_params = super_method.nil? || super_method.parameters.empty? ? '' : 'options'
+          super_params = MethodParameters.of(klass, :initialize).first
+          super_pass = super_params.empty? ? '' : 'options'
 
           instance_mod.class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def initialize(options)
               #{dependency_map.names.map { |name| "@#{name} = options[:#{name}] unless !options.key?(#{name}) && instance_variable_defined?(:'@#{name}')" }.join("\n")}
-              super(#{super_params})
+              super(#{super_pass})
             end
           RUBY
         end

data/lib/dry/auto_inject/strategies/kwargs.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'dry/auto_inject/strategies/constructor'
+require 'dry/auto_inject/method_parameters'
 
 module Dry
   module AutoInject
@@ -11,7 +12,7 @@ module Dry
 
         def define_new
           class_mod.class_exec(container, dependency_map) do |container, dependency_map|
-            map = dependency_map.to_h.to_a
+            map = dependency_map.to_h
 
             define_method :new do |*args, **kwargs|
               map.each do |name, identifier|
@@ -24,59 +25,77 @@ module Dry
         end
 
         def define_initialize(klass)
-          super_method = Dry::AutoInject.super_method(klass, :initialize)
+          super_parameters = MethodParameters.of(klass, :initialize).each do |ps|
+            # Look upwards past `def foo(*)` methods until we get an explicit list of parameters
+            break ps unless ps.pass_through?
+          end
 
-          if super_method.nil? || super_method.parameters.empty?
-            define_initialize_with_keywords
+          if super_parameters.splat? || super_parameters.sequential_arguments?
+            define_initialize_with_splat(super_parameters)
           else
-            define_initialize_with_splat(super_method)
+            define_initialize_with_keywords(super_parameters)
           end
 
           self
         end
 
-        def define_initialize_with_keywords
-          initialize_params = dependency_map.names.map { |name| "#{name}: nil" }.join(", ")
+        def define_initialize_with_keywords(super_parameters)
+          assign_dependencies = method(:assign_dependencies)
+          slice_kwargs = method(:slice_kwargs)
 
-          instance_mod.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def initialize(#{initialize_params})
-              #{dependency_map.names.map { |name| "@#{name} = #{name} unless #{name}.nil? && instance_variable_defined?(:'@#{name}')" }.join("\n")}
-              super()
-            end
-          RUBY
+          instance_mod.class_exec do
+            define_method :initialize do |**kwargs|
+              assign_dependencies.(kwargs, self)
 
-          self
+              super_kwargs = slice_kwargs.(kwargs, super_parameters)
+
+              if super_kwargs.any?
+                super(super_kwargs)
+              else
+                super()
+              end
+            end
+          end
         end
 
-        def define_initialize_with_splat(super_method)
-          super_kwarg_names = super_method.parameters.each_with_object([]) { |(type, name), names|
-            names << name if [:key, :keyreq].include?(type)
-          }
+        def define_initialize_with_splat(super_parameters)
+          assign_dependencies = method(:assign_dependencies)
+          slice_kwargs = method(:slice_kwargs)
 
-          instance_mod.class_exec(dependency_map) do |dependency_map|
+          instance_mod.class_exec do
             define_method :initialize do |*args, **kwargs|
-              dependency_map.names.each do |name|
-                # Assign instance variables, but only if the ivar is not
-                # previously defined (this improves compatibility with objects
-                # initialized in unconventional ways)
-                instance_variable_set :"@#{name}", kwargs[name] unless kwargs[name].nil? && instance_variable_defined?(:"@#{name}")
-              end
-
-              super_kwargs = kwargs.each_with_object({}) { |(key, _), hsh|
-                if !dependency_map.names.include?(key) || super_kwarg_names.include?(key)
-                  hsh[key] = kwargs[key]
-                end
-              }
+              assign_dependencies.(kwargs, self)
 
-              if super_kwargs.any?
-                super(*args, **super_kwargs)
+              if super_parameters.splat?
+                super(*args, kwargs)
               else
-                super(*args)
+                super_kwargs = slice_kwargs.(kwargs, super_parameters)
+
+                if super_kwargs.any?
+                  super(*args, super_kwargs)
+                else
+                  super(*args)
+                end
               end
             end
           end
+        end
 
-          self
+        def assign_dependencies(kwargs, destination)
+          dependency_map.names.each do |name|
+            # Assign instance variables, but only if the ivar is not
+            # previously defined (this improves compatibility with objects
+            # initialized in unconventional ways)
+            if kwargs.key?(name) || !destination.instance_variable_defined?(:"@#{name}")
+              destination.instance_variable_set :"@#{name}", kwargs[name]
+            end
+          end
+        end
+
+        def slice_kwargs(kwargs, super_parameters)
+          kwargs.select do |key|
+            !dependency_map.names.include?(key) || super_parameters.keyword?(key)
+          end
         end
       end
 

data/lib/dry/auto_inject/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module AutoInject
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end
 end

metadata

@@ -1,72 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: dry-auto_inject
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Solnica
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dry-container
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.4
-  type: :runtime
+  name: dry-container
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.4
 - !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: bundler
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '3.8'
+  name: rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '3.8'
+description:
 email:
 - piotr.solnica@gmail.com
 executables: []
@@ -93,6 +93,7 @@ files:
 - lib/dry/auto_inject/builder.rb
 - lib/dry/auto_inject/dependency_map.rb
 - lib/dry/auto_inject/injector.rb
+- lib/dry/auto_inject/method_parameters.rb
 - lib/dry/auto_inject/strategies.rb
 - lib/dry/auto_inject/strategies/args.rb
 - lib/dry/auto_inject/strategies/constructor.rb
@@ -104,7 +105,7 @@ homepage: https://github.com/dryrb/dry-auto_inject
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,16 +113,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
 specification_version: 4
 summary: Container-agnostic automatic constructor injection
 test_files: []