right_support 2.8.30 → 2.8.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53cf993f219e3cdd938198bbef08b75918018725
-  data.tar.gz: 817b7327c955cc5e97fc8ba0c93907ec81d32088
+  metadata.gz: 54dcd26e6d8094ac8b3f8ad42dae62aaf9287a7c
+  data.tar.gz: aa1a58306c4222a41daa45cc30626723065615a1
 SHA512:
-  metadata.gz: bde0080e629764e6d4dddaaeb96fb8ca4f3179f4a977f426832ad1f509859bb9fda26c81b159bb3008956ee57516e3d5ded87802d7e96dee25aea923669fb7a4
-  data.tar.gz: f6bc80c8f3a9a63da136ea59d25688a0240a6df5323f4859047fd72eb2f03912ddab43cb7c06ca7e073d93b932e11cab5c817e0d386b23ba490abd057046c1fa
+  metadata.gz: 97f3b74d83992e636fbc6d09926503db59a427f4907ea1679754dd916be7fee3764d88202be9aead0f484c878efe69d4bf77bfb0d580596a5009e74ad5d76e47
+  data.tar.gz: 6192c632633ef97f57ac37fc8159fe40b22a1eebe269608efb560615e138e69118c8b81702f853bfb7042819777225ffda197dfe8b93de21320e2789075532b4

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2012 RightScale, Inc.
+Copyright (c) 2009-2014 RightScale, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -18,3 +18,59 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+---
+
+Some portions of lib/right_support/data/mash.rb and spec/data/mash_spec.rb
+are modified versions of the extlib library, which is licensed under the
+MIT license. That license, plus the license of the code from which extlib
+was derived, is included below:
+
+Copyright (c) 2010 Dan Kubb
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+---
+
+Some portions of blank.rb and mash.rb are verbatim copies of software
+licensed under the MIT license. That license is included below:
+
+Copyright (c) 2005-2008 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/VERSION

@@ -1 +1 @@
-2.8.30
+2.8.31

data/lib/right_support/data.rb

@@ -33,3 +33,4 @@ require 'right_support/data/unknown_type'
 require 'right_support/data/serializer'
 require 'right_support/data/hash_tools'
 require 'right_support/data/uuid'
+require 'right_support/data/mash'

data/lib/right_support/data/hash_tools.rb

@@ -26,11 +26,9 @@ module RightSupport::Data
   module HashTools
 
     # require checks
-    HAS_EXTLIB = require_succeeds?('extlib/mash')
     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).
@@ -219,12 +217,8 @@ module RightSupport::Data
     # === 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
+      options = { :class => RightSupport::Data::Mash }
+      deep_clone2(any, options, &leaf_callback)
     end
 
     # Performs a deep merge (but not a deep clone) of one hash into another.

data/lib/right_support/data/mash.rb

