filter_matcher 0.1.0 → 0.2.0

data/README.md

@@ -9,11 +9,13 @@ How to install?
 What it does?
 ==
 
-It filters a collection with defined filters. Launches the filters one by one on the collection until it finds a single result. When the result is found a final action is invoked.
+It filters a collection with defined filters. Launches the filters one by one on the collection until it finds a result. When the result is found a final action is invoked.
 
 Example
 ==
 
+This example describes SingleMatcher.
+
 Lets say we have following data about people:
 
     db = [
@@ -57,7 +59,7 @@ Now, in order to run them all on the collection, we run the matcher method:
     @input.each do |input|
       collection = @db
 
-      matcher(collection) do |m|
+      matcher(collection, :single) do |m|
         m.filter do |col|
           col.select { |element| element[:name] == input[:name] }
         end
@@ -94,7 +96,7 @@ The expected result is the db matched like:
       {:id => 6, :name => "Dan",   :age => 40, :homepage => "www.fakedanny.com", :matched => false}
     ]
 
-Full PeopleMatcher class example, that is responsible only for the matching is shown below:
+Full PeopleMatcher class example, that is responsible only for the matching could look like that:
 
     class PeopleMatcher
       include FilterMatcher
@@ -133,9 +135,9 @@ Full PeopleMatcher class example, that is responsible only for the matching is s
       end
     end
 
-Visual example
+Visual examples
 ==
-Filtering a collection
+Filtering a collection with SingleMatcher
 
     [1,2,3] --first_filter--> [2,3] ---second_filter--> [2] -> match
 
@@ -147,6 +149,19 @@ Filtering a collection
 
     [1,2,3] --first_filter--> [1,2,3] --second_filter--> [2,3] --third_filter--> [2,3] -> no match
 
+Filtering a collection with FirstFromTopMatcher
+
+    [1,2,3] --first_filter--> [2,3] ---second_filter--> [2] -> matches 2
+
+    [1,2,3] --first_filter--> [] --> [1,2,3] --second_filter--> [3] -> matches 3
+
+    [1,2,3] --first_filter--> [1,2] --second_filter--> [1,2] --third_filter--> [1, 2] -> matches 1
+
+    [1,2,3] --first_filter--> [] --> [1,2,3] --second_filter--> [] --> [1,2,3] --third_filter--> [] -> no match
+
+    [1,2,3] --first_filter--> [1,2,3] --second_filter--> [2,3] --third_filter--> [2,3] -> matches 2
+
+
 Filtering real data by SQL or JS
 ==
 
@@ -160,5 +175,5 @@ Did you find it usefull any how? Please let me know, and if you can want to impr
 Contributors
 ==
 
