hashie 3.5.4 → 3.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b244f4fdc55d9650174134efecbb99d32e75ef14
-  data.tar.gz: 5a00da5d9da33a9a7bdc3f821d16e83dfca65ced
+  metadata.gz: ec77fc445035152bbc8ff4d4ce152250d2cbe448
+  data.tar.gz: 5ce003a19f12e4f3a058713ef02fbe1e179b6dcc
 SHA512:
-  metadata.gz: f948ef11d034b29d9b6a6d9473be7528ba2e3b2e79e9a164fd622194ed39ab29a7b6d37ea1a4f4eeb0232a28fb3ff8d6b19cba3b059a13b33e5894180d76c7c7
-  data.tar.gz: e3ac5f5715323c230b2beedd38a4e47a9a2d199f17a4535072d75c645364ac14b2b4f95e4985de39db270b17f10b92989266eb5d4bb2c4a834a386a7807a04dd
+  metadata.gz: f7fd9f5988b7e928f526d0bc739c754d1792af74a2ba93a328775686940d7b769e06c760cb38b9482418e397cffb7a6f4479925769537394c73b489b039f29f6
+  data.tar.gz: d31ba3a374545f33e9c8cbf551f29aa74a27f3caed1af505c72c082bc68c6d8475a790a40721ddb6a5b6fa838a0effa47440661b0f155cf3613cae9ac481bedb

data/CHANGELOG.md

@@ -6,6 +6,18 @@ scheme are considered to be bugs.
 
 [semver]: http://semver.org/spec/v2.0.0.html
 
