mobme_support 2.2.4 → 2.3.0

data/lib/mobme_support/core_ext/hash/keys.rb

@@ -7,24 +7,43 @@ require_relative '../../version'
 module MobME::Infrastructure::Utilities::CoreExtensions
   # Hash extension, allowing recursive Hash key symbolization
   module Keys
-    # Recursively symbolize all keys in the hash.
-    def recursively_symbolize_keys!(modify_nested_arrays = false)
-      case self
-      when Hash
-        symbolize_keys!
+    # Returns a version of the supplies Hash or Array with all Hash keys symbolized.
+    #
+    # @param [Boolean] modify_nested_arrays set to true to iterate over array contents. Defaults to false.
+    # @return [Hash, Array] recursively symbolized Array or Hash
+    def recursively_symbolize_keys(modify_nested_arrays = false)
+      recursively_symbolized_value = case self
+        when Hash
+          symbolized_hash = symbolize_keys
 
-        each do |key, value|
-          if value.is_a?(Hash) || (modify_nested_arrays && value.is_a?(Array))
-            self[key] = value.dup.recursively_symbolize_keys!(modify_nested_arrays)
+          symbolized_hash.each do |key, value|
+            if value.is_a?(Hash) || (modify_nested_arrays && value.is_a?(Array))
+              symbolized_hash[key] = value.recursively_symbolize_keys(modify_nested_arrays)
+            end
           end
-        end
-      when Array
-        each_with_index do |value, index|
-          self[index] = value.dup.recursively_symbolize_keys!(true) if (value.is_a?(Hash) || value.is_a?(Array))
-        end
+
+          symbolized_hash
+        when Array
+          symbolized_array = self.dup
+
+          symbolized_array.each_with_index do |value, index|
+            symbolized_array[index] = value.recursively_symbolize_keys(true) if (value.is_a?(Hash) || value.is_a?(Array))
+          end
+
+          symbolized_array
       end
 
-      self
+      recursively_symbolized_value
+    end
+
+    alias_method :recursive_symbolize_keys, :recursively_symbolize_keys
+
+    # Recursively symbolize all keys in hashes.
+    #
+    # @param [Boolean] modify_nested_arrays set to true to modify array contents. Defaults to false.
+    # @return [Hash, Array] recursively symbolized Array or Hash
+    def recursively_symbolize_keys!(modify_nested_arrays = false)
+      replace recursively_symbolize_keys(modify_nested_arrays)
     end
 
     alias_method :recursive_symbolize_keys!, :recursively_symbolize_keys!

data/lib/mobme_support/version.rb

@@ -4,7 +4,7 @@ module MobME
     # code.
     module Utilities
       # Version string.
-      VERSION = '2.2.4'
+      VERSION = '2.3.0'
 
       # Extensions to core Ruby classes.
       module CoreExtensions

data/spec/mobme/infrastructure/utilities/core_ext/hash/keys_spec.rb

@@ -6,28 +6,27 @@ module MobMESupport::CoreExtensions
   describe "Hash" do
     subject { {"foo" => {"bar" => "baz"}, :already_symbol => "far", 123 => "faz"} }
 
-    describe "#recursively_symbolize_keys!" do
-      before(:each) { subject.recursively_symbolize_keys! }
-
-      it { should == {:foo => {:bar => "baz"}, :already_symbol => "far", 123 => "faz"} }
+    describe "recursively_symbolize_keys" do
+      it "returns a recursilvely symbolized version of the value" do
+        subject.recursively_symbolize_keys.should == {:foo => {:bar => "baz"}, :already_symbol => "far", 123 => "faz"}
+      end
 
-      it "returns the recursively symbolized hash" do
-        {"foo" => "bar"}.recursively_symbolize_keys!.should == {:foo => "bar"}
+      it "does not alter the original object" do
+        subject.recursively_symbolize_keys
+        subject.should == {"foo" => {"bar" => "baz"}, :already_symbol => "far", 123 => "faz"}
       end
 
       context "when the modify_nested_arrays flag is set to true" do
         it "recursively symbolizes nested Hashes if they are nested inside an Array" do
           with_hash_inside_array = {"foo" => {"bar" => [{"baz" => [{"qux" => "qar"}, "string"]}]}}
-          with_hash_inside_array.recursively_symbolize_keys!(true)
-          with_hash_inside_array.should == {:foo => {:bar => [{:baz => [{:qux => "qar"}, "string"]}]}}
+          with_hash_inside_array.recursively_symbolize_keys(true).should == {:foo => {:bar => [{:baz => [{:qux => "qar"}, "string"]}]}}
         end
       end
 
       context "when the modify_nested_arrays flag is not set" do
         it "does not recursively symbolize nested Hashes if they are nested inside an Array" do
           with_hash_inside_array = {"foo" => {"bar" => [{"baz" => "qux"}]}}
-          with_hash_inside_array.recursively_symbolize_keys!
-          with_hash_inside_array.should == {:foo => {:bar => [{"baz" => "qux"}]}}
+          with_hash_inside_array.recursively_symbolize_keys.should == {:foo => {:bar => [{"baz" => "qux"}]}}
         end
       end
 
@@ -37,7 +36,7 @@ module MobMESupport::CoreExtensions
           sample_hash = {"far" => "bar"}
           hash_to_symbolize = {"array" => sample_array, "hash" => sample_hash}
 
-          hash_to_symbolize.recursively_symbolize_keys!(true)
+          hash_to_symbolize.recursively_symbolize_keys(true)
 
           sample_array.should == [{"foo" => "bar"}]
           sample_hash.should == {"far" => "bar"}
@@ -45,6 +44,21 @@ module MobMESupport::CoreExtensions
       end
     end
 
+    describe "#recursively_symbolize_keys!" do
+      it "replaces itself with the recursively symbolized version" do
+        replacement_object = double "Replacement"
+        subject.stub recursively_symbolize_keys: replacement_object
+        subject.should_receive(:replace).with(replacement_object)
+        subject.recursively_symbolize_keys!
+      end
+    end
+
+    describe "#recursive_symbolize_keys" do
+      it "is an alias for #recursively_symbolize_keys" do
+        subject.method(:recursive_symbolize_keys).should == subject.method(:recursively_symbolize_keys)
+      end
+    end
+
     describe "#recursive_symbolize_keys!" do
       it "is an alias for #recursively_symbolize_keys!" do
         subject.method(:recursive_symbolize_keys!).should == subject.method(:recursively_symbolize_keys!)
@@ -53,11 +67,20 @@ module MobMESupport::CoreExtensions
   end
 
   describe "Array" do
-    describe "#recursively_symbolize_keys!" do
+    subject { [{"foo" => "bar"}, {"baz" => "qux"}] }
+
+    describe "#recursively_symbolize_keys" do
       it "recursively symbolizes Hash values in the array" do
-        array_with_hash_values = [{"foo" => "bar"}, {"baz" => "qux"}]
-        array_with_hash_values.recursively_symbolize_keys!
-        array_with_hash_values.should == [{:foo => "bar"}, {:baz => "qux"}]
+        subject.recursively_symbolize_keys.should == [{:foo => "bar"}, {:baz => "qux"}]
+      end
+    end
+
+    describe "#recursively_symbolize_keys!" do
+      it "replaces itself with the recursively symbolized version" do
+        replacement_object = double "Replacement"
+        subject.stub recursively_symbolize_keys: replacement_object
+        subject.should_receive(:replace).with(replacement_object)
+        subject.recursively_symbolize_keys!
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobme_support
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n