philter 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28df2d4a59af11ab48898f5a79ae0af51fcb6433
+  data.tar.gz: d1637407fca0282aaae477558c3070a82277a7b6
+SHA512:
+  metadata.gz: c0ae3a03853aeb05c68b16003e8c348284f28d5efee717ce344d0e5b19eafc6973a258d07671cd6e8a62dc82a87f20611d5dcdce0fd631ca7b41df1e475c96ea
+  data.tar.gz: 4eb0a010060ee387efaa84f8afc12d277b7870429ff10700d0abfb0b5f97baf6ace5b60c21d0460932ff5b5f3a65bf09c9792c62d4c91ea5bf93c8886ddf20fb

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+v0.2.0 [☰](https://github.com/marcomd/Philter/compare/v0.1.0...v0.2.0) May 19th, 2016
+------------------------------
+* Added options `:get` to select attributes from hashes and objects
+* Improved documentation
+
+v0.1.0 May 19th, 2016
+------------------------------
+* Starting project

data/LICENSE

@@ -0,0 +1,15 @@
+Philter
+
+Copyright (C) 2016  Marco Mastrodonato, m.mastrodonato@gmail.com
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,135 @@
+# Phil Ter
+## It helps your life and without weighing too much on global warming
+### Sometimes it help you to filter some arrays
+
+[![Version     ](https://badge.fury.io/rb/philter.svg)                        ](https://rubygems.org/gems/philter)
+[![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
+
+
+![](/assets/logo.png)
+
+```ruby
+require 'philter'
+
+# Simple arrays
+[1,2,3].philter 1
+=> [1]
+
+[1,2,3].philter [2,3]
+=> [2,3]
+
+%w[red green blue].philter 'red'
+=> ["red"]
+
+%w[red green blue].philter %w(red blue)
+=> ["red", "blue"]
+
+# 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"}]
+
+# 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"}]
+
+# 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)
+=> ["Mark", "Larry"]
+
+# Debug mode
+[
+{id: 1, name: 'Mark'    },
+{id: 2, name: 'Larry'   },
+{id: 3, name: 'Bill'    }
+].philter({id: [1,3]}, debug: true)
+
+item Hash {:id=>1, :name=>"Mark"}
+ a. search: Array [:id, [1, 3]]
+  1.y label: Symbol .2 Hash[:id] == value | 1 == 1  => X
+  1.y label: Symbol .2 Hash[:id] == value | 1 == 3
+item Hash {:id=>2, :name=>"Larry"}
+ a. search: Array [:id, [1, 3]]
+  1.y label: Symbol .2 Hash[:id] == value | 2 == 1
+  1.y label: Symbol .2 Hash[:id] == value | 2 == 3
+item Hash {:id=>3, :name=>"Bill"}
+ a. search: Array [:id, [1, 3]]
+  1.y label: Symbol .2 Hash[:id] == value | 3 == 1
+  1.y label: Symbol .2 Hash[:id] == value | 3 == 3  => X
+------------------
+ 2 items found
+=> [{:id=>1, :name=>"Mark"}, {:id=>3, :name=>"Bill"}]
+```
+
+### Rails
+
+Rails return relation objects that must be turned to array 
+
+```ruby
+cities = City.all.to_a
+  City Load (1.0ms)  SELECT "cities".* FROM "cities"
+=> ... [cut]
+
+cities.philter id: 1
+=> [#<City id: 1, name: "Milano", code: "MI", region: "Lombardia", created_at: "2016-05-10 09:07:22", updated_at: "2016-05-10 09:07:22">]
+
+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">]
+
+cities.philter(region: /\Alomb/i).size
+=> 4
+```
+
+## Compatibility
+
+Ruby `1.9+`
+
+## Install
+
+    gem install philter
+
+To use it in a rails project, add to gem file `gem 'philter'` and run `bundle install`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-feature`)
+3. Commit your changes (`git commit -am 'I made extensive use of all my creativity'`)
+4. Push to the branch (`git push origin my-feature`)
+5. Create new Pull Request
+
+## Testing
+
+    bundle install
+    
+    bundle exec ruby test\philter_test.rb
+
+## Found a bug?
+
+Please open an issue.
+
+
+## License
+
+The GNU Lesser General Public License, version 3.0 (LGPL-3.0)
+See LICENSE file

data/lib/array.rb

@@ -0,0 +1,137 @@
+class Array
+  def philter search=nil, options={}
+    options = {
+        get:          nil,
+        debug:        false
+    }.merge(options)
+    help = <<-HELP.gsub(/^      /, '')
+      *************************************************************************
+      [].philter 'search', {options}
+      Examples:
+      [1,2,3].philter 1 => [1]
+      [1,2,3].philter [2,3] => [2, 3]
+      [{id: 1, name: 'Mark'},{id: 2, name: 'Bill'}].philter id: 1
+      Articles.philter id: 1
+      People.philter   name: 'Mario'
+      People.philter   email: /\A.+@gmail/
+      Use option get: to select an attribute
+      People.philter   {id: 1}, get: :surname
+      Use option debug: to watch the selection
+      Articles.philter {id: 1}, debug: true
+      *************************************************************************
+    HELP
+    unless search
+       puts help if options[:debug]
+       raise "Specify search parameter!"
+    end
+
+    results = []
+    self.each do |item|
+       puts "item #{item.class.name} #{item}"                               if options[:debug]
+       condition = {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 #{item.class.name}.#{label} =~ value "        if options[:debug]
+                   print "| #{item.send(label)} =~ #{value}"                if options[:debug]
+                   selected = item.send(label) =~ value
+                 else
+                   print " .2 #{item.class.name}.#{label} == value "        if options[:debug]
+                   print "| #{item.send(label)} == #{value}"                if options[:debug]
+                   selected = item.send(label) == value
+                 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 value === item "                              if options[:debug]
+                   print "| #{value} === '#{item[label]}'"                  if options[:debug]
+                   selected = value === item[label].to_s
+                 elsif item.is_a?(Hash) && !label.is_a?(Fixnum)
+                   # search: {id: 1} or {'name' => 'Mark'}
+                   print " .2 #{item.class.name}[:#{label}] == value "      if options[:debug]
+                   print "| #{item[label]} == #{value}"                     if options[:debug]
+                   selected = item[label] == value
+                 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]
+               condition[:at_least_one] ||= selected
+             end
+           elsif value.is_a?(Regexp)
+             # search: {email: /@gmail/}
+             print "   2. value === item "                                  if options[:debug]
+             print " | #{value} === '#{item}'"                              if options[:debug]
+             selected = value === item.to_s
+             puts "  #{'=> X' if selected}"                                 if options[:debug]
+             condition[:at_least_one] ||= selected
+           else
+             # Example search: [3] or search: [3, 4]
+             print "   3. item == value "                                   if options[:debug]
+             print "| #{item} == #{value}"                                  if options[:debug]
+             selected = item == value
+             puts "  #{'=> X' if selected}"                                 if options[:debug]
+             condition[:at_least_one] ||= selected
+           end
+         end
+       elsif search.is_a?(Regexp)
+         # Search has one item
+         # search: 3 or search: 'a'
+         print " b. search === item "                                       if options[:debug]
+         print " | #{search} === '#{item}'"                                 if options[:debug]
+         selected = search === item.to_s
+         puts "  #{'=> X' if selected}"                                     if options[:debug]
+         condition[:at_least_one] ||= selected
+       else
+         # Search has one item
+         # search: 3 or search: 'a'
+         print " c. item == search "                                        if options[:debug]
+         print "| #{item} == #{search}"                                     if options[:debug]
+         selected = item == search
+         puts "  #{'=> X' if selected}"                                     if options[:debug]
+         condition[:at_least_one] ||= selected
+       end
+       if condition[:at_least_one] || condition[:all]
+          tmp_result = if options[:get]
+                         item.respond_to?(options[:get]) ? item.send(options[:get]) : item[options[:get]]
+                       else
+                         item
+                       end
+          results << tmp_result
+        end
+    end
+    puts "------------------"                                               if options[:debug]
+    puts " #{results ? results.size : 'No'} item#{results && results.size == 1 ? '' : 's'} found" if options[:debug]
+    results
+  end
+
+  def phelect arg_fields
+    fields = arg_fields.split(',').flatten if arg_fields.respond_to?('split')
+    self.map do |item|
+      record = {}
+      fields.each do |field|
+        if item.respond_to?(field)
+          record[field.to_sym] = item.send field
+        elsif item.respond_to?'[]'
+          record[field.to_sym] = (item[field] || item[field.to_sym])
+        else
+          # How do i get the data ?
+        end
+      end
+    end
+  end
+end

data/lib/philter.rb

@@ -0,0 +1,5 @@
+require_relative 'version'
+require_relative 'array'
+
+module Philter
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+module Philter
+  def self.version
+    "0.2.0"
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: philter
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Marco Mastrodonato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem let you to filter any kind of arrays to get the item or attributes
+  of selected items
+email:
+- m.mastrodonato@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/array.rb
+- lib/philter.rb
+- lib/version.rb
+homepage: https://github.com/marcomd/philter
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- The brave to dare
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Filter arrays with pleasure
+test_files: []