handler_registerable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40814232bc83eb10f4be63141b15f20985a51f41
+  data.tar.gz: 3f6c9f5905cd2e357d6a80609cd6e237fce24be2
+SHA512:
+  metadata.gz: dd6baaa5db10da81336a247eaf8625954234a0d21ad707b2fc30477c69c229dbf62cbc66e021a2ef395b798e564efee04421ea87984851ada6e52cfc02ad081f
+  data.tar.gz: c0eeb6fa7718816a7bb58e85ea98989c2983fb1d1467a4df3e3c387f0b8143262145f818613be2fcc92056566f80b2f1abf5bf242d947bbd8a56fc89e3710350

data/lib/handler_registerable.rb

@@ -0,0 +1,10 @@
+# Module which can be extended into a class/module to provide the following class methods:
+#
+# registered_handlers - returns a hash which can be modified
+# obtain - loop sthrough all registered handlers and returns the first one that handles the
+# given condition (tested by calling the handles? class method on the handler class)
+module HandlerRegisterable
+  autoload :Exceptions, 'handler_registerable/exceptions'
+  autoload :Registry, 'handler_registerable/registry'
+  autoload :Version, 'handler_registerable/version'
+end

data/lib/handler_registerable/exceptions.rb

@@ -0,0 +1,6 @@
+module HandlerRegisterable
+  # Exceptions
+  module Exceptions
+    autoload :NoHandlerAccepted, 'handler_registerable/exceptions/no_handler_accepted'
+  end
+end

data/lib/handler_registerable/exceptions/no_handler_accepted.rb

@@ -0,0 +1,12 @@
+module HandlerRegisterable
+  # Exceptions
+  module Exceptions
+    # Exception when no handler meets the conditions
+    class NoHandlerAccepted < StandardError
+      # Meaningful message when for this exception
+      def message
+        "No Handler Accepted"
+      end
+    end
+  end
+end

data/lib/handler_registerable/registry.rb

@@ -0,0 +1,52 @@
+# HandlerRegisterable Registry
+module HandlerRegisterable
+  # Registry Concept
+  module Registry
+    # Enables setting the default handler to use.
+    def default=(value)
+      @default = value
+    end
+
+    # Get the default handler
+    def default
+      @default
+    end
+
+    # Register a new item in the store
+    def register(item, key)
+      registered_handlers[key] = item
+    end
+
+    # Return the registered handlers
+    def registered_handlers
+      @registered_handlers ||= {}
+    end
+
+    # @param [Object] conditions An argument to be passed to the handles? and initialize methods
+    # of the handler classes. Used to determine if they can deal with the request or not.
+    # @return [Object, nil] An instance of the first handler class that returns true to handles?
+    # when given the condition argument. The instance is initialized with the given condition.
+    def obtain(*conditions)
+      registered_handlers = self.registered_handlers
+      # Reverses the order of the handlers, this allows for ones defined in an application rather
+      # than an engine to come first (to allow for overriding a handle)
+      registered_handlers = Hash[registered_handlers.to_a.reverse] unless no_handlers_defined?
+      registered_handlers.each do |identifier, h|
+        return h.new(*conditions) if h.handles?(*conditions)
+      end
+
+      # If no handler is found and there is a default, use that instead
+      if default
+        default.new(*conditions)
+      else
+        raise HandlerRegisterable::Exceptions::NoHandlerAccepted
+      end
+    end
+
+    private
+
+    def no_handlers_defined?
+      self.registered_handlers.nil? || self.registered_handlers.empty?
+    end
+  end
+end

data/lib/handler_registerable/version.rb

@@ -0,0 +1,4 @@
+module HandlerRegisterable
+  # Define gem version
+  VERSION = '0.0.1'
+end

data/spec/exceptions_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe HandlerRegisterable::Exceptions::NoHandlerAccepted do
+  subject { described_class.new }
+
+  it 'returns a custom message' do
+    expect(subject.message).to eq('No Handler Accepted')
+  end
+
+  it 'is an instance of StandardError' do
+    expect(subject).to be_a_kind_of(StandardError)
+  end
+end

data/spec/registry_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe HandlerRegisterable::Registry do
+  class TestHandlerRegistry
+    extend HandlerRegisterable::Registry
+  end
+
+  subject { TestHandlerRegistry }
+
+  describe 'obtain' do
+    context 'when no handler is found for the given condition' do
+      it "raises an exception" do
+        expect { subject.obtain('unknown') }.to raise_error(HandlerRegisterable::Exceptions::NoHandlerAccepted)
+      end
+
+      it "is a standard error which can be caught" do
+        rescued = false
+        begin
+          subject.obtain('this handler does not exist')
+        rescue
+          rescued = true
+        end
+
+        expect(rescued).to be_truthy
+      end
+    end
+
+    context 'when no handler is found but a default has been set' do
+      let(:default_handler) do
+        Class.new do
+          def initialize(condition)
+            @condition = condition
+          end
+        end
+      end
+
+      around :each do |example|
+        original = TestHandlerRegistry.default
+        TestHandlerRegistry.default = default_handler
+
+        example.run
+
+        TestHandlerRegistry.default = original
+      end
+
+      it 'will call the default handler' do
+        expect(default_handler).to receive(:new)
+        subject.obtain('unknown')
+      end
+
+      it 'will not raise an exception' do
+        expect { subject.obtain('unknown') }.to_not raise_error
+      end
+    end
+  end
+
+  context 'when a handler is found for the given condition' do
+    let(:handler_one) do
+      Class.new do
+        def initialize(condition)
+          @condition = condition
+        end
+
+        def self.handles?(condition)
+          condition == :test
+        end
+      end
+    end
+
+    let(:handler_two) do
+      Class.new do
+        def initialize(condition)
+          @condition = condition
+        end
+
+        def self.handles?(condition)
+          condition == :other_test
+        end
+      end
+    end
+
+    it 'returns the correct handler' do
+      TestHandlerRegistry.register handler_one, :handler_one
+      TestHandlerRegistry.register handler_two, :handler_two
+
+      expect(TestHandlerRegistry.obtain(:test)).to be_an_instance_of(handler_one)
+      expect(TestHandlerRegistry.obtain(:other_test)).to be_an_instance_of(handler_two)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/'
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.requires = ['handler_registerable']
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: handler_registerable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sage One Development Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: fudge
+  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: simplecov
+  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: cane
+  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: flay
+  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: flog
+  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: yard
+  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'
+description: A gem to provide handler registry functionality
+email: support@sageone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/handler_registerable.rb
+- lib/handler_registerable/exceptions.rb
+- lib/handler_registerable/exceptions/no_handler_accepted.rb
+- lib/handler_registerable/registry.rb
+- lib/handler_registerable/version.rb
+- spec/exceptions_spec.rb
+- spec/registry_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.github.com/Sage/handler_registerable
+licenses:
+- Apache-2.0
+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.6.12
+signing_key: 
+specification_version: 4
+summary: A gem to provide handler registry functionality
+test_files:
+- spec/spec_helper.rb
+- spec/exceptions_spec.rb
+- spec/registry_spec.rb
+has_rdoc: