rsubhak 0.1.0

data/lib/rsubhak.rb

@@ -0,0 +1,41 @@
+class Rsubhak
+
+  ##
+  # Recursively walk a hash or array *ha*, 
+  # searching for all occurrences of hash key *k*, and substituting
+  # (within their values) all occurrences of pattern *p* for replacement *r*.
+  #
+  # ==== Parameters
+  # *ha*:: hash or array
+  # *k*:: hash key
+  # *p*:: pattern
+  # *r*:: replacement
+  #
+  # ==== Examples
+  #   rsubhak(params, 'price', /[€\.]/, '')
+  #   rsubhak(params, 'price', /,/, '.')
+  #
+  #   rsubhak(params, 'price', /[\$,]/, '')
+  #
+  # ==== Pronunciation
+  # r sub hak
+  #
+  def self.rsubhak(ha, k, p, r)
+    case ha
+    when Hash
+      ha[k].gsub!(p, r) if ha[k]
+      ha.each { |key, value|
+        case value
+        when Hash
+          rsubhak(ha[key], k, p, r)
+        when Array
+          rsubhak(value, k, p, r)
+        end
+      }
+    when Array
+      ha.each { |i|
+        rsubhak(i, k, p, r) if i.class == Hash || i.class == Array
+      }
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'rsubhak'

