hashie 3.2.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9392e6b092e218e8f232ce4232ffc42e593321d8
-  data.tar.gz: 96d123ecbe640bf034bd43108e27da8d437d9720
+  metadata.gz: 6551cd1a2b88f91c4e0517a95835202ca6b44152
+  data.tar.gz: cb7b3ebb5a7dae20e11489b1a393a88ddad1add0
 SHA512:
-  metadata.gz: 13c30a48d328a2427cfe2325f0690e2621fcf601bc0354b5d0831f005e4c23ea4fc83b40aef250ce85b9c4434fe6733cff2b5be2822f313b9535485e7003eef6
-  data.tar.gz: e03895318b6f26ac05e394069c30eb9eb8a98f86b206996f04a19402dd2c283ad2cd52f203e739b7a2b30f7ae4282840a6be783ea8f21cf550e047d2ed732129
+  metadata.gz: dfb86431453dbd01e46a71267457ba218e6fbf718bf6f3b246ed420a97db853ab1bed1c9db0a9491cc5a19aff54f8ec7be8a5262fa5360cfec29da63549644e1
+  data.tar.gz: fd8047680fcde393057b48f6cf9147bedc41a0e9d2824be3a28a1de8b3d962091cb343c2b32d6e5a47ac88b93b324ca16a89eecfc094aae5744ba8e715dbf75f

data/.rubocop.yml

@@ -1,36 +1,34 @@
 AllCops:
   Exclude:
-    - vendor/**
-    - bin/**
     - .bundle/**
+    - bin/**
+    - vendor/**
 
-LineLength:
-  Enabled: false
-
-MethodLength:
+Style/CaseEquality:
   Enabled: false
 
-ClassLength:
+Style/Documentation:
+  # don't require classes to be documented
   Enabled: false
 
-Documentation:
-  # don't require classes to be documented
+Style/DoubleNegation:
   Enabled: false
 
-Encoding:
+Style/Encoding:
   # no need to always specify encoding
   Enabled: false
 
-Lambda:
-  # TODO: replace all lambda with -> or Proc
+Metrics/ClassLength:
   Enabled: false
 
-CyclomaticComplexity:
+Metrics/CyclomaticComplexity:
   Enabled: false
 
-DoubleNegation:
+Metrics/LineLength:
   Enabled: false
 
-CaseEquality:
+Metrics/MethodLength:
   Enabled: false
 
+Metrics/PerceivedComplexity:
+  Max: 10

data/.travis.yml

@@ -1,14 +1,14 @@
 language: ruby
 
 rvm:
-  - ruby-head
   - 2.1.2
   - 2.1.0
   - 2.0.0
   - 1.9.3
   - jruby-19mode
+  - rbx-2.2.10
   - jruby-head
-  - rbx-2
+  - ruby-head
 
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## Next Release
+
+* Your contribution here.
+
+## 3.3.1 (8/26/2014)
+
+* [#183](https://github.com/intridea/hashie/pull/183): Added Mash#load with YAML file support - [@gregory](https://github.com/gregory).
+* [#195](https://github.com/intridea/hashie/pull/195): Ensure that the same object is returned after injecting IndifferentAccess - [@michaelherold](https://github.com/michaelherold).
+* [#201](https://github.com/intridea/hashie/pull/201): Hashie::Trash transforms can be inherited - [@fobocaster](https://github.com/fobocaster).
+* [#189](https://github.com/intridea/hashie/pull/189): Added Rash#fetch - [@medcat](https://github.com/medcat).
+* [#200](https://github.com/intridea/hashie/pull/200): Improved coercion: primitives and error handling - [@maxlinc](https://github.com/maxlinc).
+* [#204](https://github.com/intridea/hashie/pull/204): Added Hashie::Extensions::MethodOverridingWriter and Hashie::Extensions::MethodAccessWithOverride - [@michaelherold](https://github.com/michaelherold).
+* [#205](http://github.com/intridea/hashie/pull/205): Added Hashie::Extensions::Mash::SafeAssignment - [@michaelherold](https://github.com/michaelherold).
+* [#206](http://github.com/intridea/hashie/pull/206): Fixed stack overflow from repetitively including coercion in subclasses - [@michaelherold](https://github.com/michaelherold).
+* [#207](http://github.com/intridea/hashie/pull/207): Fixed inheritance of transformations in Trash - [@fobocaster](https://github.com/fobocaster).
+* [#209](http://github.com/intridea/hashie/pull/209): Added Hashie::Extensions::DeepFind - [@michaelherold](https://github.com/michaelherold).
+* [#69](https://github.com/intridea/hashie/pull/69): Fixed regression in assigning multiple properties in Hashie::Trash - [@michaelherold](https://github.com/michaelherold), [@einzige](https://github.com/einzige), [@dblock](https://github.com/dblock).
+
 ## 3.2.0 (7/10/2014)
 
 * [#164](https://github.com/intridea/hashie/pull/164), [#165](https://github.com/intridea/hashie/pull/165), [#166](https://github.com/intridea/hashie/pull/166): Fixed stack overflow when coercing mashes that contain ActiveSupport::HashWithIndifferentAccess values - [@numinit](https://github.com/numinit), [@kgrz](https://github.com/kgrz).

data/Gemfile

@@ -6,9 +6,17 @@ platforms :rbx do
   gem 'racc'
 end
 
-gemspec
+group :development do
+  gem 'pry'
+  gem 'pry-stack_explorer', platforms: [:ruby_19, :ruby_20, :ruby_21]
+  gem 'rubocop', '~> 0.25'
+  gem 'guard', '~> 2.6.1'
+  gem 'guard-rspec', '~> 4.3.1', require: false
+end
 
-gem 'rubocop', '0.24.1'
+gemspec
 
-# ActiveSupport required to test compatibility with ActiveSupport Core Extensions.
-gem 'activesupport', require: false
+group :test do
+  # ActiveSupport required to test compatibility with ActiveSupport Core Extensions.
+  gem 'activesupport', require: false
+end

data/Guardfile

@@ -1,5 +1,5 @@
-guard 'rspec' do
-  watch(%r{^spec/.+_spec\.rb})
-  watch(%r{^lib/(.+)\.rb})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb') { "spec" }
+guard 'rspec', all_on_start: false, cmd: 'bundle exec rspec' do
+  watch(/^spec\/.+_spec\.rb/)
+  watch(/^lib\/(.+)\.rb/)     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
 end

data/README.md

@@ -12,7 +12,7 @@ $ gem install hashie
 
 ## Upgrading
 
-You're reading the documentation for the stable release of Hashie, 3.2.0. Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
+You're reading the documentation for the next release of Hashie, which should be 3.3.2. Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version. The current stable release is [3.3.1](https://github.com/intridea/hashie/blob/v3.3.1/README.md).
 
 ## Hash Extensions
 
@@ -96,6 +96,47 @@ tweet.relations.class # => Hash
 #    and Relation.new on each value since Relation doesn't define the `coerce` class method
 ```
 
+### Coercing Core Types
+
+Hashie handles coercion to the following by using standard conversion methods:
+
+| type     | method   |
+|----------|----------|
+| Integer  | `#to_i`  |
+| Float    | `#to_f`  |
+| Complex  | `#to_c`  |
+| Rational | `#to_r`  |
+| String   | `#to_s`  |
+| Symbol   | `#to_sym`|
+
+**Note**: The standard Ruby conversion methods are less strict than you may assume. For example, `:foo.to_i` raises an error but `"foo".to_i` returns 0.
+
+You can also use coerce from the following supertypes with `coerce_value`:
+- Integer
+- Numeric
+
+Hashie does not have built-in support for coercion boolean values, since Ruby does not have a built-in boolean type or standard method for to a boolean. You can coerce to booleans using a custom proc.
+
+### Coercion Proc
+
+You can use a custom coercion proc on either `#coerce_key` or `#coerce_value`. This is useful for coercing to booleans or other simple types without creating a new class and `coerce` method. For example:
+
+```ruby
+class Tweet < Hash
+  include Hashie::Extensions::Coercion
+  coerce_key :retweeted, ->(v) do
+    case v
+    when String
+      return !!(v =~ /^(true|t|yes|y|1)$/i)
+    when Numeric
+      return !v.to_i.zero?
+    else
+      return v == true
+    end
+  end
+end
+```
+
 ### KeyConversion
 
 The KeyConversion extension gives you the convenience methods of `symbolize_keys` and `stringify_keys` along with their bang counterparts. You can also include just stringify or just symbolize with `Hashie::Extensions::StringifyKeys` or `Hashie::Extensions::SymbolizeKeys`.
@@ -119,6 +160,29 @@ h.abc  # => 'def'
 h.abc? # => true
 ```
 
+### MethodAccessWithOverride
+
+The MethodAccessWithOverride extension is like the MethodAccess extension, except that it allows you to override Hash methods. It aliases any overridden method with two leading underscores. To include only this overriding functionality, you can include the single module `Hashie::Extensions::MethodOverridingWriter`.
+
+```ruby
+class MyHash < Hash
+  include Hashie::Extensions::MethodAccess
+end
+
+class MyOverridingHash < Hash
+  include Hashie::Extensions::MethodAccessWithOverride
+end
+
+non_overriding = MyHash.new
+non_overriding.zip = 'a-dee-doo-dah'
+non_overriding.zip #=> [[['zip', 'a-dee-doo-dah']]]
+
+overriding = MyHash.new
+overriding.zip = 'a-dee-doo-dah'
+overriding.zip   #=> 'a-dee-doo-dah'
+overriding.__zip #=> [[['zip', 'a-dee-doo-dah']]]
+```
+
 ### IndifferentAccess
 
 This extension can be mixed in to instantly give you indifferent access to your Hash subclass. This works just like the params hash in Rails and other frameworks where whether you provide symbols or strings to access keys, you will get the same results.
@@ -196,9 +260,35 @@ user.deep_fetch :name, :middle { |key| 'default' }  # =>  'default'
 user.deep_fetch :groups, 1, :name # => 'Open source enthusiasts'
 ```
 
+### DeepFind
+
+This extension can be mixed in to provide for concise searching for keys within a deeply nested hash.
+
+It can also search through any Enumerable contained within the hash for objects with the specified key.
+
+Note: The searches are depth-first, so it is not guaranteed that a shallowly nested value will be found before a deeply nested value.
+
+```ruby
+user = {
+  name: { first: 'Bob', last: 'Boberts' },
+  groups: [
+    { name: 'Rubyists' },
+    { name: 'Open source enthusiasts' }
+  ]
+}
+
+user.extend Hashie::Extensions::DeepFind
+
+user.deep_find(:name)   #=> { first: 'Bob', last: 'Boberts' }
+user.deep_detect(:name) #=> { first: 'Bob', last: 'Boberts' }
+
+user.deep_find_all(:name) #=> [{ first: 'Bob', last: 'Boberts' }, 'Rubyists', 'Open source enthusiasts']
+user.deep_select(:name)   #=> [{ first: 'Bob', last: 'Boberts' }, 'Rubyists', 'Open source enthusiasts']
+```
+
 ## Mash
 
-Mash is an extended Hash that gives simple pseudo-object functionality that can be built from hashes and easily extended. It is designed to be used in RESTful API libraries to provide easy object-like access to JSON and XML parsed hashes.
+Mash is an extended Hash that gives simple pseudo-object functionality that can be built from hashes and easily extended. It is intended to give the user easier access to the objects within the Mash through a property-like syntax, while still retaining all Hash functionality.
 
 ### Example:
 
@@ -224,6 +314,75 @@ mash.inspect # => <Hashie::Mash>
 
 **Note:** The `?` method will return false if a key has been set to false or nil. In order to check if a key has been set at all, use the `mash.key?('some_key')` method instead.
 
+Please note that a Mash will not override methods through the use of the property-like syntax. This can lead to confusion if you expect to be able to access a Mash value through the property-like syntax for a key that conflicts with a method name. However, it protects users of your library from the unexpected behavior of those methods being overridden behind the scenes.
+
+### Example:
+
+```ruby
+mash = Hashie::Mash.new
+mash.name = "My Mash"
+mash.zip = "Method Override?"
+mash.zip # => [[["name", "My Mash"]], [["zip", "Method Override?"]]]
+```
+
+Mash allows you also to transform any files into a Mash objects.
+
+### Example:
+
+```yml
+#/etc/config/settings/twitter.yml
+development:
+  api_key: 'api_key'
+production:
+  api_key: <%= ENV['API_KEY'] %> #let's say that ENV['API_KEY'] is set to 'abcd'
+```
+
+```ruby
+mash = Mash.load('settings/twitter.yml')
+mash.development.api_key # => 'localhost'
+mash.development.api_key = "foo" # => <# RuntimeError can't modify frozen ...>
+mash.development.api_key? # => true
+```
+
+You can access a Mash from another class:
+
+```ruby
+mash = Mash.load('settings/twitter.yml')[ENV['RACK_ENV']]
+Twitter.extend mash.to_module # NOTE: if you want another name than settings, call: to_module('my_settings')
+Twitter.settings.api_key # => 'abcd'
+```
+
+You can use another parser (by default: YamlErbParser):
+
+```
+#/etc/data/user.csv
+id | name          | lastname
+---|------------- | -------------
+1  |John          | Doe
+2  |Laurent       | Garnier
+```
+
+```ruby
+mash = Mash.load('data/user.csv', parser: MyCustomCsvParser)
+# => { 1 => { name: 'John', lastname: 'Doe'}, 2 => { name: 'Laurent', lastname: 'Garnier' } }
+mash[1] #=> { name: 'John', lastname: 'Doe' }
+```
+
+### 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.
+
+#### Example:
+
+```ruby
+class SafeMash < ::Hashie::Mash
+  include Hashie::Extensions::Mash::SafeAssignment
+end
+
+safe_mash = SafeMash.new
+safe_mash.zip = 'Test' # => ArgumentError
+```
+
 ## 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.

data/RELEASING.md

@@ -0,0 +1,83 @@
+# Releasing Hashie
+
+There're no particular rules about when to release Hashie. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```sh
+bundle install
+bundle exec rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/intridea/hashie) for all supported platforms.
+
+Increment the version, modify [lib/hashie/version.rb](lib/hashie/version.rb).
+
+* Increment the third number (minor version) if the release has bug fixes and/or very minor features, only (eg. change `0.5.1` to `0.5.2`).
+* Increment the second number (patch version) if the release contains major features or breaking API changes (eg. change `0.5.1` to `0.6.0`).
+
+Modify the "Stable Release" section in [README.md](README.md). Change the text to reflect that this is going to be the documentation for a stable release. Remove references to the previous release of Hashie. Keep the file open, you'll have to undo this change after the release.
+
+```markdown
+## Stable Release
+
+You're reading the documentation for the stable release of Hashie, 3.3.0.
+```
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```markdown
+3.3.0 (8/25/2014)
+=================
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```sh
+git add README.md CHANGELOG.md lib/hashie/version.rb
+git commit -m "Preparing for release, 3.3.0."
+git push origin master
+```
+
+Release.
+
+```sh
+$ rake release
+
+hashie 3.3.0 built to pkg/hashie-3.3.0.gem.
+Tagged v3.3.0.
+Pushed git commits and tags.
+Pushed hashie 3.3.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Modify the "Stable Release" section in [README.md](README.md). Change the text to reflect that this is going to be the next release.
+
+```markdown
+## Stable Release
+
+You're reading the documentation for the next release of Hashie, which should be 3.3.1.
+The current stable release is [3.3.0](https://github.com/intridea/hashie/blob/v3.3.0/README.md).
+```
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```markdown
+Next Release
+============
+
+* Your contribution here.
+```
+
+Commit your changes.
+
+```sh
+git add CHANGELOG.md README.md
+git commit -m "Preparing for next release."
+git push origin master
+```

data/UPGRADING.md

@@ -1,6 +1,22 @@
 Upgrading Hashie
 ================
 
+### Upgrading to 3.2.1
+
+#### Possible coercion changes
+
+The improvements made to coercions in version 3.2.1 [issue #200](https://github.com/intridea/hashie/pull/200) do not break the documented API, but are significant enough that changes may effect undocumented side-effects. Applications that depended on those side-effects will need to be updated.
+
+**Change**: Type coercion no longer creates new objects if the input matches the target type. Previously coerced properties always resulted in the creation of a new object, even when it wasn't necessary. This had the effect of a `dup` or `clone` on coerced properties but not uncoerced ones.
+
+If necessary, `dup` or `clone` your own objects. Do not assume Hashie will do it for you.
+
+**Change**: Failed coercion attempts now raise Hashie::CoercionError.
+
+Hashie now raises a Hashie::CoercionError that details on the property that could not be coerced, the source and target type of the coercion, and the internal error. Previously only the internal error was raised.
+
+Applications that were attempting to rescuing the internal errors should be updated to rescue Hashie::CoercionError instead.
+
 ### Upgrading to 3.0
 
 #### Compatibility with Rails 4 Strong Parameters

data/lib/hashie.rb

@@ -21,15 +21,20 @@ module Hashie
     autoload :StringifyKeys,     'hashie/extensions/stringify_keys'
     autoload :SymbolizeKeys,     'hashie/extensions/symbolize_keys'
     autoload :DeepFetch,         'hashie/extensions/deep_fetch'
+    autoload :DeepFind,          'hashie/extensions/deep_find'
     autoload :PrettyInspect,     'hashie/extensions/pretty_inspect'
     autoload :KeyConversion,     'hashie/extensions/key_conversion'
 
-    module Mash
-      autoload :ActiveModel,     'hashie/extensions/mash/active_model'
+    module Parsers
+      autoload :YamlErbParser, 'hashie/extensions/parsers/yaml_erb_parser'
     end
 
     module Dash
       autoload :IndifferentAccess, 'hashie/extensions/dash/indifferent_access'
     end
+
+    module Mash
+      autoload :SafeAssignment, 'hashie/extensions/mash/safe_assignment'
+    end
   end
 end