philter 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 872214969624e598ec099b000b4ada64ac9837f3
-  data.tar.gz: ba1d3f800772f91b3a8d8b08b06d87a68229d517
+  metadata.gz: 9183df24657072d824e87e57a0e1b107bdc08811
+  data.tar.gz: c5a611ae4aedb57e1109cee5eb1d6b50f27742af
 SHA512:
-  metadata.gz: dc93c8a4a407b0227b0e6795dcd060d01855b83a6f4b8896a1ca2957ae480288eeabecd0d71f8f3f5e254b9cc4cb86fb2a287417856784a899ab6c24ed168a6a
-  data.tar.gz: 64bc6efbc153e5e41ad99e0eb493046a1f9be0dcd859aa522f11ab423da36877058c2203de70034b42a291300cff791887a3dc5ccff4b1c0d54141c179cf8095
+  metadata.gz: 0f0f4ef91025e5e799355c1a18191437a292920d8e19918cb95db3bf328ee8bbbc820bd3694128dbd83f51409897aab3bb6d7cb070eb74f976539b42395a0d6c
+  data.tar.gz: a7bbd89b07fe880eee3e47235e7a9c9dd0ae548330c24244bb95fe1375c74a7c6f013b16bdf7e620564e5ab7406f8d3c8a1a88e74d3b54d507161287e35ddfae

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+v1.2.0 [☰](https://github.com/marcomd/Philter/compare/v1.1.0...v1.2.0) March 29th, 2017
+------------------------------
+* Fixed the behaviour when passed a "get" argument to get an attribute which is also an item attribute. For example: with "get: :size" was returned the size of the item but if that item had an attribute "size" you want to get that attribute in the most cases so now it takes precedence.
+  This is not considered a bug so i released a new version.
+
 v1.1.0 [☰](https://github.com/marcomd/Philter/compare/v1.0.0...v1.1.0) May 26th, 2016
 ------------------------------
 * Added debug mode to unit tests

data/README.md

@@ -1,4 +1,5 @@
-# Phil Ter
+![](/assets/logo.png)
+
 ## It helps your life and without weighing too much on global warming
 ### Sometimes it help you to filter some arrays
 
@@ -6,30 +7,35 @@
 [![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.
-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.
+Filter any kind of array with the power of ruby, with ease and :smile:
 
+It's short, dynamic and readable. Its trace is a usefull tool for teachers.
 
-![](/assets/logo.png)
+The performance is inversely proportional to the comfort although efficiency is improved in the latest versions. See the section below.
 
 ```ruby
 require 'philter'
 
-# Simple arrays
+# You can use everything to filter
+# ...single value
 [1,2,3].philter 1
 => [1]
 
+# ...array of values
 [1,2,3].philter [2,3]
 => [2,3]
 
+# ...operators
 [1,2,3].philter '<= 2'
 => [1,2]
 
 [1,2,3].philter '!= 2'
 => [1,3]
 
+# ...range
+[1,2,3,4,5].philter 2..4
+=> [2, 3, 4]
+
 %w[red green blue].philter 'red'
 => ["red"]
 
@@ -37,88 +43,92 @@ require 'philter'
 => ["red", "blue"]
 
 # You can pass a block
-[1,2,3].philter([1,2]){|e|e*2}
+[1,2,3].philter([1,2]) { |e| e*2 }
 => [2, 4]
+```
+
+Things get more interesting with array of hashes or objects :yum:
+
+```ruby
+people = [{ id: 1, name: 'Mark',  email: 'mark@gmail.com'  },
+          { id: 2, name: 'Larry', email: 'larry@gmail.com' },
+          { id: 3, name: 'Bill',  email: 'bill@live.com'   }
+]
+
+people.philter id: 1
+=> [{:id=>1, :name=>"Mark", :email=>"mark@gmail.com"}]
+
+people.philter id: [1,3]
+=> [{:id=>1, :name=>"Mark", :email=>"mark@gmail.com"}, {:id=>3, :name=>"Bill", :email=>"bill@live.com"}]
 
-# Array of hashes
-[
-{id: 1, name: 'Mark'    },
-{id: 2, name: 'Larry'   }
-].philter id: 1
-=> [{:id=>1, :name=>"Mark"}]
-
-[
-{id: 1, name: 'Mark'    },
-{id: 2, name: 'Larry'   },
-{id: 3, name: 'Bill'    }
-].philter id: [1,3]
-=> [{:id=>1, :name=>"Mark"}, {:id=>3, :name=>"Bill"}]
-
-[
-{id: 1, name: 'Mark'    },
-{id: 2, name: 'Larry'   },
-{id: 3, name: 'Bill'    }
-].philter id: '>2'
-=> [{:id=>3, :name=>"Bill"}]
+people.philter id: '>2'
+=> [{:id=>3, :name=>"Bill", :email=>"bill@live.com"}]
 
 # Regular expression
-[
-{id: 1, name: 'Mark',   email: 'mark@gmail.com'  },
-{id: 2, name: 'Larry',  email: 'larry@gmail.com' },
-{id: 3, name: 'Bill',   email: 'bill@live.com'   }
-].philter email: /@gmail/
-=> [{:id=>1, :name=>"Mark", :email=>"mark@gmail.com"}, {:id=>2, :name=>"Larry",:email=>"larry@gmail.com"}]
+people.philter email: /@gmail/
+=> [{:id=>1, :name=>"Mark", :email=>"mark@gmail.com"}, {:id=>2, :name=>"Larry", :email=>"larry@gmail.com"}]
 
 # Select attributes
-[
-{id: 1, name: 'Mark',   email: 'mark@gmail.com'  },
-{id: 2, name: 'Larry',  email: 'larry@gmail.com' },
-{id: 3, name: 'Bill',   email: 'bill@live.com'   }
-].philter({email: /@gmail/}, get: :name)
+people.philter({ email: /@gmail/ }, get: :name)
 => ["Mark", "Larry"]
 
 # Philter with more attributes -and-
-[
-{id: 1, name: 'Mark',   email: 'mark@gmail.com'  },
-{id: 2, name: 'Larry',  email: 'larry@gmail.com' },
-{id: 3, name: 'Bill',   email: 'bill@live.com'   }
-].philter name: /M.+/, email: /@gmail/
+people.philter name: /M.+/, email: /@gmail/
 => [{:id=>1, :name=>"Mark", :email=>"mark@gmail.com"}]
 
 # Philter with more attributes -or-
-[
-{id: 1, name: 'Mark',   email: 'mark@gmail.com'  },
-{id: 2, name: 'Larry',  email: 'larry@gmail.com' },
-{id: 3, name: 'Bill',   email: 'bill@live.com'   }
-].philter({name: /M.+/, email: /@live/}, or: true)
+people.philter({ name: /M.+/, email: /@live/ }, or: true)
 => [{:id=>1, :name=>"Mark", :email=>"mark@gmail.com"}, {:id=>3, :name=>"Bill", :email=>"bill@live.com"}]
+```
+
+To me the power! :godmode:
 
-# A bit of magic
+```ruby
 # Select and update attributes
-[
-{id: 1, name: 'Mark',   email: 'mark@gmail.com'  },
-{id: 2, name: 'Larry',  email: 'larry@gmail.com' },
-{id: 3, name: 'Bill',   email: 'bill@live.com'   }
-].philter({email: /@gmail/}){|e| e[:name] << ' use gmail!'}
+regexp = /gmail/
+people.philter(email: regexp) { |e| "#{e[:name]} use #{e[:email].match(regexp)}!"}
 => ["Mark use gmail!", "Larry use gmail!"]
 
 # Add attributes
-[
-{id: 1, name: 'Mark',   email: 'mark@gmail.com'  },
-{id: 2, name: 'Larry',  email: 'larry@gmail.com' },
-{id: 3, name: 'Bill',   email: 'bill@live.com'   }
-].philter({email: /@gmail/}){|e| e[:surname] = 'unknown';e }
+people.philter(email: /@gmail/) do |e|
+  e[:filtered] = true
+  e
+end
 => :try_yourself
 ```
 
+
+Remember how to pass arguments:
+
+```ruby
+people.philter { ...filters... }, { ...options... }
+
+# YES
+[1,2,3].philter '<= 2', debug: true
+people.philter({ id: 1 }, debug: true)
+
+# NO (debug is not an attribute to filter but an option)
+people.philter(id: 1, debug: true)
+```
+
+
 Get the trace with the option `debug: true`
 
 ```ruby
-[{id: 1, name: 'Mark', email: 'mark@gmail.com'},
- {id: 2, name: 'Bill', email: 'bill@live.com'},
- {id: 3, name: 'Larry', email: 'larry@gmail.com'}
-].philter({name: 'Mark', email: /\A.+gmail/}, debug: true)
+[1,2,3].philter '<= 2', debug: true
+--------------- Start debugging philter 1.1.0 -------------
+ Search by String: <= 2 with operator
+ item Fixnum 1
+ item <= value | 1 <= 2 => x
+ item Fixnum 2
+ item <= value | 2 <= 2 => x
+ item Fixnum 3
+ item <= value | 3 <= 2
+--------------- End debugging philter 1.1.0 ---------------
+ 2 item(s) found
+=> [1, 2]
 
+people.philter({ name: 'Mark', email: /\A.+gmail/ }, debug: true)
 --------------- Start debugging philter 1.1.0 ---------------
  Search by Hash:
 
@@ -152,7 +162,7 @@ Get the trace with the option `debug: true`
 
 ### Rails
 
-Rails return relation objects that must be turned to array 
+Rails return relation objects that must be turned to array
 
 ```ruby
 cities = City.all.to_a
@@ -166,8 +176,8 @@ cities.philter code: 'PA'
 => [#<City id: 4, name: "Palermo", code: "PA", region: "Sicilia", created_at: "2016-05-10 09:08:13", updated_at: "2016-05-10 09:08:13">]
 
 # Pass a block to select, update or change the result
-cities.philter(region: /\Alomb/i){|city| "#{city.name}-#{city.code}"}
-=> ["Milano-MI", "Lecco-LC", "Pavia-PV", "Piacenza-PC"]
+cities.philter(region: /\Alomb/i) { |city| "#{city.name}-#{city.code}" }
+=> ["Milano-MI", "Lecco-LC", "Pavia-PV", "Piacenza-PC", ... [cut]
 
 ```
 
@@ -180,7 +190,7 @@ Ruby 2.2.3p173 on windows 7 with i5 3570K Ivy Bridge @4200 Mhz Ram 16Gb 10-10-10
 require 'benchmark'
 require 'philter'
 
-ar_test = 100.times.map{|n| n}
+ar_test = 100.times.map { |n| n }
 Benchmark.bmbm do |x|
   x.report("philter: ") { 10_000.times { ar_test.philter 1 } }
   x.report("grep: ")    { 10_000.times { ar_test.grep    1 } }
@@ -220,7 +230,7 @@ grep:       0.172000   0.000000   0.172000 (  0.182490)
 ar_search = [1,3,5,7]
 Benchmark.bmbm do |x|
   x.report("philter: ") { 10_000.times { ar_test.philter ar_search } }
-  x.report("select: ")  { 10_000.times { ar_test.select{|item| ar_search.include? item } } }
+  x.report("select: ")  { 10_000.times { ar_test.select { |item| ar_search.include?(item) } } }
 end
 
 #version 1.0.0
@@ -236,8 +246,8 @@ select:     0.078000   0.000000   0.078000 (  0.073341)
 
 ```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} } }
+  x.report("philter: ") { 1_000.times { ar_test.philter '< 50'            } }
+  x.report("select: ")  { 1_000.times { ar_test.select { |item| item < 50 } } }
 end
 
 #version 1.0.0
@@ -251,14 +261,37 @@ philter:    3.744000   0.000000   3.744000 (  3.746851)
 select:     0.016000   0.000000   0.016000 (  0.004338)
 ```
 
+Strings
+
 ```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' }]
+require 'benchmark'
+require 'philter'
+ar_test   = %w(black white grey red green blue yellow orange pink purple violet)
+ar_search = %w(red green blue)
+Benchmark.bmbm do |x|
+  x.report("philter: ") { 10_000.times { ar_test.philter ar_search } }
+  x.report("select: ")  { 10_000.times { ar_test.select { |item| ar_search.include? item } } }
+end
+
+#version 1.0.0
+                user     system      total        real
+philter:    0.063000   0.000000   0.063000 (  0.062890)
+select:     0.015000   0.000000   0.015000 (  0.011407)
+
+#version 0.7.0
+                user     system      total        real
+philter:    7.363000   0.000000   7.363000 (  7.359162)
+select:     0.000000   0.000000   0.000000 (  0.011539)
+```
+
+```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} } }
+  x.report("select: ")  { 10_000.times { ar_test.select { |item| item[:email] =~ regexp } } }
 end
 
 #version 1.0.0
