philter 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1245b87b0b4e2ca1f90789b959f544411aaa7202
-  data.tar.gz: df95daab4acadb6fb075b7d21b8618c0f281ab76
+  metadata.gz: d34fdc2c11fc99bd8a888a5fbc35f53c6ffd21cf
+  data.tar.gz: 01a3d93900d8c15305ca92e31a35937c91e307ff
 SHA512:
-  metadata.gz: ab0e2ffe2422d1babca9c368d33b076eefc7b27d33ac94c76a71917a13edd68737bbd2d4c8850c34bde622f96883e2ff7bdb123b11cc7b60aa9c77978fdbcdb6
-  data.tar.gz: 3e0cfffe99f31f60fc7456e3dd81b9344f65c3b1a07b354d4df00726d908c241f3f61d2554bcdd8cfbf4d6da743cc7490f53bd7caf696a0a151f9d04438914db
+  metadata.gz: 68143b50dacb7215269c26253418c3e6dacf266fd6290377f30770872042cfeae91cf794ec3d8347c845359b08ecea803f0e12c1220d141a0a0258f565fa9a72
+  data.tar.gz: 9be1d27635d66c6e2a533704629895ef25c253102b0ced666dfb8b7275a2576b169635d09fca77fa49de8abea19cd89433323a7ab57aa1146676ebbd480ad942

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+v0.6.0 [☰](https://github.com/marcomd/Philter/compare/v0.5.0...v0.6.0) May 24th, 2016
+------------------------------
+* Improved code readability
+* Improved documentation
+
+v0.5.0 [☰](https://github.com/marcomd/Philter/compare/v0.4.0...v0.5.0) May 24th, 2016
+------------------------------
+* Improved code readability
+* Improved documentation with benchmarks
+
 v0.4.0 [☰](https://github.com/marcomd/Philter/compare/v0.3.0...v0.4.0) May 23th, 2016
 ------------------------------
 * Improved code quality

data/README.md

@@ -6,7 +6,10 @@
 [![Travis CI   ](http://img.shields.io/travis/marcomd/Philter/master.svg)     ](https://travis-ci.org/marcomd/Philter)
 [![Quality     ](http://img.shields.io/codeclimate/github/marcomd/Philter.svg)](https://codeclimate.com/github/marcomd/Philter)
 
-This gem let you to filter any kind of arrays to get the item or attributes of selected items
+This gem let you to filter any kind of arrays to get the item or attributes of selected items.
+It's short and dynamic which helps to increase the readability.
+Its trace is a usefull tool for teachers.
+Performance it's not its field, see the section below.
 
 
 ![](/assets/logo.png)
@@ -21,6 +24,12 @@ require 'philter'
 [1,2,3].philter [2,3]
 => [2,3]
 
+[1,2,3].philter '<= 2'
+=> [1,2]
+
+[1,2,3].philter '!= 2'
+=> [1,3]
+
 %w[red green blue].philter 'red'
 => ["red"]
 
@@ -63,14 +72,17 @@ require 'philter'
 {id: 3, name: 'Bill',   email: 'bill@live.com'    }
 ].philter({email: /@gmail/}, get: :name)
 => ["Mark", "Larry"]
+```
 
-# Debug mode
+Get the trace with the option `debug: true`
+
+```ruby
 [
 {id: 1, name: 'Mark'    },
 {id: 2, name: 'Larry'   },
 {id: 3, name: 'Bill'    }
 ].philter({id: [1,3]}, debug: true)
-
+# You will get a trace
 item Hash {:id=>1, :name=>"Mark"}
  a. search: Array [:id, [1, 3]]
   1.y label: Symbol .2 Hash[:id] == value | 1 == 1  => X
@@ -107,6 +119,65 @@ cities.philter(region: /\Alomb/i).size
 => 4
 ```
 
+## Performance
+
+If you need a lot of speed it would be better to use grep when you can or select manually your items.
+
+```ruby
+require 'benchmark'
+
+ar_test = 100.times.map{|n| n}
+Benchmark.bmbm do |x|
+  x.report("philter: ") { 1_000.times { ar_test.philter [1,2] } }
+  x.report("grep: ")    { 1_000.times { ar_test.grep [1,2] } }
+end
+
+Rehearsal ---------------------------------------------
+philter:    1.872000   0.000000   1.872000 (  1.859130)
+grep:       0.031000   0.000000   0.031000 (  0.017170)
+------------------------------------ total: 1.903000sec
+
+                user     system      total        real
+philter:    1.826000   0.000000   1.826000 (  1.834825)
+grep:       0.016000   0.000000   0.016000 (  0.016777)
+```
+
+```ruby
+Benchmark.bmbm do |x|
+  x.report("philter: ") { 1_000.times { ar_test.philter '< 50' } }
+  x.report("select: ")  { 1_000.times { ar_test.select {|item| item < 50} } }
+end
+
+Rehearsal ---------------------------------------------
+philter:    3.775000   0.000000   3.775000 (  3.779718)
+select:     0.000000   0.000000   0.000000 (  0.004455)
+------------------------------------ total: 3.775000sec
+
+                user     system      total        real
+philter:    3.744000   0.000000   3.744000 (  3.746851)
+select:     0.016000   0.000000   0.016000 (  0.004338)
+```
+
+```ruby
+ar_test = [ {id: 1, name: 'Mark', email: 'mark@gmail.com'},
+            {id: 2, name: 'Bill',  email: 'bill@live.com'},
+            {id: 3, name: 'Larry', email: 'larry@gmail.com'}]
+regexp = /\A.+gmail/
+Benchmark.bmbm do |x|
+  x.report("philter: ") { 10_000.times { ar_test.philter email: regexp } }
+  x.report("select: ")  { 10_000.times { ar_test.select {|item| item[:email] =~ regexp} } }
+end
+
+Rehearsal ---------------------------------------------
+philter:    0.515000   0.000000   0.515000 (  0.490562)
+select:     0.000000   0.000000   0.000000 (  0.003961)
+------------------------------------ total: 0.515000sec
+
+                user     system      total        real
+philter:    0.468000   0.000000   0.468000 (  0.473782)
+select:     0.000000   0.000000   0.000000 (  0.003429)
+```
+
 ## Compatibility
 
 Ruby `1.9+`
@@ -117,6 +188,11 @@ Ruby `1.9+`
 
 To use it in a rails project, add to gem file `gem 'philter'` and run `bundle install`
 
+## To Do
+
+* Add boolean operator to chain of conditions
+* Improve performance keeping the operations's trace
+
 ## Contributing
 
 1. Fork it

data/lib/array.rb

@@ -6,95 +6,43 @@ class Array
         debug:        false
     }.merge(options)
     unless search
-       puts philter_help if options[:debug]
-       raise "Specify search parameter!"
+      puts philter_help if options[:debug]
+      raise "Specify search parameter!"
     end
     results = []
     self.each do |item|
-       puts "item #{item.class.name} #{item}"                                 if options[:debug]
-       h_selected = {all: nil, at_least_one: nil}
-       if search.respond_to? :each
-         # search: {} or []
-         search.each do |value|
-           # Every item must match with search options to be selected
-           puts " a. search: #{value.class.name} #{value}"                    if options[:debug]
-           if value.is_a?(Array)
-             # Example search: {code: 1} or search: {code: [1,2]}
-             label, values = value
-             values = [values] unless values.is_a?(Array)
-             values.each do |value|
-               selected = nil
-               if item.respond_to?(label)
-                 print "  1.x "                                               if options[:debug]
-                 if value.is_a?(Regexp)
-                   print " .1 "                                               if options[:debug]
-                   selected = phil_evaluate item, label, value, :method, options.merge(operator: '=~')
-                 else
-                   # search: {id: 2}
-                   # search: {id: '<3'} or any other operator
-                   print " .2 " if options[:debug]
-                   selected = phil_evaluate item, label, value, :method, options.merge(operator: '==')
-                 end
-               elsif item.respond_to? '[]'
-                 print "  1.y label: #{label.class.name}"                     if options[:debug]
-                 if value.is_a?(Regexp)
-                   # search: {email: /@gmail/}
-                   print " .1 "                                               if options[:debug]
-                   selected = phil_evaluate item, label, value, :hash, options.merge(operator: '=~')
-                 elsif item.is_a?(Hash) && !label.is_a?(Fixnum)
-                   # search: {id: 1} or {'name' => 'Mark'}
-                   # search: {id: '<3'} or any other operator
-                   print " .2 " if options[:debug]
-                   selected = phil_evaluate item, label, value, :hash, options.merge(operator: '==')
-                 else
-                   print " .3 no action for #{value} !!!"                       if options[:debug]
-                 end
-               else
-                 print "  1.z selector not present !!!"                         if options[:debug]
-               end
-               puts "  #{'=> X' if selected}"                                   if options[:debug]
-               h_selected[:at_least_one] ||= selected
-             end
-           elsif value.is_a?(Regexp)
-             # search: {email: /@gmail/}
-             print "   2. "                                                   if options[:debug]
-             selected = phil_evaluate item, nil, value, :simple, options.merge(operator: '=~')
-             puts "  #{'=> X' if selected}"                                 if options[:debug]
-             h_selected[:at_least_one] ||= selected
-           else
-             # Example search: [3] or search: [3, 4]
-             print "   3. "                                                 if options[:debug]
-             selected = phil_evaluate item, nil, value, :simple, options.merge(operator: '==')
-             puts "  #{'=> X' if selected}"                                 if options[:debug]
-             h_selected[:at_least_one] ||= selected
-           end
-         end
-       elsif search.is_a?(Regexp)
-         # Search has one item
-         # search: 3 or search: 'a'
-         print " b.  "                                                      if options[:debug]
-         selected = phil_evaluate item, nil, search, :simple, options.merge(operator: '=~')
-         puts "  #{'=> X' if selected}"                                     if options[:debug]
-         h_selected[:at_least_one] ||= selected
-       else
-         # Search has one item
-         # search: 3 or search: 'a'
-         # search: '<3' or any other operator
-         print " c.  "                                                      if options[:debug]
-         selected = phil_evaluate item, nil, search, :simple, options.merge(operator: '==')
-         puts "  #{'=> X' if selected}"                                     if options[:debug]
-         h_selected[:at_least_one] ||= selected
-       end
-       if h_selected[:at_least_one] || h_selected[:all]
-          tmp_result = if options[:get]
-                         item.respond_to?(options[:get]) ? item.send(options[:get]) : item[options[:get]]
-                       else
-                         item
-                       end
-          results << tmp_result
+      puts "item #{item.class.name} #{item}"                               if options[:debug]
+      if search.respond_to? :each
+        # search: {} or []
+        selected = phil_search_from_list search, item, options
+      elsif search.is_a?(Regexp)
+        # Search has one item
+        # search: 3 or search: 'a'
+        print " b.  "                                                      if options[:debug]
+        selected = phil_evaluate item, nil, search, :simple, options.merge(operator: '=~')
+        puts "  #{'=> X' if selected}"                                     if options[:debug]
+      else
+        # Search has one item
+        # search: 3 or search: 'a'
+        # search: '<3' or any other operator
+        print " c.  "                                                      if options[:debug]
+        selected = phil_evaluate item, nil, search, :simple, options.merge(operator: '==')
+        puts "  #{'=> X' if selected}"                                     if options[:debug]
+      end
+      if selected
+        results <<
+        if options[:get]
+          if item.respond_to? options[:get]
+            item.send options[:get]
+          elsif item.respond_to? '[]'
+            item[options[:get]]
+          end
+        else
+          item
         end
+      end
     end
-    puts "------------------"                                               if options[:debug]
+    puts "------------------"                                                                     if options[:debug]
     puts " #{results ? results.size : 'No'} item#{results && results.size == 1 ? '' : 's'} found" if options[:debug]
     results
   end

data/lib/base.rb

@@ -46,16 +46,82 @@ module Philter
           print "| #{item.send(label)} #{operator} #{value}"                if options[:debug]
           eval("item.send(label) #{operator} value")
         when :hash
-          print " #{item.class.name}[:#{label}] #{operator} value"                                   if options[:debug]
-          print "| #{item[label]} #{operator} #{value} "                     if options[:debug]
+          print " #{item.class.name}[:#{label}] #{operator} value"          if options[:debug]
+          print "| #{item[label]} #{operator} #{value} "                    if options[:debug]
           eval("item[label]#{item_to_s} #{operator} value")
         when :simple
           print " item #{operator} value"                                   if options[:debug]
-          print " | #{item} #{operator} #{value}"                         if options[:debug]
+          print " | #{item} #{operator} #{value}"                           if options[:debug]
           eval("item#{item_to_s} #{operator} value")
         else
           raise "phil_evaluate: evaluation #{evaluation ? "#{evaluation} not valid!" : "blank!"}"
       end
     end
+
+    # Search params respond to each method
+    def phil_search_from_list search, item, options={}
+      selected_or, selected_and = nil, nil
+      search.each do |value|
+        # Every item must match with search options to be selected
+        puts " a. search: #{value.class.name} #{value}"                    if options[:debug]
+        if value.is_a?(Array)
+          # Example search: {code: 1} or search: {code: [1,2]}
+          label, values = value
+          values = [values] unless values.is_a?(Array)
+          values.each do |value|
+            selected = phil_search_is_array label, value, item, options
+            selected_or   = true      if !selected_or && selected
+            selected_and  = selected  if selected_and
+          end
+        elsif value.is_a?(Regexp)
+          # search: {email: /@gmail/}
+          print "   2. "                                                   if options[:debug]
+          selected = phil_evaluate item, nil, value, :simple, options.merge(operator: '=~')
+          puts "  #{'=> X' if selected}"                                   if options[:debug]
+        else
+          # Example search: [3] or search: [3, 4]
+          print "   3. "                                                   if options[:debug]
+          selected = phil_evaluate item, nil, value, :simple, options.merge(operator: '==')
+          puts "  #{'=> X' if selected}"                                   if options[:debug]
+        end
+        selected_or   = true      if !selected_or && selected
+        selected_and  = selected  if selected_and
+      end
+      selected_or
+    end
+
+    def phil_search_is_array label, value, item, options={}
+      selected = nil
+      if item.respond_to?(label)
+        print "  1.x "                                               if options[:debug]
+        if value.is_a?(Regexp)
+          print " .1 "                                               if options[:debug]
+          selected = phil_evaluate item, label, value, :method, options.merge(operator: '=~')
+        else
+          # search: {id: 2}
+          # search: {id: '<3'} or any other operator
+          print " .2 " if options[:debug]
+          selected = phil_evaluate item, label, value, :method, options.merge(operator: '==')
+        end
+      elsif item.respond_to? '[]'
+        print "  1.y label: #{label.class.name}"                     if options[:debug]
+        if value.is_a?(Regexp)
+          # search: {email: /@gmail/}
+          print " .1 "                                               if options[:debug]
+          selected = phil_evaluate item, label, value, :hash, options.merge(operator: '=~')
+        elsif item.is_a?(Hash) && !label.is_a?(Fixnum)
+          # search: {id: 1} or {'name' => 'Mark'}
+          # search: {id: '<3'} or any other operator
+          print " .2 " if options[:debug]
+          selected = phil_evaluate item, label, value, :hash, options.merge(operator: '==')
+        else
+          print " .3 no action for #{value} !!!"                     if options[:debug]
+        end
+      else
+        print "  1.z selector not present !!!"                       if options[:debug]
+      end
+      puts "  #{'=> X' if selected}"                                 if options[:debug]
+      selected
+    end
   end
 end

data/lib/version.rb

@@ -1,5 +1,5 @@
 module Philter
   def self.version
-    "0.4.0"
+    "0.6.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: philter
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Marco Mastrodonato