@@ -0,0 +1,161 @@
+module RightSupport::Data
+  # A workalike for extlib's ::Mash, but properly namespaced.
+  class Mash < ::Hash
+
+    # @param constructor<Object>
+    #   The default value for the mash. Defaults to an empty hash.
+    #
+    # @details [Alternatives]
+    #   If constructor is a Hash, a new mash will be created based on the keys of
+    #   the hash and no default value will be set.
+    def initialize(constructor = {})
+      if constructor.is_a?(Hash)
+        super()
+        update(constructor)
+      else
+        super(constructor)
+      end
+    end
+
+    # @param key<Object> The default value for the mash. Defaults to nil.
+    #
+    # @details [Alternatives]
+    #   If key is a Symbol and it is a key in the mash, then the default value will
+    #   be set to the value matching the key.
+    def default(key = nil)
+      if key.is_a?(Symbol) && include?(key = key.to_s)
+        self[key]
+      else
+        super
+      end
+    end
+
+    alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
+    alias_method :regular_update, :update unless method_defined?(:regular_update)
+
+    # @param key<Object> The key to set.
+    # @param value<Object>
+    #   The value to set the key to.
+    #
+    # @see Mash#convert_key
+    # @see Mash#convert_value
+    def []=(key, value)
+      regular_writer(convert_key(key), convert_value(value))
+    end
+
+    # @param other_hash<Hash>
+    #   A hash to update values in the mash with. The keys and the values will be
+    #   converted to Mash format.
+    #
+    # @return [Mash] The updated mash.
+    def update(other_hash)
+      other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
+      self
+    end
+
+    alias_method :merge!, :update
+
+    # @param key<Object> The key to check for. This will be run through convert_key.
+    #
+    # @return [Boolean] True if the key exists in the mash.
+    def key?(key)
+      super(convert_key(key))
+    end
+
+    # def include? def has_key? def member?
+    alias_method :include?, :key?
+    alias_method :has_key?, :key?
+    alias_method :member?, :key?
+
+    # @param key<Object> The key to fetch. This will be run through convert_key.
+    # @param *extras<Array> Default value.
+    #
+    # @return [Object] The value at key or the default value.
+    def fetch(key, *extras)
+      super(convert_key(key), *extras)
+    end
+
+    # @param *indices<Array>
+    #   The keys to retrieve values for. These will be run through +convert_key+.
+    #
+    # @return [Array] The values at each of the provided keys
+    def values_at(*indices)
+      indices.collect {|key| self[convert_key(key)]}
+    end
+
+    # @param hash<Hash> The hash to merge with the mash.
+    #
+    # @return [Mash] A new mash with the hash values merged in.
+    def merge(hash)
+      self.dup.update(hash)
+    end
+
+    # @param key<Object>
+    #   The key to delete from the mash.\
+    def delete(key)
+      super(convert_key(key))
+    end
+
+    # @param *rejected<Array[(String, Symbol)] The mash keys to exclude.
+    #
+    # @return [Mash] A new mash without the selected keys.
+    #
+    # @example
+    #   { :one => 1, :two => 2, :three => 3 }.except(:one)
+    #     #=> { "two" => 2, "three" => 3 }
+    def except(*keys)
+      keys = keys.map { |k| convert_key(k) }
+      hash = self.dup
+      keys.each {|k| hash.delete(k) }
+      hash
+    end
+
+    # Used to provide the same interface as Hash.
+    #
+    # @return [Mash] This mash unchanged.
+    def stringify_keys!; self end
+
+    # @return [Hash] The mash as a Hash with symbolized keys.
+    def symbolize_keys
+      h = Hash.new(default)
+      each { |key, val| h[key.to_sym] = val }
+      h
+    end
+
+    # @return [Hash] The mash as a Hash with string keys.
+    def to_hash
+      Hash.new(default).merge(self)
+    end
+
+    protected
+    # @param key<Object> The key to convert.
+    #
+    # @param [Object]
+    #   The converted key. If the key was a symbol, it will be converted to a
+    #   string.
+    #
+    # @api private
+    def convert_key(key)
+      key.kind_of?(Symbol) ? key.to_s : key
+    end
+
+    # @param value<Object> The value to convert.
+    #
+    # @return [Object]
+    #   The converted value. A Hash or an Array of hashes, will be converted to
+    #   their Mash equivalents.
+    #
+    # @api private
+    def convert_value(value)
+      if value.class == Hash
+        hash = Mash.new(value)
+        hash.default = value.default
+        hash
+      elsif value.is_a?(Array)
+        value.collect { |e| convert_value(e) }
+      else
+        value
+      end
+    end
+  end
+end

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.30 ruby lib
+# stub: right_support 2.8.31 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "right_support"
-  s.version = "2.8.30"
+  s.version = "2.8.31"
 
   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-09-24"