-[Albert Llop](https://github.com/mrsimo)
+[Albert Llop](https://github.com/mrsimo),
 [Sebastian Röbke](https://github.com/boosty)

data/lib/filter_matcher/filter_matcher.rb

@@ -1,35 +1,94 @@
 module FilterMatcher
-  class Filterer
-    def initialize(collection)
+
+  class Matcher
+    class UnknownMatcherError < StandardError; end
+
+    MATCHERS = [:single, :first_from_top]
+
+    def initialize(collection, matcher_type)
+      unless MATCHERS.include?(matcher_type)
+        raise UnknownMatcherError,
+          "No matcher #{matcher_type} found, select one of these: #{MATCHERS.join(', ')}"
+      end
+
       @collection = collection
-      @filters = []
+      @matcher = get_matcher(matcher_type)
     end
 
     def filter(&block)
-      @filters << block
+      @matcher.filters << block
     end
 
     def match(&block)
       @match = block
     end
 
-    def process
+    def run
+      @matcher.run(@collection, @match)
+    end
+
+    private
+
+    def get_matcher(symbol)
+      klass_name = symbol.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+      klass_name << "Matcher"
+      klass = Object.const_get(klass_name)
+      klass.new
+    end
+  end
+
+  # matches only when filters can narrow collection to one element
+  class SingleMatcher
+    attr_accessor :filters
+
+    def initialize
+      @filters = []
+    end
+
+    def run(collection, match)
       @filters.each do |filter|
-        filtered = filter.call(@collection)
-        @collection = filtered.empty? ? @collection : filtered
+        filtered = filter.call(collection)
+        collection = filtered.empty? ? collection : filtered
+
+        if collection.size == 1
+          match.call(collection.first)
+          break
+        end
+      end
+    end
+  end
 
-        if @collection.size == 1
-          @match.call(@collection.first)
+  # matches the result from the top of the filtered collection
+  # does not match only when filtered didn't filtered anything
+  class FirstFromTopMatcher
+    attr_accessor :filters
+
+    def initialize
+      @filters = []
+    end
+
+    def run(collection, match)
+      last_filter_index = @filters.size - 1
+      collection_init_size = collection.size
+      @filters.each_with_index do |filter, index|
+        filtered = filter.call(collection)
+        collection = filtered.empty? ? collection : filtered
+
+        if (collection.size == 1) ||
+          ((last_filter_index == index) && (collection_init_size != collection.size))
+
+          match.call(collection.first)
           break
         end
       end
     end
   end
 
-  def matcher(collection)
-    filterer = Filterer.new(collection)
-    yield filterer
 
-    filterer.process
+  def matcher(collection, matcher_type)
+    matcher = Matcher.new(collection, matcher_type)
+    yield matcher
+
+    matcher.run
   end
 end

data/lib/filter_matcher/version.rb

@@ -1,3 +1,3 @@
 module FilterMatcher
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/first_from_top_matcher_test.rb

@@ -0,0 +1,101 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class FirstFromTopMatcherTest < Test::Unit::TestCase
+
+  def run_matcher(input)
+    input.each do |input|
+      collection = @db
+
+      matcher(collection, :first_from_top) do |m|
+        m.filter do |col|
+          col.select { |element| element[:name] == input[:name] }
+        end
+
+        m.filter do |col|
+          col.select { |element| element[:age] == input[:age]}
+        end
+
+        m.filter do |col|
+          col.select { |element| element[:homepage] == input[:homepage] }
+        end
+
+        m.match do |element|
+          element[:matched] = true
+        end
+      end
+    end
+  end
+
+  def setup
+    @db = [
+      { :id => 1, :name => "John",  :age => 33, :homepage => "www.johny.com",     :matched => false },
+      { :id => 2, :name => "Mike",  :age => 30, :homepage => "www.mikes.com",     :matched => false },
+      { :id => 3, :name => "Johny", :age => 25, :homepage => "www.johny.com",     :matched => false },
+      { :id => 4, :name => "Mike",  :age => 30, :homepage => "www.realmike.com",  :matched => false },
+      { :id => 5, :name => "Dan",   :age => 25, :homepage => "www.danny.com",     :matched => false },
+      { :id => 6, :name => "Dan",   :age => 40, :homepage => "www.fakedanny.com", :matched => false }
+    ]
+  end
+
+  def test_filters_by_name
+    input = [
+      { :name => "John" },
+      { :name => "Johny" }
+    ]
+
+    run_matcher(input)
+
+    assert_matched(@db, input, [1, 3])
+  end
+
+  def test_filters_by_name_and_then_by_age
+    input = [
+      { :name => "Dan", :age => 40 }
+    ]
+
+    run_matcher(input)
+
+    assert_matched(@db, input, [6])
+  end
+
+  def test_filters_by_name_and_then_by_age_and_then_by_homepage
+    input = [
+      { :name => "Mike", :age => 30, :homepage => "www.realmike.com" },
+      { :name => "Dan", :homepage => "www.danny.com" }
+    ]
+
+    run_matcher(input)
+
+    assert_matched(@db, input, [4, 5])
+  end
+
+  def test_filters_by_age_and_then_by_homepage_name_not_given
+    input = [
+      { :age => 25, :homepage => "www.johny.com" }
+    ]
+
+    run_matcher(input)
+
+    assert_matched(@db, input, [3])
+  end
+
+  def test_doesnt_match_if_nothing_matched
+    input = [
+      { :name => "George" }
+    ]
+
+    run_matcher(input)
+
+    assert_matched(@db, input, [])
+  end
+
+  def test_doesnt_match_if_many_matched
+    input = [
+      { :name => "Mike", :age => 30 }
+    ]
+
+    run_matcher(input)
+
+    assert_matched(@db, input, [2])
+  end
+end

data/test/{people_matcher_test.rb → single_matcher_test.rb}

@@ -1,8 +1,31 @@
-require 'bundler/setup'
-require 'test/unit'
-require File.expand_path(File.dirname(__FILE__) + '/people_matcher')
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class FirstFromTopMatcherTest < Test::Unit::TestCase
+
+  def run_matcher(input)
+    input.each do |input|
+      collection = @db
+
+      matcher(collection, :single) do |m|
+        m.filter do |col|
+          col.select { |element| element[:name] == input[:name] }
+        end
+
+        m.filter do |col|
+          col.select { |element| element[:age] == input[:age]}
+        end
+
+        m.filter do |col|
+          col.select { |element| element[:homepage] == input[:homepage] }
+        end
+
+        m.match do |element|
+          element[:matched] = true
+        end
+      end
+    end
+  end
 
-class PeopleMatcherTest < Test::Unit::TestCase
   def setup
     @db = [
       { :id => 1, :name => "John",  :age => 33, :homepage => "www.johny.com",     :matched => false },
@@ -20,7 +43,9 @@ class PeopleMatcherTest < Test::Unit::TestCase
       { :name => "Johny" }
     ]
 
-    assert_matched(input, [1, 3])
+    run_matcher(input)
+
+    assert_matched(@db, input, [1, 3])
   end
 
   def test_filters_by_name_and_then_by_age
@@ -28,7 +53,9 @@ class PeopleMatcherTest < Test::Unit::TestCase
       { :name => "Dan", :age => 40 }
     ]
 
-    assert_matched(input, [6])
+    run_matcher(input)
+
+    assert_matched(@db, input, [6])
   end
 
   def test_filters_by_name_and_then_by_age_and_then_by_homepage
@@ -37,7 +64,9 @@ class PeopleMatcherTest < Test::Unit::TestCase
       { :name => "Dan", :homepage => "www.danny.com" }
     ]
 
-    assert_matched(input, [4, 5])
+    run_matcher(input)
+
+    assert_matched(@db, input, [4, 5])
   end
 
   def test_filters_by_age_and_then_by_homepage_name_not_given
@@ -45,7 +74,9 @@ class PeopleMatcherTest < Test::Unit::TestCase
       { :age => 25, :homepage => "www.johny.com" }
     ]
 
