black_hole_struct 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1029935145064902197c9e3871ef53e7349a105e
-  data.tar.gz: ed7989a51275c4ded5c4d13a257e4e974dc4f1a7
+  metadata.gz: 0e6b867238881473e5302a2d846b0f761ede511e
+  data.tar.gz: b28833bb76c5b7fe5e51a21a94f515cba7eb99e9
 SHA512:
-  metadata.gz: cc6c4efeebdd672a4bb8c7f390cb0dd10e3a1a44ebd37c9586463a47f3dccda031d07465bb059c90983a675ab16342f67f2f42bdbac6f97ffa1178bcf7ef4333
-  data.tar.gz: 832aea4153ba5675ea78d1a252ab464085574c61dbbeb799dd0fd8c7c8969a32dd9be62a513740b06286212f9d0a01fb2628074364169904548c0a5e4e77bbb2
+  metadata.gz: 30c0f323a16358dedfbae9eb464a86db214bf39ae7664e89b64f15f5805ff8e163746c68f9830ec764f4ae79564f98eb0440486740939ebba3d4e0a8f425d12b
+  data.tar.gz: 5ce7b1f60843969f3af2842f66c49162e92e3fad1b8201426ac1f8cd9b71eb0dd23d3cf504ebced1da41e2ad01e8868a4aa96b01c5c8f72f4440fc9f647d12dc

data/README.md

@@ -1,7 +1,12 @@
+[![CircleCI](https://circleci.com/gh/mickey/black-hole-struct/tree/master.svg?style=svg)](https://circleci.com/gh/mickey/black-hole-struct/tree/master)
+
 # BlackHoleStruct
 
-**BlackHoleStruct** is a data structure similar to an `OpenStruct`, that allows
-infinite chaining of attributes or [autovivification](https://en.wikipedia.org/wiki/Autovivification).  
+**BlackHoleStruct** is a data structure similar to an `OpenStruct` that allows:
+- infinite chaining of attributes or [autovivification](https://en.wikipedia.org/wiki/Autovivification)
+- deep merging of BlackHoleStruct/Hash
+
+![](https://media.giphy.com/media/kxAX99ncvbPk4/giphy.gif)
 
 ## Installation
 
@@ -30,8 +35,42 @@ config.dashboard.time.to = "now"
 puts config.dashboard.theme      # "white"
 puts config.dashboard.time       # #<BlackHoleStruct :from="now-1h" :to="now">
 puts config.dashboard.time.from  # "now-1h"
+
+config[:connection][:host] = "localhost"
+config[:connection][:port] = 3000
+
+puts config.to_h
+# {
+#   connection: {
+#     host: "localhost",
+#     port: 3000
+#   }
+#   dashboard: {
+#     theme: "white",
+#     time: {
+#       from: "now-1h",
+#       to: "now"
+#     }
+#   }
+# }
+
+config = BlackHoleStruct.new(theme: "white", connection: {port: 3000})
+config.deep_merge!(connection: {host: 'localhost'})
+puts config.to_h
+# {
+#   connection: {
+#     host: "localhost",
+#     port: 3000
+#   }
+#   theme: "white"
+# }
+
 ```
 
+## Is it any good
+
+[Yes](https://news.ycombinator.com/item?id=3067434)
+
 ## Advanced usage
 
 Check the [documentation](http://www.rubydoc.info/github/mickey/black-hole-struct/master/BlackHoleStruct).

data/lib/black_hole_struct.rb

@@ -2,7 +2,7 @@
 # infinite chaining of attributes or [autovivification](https://en.wikipedia.org/wiki/Autovivification).
 class BlackHoleStruct
   # Current version
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 
   # BlackHoleStruct can be optionally initialized with a Hash
   # @param [Hash] hash Initialize with a hash
@@ -56,18 +56,49 @@ class BlackHoleStruct
     @table.each_pair
   end
 
-  # Adds the contents of other_hash to hsh.
-  # If no block is specified, entries with duplicate keys are overwritten with the values from other_hash,
-  # otherwise the value of each duplicate key is determined by calling the block with the key,
-  # its value in hsh and its value in other_hash.
+  # Returns a new hash with self and other_hash merged.
+  # @param [Hash] other_hash
+  # @return the final hash
+  def merge(other_hash)
+    self.dup.merge!(other_hash)
+  end
+
+  # Same as merge, but modifies self.
   # @param [Hash] other_hash
   # @return the final hash
   def merge!(other_hash)
     # no deep merge
     @table = self.to_h.merge!(other_hash)
+    self
   end
   alias :update :merge!
 
+  # Returns a new hash with self and other_hash merged recursively.
+  # It only merges Hash recursively.
+  # @param [Hash] other_hash
+  # @return the final hash
+  def deep_merge(other_hash)
+    self.dup.deep_merge!(other_hash)
+  end
+
+  # Same as deep_merge, but modifies self.
+  # @param [Hash] other_hash
+  # @return the final hash
+  def deep_merge!(other_hash)
+    other_hash.each_pair do |current_key, other_value|
+      this_value = @table[current_key.to_sym]
+
+      if (this_value.is_a?(Hash) || this_value.is_a?(self.class)) &&
+        (other_value.is_a?(Hash) || other_value.is_a?(self.class))
+        @table[current_key.to_sym] = this_value.deep_merge(other_value)
+      else
+        @table[current_key.to_sym] = other_value
+      end
+    end
+
+    self
+  end
+
   # Converts self to the hash
   # @return [Hash]
   def to_h
@@ -89,6 +120,11 @@ class BlackHoleStruct
 
   private
 
+  def initialize_copy(other)
+    super
+    @table = @table.clone
+  end
+
   def method_missing(name, *args)
     if @table[name.to_sym]
       @table[name.to_sym]

data/test/black_hole_struct_test.rb

@@ -89,12 +89,44 @@ class BlackHoleStructTest < Minitest::Test
     }
   end
 
-  def test_merge
+  def test_merge!
     @subject.theme = "white"
     @subject.merge!(size: 5)
 
+    assert_equal @subject.to_h, { theme: "white", size: 5 }
+  end
+
+  def test_merge
+    @subject.theme = "white"
+    merged = @subject.merge(size: 5)
+
+    assert_equal merged.to_h, { theme: "white", size: 5 }
+    assert_equal @subject.to_h, { theme: "white" }
+  end
+
+  def test_deep_merge!
+    @subject.theme = "white"
+    @subject.connection.port = 3000
+    @subject.deep_merge!(connection: { host: '127.0.0.1' })
+
+    assert_equal @subject.to_h, {
+      theme: "white",
+      connection: { port: 3000, host: '127.0.0.1' }
+    }
+  end
+
+  def test_deep_merge
+    @subject.theme = "white"
+    @subject.connection.port = 3000
+    merged = @subject.deep_merge(connection: { host: '127.0.0.1' })
+
+    assert_equal merged.to_h, {
+      theme: "white",
+      connection: { port: 3000, host: '127.0.0.1' }
+    }
     assert_equal @subject.to_h, {
-      theme: "white", size: 5
+      theme: "white",
+      connection: { port: 3000 }
     }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: black_hole_struct
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Michael Bensoussan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-01 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest