iudex-filter 1.2.1-java → 1.3.0-java

data/History.rdoc

@@ -1,3 +1,11 @@
+=== 1.3.0 (2012-11-8)
+* Upgrade/narrow to slf4j ~> 1.7.0, logback ~> 1.5
+* Add FilterChain.alwaysPass option
+* Add alternative create_chain options Hash syntax
+* Add fltr_method and support,cleanup in ProcFilter
+* Simplify KeyHelper.keys
+* Misc java logging simplifications with slf4j 1.7 varargs
+
 === 1.2.1 (2012-9-15)
 * Upgrade/narrow to gravitext-util ~> 1.6.1
 * Upgrade to slf4j [1.6.5,1.8), logback ~> 1.2

data/Manifest.txt

@@ -15,4 +15,4 @@ test/test_filter_base.rb
 test/test_filter_chain_factory.rb
 test/test_proc_filter.rb
 test/test_sublist_filter.rb
-lib/iudex-filter/iudex-filter-1.2.1.jar
+lib/iudex-filter/iudex-filter-1.3.0.jar

data/lib/iudex-filter/base.rb

@@ -16,7 +16,7 @@
 
 module Iudex
   module Filter
-    VERSION = '1.2.1'
+    VERSION = '1.3.0'
 
     LIB_DIR = File.dirname( __FILE__ ) # :nodoc:
   end

data/lib/iudex-filter/filter_chain_factory.rb

@@ -67,7 +67,9 @@ module Iudex
           flts = filters.flatten.compact
           log_and_register( flts )
 
-          @chain = create_chain( @description, flts, :main )
+          @chain = create_chain( :desc     => @description,
+                                 :filters  => flts,
+                                 :listener => :main )
           @listener = ListenerChain.new( listeners )
 
           # Now replace the temp listener with the final listener
@@ -120,41 +122,78 @@ module Iudex
                             @main_by_filter_period )
         end
 
-        # Create, yield to optional block, and return FilterChain if
-        # flts is not empty. Otherwise return a NoOpFilter and don't
-        # yield. If passed a Symbol desc and nil flts, will use both
-        # as description and method to obtain flts array from.
-        def create_chain( desc, flts = nil, listener = nil )
+        # Create, yield to optional block, and returns FilterChain if
+        # provided filters is not empty. If empty returns a NoOpFilter
+        # but does not yield.
+        #
+        # A trailing Hash argument is interpreted as options, see
+        # below. Alternative positional parameters equivalent to
+        # either the following are deprecated:
+        #
+        # * filters (Symbol), nil, listener = nil
+        # * desc (~to_s), filters = nil, listener = nil
+        #
+        # === Options
+        #
+        # :desc:: ~>to_s Description of this chain.
+        # :filters:: Symbol method name to send for filters (and also
+        #            default description), or an Array of filters.
+        # :listener:: The :main symbol for this filter chains
+        #             listeners, or an alternative FilterListener
+        #             instance.
+        # :pass:: If truthy, the chain always returns true (pass) on
+        #         filter.
+        #
+        def create_chain( *args )
+
+          opts = args.last.is_a?( Hash ) ? args.pop.dup : {}
+
+          # Fold in deprecated positional parameters
+          if args[ 0 ].is_a?( Symbol ) && args[ 1 ].nil?
+            opts[ :filters ]  ||= args[ 0 ]
+          else
+            opts[ :desc ]     ||= args[ 0 ]
+            opts[ :filters ]  ||= args[ 1 ]
+          end
+
+          opts[ :listener ]   ||= args[ 2 ]
 
-          if desc.is_a?( Symbol )
-            flts = send( desc ) unless flts
-            desc = desc.to_s.gsub( /_/, '-' )
+          # Handle special case of symbol for :filters
+          if opts[ :filters ].is_a?( Symbol )
+            opts[ :desc ]     ||= opts[ :filters ].to_s.gsub( /_/, '-' )
+            opts[ :filters ]    = send( opts[ :filters ] )
           end
 
-          flts = flts.flatten.compact if flts
+          flts = Array( opts[ :filters ] ).flatten.compact
 
-          if flts.nil? || flts.empty?
+          if flts.empty?
             NoOpFilter.new
           else
