rsubhak 0.1.3 → 0.2.0

data/lib/rsubhak.rb

@@ -1,9 +1,10 @@
 class Rsubhak
 
   ##
-  # Recursively traverse 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*.
+  # Recursively traverse a hash or array *ha* (potentially of other nested
+  # hashes and/or arrays), 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
@@ -23,7 +24,7 @@ class Rsubhak
   def self.rsubhak(ha, k, p, r)
     case ha
     when Hash
-      ha[k].gsub!(p, r) if ha[k]
+      ha[k].gsub!(p, r) if ha[k] # base case
       ha.each { |key, value|
         case value
         when Hash
@@ -38,4 +39,42 @@ class Rsubhak
       }
     end
   end
+
+  ##
+  # Recursively traverse a hash or array *ha* (potentially of other nested
+  # hashes and/or arrays), searching for all values that respond to *strip*,
+  # and calling *strip!* on them to remove leading and trailing whitespace.
+  #
+  # ==== Parameters
+  # *ha*:: hash or array
+  #
+  # ==== Examples
+  #   rstrip(params)
+  #
+  # ==== Pronunciation
+  # r strip
+  #
+  def self.rstrip(ha)
+    case ha
+    when Hash
+      ha.each { |key, value|
+        case value
+        when Hash
+          self.rstrip(ha[key])
+        when Array
+          self.rstrip(value)
+        else
+          value.strip! if value.respond_to?(:strip) # base case
+        end
+      }
+    when Array
+      ha.each_with_index { |item, index|
+        if item.class == Hash || item.class == Array
+          self.rstrip(item)
+        elsif item.respond_to?(:strip) # base case
+          ha[index].strip!
+        end
+      }
+    end
+  end
 end

