Merge pull request #10 from benSlaughter/modify-hash-keys

Added functionality to modify hash keys

.rubocop.yml

@@ -3,6 +3,10 @@ Metrics/LineLength:
     - '*.gemspec'
     - 'spec/**/*_spec.rb'
 
+Metrics/BlockLength:
+  Exclude:
+      - 'spec/**/*_spec.rb'
+
 Style/SymbolProc:
   Exclude:
     - 'lib/utilise/augment/hash.rb'

lib/utilise.rb

@@ -1,7 +1,7 @@
 require 'utilise/array'
-require 'utilise/fixnum'
 require 'utilise/hash'
 require 'utilise/hashie'
+require 'utilise/integer'
 require 'utilise/object'
 require 'utilise/string'
 require 'utilise/symbol'

lib/utilise/augment/hash.rb

@@ -19,6 +19,16 @@ def space_keys
         utilise_deep_transform_keys(self) { |key| key.space }
       end
 
+      # Transforms all keys to a string
+      def string_keys
+        utilise_deep_transform_keys(self) { |key| key.to_s }
+      end
+
+      # Transforms all keys to a symbol
+      def symbol_keys
+        utilise_deep_transform_keys(self) { |key| key.to_sym }
+      end
+
       private
 
       # Deep transform keys in object

lib/utilise/version.rb

@@ -1,9 +1,9 @@
 # Utilise
 module Utilise
   # The current gem version
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
   # The version update date
-  DATE = '2015-10-06'.freeze
+  DATE = '2017-02-07'.freeze
   # Debug output message
   MSG = 'Version %s %s (running on %s-%s)'.freeze
 

spec/utilise/hash_spec.rb

@@ -198,4 +198,90 @@
       expect(old_hash['red key'][:blueKey]).to eql('testing 123')
     end
   end
+
+  describe '#string_keys' do
+    let(:hash) { { oneKey: 'aString', two_key: ['a_string'], redKey: { blue_key: 'testing 123' } } }
+
+    it 'converts all keys to a string' do
+      new_hash = hash.string_keys
+      expect(new_hash.key?('oneKey')).to be_truthy
+      expect(new_hash.key?('two_key')).to be_truthy
+      expect(new_hash.key?('redKey')).to be_truthy
+      expect(new_hash['redKey'].key?('blue_key')).to be_truthy
+    end
+
+    it 'does not keep the old keys' do
+      new_hash = hash.string_keys
+      expect(new_hash.key?(:oneKey)).to be_falsey
+      expect(new_hash.key?(:two_key)).to be_falsey
+      expect(new_hash.key?(:redKey)).to be_falsey
+      expect(new_hash['redKey'].key?(:blue_key)).to be_falsey
+    end
+
+    it 'does not convert the values' do
+      new_hash = hash.string_keys
+
+      expect(new_hash['oneKey']).to eql(hash[:oneKey])
+      expect(new_hash['two_key']).to eql(hash[:two_key])
+      expect(new_hash['redKey']['blue_key']).to eql(hash[:redKey][:blue_key])
+    end
+
+    it 'does not modify the original hash' do
+      new_hash = hash
+      new_hash.string_keys
+
+      expect(new_hash.key?(:oneKey)).to be_truthy
+      expect(new_hash.key?(:two_key)).to be_truthy
+      expect(new_hash.key?(:redKey)).to be_truthy
+      expect(new_hash[:redKey].key?(:blue_key)).to be_truthy
+
+      expect(new_hash[:oneKey]).to be(hash[:oneKey])
+      expect(new_hash[:two_key]).to be(hash[:two_key])
+      expect(new_hash[:redKey]).to be(hash[:redKey])
+      expect(new_hash[:redKey][:blue_key]).to be(hash[:redKey][:blue_key])
+    end
+  end
+
+  describe '#symbol_keys' do
+    let(:hash) { { 'oneKey' => 'aString', 'two_key' => ['a_string'], 'redKey' => { 'blue_key' => 'testing 123' } } }
+
+    it 'converts all keys to a symbol' do
+      new_hash = hash.symbol_keys
+      expect(new_hash.key?(:oneKey)).to be_truthy
+      expect(new_hash.key?(:two_key)).to be_truthy
+      expect(new_hash.key?(:redKey)).to be_truthy
+      expect(new_hash[:redKey].key?(:blue_key)).to be_truthy
+    end
+
+    it 'does not keep the old keys' do
+      new_hash = hash.symbol_keys
+      expect(new_hash.key?('oneKey')).to be_falsey
+      expect(new_hash.key?('two_key')).to be_falsey
+      expect(new_hash.key?('redKey')).to be_falsey
+      expect(new_hash[:redKey].key?('blue_key')).to be_falsey
+    end
+
+    it 'does not convert the values' do
+      new_hash = hash.symbol_keys
+
+      expect(new_hash[:oneKey]).to eql(hash['oneKey'])
+      expect(new_hash[:two_key]).to eql(hash['two_key'])
+      expect(new_hash[:redKey][:blue_key]).to eql(hash['redKey']['blue_key'])
+    end
+
+    it 'does not modify the original hash' do
+      new_hash = hash
+      new_hash.symbol_keys
+
+      expect(new_hash.key?('oneKey')).to be_truthy
+      expect(new_hash.key?('two_key')).to be_truthy
+      expect(new_hash.key?('redKey')).to be_truthy
+      expect(new_hash['redKey'].key?('blue_key')).to be_truthy
+
+      expect(new_hash['oneKey']).to be(hash['oneKey'])
+      expect(new_hash['two_key']).to be(hash['two_key'])
+      expect(new_hash['redKey']).to be(hash['redKey'])
+      expect(new_hash['redKey']['blue_key']).to be(hash['redKey']['blue_key'])
+    end
+  end
 end

spec/utilise/time_spec.rb

@@ -7,7 +7,7 @@
     end
 
     it 'returns a string number' do
-      expect(Time.unique).to match(/\d+/)
+      expect(Time.unique.to_i).to be_a Integer
     end
 
     it 'returns a number from time to 3 decimal places' do

spec/utilise/version_spec.rb

@@ -3,7 +3,7 @@
 describe Utilise do
   describe '.version' do
     it 'should return the current gem version' do
-      expect(Utilise.version).to eq('1.0.0')
+      expect(Utilise.version).to eq('1.1.0')
     end
 
     it 'should return the current gem version with debug information' do