hashie 3.5.3 → 3.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4946d0568ab6be36877e25d748fdb8f04f50ed5
-  data.tar.gz: f9cdd8a276939236ceb84633d88d5325486d5d86
+  metadata.gz: b244f4fdc55d9650174134efecbb99d32e75ef14
+  data.tar.gz: 5a00da5d9da33a9a7bdc3f821d16e83dfca65ced
 SHA512:
-  metadata.gz: 7c4748d9c7c2d79fa5a362fe10497994ea1f7fc27e75dc476b17422cd32fb9d32d9923c42662a7bfb64c19413b1391124cf91cfd463b0c4adcdc7b463d611981
-  data.tar.gz: ded15b7bd812ffe4792cf7e56f894e040d9041af56e1816f2c3d82ef62ee7bd5193fcf2cdac4086b11372dc6689fc0ee0a1b150f84cb17462e93bc4a5f860878
+  metadata.gz: f948ef11d034b29d9b6a6d9473be7528ba2e3b2e79e9a164fd622194ed39ab29a7b6d37ea1a4f4eeb0232a28fb3ff8d6b19cba3b059a13b33e5894180d76c7c7
+  data.tar.gz: e3ac5f5715323c230b2beedd38a4e47a9a2d199f17a4535072d75c645364ac14b2b4f95e4985de39db270b17f10b92989266eb5d4bb2c4a834a386a7807a04dd

data/CHANGELOG.md

@@ -6,6 +6,19 @@ scheme are considered to be bugs.
 
 [semver]: http://semver.org/spec/v2.0.0.html
 