+  s.date = "2014-09-25"
   s.description = "A toolkit of useful, reusable foundation code created by RightScale."
   s.email = "support@rightscale.com"
   s.extra_rdoc_files = [
@@ -53,6 +53,7 @@ Gem::Specification.new do |s|
     "lib/right_support/crypto/signed_hash.rb",
     "lib/right_support/data.rb",
     "lib/right_support/data/hash_tools.rb",
+    "lib/right_support/data/mash.rb",
     "lib/right_support/data/serializer.rb",
     "lib/right_support/data/unknown_type.rb",
     "lib/right_support/data/uuid.rb",
@@ -100,6 +101,7 @@ Gem::Specification.new do |s|
     "spec/config/feature_set_spec.rb",
     "spec/crypto/signed_hash_spec.rb",
     "spec/data/hash_tools_spec.rb",
+    "spec/data/mash_spec.rb",
     "spec/data/uuid_spec.rb",
     "spec/db/cassandra_model_part1_spec.rb",
     "spec/db/cassandra_model_part2_spec.rb",

data/spec/data/hash_tools_spec.rb

@@ -194,7 +194,7 @@ describe RightSupport::Data::HashTools 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
+        b.class.should == RightSupport::Data::Mash
         a.each do |k, v|
           other = b[k]
           if subject.hashable?(v)

data/spec/data/mash_spec.rb

@@ -0,0 +1,313 @@
+require 'spec_helper'
+
+class AwesomeHash < Hash
+end
+
+describe RightSupport::Data::Mash do
+  subject { RightSupport::Data::Mash}
+  
+  before(:each) do
+    @hash = { "mash" => "indifferent", :hash => "different" }
+    @sub  = AwesomeHash.new("mash" => "indifferent", :hash => "different")
+  end
+
+  describe "#initialize" do
+    it 'converts all keys into strings when param is a Hash' do
+      mash = subject.new(@hash)
+
+      mash.keys.any? { |key| key.is_a?(Symbol) }.should be(false)
+    end
+
+    it 'converts all pure Hash values into Mashes if param is a Hash' do
+      mash = subject.new :hash => @hash
+
+      mash["hash"].should be_an_instance_of(subject)
+      # sanity check
+      mash["hash"]["hash"].should == "different"
+    end
+
+    it 'doesn not convert Hash subclass values into Mashes' do
+      mash = subject.new :sub => @sub
+      mash["sub"].should be_an_instance_of(AwesomeHash)
+    end
+
+    it 'converts all value items if value is an Array' do
+      mash = subject.new :arry => { :hash => [@hash] }
+
+      mash["arry"].should be_an_instance_of(subject)
+      # sanity check
+      mash["arry"]["hash"].first["hash"].should == "different"
+
+    end
+
+    it 'delegates to superclass constructor if param is not a Hash' do
+      mash = subject.new("dash berlin")
+
+      mash["unexisting key"].should == "dash berlin"
+    end
+  end # describe "#initialize"
+
+
+
+  describe "#update" do
+    it 'converts all keys into strings when param is a Hash' do
+      mash = subject.new(@hash)
+      mash.update("starry" => "night")
+
+      mash.keys.any? { |key| key.is_a?(Symbol) }.should be(false)
+    end
+
+    it 'converts all Hash values into Mashes if param is a Hash' do
+      mash = subject.new :hash => @hash
+      mash.update(:hash => { :hash => "is buggy in Ruby 1.8.6" })
+
+      mash["hash"].should be_an_instance_of(subject)
+    end
+  end # describe "#update"
+
+
+
+  describe "#[]=" do
+    it 'converts key into string' do
+      mash = subject.new(@hash)
+      mash[:hash] = { "starry" => "night" }
+
+      mash.keys.any? { |key| key.is_a?(Symbol) }.should be(false)
+    end
+
+    it 'converts all Hash value into subject' do
+      mash = subject.new :hash => @hash
+      mash[:hash] = { :hash => "is buggy in Ruby 1.8.6" }
+
+      mash["hash"].should be_an_instance_of(subject)
+    end
+  end # describe "#[]="
+
+
+
+  describe "#key?" do
+    before(:each) do
+      @mash = subject.new(@hash)
+    end
+
+    it 'converts key before lookup' do
+      @mash.key?("mash").should be(true)
+      @mash.key?(:mash).should be(true)
+
+      @mash.key?("hash").should be(true)
+      @mash.key?(:hash).should be(true)
+
+      @mash.key?(:rainclouds).should be(false)
+      @mash.key?("rainclouds").should be(false)
+    end
+
+    it 'is aliased as include?' do
+      @mash.include?("mash").should be(true)
+      @mash.include?(:mash).should be(true)
+
+      @mash.include?("hash").should be(true)
+      @mash.include?(:hash).should be(true)
+
+      @mash.include?(:rainclouds).should be(false)
+      @mash.include?("rainclouds").should be(false)
+    end
+
+    it 'is aliased as member?' do
+      @mash.member?("mash").should be(true)
+      @mash.member?(:mash).should be(true)
+
+      @mash.member?("hash").should be(true)
+      @mash.member?(:hash).should be(true)
+
+      @mash.member?(:rainclouds).should be(false)
+      @mash.member?("rainclouds").should be(false)
+    end
+  end # describe "#key?"
+
+
+  describe "#dup" do
+    it 'returns instance of subject' do
+      subject.new(@hash).dup.should be_an_instance_of(subject)
+    end
+
+    it 'preserves keys' do
+      mash = subject.new(@hash)
+      dup  = mash.dup
+
+      mash.keys.sort.should == dup.keys.sort
+    end
+
+    it 'preserves value' do
+      mash = subject.new(@hash)
+      dup  = mash.dup
+
+      mash.values.sort.should == dup.values.sort
+    end
+  end
+
+
+
+  describe "#to_hash" do
+    it 'returns instance of subject' do
+      subject.new(@hash).to_hash.should be_an_instance_of(Hash)
+    end
+
+    it 'preserves keys' do
+      mash = subject.new(@hash)
+      converted  = mash.to_hash
+
+      mash.keys.sort.should == converted.keys.sort
+    end
+
+    it 'preserves value' do
+      mash = subject.new(@hash)
+      converted = mash.to_hash
+
+      mash.values.sort.should == converted.values.sort
+    end
+  end
+
+
+
+  describe "#symbolize_keys" do
+    it 'returns instance of subject' do
+      subject.new(@hash).symbolize_keys.should be_an_instance_of(Hash)
+    end
+
+    it 'converts keys to symbols' do
+      mash = subject.new(@hash)
+      converted  = mash.symbolize_keys
+
+      converted_keys = converted.keys.sort{|k1, k2| k1.to_s <=> k2.to_s}
+      orig_keys = mash.keys.map{|k| k.to_sym}.sort{|i1, i2| i1.to_s <=> i2.to_s}
+
+      converted_keys.should == orig_keys
+    end
+
+    it 'preserves value' do
+      mash = subject.new(@hash)
+      converted = mash.symbolize_keys
+
+      mash.values.sort.should == converted.values.sort
+    end
+  end
+
+
+
+  describe "#delete" do
+    it 'converts Symbol key into String before deleting' do
+      mash = subject.new(@hash)
+
+      mash.delete(:hash)
+      mash.key?("hash").should be(false)
+    end
+
+    it 'works with String keys as well' do
+      mash = subject.new(@hash)
+
+      mash.delete("mash")
+      mash.key?("mash").should be(false)
+    end
+  end
+
+
+
+  describe "#except" do
+    it "converts Symbol key into String before calling super" do
+      mash = subject.new(@hash)
+
+      hashless_mash = mash.except(:hash)
+      hashless_mash.key?("hash").should be(false)
+    end
+
+    it "works with String keys as well" do
+      mash = subject.new(@hash)
+
+      mashless_mash = mash.except("mash")
+      mashless_mash.key?("mash").should be(false)
+    end
+
+    it "works with multiple keys" do
+      mash = subject.new(@hash)
+
+      mashless = mash.except("hash", :mash)
+      mashless.key?(:hash).should be(false)
+      mashless.key?("mash").should be(false)
+    end
+
+    it "should return a mash" do
+      mash = subject.new(@hash)
+
+      hashless_mash = mash.except(:hash)
+      hashless_mash.class.should be(subject)
+    end
+  end
+
+
+
+  describe "#merge" do
+    before(:each) do
+      @mash = subject.new(@hash).merge(:no => "in between")
+    end
+
+    it 'returns instance of subject' do
+      @mash.should be_an_instance_of(subject)
+    end
+
+    it 'merges in give Hash' do
+      @mash["no"].should == "in between"
+    end
+  end
+
+
+
+  describe "#fetch" do
+    before(:each) do
+      @mash = subject.new(@hash).merge(:no => "in between")
+    end
+
+    it 'converts key before fetching' do
+      @mash.fetch("no").should == "in between"
+    end
+
+    it 'returns alternative value if key lookup fails' do
+      @mash.fetch("flying", "screwdriver").should == "screwdriver"
+    end
+  end
+
+
+  describe "#default" do
+    before(:each) do
+      @mash = subject.new(:yet_another_technical_revolution)
+    end
+
+    it 'returns default value unless key exists in mash' do
+      @mash.default("peak oil is now behind, baby").should == :yet_another_technical_revolution
+    end
+
+    it 'returns existing value if key is Symbol and exists in mash' do
+      @mash.update(:no => "in between")
+      @mash.default(:no).should == "in between"
+    end
+  end
+
+
+  describe "#values_at" do
+    before(:each) do
+      @mash = subject.new(@hash).merge(:no => "in between")
+    end
+
+    it 'is indifferent to whether keys are strings or symbols' do
+      @mash.values_at("hash", :mash, :no).should == ["different", "indifferent", "in between"]
+    end
+  end
+
+
+  describe "#stringify_keys!" do
+    it 'returns the mash itself' do
+      mash = subject.new(@hash)
+
+      mash.stringify_keys!.object_id.should == mash.object_id
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_support
 version: !ruby/object:Gem::Version
-  version: 2.8.30
+  version: 2.8.31
 platform: ruby
 authors:
 - Tony Spataro
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-24 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies: []
 description: A toolkit of useful, reusable foundation code created by RightScale.
 email: support@rightscale.com
@@ -57,6 +57,7 @@ files:
 - lib/right_support/crypto/signed_hash.rb
 - lib/right_support/data.rb
 - lib/right_support/data/hash_tools.rb
+- lib/right_support/data/mash.rb
 - lib/right_support/data/serializer.rb
 - lib/right_support/data/unknown_type.rb
 - lib/right_support/data/uuid.rb
@@ -104,6 +105,7 @@ files:
 - spec/config/feature_set_spec.rb
 - spec/crypto/signed_hash_spec.rb
 - spec/data/hash_tools_spec.rb
+- spec/data/mash_spec.rb
 - spec/data/uuid_spec.rb
 - spec/db/cassandra_model_part1_spec.rb
 - spec/db/cassandra_model_part2_spec.rb