adaptor 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0990c06482fe55cec104a9f0f0587f1b0d00a6b5187bfbb05d16e6acdff87f9
-  data.tar.gz: 624998b5b711ceb962a592be32c456ad0f248aa52b410e2b7672aaad1c6a07ff
+  metadata.gz: 2cec000085cd4c4fbeee7ca6dc0ba9443733f5dcd981167e948fe9f5e78a209d
+  data.tar.gz: 71dc57e3c8157ecd56eb8cdf43434a873ec9d4369bb6ffb437446d023a67fb53
 SHA512:
-  metadata.gz: 9d58b8bfa436860609a2cdbafcdea3750caa8ce0a1b0bd152755e4f74e5292769830c46033e0c31983c444cf218a9f3cd1ac350ac4fc4cab62ea06080469ef51
-  data.tar.gz: 6008e017efe35b30848983df4a392825bf217230ffb1ab1e2aca0d8cf299da41ed1bd7e78533c23cfa89bd5b542d90654e880a5a7c5221684d4366eaaee696e7
+  metadata.gz: cef2a653b2e6f619d0d792f77aaa8969c39d66adb629926a5cacec055a9c56790cdb0c89821b755120c4e6e8d1eb33891e286e479e8666b69d8967ac67a89d5a
+  data.tar.gz: e25535ef085921a51ed8c04c4d9fb3e0aa5af09bde3229817a1a655f7a326f7fa1332d22c8b7e521ca816a5d1323847725814ceaa9bae947eefdac4caee13703

data/.rubocop.yml

@@ -5,6 +5,7 @@ AllCops:
   Include:
     - '**/Gemfile'
     - '**/Rakefile'
+    - '**/*.rb'
   Exclude:
    - 'bin/*'
    - 'db/**/*'
@@ -52,7 +53,7 @@ Style/SignalException:
 Style/BracesAroundHashParameters:
   EnforcedStyle: context_dependent
 
-Lint/EndAlignment:
+Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
   AutoCorrect: true
 

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.1]
+
+### Fixed
+
+- Fixed support for multiple arguments
+
+## [0.2.0]
+
+### Added
+
+- Added support for multiple arguments
+
+## [0.1.0]
+
+Initial release.
+
+[Unreleased]: https://github.com/aldesantis/adaptor/compare/v0.2.0...HEAD
+[0.2.1]: https://github.com/aldesantis/adaptor/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/aldesantis/adaptor/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/aldesantis/adaptor/tree/v0.1.0

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in adaptor.gemspec
 gemspec
+
+gem 'pry'

data/Gemfile.lock

@@ -1,25 +1,31 @@
 PATH
   remote: .
   specs:
-    adaptor (0.1.0)
+    adaptor (0.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    coveralls (0.8.21)
+    coderay (1.1.2)
+    coveralls (0.8.22)
       json (>= 1.8, < 3)
-      simplecov (~> 0.14.1)
+      simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.4)
       tins (~> 1.6)
     diff-lcs (1.3)
-    docile (1.1.5)
+    docile (1.3.1)
+    jaro_winkler (1.5.1)
     json (2.1.0)
+    method_source (0.9.0)
     parallel (1.12.1)
-    parser (2.4.0.2)
-      ast (~> 2.3)
-    powerpack (0.1.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.7.0)
@@ -35,18 +41,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    rubocop (0.52.1)
+    rubocop (0.58.1)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.4.0.2, < 3.0)
+      parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (1.22.2)
-      rubocop (>= 0.52.1)
+    rubocop-rspec (1.27.0)
+      rubocop (>= 0.56.0)
     ruby-progressbar (1.9.0)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
@@ -54,7 +61,7 @@ GEM
       tins (~> 1.0)
     thor (0.19.4)
     tins (1.16.3)
-    unicode-display_width (1.3.0)
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
@@ -63,10 +70,11 @@ DEPENDENCIES
   adaptor!
   bundler (~> 1.16)
   coveralls (~> 0.8)
+  pry
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop (~> 0.52)
   rubocop-rspec (~> 1.22)
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -1,9 +1,8 @@
 # Adaptor
 
