injectable 1.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a32caf8a5fd11f69df5ea9ffe381e63fdaa4d640044c797bc1d6b0ee29bf2f1
-  data.tar.gz: c57be65098fc9b53b7e7bd6b4f9bce85296390424655d2fed9bb6bf534494c61
+  metadata.gz: 39e5192fdea17f097ed9a59e790d420cc57c948d634d62295cf1b4060423b57e
+  data.tar.gz: 03df6db3f7c4d49eed4333800a8d1f58a8621d030285327f0bc9b0fc46b12ba6
 SHA512:
-  metadata.gz: fa7c6f31fccdbe29d987732dba922c7a6915517340c8833ccd1aaeed9e48c8eb39fb71eda6ae718f951fc5b56ac8aa0cff7d9519105aae9f2a9de8f526ea130c
-  data.tar.gz: 88b632c250c5cdf4a98e542e1e9801eab4684eb891c2ec9cad2386c10b62d2e749828fd5b21ed40bcdcabcece7ffa48ae8999e6cda2dd57a52a6ffa71bb60b0e
+  metadata.gz: b68bf39f92aaccd38780cda67bddf53d3f95eecfcc9a00028787f56a9075d03356fa2533708827deeb5c12441bc007132e8934e6c353de1e109284923764a76f
+  data.tar.gz: c9a3fb6173b26269589bcea5ac45a02c86a81df8c6b956405067f7f483afbbf78f395a3678fe98b96b2d02582edad45c2a8d6444fd777e16cea25c33647c4c91

data/.github/workflows/ruby.yml