data/test/test_rstrip.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'test_helper'
+
+class RsubhakTest < Test::Unit::TestCase
+
+  def test_strip_of_whitespace_from_hash_similar_to_rails_params
+    input= {"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", "corn"=>{"corn_category_id"=>"569", "country_name"=>" Canada ", "region_name"=>" Cowichan Valley ", "producer_name"=>" x ", "name"=>"La Crema", "year"=>"1700", "existing_grapeage_attributes"=>{"1010"=>{"leaf_varietal"=>{"name"=>" x ", "_delete"=>""}}}, "description"=>" hello ", "price_with_currency_and_commas"=>" $1,000.00 ", "remote_image_url"=>"", "existing_inventory_attributes"=>{"745"=>{"stockroom_id"=>" 84  ", "quantity_with_commas"=>" 1 "}, "746"=>{"stockroom_id"=>" 85 ", "quantity_with_commas"=>"2 "}, "747"=>{"stockroom_id"=>"86", "quantity_with_commas"=>" 3"}}, "publishable"=>"1"}, "commit"=>"Save this corn", "id"=>" 659 "}
+    expect={"utf8"=>"✓", "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", "corn"=>{"corn_category_id"=>"569", "country_name"=>"Canada", "region_name"=>"Cowichan Valley", "producer_name"=>"x", "name"=>"La Crema", "year"=>"1700", "existing_grapeage_attributes"=>{"1010"=>{"leaf_varietal"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"hello", "price_with_currency_and_commas"=>"$1,000.00", "remote_image_url"=>"", "existing_inventory_attributes"=>{"745"=>{"stockroom_id"=>"84", "quantity_with_commas"=>"1"}, "746"=>{"stockroom_id"=>"85", "quantity_with_commas"=>"2"}, "747"=>{"stockroom_id"=>"86", "quantity_with_commas"=>"3"}}, "publishable"=>"1"}, "commit"=>"Save this corn", "id"=>"659"}
+    assert_equal expect,
+      Rsubhak.rstrip(input)
+  end
+
+  def test_strip_of_whitespace_from_hash_of_nested_hashes_and_arrays
+    input= {"utf8"=>"✓", "a"=>["b", "  c  "], "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", "corn"=>{"corn_category_id"=>"569", "country_name"=>" Canada ", "region_name"=>" Cowichan Valley ", "producer_name"=>" x ", "name"=>"La Crema", "year"=>"1700", "existing_grapeage_attributes"=>{"1010"=>{"leaf_varietal"=>{"name"=>" x ", "_delete"=>""}}}, "description"=>" hello ", "price_with_currency_and_commas"=>" $1,000.00 ", "remote_image_url"=>"", "existing_inventory_attributes"=>{"745"=>{"stockroom_id"=>" 84  ", "quantity_with_commas"=>" 1 "}, "746"=>{"stockroom_id"=>" 85 ", "quantity_with_commas"=>"2 "}, "747"=>{"stockroom_id"=>"86", "quantity_with_commas"=>" 3", "z"=>[" w", " x ", "y "]}}, "publishable"=>"1"}, "commit"=>"Save this corn", "id"=>" 659 "}
+    expect={"utf8"=>"✓", "a"=>["b", "c"], "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", "corn"=>{"corn_category_id"=>"569", "country_name"=>"Canada", "region_name"=>"Cowichan Valley", "producer_name"=>"x", "name"=>"La Crema", "year"=>"1700", "existing_grapeage_attributes"=>{"1010"=>{"leaf_varietal"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"hello", "price_with_currency_and_commas"=>"$1,000.00", "remote_image_url"=>"", "existing_inventory_attributes"=>{"745"=>{"stockroom_id"=>"84", "quantity_with_commas"=>"1"}, "746"=>{"stockroom_id"=>"85", "quantity_with_commas"=>"2"}, "747"=>{"stockroom_id"=>"86", "quantity_with_commas"=>"3", "z"=>["w", "x", "y"]}}, "publishable"=>"1"}, "commit"=>"Save this corn", "id"=>"659"}
+    assert_equal expect,
+      Rsubhak.rstrip(input)
+  end
+
+  def test_strip_of_whitespace_from_array_of_nested_hashes_and_arrays
+    input= [" hello ", "   ",  {"utf8"=>"✓", "a"=>["b", "  c  "], "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", "corn"=>{"corn_category_id"=>"569", "country_name"=>" Canada ", "region_name"=>" Cowichan Valley ", "producer_name"=>" x ", "name"=>"La Crema", "year"=>"1700", "existing_grapeage_attributes"=>{"1010"=>{"leaf_varietal"=>{"name"=>" x ", "_delete"=>""}}}, "description"=>" hello ", "price_with_currency_and_commas"=>" $1,000.00 ", "remote_image_url"=>"", "existing_inventory_attributes"=>{"745"=>{"stockroom_id"=>" 84  ", "quantity_with_commas"=>" 1 "}, "746"=>{"stockroom_id"=>" 85 ", "quantity_with_commas"=>"2 "}, "747"=>{"stockroom_id"=>"86", "quantity_with_commas"=>" 3", "z"=>[" w", " x ", "y "]}}, "publishable"=>"1"}, "commit"=>"Save this corn", "id"=>" 659 "}]
+    expect=["hello", "",  {"utf8"=>"✓", "a"=>["b", "c"], "authenticity_token"=>"N2gqZ3+Zm8JDsXg94/7lB3AZSB5o3PLxPHPbDJRvhkI=", "corn"=>{"corn_category_id"=>"569", "country_name"=>"Canada", "region_name"=>"Cowichan Valley", "producer_name"=>"x", "name"=>"La Crema", "year"=>"1700", "existing_grapeage_attributes"=>{"1010"=>{"leaf_varietal"=>{"name"=>"x", "_delete"=>""}}}, "description"=>"hello", "price_with_currency_and_commas"=>"$1,000.00", "remote_image_url"=>"", "existing_inventory_attributes"=>{"745"=>{"stockroom_id"=>"84", "quantity_with_commas"=>"1"}, "746"=>{"stockroom_id"=>"85", "quantity_with_commas"=>"2"}, "747"=>{"stockroom_id"=>"86", "quantity_with_commas"=>"3", "z"=>["w", "x", "y"]}}, "publishable"=>"1"}, "commit"=>"Save this corn", "id"=>"659"}]
+    assert_equal expect,
+      Rsubhak.rstrip(input)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsubhak
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,13 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-04 00:00:00.000000000Z
+date: 2012-04-12 00:00:00.000000000Z
 dependencies: []
-description: ! 'Recursively traverse 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).. Though the initial intent was to sanitize the params hash
-  as far as removing currency symbols and/or commas from attributes such as price
-  and quantity, there is a better approach: see the note on the homepage.'
+description: ! 'Recursively traverse a hash or array *ha* (potentially of other nested
+  hashes and/or arrays), doing manipulations. Two methods are available: rsubhak (do
+  substitutions to hash values) and rstrip (strip whitespace from params hash).. Though
+  the initial intent of the rsubhak method was to sanitize the params hash as far
+  as removing currency symbols and/or commas from attributes such as price and quantity,
+  there is a better approach: see the note on the homepage.'
 email:
 - alexbatko@gmail.com
 executables: []
@@ -24,6 +25,7 @@ extra_rdoc_files: []
 files:
 - lib/rsubhak.rb
 - test/test_helper.rb
+- test/test_rstrip.rb
 - test/test_rsubhak.rb
 homepage: https://github.com/abatko/rsubhak
 licenses: []
@@ -48,9 +50,10 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Recursively traverse 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).
+summary: ! 'Recursively traverse a hash or array *ha* (potentially of other nested
+  hashes and/or arrays), doing manipulations. Two methods are available: rsubhak (do
+  substitutions to hash values) and rstrip (strip whitespace from params hash).'
 test_files:
 - test/test_helper.rb
+- test/test_rstrip.rb
 - test/test_rsubhak.rb