right_support 2.8.28 → 2.8.29

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d244fe9a56d4712f420a8e3aef63841427de950c
+  data.tar.gz: 9ea699ca1dd5bc23bb23c0085ed03d3ea1a23968
+SHA512:
+  metadata.gz: 2fa6ca5181f6040eae44dec1fdb8bbb2980c9faa39b80de0cd2b87057078b4c6b1c0df3a54a1e0c6627d86ca0726a5023eec91a7ee697834666a12bd82dc36c2
+  data.tar.gz: d636fe0c0f2eec50ce62c1a91131631db306ce67777b2b2af825be726e19413439e42c87255a32fa26b7b2a54165e881098de0cbb73f3461025d105de1ffef2c

data/VERSION

@@ -1 +1 @@
-2.8.28
+2.8.29

data/lib/right_support/data/hash_tools.rb

@@ -25,7 +25,13 @@ module RightSupport::Data
   # various tools for manipulating hash-like classes.
   module HashTools
 
-    HAS_JSON = require_succeeds?('json')
+    # require checks
+    HAS_EXTLIB = require_succeeds?('extlib')
+    HAS_JSON   = require_succeeds?('json')
+
+    # exceptions
+    class NoExtlib < ::StandardError; end
+    class NoJson < ::StandardError; end
 
     # Determines if given object is hashable (i.e. object responds to hash methods).
     #
@@ -112,6 +118,8 @@ module RightSupport::Data
 
     # Creates a deep clone of the given hash.
     #
+    # @deprecated in favor of more robust deep_clone2
+    #
     # note that not all objects are clonable in Ruby even though all respond to clone
     # (which is completely counter-intuitive and contrary to all other managed languages).
     # Java, for example, has the built-in Cloneable marker interface which we will simulate
@@ -135,6 +143,9 @@ module RightSupport::Data
       result = original.clone
       result.each do |k, v|
         if hashable?(v)
+          # HACK: we should have passed &leaf_callback here but never did before
+          # so it is techincally a bug. we are not going to change it due to not
+          # wanting to break legacy code so use deep_clone2 instead.
           result[k] = deep_clone(v)
         elsif leaf_callback
           result[k] = leaf_callback.call(v)
@@ -147,6 +158,75 @@ module RightSupport::Data
       result
     end
 
+    # Deeply duplicates (clones) a hashable object containing other hashes or
+    # arrays of hashes but passing other types through.
+    #
+    # Optionally changes the target hashable type to 'normalize' to a specific
+    # hashable class (such as Mash).
+    #
+    # Optionally traverses arrays (default) in an attempt to deep-clone any
+    # sub-hashes instead of simply associating them.
+    #
+    # === Parameters
+    # @param [Object] any kind of object
+    # @param [Hash] options
+    # @option [Class] :class for cloned hashables or nil for same as source
+    #
+    # === Block
+    # @yieldparam [Object] value of leaf
+    # @yieldreturn [Object] cloned value of leaf or original value
+    #
+    # === Return
+    # @return [Object] depends on input type
+    def self.deep_clone2(any, options = {}, &leaf_callback)
+      if hashable?(any)
+        # clone to a new instance of hashable class with deep cloning.
+        any.inject((options[:class] || any.class).new) do |m, (k, v)|
+          m[k] = deep_clone2(v, options, &leaf_callback)
+          m
+        end
+      elsif any.kind_of?(::Array)
+        # traverse arrays
+        any.map { |e| deep_clone2(e, options, &leaf_callback) }
+      elsif leaf_callback
+        leaf_callback.call(any)
+      elsif any.respond_to?(:duplicable?)
+        # see #deep_clone for remarks
+        any.duplicable? ? any.clone : any
+      else
+        any  # whatever
+      end
+    end
+
+    # Deeply mashes and duplicates (clones) a hashable using deep_clone2 after
+    # checking that extlib is available.
+    #
+    # The advantage of Mash over Hash is, of course, to be able to use either
+    # a String or Symbol as a key for the same value.
+    #
+    # Note that Mash.new(my_mash) will convert child hashes to mashes but not
+    # with the guarantee of cloning and detaching the deep mash. In other words.
+    # if any part of the hash is already a mash then it is not cloned by
+    # invoking Mash.new()
+    #
+    # === Parameters
+    # @param [Object] any kind of object
+    #
+    # === Block
+    # @yieldparam [Object] value of leaf
+    # @yieldreturn [Object] cloned value of leaf or original value
+    #
+    # === Return
+    # @return [Object] depends on input type
+    def self.deep_mash(any, &leaf_callback)
+      if HAS_EXTLIB
+        options = { :class => ::Mash }
+        deep_clone2(any, options, &leaf_callback)
+      else
+        raise NoExtlib, "extlib is unavailable"
+      end
+    end
+
     # Performs a deep merge (but not a deep clone) of one hash into another.
     #
     # === Parameters
@@ -327,8 +407,6 @@ module RightSupport::Data
       end
     end
 