-    assert_matched(input, [3])
+    run_matcher(input)
+
+    assert_matched(@db, input, [3])
   end
 
   def test_doesnt_match_if_nothing_matched
@@ -53,7 +84,9 @@ class PeopleMatcherTest < Test::Unit::TestCase
       { :name => "George" }
     ]
 
-    assert_matched(input, [])
+    run_matcher(input)
+
+    assert_matched(@db, input, [])
   end
 
   def test_doesnt_match_if_many_matched
@@ -61,21 +94,8 @@ class PeopleMatcherTest < Test::Unit::TestCase
       { :name => "Mike", :age => 30 }
     ]
 
-    assert_matched(input, [])
-  end
-
-  private
+    run_matcher(input)
 
-  def assert_matched(input, matched)
-    matcher = PeopleMatcher.new(@db, input)
-    matcher.match
-
-    matcher.db.select {|x| matched.include?(x[:id]) }.each do |entry|
-      assert(entry[:matched], "Matched expected: #{entry.inspect}")
-    end
-
-    matcher.db.reject {|x| matched.include?(x[:id]) }.each do |entry|
-      assert(!entry[:matched], "Not matched expected: #{entry.inspect}")
-    end
+    assert_matched(@db, input, [])
   end
 end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require 'test/unit'
+require 'filter_matcher/filter_matcher'
+
+include FilterMatcher
+
+def assert_matched(db, input, matched)
+  db.select {|x| matched.include?(x[:id]) }.each do |entry|
+    assert(entry[:matched], "Matched expected: #{entry.inspect}")
+  end
+
+  db.reject {|x| matched.include?(x[:id]) }.each do |entry|
+    assert(!entry[:matched], "Not matched expected: #{entry.inspect}")
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: filter_matcher
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jakub Godawa
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-19 00:00:00 +02:00
+date: 2011-07-21 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -36,8 +36,9 @@ files:
 - lib/filter_matcher.rb
 - lib/filter_matcher/filter_matcher.rb
 - lib/filter_matcher/version.rb
-- test/people_matcher.rb
-- test/people_matcher_test.rb
+- test/first_from_top_matcher_test.rb
+- test/single_matcher_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/vysogot/filter_matcher
 licenses: []
@@ -67,5 +68,6 @@ signing_key:
 specification_version: 3
 summary: FilterMatcher makes it easy to find a match in a collection
 test_files: 
-- test/people_matcher.rb
-- test/people_matcher_test.rb
+- test/first_from_top_matcher_test.rb
+- test/single_matcher_test.rb
+- test/test_helper.rb

data/test/people_matcher.rb

@@ -1,49 +0,0 @@
-#
-# example class that uses filter matcher module
-#
-# @db:
-# represents data from which machter tries to filter
-# a single result
-#
-# @input:
-# criteria for maching
-#
-
-require 'filter_matcher'
-
-class PeopleMatcher
-  include FilterMatcher
-
-  attr_reader :db
-
-  def initialize(db, input)
-    @db, @input = db, input
-  end
-
-  #
-  # run filters on all data for every input element
-  #
-  def match
-    @input.each do |input|
-      collection = @db
-
-     matcher(collection) do |m|
-        m.filter do |col|
-          col.select { |element| element[:name] == input[:name] }
-        end
-
-        m.filter do |col|
-          col.select { |element| element[:age] == input[:age]}
-        end
-
-        m.filter do |col|
-          col.select { |element| element[:homepage] == input[:homepage] }
-        end
-
-        m.match do |element|
-          element[:matched] = true
-        end
-      end
-    end
-  end
-end