-            c = FilterChain.new( desc, flts )
-            if listener.nil?
-              c.listener = log_listener( desc )
-            elsif listener == :main
-              c.listener = @listener
+            chain = FilterChain.new( opts[ :desc ], flts )
+
+            if opts[ :listener ] == :main
+              chain.listener = @listener
+            elsif opts[ :listener ].nil?
+              chain.listener = log_listener( opts[ :desc ] )
             else
-              c.listener = listener
+              chain.listener = opts[ :listener ]
             end
-            yield c if block_given?
-            c
+
+            chain.always_pass = true if opts[ :pass ]
+
+            yield chain if block_given?
+            chain
           end
         end
 
         # Create a new Switch given selector key and map of values to
-        # filters, or values to [filters,listener]
+        # filters, or values to [ filters, listener ]
         def create_switch( key, value_filters_map )
           switch = Switch.new
           value_filters_map.each do |value, (filters, listener)|
-            create_chain( value.to_s.downcase, filters, listener ) do |chain|
+            create_chain( :desc     => value.to_s.downcase,
+                          :filters  => filters,
+                          :listener => listener ) do |chain|
               switch.add_proposition( Selector.new( key, value ), chain )
             end
           end

data/lib/iudex-filter/key_helper.rb

@@ -47,9 +47,9 @@ module Iudex
 
       # Map Symbols to Keys
       def keys( *syms )
-        syms = syms[0] if ( syms[0] && syms[0].respond_to?( :each ) )
-        syms.map { |s| s.to_k }.uniq
+        syms.flatten.compact.map { |s| s.to_k }.uniq
       end
+
       module_function :keys
     end
   end

data/lib/iudex-filter/proc_filter.rb

@@ -18,30 +18,62 @@ require 'iudex-filter/filter_base'
 
 module Iudex::Filter
 
-  # Short hand for ProcFilter.new
-  def fltr( &block )
-    ProcFilter.new( caller.first, &block )
+  # Short hand for ProcFilter.new( opts, &block )
+  def fltr( opts = {}, &block )
+    ProcFilter.new( { :caller => caller.first }.merge( opts ), &block )
   end
 
+  # Return a Procfilter using method( map ) identified by method_symbol
+  # in self's scope as filter. The default :desc is [ method_symbol ].
+  def fltr_method( method_symbol, opts = {} )
+    ProcFilter.new( { :desc => [ method_symbol ] }.merge( opts ),
+                    &( method method_symbol ) )
+  end
+
+  # A filter wrapping a Ruby Proc.
   class ProcFilter < FilterBase
 
-    # New ProcFilter using block as implmentation of
-    # Filter.filter( map ).  The created filter will only return false
-    # (reject map, stop chain) if the block returns the :reject
-    # symbol.
-    def initialize( clr = nil, &block )
+    # Use block as implementation of filter(map).  The filter will
+    # only return false (reject map, stop chain) if the block returns
+    # the :reject symbol. All other return values are ignored,
+    # including "false".
+    #
+    # === Options
+    #
+    # Passing a String for opts is interpreted as :caller (deprecated
+    # as of 1.3.0)
+    #
+    # :caller:: String from which to compose the description. This is
+    #           used under Ruby 1.8 only, obtained via
+    #           block.source_location in 1.9.
+    #
+    # :desc:: Array<~to_s> description (overrides caller)
+    #
+    def initialize( opts = {}, &block )
       @block = block
 
-      clr ||= caller.first
-      clr = clr.split( /:/ )
-      @description = [ File.basename( clr[0], ".rb" ), clr[1].to_i ]
-      #FIXME: When ruby 1.9, can use Proc.source_location instead.
+      opts = { :caller => opts } if opts.is_a?( String )
+      @description = Array( opts[ :desc ] ).compact
+
+      if @description.empty?
+        if @block.respond_to?( :source_location ) # ruby 1.9
+          clr = @block.source_location
+        else                                      # ruby 1.8
+          clr = opts[ :caller ] || caller.first
+          clr = clr.split( /:/ )
+        end
+
+        @description = [ File.basename( clr[0], ".rb" ), clr[1].to_i ]
+      end
+
     end
 
     def describe
       @description
     end
 
+    # Calls initialized block, returning true if it returns anything
+    # but :reject
     def filter( map )
       ( @block.call( map ) != :reject )
     end

data/pom.xml

