chain_of_responsibility 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf3c8c0e99685e1f360c4994b7863d0b54829eab
+  data.tar.gz: ad928480a019247e3dbe2d66ef4c4b6592abc180
+SHA512:
+  metadata.gz: b2edddc4044ffb15dbe2b2f118b7de786bcdab1eb58143608946cdb3c956d8ffefb1be60967424f52b2d33e6d0eaafb02215fc9e0e6a2061219b32044ad03149
+  data.tar.gz: 35b07a2cb18d44e46c29e7c2e5140b7f8bcfae3976635ea6173efc85a77d7b097ac02a2e638010824e9f380d18e8ba8a5baa897130a7ea8d7e1c9383eabe08e0

data/.circleci/config.yml

@@ -0,0 +1,33 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.3
+
+    steps:
+      - checkout
+
+      - run:
+          name: Setup Code Climate test-reporter
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+
+      - run:
+          name: Install dependencies
+          command: bundle install --path vendor/bundle
+
+      - run:
+          name: Run tests
+          command: |
+            ./cc-test-reporter before-build
+            bundle exec rspec --format progress --color
+            ./cc-test-reporter after-build --coverage-input-type simplecov --exit-code $?
+
+      - run:
+          name: Run linter
+          command: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,19 @@
+inherit_gem:
+  sanelint:
+    - config/default.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Rails/Delegate:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kacper.pucek@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in chain_of_responsibility.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 KacperPucek
+
+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,132 @@
+# chain_of_responsibility
+
+[![CircleCI](https://circleci.com/gh/KacperPucek/chain_of_responsibility.svg?style=shield)](https://circleci.com/gh/KacperPucek/chain_of_responsibility)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b9b001acc0dfd25d0c19/maintainability)](https://codeclimate.com/github/KacperPucek/chain_of_responsibility/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/b9b001acc0dfd25d0c19/test_coverage)](https://codeclimate.com/github/KacperPucek/chain_of_responsibility/test_coverage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "chain_of_responsibility"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chain_of_responsibility
+
+## About
+
+Some time ago I've stumbled upon pretty nice [article](http://rubyblog.pro/2017/11/chain-of-responsibility-ruby) written by *Sergii Makagon* about a chain of
+responsibility pattern which I highly encourage you to read.
+
+The main idea is that we can change nasty `if/else` statements to a chain of
+handlers that can decide whether they are applicable or not. Handlers
+are specified in the certain order and when we get a match we resolve using an appropriate handler.
+
+This `gem` provides a tiny wrapper to make defining `chains` nicer. It's pretty minimal so feel free to simply copy the source code and adjust it to your needs if you wish.
+
+## Usage
+
+A chain is composed of handlers defined in a specific order which are called one by one until
+there's a handler that can handle the request. If none of the handlers can be used, error will
+be raised.
+
+### Handlers
+
+Handlers should inherit from `ChainOfResponsibility::Handler` and define `applicable?` and `resolve` methods that can take an arbitrary number of arguments (but both the same).
+
+Example:
+
+```ruby
+module Handlers
+  class WelcomeEmailHandler < ChainOfResponsibility::Handler
+    def applicable?(user)
+      user.registered? && user.confirmed?
+    end
+
+    def resolve(user)
+      # send email
+    end
+  end
+end
+```
+
+### Chain
+
+Once you have your specific handlers defined, you can easily compose them.
+
+Example
+
+```ruby
+module Handlers
+  class Passing < ChainOfResponsibility::Handler
+    def applicable?
+      true
+    end
+
+    def resolve
+      :ok
+    end
+  end
+end
+
+module Handlers
+  class Failing < ChainOfResponsibility::Handler
+    def applicable?
+      false
+    end
+
+    def resolve
+      # won't be reached
+    end
+  end
+end
+
+class PassingTransaction
+  include ChainOfResponsibility
+
+  def_handler Handlers::Failing
+  def_handler Handlers::Passing
+
+  def call
+    chain.call
+  end
+end
+
+PassingTransaction.new.call # => :ok
+
+class FailingTransation
+  include ChainOfResponsibility
+
+  def_handler Handlers::Failing
+
+  def call
+    chain.call
+  end
+end
+
+FailingTransation.new.call # => ChainOfResponsibility::NoAppropriateHandlerFoundError
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/KacperPucek/chain_of_responsibility. 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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chain_of_responsibility"
+
+# 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

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/chain_of_responsibility.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chain_of_responsibility/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chain_of_responsibility"
+  spec.version       = ChainOfResponsibility::VERSION
+  spec.authors       = ["KacperPucek"]
+  spec.email         = ["kacper.pucek@gmail.com"]
+
+  spec.summary       = "Ruby implementation of Chain of Responsibility pattern."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/KacperPucek/chain_of_responsibility"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sanelint", "~> 1.0"
+  spec.add_development_dependency "simplecov", "~> 0.16.1"
+end

data/lib/chain_of_responsibility.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "chain_of_responsibility/handler"
+
+module ChainOfResponsibility
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def handlers
+      @handler ||= []
+    end
+
+    def def_handler(handler)
+      handlers << handler
+    end
+  end
+
+  def chain
+    build_chain(self.class.handlers)
+  end
+
+  private
+
+  def build_chain(handlers)
+    handler, *remaining = handlers
+
+    if remaining.empty?
+      handler.new
+    else
+      handler.new(build_chain(remaining))
+    end
+  end
+end

data/lib/chain_of_responsibility/errors/method_not_implemented_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ChainOfResponsibility
+  MethodNotImplementedError = Class.new(StandardError)
+end

data/lib/chain_of_responsibility/errors/no_appropriate_handler_found_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ChainOfResponsibility
+  NoAppropriateHandlerFoundError = Class.new(StandardError)
+end

data/lib/chain_of_responsibility/handler.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "chain_of_responsibility/errors/method_not_implemented_error"
+require "chain_of_responsibility/missing_successor"
+
+module ChainOfResponsibility
+  class Handler
+    def initialize(successor = MissingSuccessor.new)
+      @successor = successor
+    end
+
+    attr_reader :successor
+
+    def call(*args)
+      if applicable?(*args)
+        resolve(*args)
+      else
+        successor.call(*args)
+      end
+    end
+
+    def resolve(*)
+      raise MethodNotImplementedError, "resolve"
+    end
+
+    def applicable?(*)
+      raise MethodNotImplementedError, "applicable?"
+    end
+  end
+end

data/lib/chain_of_responsibility/missing_successor.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "chain_of_responsibility/errors/no_appropriate_handler_found_error"
+
+module ChainOfResponsibility
+  class MissingSuccessor
+    def call(*)
+      raise NoAppropriateHandlerFoundError
+    end
+  end
+end

data/lib/chain_of_responsibility/version.rb

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

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: chain_of_responsibility
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- KacperPucek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: sanelint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: Ruby implementation of Chain of Responsibility pattern.
+email:
+- kacper.pucek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chain_of_responsibility.gemspec
+- lib/chain_of_responsibility.rb
+- lib/chain_of_responsibility/errors/method_not_implemented_error.rb
+- lib/chain_of_responsibility/errors/no_appropriate_handler_found_error.rb
+- lib/chain_of_responsibility/handler.rb
+- lib/chain_of_responsibility/missing_successor.rb
+- lib/chain_of_responsibility/version.rb
+homepage: https://github.com/KacperPucek/chain_of_responsibility
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of Chain of Responsibility pattern.
+test_files: []
+has_rdoc: