pipeliner 1.0 → 1.1

data/CHANGELOG

@@ -0,0 +1,4 @@
+1.1
+    * Modified Pipeline#hook to allow conditional matching
+1.0
+    * Initial release

data/README.rdoc

@@ -34,7 +34,7 @@ In the example above, we use a simple block to process any String type objects.
 
     require 'pipeliner'
 
-    class Tester < Pipeliner::Filter
+    class Tester
         attr_reader :store
         def initialize
             @store = []
@@ -54,6 +54,31 @@ In the example above, we use a simple block to process any String type objects.
 
     => ["String", 100, {:test=>:data}]
 
+Another handy thing is limiting what hooks are called when a very generic type is hooked. When supplying an object method to call, we can also pass a block that provides the condition for which the hook will be run:
+
+    require 'pipeliner'
+
+    class Tester
+        attr_reader :store
+        def initialize
+            @store = []
+        end
+        def process(m)
+            @store << m
+        end
+    end
+
+    pipeline = Pipeliner::Pipeline.new
+    obj = Tester.new
+    pipeline.hook(Object, obj, :process){|o| o.is_a?(String) }
+    pipeline << "String"
+    pipeline << 100
+    pipeline << {:test => :data}
+    p obj.store
+
+    => ["String"]
+
+
 But, what if you want anything added to the pipeline to be modified before it is distributed out to hooked processors? Well, then you would use a filter:
 
     require 'pipeliner'

data/Rakefile

