hashie 4.1.0 → 5.2.0

data/README.md

@@ -1,24 +1,88 @@
 # Hashie
 
 [![Join the chat at https://gitter.im/hashie/hashie](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hashie/hashie?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Gem Version](http://img.shields.io/gem/v/hashie.svg)](http://badge.fury.io/rb/hashie)
-[![Build Status](http://img.shields.io/travis/hashie/hashie.svg)](https://travis-ci.org/hashie/hashie)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/7a0b42c8a22c945571fd/test_coverage)](https://codeclimate.com/github/hashie/hashie/test_coverage)
-[![Maintainability](https://api.codeclimate.com/v1/badges/7a0b42c8a22c945571fd/maintainability)](https://codeclimate.com/github/hashie/hashie/maintainability)
-
-Hashie is a growing collection of tools that extend Hashes and make them more useful.
+[![Gem Version](https://img.shields.io/gem/v/hashie.svg)](https://rubygems.org/gems/hashie)
+[![Build Status](https://github.com/hashie/hashie/actions/workflows/test.yml/badge.svg)](https://github.com/hashie/hashie/actions/workflows/test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/hashie/hashie/badge.svg)](https://coveralls.io/github/hashie/hashie)
+
+[![eierlegende Wollmilchsau](./mascot.svg)](#mascot) Hashie is a growing collection of tools that extend Hashes and make them more useful.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Stable Release](#stable-release)
+- [Hash Extensions](#hash-extensions)
+  - [Coercion](#coercion)
+    - [Coercing Collections](#coercing-collections)
+    - [Coercing Hashes](#coercing-hashes)
+    - [Coercing Core Types](#coercing-core-types)
+    - [Coercion Proc](#coercion-proc)
+      - [Circular Coercion](#circular-coercion)
+    - [Nil Values and Defaults](#nil-values-and-defaults)
+    - [KernelCoercion](#kernelcoercion)
+    - [Callable Coercion](#callable-coercion)
+    - [Coercion with dry-types](#coercion-with-dry-types)
+    - [Coercion with ActiveModel](#coercion-with-activemodel)
+  - [KeyConversion](#keyconversion)
+  - [MergeInitializer](#mergeinitializer)
+  - [DeepMergeInitializer](#deepmergeinitializer)
+  - [MethodAccess](#methodaccess)
+  - [BlockAccess](#blockaccess)
+  - [Persistable](#persistable)
+  - [MethodAccessWithOverride](#methodaccesswithoverride)
+  - [MethodOverridingInitializer](#methodoverridinginitializer)
+  - [IndifferentAccess](#indifferentaccess)
+  - [IgnoreUndeclared](#ignoreundeclared)
+  - [DeepMerge](#deepmerge)
+  - [DeepFetch](#deepfetch)
+  - [DeepFind](#deepfind)
+  - [DeepGrep](#deepgrep)
+  - [DeepLocate](#deeplocate)
+  - [StrictKeyAccess](#strictkeyaccess)
+- [Mash](#mash)
+  - [Method Conflicts](#method-conflicts)
+  - [Nested Hashes](#nested-hashes)
+  - [Key Types](#key-types)
+  - [Loading Files](#loading-files)
+  - [Mash and Rails 4 Strong Parameters](#mash-and-rails-4-strong-parameters)
+  - [KeepOriginalKeys](#keeporiginalkeys)
+  - [PermissiveRespondTo](#permissiverespondto)
+  - [SafeAssignment](#safeassignment)
+  - [TransformKeys](#transformkeys)
+  - [UnderscoreKeys](#underscorekeys)
+  - [SymbolizeKeys](#symbolizekeys)
+  - [DefineAccessors](#defineaccessors)
+  - [StrictKeyAccess](#strictkeyaccess-1)
+  - [RequiredKeys](#requiredkeys)
+- [Dash](#dash)
+  - [Lazy Property Loading](#lazy-property-loading)
+  - [Validations with ActiveModel](#validations-with-activemodel)
+  - [Potential Gotchas](#potential-gotchas)
+  - [PropertyTranslation](#propertytranslation)
+  - [Coercion](#coercion-1)
+  - [PredefinedValues](#predefinedvalues)
+- [Trash](#trash)
+- [Clash](#clash)
+- [Rash](#rash)
+  - [Auto-Optimized](#auto-optimized)
+- [Logging](#logging)
+- [Mascot](#mascot)
+- [Contributing](#contributing)
+- [Copyright](#copyright)
 
 ## Installation
 
+Hashie requires Ruby 3.0 or newer.
+
 Hashie is available as a RubyGem:
 
 ```bash
-$ gem install hashie
+gem install hashie
 ```
 
 ## Stable Release
 
-You're reading the documentation for the stable release of Hashie, 4.1.0.(https://github.com/hashie/hashie/blob/v4.1.0/README.md).
+You're reading the documentation for the stable release of Hashie, 5.2.0.
 
 ## Hash Extensions
 
@@ -26,20 +90,16 @@ The library is broken up into a number of atomically includable Hash extension m
 
 Any of the extensions listed below can be mixed into a class by `include`-ing `Hashie::Extensions::ExtensionName`.
 
-## Logging
-
-Hashie has a built-in logger that you can override. By default, it logs to `STDOUT` but can be replaced by any `Logger` class. The logger is accessible on the Hashie module, as shown below:
-
-```ruby
-# Set the logger to the Rails logger
-Hashie.logger = Rails.logger
-```
+Hashie's extensions and classes can add method-style access to keys ([Mash](#mash)), define allowed properties with defaults and required values ([Dash](#dash)), rename or transform incoming properties ([Trash](#trash)), build nested option hashes through chained calls ([Clash](#clash)), or match keys using regular expressions and ranges ([Rash](#rash)). Use these ready-made classes or mix individual extensions into your own Hash subclass to add only the behavior you need.
 
 ### Coercion
 
-Coercions allow you to set up "coercion rules" based either on the key or the value type to massage data as it's being inserted into the Hash. Key coercions might be used, for example, in lightweight data modeling applications such as an API client:
+Include `Hashie::Extensions::Coercion` to convert values on assignment. Use `coerce_key` to choose a conversion by key, for example when wrapping API data:
 
 ```ruby
+class User < Hashie::Mash
+end
+
 class Tweet < Hash
   include Hashie::Extensions::Coercion
   include Hashie::Extensions::MergeInitializer
@@ -47,9 +107,10 @@ class Tweet < Hash
 end
 
 user_hash = { name: "Bob" }
-Tweet.new(user: user_hash)
-# => automatically calls User.coerce(user_hash) or
-#    User.new(user_hash) if that isn't present.
+tweet = Tweet.new(user: user_hash)
+# Automatically calls User.coerce(user_hash), or User.new(user_hash) if absent.
+tweet[:user].class # => User
+tweet[:user].name # => "Bob"
 ```
 
 Value coercions, on the other hand, will coerce values based on the type of the value being inserted. This is useful if you are trying to build a Hash-like class that is self-propagating.
@@ -66,31 +127,45 @@ class SpecialHash < Hash
     end
   end
 end
+
+hash = SpecialHash.new(child: { name: 'Bob' })
+hash[:child].class # => SpecialHash
+hash[:child][:name] # => 'Bob'
 ```
 
-### Coercing Collections
+#### Coercing Collections
 
 ```ruby
+require 'set'
+
+class User < Hashie::Mash
+end
+
 class Tweet < Hash
   include Hashie::Extensions::Coercion
+  include Hashie::Extensions::MergeInitializer
+  include Hashie::Extensions::MethodAccess
   coerce_key :mentions, Array[User]
   coerce_key :friends, Set[User]
 end
 
 user_hash = { name: "Bob" }
-mentions_hash= [user_hash, user_hash]
+mentions_hash = [user_hash, user_hash]
 friends_hash = [user_hash]
 tweet = Tweet.new(mentions: mentions_hash, friends: friends_hash)
-# => automatically calls User.coerce(user_hash) or
-#    User.new(user_hash) if that isn't present on each element of the array
+# Automatically calls User.coerce(user_hash), or User.new(user_hash) if absent,
+# on each element of the array.
 
 tweet.mentions.map(&:class) # => [User, User]
 tweet.friends.class # => Set
 ```
 
-### Coercing Hashes
+#### Coercing Hashes
 
 ```ruby
+class User < Hashie::Mash
+end
+
 class Relation
   def initialize(string)
     @relation = string
@@ -99,20 +174,22 @@ end
 
 class Tweet < Hash
   include Hashie::Extensions::Coercion
+  include Hashie::Extensions::MergeInitializer
+  include Hashie::Extensions::MethodAccess
   coerce_key :relations, Hash[User => Relation]
 end
 
 user_hash = { name: "Bob" }
-relations_hash= { user_hash => "father", user_hash => "friend" }
+relations_hash = { user_hash => "father", { name: "Alice" } => "friend" }
 tweet = Tweet.new(relations: relations_hash)
 tweet.relations.map { |k,v| [k.class, v.class] } # => [[User, Relation], [User, Relation]]
 tweet.relations.class # => Hash
 
-# => automatically calls User.coerce(user_hash) on each key
-#    and Relation.new on each value since Relation doesn't define the `coerce` class method
+# Automatically calls User.coerce(user_hash) or User.new(user_hash) on each key
+# and Relation.new on each value since Relation doesn't define `coerce`.
 ```
 
-### Coercing Core Types
+#### Coercing Core Types
 
 Hashie handles coercion to the following by using standard conversion methods:
 
@@ -127,19 +204,18 @@ Hashie handles coercion to the following by using standard conversion methods:
 
 **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
+`coerce_value` also supports the supertypes `Integer` and `Numeric`.
 
-Hashie does not have built-in support for coercing boolean values, since Ruby does not have a built-in boolean type or standard method for coercing to a boolean. You can coerce to booleans using a custom proc.
+Hashie does not choose a built-in boolean coercion policy. You can coerce to booleans using a custom proc or an external callable coercer.
 
-### Coercion 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
+  include Hashie::Extensions::MergeInitializer
   coerce_key :retweeted, ->(v) do
     case v
     when String
@@ -151,60 +227,251 @@ class Tweet < Hash
     end
   end
 end
+
+Tweet.new(retweeted: 'yes')[:retweeted] # => true
+Tweet.new(retweeted: 'false')[:retweeted] # => false
 ```
 
-#### A note on circular coercion
+##### Circular Coercion
 
 Since `coerce_key` is a class-level method, you cannot have circular coercion without the use of a proc. For example:
 
+```ruby
+def define_category
+  Class.new(Hash) do
+    include Hashie::Extensions::Coercion
+    include Hashie::Extensions::MergeInitializer
+
+    coerce_key :products, Array[ProductHash]
+  end
+end
+
+begin
+  define_category
+rescue NameError
+  # Expected: NameError, /ProductHash/
+end
+```
+
+This fails with a `NameError` for `ProductHash` because `ProductHash` is not defined at the point that `coerce_key` is happening.
+
+To work around this, you can use a coercion proc. For example, you could do:
+
 ```ruby
 class CategoryHash < Hash
   include Hashie::Extensions::Coercion
   include Hashie::Extensions::MergeInitializer
 
-  coerce_key :products, Array[ProductHash]
+  coerce_key :products, ->(value) do
+    return value.map { |v| ProductHash.new(v) } if value.respond_to?(:map)
+
+    ProductHash.new(value)
+  end
 end
 
 class ProductHash < Hash
   include Hashie::Extensions::Coercion
   include Hashie::Extensions::MergeInitializer
 
-  coerce_key :categories, Array[CategoriesHash]
+  coerce_key :categories, Array[CategoryHash]
 end
+
+category = CategoryHash.new(products: [{ categories: [{}] }])
+category[:products].first.class # => ProductHash
+category[:products].first[:categories].first.class # => CategoryHash
 ```
 
-This will fail with a `NameError` for `CategoryHash::ProductHash` because `ProductHash` is not defined at the point that `coerce_key` is happening for `CategoryHash`.
+#### Nil Values and Defaults
 
-To work around this, you can use a coercion proc. For example, you could do:
+Top-level `nil` values bypass coercion: `coerce_key :description, String` does not turn `nil` into `''`. A coercion rule converts supplied non-nil values; it does not define a default. Use a Dash property default when missing or nil input should become an empty string:
 
 ```ruby
-class CategoryHash < Hash
-  # ...
-  coerce_key :products, ->(value) do
-    return value.map { |v| ProductHash.new(v) } if value.respond_to?(:map)
+class DescriptionParams < Hashie::Dash
+  include Hashie::Extensions::Coercion
 
-    ProductHash.new(value)
-  end
+  property :description, default: ''
+  coerce_key :description, String
+end
+
+params = DescriptionParams.new(description: nil)
+params.description # => ''
+DescriptionParams.new.description # => ''
+DescriptionParams.new(description: 123).description # => '123'
+
+params.description = nil
+params.description # => nil
+params.update_attributes!(description: nil)
+params.description # => ''
+```
+
+Dash initialization and `update_attributes!` apply property defaults to nil values. Direct assignments through a property writer or `[]=` retain nil and do not reapply defaults. These rules also apply to subclasses. Dash already initializes attributes; it does not need `MergeInitializer`.
+
+#### KernelCoercion
+
+By default, `Hashie::Extensions::Coercion` coerces core types using lenient methods like `#to_i` and `#to_f`, which can silently produce undesirable results:
+
+```ruby
+'abcd'.to_f # => 0.0
+```
+
+The `Hashie::Extensions::KernelCoercion` mixin extends `Coercion` to use the stricter `Kernel` methods (e.g. `Kernel#Integer`, `Kernel#Float`) instead, which raise an error for invalid input rather than silently coercing it:
+
+```ruby
+class StrictHash < Hash
+  include Hashie::Extensions::Coercion
+  extend Hashie::Extensions::KernelCoercion
+
+  coerce_key :count, Integer
+end
+
+hash = StrictHash.new
+hash[:count] = '5'
+hash[:count] # => 5
+begin
+  hash[:count] = 'abcd'
+rescue Hashie::CoercionError
+  # Expected: Hashie::CoercionError, /cannot coerce property `:count`/
+end
+```
+
+This applies to `Integer`, `Float`, `Complex`, `Rational` and `String`. There is no strict `Kernel` method equivalent for `Symbol`, so `Symbol` coercion always uses the default, lenient `#to_sym` behavior.
+
+#### Callable Coercion
+
+Coercion also accepts bound methods and other objects responding to `call`. Existing collection and class/module dispatch takes precedence over `call` for non-Proc targets; other callable objects use `call` even if they also expose `coerce` or `new`. Callable coercers work with `coerce_key`, `coerce_value`, collection members, and Dash's `coerce:` property option.
+
+Hashie does not load or depend on external type libraries. The callable determines conversion and validation; no additional output validation or empty-string normalization is applied. Hashie preserves its existing `nil` bypass for top-level assignments, even when the callable would reject `nil`; nested collection members are passed to their coercers. As with existing coercers, `TypeError`, `ArgumentError`, and `NoMethodError` during assignment become `Hashie::CoercionError`; other exceptions propagate unchanged.
+
+#### Coercion with dry-types
+
+Add `dry-types` to your application's Gemfile:
+
+```gemfile
+gem 'dry-types'
+```
+
+Pass a [dry-types](https://dry-rb.org/gems/dry-types/main/) object directly as the coercer:
+
+```ruby
+require 'dry-types'
+require 'hashie'
+
+class Settings < Hashie::Dash
+  include Hashie::Extensions::Dash::Coercion
+
+  property :enabled, coerce: Dry::Types['params.bool']
+end
+
+Settings.new(enabled: 'false').enabled # => false
+Settings.new(enabled: nil).enabled # => nil
+begin
+  Settings.new(enabled: 'unknown')
+rescue Dry::Types::CoercionError
+  # Expected: Dry::Types::CoercionError
+end
+```
+
+The `params.bool` type converts recognized boolean representations and rejects unknown values and empty strings. Use `Dry::Types['strict.bool']` for validation without conversion: it accepts `true` and `false`, but rejects strings such as `'false'`. Top-level `nil` assignments still bypass coercion.
+
+The bypass applies only to top-level assignments, not collection members:
+
+```ruby
+require 'dry-types'
+
+class Flags < Hashie::Dash
+  include Hashie::Extensions::Dash::Coercion
+
+  property :values, coerce: Array[Dry::Types['strict.bool']]
+end
+
+Flags.new(values: nil).values # => nil
+begin
+  Flags.new(values: [true, nil])
+rescue Dry::Types::ConstraintError
+  # Expected: Dry::Types::ConstraintError
+end
+```
+
+#### Coercion with ActiveModel
+
+Add `activemodel` to your application's Gemfile if it is not already provided by Rails:
+
+```gemfile
+gem 'activemodel'
+```
+
+Pass a bound [ActiveModel type](https://api.rubyonrails.org/classes/ActiveModel/Type/Boolean.html) `cast` method as the coercer:
+
+```ruby
+require 'active_model'
+require 'hashie'
+
+class Settings < Hashie::Dash
+  include Hashie::Extensions::Dash::Coercion
+
+  property :enabled, coerce: ActiveModel::Type::Boolean.new.method(:cast)
 end
+
+Settings.new(enabled: 'off').enabled # => false
+Settings.new(enabled: nil).enabled # => nil
+Settings.new(enabled: '').enabled # => nil
+Settings.new(enabled: 'unknown').enabled # => true
 ```
 
+ActiveModel's boolean policy differs from dry-types: it treats an empty string as `nil`, recognized false values as false, and most other values as true. Choose the library whose conversion policy matches your application.
+
 ### 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`](#mash-extension-symbolizekeys).
+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`.
 
 Hashie also has a utility method for converting keys on a Hash without a mixin:
 
 ```ruby
-Hashie.symbolize_keys! hash # => Symbolizes keys of hash.
-Hashie.symbolize_keys hash # => Returns a copy of hash with keys symbolized.
-Hashie.stringify_keys! hash # => Stringifies keys of hash.
-Hashie.stringify_keys hash # => Returns a copy of hash with keys stringified.
+hash = { 'name' => 'Ruby' }
+Hashie.symbolize_keys(hash) # => { name: 'Ruby' }
+hash # => { 'name' => 'Ruby' }
+Hashie.symbolize_keys!(hash) # => { name: 'Ruby' }
+Hashie.stringify_keys(hash) # => { 'name' => 'Ruby' }
+hash # => { name: 'Ruby' }
+Hashie.stringify_keys!(hash) # => { 'name' => 'Ruby' }
 ```
 
 ### MergeInitializer
 
 The MergeInitializer extension simply makes it possible to initialize a Hash subclass with another Hash, giving you a quick short-hand.
 
+### DeepMergeInitializer
+
+The `DeepMergeInitializer` extension initializes a `Hash` subclass from another hash, like `MergeInitializer`, but also converts nested hashes to the same concrete class. This includes hashes inside arrays, even when arrays are nested.
+
+<!-- hashie:example deep-merge-initializer -->
+```ruby
+class MyHash < Hash
+  include Hashie::Extensions::DeepMergeInitializer
+  include Hashie::Extensions::IndifferentAccess
+  include Hashie::Extensions::MethodAccess
+end
+
+hash = MyHash.new(foo: { bar: 1 }, children: [{ name: 'Bob' }])
+hash.foo.bar # => 1
+hash['foo']['bar'] # => 1
+hash.children.first.name # => 'Bob'
+hash.foo.class # => MyHash
+```
+
+Use this extension instead of `MergeInitializer` on plain `Hash` subclasses; Mash already provides recursive conversion, and Dash/Trash have their own property-aware initializers. The subclass must accept the same initializer arguments. Conversion happens only during initialization, not on later assignment or merge, and does not change `MethodAccess` itself.
+
+An optional second argument supplies a default value, including `false`; alternatively, a block supplies a default proc. The same default is passed to every converted hash. As with `Hash`, a non-nil default value cannot be combined with a block.
+
+<!-- hashie:example deep-merge-initializer -->
+```ruby
+hash = MyHash.new({ foo: {} }, false)
+hash[:missing] # => false
+hash.foo[:missing] # => false
+```
+
+Input hashes and arrays are rebuilt without modifying the source; keys and non-container values are retained. Use acyclic input data.
+
 ### MethodAccess
 
 The MethodAccess extension allows you to quickly build method-based reading, writing, and querying into your Hash descendant. It can also be included as individual modules, i.e. `Hashie::Extensions::MethodReader`, `Hashie::Extensions::MethodWriter` and `Hashie::Extensions::MethodQuery`.
@@ -220,6 +487,56 @@ h.abc  # => 'def'
 h.abc? # => true
 ```
 
+### BlockAccess
+
+`Hashie::Extensions::BlockAccess` builds nested hashes using blocks. It works with Hash subclasses, including Mash and Dash, without changing calls made without a block. For a plain Hash subclass, include `MethodAccess` first if you also want method-style readers and writers.
+
+```ruby
+class Configuration < Hash
+  include Hashie::Extensions::MethodAccess
+  include Hashie::Extensions::BlockAccess
+end
+
+config = Configuration.new
+config.author do |author|
+  author.name = 'Michael Bleigh'
+end
+config.author.name #=> 'Michael Bleigh'
+
+config.test(:one) { |one| one.foo = 'bar' }
+config.test(:two) { |two| two.hurp = 'derp' }
+config.test.one.foo  #=> 'bar'
+config.test.two.hurp #=> 'derp'
+```
+
+Include only `BlockAccess` in a Mash subclass; Mash already supplies method access. Bracket calls also accept a block: `config['author'] { |author| author.name = 'Bob' }`. Each call returns the child, not the block's result. Existing hashes are reused; missing children are constructed using the containing hash's class, which must accept no arguments. Existing non-hash values, including `nil` and `false`, raise `TypeError` rather than being overwritten.
+
+Dash properties must be declared, and its constructor and property validations still apply. Real methods (such as `each`) and Mash's `?`, `!`, `=`, and `_` suffixes keep their existing behavior.
+
+### Persistable
+
+`Hashie::Extensions::Persistable` adds opt-in YAML file persistence to classes whose constructors accept a hash. Plain Hash subclasses can include `MergeInitializer` first.
+
+```ruby
+class Configuration < Hashie::Mash
+  include Hashie::Extensions::Persistable
+end
+
+config = Configuration.new(name: 'example')
+config.save('config.yaml') # => File.expand_path('config.yaml')
+loaded = Configuration.load('config.yaml')
+loaded.name # => 'example'
+loaded.name = 'updated'
+loaded.save # writes back to config.yaml
+Configuration.load('config.yaml').name # => 'updated'
+```
+
+`save` returns and remembers the absolute path only after a successful write. It atomically replaces the destination using a temporary file in the same directory, preserves existing file permissions, and creates new files with private permissions. A failed write leaves the remembered path unchanged.
+
+Files contain plain YAML data, not Ruby class tags or persistence metadata. Loading uses `Psych.safe_load`, permits symbols for declared Dash/Trash properties, rejects aliases and non-hash roots, and never evaluates ERB. String and symbol keys retain their types; Dash/Trash files must use keys accepted by their constructors. Nested Hashie classes are not encoded: constructors such as Mash may reconstruct their own nested types, while Dash retains nested plain hashes. Supported values are hashes, arrays, strings, symbols, numbers, booleans, and `nil`; cycles and unsupported objects are rejected.
+
+Including this extension explicitly replaces an inherited class-level `load` on that subclass. Ordinary `Hashie::Mash.load` retains its existing caching and YAML/ERB behavior. No autosave or other serialization formats are provided.
+
 ### 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`.
@@ -269,8 +586,7 @@ This extension can be mixed in to your Hash subclass to allow you to use Strings
 
 In addition, IndifferentAccess will also inject itself into sub-hashes so they behave the same.
 
-Example:
-
+<!-- hashie:example indifferent-access -->
 ```ruby
 class MyHash < Hash
   include Hashie::Extensions::MergeInitializer
@@ -290,12 +606,25 @@ myhash['fishes'][:food] = 'flakes'
 myhash['fishes']['food'] # => "flakes"
 ```
 
+To get back a normal, not-indifferent Hash, you can use `#to_hash` on the indifferent hash. It exports the keys as strings, not symbols:
+
+<!-- hashie:example indifferent-access -->
+```ruby
+myhash = MyHash.new
+myhash["foo"] = "bar"
+myhash[:foo]  #=> "bar"
+
+normal_hash = myhash.to_hash
+normal_hash["foo"]  #=> "bar"
+normal_hash[:foo]  #=> nil
+```
+
 ### IgnoreUndeclared
 
 This extension can be mixed in to silently ignore undeclared properties on initialization instead of raising an error. This is useful when using a Trash to capture a subset of a larger hash.
 
 ```ruby
-class Person < Trash
+class Person < Hashie::Trash
   include Hashie::Extensions::IgnoreUndeclared
   property :first_name
   property :last_name
@@ -311,13 +640,16 @@ p = Person.new(user_data) # 'email' is silently ignored
 
 p.first_name # => 'Freddy'
 p.last_name  # => 'Nostrils'
-p.email      # => NoMethodError
+begin
+  p.email
+rescue NoMethodError
+  # Expected: NoMethodError
+end
 ```
 
 ### DeepMerge
 
-This extension allows you to easily include a recursive merging
-system into any Hash descendant:
+Include `DeepMerge` to merge nested hashes recursively:
 
 ```ruby
 class MyHash < Hash
@@ -341,11 +673,9 @@ end
 h1 = MyHash[{ a: 100, b: 200, c: { c1: 100 } }]
 h2 = MyHash[{ b: 250, c: { c1: 200 } }]
 
-h1.deep_merge(h2) { |key, this_val, other_val| this_val + other_val }
-# => { a: 100, b: 450, c: { c1: 300 } }
+h1.deep_merge(h2) { |key, this_val, other_val| this_val + other_val } # => { a: 100, b: 450, c: { c1: 300 } }
 ```
 
-
 ### DeepFetch
 
 This extension can be mixed in to provide for safe and concise retrieval of deeply nested hash values. In the event that the requested key does not exist a block can be provided and its value will be returned.
@@ -364,7 +694,11 @@ user = {
 user.extend Hashie::Extensions::DeepFetch
 
 user.deep_fetch :name, :first # => 'Bob'
-user.deep_fetch :name, :middle # => 'KeyError: Could not fetch middle'
+begin
+  user.deep_fetch :name, :middle
+rescue Hashie::Extensions::DeepFetch::UndefinedPathError
+  # Expected: Hashie::Extensions::DeepFetch::UndefinedPathError, /could not fetch path .* at `middle`/
+end
 
 # using a default block
 user.deep_fetch(:name, :middle) { |key| 'default' }  # =>  'default'
@@ -399,11 +733,39 @@ user.deep_find_all(:name) #=> [{ first: 'Bob', last: 'Boberts' }, 'Rubyists', 'O
 user.deep_select(:name)   #=> [{ first: 'Bob', last: 'Boberts' }, 'Rubyists', 'Open source enthusiasts']
 ```
 
-### DeepLocate
+### DeepGrep
 
-This extension can be mixed in to provide a depth first search based search for enumerables matching a given comparator callable.
+Search nested hashes and arrays for string or symbol keys and values matching a regular expression. Include `Hashie::Extensions::DeepGrep` to call `deep_grep(pattern)`.
 
-It returns all enumerables which contain at least one element, for which the given comparator returns ```true```.
+```ruby
+class Library < Hash
+  include Hashie::Extensions::DeepGrep
+end
+
+books = Library[
+  'Uncategorized' => [
+    { title: 'Ruby for beginners', pages: 120 },
+    { title: 'CSS for intermediates', pages: 80 }
+  ],
+  'Collection of Ruby books' => [{ title: 'That other language by Matz', pages: 578 }]
+]
+
+matches = [
+  { title: 'Ruby for beginners', pages: 120 },
+  { 'Collection of Ruby books' => [{ title: 'That other language by Matz', pages: 578 }] }
+]
+books.deep_grep(/ruby/i) # => matches
+
+books.deep_grep(/missing/) # => []
+```
+
+For plain hashes or arrays, call `Hashie::Extensions::DeepGrep.deep_grep(pattern, object)` directly.
+
+A matching hash key returns a new one-entry hash containing that key and its original subtree; that subtree is not searched further. A matching scalar hash value returns its containing hash once, preserving sibling context. A matching scalar array element returns just that element, not the whole array. Non-text scalars and container keys are not searched. Results follow depth-first insertion order; shared containers can appear at multiple input locations, and cycles are skipped. Input data is not modified, but returned containers share references with the input.
+
+### DeepLocate
+
+`DeepLocate` searches nested Enumerables depth-first and returns each container with at least one element matching the comparator. The comparator receives the key, value, and containing object.
 
 Because the container objects are returned, the result elements can be modified in place. This way, one can perform modifications on deeply nested hashes without the need to know the exact paths.
 
@@ -431,40 +793,34 @@ books = [
 
 books.extend(Hashie::Extensions::DeepLocate)
 
-# for ruby 1.9 leave *no* space between the lambda rocket and the braces
-# http://ruby-journal.com/becareful-with-space-in-lambda-hash-rocket-syntax-between-ruby-1-dot-9-and-2-dot-0/
-
-books.deep_locate -> (key, value, object) { key == :title && value.include?("Ruby") }
-# => [{:title=>"Ruby for beginners", :pages=>120}, {:title=>"Ruby for the rest of us", :pages=>576}]
+books.deep_locate ->(key, value, _object) { key == :title && value.include?("Ruby") } # => [{:title=>"Ruby for beginners", :pages=>120}, {:title=>"Ruby for the rest of us", :pages=>576}]
 
-books.deep_locate -> (key, value, object) { key == :pages && value <= 120 }
-# => [{:title=>"Ruby for beginners", :pages=>120}, {:title=>"CSS for intermediates", :pages=>80}]
+books.deep_locate ->(key, value, _object) { key == :pages && value <= 120 } # => [{:title=>"Ruby for beginners", :pages=>120}, {:title=>"CSS for intermediates", :pages=>80}]
 ```
 
-## StrictKeyAccess
+Traversal enumerates nested objects, including files and other stateful Enumerables, and can consume their contents. Use this extension only when enumerating every nested Enumerable is safe. A matching comparator does not stop traversal into that container.
 
-This extension can be mixed in to allow a Hash to raise an error when attempting to extract a value using a non-existent key.
+### StrictKeyAccess
 
-### Example:
+This extension can be mixed in to allow a Hash to raise an error when attempting to extract a value using a non-existent key.
 
 ```ruby
 class StrictKeyAccessHash < Hash
   include Hashie::Extensions::StrictKeyAccess
 end
 
->> hash = StrictKeyAccessHash[foo: "bar"]
-=> {:foo=>"bar"}
->> hash[:foo]
-=> "bar"
->> hash[:cow]
-  KeyError: key not found: :cow
+hash = StrictKeyAccessHash[foo: "bar"] # => {:foo=>"bar"}
+hash[:foo] # => "bar"
+begin
+  hash[:cow]
+rescue KeyError
+  # Expected: KeyError, "key not found: :cow"
+end
 ```
 
 ## Mash
 
-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:
+Mash adds method-style access to Hash keys and recursively wraps nested hashes:
 
 ```ruby
 mash = Hashie::Mash.new
@@ -473,39 +829,34 @@ mash.name # => nil
 mash.name = "My Mash"
 mash.name # => "My Mash"
 mash.name? # => true
-mash.inspect # => <Hashie::Mash name="My Mash">
+mash.inspect # => '#<Hashie::Mash name="My Mash">'
 
 mash = Hashie::Mash.new
 # use bang methods for multi-level assignment
 mash.author!.name = "Michael Bleigh"
-mash.author # => <Hashie::Mash name="Michael Bleigh">
+mash.author.to_h # => { 'name' => 'Michael Bleigh' }
 
 mash = Hashie::Mash.new
 # use under-bang methods for multi-level testing
 mash.author_.name? # => false
-mash.inspect # => <Hashie::Mash>
+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.
 
-### How does Mash handle conflicts with pre-existing methods?
-
-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.
+### Method Conflicts
 
-#### Example:
+Mash does not override existing methods. Use brackets to read a key that conflicts with a method name:
 
 ```ruby
 mash = Hashie::Mash.new
 mash.name = "My Mash"
 mash.zip = "Method Override?"
 mash.zip # => [[["name", "My Mash"]], [["zip", "Method Override?"]]]
+mash[:zip] # => 'Method Override?'
 ```
 
-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
-```
+Hashie logs a warning when a key conflicts with an existing method. See [Logging](#logging) to configure the logger.
 
 You can also disable the logging in subclasses of Mash:
 
@@ -513,14 +864,19 @@ You can also disable the logging in subclasses of Mash:
 class Response < Hashie::Mash
   disable_warnings
 end
+
+Response.new(zip: '90210').zip # => [[['zip', '90210']]]
+Response.disable_warnings? # => true
 ```
 
-The default is to disable logging for all methods that conflict. If you would like to only disable the logging for specific methods, you can include an array of method keys:
+To suppress warnings only for specific methods, pass their names to `disable_warnings`:
 
 ```ruby
 class Response < Hashie::Mash
   disable_warnings :zip, :zap
 end
+
+Response.disabled_warnings # => [:zip, :zap]
 ```
 
 This behavior is cumulative. The examples above and below behave identically.
@@ -530,21 +886,29 @@ class Response < Hashie::Mash
   disable_warnings :zip
   disable_warnings :zap
 end
+
+Response.disabled_warnings # => [:zip, :zap]
 ```
 
-Disable warnings will honor the last `disable_warnings` call. Calling without parameters will override the ignored methods list, and calling with parameters will create a new ignored methods list. This includes child classes that inherit from a class that disables warnings.
+Calling `disable_warnings` without arguments suppresses all warnings. A subsequent call with method names replaces that setting with a list of specific exceptions, including in subclasses:
 
 ```ruby
+require 'stringio'
+
 class Message < Hashie::Mash
   disable_warnings :zip, :zap
   disable_warnings
 end
 
-# No errors will be logged
+log = StringIO.new
+Hashie.logger = Logger.new(log)
 Message.new(merge: 'true', compact: true)
+log.string # => ''
 ```
 
 ```ruby
+require 'stringio'
+
 class Message < Hashie::Mash
   disable_warnings
 end
@@ -553,22 +917,31 @@ class Response < Message
   disable_warnings :zip, :zap
 end
 
-# 2 errors will be logged
+log = StringIO.new
+Hashie.logger = Logger.new(log)
 Response.new(merge: 'true', compact: true, zip: '90210', zap: 'electric')
+log.string.lines.size # => 2
+log.string.include?('#merge ') # => true
+log.string.include?('#compact ') # => true
 ```
 
 If you would like to create an anonymous subclass of a Hashie::Mash with key conflict warnings disabled:
 
 ```ruby
-Hashie::Mash.quiet.new(zip: '90210', compact: true) # no errors logged
-Hashie::Mash.quiet(:zip).new(zip: '90210', compact: true) # error logged for compact
+require 'stringio'
+
+log = StringIO.new
+Hashie.logger = Logger.new(log)
+Hashie::Mash.quiet.new(zip: '90210', compact: true)
+log.string # => ''
+Hashie::Mash.quiet(:zip).new(zip: '90210', compact: true)
+log.string.lines.size # => 1
+log.string.include?('#compact ') # => true
 ```
 
-### How does the wrapping of Mash sub-Hashes work?
-
-Mash duplicates any sub-Hashes that you add to it and wraps them in a Mash. This allows for infinite chaining of nested Hashes within a Mash without modifying the object(s) that are passed into the Mash. When you subclass Mash, the subclass wraps any sub-Hashes in its own class. This preserves any extensions that you mixed into the Mash subclass and allows them to work within the sub-Hashes, in addition to the main containing Mash.
+### Nested Hashes
 
-#### Example:
+Mash wraps nested plain hashes in new Mashes without modifying the input. A Mash subclass uses its own class for those nested hashes, preserving the extensions you included:
 
 ```ruby
 mash = Hashie::Mash.new(name: "Hashie", dependencies: { rake: "< 11", rspec: "~> 3.0" })
@@ -579,69 +952,130 @@ my_gem = MyGem.new(name: "Hashie", dependencies: { rake: "< 11", rspec: "~> 3.0"
 my_gem.dependencies.class #=> MyGem
 ```
 
-### What else can Mash do?
+### Key Types
+
+Mash uses string keys for indifferent string/symbol access. Other key types, such as integers, are preserved and accessed with brackets:
+
+```ruby
+Hashie::Mash.new('1' => 'one string', :'1' => 'one sym', 1 => 'one num') # => {"1"=>"one sym", 1=>"one num"}
+```
+
+The symbol `:'1'` and string `'1'` share a key, so the later value wins. The integer `1` remains a separate key.
 
-Mash allows you also to transform any files into a Mash objects.
+### Loading Files
 
-#### Example:
+Use `Mash.load` to read a YAML configuration file:
 
 ```yml
-#/etc/config/settings/twitter.yml
+# 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'
+  api_key: <%= ENV.fetch('HASHIE_README_API_KEY') %> # set to 'abcd' below
 ```
 
+<!-- hashie:example mash-load -->
 ```ruby
-mash = Mash.load('settings/twitter.yml')
-mash.development.api_key # => 'localhost'
-mash.development.api_key = "foo" # => <# RuntimeError can't modify frozen ...>
+require 'fileutils'
+require 'pathname'
+
+FileUtils.mkdir_p('settings')
+File.write('settings/twitter.yml', <<~YAML)
+  development:
+    api_key: 'api_key'
+  production:
+    api_key: <%= ENV.fetch('HASHIE_README_API_KEY') %>
+YAML
+ENV['HASHIE_README_API_KEY'] = 'abcd'
+
+mash = Hashie::Mash.load('settings/twitter.yml')
+mash.development.api_key # => 'api_key'
+begin
+  mash.production = {}
+rescue FrozenError
+  # Expected: FrozenError, /can't modify frozen/
+end
 mash.development.api_key? # => true
+mash.development.api_key = "foo"
+mash.development.api_key # => 'foo'
 ```
 
 You can also load with a `Pathname` object:
 
+<!-- hashie:example mash-load -->
+```ruby
+mash = Hashie::Mash.load(Pathname 'settings/twitter.yml')
+mash.development.api_key # => 'api_key'
+```
+
+The loaded root is frozen, but nested Mashes remain mutable. Repeated loads with the same path object return the cached Mash.
+
+By default, `Mash.load` evaluates ERB before parsing YAML. Only use it with trusted files; `YAML.safe_load` does not make ERB evaluation safe. To parse untrusted or plain YAML without evaluating ERB, explicitly select `YamlParser`:
+
 ```ruby
-mash = Mash.load(Pathname 'settings/twitter.yml')
-mash.development.api_key # => 'localhost'
+File.write('data.yml', "api_key: <%= not_evaluated %>\n")
+mash = Hashie::Mash.load('data.yml', parser: Hashie::Extensions::Parsers::YamlParser)
+mash.api_key # => '<%= not_evaluated %>'
 ```
 
 You can access a Mash from another class:
 
+<!-- hashie:example mash-load -->
 ```ruby
-mash = Mash.load('settings/twitter.yml')[ENV['RACK_ENV']]
+class Twitter
+end
+
+mash = Hashie::Mash.load('settings/twitter.yml')['production']
 Twitter.extend mash.to_module # NOTE: if you want another name than settings, call: to_module('my_settings')
 Twitter.settings.api_key # => 'abcd'
+ENV.delete('HASHIE_README_API_KEY')
 ```
 
-You can use another parser (by default: [YamlErbParser](lib/hashie/extensions/parsers/yaml_erb_parser.rb)):
+You can use another parser (by default: [YamlErbParser](lib/hashie/extensions/parsers/yaml_erb_parser.rb), which evaluates ERB):
 
-```
-#/etc/data/user.csv
-id | name          | lastname
----|------------- | -------------
-1  |John          | Doe
-2  |Laurent       | Garnier
+```text
+# 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' }
+require 'csv'
+require 'fileutils'
+
+class MyCustomCsvParser
+  def self.perform(path, _options = {})
+    CSV.read(path, headers: true).to_h do |row|
+      [row['id'].to_i, { 'name' => row['name'], 'lastname' => row['lastname'] }]
+    end
+  end
+end
+
+FileUtils.mkdir_p('data')
+File.write('data/user.csv', "id,name,lastname\n1,John,Doe\n2,Laurent,Garnier\n")
+mash = Hashie::Mash.load('data/user.csv', parser: MyCustomCsvParser)
+mash.to_h # => { 1 => { 'name' => 'John', 'lastname' => 'Doe' }, 2 => { 'name' => 'Laurent', 'lastname' => 'Garnier' } }
+mash[1].to_h #=> { 'name' => 'John', 'lastname' => 'Doe' }
 ```
 
-The `Mash#load` method calls `YAML.safe_load(path, [], [], true)`.
+Both built-in YAML parsers use `YAML.safe_load`.
 
 Specify `permitted_symbols`, `permitted_classes` and `aliases` options as needed.
 
 ```ruby
-Mash.load('data/user.csv', permitted_classes: [Symbol], permitted_symbols: [], aliases: false)
+File.write('symbols.yml', ":name: Ruby\n")
+mash = Hashie::Mash.load('symbols.yml', permitted_classes: [Symbol], permitted_symbols: [], aliases: false)
+mash.name # => 'Ruby'
 ```
 
-### Mash Extension: KeepOriginalKeys
+### Mash and Rails 4 Strong Parameters
+
+To enable compatibility with Rails 4 use the [hashie-forbidden_attributes](https://github.com/Maxim-Filimonov/hashie-forbidden_attributes) gem.
 
-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.
+### 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 symbol 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
@@ -658,7 +1092,7 @@ mash['string_key']  #=> 'string'
 mash[:string_key]  #=> 'string'
 ```
 
-### Mash Extension: PermissiveRespondTo
+### PermissiveRespondTo
 
 By default, Mash only states that it responds to built-in methods, affixed methods (e.g. setters, underbangs, etc.), and keys that it currently contains. That means it won't state that it responds to a getter for an unset key, as in the following example:
 
@@ -680,28 +1114,70 @@ mash = PermissiveMash.new(a: 1)
 mash.respond_to? :b  #=> true
 ```
 
-This comes at the cost of approximately 20% performance for initialization and setters and 19KB of permanent memory growth for each such class that you create.
+Use this only when the delegator needs to forward reads for keys that have not been set.
 
-### Mash Extension: SafeAssignment
+### 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
-safe_mash[:zip] = 'test' # => still ArgumentError
+begin
+  safe_mash.zip   = 'Test'
+rescue ArgumentError
+  # Expected: ArgumentError, /clashes/
+end
+begin
+  safe_mash[:zip] = 'test'
+rescue ArgumentError
+  # Expected: ArgumentError, /clashes/
+end
+```
+
+### TransformKeys
+
+Include `Hashie::Extensions::Mash::TransformKeys` and configure `transform_keys_with` with a callable or block to normalize string and symbol keys. The transformer receives a string and must return a string; other key types are unchanged.
+
+```ruby
+class LowercaseMash < Hashie::Mash
+  include Hashie::Extensions::Mash::TransformKeys
+  transform_keys_with(&:downcase)
+end
+
+mash = LowercaseMash.new('User' => { 'NAME' => 'Ada' })
+mash.user.name # => 'Ada'
+mash.USER.NAME # => 'Ada'
+```
+
+Normalization applies to reads and writes, including nested Mashes and hashes inside arrays. Subclasses inherit the callable but can replace it without changing their parent or siblings. Without a callable, ordinary Mash key conversion is retained. Configure the transformer before creating instances, keep it free of side effects, and make it idempotent: transforming an already-normalized key must return the same key. When input keys normalize to the same key, the last assignment wins. Transformer exceptions propagate; non-string results raise `TypeError`.
+
+### UnderscoreKeys
+
+Include `Hashie::Extensions::Mash::UnderscoreKeys` to normalize camelCase, PascalCase, and hyphenated keys to lowercase underscore names. It uses `TransformKeys`, including its nested conversion and subclass configuration behavior.
+
+```ruby
+class UnderscoreMash < Hashie::Mash
+  include Hashie::Extensions::Mash::UnderscoreKeys
+end
+
+mash = UnderscoreMash.new('updatedAt' => 'today', 'created-at' => 'tomorrow')
+mash.updatedAt  # => 'today'
+mash.updated_at # => 'today'
+mash.created_at # => 'tomorrow'
+mash.to_h      # => { 'updated_at' => 'today', 'created_at' => 'tomorrow' }
 ```
 
-### Mash Extension: SymbolizeKeys
+Acronym boundaries are split: `HTTPServer` becomes `http_server`, and `GitHub` becomes `git_hub`. There is no acronym registry or ActiveSupport dependency. Spaces and punctuation other than hyphens are retained, so this does not guarantee method-safe names. Non-text keys are unchanged. If keys normalize to the same name, the last assignment wins. Use `transform_keys_with` to replace this policy with custom normalization.
 
-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. It can be useful to use with keywords argument, which required symbol keys.
+### SymbolizeKeys
 
+Include `Hashie::Extensions::Mash::SymbolizeKeys` to store string keys as symbols instead of converting symbols to strings. This is useful when passing a Mash as keyword arguments:
+
+<!-- hashie:example symbolized-mash -->
 ```ruby
 class SymbolizedMash < ::Hashie::Mash
   include Hashie::Extensions::Mash::SymbolizeKeys
@@ -713,27 +1189,27 @@ symbol_mash.test  #=> 'value'
 symbol_mash.to_h  #=> {test: 'value'}
 
 def example(test:)
-  puts test
+  test
 end
 
-example(symbol_mash) #=> value
+example(**symbol_mash) #=> '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:
+Iteration also returns symbol keys:
 
+<!-- hashie:example symbolized-mash -->
 ```ruby
 symbol_mash = SymbolizedMash.new(id: 123, name: 'Rey')
+entries = []
 symbol_mash.each do |key, value|
-  # key is :id, then :name
-  # value is 123, then 'Rey'
+  entries << [key, value]
 end
+entries # => [[:id, 123], [:name, 'Rey']]
 ```
 
-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.
-
-### Mash Extension: DefineAccessors
+### DefineAccessors
 
-This extension can be mixed into a Mash so it makes it behave like `OpenStruct`. It reduces the overhead of `method_missing?` magic by lazily defining field accessors when they're requested.
+Include `Hashie::Extensions::Mash::DefineAccessors` to lazily define readers and writers when first used, reducing repeated dispatch through `method_missing`.
 
 ```ruby
 class MyHash < ::Hashie::Mash
@@ -754,17 +1230,76 @@ You can also extend the existing mash without defining a class:
 
 ```ruby
 mash = ::Hashie::Mash.new.with_accessors!
+mash.foo = 123
+mash.singleton_class.method_defined?(:foo=) # => true
+mash.foo # => 123
+mash.singleton_class.method_defined?(:foo) # => true
+```
+
+### StrictKeyAccess
+
+This extension can be mixed into a Mash to raise a `KeyError` for any key that is not set, instead of returning `nil`. It's aware of Mash's special suffixed methods (`?`, `!`, `_` and `=`), which all continue to work as normal. Since nested Hashes are converted into instances of the same Mash class, this behavior automatically applies to nested Mashes as well.
+
+```ruby
+class StrictMash < Hashie::Mash
+  include Hashie::Extensions::Mash::StrictKeyAccess
+end
+
+mash = StrictMash.new(name: 'Bob', address: { city: 'Springfield' })
+mash.name           #=> 'Bob'
+begin
+  mash.age
+rescue KeyError
+  # Expected: KeyError, 'key not found: `age`'
+end
+
+mash.name?          #=> true
+mash.age?           #=> false
+
+mash.address.city   #=> 'Springfield'
+begin
+  mash.address.postcode
+rescue KeyError
+  # Expected: KeyError, 'key not found: `postcode`'
+end
+```
+
+
+### RequiredKeys
+
+This extension can be mixed into a Mash to require specific keys to be set (non-nil) when constructing an instance, while still allowing arbitrary, undeclared keys to be assigned - unlike `Hashie::Dash`, which only allows setting pre-declared properties.
+
+```ruby
+class PersonMash < ::Hashie::Mash
+  include Hashie::Extensions::Mash::RequiredKeys
+
+  required_keys :name, :email
+end
+
+begin
+  PersonMash.new(email: 'bob@example.com')
+rescue ArgumentError
+  # Expected: ArgumentError, 'the following keys are required: `name`'
+end
+
+person = PersonMash.new(name: 'Bob', email: 'bob@example.com')
+person.age = 42 # arbitrary, undeclared keys are still allowed
+person.age # => 42
 ```
 
 ## 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.
+Dash accepts only declared properties. Use `default:` for initial values, `required: true` to reject missing or nil values, and `message:` to customize a required-property error. A proc assigned as a property's value is evaluated when read; proc defaults are evaluated during initialization.
 
 You can also conditionally require certain properties by passing a Proc or Symbol. If a Proc is provided, it will be run in the context of the Dash instance. If a Symbol is provided, the value returned for the property or method of the same name will be evaluated. The property will be required if the result of the conditional is truthy.
 
-### Example:
-
 ```ruby
+class Genome
+  def self.sequence
+    'GATTACA'
+  end
+end
+
 class Person < Hashie::Dash
   property :name, required: true
   property :age, required: true, message: 'must be set.'
@@ -772,36 +1307,57 @@ class Person < Hashie::Dash
   property :phone, required: -> { email.nil? }, message: 'is required if email is not set.'
   property :pants, required: :weekday?, message: 'are only required on weekdays.'
   property :occupation, default: 'Rubyist'
+  property :genome
 
   def weekday?
     [ Time.now.saturday?, Time.now.sunday? ].none?
   end
 end
 
-p = Person.new # => ArgumentError: The property 'name' is required for this Dash.
-p = Person.new(name: 'Bob') # => ArgumentError: The property 'age' must be set.
+begin
+  p = Person.new
+rescue ArgumentError
+  # Expected: ArgumentError, /the property `name` is required for/
+end
+begin
+  p = Person.new(name: 'Bob')
+rescue ArgumentError
+  # Expected: ArgumentError, "the property `age` must be set."
+end
 
-p = Person.new(name: "Bob", age: 18)
+p = Person.new(name: "Bob", age: 18, email: 'bob@example.com', pants: true)
 p.name         # => 'Bob'
-p.name = nil   # => ArgumentError: The property 'name' is required for this Dash.
+begin
+  p.name = nil
+rescue ArgumentError
+  # Expected: ArgumentError, /the property `name` is required for/
+end
 p.age          # => 18
-p.age = nil    # => ArgumentError: The property 'age' must be set.
+begin
+  p.age = nil
+rescue ArgumentError
+  # Expected: ArgumentError, "the property `age` must be set."
+end
 p.email = 'abc@def.com'
 p.occupation   # => 'Rubyist'
 p.email        # => 'abc@def.com'
-p[:awesome]    # => NoMethodError
+begin
+  p[:awesome]
+rescue NoMethodError
+  # Expected: NoMethodError
+end
 p[:occupation] # => 'Rubyist'
 p.update_attributes!(name: 'Trudy', occupation: 'Evil')
 p.occupation   # => 'Evil'
 p.name         # => 'Trudy'
 p.update_attributes!(occupation: nil)
 p.occupation   # => 'Rubyist'
+p.genome = -> { Genome.sequence } # Some expensive operation
+p.genome       # => 'GATTACA'
 ```
 
 Properties defined as symbols are not the same thing as properties defined as strings.
 
-### Example:
-
 ```ruby
 class Tricky < Hashie::Dash
   property :trick
@@ -809,12 +1365,12 @@ class Tricky < Hashie::Dash
 end
 
 p = Tricky.new(trick: 'one', 'trick' => 'two')
-p.trick # => 'one', always symbol version
+p.trick # => 'two'
 p[:trick] # => 'one'
 p['trick'] # => 'two'
 ```
 
-Note that accessing a property as a method always uses the symbol version.
+Bracket access distinguishes symbol and string properties. When both declarations generate the same method name, the last declaration supplies the method accessor.
 
 ```ruby
 class Tricky < Hashie::Dash
@@ -822,13 +1378,122 @@ class Tricky < Hashie::Dash
 end
 
 p = Tricky.new('trick' => 'two')
-p.trick # => NoMethodError
+p.trick # => 'two'
 ```
 
-### Potential gotchas
+If you would like to update a Dash and use any default values set in the case of a `nil` value, use `#update_attributes!`.
 
-Because Dashes are subclasses of the built-in Ruby Hash class, the double-splat operator takes the Dash as-is without any conversion. This can lead to strange behavior when you use the double-splat operator on a Dash as the first part of a keyword list or built Hash. For example:
+```ruby
+class WithDefaults < Hashie::Dash
+  property :description, default: 'none'
+end
+
+dash = WithDefaults.new
+dash.description  #=> 'none'
+
+dash.description = 'You committed one of the classic blunders!'
+dash.description  #=> 'You committed one of the classic blunders!'
 
+dash.description = nil
+dash.description  #=> nil
+
+dash.description = 'Only slightly less known is ...'
+dash.update_attributes!(description: nil)
+dash.description  #=> 'none'
+```
+
+The names `required` and `required?` can themselves be used as properties, for example when modeling a Swagger parameter. Their values are independent of Dash's `required: true` declaration option; `false` is a valid non-nil value even for a required property.
+
+```ruby
+class SwaggerParameter < Hashie::Dash
+  property :name, required: true
+  property :required, default: false
+  property :required?
+end
+
+parameter = SwaggerParameter.new(name: 'limit', required: true, required?: false)
+parameter.required # => true
+parameter.required? # => false
+parameter.required = false
+parameter[:required] # => false
+SwaggerParameter.required?(:name) # => true
+SwaggerParameter.required?(:required) # => false
+```
+
+### Lazy Property Loading
+
+Include `Hashie::Extensions::Dash::Lazy` after other Dash extensions to load properties on demand. The initializer block receives an input key and runs only when that property is first read. Results are cached, including `nil` and `false`; other properties remain unloaded.
+
+```ruby
+class LazyPerson < Hashie::Trash
+  include Hashie::Extensions::Dash::Coercion
+  include Hashie::Extensions::Dash::Lazy
+
+  property :name, from: :fullName, required: true
+  property :age, coerce: Integer
+end
+
+source = { fullName: 'Ada', age: '37' }
+person = LazyPerson.new do |key|
+  # Fetch this property from an expensive source, such as a remote API.
+  source[key]
+end
+
+person.name # => 'Ada' (loads :fullName)
+person.name # => 'Ada' (cached)
+person.age # => 37 (loads :age)
+```
+
+The loader can query XML or another source instead of a hash. With Trash, it receives the original input key (`:fullName` above); transformations and coercion run only for the property being read. Nested objects need their own loaders to remain lazy.
+
+Return `nil` for missing input to use the property's default. Defaults and required-property checks run on access, not construction; conditional requirements may load other properties. Errors propagate without caching the failed load, and circular dependencies raise `ArgumentError`.
+
+On these classes, the initializer block is a property loader, not a Hash default block. Without a block, initialization remains eager. Initial attributes take precedence over the loader, with canonical keys preferred over translated keys. Assignment overrides a pending load and validates normally.
+
+Getters, `[]`, `fetch`, and `dig` load individual properties. `to_h`, `to_hash`, and `freeze` load all declared properties. Other Hash operations, including enumeration and inspection, see only loaded entries. Synchronize concurrent access externally.
+
+### Validations with ActiveModel
+
+Include [ActiveModel::Validations](https://api.rubyonrails.org/classes/ActiveModel/Validations.html) in a Dash subclass to validate property values with standard validators or custom `validate` methods. Add `gem 'activemodel'` to your application's Gemfile unless Rails already provides it; ActiveModel is optional and is not a Hashie runtime dependency.
+
+```ruby
+require 'logger'
+require 'active_model'
+require 'hashie'
+
+class Article < Hashie::Dash
+  include ActiveModel::Validations
+
+  property :title, required: true
+
+  validates :title, presence: true, length: { maximum: 15 }
+end
+
+article = Article.new(title: 'Hello')
+article.valid? # => true
+
+article.title = 'A title that is too long' # assignment succeeds
+article.valid? # => false
+article.errors[:title] # => ["is too long (maximum is 15 characters)"]
+
+article.title = ''
+article.valid? # => false
+article.errors[:title] # => ["can't be blank"]
+
+article.title = 'Short title'
+article.valid? # => true
+article.errors.empty? # => true
+```
+
+Call `valid?` explicitly after constructing or changing the Dash. Including `ActiveModel::Validations` does not automatically validate on initialization or assignment, reject invalid values, or roll back changes; `valid?` returns a boolean and populates `errors`.
+
+Dash's `required: true` is a separate non-nil constraint: omitting `title` during initialization or assigning `nil` raises `ArgumentError` immediately, without calling `valid?`. It permits an empty string, whereas ActiveModel's `presence` validator reports blank values when `valid?` runs. Leave off `required: true` if missing or nil values should be collected as validation errors instead of raising.
+
+### Potential Gotchas
+
+Because Dashes are subclasses of the built-in Ruby Hash class, older Ruby versions could preserve the Dash subclass when using it as the first double-splat in a hash literal. The additional keys then existed without declared properties, and property access could raise `NoMethodError`. On Ruby 3.3 and newer the resulting object is a plain Hash:
+
+<!-- hashie:example dash-double-splat -->
 ```ruby
 class Foo < Hashie::Dash
   property :bar
@@ -836,17 +1501,17 @@ end
 
 foo = Foo.new(bar: 'baz')      #=> {:bar=>"baz"}
 qux = { **foo, quux: 'corge' } #=> {:bar=> "baz", :quux=>"corge"}
-qux.is_a?(Foo)                 #=> true
-qux[:quux]
-#=> raise NoMethodError, "The property 'quux' is not defined for Foo."
+qux.is_a?(Foo)                 #=> false
+qux[:quux] #=> 'corge'
 qux.key?(:quux) #=> true
 ```
 
-You can work around this problem in two ways:
+For code that also targets older Rubies, you can avoid preserving the subclass in two ways:
 
 1. Call `#to_h` on the resulting object to convert it into a Hash.
 2. Use the double-splat operator on the Dash as the last argument in the Hash literal. This will cause the resulting object to be a Hash instead of a Dash, thereby circumventing the problem.
 
+<!-- hashie:example dash-double-splat -->
 ```ruby
 qux = { **foo, quux: 'corge' }.to_h #=> {:bar=> "baz", :quux=>"corge"}
 qux.is_a?(Hash)                     #=> true
@@ -857,16 +1522,9 @@ qux.is_a?(Hash)                #=> true
 qux[:quux]                     #=> "corge"
 ```
 
-### Dash Extension: PropertyTranslation
-
-The `Hashie::Extensions::Dash::PropertyTranslation` mixin extends a Dash with
-the ability to remap keys from a source hash.
-
-### Example from inconsistent APIs
+### PropertyTranslation
 
-Property translation is useful when you need to read data from another
-application -- such as a Java API -- where the keys are named differently from
-Ruby conventions.
+Include `Hashie::Extensions::Dash::PropertyTranslation` to map incoming keys to declared properties, for example when an API uses different naming conventions:
 
 ```ruby
 class PersonHash < Hashie::Dash
@@ -880,15 +1538,14 @@ end
 
 person = PersonHash.new(firstName: 'Michael', l_name: 'Bleigh')
 person[:first_name]  #=> 'Michael'
-person[:last_name]   #=> 'Bleigh
+person[:last_name]   #=> 'Bleigh'
 ```
 
-### Example using translation lambdas
-
-You can also use a lambda to translate the value. This is particularly useful
-when you want to ensure the type of data you're wrapping.
+Use a lambda to transform an incoming value:
 
 ```ruby
+require 'time'
+
 class DataModelHash < Hashie::Dash
   include Hashie::Extensions::Dash::PropertyTranslation
 
@@ -897,23 +1554,19 @@ class DataModelHash < Hashie::Dash
 end
 
 model = DataModelHash.new(id: '123', created: '2014-04-25 22:35:28')
-model.id.class          #=> Integer (Fixnum if you are using Ruby 2.3 or lower)
+model.id.class          #=> Integer
 model.created_at.class  #=> Time
 ```
 
-### Mash and Rails 4 Strong Parameters
-
-To enable compatibility with Rails 4 use the [hashie-forbidden_attributes](https://github.com/Maxim-Filimonov/hashie-forbidden_attributes) gem.
-
-### Dash Extension: Coercion.
+### Coercion
 
-If you want to use `Hashie::Extensions::Coercion` together with `Dash` then
-you may probably want to use `Hashie::Extensions::Dash::Coercion` instead.
-This extension automatically includes `Hashie::Extensions::Coercion`
-and also adds a convenient `:coerce` option to `property` so you can define coercion in one line
-instead of using `property` and `coerce_key` separate:
+Use `Hashie::Extensions::Dash::Coercion` to declare coercion rules with `property ..., coerce:`. It includes the general `Coercion` extension and replaces separate `property` and `coerce_key` declarations:
 
 ```ruby
+class PostHash < Hashie::Dash
+  property :title
+end
+
 class UserHash < Hashie::Dash
   include Hashie::Extensions::Coercion
 
@@ -922,40 +1575,71 @@ class UserHash < Hashie::Dash
 
   coerce_key :posts, Array[PostHash]
 end
+
+UserHash.new(posts: [{ title: 'Hello' }]).posts.first.title # => 'Hello'
 ```
 
 This is the same as:
 
 ```ruby
+class PostHash < Hashie::Dash
+  property :title
+end
+
 class UserHash < Hashie::Dash
   include Hashie::Extensions::Dash::Coercion
 
   property :id
   property :posts, coerce: Array[PostHash]
 end
+
+UserHash.new(posts: [{ title: 'Hello' }]).posts.first.title # => 'Hello'
+```
+
+### PredefinedValues
+
+The `Hashie::Extensions::Dash::PredefinedValues` mixin extends a Dash with the ability to accept predefined values on a property.
+
+```ruby
+class UserHash < Hashie::Dash
+  include Hashie::Extensions::Dash::PredefinedValues
+
+  property :gender, values: %i[male female prefer_not_to_say]
+  property :age, values: (0..150)
+end
+
+UserHash.new(gender: :male, age: 42).age # => 42
+begin
+  UserHash.new(age: -1)
+rescue ArgumentError
+  # Expected: ArgumentError, /value `-1` is not allowed for `age`/
+end
 ```
 
 ## Trash
 
-A Trash is a Dash that allows you to translate keys on initialization. It mixes
-in the PropertyTranslation mixin by default and is used like so:
+A Trash is a Dash that allows you to translate keys on initialization. It mixes in the PropertyTranslation mixin by default and is used like so:
 
+<!-- hashie:example trash -->
 ```ruby
 class Person < Hashie::Trash
   property :first_name, from: :firstName
 end
 ```
 
-This will automatically translate the <tt>firstName</tt> key to <tt>first_name</tt>
-when it is initialized using a hash such as through:
+This will automatically translate the `firstName` key to `first_name` when it is initialized using a hash such as through:
 
+<!-- hashie:example trash -->
 ```ruby
-Person.new(firstName: 'Bob')
+Person.new(firstName: 'Bob').first_name # => 'Bob'
 ```
 
 Trash also supports translations using lambda, this could be useful when dealing with external API's. You can use it in this way:
 
+<!-- hashie:example trash-result -->
 ```ruby
+require 'time'
+
 class Result < Hashie::Trash
   property :id, transform_with: lambda { |v| v.to_i }
   property :created_at, from: :creation_date, with: lambda { |v| Time.parse(v) }
@@ -964,20 +1648,35 @@ end
 
 this will produce the following
 
+<!-- hashie:example trash-result -->
 ```ruby
 result = Result.new(id: '123', creation_date: '2012-03-30 17:23:28')
-result.id.class         # => Integer (Fixnum if you are using Ruby 2.3 or lower)
+result.id.class         # => Integer
 result.created_at.class # => Time
 ```
 
+Multiple properties can share a source key to flatten a nested hash. Combine indifferent access with `IgnoreUndeclared` to accept string or symbol input keys and ignore unrelated fields:
+
+```ruby
+class FlattenedPerson < Hashie::Trash
+  include Hashie::Extensions::IgnoreUndeclared
+  include Hashie::Extensions::IndifferentAccess
+
+  property :first_name, from: :name, transform_with: ->(name) { name['first'] }
+  property :last_name, from: :name, transform_with: ->(name) { name['last'] }
+end
+
+person = FlattenedPerson.new('name' => { 'first' => 'First', 'last' => 'Last' }, 'extra' => true)
+person.first_name # => 'First'
+person.last_name  # => 'Last'
+```
+
 ## Clash
 
 Clash is a Chainable Lazy Hash that allows you to easily construct complex hashes using method notation chaining. This will allow you to use a more action-oriented approach to building options hashes.
 
 Essentially, a Clash is a generalized way to provide much of the same kind of "chainability" that libraries like Arel or Rails 2.x's named_scopes provide.
 
-### Example:
-
 ```ruby
 c = Hashie::Clash.new
 c.where(abc: 'def').order(:created_at)
@@ -995,6 +1694,8 @@ c.where(abc: 'def').where(hgi: 123)
 c # => { where: { abc: 'def', hgi: 123 } }
 ```
 
+Clash supports YAML and Marshal round-trips, preserving stored data, named subclasses, and parent links used by `_end!`. Only deserialize trusted data. YAML requires Ruby object loading enabled (`Psych.unsafe_load` on modern Psych); ordinary safe loading does not permit arbitrary Ruby classes.
+
 ## Rash
 
 Rash is a Hash whose keys can be Regexps or Ranges, which will map many input keys to a value.
@@ -1003,12 +1704,10 @@ A good use case for the Rash is an URL router for a web framework, where URLs ne
 
 If the Rash's value is a `proc`, the `proc` will be automatically called with the regexp's MatchData (matched groups) as a block argument.
 
-### Example:
-
 ```ruby
 
 # Mapping names to appropriate greetings
-greeting = Hashie::Rash.new( /^Mr./ => "Hello sir!", /^Mrs./ => "Evening, madame." )
+greeting = Hashie::Rash.new( /^Mr\./ => "Hello sir!", /^Mrs\./ => "Evening, madame." )
 greeting["Mr. Steve Austin"] # => "Hello sir!"
 greeting["Mrs. Steve Austin"] # => "Evening, madame."
 
@@ -1021,18 +1720,34 @@ mapper["I like traffic lights"] # => "Who DOESN'T like traffic lights?!"
 mapper["Get off my lawn!"]      # => "Forget your lawn, old man!"
 ```
 
-### Auto-optimized
+### Auto-Optimized
 
 **Note:** The Rash is automatically optimized every 500 accesses (which means that it sorts the list of Regexps, putting the most frequently matched ones at the beginning).
 
 If this value is too low or too high for your needs, you can tune it by setting: `rash.optimize_every = n`.
 
+## Logging
+
+Hashie logs to `STDOUT` by default. Assign `Hashie.logger` to use your application's logger:
+
+```ruby
+require 'logger'
+require 'hashie'
+
+Hashie.logger = Logger.new($stdout)
+```
+
+In Rails, use `Hashie.logger = Rails.logger`; Hashie's Railtie sets this automatically during application initialization.
+
+## Mascot
+[![eierlegende Wollmilchsau](./mascot.svg)](https://en.wiktionary.org/wiki/eierlegende_Wollmilchsau) Meet Hashie's "official" mascot, the [eierlegende Wollmilchsau](https://en.wiktionary.org/wiki/eierlegende_Wollmilchsau)!
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md)
 
 ## Copyright
 
-Copyright (c) 2009-2014 Intridea, Inc. (http://intridea.com/) and [contributors](https://github.com/hashie/hashie/graphs/contributors).
+Copyright (c) 2009-2020 [Intridea, Inc.](http://intridea.com), and [contributors](https://github.com/hashie/hashie/graphs/contributors).
 
 MIT License. See [LICENSE](LICENSE) for details.