@@ -272,9 +305,13 @@ philter:    0.468000   0.000000   0.468000 (  0.473782)
 select:     0.000000   0.000000   0.000000 (  0.003429)
 ```
 
+
+
 ## Compatibility
 
-Ruby `1.9+`
+Ruby `2.1+`
+
+Ruby `1.9+`  has been tested up to `v1.2.0`
 
 ## Install
 
@@ -286,7 +323,7 @@ To use it in a bundle, add to gem file `gem 'philter'` and run `bundle install`
 
 - [x] Add boolean operator to chain of conditions `v1.0.0`
 - [x] Improve performance keeping the operations's trace `v1.0.0`
-- [x] Add block `v1.0.0`
+- [x] Add blocks `v1.0.0`
 - [ ] Increase performance further
 
 ## Contributing
@@ -299,7 +336,7 @@ To use it in a bundle, add to gem file `gem 'philter'` and run `bundle install`
 
 ## Testing
 
-Wide coverage with `37 unit tests` and `137 assertions`
+Wide coverage with `39 unit tests` and `155 assertions`
 
 To test locally install the development requirements
 
@@ -307,11 +344,11 @@ To test locally install the development requirements
 
 Then execute
 
-    bundle exec ruby test\unit_test.rb
+    bundle exec ruby test/unit_test.rb
 
 Performance tests are calibrated to not exceed 1.2 seconds on my pc with a tolerance become 2 seconds:
 
-    bundle exec ruby test\performance_test.rb
+    bundle exec ruby test/performance_test.rb
 
 ```
 Loaded suite test/performance_test
@@ -330,7 +367,7 @@ Finished in 8.505 seconds.
 
 If you have a very slow pc it could not pass. In this case you can pass a higher tolerance value as argument, for example 3 seconds:
 
-    bundle exec ruby test\performance_test.rb 3.0
+    bundle exec ruby test/performance_test.rb 3.0
 
 ## Found a bug?
 

data/lib/philter/search.rb

@@ -92,10 +92,10 @@ module Philter
 
         next unless selected
         results <<
-          if options[:get] && item.respond_to?(options[:get])
-            item.send options[:get]
-          elsif options[:get] && item.respond_to?('[]')
+          if options[:get] && item.respond_to?('[]')
             item[options[:get]]
+          elsif options[:get] && item.respond_to?(options[:get])
+            item.send options[:get]
           else
             item
           end

data/lib/version.rb

@@ -1,5 +1,5 @@
 module Philter
   def self.version
-    "1.1.0"
+    "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philter
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Marco Mastrodonato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-27 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -53,7 +53,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - The brave to dare
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Filter arrays with pleasure