@@ -0,0 +1,54 @@
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+ 
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+
+spec = Gem::Specification.new do |s|
+    s.name              = 'pipeliner'
+    s.author            = 'spox'
+    s.email             = 'spox@modspox.com'
+    s.version           = '1.1'
+    s.summary           = 'Object Pipeline'
+    s.platform          = Gem::Platform::RUBY
+    s.files             = Dir['**/*']
+    s.rdoc_options      = %w(--title pipeliner --main README.rdoc --line-numbers)
+    s.extra_rdoc_files  = %w(README.rdoc CHANGELOG)
+    s.require_paths     = %w(lib)
+    s.required_ruby_version = '>= 1.8.6'
+    s.add_dependency 'actionpool', '~> 0.2.3'
+    s.add_dependency 'splib', '~> 1.4.3'
+    s.homepage          = %q(http://github.com/spox/pipeliner)
+    s.description       = "Simple library to allow pipeline styled communications between objects"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  files =['README', 'LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README" # page to start on
+  rdoc.title = "pipeliner Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.libs << Dir["lib"]
+end

data/lib/pipeliner/Pipeline.rb

@@ -1,4 +1,6 @@
-['thread', 'splib', 'actionpool', 'pipeliner/FilterManager'].each{|f| require f}
+require 'actionpool'
+require 'splib'
+require 'pipeliner/FilterManager'
 
 Splib.load :Constants
 
@@ -13,17 +15,21 @@ module Pipeliner
             @hooks = {}
             @lock = Mutex.new
             @filters = args[:filters] ? args[:filters] : FilterManager.new
+            if(!args[:pool])
+                Kernel.at_exit do
+                    close
+                end
+            end
         end
 
         # Close the pipeline
-        # Note: This is important to at the end of a script when not
+        # Note: This is important to call at the end of a script when not
         #       providing an ActionPool thread pool to the pipeline.
         #       This will ensure the thread pool is properly shutdown
         #       and avoid the script hanging.
         def close
             @pool.shutdown
             clear
-            @pool = nil
         end
 
         # Open the pipeline
@@ -46,25 +52,38 @@ module Pipeliner
         # type:: Type of Objects to pass to object
         # object:: Object to hook to pipeline
         # method:: Method to call on object
-        # block:: Block to apply to object (called without object and method set)
-        # Hooks an Object into the pipeline for objects of a given type
+        # block:: Block to apply to object (called without object and method set) or conditional
+        # Hooks an Object into the pipeline for objects of a given type. The block can serve
+        # two purposes here. First, we can hook a block to a type like so:
+        #   pipeline.hook(String){|s| puts s }
+        # Or, we can use the block as a conditional for calling an object's method:
+        #   pipeline.hook(String, obj, :method){|s| s == 'test' }
+        # In the second example, this hook will only be called if the String type object
+        # matches the conditional in the block, meaning the string must be 'test'
         def hook(type, object=nil, method=nil, &block)
-            raise ArgumentError.new('No object information or block provided for hook') if !block_given? && object.nil? && method.nil?
-            raise ArgumentError.new('Block must accept a parameter') unless block.nil? || block.arity == 1 || block.arity < 0
+            raise ArgumentError.new 'Type must be provided' if type.nil?
+            if(block && (block.arity > 1 || block.arity == 0))
+                raise ArgumentError.new('Block must accept a parameter')
+            end
+            if((object && method.nil?) || (object.nil? && method))
+                raise ArgumentError.new('Object AND method must be provided')
+            end
+            if(!block_given? && object.nil? && method.nil?)
+                raise ArgumentError.new('No object information or block provided for hook')
+            end
             @lock.synchronize do
                 const = Splib.find_const(type)
                 type = const unless const.nil?
                 @hooks[type] ||= {}
-                if(block_given?)
+                if(block_given? && object.nil? && method.nil?)
                     @hooks[type][:procs] ||= []
                     @hooks[type][:procs] << block
-                end
-                if(object && method)
+                else
                     name = object.class
                     method = method.to_sym
                     raise ArgumentError.new('Given object does not respond to given method') unless object.respond_to?(method)
                     @hooks[type][name] ||= []
-                    @hooks[type][name] << {:object => object, :method => method}
+                    @hooks[type][name] << {:object => object, :method => method, :req => !block_given? ? lambda{|x|true} : block}
                 end
             end
             block_given? ? block : nil
@@ -144,7 +163,7 @@ module Pipeliner
                     if(key == :procs)
                         objects.each{|pr| @pool.process{ pr.call(o) }}
                     else
-                        objects.each{|h| @pool.process{ h[:object].send(h[:method], o)}}
+                        objects.each{|h| @pool.process{ h[:object].send(h[:method], o) if h[:req].call(o) }}
                     end
                 end
             end

data/nbproject/private/private.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project-private xmlns="http://www.netbeans.org/ns/project-private/1">
+    <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/1"/>
+    <open-files xmlns="http://www.netbeans.org/ns/projectui-open-files/1">
+        <file>file:/home/spox/NetBeansProjects/pipeliner/lib/pipeliner/Pipeline.rb</file>
+    </open-files>
+</project-private>

data/nbproject/private/rake-d.txt

@@ -0,0 +1,19 @@
+clean=Remove any temporary products.
+clobber=Remove any generated file.
+clobber_package=Remove package products
+clobber_rdoc=Remove rdoc products
+doc=
+doc/rdoc=
+doc/rdoc/index.html=
+gem=Build the gem file pipeliner-1.1.gem
+package=Build all the packages
+pkg=
+pkg/pipeliner-1.1=
+pkg/pipeliner-1.1.gem=
+pkg/pipeliner-1.1.tgz=
+pkg/pipeliner-1.1.zip=
+rdoc=Build the rdoc HTML Files
+repackage=Force a rebuild of the package files
+rerdoc=Force a rebuild of the RDOC files
+spec=Run specs
+test=Run tests

data/nbproject/project.properties

@@ -0,0 +1,6 @@
+main.file=
+platform.active=default
+source.encoding=UTF-8
+spec.src.dir=spec
+src.dir=lib
+test.src.dir=test

data/nbproject/project.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://www.netbeans.org/ns/project/1">
+    <type>org.netbeans.modules.ruby.rubyproject</type>
+    <configuration>
+        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
+            <name>pipeliner</name>
+            <source-roots>
+                <root id="src.dir"/>
+            </source-roots>
+            <test-roots>
+                <root id="test.src.dir"/>
+                <root id="spec.src.dir"/>
+            </test-roots>
+        </data>
+    </configuration>
+</project>

data/pipeliner.gemspec

@@ -2,7 +2,7 @@ spec = Gem::Specification.new do |s|
     s.name              = 'pipeliner'
     s.author            = 'spox'
     s.email             = 'spox@modspox.com'
-    s.version           = '1.0'
+    s.version           = '1.1'
     s.summary           = 'Object Pipeline'
     s.platform          = Gem::Platform::RUBY
     s.files             = Dir['**/*']
@@ -10,8 +10,8 @@ spec = Gem::Specification.new do |s|
     s.extra_rdoc_files  = %w(README.rdoc CHANGELOG)
     s.require_paths     = %w(lib)
     s.required_ruby_version = '>= 1.8.6'
-    s.add_dependency 'ActionPool', '~> 0.2.0'
-    s.add_dependency 'splib', '~> 1.1'
+    s.add_dependency 'actionpool', '~> 0.2.3'
+    s.add_dependency 'splib', '~> 1.4.3'
     s.homepage          = %q(http://github.com/spox/pipeliner)
     s.description       = "Simple library to allow pipeline styled communications between objects"
 end

data/{tests → test}/cases/Pipeline.rb

@@ -32,7 +32,7 @@ class PipelineTest < Test::Unit::TestCase
     end
     def test_hook_addition
         assert_raise(ArgumentError){ @pipeline.hook(String) }
-        assert_raise(ArgumentError){ @pipeline.hook(String){ true } }
+        assert_raise(ArgumentError){ @pipeline.hook(String){ true } } if RUBY_VERSION >= '1.9.0'
         assert_raise(ArgumentError){ @pipeline.hook(String){|a,b| true} }
         assert_kind_of(Proc, @pipeline.hook(String){|a| true })
         assert_kind_of(Proc, @pipeline.hook(String){|a, *b| true })
@@ -70,6 +70,20 @@ class PipelineTest < Test::Unit::TestCase
         @pipeline.clear
         assert(@pipeline.hooks.empty?)
     end
+    def test_hook_conditional
+        obj = Tester.new
+        @pipeline.hook(String, obj, :method)
+        @pipeline << "test"
+        sleep(0.01)
+        assert_equal(1, obj.messages.size)
+        @pipeline.hook(String, obj, :method){|s| s == 'test' }
+        @pipeline << "fubar"
+        sleep(0.01)
+        assert_equal(2, obj.messages.size)
+        @pipeline << "test"
+        sleep(0.01)
+        assert_equal(4, obj.messages.size)
+    end
     def test_flush
         out = []
         assert(out.empty?)
@@ -100,6 +114,7 @@ class PipelineTest < Test::Unit::TestCase
         @pipeline.filters.add(String){|s|10}
         @pipeline.hook(Object){|s|out << s}
         @pipeline << 'fubar'
+        sleep(0.01)
         assert(out.include?(10))
         assert(!out.include?('fubar'))
         @pipeline.filters.clear

metadata

@@ -1,7 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: pipeliner
 version: !ruby/object:Gem::Version 
-  version: "1.0"
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  version: "1.1"
 platform: ruby
 authors: 
 - spox
@@ -9,29 +13,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-30 00:00:00 -08:00
+date: 2010-04-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: ActionPool
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: actionpool
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.2.0
-    version: 
+        segments: 
+        - 0
+        - 2
+        - 3
+        version: 0.2.3
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: splib
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "1.1"
-    version: 
+        segments: 
+        - 1
+        - 4
+        - 3
+        version: 1.4.3
+  type: :runtime
+  version_requirements: *id002
 description: Simple library to allow pipeline styled communications between objects
 email: spox@modspox.com
 executables: []
@@ -42,14 +54,20 @@ extra_rdoc_files:
 - README.rdoc
 - CHANGELOG
 files: 
-- tests/cases/Filter.rb
-- tests/cases/FilterManager.rb
-- tests/cases/Pipeline.rb
-- tests/run_tests.rb
+- spec/dummy.rb
+- test/cases/Filter.rb
+- test/cases/FilterManager.rb
+- test/cases/Pipeline.rb
+- test/run_tests.rb
+- nbproject/private/rake-d.txt
+- nbproject/private/private.xml
+- nbproject/project.xml
+- nbproject/project.properties
 - lib/pipeliner/Filter.rb
 - lib/pipeliner/FilterManager.rb
 - lib/pipeliner/Pipeline.rb
 - lib/pipeliner.rb
+- Rakefile
 - CHANGELOG
 - LICENSE
 - README.rdoc
@@ -71,18 +89,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 6
       version: 1.8.6
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Object Pipeline