+## [3.5.5] - 2017-02-24
+
+[3.5.5]: https://github.com/intridea/hashie/compare/v3.5.4...v3.5.5
+
+### Added
+
+* [#326](https://github.com/intridea/hashie/pull/326): Added `Hashie::Extensions::Mash::KeepOriginalKeys` to give Mashes the ability to keep the original structure given to it - [@michaelherold](https://github.com/michaelherold).
+
+### Fixed
+
+* [#415](https://github.com/intridea/hashie/pull/415): Fixed Mash logging keys multiple times which lead to a bad user experience or, in some cases, errors - [@michaelherold](https://github.com/michaelherold).
+
 ## [3.5.4] - 2017-02-22
 
 [3.5.4]: https://github.com/intridea/hashie/compare/v3.5.3...v3.5.4

data/README.md

@@ -20,7 +20,7 @@ $ gem install hashie
 
 ## Upgrading
 
-You're reading the documentation for the stable release of Hashie, 3.5.4. Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
+You're reading the documentation for the stable release of Hashie, 3.5.5. Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
 
 ## Hash Extensions
 
@@ -545,6 +545,25 @@ class Response < Hashie::Mash
 end
 ```
 
+### Mash Extension: KeepOriginalKeys
+
+This extension can be mixed into a Mash to keep the form of any keys passed directly into the Mash. By default, Mash converts keys to strings to give indifferent access. This extension still allows indifferent access, but keeps the form of the keys to eliminate confusion when you're not expecting the keys to change.
+
+```ruby
+class KeepingMash < ::Hashie::Mash
+  include Hashie::Extensions::Mash::KeepOriginalKeys
+end
+
+mash = KeepingMash.new(:symbol_key => :symbol, 'string_key' => 'string')
+mash.to_hash == { :symbol_key => :symbol, 'string_key' => 'string' }  #=> true
+mash.symbol_key  #=> :symbol
+mash[:symbol_key]  #=> :symbol
+mash['symbol_key']  #=> :symbol
+mash.string_key  #=> 'string'
+mash['string_key']  #=> 'string'
+mash[:string_key]  #=> 'string'
+```
+
 ### Mash Extension: SafeAssignment
 
 This extension can be mixed into a Mash to guard the attempted overwriting of methods by property setters. When mixed in, the Mash will raise an `ArgumentError` if you attempt to write a property with the same name as an existing method.

data/lib/hashie.rb

@@ -44,6 +44,7 @@ module Hashie
     end
 
     module Mash
+      autoload :KeepOriginalKeys, 'hashie/extensions/mash/keep_original_keys'
       autoload :SafeAssignment, 'hashie/extensions/mash/safe_assignment'
       autoload :SymbolizeKeys, 'hashie/extensions/mash/symbolize_keys'
     end

data/lib/hashie/extensions/mash/keep_original_keys.rb

@@ -0,0 +1,54 @@
+module Hashie
+  module Extensions
+    module Mash
+      # Overrides the indifferent access of a Mash to keep keys in the
+      # original format given to the Mash.
+      #
+      # @example
+      #   class KeepingMash < Hashie::Mash
+      #     include Hashie::Extensions::Mash::KeepOriginalKeys
+      #   end
+      #
+      #   mash = KeepingMash.new(:symbol_key => :symbol, 'string_key' => 'string')
+      #   mash.to_hash  #=> { :symbol_key => :symbol, 'string_key' => 'string' }
+      #   mash['string_key'] == mash[:string_key]  #=> true
+      #   mash[:symbol_key] == mash['symbol_key']  #=> true
+      module KeepOriginalKeys
+        private
+
+        def self.included(descendant)
+          unless descendant <= Hashie::Mash
+            fail ArgumentError, "#{descendant} is not a kind of Hashie::Mash"
+          end
+        end
+
+        # Converts the key when necessary to access the correct Mash key.
+        #
+        # @param [Object, String, Symbol] key the key to access.
+        # @return [Object] the value assigned to the key.
+        def convert_key(key)
+          if regular_key?(key)
+            key
+          elsif (converted_key = __convert(key)) && regular_key?(converted_key)
+            converted_key
+          else
+            key
+          end
+        end
+
+        # Converts symbol/string keys to their alternative formats, but leaves
+        # other keys alone.
+        #
+        # @param [Object, String, Symbol] key the key to convert.
+        # @return [Object, String, Symbol] the converted key.
+        def __convert(key)
+          case key
+          when Symbol then key.to_s
+          when String then key.to_sym
+          else key
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hashie/mash.rb

@@ -145,7 +145,7 @@ module Hashie
     def custom_writer(key, value, convert = true) #:nodoc:
       key_as_symbol = (key = convert_key(key)).to_sym
 
-      log_built_in_message(key_as_symbol) if respond_to?(key_as_symbol)
+      log_built_in_message(key_as_symbol) if log_collision?(key_as_symbol)
       regular_writer(key, convert ? convert_value(value) : value)
     end
 
@@ -189,6 +189,7 @@ module Hashie
       self.class.new(self, default)
     end
 
+    alias_method :regular_key?, :key?
     def key?(key)
       super(convert_key(key))
     end
@@ -347,5 +348,10 @@ module Hashie
         'property. You can still access the key via the #[] method.'
       )
     end
+
+    def log_collision?(method_key)
+      respond_to?(method_key) && !self.class.disable_warnings? &&
+        !(regular_key?(method_key) || regular_key?(method_key.to_s))
+    end
   end
 end

data/lib/hashie/version.rb

@@ -1,3 +1,3 @@
 module Hashie
-  VERSION = '3.5.4'
+  VERSION = '3.5.5'
 end

data/spec/hashie/dash_spec.rb

@@ -192,6 +192,32 @@ describe DashTest do
     end
   end
 
+  context 'converting from a Mash' do
+    class ConvertingFromMash < Hashie::Dash
+      property :property, required: true
+    end
+
+    context 'without keeping the original keys' do
+      let(:mash) { Hashie::Mash.new(property: 'test') }
+
+      it 'does not pick up the property from the stringified key' do
+        expect { ConvertingFromMash.new(mash) }.to raise_error(NoMethodError)
+      end
+    end
+
+    context 'when keeping the original keys' do
+      class KeepingMash < Hashie::Mash
+        include Hashie::Extensions::Mash::KeepOriginalKeys
+      end
+
+      let(:mash) { KeepingMash.new(property: 'test') }
+
+      it 'picks up the property from the original key' do
+        expect { ConvertingFromMash.new(mash) }.not_to raise_error
+      end
+    end
+  end
+
   describe '#new' do
     it 'fails with non-existent properties' do
       expect { described_class.new(bork: '') }.to raise_error(*no_property_error('bork'))

data/spec/hashie/extensions/mash/keep_original_keys_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+RSpec.describe Hashie::Extensions::Mash::KeepOriginalKeys do
+  let(:keeping_mash) do
+    Class.new(Hashie::Mash) do
+      include Hashie::Extensions::Mash::KeepOriginalKeys
+    end
+  end
+
+  it 'keeps the keys in the resulting hash identical to the original' do
+    original = { :a => 'apple', 'b' => 'bottle' }
+    mash = keeping_mash.new(original)
+
+    expect(mash.to_hash).to eq(original)
+  end
+
+  it 'indifferently responds to keys' do
+    original = { :a => 'apple', 'b' => 'bottle' }
+    mash = keeping_mash.new(original)
+
+    expect(mash['a']).to eq(mash[:a])
+    expect(mash['b']).to eq(mash[:b])
+  end
+
+  it 'responds to all method accessors like a Mash' do
+    original = { :a => 'apple', 'b' => 'bottle' }
+    mash = keeping_mash.new(original)
+
+    expect(mash.a).to eq('apple')
+    expect(mash.a?).to eq(true)
+    expect(mash.b).to eq('bottle')
+    expect(mash.b?).to eq(true)
+    expect(mash.underbang_).to be_a(keeping_mash)
+    expect(mash.bang!).to be_a(keeping_mash)
+    expect(mash.predicate?).to eq(false)
+  end
+
+  it 'keeps the keys that are directly passed without converting them' do
+    original = { :a => 'apple', 'b' => 'bottle' }
+    mash = keeping_mash.new(original)
+
+    mash[:c] = 'cat'
+    mash['d'] = 'dog'
+    expect(mash.to_hash).to eq(:a => 'apple', 'b' => 'bottle', :c => 'cat', 'd' => 'dog')
+  end
+end

data/spec/hashie/mash_spec.rb

@@ -142,6 +142,14 @@ describe Hashie::Mash do
       expect(logger_output).to match('Hashie::Mash#trust')
     end
 
+    it 'can set keys more than once and does not warn when doing so' do
+      mash = Hashie::Mash.new
+      mash[:test_key] = 'Test value'
+
+      expect { mash[:test_key] = 'A new value' }.not_to raise_error
+      expect(logger_output).to be_blank
+    end
+
     it 'does not write to the logger when warnings are disabled' do
       mash_class = Class.new(Hashie::Mash) do
         disable_warnings

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashie
 version: !ruby/object:Gem::Version
-  version: 3.5.4
+  version: 3.5.5
 platform: ruby
 authors:
 - Michael Bleigh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -85,6 +85,7 @@ files:
 - lib/hashie/extensions/ignore_undeclared.rb
 - lib/hashie/extensions/indifferent_access.rb
 - lib/hashie/extensions/key_conversion.rb
+- lib/hashie/extensions/mash/keep_original_keys.rb
 - lib/hashie/extensions/mash/safe_assignment.rb
 - lib/hashie/extensions/mash/symbolize_keys.rb
 - lib/hashie/extensions/merge_initializer.rb
@@ -119,6 +120,7 @@ files:
 - spec/hashie/extensions/indifferent_access_spec.rb
 - spec/hashie/extensions/indifferent_access_with_rails_hwia_spec.rb
 - spec/hashie/extensions/key_conversion_spec.rb
+- spec/hashie/extensions/mash/keep_original_keys_spec.rb
 - spec/hashie/extensions/mash/safe_assignment_spec.rb
 - spec/hashie/extensions/mash/symbolize_keys_spec.rb
 - spec/hashie/extensions/merge_initializer_spec.rb
@@ -187,6 +189,7 @@ test_files:
 - spec/hashie/extensions/indifferent_access_spec.rb
 - spec/hashie/extensions/indifferent_access_with_rails_hwia_spec.rb
 - spec/hashie/extensions/key_conversion_spec.rb
+- spec/hashie/extensions/mash/keep_original_keys_spec.rb
 - spec/hashie/extensions/mash/safe_assignment_spec.rb
 - spec/hashie/extensions/mash/symbolize_keys_spec.rb
 - spec/hashie/extensions/merge_initializer_spec.rb