@@ -0,0 +1,25 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ 2.5.x, 2.6, 2.7.x ]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+### Unreleased
+
+### 2.1.1 - 2021-03-15
+
+* bug fixes
+  * Address final Ruby 2.7 warnings (#24)
+
+### 2.1.0 - 2021-01-05
+
+* enhancements
+  * Return `method` object instead of monkey patched instance (#17)
+  * Prepare for Ruby 3.0 (#22)
+
+### 2.0.0 - 2020-03-16
+
+* breaking changes
+  * Raises exception if shadowing an existing `#call` method in a dependency (#15)
+
+### 1.0.3 - 2020-03-16
+
+* enhancements
+  * Added GitHub Actions as CI (#9)
+
+* bug fixes
+  * Fixed a bug that wouldn't pass a block if `#call` was aliased (#7)
+
+### 1.0.2 - 2020-03-02
+
+* security
+  * Bump `rake` to 12.3.3 (#11)

data/Gemfile.lock

@@ -1,26 +1,35 @@
 PATH
   remote: .
   specs:
-    injectable (1.0.0)
+    injectable (2.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
 
 PLATFORMS
   ruby
@@ -28,8 +37,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   injectable!
-  rake (~> 12.0)
+  pry-byebug
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.0.1
+   2.2.4

data/README.md

@@ -1,5 +1,7 @@
 # Injectable
 
+[![Maintainability](https://api.codeclimate.com/v1/badges/a45cc5935a5c16b837ed/maintainability)](https://codeclimate.com/github/rubiconmd/injectable/maintainability)![Ruby](https://github.com/rubiconmd/injectable/workflows/Ruby/badge.svg)
+
 `Injectable` is an opinionated and declarative [Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection) library for ruby.
 
 It is being used in production (under ruby 2.5.1) in [RubiconMD](https://github.com/rubiconmd) and was extracted from its codebase.
@@ -209,8 +211,8 @@ There are several ways of declaring a `#dependency`:
 
 ```rb
 class ReportPdfRenderer
-  include Injectable 
-  
+  include Injectable
+
   dependency :some_dependency
 end
 ```
@@ -225,9 +227,9 @@ Notice that this happens **at runtime**, not when defining your class.
 ```rb
 class MyInjectable
   include Injectable
-  
+
   dependency :client, class: Aws::S3::Client
-  dependency :parser, class: VeryLongClassNameForMyParser 
+  dependency :parser, class: VeryLongClassNameForMyParser
 end
 ```
 
@@ -353,6 +355,6 @@ Everyone interacting in the Injectable project’s codebases, issue trackers, ch
 
 - [RubiconMD](https://github.com/rubiconmd) allowed extracting this gem from its codebase and release it as open source.
 - [Durran Jordan](https://github.com/durran) allowed the usage of the gem name at rubygems.org.
-- [David Marchante](https://github.com/iovis9) brainstormed the `initialize`/`call` approach, did all code reviews and provided lots of insightful feedback and suggestions. He also wrote the inline documentation.
+- [David Marchante](https://github.com/iovis) brainstormed the `initialize`/`call` approach, did all code reviews and provided lots of insightful feedback and suggestions. He also wrote the inline documentation.
 - [Julio Antequera](https://github.com/jantequera), [Jimmi Carney](https://github.com/ayoformayo) and [Anthony Rocco](https://github.com/amrocco) had the patience to use it and report many bugs. Also most of the features in this gem came up when reviewing their usage of it. Anthony also made the effort of extracting the code from RubiconMD's codebase.
 - [Rodrigo Álvarez](https://github.com/Papipo) had the idea for the DSL and actually wrote the library.

data/injectable.gemspec

@@ -1,29 +1,29 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "injectable/version"
+require 'injectable/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'injectable'
   spec.version       = Injectable::VERSION
-  spec.authors       = %w(Papipo iovis9 jantequera amrocco)
-  spec.email         = %w(rodrigo@rubiconmd.com david.marchante@rubiconmd.com julio@rubiconmd.com anthony@rubiconmd.com)
+  spec.authors       = %w[Papipo iovis jantequera amrocco rewritten]
+  spec.email         = %w[dev@rubiconmd.com]
 
-  spec.summary       = %q{A library to help you build nice service objects with dependency injection.}
+  spec.summary       = 'A library to help you build nice service objects with dependency injection.'
   spec.homepage      = 'https://github.com/rubiconmd/injectable'
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
 
   # 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(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/injectable.rb

@@ -5,6 +5,7 @@ require 'injectable/dependencies_proxy'
 require 'injectable/dependency'
 require 'injectable/instance_methods'
 require 'injectable/missing_dependencies_exception'
+require 'injectable/method_already_exists_exception'
 
 # Convert your class into an injectable service
 #

data/lib/injectable/class_methods.rb

@@ -97,7 +97,7 @@ module Injectable
       options[:block] = block if block_given?
       options[:depends_on] = Array(options.fetch(:depends_on, []))
       options[:name] = name
-      dependencies.add(options)
+      dependencies.add(**options)
       define_method name do
         instance_variable_get("@#{name}") || dependencies_proxy.get(name)
       end

data/lib/injectable/dependency.rb

@@ -2,27 +2,57 @@ module Injectable
   # Initialize a dependency based on the options or the block passed
   Dependency = Struct.new(:name, :block, :class, :call, :with, :depends_on, keyword_init: true) do
     def instance(args: [], namespace: nil)
-      args = wrap_args(args)
-      wrap_call build_instance(args, namespace: namespace)
+      positional_args, kwargs = split_args(args)
+
+      wrap_call build_instance(positional_args, kwargs, namespace: namespace)
     end
 
     private
 
-    def wrap_args(args)
+    def split_args(args)
+      args = preprocess_args(args)
+
+      return [[], {}] if args.empty?
+
+      kwargs = args.pop
+
+      if kwargs.is_a?(Hash) && kwargs.keys.all? { |key| key.is_a?(Symbol) }
+        [args, kwargs]
+      else
+        [args << kwargs, {}]
+      end
+    end
+
+    def preprocess_args(args)
       args = with unless with.nil?
-      args.is_a?(Array) ? args : [args]
+      wrap_args(args)
+    end
+
+    def wrap_args(args)
+      args.is_a?(Array) ? args.clone : [args]
     end
 
     def wrap_call(the_instance)
       return the_instance unless call
 
-      lambda do |*args|
-        the_instance.public_send(call, *args)
+      if the_instance.respond_to? :call
+        raise Injectable::MethodAlreadyExistsException
       end
+
+      the_instance.public_method(call)
     end
 
-    def build_instance(args, namespace:)
-      block.nil? ? klass(namespace: namespace).new(*args) : block.call(*args)
+    def build_instance(args, kwargs, namespace:)
+      return build_instance_26(args, kwargs, namespace: namespace) if RUBY_VERSION < '2.7'
+
+      instantiator = block || klass(namespace: namespace).method(:new)
+      if kwargs.empty?
+        # otherwise an empty hash will be added in ruby 2.7, which could be taken as
+        # positional argument instead.
+        instantiator.call(*args)
+      else
+        instantiator.call(*args, **kwargs)
+      end
     end
 
     def klass(namespace:)
@@ -36,5 +66,11 @@ module Injectable
     def camelcased
       @camelcased ||= name.to_s.split('_').map(&:capitalize).join
     end
+
+    def build_instance_26(args, kwargs, namespace:)
+      args << kwargs if kwargs.any?
+
+      block.nil? ? klass(namespace: namespace).new(*args) : block.call(*args)
+    end
   end
 end

data/lib/injectable/method_already_exists_exception.rb

@@ -0,0 +1,4 @@
+module Injectable
+  class MethodAlreadyExistsException < RuntimeError
+  end
+end

data/lib/injectable/version.rb

@@ -1,3 +1,3 @@
 module Injectable
-  VERSION = '1.0.1'
+  VERSION = '2.1.1'.freeze
 end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: injectable
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Papipo
-- iovis9
+- iovis
 - jantequera
 - amrocco
-autorequire: 
+- rewritten
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -27,20 +28,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  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: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -55,19 +70,18 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
-- rodrigo@rubiconmd.com
-- david.marchante@rubiconmd.com
-- julio@rubiconmd.com
-- anthony@rubiconmd.com
+- dev@rubiconmd.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -83,13 +97,14 @@ files:
 - lib/injectable/dependencies_proxy.rb
 - lib/injectable/dependency.rb
 - lib/injectable/instance_methods.rb
+- lib/injectable/method_already_exists_exception.rb
 - lib/injectable/missing_dependencies_exception.rb
 - lib/injectable/version.rb
 homepage: https://github.com/rubiconmd/injectable
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,16 +112,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A library to help you build nice service objects with dependency injection.
 test_files: []