rename_keys 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9117311c21ce4c776a0fdec2df857485bdd684e4
-  data.tar.gz: 10f51c550b80cce77bb839c817a25c1bae9b6fb1
+  metadata.gz: b3688359ea366f3b3463e1ee01fddf0841b54da4
+  data.tar.gz: 4b62214ca40e1d2eeeaf8c225b3038c9b8fc7ed5
 SHA512:
-  metadata.gz: 7110da626223d7f8dc36ba6a229b920d0e9a2e0dc1e810436048d1efe3a6076266132a5d64e4d3ee3eb42d7f95c2e739e9980d4a00e9f1e7bb2b1118cd1b2a4f
-  data.tar.gz: 3bd2f909738b38cb39b2dd956035b4c9d7de3c0f6be8ee95e0002909355cb62cc195f10aed7147253f1bb9e7e676e928d1dc033460555ad7dcafa518c3045e1c
+  metadata.gz: c1dad9fee4c88e403ef89260d1e662dbae192250acd9e5a7355e0f2c3cff6a020999cc3765ad54543325f175e57265c4f8351e0c1ebb6819a4fc274fbff80fde
+  data.tar.gz: 26399405910f0edf7aed6c88ba35958a73ce6f9623eaf60ff6afecdb2bf048b53f8f529cb412814725bfcd44f112cb35a88cc62efdb63559bb8d0104d593f6df

data/README.md

@@ -24,20 +24,40 @@ Or install it yourself as:
 # Simple renaming of keys
 h = { "first" => "first value" }
 
-h.rename_keys({ "first" => "a" })
+renamed_hash = h.rename_keys({ "first" => "a" })
 
-puts h #=> { "a" => "first value" }
+puts renamed_hash #=> { "a" => "first value" }
 ```
 
 ```
 # Deep nesting of keys
 h = { "first" => { "second" => { "third" => "third value" } } }
 
-h.rename_keys({ "third" => "charlie" })
+renamed_hash = h.rename_keys({ "third" => "charlie" })
 
-puts h #=> { "first" => { "second" => { "charlie" => "third value" } } }
+puts renamed_hash #=> { "first" => { "second" => { "charlie" => "third value" } } }
 ```
 
+```
+# Iterating over array of hashes (does not alter non-hash elements)
+hashes = [
+  { "a" => "first" },
+  { "b" => "second" },
+  { "c" => "third" },
+  4
+]
+
+renamed_hashes = hashes.rename_keys({ "a" => "alpha", "b" => "bravo", "c" => "charlie" })
+
+puts renamed_hashes # => [{ "alpha" => "first" }, { "bravo" => "second" }, { "charlie" => "third" }, 4]
+```
+
+## Performance
+
+The use case I created this gem for was retrieving small amounts of JSON from external APIs (small as in a JSON object with maybe 50-100 keys).
+I do not know how performant this gem would be if you had, say, 100+ JSON objects, each with 50-100 keys, and you were changing 20+ keys at once.
+If I find that performance is a big necessity, I may optimize it at that point and start doing some benchmarking.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/core_extensions/array/iterate_over_hashes.rb

@@ -0,0 +1,24 @@
+require "rename_keys/version"
+
+module CoreExtensions
+  module Array
+    module IterateOverHashes
+      def rename_keys(mapping)
+        result = []
+
+        self.each_with_index do |element, index|
+          if element.kind_of?(::Hash)
+            result[index] = element.rename_keys(mapping)
+          else
+            result[index] = element
+          end
+        end
+
+        result
+      end
+    end
+  end
+end
+
+# Actually monkey-patch the Ruby core Array class
+Array.include ::CoreExtensions::Array::IterateOverHashes

data/lib/rename_keys/version.rb

@@ -1,3 +1,3 @@
 module RenameKeys
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rename_keys
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Daniel LeGrand
@@ -56,6 +56,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/core_extensions/array/iterate_over_hashes.rb
 - lib/core_extensions/hash/keys.rb
 - lib/rename_keys/version.rb
 - rename_keys.gemspec