filter_chain 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8d9ea641ac0e79a4b90fcfeac8b25c67e0ea1cb
+  data.tar.gz: f80d61ce2db22a454f3bb07649553eb1eca1e572
+SHA512:
+  metadata.gz: bb0f65a45c63ef67c807b7cbf76d7fefc2703237882127eff315f219c4bc9dda330abe27f0b1229ee8e6168ccfdfa0d56f7d49442be32881a6b4e5bd1fa8a474
+  data.tar.gz: c5a60682c76b7b1e286b56acb5942d0dbce7cca652dcedbe668666f06f95b55c12d93fcfdb4aad48ef4e1fb9cae567c5e64279f132daf1b246ce736b2c1a1b3b

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in filter_chain.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chad Remesch
+
+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,76 @@
+# Filter Chain [![Build Status](https://travis-ci.org/chadrem/filter_chain.svg)](https://travis-ci.org/chadrem/filter_chain)
+
+Filter Chain is a Ruby gem for processing data through a chain of filters in an object oriented style.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "filter_chain"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install filter_chain
+
+## Chains
+
+A ````Chain```` is a container for a set of filters and makes it easy to create them and retrieve the results.
+
+The constructor takes a schema that defines the set of filters you want to use.
+The below example serializes each input object to a JSON string, compresses the strings, prints the byte size of each string, and collects the results for future retrieval:
+
+    chain = FilterChain::Chain.new(:filters => [
+      {:class => FilterChain::SerializeFilter, :opts => {:format => :json}},
+      {:class => FilterChain::DeflateFilter},
+      {:class => FilterChain::ProcFilter, :opts => {:proc => proc { |data|
+        puts "Byte size: #{data.bytesize}"
+        data
+      }}},
+      {:class => FilterChain::Collector}
+    ])
+
+    chain.input("Hello world")
+    chain.input("How are you?")
+
+    puts chain.output.inspect
+
+## Filters
+
+A ````Filter```` is an object that takes an input and passes it's output to the next link in a chain of filters.
+A number of filters are pre-defined:
+
+- ````DeflateFilter````
+- ````InflateFilter````
+- ````SerializeFilter````
+- ````DeserializeFilter````
+- ````SplitHeaderFilter````
+- ````UnsplitHeaderFilter````
+- ````ProcFilter````
+- ````Collector````
+
+You can easily create your own filters by inheriting from the ````Filter```` class and overriding the following handlers:
+
+- ````on_initialize````
+- ````on_input(data)````
+
+You pass data to the next filter by calling the ````pass```` method in your ````on_input```` method.
+
+## Collectors
+
+A ````Collector```` is a specialized filter designed to be the last link in a chain.
+Typically, all chains should end in a collector.
+An array based collector is included, but you can easily define custom collectors using other data structures.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chadrem/filter_chain.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "filter_chain"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/filter_chain.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filter_chain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "filter_chain"
+  spec.version       = FilterChain::VERSION
+  spec.authors       = ["Chad Remesch"]
+  spec.email         = ["chad@remesch.com"]
+
+  spec.summary       = %q{Object oriented filter chain and filter collection.}
+  spec.homepage      = "https://github.com/chadrem/filter_chain"
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/filter_chain/chain.rb

@@ -0,0 +1,34 @@
+module FilterChain  
+  class Chain
+    attr_reader :filters
+
+    def initialize(opts = {})
+      @opts = opts
+      @filters = create_filters(opts[:filters] || [])
+    end
+
+    def input(data)
+      @filters.first.input(data)
+    end
+
+    def output
+      raise MissingCollector if @filters.empty? || !@filters.last.is_a?(Collector)
+
+      @filters.last.collection
+    end
+
+    private
+
+    def create_filters(filter_schema)
+      results = []
+
+      filter_schema.each do |elem|
+        filter = elem[:class].new(elem[:opts])
+        results.last.next_filter = filter unless results.empty?
+        results << filter
+      end
+
+      results
+    end
+  end
+end

data/lib/filter_chain/collector.rb

@@ -0,0 +1,15 @@
+module FilterChain
+  class Collector < Filter
+    attr_reader :collection
+
+    private
+
+    def on_initialize
+      @collection = []
+    end
+
+    def on_input(data)
+      @collection << data
+    end
+  end
+end

data/lib/filter_chain/deflate_filter.rb

@@ -0,0 +1,14 @@
+module FilterChain
+  class DeflateFilter < Filter
+    private
+
+    def on_initialize
+    end
+
+    def on_input(data)
+      result = Zlib::Deflate.deflate(data)
+
+      pass(result)
+    end
+  end
+end

data/lib/filter_chain/deserialize_filter.rb

@@ -0,0 +1,32 @@
+module FilterChain
+  class DeserializeFilter < Filter
+    private
+
+    def on_initialize
+      unless known_formats.include?(opts[:format]) 
+        raise_unknown_format
+      end
+    end
+
+    def on_input(data)
+      result = case opts[:format]
+      when :json
+        JSON.load(data)
+      when :marshal
+        Marshal.load(data)
+      else
+        raise_unknown_format
+      end
+
+      pass(result)
+    end
+
+    def known_formats
+      [:json, :marshal]
+    end
+
+    def raise_unknown_format
+      raise FilterChainError, "Unknown format:#{opts[:format]}"
+    end
+  end
+end