@@ -5,13 +5,13 @@
   <groupId>iudex</groupId>
   <artifactId>iudex-filter</artifactId>
   <packaging>jar</packaging>
-  <version>1.2.1</version>
+  <version>1.3.0</version>
   <name>Iudex Filter</name>
 
   <parent>
     <groupId>iudex</groupId>
     <artifactId>iudex-parent</artifactId>
-    <version>1.2.1</version>
+    <version>1.3.0</version>
     <relativePath>..</relativePath>
   </parent>
 

data/test/test_filter_chain_factory.rb

@@ -83,12 +83,66 @@ class TestFilterChainFactory < MiniTest::Unit::TestCase
 
   end
 
+  def test_create_chain_noop
+    fcf = FilterChainFactory.new( "test" )
+    fc = fcf.create_chain() { |c| flunk( "NoOpFilter no yield" ) }
+    assert_kind_of( NoOpFilter, fc )
+  end
+
+  def test_create_chain_legacy_params
+    fcf = FilterChainFactory.new( "test" )
+    class << fcf
+      def filters_method
+        [ nil, [ RandomFilter.new ] ]
+      end
+    end
+
+    yielded = nil
+    fc = fcf.create_chain( :filters_method, nil, :main ) { |c| yielded = c }
+    assert_kind_of( FilterChain, fc )
+    assert_equal( fc, yielded )
+    assert_equal( 1, fc.children.length )
+    assert_equal( [ 'filters-method' ], Array( fc.describe ) )
+    assert_kind_of( RandomFilter, fc.children.first )
+
+    yielded = nil
+    fc = fcf.create_chain( :filters_method ) { |c| yielded = c }
+    assert_kind_of( FilterChain, fc )
+    assert_equal( fc, yielded )
+    assert_equal( [ 'filters-method' ], Array( fc.describe ) )
+    assert_equal( 1, fc.children.length )
+    assert_kind_of( RandomFilter, fc.children.first )
+    assert_kind_of( LogListener, fc.listener )
+  end
+
+  def test_create_chain_opts
+    fcf = FilterChainFactory.new( "test" )
+    class << fcf
+      def filters_method
+        [ nil, [ RandomFilter.new ] ]
+      end
+    end
+    yielded = nil
+    fc = fcf.create_chain( :desc     => 'described',
+                           :filters  => :filters_method,
+                           :listener => NoOpListener.new,
+                           :pass     => true ) do |c|
+      yielded = c
+    end
+    assert_kind_of( FilterChain, fc )
+    assert_equal( fc, yielded )
+    assert_equal( [ 'described' ], Array( fc.describe ) )
+    assert_equal( 1, fc.children.length )
+    assert_kind_of( RandomFilter, fc.children.first )
+    assert_kind_of( NoOpListener, fc.listener )
+  end
+
   def test_nested_reporting
     fcf = FilterChainFactory.new( "test" )
     class << fcf
       attr_accessor :summary_reporter
       def filters
-        [ create_chain( :sub_filters, nil, :main ) ]
+        [ create_chain( :filters => :sub_filters, :listener => :main ) ]
       end
       def listeners
         super.tap do |ll|

data/test/test_proc_filter.rb

@@ -29,18 +29,41 @@ class TestProcFilter < MiniTest::Unit::TestCase
   UniMap.create_key( 'mkey' )
   UniMap.define_accessors
 
-  def test_describe
+  def test_describe_proc
     assert_equal( [ 'test_proc_filter', __LINE__ ], fltr {}.describe )
     assert_equal( [ 'test_proc_filter', __LINE__ ], ProcFilter.new {}.describe )
     assert_equal( [ 'test_proc_filter', __LINE__ ], ProcFilter.new {}.describe )
   end
 
-  def test_name
+  def test_name_proc
     index = Core::FilterIndex.new
     name, line = index.register( fltr {} ), __LINE__
     assert_equal( "i.f.ProcFilter-test_proc_filter-#{line}", name )
   end
 
+  def test_describe_method
+    assert_equal( [ :filter_m_reject ],
+                  fltr_method( :filter_m_reject ).describe )
+  end
+
+  def test_name_method
+    index = Core::FilterIndex.new
+    name = index.register( fltr_method( :filter_m_reject ) )
+    assert_equal( "i.f.ProcFilter-filter_m_reject", name )
+  end
+
+  def test_return_method
+    assert do_f( fltr_method :filter_m_happy )
+    refute do_f( fltr_method :filter_m_reject )
+  end
+
+  def filter_m_reject( map )
+    :reject
+  end
+
+  def filter_m_happy( map )
+  end
+
   def test_return
     assert do_f( fltr { } )
     assert do_f( fltr { nil } )

