crazy_hash_filter 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby
+  - rbx
+script: "bundle exec rake spec"
+

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'activesupport'
+
+group :test do
+  gem "rspec"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Laurynas Butkus
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,157 @@
+# CrazyHashFilter
+
+[![Build Status](https://secure.travis-ci.org/friendlyfashion/crazy_hash_filter.png)](http://travis-ci.org/friendlyfashion/crazy_hash_filter)
+
+Hash filtering by advanced rules.
+
+Can be used to reduce API data throughput if you are building API responses from hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crazy_hash_filter'
+
+## Usage
+
+### Sample hash
+
+```ruby
+  @sample = {
+    :code => 0,
+    :items => [
+      { :id => 1,
+        :title => 'First item',
+        :thumbs => [
+          { :code => '50', :url => 'http://some-url/1/50' },
+          { :code => '100', :url => 'http://some-url/1/100' },
+          { :code => '150', :url => 'http://some-url/1/150' }
+        ]
+      },
+      { :id => 2,
+        :title => 'Second item',
+        :thumbs => [
+          { :code => '50', :url => 'http://some-url/2/50' },
+          { :code => '100', :url => 'http://some-url/2/100' },
+          { :code => '150', :url => 'http://some-url/2/150' }
+        ]
+      },
+    ]
+  }
+```
+
+### Simple filtering
+
+```ruby
+  rules  = { :select => [ :code ] }
+```
+
+#### Result
+
+```ruby
+  result = CrazyHashFilter.process(@sample, rules)
+
+  { :code => 0 }
+```
+
+### Filtering with nested rules
+
+```ruby
+  rules = {
+    :select => [ :code, :items ],
+    :child_rules => {
+      :items => { :select => [ :id, :title ] }
+    }
+  }
+```
+
+#### Result
+
+```ruby
+  result = CrazyHashFilter.process(@sample, rules)
+
+  { :code=>0,
+    :items=> [
+      {:id=>1, :title=>"First item"},
+      {:id=>2, :title=>"Second item"}
+    ]
+  }
+```
+
+### Filtering with conditions
+
+```ruby
+  rules = {
+    :select => [ :code, :items ],
+      :child_rules => {
+      :items => {
+        :select => [ :id, :thumbs ],
+
+        :child_rules => {
+          :thumbs => {
+            :conditions => {
+              :code => '50'
+            }
+          }
+        }
+      }
+    }
+  }
+```
+
+#### Result
+
+```ruby
+  result = CrazyHashFilter.process(@sample, rules)
+
+  { :code=>0,
+    :items=> [
+      { :id=>1, :thumbs=> [ { :code=>"50", :url=> "http://some-url/1/50" } ] },
+      { :id=>2, :thumbs=> [ { :code=>"50", :url=> "http://some-url/2/50" } ] }
+  ]}
+```
+
+### Filtering with conditions array
+
+```ruby
+  rules = {
+    :select => [ :code, :items ],
+      :child_rules => {
+      :items => {
+        :select => [ :id, :thumbs ],
+
+        :child_rules => {
+          :thumbs => {
+            :conditions => {
+              :code => [ '50', '100' ]
+            }
+          }
+        }
+      }
+    }
+  }
+```
+
+#### Result
+
+```ruby
+  result = CrazyHashFilter.process(@sample, rules)
+
+  { :code => 0,
+    :items=> [
+      { :id=>1,
+        :thumbs=>[
+          { :code => "50", :url => "http://some-url/1/50" },
+          { :code => "100", :url => "http://some-url/1/100" }
+        ]
+      },
+      { :id => 2,
+        :thumbs => [
+          { :code => "50", :url => "http://some-url/2/50" },
+          { :code => "100", :url => "http://some-url/2/100" }
+        ]
+      }
+    ]
+  }
+```
+

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/crazy_hash_filter.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/crazy_hash_filter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Laurynas Butkus", "Tomas Didziokas", "Justas Janauskas", "Edvinas Bartkus"]
+  gem.email         = ["laurynas.butkus@gmail.com", "tomas.did@gmail.com", "jjanauskas@gmail.com", "edvinas.bartkus@gmail.com"]
+
+  gem.description   = %q{Hash filtering by advanced rules}
+  gem.summary       = %q{Hash filtering by advanced rules. Can be used to reduce API data throughput if you are building API responses from hashes.}
+  gem.homepage      = "http://github.com/friendlyfashion/crazy_hash_filter"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "crazy_hash_filter"
+  gem.require_paths = ["lib"]
+  gem.version       = CrazyHashFilter::VERSION
+end

data/lib/crazy_hash_filter/version.rb

@@ -0,0 +1,3 @@
+module CrazyHashFilter
+  VERSION = "0.0.1"
+end

data/lib/crazy_hash_filter.rb

@@ -0,0 +1,78 @@
+require "crazy_hash_filter/version"
+require "active_support/core_ext/hash/indifferent_access.rb"
+
+module CrazyHashFilter
+
+  def self.process(hash, rules)
+    rules       = HashWithIndifferentAccess.new(rules || {}) unless rules.is_a?(HashWithIndifferentAccess)
+    child_rules = rules[:child_rules] || {}
+    result      = {}
+    select      = rules[:select].collect(&:to_sym) unless rules[:select].nil?
+
+    hash.each do |key, value|
+      next if !select.nil? && !select.include?(key.to_sym)
+
+      if child_rules[key].nil?
+        result[key] = value
+      else
+        if value.is_a?(Array)
+          result[key] = self.filter_array(value, child_rules[key])
+        else
+          result[key] = self.process(value, child_rules[key])
+        end
+      end
+    end
+
+    result
+  end
+
+  private
+
+  def self.filter_array(array, rules)
+    result      = []
+    conditions  = rules[:conditions] || {}
+
+    array.each do |value|
+      result << self.process(value, rules) if match_conditions(value, conditions)
+    end
+
+    result
+  end
+
+  def self.match_conditions(value, conditions)
+    indifferent_value = HashWithIndifferentAccess.new(value)
+
+    conditions.inject(true) do |b, r|
+      key, match = r
+
+      if match.is_a?(Array)
+        b & self.is_value_in_array?(indifferent_value[key], match)
+      else
+        b & self.values_match?(indifferent_value[key], match)
+      end
+    end
+  end
+
+  def self.is_value_in_array?(value, array)
+    array.each do |v|
+      return true if self.values_match?(v, value)
+    end
+
+    return false
+  end
+
+  def self.values_match?(a, b)
+    a == self.equalize_type(b, a)
+  end
+
+  def self.equalize_type(value, target)
+    if target.is_a?(Integer) && value.is_a?(String)
+      return value.to_i
+    elsif target.is_a?(String) && value.is_a?(Integer)
+      return value.to_s
+    else
+      return value
+    end
+  end
+
+end

data/spec/crazy_hash_filter_spec.rb

@@ -0,0 +1,188 @@
+require 'spec_helper'
+
+describe CrazyHashFilter do
+
+  before do
+    @sample = {
+      :code => 0,
+      :items => [
+        { :id => 1,
+          :title => 'First item',
+          :thumbs => [
+            { :code => '50', :url => 'http://some-url/1/50' },
+            { :code => '100', :url => 'http://some-url/1/100' },
+            { :code => '150', :url => 'http://some-url/1/150' }
+          ]
+        },
+        { :id => 2,
+          :title => 'Second item',
+          :thumbs => [
+            { :code => '50', :url => 'http://some-url/2/50' },
+            { :code => '100', :url => 'http://some-url/2/100' },
+            { :code => '150', :url => 'http://some-url/2/150' }
+          ]
+        },
+      ]
+    }
+  end
+
+  it "should return same hash if no filters passed" do
+    result = CrazyHashFilter.process(@sample, {})
+    result.should == @sample
+  end
+
+  it "should select only certain keys from the hash" do
+    rules = { :select => [ :code ] }
+
+    result = CrazyHashFilter.process(@sample, rules)
+
+    result.should == { :code => 0 }
+  end
+
+  it "should filter with nested rules" do
+    rules = {
+      :select => [ :code, :items ],
+      :child_rules => {
+        :items => {
+          :select => [ :id, :title ]
+        }
+      }
+    }
+
+    result = CrazyHashFilter.process(@sample, rules)
+
+    result.keys.should include(:code)
+    result.keys.should include(:items)
+
+    result[:items][0].keys.should include(:id)
+    result[:items][0].keys.should include(:title)
+    result[:items][0].keys.should_not include(:thumbs)
+    result[:items][1].keys.should include(:id)
+    result[:items][1].keys.should include(:title)
+    result[:items][1].keys.should_not include(:thumbs)
+  end
+
+  it "should filter with nested rules and conditions" do
+    rules = {
+      :select => [ :code, :items ],
+
+      :child_rules => {
+        :items => {
+          :select => [ :id, :title, :thumbs ],
+
+          :child_rules => {
+            :thumbs => {
+              :conditions => {
+                :code => [ '50', '100' ]
+              }
+            }
+          }
+        }
+      }
+    }
+
+    result = CrazyHashFilter.process(@sample, rules)
+
+    result.keys.should include(:code)
+    result.keys.should include(:items)
+
+    result[:items][0].keys.should include(:id)
+    result[:items][0].keys.should include(:title)
+    result[:items][0].keys.should include(:thumbs)
+    result[:items][0][:thumbs].collect { |t| t[:code] }.should include('50')
+    result[:items][0][:thumbs].collect { |t| t[:code] }.should include('100')
+    result[:items][0][:thumbs].collect { |t| t[:code] }.should_not include('150')
+  end
+
+  it "should accept condition strings" do
+    rules = {
+      :select => [ :code, :items ],
+
+      :child_rules => {
+        :items => {
+          :select => [ :id, :thumbs ],
+
+          :child_rules => {
+            :thumbs => {
+              :conditions => {
+                :code => '50'
+              }
+            }
+          }
+        }
+      }
+    }
+
+    result = CrazyHashFilter.process(@sample, rules)
+
+    result[:items][0][:thumbs].collect { |t| t[:code] }.should include('50')
+    result[:items][0][:thumbs].collect { |t| t[:code] }.should_not include('100')
+    result[:items][0][:thumbs].collect { |t| t[:code] }.should_not include('150')
+  end
+
+  it "should allow using strings in rules" do
+    rules = {
+      'select' => [ 'code', 'items' ],
+      'child_rules' => {
+        'items' => {
+          'select' => [ 'id', 'title' ]
+        }
+      }
+    }
+
+    result = CrazyHashFilter.process(@sample, rules)
+
+    result.keys.should include(:code)
+    result.keys.should include(:items)
+
+    result[:items][0].keys.should include(:id)
+    result[:items][0].keys.should include(:title)
+    result[:items][0].keys.should_not include(:thumbs)
+    result[:items][1].keys.should include(:id)
+    result[:items][1].keys.should include(:title)
+    result[:items][1].keys.should_not include(:thumbs)
+  end
+
+  it "should match integer conditions" do
+    rules = {
+      :select => [ :code, :items ],
+
+      :child_rules => {
+        :items => {
+          :select => [ :id, :thumbs ],
+
+          :conditions => {
+            :id => 1
+          }
+        }
+      }
+    }
+
+    result = CrazyHashFilter.process(@sample, rules)
+
+    result[:items].collect { |i| i[:id] }.should include(1)
+    result[:items].collect { |i| i[:id] }.should_not include(2)
+  end
+
+  it "should match integer to string conditions" do
+    rules = {
+      :select => [ :code, :items ],
+
+      :child_rules => {
+        :items => {
+          :select => [ :id, :thumbs ],
+
+          :conditions => {
+            :id => '1'
+          }
+        }
+      }
+    }
+
+    result = CrazyHashFilter.process(@sample, rules)
+
+    result[:items].collect { |i| i[:id] }.should include(1)
+    result[:items].collect { |i| i[:id] }.should_not include(2)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'crazy_hash_filter'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: crazy_hash_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Laurynas Butkus
+- Tomas Didziokas
+- Justas Janauskas
+- Edvinas Bartkus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-07 00:00:00.000000000 Z
+dependencies: []
+description: Hash filtering by advanced rules
+email:
+- laurynas.butkus@gmail.com
+- tomas.did@gmail.com
+- jjanauskas@gmail.com
+- edvinas.bartkus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- crazy_hash_filter.gemspec
+- lib/crazy_hash_filter.rb
+- lib/crazy_hash_filter/version.rb
+- spec/crazy_hash_filter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/friendlyfashion/crazy_hash_filter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Hash filtering by advanced rules. Can be used to reduce API data throughput
+  if you are building API responses from hashes.
+test_files:
+- spec/crazy_hash_filter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: