filter_chain 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8d9ea641ac0e79a4b90fcfeac8b25c67e0ea1cb
-  data.tar.gz: f80d61ce2db22a454f3bb07649553eb1eca1e572
+  metadata.gz: b3127a90f8424ced0cc5f39ef9a4d441371dd410
+  data.tar.gz: c84f731c83e69370657df510046619075328d79d
 SHA512:
-  metadata.gz: bb0f65a45c63ef67c807b7cbf76d7fefc2703237882127eff315f219c4bc9dda330abe27f0b1229ee8e6168ccfdfa0d56f7d49442be32881a6b4e5bd1fa8a474
-  data.tar.gz: c5a60682c76b7b1e286b56acb5942d0dbce7cca652dcedbe668666f06f95b55c12d93fcfdb4aad48ef4e1fb9cae567c5e64279f132daf1b246ce736b2c1a1b3b
+  metadata.gz: 9d493c676a3683688f39931a2bea3437121942344a0340e4aa334d892f6d6f4168fa8b6381faf200144de60b7cf5554a49f0b97d8aab2de11573ca306a24cb69
+  data.tar.gz: 0d01dc929f450d07f789d9b93aa8920e608e870dd5f674633de093d13c541277b9cf92b015bbcd69bc26a0741ccc604d0d8eb6ccb3921b026500a59b68902218

data/README.md

@@ -18,23 +18,25 @@ Or install it yourself as:
 
 ## Chains
 
-A ````Chain```` is a container for a set of filters and makes it easy to create them and retrieve the results.
+A ````Chain```` is a container for a set of filters. 
 
-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|
+    chain = FilterChain::Chain.new { |c|
+      c.add(FilterChain::SerializeFilter.new(:format => :json))
+
+      c.add(FilterChain::DeflateFilter.new)
+
+      c.add(FilterChain::ProcFilter.new { |data|
         puts "Byte size: #{data.bytesize}"
         data
-      }}},
-      {:class => FilterChain::Collector}
-    ])
+      })
+
+      c.add(FilterChain::Collector.new)
+    }
 
-    chain.input("Hello world")
-    chain.input("How are you?")
+    chain << "Hello world"
+    chain << "How are you?"
 
     puts chain.output.inspect
 
@@ -47,10 +49,11 @@ A number of filters are pre-defined:
 - ````InflateFilter````
 - ````SerializeFilter````
 - ````DeserializeFilter````
-- ````SplitHeaderFilter````
-- ````UnsplitHeaderFilter````
+- ````MultiplexFilter````
+- ````DemultiplexFilter````
 - ````ProcFilter````
 - ````Collector````
+- ````Terminator````
 
 You can easily create your own filters by inheriting from the ````Filter```` class and overriding the following handlers:
 
@@ -62,9 +65,12 @@ You pass data to the next filter by calling the ````pass```` method in your ````
 ## 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.
 
+## Terminators
+
+A ````Terminator```` takes the place of a collector when you want your last link to run a block of code. 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/chadrem/filter_chain.
@@ -73,4 +79,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/chadre
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/filter_chain.rb

@@ -9,8 +9,8 @@ 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/multiplex_filter"
+require "filter_chain/demultiplex_filter"
 
 require "filter_chain/deflate_filter"
 require "filter_chain/inflate_filter"
@@ -19,5 +19,7 @@ require "filter_chain/proc_filter"
 
 require "filter_chain/collector"
 
+require "filter_chain/terminator"
+
 module FilterChain
 end

data/lib/filter_chain/chain.rb

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

data/lib/filter_chain/{unsplit_header_filter.rb → demultiplex_filter.rb}

@@ -1,5 +1,5 @@
 module FilterChain
-  class UnsplitHeaderFilter < Filter
+  class DemultiplexFilter < Filter
     private
 
     def on_initialize
@@ -8,15 +8,20 @@ module FilterChain
 
     def on_input(data)
       @buffer << data
+      payloads = []
 
       while @buffer.size >= 4
         if @buffer.size >= 4+(size=@buffer.unpack('N').first)
           @buffer.slice!(0,4)
-          pass(@buffer.slice!(0,size))
+          payload = @buffer.slice!(0,size)
+          payloads << payload
+          pass(payload)
         else
           break
         end
       end
+
+      payloads
     end
   end
 end

data/lib/filter_chain/deserialize_filter.rb

@@ -26,7 +26,7 @@ module FilterChain
     end
 
     def raise_unknown_format
-      raise FilterChainError, "Unknown format:#{opts[:format]}"
+      raise UnknownFormatError, "Unknown format:#{opts[:format]}"
     end
   end
 end

data/lib/filter_chain/exceptions.rb

@@ -1,8 +1,9 @@
 module FilterChain 
   class FilterChainError < RuntimeError; end
-
-  class NextFilterMissing < FilterChainError; end
-  class MissingCollector < FilterChainError; end
-  class UnknownFormat < FilterChainError; end
-  class MissingRequiredOpt < FilterChainError; end
+  class NextFilterMissingError < FilterChainError; end
+  class MissingCollectorError < FilterChainError; end
+  class UnknownFormatError < FilterChainError; end
+  class MissingRequiredOptError < FilterChainError; end
+  class InvalidStateError < FilterChainError; end
+  class MissingBlockError < FilterChainError; end
 end

data/lib/filter_chain/filter.rb

@@ -1,24 +1,22 @@
 module FilterChain
   class Filter
     attr_reader :opts
+    attr_reader :block
     
     attr_accessor :next_filter
 
-    def initialize(opts = {})
+    def initialize(opts = {}, &block)
       @opts = opts
+      @block = block
       on_initialize
     end
 
-    def input(data)
+    def <<(data)
       on_input(data)
-      
-      nil
     end
 
     def pass(data)
-      raise NextFilterMissing unless next_filter
-      
-      next_filter.input(data)
+      next_filter ? next_filter << data : data
     end
 
     private

data/lib/filter_chain/{split_header_filter.rb → multiplex_filter.rb}

@@ -1,5 +1,5 @@
 module FilterChain
-  class SplitHeaderFilter < Filter
+  class MultiplexFilter < Filter
     private
 
     def on_initialize

data/lib/filter_chain/proc_filter.rb

@@ -3,11 +3,11 @@ module FilterChain
     private
 
     def on_initialize
-      raise MissingRequiredOpt, ":proc is required" unless opts[:proc]
+      raise MissingBlockError unless block
     end
 
     def on_input(data)
-      result = opts[:proc].call(data)
+      result = block.call(data)
 
       pass(result)
     end

data/lib/filter_chain/serialize_filter.rb

@@ -26,7 +26,7 @@ module FilterChain
     end
 
     def raise_unknown_format
-      raise FilterChainError, "Unknown format:#{opts[:format]}"
+      raise UnknownFormatError, "Unknown format:#{opts[:format]}"
     end
   end
 end

data/lib/filter_chain/terminator.rb

@@ -0,0 +1,15 @@
+module FilterChain
+  class Terminator < Filter
+    private
+
+    def on_initialize
+      raise MissingBlockError unless block
+    end
+
+    def on_input(data)
+      block.call(data)
+
+      data
+    end
+  end
+end

data/lib/filter_chain/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filter_chain
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Chad Remesch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,15 @@ files:
 - lib/filter_chain/chain.rb
 - lib/filter_chain/collector.rb
 - lib/filter_chain/deflate_filter.rb
+- lib/filter_chain/demultiplex_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/multiplex_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/terminator.rb
 - lib/filter_chain/version.rb
 homepage: https://github.com/chadrem/filter_chain
 licenses: