hashie 3.5.1 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e68805c828e2bfe9d5921050a82bb0ac4d58428
-  data.tar.gz: 37906b7b9d2cd7f123b9968e9e67e2076c4e7bc5
+  metadata.gz: ee11cc424479d1ff5f737d9279f60e182adb0553
+  data.tar.gz: 7bae504b1c65b8cf79909c3180cf5084771efb5e
 SHA512:
-  metadata.gz: f1723cc215b0fbadd587e7f48827126e3d254b501498954a757ae445dc40eb8213d6499832182548387469b022f2f9b7af73085ecb1dbcdc6e3813d861b4ad60
-  data.tar.gz: fca4da7f4d73669f12c3e2f7b696ce2ffbde9aba07b33f61c0879e5f8428d59c441b5dedbc59db003bb42a4fecafd202cdc6f2145183dcdd407dbabdd3508d01
+  metadata.gz: 6af54aa6435ee5df457614baf9a60a0d3660e7066229e90a74109ff38999afda2444a02e965ec9f5422e4ddd85e6a493d3cb52ff735712d8dfd8d02c84f504f8
+  data.tar.gz: a2ed6b577219d2a7e6ebaca2ca5589b29af9b89a1201580707ab39d4895c0cbee63f4dd4e92a5c3ccda1409f226fc0ccbce41e0b7f8e6a694f6d85df7e598d60

data/CHANGELOG.md

@@ -6,13 +6,31 @@ scheme are considered to be bugs.
 
 [semver]: http://semver.org/spec/v2.0.0.html
 
+## [3.5.2] - 2017-02-10
+
+[3.5.2]: https://github.com/intridea/hashie/compare/v3.5.1...v3.5.2
+
+### Added
+
+* [#395](https://github.com/intridea/hashie/pull/395): Add the ability to disable warnings in Mash subclasses - [@michaelherold](https://github.com/michaelherold).
+* [#400](https://github.com/intridea/hashie/pull/400): Fix Hashie.logger load and set the Hashie logger to the Rails logger in a Rails environment - [@michaelherold](https://github.com/michaelherold).
+
+### Fixed
+
+* [#396](https://github.com/intridea/hashie/pull/396): Fix for specs in #381: Incorrect use of shared context meant example was not being run - [@biinari](https://github.com/biinari).
+* [#399](https://github.com/intridea/hashie/pull/399): Fix passing Pathname object to Hashie::Mesh.load() - [@albb0920](https://github.com/albb0920).
+
+### Miscellanous
+
+* [#397](https://github.com/intridea/hashie/pull/397): Add the integration specs harness into the main test tasks - [@michaelherold](https://github.com/michaelherold).
+
 ## [3.5.1] - 2017-01-31
 
 * [#392](https://github.com/intridea/hashie/pull/392): Fix for #391: Require all dependencies of Hashie::Mash - [@dblock](https://github.com/dblock).
 
 [3.5.1]: https://github.com/intridea/hashie/compare/v3.5.0...v3.5.1
 
-## [3.5.0] - 2017-01-31 (YANKED)
+## [3.5.0] - 2017-01-31
 
 * [#386](https://github.com/intridea/hashie/pull/386): Fix for #385: Make `deep_merge` always `deep_dup` nested hashes before merging them in so that there are no shared references between the two hashes being merged. - [@mltsy](https://github.com/mltsy).
 * [#389](https://github.com/intridea/hashie/pull/389): Support Ruby 2.4.0 - [@camelmasa](https://github.com/camelmasa).

data/README.md

@@ -20,7 +20,7 @@ $ gem install hashie
 
 ## Upgrading
 
-You're reading the documentation for the stable release of Hashie, 3.5.1. Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
+You're reading the documentation for the stable release of Hashie, 3.5.2. Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
 
 ## Hash Extensions
 
@@ -531,6 +531,20 @@ mash = Mash.load('data/user.csv', parser: MyCustomCsvParser)
 mash[1] #=> { name: 'John', lastname: 'Doe' }
 ```
 
+Since Mash gives you the ability to set arbitrary keys that then act as methods, Hashie logs when there is a conflict between a key and a pre-existing method. You can set the logger that this logs message to via the global Hashie logger:
+
+```ruby
+Hashie.logger = Rails.logger
+```
+
+You can also disable the logging in subclasses of Mash:
+
+```ruby
+class Response < Hashie::Mash
+  disable_warnings
+end
+```
+
 ### 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/Rakefile

@@ -13,4 +13,20 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+require_relative 'spec/support/integration_specs'
+task :integration_specs do
+  next if ENV['CI']
+  status_codes = []
+  handler = lambda do |status_code|
+    status_codes << status_code unless status_code.zero?
+  end
+
+  run_all_integration_specs(handler: handler, logger: ->(msg) { puts msg })
+
+  if status_codes.any?
+    $stderr.puts "#{status_codes.size} integration test(s) failed"
+    exit status_codes.last
+  end
+end
+
+task default: [:rubocop, :spec, :integration_specs]

data/UPGRADING.md

@@ -1,6 +1,19 @@
 Upgrading Hashie
 ================
 
+### Upgrading to 3.5.2
+
+#### Disable logging in Mash subclasses
+
+If you subclass `Hashie::Mash`, you can now disable the logging we do about
+overriding existing methods with keys. This looks like:
+
+```ruby
+class MyMash < Hashie::Mash
+  disable_warnings
+end
+```
+
 ### Upgrading to 3.4.7
 
 #### Procs as default values for Dash
@@ -11,7 +24,7 @@ class MyHash < Hashie::Dash
 end
 ```
 
-In versions < 3.4.7 `Time.now` will be evaluated when `time` property is accessed directly first time. 
+In versions < 3.4.7 `Time.now` will be evaluated when `time` property is accessed directly first time.
 In version >= 3.4.7 `Time.now` is evaluated in time of object initialization.
 ### Upgrading to 3.4.4
 

data/lib/hashie.rb

@@ -1,8 +1,7 @@
-require 'logger'
+require 'hashie/logger'
 require 'hashie/version'
 
 module Hashie
-  autoload :Logger,             'hashie/logger'
   autoload :Clash,              'hashie/clash'
   autoload :Dash,               'hashie/dash'
   autoload :Hash,               'hashie/hash'

data/lib/hashie/logger.rb

@@ -1,9 +1,16 @@
+require 'logger'
+
 module Hashie
   # The logger that Hashie uses for reporting errors.
   #
   # @return [Logger]
   def self.logger
-    @logger ||= Logger.new(STDOUT)
+    @logger ||=
+      if defined?(::Rails)
+        Rails.logger
+      else
+        Logger.new(STDOUT)
+      end
   end
 
   # Sets the logger that Hashie uses for reporting errors.

data/lib/hashie/mash.rb

@@ -63,6 +63,29 @@ module Hashie
 
     ALLOWED_SUFFIXES = %w(? ! = _)
 
+    class CannotDisableMashWarnings < StandardError
+      def initialize(message = 'You cannot disable warnings on the base Mash class. Please subclass the Mash and disable it in the subclass.')
+        super(message)
+      end
+    end
+
+    # Disable the logging of warnings based on keys conflicting keys/methods
+    #
+    # @api semipublic
+    # @return [void]
+    def self.disable_warnings
+      fail CannotDisableMashWarnings if self == Hashie::Mash
+      @disable_warnings = true
+    end
+
+    # Checks whether this class disables warnings for conflicting keys/methods
+    #
+    # @api semipublic
+    # @return [Boolean]
+    def self.disable_warnings?
+      !!@disable_warnings
+    end
+
     def self.load(path, options = {})
       @_mashes ||= new
 
@@ -111,9 +134,10 @@ module Hashie
     # a string before it is set, and Hashes will be converted
     # into Mashes for nesting purposes.
     def custom_writer(key, value, convert = true) #:nodoc:
-      key_as_symbol = key.to_sym
+      key_as_symbol = (key = convert_key(key)).to_sym
+
       log_built_in_message(key_as_symbol) if methods.include?(key_as_symbol)
-      regular_writer(convert_key(key), convert ? convert_value(value) : value)
+      regular_writer(key, convert ? convert_value(value) : value)
     end
 
     alias_method :[], :custom_reader
@@ -303,6 +327,8 @@ module Hashie
     private
 
     def log_built_in_message(method_key)
+      return if self.class.disable_warnings?
+
       method_information = Hashie::Utils.method_information(method(method_key))
 
       Hashie.logger.warn(

data/lib/hashie/version.rb

@@ -1,3 +1,3 @@
 module Hashie
-  VERSION = '3.5.1'
+  VERSION = '3.5.2'
 end

data/spec/hashie/mash_spec.rb

@@ -1,9 +1,10 @@
 require 'spec_helper'
-require 'delegate'
 
 describe Hashie::Mash do
   subject { Hashie::Mash.new }
 
+  include_context 'with a logger'
+
   it 'inherits from Hash' do
     expect(subject.is_a?(Hash)).to be_truthy
   end
@@ -134,12 +135,26 @@ describe Hashie::Mash do
     expect(subject.type).to eq 'Steve'
   end
 
-  shared_context 'with a logger' do
+  include_context 'with a logger' do
     it 'logs a warning when overriding built-in methods' do
       Hashie::Mash.new('trust' => { 'two' => 2 })
 
       expect(logger_output).to match('Hashie::Mash#trust')
     end
+
+    it 'does not write to the logger when warnings are disabled' do
+      mash_class = Class.new(Hashie::Mash) do
+        disable_warnings
+      end
+
+      mash_class.new('trust' => { 'two' => 2 })
+
+      expect(logger_output).to be_blank
+    end
+
+    it 'cannot disable logging on the base Mash' do
+      expect { Hashie::Mash.disable_warnings }.to raise_error(Hashie::Mash::CannotDisableMashWarnings)
+    end
   end
 
   context 'updating' do
@@ -617,6 +632,20 @@ describe Hashie::Mash do
       end
     end
 
+    context 'if the file is passed as Pathname' do
+      require 'pathname'
+      let(:path) { Pathname.new('database.yml') }
+
+      before do
+        expect(File).to receive(:file?).with(path).and_return(true)
+        expect(parser).to receive(:perform).with(path).and_return(config)
+      end
+
+      it 'return a Mash from a file' do
+        expect(subject.production.foo).to eq config['production']['foo']
+      end
+    end
+
     describe 'results are cached' do
       let(:parser) { double(:parser) }
 

data/spec/hashie_spec.rb

@@ -2,12 +2,12 @@ require 'spec_helper'
 
 RSpec.describe Hashie do
   describe '.logger' do
-    shared_context 'with a logger' do
-      it 'is available via an accessor' do
-        Hashie.logger.info('Fee fi fo fum')
+    include_context 'with a logger'
 
-        expect(logger_output).to match('Fee fi fo fum')
-      end
+    it 'is available via an accessor' do
+      Hashie.logger.info('Fee fi fo fum')
+
+      expect(logger_output).to match('Fee fi fo fum')
     end
   end
 end

data/spec/integration/omniauth/integration_spec.rb

@@ -6,7 +6,7 @@ require 'sinatra'
 require 'omniauth'
 
 class MyApplication < Sinatra::Base
-  use Rack::Session::Cookie
+  use Rack::Session::Cookie, secret: 'hashie integration tests'
   use OmniAuth::Strategies::Developer
 
   get '/' do

data/spec/integration/rails/integration_spec.rb

@@ -0,0 +1,66 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'rspec/core'
+require 'rails'
+require 'rails/all'
+require 'action_view/testing/resolvers'
+
+module RailsApp
+  class Application < ::Rails::Application
+    config.action_dispatch.show_exceptions            = false
+    config.active_support.deprecation                 = :stderr
+    config.eager_load                                 = false
+    config.root                                       = __dir__
+    config.secret_key_base                            = 'hashieintegrationtest'
+
+    routes.append do
+      get '/' => 'application#index'
+    end
+
+    config.assets.paths << File.join(__dir__, 'assets/javascripts')
+    config.assets.debug = true
+  end
+end
+
+LAYOUT = <<-HTML
+<!DOCTYPE html>
+<html>
+<head>
+  <title>TestApp</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>
+HTML
+
+INDEX = <<-HTML
+<h1>Hello, world!</h1>
+HTML
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+
+  layout 'application'
+
+  self.view_paths = [ActionView::FixtureResolver.new(
+    'layouts/application.html.erb'         => LAYOUT,
+    'application/index.html.erb'           => INDEX
+  )]
+
+  def index
+  end
+end
+
+RailsApp::Application.initialize!
+
+require 'hashie'
+
+RSpec.describe 'the Hashie logger' do
+  it 'is set to the Rails logger' do
+    expect(Hashie.logger).to eq(Rails.logger)
+  end
+end

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ require 'rspec'
 require 'hashie'
 require 'rspec/pending_for'
 require './spec/support/ruby_version_check'
+require './spec/support/logger'
 
 require 'active_support'
 require 'active_support/core_ext'

data/spec/support/integration_specs.rb

@@ -0,0 +1,36 @@
+# Generates the bundle command for running an integration test
+#
+# @param [String] integration the integration folder to run
+# @param [String] command the command to run
+# @return [String]
+def integration_command(integration, command)
+  "#{integration_gemfile(integration)} #{command}"
+end
+
+# Generates the Gemfile for an integration
+#
+# @param [String] integration the integration test name
+# @return [String]
+def integration_gemfile(integration)
+  "BUNDLE_GEMFILE=#{integration_path(integration)}/Gemfile"
+end
+
+# Generates the path to the integration
+#
+# @param [String] integration the integration test name
+# @return [String]
+def integration_path(integration)
+  "spec/integration/#{integration}"
+end
+
+# Runs all integration specs in their own environment
+def run_all_integration_specs(handler: ->(_code) {}, logger: ->(_msg) {})
+  Dir['spec/integration/*']
+    .map { |directory| directory.split('/').last }
+    .each do |integration|
+      logger.call(%(Running "#{integration}" integration spec))
+      system(integration_command(integration, 'bundle --quiet'))
+      system(integration_command(integration, "bundle exec rspec #{integration_path(integration)}"))
+      handler.call($CHILD_STATUS.exitstatus)
+    end
+end

data/spec/support/logger.rb

@@ -1,7 +1,9 @@
 # A shared context that allows you to check the output of Hashie's logger.
 #
 # @example
-#   shared_context 'with a logger' do
+#   include_context 'with a logger'
+#
+#   it 'logs info message' do
 #     Hashie.logger.info 'What is happening in here?!'
 #
 #     expect(logger_output).to match('What is happening in here?!')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashie
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.5.2
 platform: ruby
 authors:
 - Michael Bleigh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -132,7 +132,9 @@ files:
 - spec/hashie/version_spec.rb
 - spec/hashie_spec.rb
 - spec/integration/omniauth/integration_spec.rb
+- spec/integration/rails/integration_spec.rb
 - spec/spec_helper.rb
+- spec/support/integration_specs.rb
 - spec/support/logger.rb
 - spec/support/module_context.rb
 - spec/support/ruby_version_check.rb
@@ -191,7 +193,9 @@ test_files:
 - spec/hashie/version_spec.rb
 - spec/hashie_spec.rb
 - spec/integration/omniauth/integration_spec.rb
+- spec/integration/rails/integration_spec.rb
 - spec/spec_helper.rb
+- spec/support/integration_specs.rb
 - spec/support/logger.rb
 - spec/support/module_context.rb
 - spec/support/ruby_version_check.rb