ibsciss-middleware 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2885d91b0fe8a07086ee6e68f40194cce36747c9
-  data.tar.gz: d4b6288f7aec993be1640244c6b5d193b27e2ffe
+  metadata.gz: ab6d4d8a9225726d9aa68a41d4be42bcac71bc23
+  data.tar.gz: 4df6dce76dca18f51c8af01a3be56e5861d8fe4e
 SHA512:
-  metadata.gz: 8e3fa59de3b97d5f38e0b8a4588a1e3babca6bdb885eecb6351ff960e1e485e7763e3a6803949e98448a7ddbc19e756af64f8f2a6abacfa1329c64f72679c6ae
-  data.tar.gz: 57e79ebd22365b169dff558b248fc50bd05b425b2ba609a9bc654b426111ae0822e78ce6dcc51c3cf5194a78c868cbe4518b7995ddd5aa5da6e952a82fb9c0cd
+  metadata.gz: e33e2f98cc16cf4dcf6ee076cf1734b1cf8bac3ef17daf7d8aa97636510d739e4af7f851d0adacb75444844e3c9eba401e5f22c787406adac6badab48ffc7ab4
+  data.tar.gz: c9f1537de72e76797a690c23646640655ca9ed4adfbefae661bef899cac998efb073d199ab9ec3854de9a4cbfa9d4e36322b24d2c201be2530528fcafd9cb734

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.3.2
+  - Add CI & Code Climate & Improve documentation
+
+## 0.3.1
+  - Enable lambda to change the given object
+
 ## 0.3.0
   - Apply https://github.com/Ibsciss/ruby-middleware/commit/01f75d8e4137b39ea907f13756f21cba4edffaa7
   - Apply https://github.com/Ibsciss/ruby-middleware/commit/00aa09353f7ee2b801bdb446418a936640ae56d7

data/LICENSE

@@ -1,3 +1,4 @@
+Copyright (c) 2015 Arnaud LEMAIRE
 Copyright (c) 2012 Mitchell Hashimoto
 
 MIT License

data/README.md