data/test/test_rsubhak.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+require 'test_helper'
+
+class RsubhakTest < Test::Unit::TestCase
+
+  def test_remove_dollar_sign_and_commas_from_price_string_key_in_enclosing_array
+    input= [{"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"$2,500,000.00", "price"=>"$1,500,000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"$10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"$5.00"}, "fff"=>{:price=>"$6,000.00"}}], {"stockroom_id"=>"45", "quantity"=>"5,000"}], {"stockroom_id"=>"46", "quantity"=>"1,000", "x"=>["xyz", {"price"=>"$4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12,000,000,000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}]
+    expect=[{"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"$2,500,000.00", "price"=>"1500000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"5.00"}, "fff"=>{:price=>"$6,000.00"}}], {"stockroom_id"=>"45", "quantity"=>"5,000"}], {"stockroom_id"=>"46", "quantity"=>"1,000", "x"=>["xyz", {"price"=>"4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12,000,000,000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}]
+    assert_equal expect,
+      Rsubhak.rsubhak(input, 'price', /[\$,]/, '')
+  end
+
+  def test_remove_dollar_sign_and_commas_from_price_string_key
+    input= {"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"$2,500,000.00", "price"=>"$1,500,000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"$10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"$5.00"}, "fff"=>{:price=>"$6,000.00"}}], {"stockroom_id"=>"45", "quantity"=>"5,000"}], {"stockroom_id"=>"46", "quantity"=>"1,000", "x"=>["xyz", {"price"=>"$4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12,000,000,000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}
+    expect={"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"$2,500,000.00", "price"=>"1500000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"5.00"}, "fff"=>{:price=>"$6,000.00"}}], {"stockroom_id"=>"45", "quantity"=>"5,000"}], {"stockroom_id"=>"46", "quantity"=>"1,000", "x"=>["xyz", {"price"=>"4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12,000,000,000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}
+    assert_equal expect,
+      Rsubhak.rsubhak(input, 'price', /[\$,]/, '')
+  end
+
+  def test_remove_dollar_sign_and_commas_from_price_symbol_key
+    input= {"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"$2,500,000.00", "price"=>"$1,500,000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"$10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"$5.00"}, "fff"=>{:price=>"$6,000.00"}}], {"stockroom_id"=>"45", "quantity"=>"5,000"}], {"stockroom_id"=>"46", "quantity"=>"1,000", "x"=>["xyz", {"price"=>"$4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12,000,000,000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}
+    expect={"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"2500000.00", "price"=>"$1,500,000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"$10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"$5.00"}, "fff"=>{:price=>"6000.00"}}], {"stockroom_id"=>"45", "quantity"=>"5,000"}], {"stockroom_id"=>"46", "quantity"=>"1,000", "x"=>["xyz", {"price"=>"$4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12,000,000,000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}
+    assert_equal expect,
+      Rsubhak.rsubhak(input, :price, /[\$,]/, '')
+  end
+
+  def test_remove_commas_from_quantity_string_key
+    input= {"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"$2,500,000.00", "price"=>"$1,500,000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"$10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"$5.00"}, "fff"=>{:price=>"$6,000.00"}}], {"stockroom_id"=>"45", "quantity"=>"5,000"}], {"stockroom_id"=>"46", "quantity"=>"1,000", "x"=>["xyz", {"price"=>"$4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12,000,000,000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}
+    expect={"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"$2,500,000.00", "price"=>"$1,500,000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"$10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"$5.00"}, "fff"=>{:price=>"$6,000.00"}}], {"stockroom_id"=>"45", "quantity"=>"5000"}], {"stockroom_id"=>"46", "quantity"=>"1000", "x"=>["xyz", {"price"=>"$4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12000000000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}
+    assert_equal expect,
+      Rsubhak.rsubhak(input, 'quantity', /,/, '')
+  end
+
+  def test_remove_euro_sign_and_periods_from_price_symbol_key
+    input= {"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"€2.500.000,00", "price"=>"$1,500,000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"$10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"$5.00"}, "fff"=>{:price=>"€6.000,00"}}], {"stockroom_id"=>"45", "quantity"=>"5,000"}], {"stockroom_id"=>"46", "quantity"=>"1,000", "x"=>["xyz", {"price"=>"$4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12,000,000,000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}
+    expect={"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"2500000,00", "price"=>"$1,500,000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"$10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"$5.00"}, "fff"=>{:price=>"6000,00"}}], {"stockroom_id"=>"45", "quantity"=>"5,000"}], {"stockroom_id"=>"46", "quantity"=>"1,000", "x"=>["xyz", {"price"=>"$4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12,000,000,000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}
+    intermediary = Rsubhak.rsubhak(input, :price, /[€\.]/, '')
+    assert_equal expect, intermediary
+    expect={"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"2500000.00", "price"=>"$1,500,000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"$10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"$5.00"}, "fff"=>{:price=>"6000.00"}}], {"stockroom_id"=>"45", "quantity"=>"5,000"}], {"stockroom_id"=>"46", "quantity"=>"1,000", "x"=>["xyz", {"price"=>"$4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12,000,000,000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}
+    assert_equal expect,
+      Rsubhak.rsubhak(intermediary, :price, /,/, '.')
+  end
+
+  def test_remove_all_currency_signs_and_commas_and_convert_comma_decimal_separator_to_periods_all_prices_and_quantities
+    input= {"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"€2.500.000,00", "price"=>"$1,500,000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"$10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"$5.00"}, "fff"=>{:price=>"€6.000,00"}}], {"stockroom_id"=>"45", "quantity"=>"5,000"}], {"stockroom_id"=>"46", "quantity"=>"1,000", "x"=>["xyz", {"price"=>"$4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12,000,000,000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}
+    expect={"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", :price=>"2500000.00", "price"=>"1500000.00", "corn"=>{"corn_category_id"=>"299", "country_name"=>"x", "region_name"=>"x", "producer_name"=>"x", "name"=>"x", "year"=>"2012", "new_corny_attributes"=>{"1333074807.696388"=>{"leaf_variation"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"x", "price"=>"10.00", "remote_image_url"=>"", "new_inventory_attributes"=>["aaa", 123, [123, [123, "bbb", {"ccc"=>"ddd", "eee"=>{"price"=>"5.00"}, "fff"=>{:price=>"6000.00"}}], {"stockroom_id"=>"45", "quantity"=>"5000"}], {"stockroom_id"=>"46", "quantity"=>"1000", "x"=>["xyz", {"price"=>"4.00"}, "", []]}, {"stockroom_id"=>"47", "quantity"=>"0.01"}, {"stockroom_id"=>"48", "quantity"=>"12000000000"}], "publishable"=>"0"}, "commit"=>"Save this thing"}
+    Rsubhak.rsubhak(input, :price, /[€\.]/, '')
+    Rsubhak.rsubhak(input, :price, /,/, '.')
+    Rsubhak.rsubhak(input, 'price', /[\$,]/, '')
+    assert_equal expect,
+      Rsubhak.rsubhak(input, 'quantity', /,/, '')
+  end
+
+  def test_readme_rdoc_example
+    input= {"utf8"=>"✓", "authenticity_token"=>"xyz", "type"=>"cheese", "cheese"=>{"cheese_category_id"=>"299", "country_name"=>"France", "region_name"=>"Savoie", "producer_name"=>"aaa", "name"=>"bbb", "year"=>"2001", "new_grapeage_attributes"=>{"1333074807.696388"=>{"cheese_variation"=>{"name"=>"ccc", "_delete"=>""}}}, "description"=>"ddd", "price"=>"$100.00", "remote_image_url"=>"", "new_variant_attributes"=>[{"variation_id"=>"46", "price"=>"$150.00"}, {"variation_id"=>"47", "price"=>"$1,500"}, {"variation_id"=>"48", "price"=>"$10,500"}], "publishable"=>"0"}, "commit"=>"Save this cheese"}
+    expect={"utf8"=>"✓", "authenticity_token"=>"xyz", "type"=>"cheese", "cheese"=>{"cheese_category_id"=>"299", "country_name"=>"France", "region_name"=>"Savoie", "producer_name"=>"aaa", "name"=>"bbb", "year"=>"2001", "new_grapeage_attributes"=>{"1333074807.696388"=>{"cheese_variation"=>{"name"=>"ccc", "_delete"=>""}}}, "description"=>"ddd", "price"=>"100.00", "remote_image_url"=>"", "new_variant_attributes"=>[{"variation_id"=>"46", "price"=>"150.00"}, {"variation_id"=>"47", "price"=>"1500"}, {"variation_id"=>"48", "price"=>"10500"}], "publishable"=>"0"}, "commit"=>"Save this cheese"}
+    assert_equal expect,
+      Rsubhak.rsubhak(input, 'price', /[\$,]/, '')
+  end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: rsubhak
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Batko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-31 00:00:00.000000000Z
+dependencies: []
+description: Rsubhak can be used to sanitize a params hash. For instance, remove currency
+  symbols and commas from decimal fields (e.g. price, cost, quantity). Convert '$1,500.00'
+  to '1500.00'.
+email:
+- alexbatko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rsubhak.rb
+- test/test_helper.rb
+- test/test_rsubhak.rb
+homepage: ''
+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.10
+signing_key: 
+specification_version: 3
+summary: Recursively walk a hash or array (ha), searching for all occurrences of hash
+  key (k), and substituting (within their values) all occurrences of pattern (p) for
+  replacement (r).
+test_files:
+- test/test_helper.rb
+- test/test_rsubhak.rb