-    class NoJson < Exception; end
-
     # Generates JSON from the given hash (of hashes) that is sorted by key at
     # all levels. Does not handle case of hash to array of hashes, etc.
     #

data/right_support.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: right_support 2.8.28 ruby lib
+# stub: right_support 2.8.29 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "right_support"
-  s.version = "2.8.28"
+  s.version = "2.8.29"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Tony Spataro", "Sergey Sergyenko", "Ryan Williamson", "Lee Kirchhoff", "Alexey Karpik", "Scott Messier"]
-  s.date = "2014-08-15"
+  s.date = "2014-08-26"
   s.description = "A toolkit of useful, reusable foundation code created by RightScale."
   s.email = "support@rightscale.com"
   s.extra_rdoc_files = [

data/spec/data/hash_tools_spec.rb

@@ -175,20 +175,75 @@ describe RightSupport::Data::HashTools do
           data[:tree][:branch][:a].duplicable?.should be_true
           data[:tree][:branch][:b].duplicable?.should be_true
         end
-        deep_check_object_id(actual, data)
+        deep_check_object_id(data, actual)
       end
     end
 
     it 'should deep clone leaves using callback when given' do
-      initial = { :x => 1, :y => { :a => [1, 2, 3], :b => [4, 5, 6] } }
-      actual = subject.deep_clone(initial) { |value| value.kind_of?(Array) ? value.clone : value }
+      initial = { :x => 'a', :y => { :a => ['b', 'c'], :b => ['d', ['e', 'f']] } }
+      actual = subject.deep_clone(initial) { |value| value.clone }
       actual.should == initial
       deep_check_object_id(actual, initial) do |a, b|
-        if a.kind_of?(Array)
-          a.object_id.should_not == b.object_id
-        else
-          a.object_id.should == b.object_id
+        a.object_id.should_not == b.object_id
+      end
+    end
+  end
+
+  # also tests deep_clone2
+  context '#deep_mash' do
+    def deep_check_object_id(a, b, &leaf_callback)
+      a.object_id.should_not == b.object_id
+      if subject.hashable?(a)
+        b.class.should == ::Mash
+        a.each do |k, v|
+          other = b[k]
+          if subject.hashable?(v)
+            deep_check_object_id(v, other)
+          elsif v.kind_of?(::Array)
+            v.object_id.should_not == other.object_id
+            other.class.should == ::Array
+            v.size.should == other.size
+            v.each_with_index do |e, idx|
+              deep_check_object_id(e, other[idx])
+            end
+          elsif leaf_callback
+            leaf_callback.call(v, other)
+          elsif v.respond_to?(:duplicable?) && v.duplicable?
+            v.object_id.should_not == other.object_id
+          else
+            v.object_id.should == other.object_id
+          end
+        end
+      end
+    end
+
+    {
+      :empty => {},
+      :shallow => { :x => 1, :y => 2 },
+      :deep => { :x => 1, :y => { :a => 'A' }, :z => { :b => 'B', :c => { :foo => :bar } } },
+      :arrayed => [ { :x => 1 }, { :y => { :a => 'A' } }, :z => { :b => 'B', :c => { :foo => :bar } } ],
+      :duplicable => {
+        :tree => {
+          :branch => {
+            :a => ::RightSupport::Data::HashToolsSpec::DuplicableValue.new(1),
+            :b => ::RightSupport::Data::HashToolsSpec::DuplicableValue.new('hi there') } } }
+    }.each do |kind, data|
+      it "should deep mash values in #{kind} hashes" do
+        actual = subject.deep_mash(data)
+        if :duplicable == kind
+          # verify that leaves are duplicable
+          data[:tree][:branch][:a].duplicable?.should be_true
+          data[:tree][:branch][:b].duplicable?.should be_true
         end
+        deep_check_object_id(data, actual)
+      end
+    end
+
+    it 'should deep clone leaves using callback when given' do
+      initial = { :x => 'a', :y => { :a => ['b', 'c'], :b => ['d', ['e', 'f']] } }
+      actual = subject.deep_mash(initial) { |value| value.clone }
+      deep_check_object_id(initial, actual) do |a, b|
+        a.object_id.should_not == b.object_id
       end
     end
   end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_support
 version: !ruby/object:Gem::Version
-  version: 2.8.28
-  prerelease: 
+  version: 2.8.29
 platform: ruby
 authors:
 - Tony Spataro
@@ -14,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-15 00:00:00.000000000 Z
+date: 2014-09-15 00:00:00.000000000 Z
 dependencies: []
 description: A toolkit of useful, reusable foundation code created by RightScale.
 email: support@rightscale.com
@@ -24,7 +23,7 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files:
-- .rspec
+- ".rspec"
 - CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
@@ -146,29 +145,25 @@ files:
 homepage: https://github.com/rightscale/right_support
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1570969451733484161
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.26
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Reusable foundation code.
 test_files: []