data/lib/filter_chain/exceptions.rb

@@ -0,0 +1,8 @@
+module FilterChain 
+  class FilterChainError < RuntimeError; end
+
+  class NextFilterMissing < FilterChainError; end
+  class MissingCollector < FilterChainError; end
+  class UnknownFormat < FilterChainError; end
+  class MissingRequiredOpt < FilterChainError; end
+end

data/lib/filter_chain/filter.rb

@@ -0,0 +1,37 @@
+module FilterChain
+  class Filter
+    attr_reader :opts
+    
+    attr_accessor :next_filter
+
+    def initialize(opts = {})
+      @opts = opts
+      on_initialize
+    end
+
+    def input(data)
+      on_input(data)
+      
+      nil
+    end
+
+    def pass(data)
+      raise NextFilterMissing unless next_filter
+      
+      next_filter.input(data)
+    end
+
+    private
+
+    #
+    # Event handlers (override these).
+    #
+
+    def on_initialize
+    end
+
+    def on_input(data)
+      pass(data)
+    end
+  end
+end

data/lib/filter_chain/inflate_filter.rb

@@ -0,0 +1,14 @@
+module FilterChain
+  class InflateFilter < Filter
+    private
+
+    def on_initialize
+    end
+
+    def on_input(data)
+      result = Zlib::Inflate.inflate(data)
+
+      pass(result)
+    end
+  end
+end

data/lib/filter_chain/proc_filter.rb

@@ -0,0 +1,15 @@
+module FilterChain
+  class ProcFilter < Filter
+    private
+
+    def on_initialize
+      raise MissingRequiredOpt, ":proc is required" unless opts[:proc]
+    end
+
+    def on_input(data)
+      result = opts[:proc].call(data)
+
+      pass(result)
+    end
+  end
+end

data/lib/filter_chain/serialize_filter.rb

@@ -0,0 +1,32 @@
+module FilterChain
+  class SerializeFilter < Filter
+    private
+
+    def on_initialize
+      unless known_formats.include?(opts[:format]) 
+        raise_unknown_format
+      end
+    end
+
+    def on_input(data)
+      result = case opts[:format]
+      when :json
+        JSON.dump(data)
+      when :marshal
+        Marshal.dump(data)
+      else
+        raise_unknown_format
+      end
+
+      pass(result)
+    end
+
+    def known_formats
+      [:json, :marshal]
+    end
+
+    def raise_unknown_format
+      raise FilterChainError, "Unknown format:#{opts[:format]}"
+    end
+  end
+end

data/lib/filter_chain/split_header_filter.rb

@@ -0,0 +1,14 @@
+module FilterChain
+  class SplitHeaderFilter < Filter
+    private
+
+    def on_initialize
+    end
+
+    def on_input(data)
+      result = [data.respond_to?(:bytesize) ? data.bytesize : data.size, data].pack('Na*')
+
+      pass(result)
+    end
+  end
+end

data/lib/filter_chain/unsplit_header_filter.rb

@@ -0,0 +1,22 @@
+module FilterChain
+  class UnsplitHeaderFilter < Filter
+    private
+
+    def on_initialize
+      @buffer = ""
+    end
+
+    def on_input(data)
+      @buffer << data
+
+      while @buffer.size >= 4
+        if @buffer.size >= 4+(size=@buffer.unpack('N').first)
+          @buffer.slice!(0,4)
+          pass(@buffer.slice!(0,size))
+        else
+          break
+        end
+      end
+    end
+  end
+end

data/lib/filter_chain/version.rb

@@ -0,0 +1,3 @@
+module FilterChain
+  VERSION = "0.1.0"
+end

data/lib/filter_chain.rb

@@ -0,0 +1,23 @@
+require "json"
+require "zlib"
+
+require "filter_chain/version"
+require "filter_chain/exceptions"
+require "filter_chain/chain"
+require "filter_chain/filter"
+
+require "filter_chain/serialize_filter"
+require "filter_chain/deserialize_filter"
+
+require "filter_chain/split_header_filter"
+require "filter_chain/unsplit_header_filter"
+
+require "filter_chain/deflate_filter"
+require "filter_chain/inflate_filter"
+
+require "filter_chain/proc_filter"
+
+require "filter_chain/collector"
+
+module FilterChain
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: filter_chain
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chad Remesch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: 
+email:
+- chad@remesch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- filter_chain.gemspec
+- lib/filter_chain.rb
+- lib/filter_chain/chain.rb
+- lib/filter_chain/collector.rb
+- lib/filter_chain/deflate_filter.rb
+- lib/filter_chain/deserialize_filter.rb
+- lib/filter_chain/exceptions.rb
+- lib/filter_chain/filter.rb
+- lib/filter_chain/inflate_filter.rb
+- lib/filter_chain/proc_filter.rb
+- lib/filter_chain/serialize_filter.rb
+- lib/filter_chain/split_header_filter.rb
+- lib/filter_chain/unsplit_header_filter.rb
+- lib/filter_chain/version.rb
+homepage: https://github.com/chadrem/filter_chain
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Object oriented filter chain and filter collection.
+test_files: []