adaptor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0990c06482fe55cec104a9f0f0587f1b0d00a6b5187bfbb05d16e6acdff87f9
+  data.tar.gz: 624998b5b711ceb962a592be32c456ad0f248aa52b410e2b7672aaad1c6a07ff
+SHA512:
+  metadata.gz: 9d58b8bfa436860609a2cdbafcdea3750caa8ce0a1b0bd152755e4f74e5292769830c46033e0c31983c444cf218a9f3cd1ac350ac4fc4cab62ea06080469ef51
+  data.tar.gz: 6008e017efe35b30848983df4a392825bf217230ffb1ab1e2aca0d8cf299da41ed1bd7e78533c23cfa89bd5b542d90654e880a5a7c5221684d4366eaaee696e7

data/.gitignore

@@ -0,0 +1,12 @@
+.ruby-version
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,102 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+   - 'bin/*'
+   - 'db/**/*'
+   - 'vendor/bundle/**/*'
+   - 'spec/spec_helper.rb'
+   - 'spec/rails_helper.rb'
+   - 'spec/support/**/*'
+   - 'config/**/*'
+   - '**/Rakefile'
+   - '**/Gemfile'
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/requests/**/*'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+  AllowURI: true
+
+Layout/FirstParameterIndentation:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at desa.alessandro@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in adaptor.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    adaptor (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.1.0)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      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)
+    ruby-progressbar (1.9.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.16.3)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  adaptor!
+  bundler (~> 1.16)
+  coveralls (~> 0.8)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.52)
+  rubocop-rspec (~> 1.22)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alessandro Desantis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# 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)
+
+Adaptor makes it easy to implement the [Adapter pattern](https://en.wikipedia.org/wiki/Adapter_pattern) in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adaptor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adaptor
+
+## Usage
+
+### Single-Adaptor Mode
+
+You can use the library in single-adaptor mode:
+
+```ruby
+module DocumentProcessor
+  class Pdf
+    include Adaptor
+        
+    def self.supports?(document)
+      document.mime_type == 'application/pdf'
+    end
+    
+    def build_thumbnail
+      # ...
+    end
+  end
+  
+  class Word 
+    include Adaptor
+    
+    def self.supports?(document)
+      document.mime_type == 'application/msword'
+    end
+    
+    def build_thumbnail
+      # ...
+    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(object).build_thumbnail
+```
+
+### Multiple-Adaptor Mode
+
+If it suits your use case, you can use multiple-adaptor mode:
+
+```ruby
+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 
+    include Adaptor
+    
+    def self.supports?(notification)
+      notification.user.phone.present?
+    end
+    
+    def initialize(notification)
+      @notification = notification
+    end
+    
+    def deliver
+      # ...
+    end
+  end
+end
+
+module MultipleAdaptorLoader
+  include Adaptor::Loader
+  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)
+```
+
+## 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 
+to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/adaptor.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adaptor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'adaptor'
+  spec.version       = Adaptor::VERSION
+  spec.authors       = ['Alessandro Desantis']
+  spec.email         = ['desa.alessandro@gmail.com']
+
+  spec.summary       = 'Adaptor makes it easy to implement the Adapter pattern in Ruby.'
+  spec.homepage      = 'https://github.com/aldesantis/adaptor'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.22'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "adaptor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/adaptor.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'adaptor/version'
+require 'adaptor/loader'
+require 'adaptor/errors'
+
+# Adaptor makes it easy to implement the Adapter pattern in Ruby.
+#
+# @example Defining a new adaptor
+#   class EmailAdaptor
+#     include Adaptor
+#
+#     def self.supports?(notification)
+#       notification.recipient.email.present?
+#     end
+#   end
+module Adaptor
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    # Returns whether this adaptor supports the given object.
+    #
+    # @param [Object] _object the object to test
+    #
+    # @return [Boolean] whether the adaptor supports the object
+    def supports?(_object)
+      fail NotImplementedError
+    end
+  end
+end

data/lib/adaptor/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Adaptor
+  # This error is raised when no adaptors can be found for an object and the adaptor is loaded
+  # through {Loader::ClassMethods#load_adaptor!} or {Loader::ClassMethods#load_adaptors!}.
+  class NoAdaptorError < StandardError
+  end
+end

data/lib/adaptor/loader.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Adaptor
+  # An adaptor loader holds and loads the adapter(s) which support an object.
+  #
+  # @example Defining a loader
+  #   module NotificationProcessor
+  #     include Adaptor::Loader
+  #     register Email, Sms
+  #   end
+  module Loader
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Registers one or more new adaptors with the loader.
+      #
+      # @param [Array<Class>] klasses the adaptors to register
+      def register(*klasses)
+        klasses.each do |klass|
+          adaptors << klass unless adaptors.include?(klass)
+        end
+      end
+
+      # Returns the adaptors registered with this loader.
+      #
+      # @return [Array<Class>]
+      def adaptors
+        @adaptors ||= []
+      end
+
+      # Loads the first available adaptor for the given object.
+      #
+      # @param [Object] object the object to load the adaptor for
+      #
+      # @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)
+      end
+
+      # Loads the first available adaptor for the given object.
+      #
+      # @param [Object] object the object to load the adaptor for
+      #
+      # @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}")
+      end
+
+      # Loads all the adaptors which support the given object.
+      #
+      # @param [Object] object the object to load the adaptors for
+      #
+      # @return [Array] instances of compatible adaptors
+      def load_adaptors(object)
+        adaptors.map do |adaptor_klass|
+          next unless adaptor_klass.supports?(object)
+          adaptor_klass.new(object)
+        end.compact
+      end
+
+      # Loads all the adaptors which support the given object.
+      #
+      # @param [Object] object the object to load the adaptors for
+      #
+      # @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}")
+      end
+    end
+  end
+end

data/lib/adaptor/version.rb

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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: adaptor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alessandro Desantis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: 
+email:
+- desa.alessandro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- adaptor.gemspec
+- bin/console
+- bin/setup
+- lib/adaptor.rb
+- lib/adaptor/errors.rb
+- lib/adaptor/loader.rb
+- lib/adaptor/version.rb
+homepage: https://github.com/aldesantis/adaptor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.5
+signing_key: 
+specification_version: 4
+summary: Adaptor makes it easy to implement the Adapter pattern in Ruby.
+test_files: []