metadata

@@ -1,137 +1,154 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: iudex-filter
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.2.1
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 1.3.0
 platform: java
-authors: 
-  - David Kellum
-autorequire: 
+authors:
+- David Kellum
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2012-09-15 00:00:00 Z
-dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: rjack-slf4j
-    version_requirements: &id001 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: 1.6.5
-        - - <
-          - !ruby/object:Gem::Version 
-            version: "1.8"
-    requirement: *id001
-    prerelease: false
-    type: :runtime
-  - !ruby/object:Gem::Dependency 
-    name: gravitext-util
-    version_requirements: &id002 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ~>
-          - !ruby/object:Gem::Version 
-            version: 1.6.1
-    requirement: *id002
-    prerelease: false
-    type: :runtime
-  - !ruby/object:Gem::Dependency 
-    name: minitest
-    version_requirements: &id003 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ~>
-          - !ruby/object:Gem::Version 
-            version: "2.3"
-    requirement: *id003
-    prerelease: false
-    type: :development
-  - !ruby/object:Gem::Dependency 
-    name: rjack-logback
-    version_requirements: &id004 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ~>
-          - !ruby/object:Gem::Version 
-            version: "1.2"
-    requirement: *id004
-    prerelease: false
-    type: :development
-  - !ruby/object:Gem::Dependency 
-    name: rjack-tarpit
-    version_requirements: &id005 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ~>
-          - !ruby/object:Gem::Version 
-            version: "2.0"
-    requirement: *id005
-    prerelease: false
-    type: :development
+date: 2012-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rjack-slf4j
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: gravitext-util
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: minitest
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rjack-logback
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rjack-tarpit
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    none: false
+  prerelease: false
+  type: :development
 description: Iudex is a general purpose web crawler and feed processor in ruby/java. The iudex-filter gem contains a fundamental filtering/chain of responsbility sub-system.
-email: 
-  - dek-oss@gravitext.com
+email:
+- dek-oss@gravitext.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-  - History.rdoc
-  - README.rdoc
-files: 
-  - History.rdoc
-  - Manifest.txt
-  - README.rdoc
-  - Rakefile
-  - pom.xml
-  - lib/iudex-filter/base.rb
-  - lib/iudex-filter.rb
-  - lib/iudex-filter/by_filter_logger.rb
-  - lib/iudex-filter/filter_base.rb
-  - lib/iudex-filter/filter_chain_factory.rb
-  - lib/iudex-filter/key_helper.rb
-  - lib/iudex-filter/proc_filter.rb
-  - test/setup.rb
-  - test/test_filter_base.rb
-  - test/test_filter_chain_factory.rb
-  - test/test_proc_filter.rb
-  - test/test_sublist_filter.rb
-  - lib/iudex-filter/iudex-filter-1.2.1.jar
+extra_rdoc_files:
+- History.rdoc
+- README.rdoc
+files:
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- pom.xml
+- lib/iudex-filter/base.rb
+- lib/iudex-filter.rb
+- lib/iudex-filter/by_filter_logger.rb
+- lib/iudex-filter/filter_base.rb
+- lib/iudex-filter/filter_chain_factory.rb
+- lib/iudex-filter/key_helper.rb
+- lib/iudex-filter/proc_filter.rb
+- test/setup.rb
+- test/test_filter_base.rb
+- test/test_filter_chain_factory.rb
+- test/test_proc_filter.rb
+- test/test_sublist_filter.rb
+- lib/iudex-filter/iudex-filter-1.3.0.jar
 homepage: http://iudex.gravitext.com
 licenses: []
-
-post_install_message: 
-rdoc_options: 
-  - --main
-  - README.rdoc
-require_paths: 
-  - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+post_install_message:
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2
   none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 2
-        segments: 
-          - 0
-        version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2
   none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 2
-        segments: 
-          - 0
-        version: "0"
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.8.15
-signing_key: 
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
 specification_version: 3
 summary: Iudex is a general purpose web crawler and feed processor in ruby/java.
 test_files: []
-
+...