+## [3.5.4] - 2017-02-22
+
+[3.5.4]: https://github.com/intridea/hashie/compare/v3.5.3...v3.5.4
+
+### Added
+
+* [#412](https://github.com/intridea/hashie/pull/412): Added a Hashie::Extensions::Mash::SymbolizeKeys extension that overrides the default stringification behavior for keys - [@michaelherold](https://github.com/michaelherold).
+
+### Fixed
+
+* [#409](https://github.com/intridea/hashie/pull/409): Fixed Railtie detection for projects where Rails is defined but Railties are not availble - [@CallumD](https://github.com/callumd).
+* [#411](https://github.com/intridea/hashie/pull/411): Fixed a performance regression from 3.4.3 that caused a 10x slowdown in OmniAuth - [@michaelherold](https://github.com/michaelherold).
+
 ## [3.5.3] - 2017-02-11
 
 [3.5.3]: https://github.com/intridea/hashie/compare/v3.5.2...v3.5.3

data/README.md

@@ -20,7 +20,7 @@ $ gem install hashie
 
 ## Upgrading
 
-You're reading the documentation for the stable release of Hashie, 3.5.3. Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
+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.
 
 ## Hash Extensions
 
@@ -561,6 +561,33 @@ safe_mash.zip   = 'Test' # => ArgumentError
 safe_mash[:zip] = 'test' # => still ArgumentError
 ```
 
+### Mash Extension:: SymbolizeKeys
+
+This extension can be mixed into a Mash to change the default behavior of converting keys to strings. After mixing this extension into a Mash, the Mash will convert all keys to symbols.
+
+```ruby
+class SymbolizedMash < ::Hashie::Mash
+  include Hashie::Extensions::Mash::SymbolizeKeys
+end
+
+symbol_mash = SymbolizedMash.new
+symbol_mash['test'] = 'value'
+symbol_mash.test  #=> 'value'
+symbol_mash.to_h  #=> {test: 'value'}
+```
+
+There is a major benefit and coupled with a major trade-off to this decision (at least on older Rubies). As a benefit, by using symbols as keys, you will be able to use the implicit conversion of a Mash via the `#to_hash` method to destructure (or splat) the contents of a Mash out to a block. This can be handy for doing iterations through the Mash's keys and values, as follows:
+
+```ruby
+symbol_mash = SymbolizedMash.new(id: 123, name: 'Rey')
+symbol_mash.each do |key, value|
+  # key is :id, then :name
+  # value is 123, then 'Rey'
+end
+```
+
+However, on Rubies less than 2.0, this means that every key you send to the Mash will generate a symbol. Since symbols are not garbage-collected on older versions of Ruby, this can cause a slow memory leak when using a symbolized Mash with data generated from user input.
+
 ## Dash
 
 Dash is an extended Hash that has a discrete set of defined properties and only those properties may be set on the hash. Additionally, you can set defaults for each property. You can also flag a property as required. Required properties will raise an exception if unset. Another option is message for required properties, which allow you to add custom messages for required property.

data/lib/hashie.rb

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

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

@@ -0,0 +1,38 @@
+module Hashie
+  module Extensions
+    module Mash
+      # Overrides Mash's default behavior of converting keys to strings
+      #
+      # @example
+      #   class LazyResponse < Hashie::Mash
+      #     include Hashie::Extensions::Mash::SymbolizedKeys
+      #   end
+      #
+      #   response = LazyResponse.new("id" => 123, "name" => "Rey").to_h
+      #   #=> {id: 123, name: "Rey"}
+      #
+      # @api public
+      module SymbolizeKeys
+        # Hook for being included in a class
+        #
+        # @api private
+        # @return [void]
+        # @raise [ArgumentError] when the base class isn't a Mash
+        def self.included(base)
+          fail ArgumentError, "#{base} must descent from Hashie::Mash" unless base <= Hashie::Mash
+        end
+
+        private
+
+        # Converts a key to a symbol
+        #
+        # @api private
+        # @param [String, Symbol] key the key to convert to a symbol
+        # @return [void]
+        def convert_key(key)
+          key.to_sym
+        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 methods.include?(key_as_symbol)
+      log_built_in_message(key_as_symbol) if respond_to?(key_as_symbol)
       regular_writer(key, convert ? convert_value(value) : value)
     end
 

data/lib/hashie/railtie.rb

@@ -1,10 +1,14 @@
-require 'rails/railtie'
+begin
+  require 'rails/railtie'
 
-module Hashie
-  class Railtie < Rails::Railtie
-    # Set the Hashie.logger to use Rails.logger when used with rails.
-    initializer 'hashie.configure_logger', after: 'initialize_logger' do
-      Hashie.logger = Rails.logger
+  module Hashie
+    class Railtie < Rails::Railtie
+      # Set the Hashie.logger to use Rails.logger when used with rails.
+      initializer 'hashie.configure_logger', after: 'initialize_logger' do
+        Hashie.logger = Rails.logger
+      end
     end
   end
+rescue LoadError => e
+  Hashie.logger.info("Hashie skipping railtie as #{e.message}")
 end

data/lib/hashie/version.rb

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

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

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+RSpec.describe Hashie::Extensions::Mash::SymbolizeKeys do
+  it 'raises an error when included in a class that is not a Mash' do
+    expect do
+      Class.new do
+        include Hashie::Extensions::Mash::SymbolizeKeys
+      end
+    end.to raise_error(ArgumentError)
+  end
+
+  it 'symbolizes all keys in the Mash' do
+    my_mash = Class.new(Hashie::Mash) do
+      include Hashie::Extensions::Mash::SymbolizeKeys
+    end
+
+    expect(my_mash.new('test' => 'value').to_h).to eq(test: 'value')
+  end
+
+  context 'implicit to_hash on double splat' do
+    let(:destructure) { ->(**opts) { opts } }
+    let(:my_mash) do
+      Class.new(Hashie::Mash) do
+        include Hashie::Extensions::Mash::SymbolizeKeys
+      end
+    end
+    let(:instance) { my_mash.new('outer' => { 'inner' => 42 }, 'testing' => [1, 2, 3]) }
+
+    subject { destructure.call(instance) }
+
+    it 'is converted on method calls' do
+      expect(subject).to eq(outer: { inner: 42 }, testing: [1, 2, 3])
+    end
+
+    it 'is converted on explicit operator call' do
+      expect(**instance).to eq(outer: { inner: 42 }, testing: [1, 2, 3])
+    end
+  end
+end

data/spec/integration/rails-without-dependency/integration_spec.rb

@@ -0,0 +1,15 @@
+require 'rspec/core'
+
+RSpec.describe 'partial-rails' do
+  context 'when Rails constant is present but the railties are not' do
+    before(:all) do
+      class Rails
+        # A class about railways
+      end
+    end
+
+    it 'does not raise an exception when we require hashie' do
+      expect { require 'hashie' }.not_to raise_error
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashie
 version: !ruby/object:Gem::Version
-  version: 3.5.3
+  version: 3.5.4
 platform: ruby
 authors:
 - Michael Bleigh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-11 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -86,6 +86,7 @@ files:
 - lib/hashie/extensions/indifferent_access.rb
 - lib/hashie/extensions/key_conversion.rb
 - lib/hashie/extensions/mash/safe_assignment.rb
+- lib/hashie/extensions/mash/symbolize_keys.rb
 - lib/hashie/extensions/merge_initializer.rb
 - lib/hashie/extensions/method_access.rb
 - lib/hashie/extensions/parsers/yaml_erb_parser.rb
@@ -119,6 +120,7 @@ files:
 - spec/hashie/extensions/indifferent_access_with_rails_hwia_spec.rb
 - spec/hashie/extensions/key_conversion_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
 - spec/hashie/extensions/method_access_spec.rb
 - spec/hashie/extensions/strict_key_access_spec.rb
@@ -137,6 +139,7 @@ files:
 - spec/integration/omniauth-oauth2/some_site.rb
 - spec/integration/omniauth/app.rb
 - spec/integration/omniauth/integration_spec.rb
+- spec/integration/rails-without-dependency/integration_spec.rb
 - spec/integration/rails/app.rb
 - spec/integration/rails/integration_spec.rb
 - spec/spec_helper.rb
@@ -164,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Your friendly neighborhood hash library.
@@ -185,6 +188,7 @@ test_files:
 - spec/hashie/extensions/indifferent_access_with_rails_hwia_spec.rb
 - spec/hashie/extensions/key_conversion_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
 - spec/hashie/extensions/method_access_spec.rb
 - spec/hashie/extensions/strict_key_access_spec.rb
@@ -205,6 +209,7 @@ test_files:
 - spec/integration/omniauth-oauth2/some_site.rb
 - spec/integration/rails/app.rb
 - spec/integration/rails/integration_spec.rb
+- spec/integration/rails-without-dependency/integration_spec.rb
 - spec/spec_helper.rb
 - spec/support/integration_specs.rb
 - spec/support/logger.rb