middlewear 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0a549a0b6aa91d2825af567d6dde24249ec950c
+  data.tar.gz: 776faf538a84ffbf99f4dfa48f045b45501115fc
+SHA512:
+  metadata.gz: c0afe5943351fbbd86dcc85e81e204158c1d92546b2d4391b8f7c93cfdb2bb80e8e63d0cdf42556d300d9867c4f95cb5f9d7a5b9977f69c36f68e961adf23492
+  data.tar.gz: ca81bc8865e8b0271146cac52a13d2b2a720fbabe9b52149990af2e38c10e9be89c42c6316e047e98a5c67c96f688849683975a28957ac14a27d9824ad2ee52a

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.7
+before_install: gem install bundler -v 1.11.2

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 sax@livinginthepast.org. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middlewear.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Eric Saxby
+
+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,80 @@
+Middlewear
+==========
+
+Add a middleware stack to any project.
+
+
+## Usage
+
+To avoid possible contamination of stacks if multiple projects are used that depend on it, create your own middleware
+module:
+
+```ruby
+require 'middlewear'
+
+module MyApp
+  module Middleware
+    include Middlewear
+  end
+end
+```
+
+Now you can add middleware to the stack. Middleware classes can be written in such a way as to accept arguments.
+
+```ruby
+MyApp::Middleware.add(MyMiddleware)
+MyApp::Middleware.add(MyArgumentativeMiddleware, 'foo')
+```
+
+Users will be able to manipulate a middleware stack after the fact:
+
+```ruby
+MyApp::Middleware.delete(SomeMiddleware)
+MyApp::Middleware.insert_before(SomeMiddleware, OtherMiddleware)
+MyApp::Middleware.insert_after(SomeMiddleware, OtherMiddleware)
+MyApp::Middleware.insert_after(SomeMiddleware, OtherMiddleware, 'with', 'arguments')
+```
+
+Middleware should be written in the following format:
+
+```ruby
+class MyMiddleware
+  def initialize(app)
+    @app = app
+  end
+  
+  def call(foo)
+    puts foo        # do some arbitrary work
+    @app.call(foo)  # ensure that the rest of the middleware stack is called
+  end
+end
+```
+
+Now in order to actually process the stack, use the `#app` method provided on the module:
+
+```ruby
+MyApp::Middleware.app.call(foo) do |foo|
+  # do
+  # the
+  # actual
+  # application
+  # stuff
+end
+```
+
+Note that we pass a single argument to the `#call` method. This is arbitrary. Middleware can be written to take any
+number of arguments, so long as all of the registered middleware matches the call signature and it matches the number
+of arguments of the block passed to `app.call`.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/middlewear. This project is i
+ntended 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/middlewear/app.rb

@@ -0,0 +1,26 @@
+module Middlewear
+  # An App is instantiated and given a stack of instantiated Middleware objects.
+  # An app can by called with multiple arguments, excepting for the fact that the
+  # call signature used must match every middleware in the stack. It can be called
+  # with a block, which gets appended to the chain.
+  #
+  # Usage:
+  #
+  #   app = App.new
+  #   middleware = Middleware.new(app)
+  #   app.stack = [middleware]
+  #
+  #   app.call(message) do |message|
+  #     # do work
+  #   end
+  #
+  class App
+    attr_accessor :stack
+
+    def call(*args, &block)
+      stack << block if block_given?
+      current_register = stack.shift
+      current_register.call(*args) if current_register
+    end
+  end
+end

data/lib/middlewear/errors.rb

@@ -0,0 +1,5 @@
+module Middlewear
+  class Error < StandardError; end
+  class MiddlewareNotFound < Error; end
+  class DuplicateMiddleware < Error; end
+end

data/lib/middlewear/registry.rb

@@ -0,0 +1,46 @@
+module Middlewear
+  # A Register of a middleware class that messages will be passed through
+  # on the way to being dispatched.
+  class Register < Struct.new(:klass, :args)
+    def create_new(app)
+      klass.new(app, *args)
+    end
+  end
+
+  # Registry holds records of each middleware class that is added to the
+  # consumer middleware chain.
+  class Registry
+    include Enumerable
+
+    attr_reader :registry
+
+    def initialize(registry = [])
+      @registry = registry
+    end
+
+    def all
+      registry
+    end
+
+    def each(&blk)
+      all.each(&blk)
+    end
+
+    def delete(klass)
+      registry.reject! { |register| register.klass == klass }
+    end
+
+    def <<(klass_args)
+      insert(-1, klass_args[0], klass_args[1])
+    end
+
+    def index_of(klass)
+      registry.find_index { |register| register.klass == klass }
+    end
+
+    def insert(index, klass, args)
+      raise DuplicateMiddleware if index_of(klass)
+      registry.insert(index, Register.new(klass, args))
+    end
+  end
+end

data/lib/middlewear/version.rb

@@ -0,0 +1,3 @@
+module Middlewear
+  VERSION = '0.1.0'
+end

data/lib/middlewear.rb

@@ -0,0 +1,51 @@
+require 'middlewear/app'
+require 'middlewear/errors'
+require 'middlewear/registry'
+require 'middlewear/version'
+
+module Middlewear
+  def self.included(base)
+    base.send(:extend, ClassMethods)
+  end
+
+  module ClassMethods
+    def add(klass, *args)
+      registry << [klass, args]
+    end
+
+    def add_before(before_klass, klass, *args)
+      idx = registry.index_of(before_klass)
+      raise MiddlewareNotFound.new("#{before_klass} not registered in middleware stack") unless idx
+      registry.insert(idx, klass, args)
+    end
+
+    def add_after(after_klass, klass, *args)
+      idx = registry.index_of(after_klass)
+      raise MiddlewareNotFound.new("#{after_klass} not registered in middleware stack") unless idx
+      registry.insert(idx + 1, klass, args)
+    end
+
+    def delete(klass)
+      registry.delete(klass)
+    end
+
+    # The current registry of middleware. Note that this registry is not a set
+    # of instantiated middleware objects, but a registry of the classes themselves.
+    def registry
+      @registry ||= Registry.new
+    end
+
+    def create_stack(app)
+      registry.map { |r| r.create_new(app) }
+    end
+
+    # When called, this creates a new instance of an App with new instances of
+    # each registered middleware. To avoid contamination between calls, this
+    # instantiates a new set of objects each time it is called.
+    def app
+      App.new.tap do |app|
+        app.stack = create_stack(app)
+      end
+    end
+  end
+end

data/middlewear.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middlewear/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'middlewear'
+  spec.version       = Middlewear::VERSION
+  spec.authors       = ['Eric Saxby']
+  spec.email         = ['sax@livinginthepast.org']
+
+  spec.summary       = %q{Generic middleware registry and runner}
+  spec.description   = %q{Generic middleware registry and runner}
+  spec.homepage      = 'https://github.com/messagebus/middlewear'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: middlewear
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Saxby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: Generic middleware registry and runner
+email:
+- sax@livinginthepast.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/middlewear.rb
+- lib/middlewear/app.rb
+- lib/middlewear/errors.rb
+- lib/middlewear/registry.rb
+- lib/middlewear/version.rb
+- middlewear.gemspec
+homepage: https://github.com/messagebus/middlewear
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Generic middleware registry and runner
+test_files: []