@@ -1,11 +1,21 @@
+[![Code Climate](https://codeclimate.com/github/Ibsciss/ruby-middleware/badges/gpa.svg)](https://codeclimate.com/github/Ibsciss/ruby-middleware) 
+[![Test Coverage](https://codeclimate.com/github/Ibsciss/ruby-middleware/badges/coverage.svg)](https://codeclimate.com/github/Ibsciss/ruby-middleware)
+[![Build Status](https://semaphoreci.com/api/v1/projects/c5797935-6c93-4596-a8a8-bd45c8c584e9/393201/shields_badge.svg)](https://semaphoreci.com/lilobase/ruby-middleware)
+
 # Middleware
 
-`middleware` is a library which provides a generalized implementation
-of the middleware pattern for Ruby. The middleware pattern is a useful
+[![Join the chat at https://gitter.im/Ibsciss/ruby-middleware](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Ibsciss/ruby-middleware?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+`Middleware` is a library which provides a generalized implementation
+of the [chain of responsibility pattern](http://en.wikipedia.org/wiki/Chain-of-responsibility_pattern) for Ruby.
+
+This pattern is used in `Rack::Builder` or `ActionDispatch::MiddlewareStack` to manage a stack of middlewares. This gem is a generic implementation for any Ruby project.
+ 
+ The middleware pattern is a useful
 abstraction tool in various cases, but is specifically useful for splitting
 large sequential chunks of logic into small pieces.
 
-This library was created by Mitchell Hashimoto, original repository: https://github.com/mitchellh/middleware
+This is an updated version of the original Mitchell Hashimoto's library: https://github.com/mitchellh/middleware
 
 ## Installing
 
@@ -15,6 +25,18 @@ Middleware is distributed as a RubyGem, so simply gem install:
 $ gem install ibsciss-middleware
 ```
 
+Or, in your Gemfile:
+
+```
+gem 'ibsciss-middleware', '~> 0.3'
+```
+
+Then, you can add it to your project:
+
+```ruby
+require 'middleware'
+```
+
 ## A Basic Example
 
 Below is a basic example of the library in use. If you don't understand
@@ -61,7 +83,6 @@ And the output:
 ```
 
 
-
 ## Middleware
 
 ### What is it?
@@ -103,9 +124,9 @@ class Trace
   end
 
   def call(env)
-    puts "Trace up"
+    puts "Before next middleware execution"
     @app.call(env)
-    puts "Trace down"
+    puts "After next middleware execution"
   end
 end
 ```
@@ -119,14 +140,39 @@ A basic description of the two methods that a middleware must implement:
     state sent in (defined by the caller, but usually a Hash). This call should also
     call `app.call(env)` at some point to move on.
 
+This architecture offers the biggest advantage of letting you enhance the env variable before passing it to the next middleware, 
+and giving you the abilities to change the returned datas, as follow:
+
+```ruby
+class Greeting
+  def initialize(app, append = nil)
+    @app = app
+    @datas = datas
+  end
+  
+  def call(env)
+    env = "#{append} #{env}"
+    result = @app(env)
+    "#{result} !"
+  end
+end
+
+Middleware::Builder.new { |b|
+  b.use Greeting, 'Hello'
+}.call('John') #return "Hello John !"
+```
+
 ### Middleware Lambdas
 
 A middleware can also be a simple lambda. The downside of using a lambda is that
 it only has access to the state on the initial call, there is no "post" step for
-lambdas. A basic example, in the context of a web request:
+lambdas:
 
 ```ruby
-lambda { |env| puts "You requested: #{env["http.request_url"]}" }
+Middleware::Builder.new { |b|
+  b.use lambda { |env| env + 3 }
+  b.use lambda { |env| env * 2 }
+}.call(1) #return 8
 ```
 
 ## Middleware Stacks
@@ -148,10 +194,12 @@ end
 ```
 
 This `stack` variable itself is now a valid middleware and has the same interface,
-so to execute the stack, just call `call` on it:
+so to execute the stack, just call `call` on it, so can compose middleware stack between them:
 
 ```ruby
-stack.call
+Middleware::Builder.new do |d|
+  d.use stack
+end.call()
 ```
 
 The call method takes an optional parameter which is the state to pass into the
@@ -165,15 +213,62 @@ created. Given the `stack` variable created above, we can manipulate it as
 follows. Please imagine that each example runs with the original `stack` variable,
 so that the order of the examples doesn't actually matter:
 
+#### Insert before
+
+```ruby
+# Insert a new item before the Trace middleware
+stack.insert_before Trace, SomeOtherMiddleware
+
+# Insert a new item at the top of the middleware stack
+stack.insert_before 0, SomeOtherMiddleware
+```
+
+#### Insert after
+
 ```ruby
 # Insert a new item after the Trace middleware
 stack.insert_after(Trace, SomeOtherMiddleware)
 
-# Replace the lambda
+# Insert a new item after the first middleware
+stack.insert_after(0, SomeOtherMiddleware)
+```
+
+#### Insert after each
+
+```ruby
+logger = lambda { |env| p env }
+
+# Insert the middleware (can be also a middleware object) after each existing middleware
+stack.insert_after_each logger
+```
+
+#### Insert before each
+
+```ruby
+logger = lambda { |env| p env }
+
+# Insert the middleware (can be also a middleware object) before each existing middleware
+stack.insert_before_each logger
+```
+
+#### Replace
+
+```ruby
+# Replace the first middleware
 stack.replace(1, SomeOtherMiddleware)
 
+# Replace the Trace middleware
+stack.replace(Trace, SomeOtherMiddleware)
+```
+
+#### Delete
+
+```ruby
 # Delete the lambda
 stack.delete(1)
+
+# Delete the Trace middleware
+stack.delete(Trace)
 ```
 
 ### Passing Additional Constructor Arguments
@@ -206,3 +301,31 @@ end
 Then when the stack is called, it will output "Hello, World!"
 
 Note that you can also pass blocks in using the `use` method.
+
+#### Lambda
+
+Lambda work the same with additional arguments:
+
+```ruby
+Middleware::Builder.new { |b|
+  # arrow syntax for lambda construction
+  b.use ->(env, msg) { puts msg }, 'some message'
+}.call(1) #will print "some message"
+```
+
+### Debug
+
+You can see the content of a given stack using the `inspect` method
+
+```ruby
+Middleware::Builder.new { |b|
+  b.use Trace
+  b.use Echo, "Hello, World!"
+}.inspect
+```
+
+the output will be
+
+```ruby
+[Trace(), Echo("Hello, World!")]
+```

data/lib/middleware/builder.rb

@@ -92,6 +92,20 @@ module Middleware
       insert(index + 1, middleware, *args, &block)
     end
 
+    # Inserts a middleware before each middleware object
+    def insert_before_each(middleware, *args, &block)
+      self.stack = stack.reduce([]) do |carry, item|
+        carry.push([middleware, args, block], item)
+      end
+    end
+
+    # Inserts a middleware after each middleware object
+    def insert_after_each(middleware, *args, &block)
+      self.stack = stack.reduce([]) do |carry, item|
+        carry.push(item, [middleware, args, block])
+      end
+    end
+
     # Replaces the given middleware object or index with the new
     # middleware.
     def replace(index, middleware, *args, &block)
@@ -115,6 +129,12 @@ module Middleware
       to_app.call(env)
     end
 
+    def inspect
+      "[" + stack.reduce([]) { |carry, middleware|
+        carry << "#{middleware[0].class.name}(#{middleware[1].join(', ')})"
+      }.join(', ') + "]"
+    end
+
     protected
 
     # Returns the numeric index for the given middleware object.
@@ -137,11 +157,19 @@ module Middleware
       @stack ||= []
     end
 
+    # you shouldn't use this method
+    #
+    # @return [Array]
+    def stack= stack
+      @stack = stack
+    end
+
     # Converts the builder stack to a runnable action sequence.
     #
     # @return [Object] A callable object
     def to_app
       @runner_class.new(stack.dup)
     end
+
   end
 end

data/lib/middleware/runner.rb

@@ -57,7 +57,7 @@ module Middleware
           # Make it a lambda which calls the item then forwards up
           # the chain.
           lambda do |env|
-            next_middleware.call(klass.call(env))
+            next_middleware.call(klass.call(env, *args))
           end
         else
           raise "Invalid middleware, doesn't respond to `call`: #{klass.inspect}"

data/middleware.gemspec

@@ -8,15 +8,16 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/ibsciss/ruby-middleware"
   gem.license       = "MIT"
 
-  gem.add_development_dependency "rake", "~> 1.6"
+  gem.add_development_dependency "rake", "~> 10.4.2"
   gem.add_development_dependency "rspec-core", "~> 3.2"
   gem.add_development_dependency "rspec-expectations", "~> 3.2"
   gem.add_development_dependency "rspec-mocks", "~> 3.2"
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.7'
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "ibsciss-middleware"
   gem.require_paths = ["lib"]
-  gem.version       = '0.3.1'
+  gem.version       = '0.3.2'
 end

data/spec/middleware/builder_spec.rb

@@ -126,13 +126,22 @@ describe Middleware::Builder do
         to raise_error(RuntimeError)
     end
 
-    it "can insert after" do
+    it "can insert after each" do
       instance.use appender_proc(1)
+      instance.use appender_proc(2)
       instance.use appender_proc(3)
-      instance.insert_after 0, appender_proc(2)
+      instance.insert_after_each appender_proc(9)
       instance.call(data)
+      expect(data[:data]).to eq [1, 9, 2, 9, 3, 9]
+    end
 
-      expect(data[:data]).to eq [1, 2, 3]
+    it "can insert before each" do
+      instance.use appender_proc(1)
+      instance.use appender_proc(2)
+      instance.use appender_proc(3)
+      instance.insert_before_each appender_proc(9)
+      instance.call(data)
+      expect(data[:data]).to eq [9, 1, 9, 2, 9, 3]
     end
 
     it "raises an exception if attempting to insert after an invalid object" do
@@ -188,4 +197,12 @@ describe Middleware::Builder do
       expect(data[:data]).to eq [2]
     end
   end
+
+  context "debugging" do
+    it "has an inspect method" do
+      instance.use appender_proc(1)
+      instance.use appender_proc(1), 2
+      expect(instance.inspect).to eq '[Proc(), Proc(2)]'
+    end
+  end
 end

data/spec/middleware/runner_spec.rb

@@ -49,7 +49,6 @@ describe Middleware::Runner do
   end
 
   it "should let lambdas to change the given argument" do
-    data = []
     a = lambda { |env| env + 1 }
     b = lambda { |env| env + 2 }
 
@@ -57,6 +56,16 @@ describe Middleware::Runner do
     expect(instance.call(1)).to eq 4
   end
 
+  it "passes in arguments to lambda if given" do
+    data = []
+    a = lambda { |env, arg| data << arg }
+
+    instance = described_class.new([[a, 1]])
+    instance.call(nil)
+
+    expect(data).to eq [1]
+  end
+
   it "passes in arguments if given" do
     a = Class.new do
       def initialize(app, value)
@@ -156,7 +165,7 @@ describe Middleware::Runner do
 
       env = {}
       instance = described_class.new([a, b, c])
-      expect { instance.call(env) }.to raise_error
+      expect { instance.call(env) }.to raise_error 'ERROR'
 
       expect(data).to eq ["a", "b", "e"]
     end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 # 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ibsciss-middleware
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Mitchell Hashimoto
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.7
 description: Generalized implementation of the rack middleware abstraction for Ruby.
 email:
 - mitchell.hashimoto@gmail.com
@@ -77,7 +91,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - jruby-18mode
-  - rbx-18mode
-  - rbx-19mode
-  - ruby-head
-  - jruby-head
-  - ree