callchain 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f961badd05dcae2858d74eaf1568858199639b2
+  data.tar.gz: e6aa34f668bf30cb4ac5e0556daa503d2c82f408
+SHA512:
+  metadata.gz: a7252499d454464a7c98ff023bc396d3f51852a5d93678ac6db575a82d3b245e2a4de0ce65e41c8e5c5cb6c14c0f729a61dbef351d8b4e20cd0160c96a367204
+  data.tar.gz: 42320b9bc8c268ca4fa3ec32bea52b77f95a6d823a48fb6e09fc9f8c76b35af11de2fcacd766a31db689010b86ac0b5331a40f9457f5c527fe375a416a2cca88

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in callchain.gemspec
+gemspec
+
+group :test do
+  gem 'minitest'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 csquared
+
+MIT License
+
+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,81 @@
+# Callchain
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'callchain'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install callchain
+
+## Usage
+
+Individual objects, lambdas, or modules do work with `::call(object)`
+
+Compose a CallChain with the `::use` method
+
+Compose a CallChain of call chains because it exports `::call(object)`
+
+### Example: Class/Module names define `::call`
+
+```ruby
+  class PlanScoper
+    def self.call(thing)
+      scope_the_thing(thing)
+      thing
+    end
+  end
+
+  module Quantizer
+    def self.call(thing)
+      quantize_the_thing(thing)
+      thing
+    end
+  end
+
+  class Pricer
+    extend CallChain
+    use PlanScoper, Quantizer, AppGrouper
+    use UserGrouper
+  end
+
+  statement = Statement.new
+  Pricer.call(statement)
+```
+
+### Example: lambda-friendly
+
+```ruby
+  class Debugger
+    extend CallChain
+    use lambda { |thing| p thing; thing }
+  end
+
+  Debugger.call(Object.new)
+```
+
+### Example: composable
+```ruby
+  class CompositeCallChain
+    extend CallChain
+    use Debugger
+  end
+
+  CompositeCallChain.call(Object.new)
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/callchain/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/callchain.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'callchain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "callchain"
+  spec.version       = Callchain::VERSION
+  spec.authors       = ["csquared"]
+  spec.email         = ["christopher.continanza@gmail.com"]
+  spec.summary       = %q{Simple, composable call chains}
+  spec.description   = %q{Simple, composalbe call chains}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/callchain.rb

@@ -0,0 +1,38 @@
+require "callchain/version"
+
+module CallChain
+  # CallChain implementations
+  #
+  # Individual filters do work with ::call(object)
+  #
+  # Compose a CallChain with the ::use method
+  #
+  # Compose a CallChain of call chains because it exports ::call(object)
+  #
+  # Example:
+  #
+  #   Pricer = Class.new(CallChain)
+  #
+  #   class AppTierPricer < Pricer
+  #     use PlanScoper, Quantizer, AppGrouper
+  #     use UserGrouper
+  #   end
+
+  def use(*args)
+    @chain ||= []
+    @chain.push(*args)
+  end
+
+  def chain
+    @chain
+  end
+
+  def call(thing)
+    return thing unless chain
+    chain.each do |filter|
+      thing = filter.call(thing)
+      yield thing, filter if block_given?
+    end
+    thing
+  end
+end

data/lib/callchain/version.rb

@@ -0,0 +1,3 @@
+module Callchain
+  VERSION = "0.0.1"
+end

data/test/callchain_test.rb

@@ -0,0 +1,97 @@
+require 'minitest/autorun'
+require 'callchain'
+
+module CallChainTestTemplate
+  def chain
+    @chain ||= new_chain
+  end
+
+  # create a Module, Class, and lambda
+  def setup
+    super
+    @chain = nil
+    @append_a = Module.new
+    @append_a.define_singleton_method(:call) do |thing|
+      thing << 'a'
+      thing
+    end
+
+    @append_b = Class.new
+    @append_b.define_singleton_method(:call) do |thing|
+      thing << 'b'
+      thing
+    end
+
+    @append_c = lambda do |thing|
+      thing << 'c'
+      thing
+    end
+  end
+
+  # No shirt, no shoes, no problem
+  def test_noops_with_no_composites
+    result = chain.call([])
+    assert_equal([], result)
+  end
+
+  # #chain returns the chain
+  def test_chain_accessor
+    chain.use @append_a, @append_b
+    assert_equal([@append_a, @append_b], chain.chain)
+  end
+
+  # Single call to ::use
+  def test_with_one_composite
+    chain.use @append_a
+    result = chain.call([])
+    assert_equal(['a'], result)
+  end
+
+  # Single call to ::use with multiple classes
+  # are chained in the order they are added
+  def test_with_multiple_composites
+    chain.use @append_a, @append_b
+    result = chain.call([])
+    assert_equal(['a', 'b'], result)
+  end
+
+  # Multiple calls to ::use are chained in
+  # the order they are added
+  def test_with_multiple_compositions
+    chain.use @append_a, @append_b
+    chain.use @append_c
+    result = chain.call([])
+    assert_equal(['a', 'b', 'c'], result)
+  end
+
+  def test_composite_chain
+    chain2 = new_chain
+    chain2.use @append_a, @append_b, @append_c
+    chain.use chain2, @append_c
+    result = chain.call([])
+    assert_equal(['a', 'b', 'c', 'c'], result)
+  end
+end
+
+# Test to the two different ways of mixin-in
+# extend for class-level methods
+# include for instance-level methods
+# exposes the same interface
+class CallChainExtendTest < Minitest::Test
+  include CallChainTestTemplate
+
+  def new_chain
+    chain_class = Class.new
+    chain_class.extend(CallChain)
+    chain_class
+  end
+end
+
+class CallChainIncludeTest < Minitest::Test
+  include CallChainTestTemplate
+  def new_chain
+    chain_class = Class.new
+    chain_class.include(CallChain)
+    chain_class.new
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: callchain
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- csquared
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: Simple, composalbe call chains
+email:
+- christopher.continanza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- callchain.gemspec
+- lib/callchain.rb
+- lib/callchain/version.rb
+- test/callchain_test.rb
+homepage: ''
+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.0
+signing_key: 
+specification_version: 4
+summary: Simple, composable call chains
+test_files:
+- test/callchain_test.rb