-[![Build Status](https://travis-ci.org/aldesantis/adaptor-rb.svg?branch=master)](https://travis-ci.org/aldesantis/adaptor-rb)
-[![Dependency Status](https://gemnasium.com/badges/github.com/aldesantis/adaptor-rb.svg)](https://gemnasium.com/github.com/aldesantis/adaptor-rb)
-[![Coverage Status](https://coveralls.io/repos/github/aldesantis/adaptor-rb/badge.svg?branch=master)](https://coveralls.io/github/aldesantis/adaptor-rb?branch=master)
-[![Maintainability](https://api.codeclimate.com/v1/badges/e51e8d7489eb72ab97ba/maintainability)](https://codeclimate.com/github/aldesantis/adaptor-rb/maintainability)
+[![Build Status](https://travis-ci.org/aldesantis/adaptor.svg?branch=master)](https://travis-ci.org/aldesantis/adaptor)
+[![Coverage Status](https://coveralls.io/repos/github/aldesantis/adaptor/badge.svg?branch=master)](https://coveralls.io/github/aldesantis/adaptor?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e51e8d7489eb72ab97ba/maintainability)](https://codeclimate.com/github/aldesantis/adaptor/maintainability)
 
 Adaptor makes it easy to implement the [Adapter pattern](https://en.wikipedia.org/wiki/Adapter_pattern) in Ruby.
 
@@ -25,7 +24,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Single-Adaptor Mode
+### Single adaptor mode
 
 You can use the library in single-adaptor mode:
 
@@ -33,25 +32,33 @@ You can use the library in single-adaptor mode:
 module DocumentProcessor
   class Pdf
     include Adaptor
-        
+
     def self.supports?(document)
       document.mime_type == 'application/pdf'
     end
-    
+
+    def initialize(document)
+      @document = document
+    end
+
     def build_thumbnail
-      # ...
+      # something with @document
     end
   end
-  
-  class Word 
+
+  class Word
     include Adaptor
-    
+
     def self.supports?(document)
       document.mime_type == 'application/msword'
     end
-    
+
+    def initialize(document)
+      @document = document
+    end
+
     def build_thumbnail
-      # ...
+      # something with @document
     end
   end
 end
@@ -61,12 +68,12 @@ module DocumentProcessor
   register Pdf, Word
 end
 
-# You can use #load_adaptor! if you want to raise an 
-# Adaptor::NoAdaptorError when no adaptor is found. 
-thumbnail = DocumentProcessor.load_adaptor(object).build_thumbnail
+# You can use #load_adaptor! if you want to raise an
+# Adaptor::NoAdaptorError when no adaptor is found.
+thumbnail = DocumentProcessor.load_adaptor(document).build_thumbnail
 ```
 
-### Multiple-Adaptor Mode
+### Multiple adaptor mode
 
 If it suits your use case, you can use multiple-adaptor mode:
 
@@ -74,31 +81,31 @@ If it suits your use case, you can use multiple-adaptor mode:
 module NotificationProcessor
   class Email
     include Adaptor
-        
+
     def self.supports?(notification)
       notification.user.email.present?
     end
-    
+
     def initialize(notification)
       @notification = notification
     end
-    
+
     def deliver
       # ...
     end
   end
-  
-  class Sms 
+
+  class Sms
     include Adaptor
-    
+
     def self.supports?(notification)
       notification.user.phone.present?
     end
-    
+
     def initialize(notification)
       @notification = notification
     end
-    
+
     def deliver
       # ...
     end
@@ -110,15 +117,71 @@ module MultipleAdaptorLoader
   register Email, Sms
 end
 
-# You can use #load_adaptors! if you want to raise an 
-# Adaptor::NoAdaptorError when no adaptors are found. 
-NotificationProcessor.load_adaptors(notifications).each(&:deliver)
+# You can use #load_adaptors! if you want to raise an
+# Adaptor::NoAdaptorError when no adaptors are found.
+NotificationProcessor.load_adaptors(notification).each(&:deliver)
+```
+
+### Multiple arguments
+
+Note that there is no limit to the number of arguments you can pass to the adaptors' `.supports?`
+and `.new` methods. Here's an example that checks support only with one argument, but initializes
+with multiple:
+
+```ruby
+module DocumentProcessor
+  class Pdf
+    include Adaptor
+
+    def self.supports?(document)
+      document.mime_type == 'application/pdf'
+    end
+
+    def initialize(document, options)
+      @document = document
+      @options = options
+    end
+
+    def build_thumbnail
+      # something with @document and @options
+    end
+  end
+
+  class Word
+    include Adaptor
+
+    def self.supports?(document)
+      document.mime_type == 'application/msword'
+    end
+
+    def initialize(document, options)
+      @document = document
+      @options = options
+    end
+
+    def build_thumbnail
+      # something with @document and @options
+    end
+  end
+end
+
+module DocumentProcessor
+  include Adaptor::Loader
+  register Pdf, Word
+end
+
+# You can use #load_adaptor! if you want to raise an
+# Adaptor::NoAdaptorError when no adaptor is found.
+thumbnail = DocumentProcessor.load_adaptor(document, stamp: true).build_thumbnail
 ```
 
+As you can see, whatever you pass to `.load_adaptor` or `.load_adaptors` will be forwarded to
+`.supports?` and `.new`, according to the methods' respective arity.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/aldesantis/adaptor-rb. This 
-project is intended to be a safe, welcoming space for collaboration, and contributors are expected 
+Bug reports and pull requests are welcome on GitHub at https://github.com/aldesantis/adaptor. This
+project is intended to be a safe, welcoming space for collaboration, and contributors are expected
 to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
@@ -127,5 +190,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Adaptor project’s codebases, issue trackers, chat rooms and mailing 
+Everyone interacting in the Adaptor project’s codebases, issue trackers, chat rooms and mailing
 lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/adaptor/blob/master/CODE_OF_CONDUCT.md).

data/lib/adaptor/loader.rb

@@ -32,46 +32,65 @@ module Adaptor
 
       # Loads the first available adaptor for the given object.
       #
-      # @param [Object] object the object to load the adaptor for
+      # @param [Array] args any arguments to pass to the adaptor's +.supports?+ and +.new+
       #
       # @return [Object|NilClass] an instance of the adpator or nil if no adaptor was found
-      def load_adaptor(object)
-        adaptors.find { |adaptor_klass| adaptor_klass.supports?(object) }&.new(object)
+      def load_adaptor(*args)
+        adaptor_klass = adaptors.find do |klass|
+          adaptor_supports?(klass, args)
+        end
+
+        instantiate_adaptor(adaptor_klass, args) if adaptor_klass
       end
 
       # Loads the first available adaptor for the given object.
       #
-      # @param [Object] object the object to load the adaptor for
+      # @param [Array] args any arguments to pass to the adaptor's +.supports?+ and +.new+
       #
       # @return [Object] an instance of the adaptor
       #
       # @raise [NoAdaptorError] when no adaptor was found
-      def load_adaptor!(object)
-        load_adaptor(object) || fail(NoAdaptorError, "No adaptor found for #{object}")
+      def load_adaptor!(*args)
+        load_adaptor(*args) || fail(NoAdaptorError, "No adaptor found for #{args.inspect}")
       end
 
       # Loads all the adaptors which support the given object.
       #
-      # @param [Object] object the object to load the adaptors for
+      # @param [Array] args any arguments to pass to the adaptors' +.supports?+ and +.new+
       #
       # @return [Array] instances of compatible adaptors
-      def load_adaptors(object)
+      def load_adaptors(*args)
         adaptors.map do |adaptor_klass|
-          next unless adaptor_klass.supports?(object)
-          adaptor_klass.new(object)
+          next unless adaptor_supports?(adaptor_klass, args)
+          instantiate_adaptor(adaptor_klass, args)
         end.compact
       end
 
       # Loads all the adaptors which support the given object.
       #
-      # @param [Object] object the object to load the adaptors for
+      # @param [Array] args any arguments to pass to the adaptors' +.supports?+ and +.new+
       #
       # @return [Array] instances of compatible adaptors
       #
       # @raise [NoAdaptorError] when no adaptors are found
-      def load_adaptors!(object)
-        adaptors = load_adaptors(object)
-        adaptors.any? ? adaptors : fail(NoAdaptorError, "No adaptors found for #{object}")
+      def load_adaptors!(*args)
+        adaptors = load_adaptors(*args)
+        adaptors.any? ? adaptors : fail(NoAdaptorError, "No adaptors found for #{args.inspect}")
+      end
+
+      private
+
+      def adaptor_supports?(adaptor, args)
+        adaptor.supports?(*cut_args(args, method: adaptor.method(:supports?)))
+      end
+
+      def instantiate_adaptor(adaptor, args)
+        adaptor.new(*cut_args(args, method: adaptor.method(:new)))
+      end
+
+      def cut_args(args, method:)
+        arity = method.arity
+        arity.negative? ? args : args[0..(arity - 1)]
       end
     end
   end

data/lib/adaptor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Adaptor
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adaptor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2018-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -105,6 +105,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -138,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Adaptor makes it easy to implement the Adapter pattern in Ruby.