class Hashie::Mash
Mash
allows you to create pseudo-objects that have method-like accessors for hash keys. This is useful for such implementations as an API-accessing library that wants to fake robust objects without the overhead of actually doing so. Think of it as OpenStruct with some additional goodies.
A Mash
will look at the methods you pass it and perform operations based on the following rules:
-
No punctuation: Returns the value of the hash for that key, or nil if none exists.
-
Assignment (
=
): Sets the attribute of the given method name. -
Truthiness (
?
): Returns true or false depending on the truthiness of the attribute, or false if the key is not set. -
Bang (
!
): Forces the existence of this key, used for deep Mashes. Think of it as “touch” for mashes. -
Under Bang (
_
): Like Bang, but returns a newMash
rather than creating a key. Used to test existance in deep Mashes.
Basic Example¶ ↑
mash = Mash.new mash.name? # => false mash.name = "Bob" mash.name # => "Bob" mash.name? # => true
Hash
Conversion Example¶ ↑
hash = {:a => {:b => 23, :d => {:e => "abc"}}, :f => [{:g => 44, :h => 29}, 12]} mash = Mash.new(hash) mash.a.b # => 23 mash.a.d.e # => "abc" mash.f.first.g # => 44 mash.f.last # => 12
Bang Example¶ ↑
mash = Mash.new mash.author # => nil mash.author! # => <Mash> mash = Mash.new mash.author!.name = "Michael Bleigh" mash.author # => <Mash name="Michael Bleigh">
Under Bang Example¶ ↑
mash = Mash.new mash.author # => nil mash.author_ # => <Mash> mash.author_.name # => nil mash = Mash.new mash.author_.name = "Michael Bleigh" (assigned to temp object) mash.author # => <Mash>
Constants
- ALLOWED_SUFFIXES
Public Class Methods
Source
# File lib/hashie/mash.rb, line 70 def self.load(path, options = {}) @_mashes ||= new return @_mashes[path] if @_mashes.key?(path) raise ArgumentError, "The following file doesn't exist: #{path}" unless File.file?(path) options = options.dup parser = options.delete(:parser) { Hashie::Extensions::Parsers::YamlErbParser } @_mashes[path] = new(parser.perform(path, options)).freeze end
Source
# File lib/hashie/mash.rb, line 100 def initialize(source_hash = nil, default = nil, &blk) deep_update(source_hash) if source_hash default ? super(default) : super(&blk) end
If you pass in an existing hash, it will convert it to a Mash
including recursively descending into arrays and hashes, converting them as well.
Source
# File lib/hashie/mash.rb, line 111 def self.quiet(*method_keys) @memoized_classes ||= {} @memoized_classes[method_keys] ||= Class.new(self) do disable_warnings(*method_keys) end end
Creates a new anonymous subclass with key conflict warnings disabled. You may pass an array of method symbols to restrict the disabled warnings to. Hashie::Mash.quiet
.new(hash) all warnings disabled. Hashie::Mash.quiet
(:zip).new(hash) only zip warning is disabled.
Public Instance Methods
Source
# File lib/hashie/mash.rb, line 259 def assign_property(name, value) self[name] = value end
Assigns a value to a key
Source
# File lib/hashie/mash.rb, line 338 def compact self.class.new(super) end
Returns a new instance of the class it was called on, with nil values removed.
Source
# File lib/hashie/mash.rb, line 125 def custom_reader(key) default_proc.call(self, key) if default_proc && !key?(key) value = regular_reader(convert_key(key)) yield value if block_given? value end
Retrieves an attribute set in the Mash
. Will convert a key passed in as a symbol to a string before retrieving.
Source
# File lib/hashie/mash.rb, line 210 def deep_merge(*other_hashes, &blk) dup.deep_update(*other_hashes, &blk) end
Performs a deep_update
on a duplicate of the current mash.
Source
# File lib/hashie/mash.rb, line 216 def deep_update(*other_hashes, &blk) other_hashes.each do |other_hash| _deep_update(other_hash, &blk) end self end
Recursively merges this mash with the passed in hash, merging each hash in the hierarchy.
Source
# File lib/hashie/mash.rb, line 166 def delete(key) super(convert_key(key)) end
Source
# File lib/hashie/mash.rb, line 326 def dig(*keys) super(*keys.map { |key| convert_key(key) }) end
Source
# File lib/hashie/mash.rb, line 195 def dup self.class.new(self, default, &default_proc) end
Duplicates the current mash as a new mash.
Source
# File lib/hashie/mash.rb, line 355 def except(*keys) string_keys = keys.map { |key| convert_key(key) } self.class.new(super(*string_keys)) end
Source
# File lib/hashie/mash.rb, line 316 def extractable_options? true end
play nice with ActiveSupport Array#extract_options!
Source
# File lib/hashie/mash.rb, line 162 def fetch(key, *args) super(convert_key(key), *args) end
Source
# File lib/hashie/mash.rb, line 145 def initializing_reader(key) ck = convert_key(key) regular_writer(ck, self.class.new) unless key?(ck) regular_reader(ck) end
This is the bang method reader, it will return a new Mash
if there isn’t a value already assigned to the key requested.
Source
# File lib/hashie/mash.rb, line 177 def invert self.class.new(super) end
Returns a new instance of the class it was called on, using its keys as values, and its values as keys. The new values and keys will always be strings.
Source
# File lib/hashie/mash.rb, line 200 def key?(key) super(convert_key(key)) end
Alias these lexically so they get the correctly defined deep_merge
and deep_update
based on ruby version.
Source
# File lib/hashie/mash.rb, line 298 def method_missing(method_name, *args, &blk) # rubocop:disable Style/MethodMissing return self.[](method_name, &blk) if key?(method_name) name, suffix = method_name_and_suffix(method_name) case suffix when '='.freeze assign_property(name, args.first) when '?'.freeze !!self[name] when '!'.freeze initializing_reader(name) when '_'.freeze underbang_reader(name) else self[method_name] end end
Source
# File lib/hashie/mash.rb, line 293 def prefix_method?(method_name) method_name = method_name.to_s method_name.end_with?(*ALLOWED_SUFFIXES) && key?(method_name.chop) end
Source
# File lib/hashie/mash.rb, line 183 def reject(&blk) self.class.new(super(&blk)) end
Returns a new instance of the class it was called on, containing elements for which the given block returns false.
Source
# File lib/hashie/mash.rb, line 277 def replace(other_hash) (keys - other_hash.keys).each { |key| delete(key) } other_hash.each { |key, value| self[key] = value } self end
Source
# File lib/hashie/mash.rb, line 283 def respond_to_missing?(method_name, *args) return true if key?(method_name) suffix = method_suffix(method_name) if suffix true else super end end
Source
# File lib/hashie/mash.rb, line 321 def reverse_merge(other_hash) self.class.new(other_hash).merge(self) end
another ActiveSupport method, see issue #270
Source
# File lib/hashie/mash.rb, line 189 def select(&blk) self.class.new(super(&blk)) end
Returns a new instance of the class it was called on, containing elements for which the given block returns true.
Source
# File lib/hashie/mash.rb, line 264 def shallow_merge(other_hash) dup.shallow_update(other_hash) end
Performs a shallow_update
on a duplicate of the current mash
Source
# File lib/hashie/mash.rb, line 270 def shallow_update(other_hash) other_hash.each_pair do |k, v| regular_writer(convert_key(k), convert_value(v, true)) end self end
Merges (non-recursively) the hash from the argument, changing the receiving hash
Source
# File lib/hashie/mash.rb, line 344 def slice(*keys) string_keys = keys.map { |key| convert_key(key) } self.class.new(super(*string_keys)) end
Source
# File lib/hashie/mash.rb, line 81 def to_module(mash_method_name = :settings) mash = self Module.new do |m| m.send :define_method, mash_method_name.to_sym do mash end end end
Source
# File lib/hashie/mash.rb, line 349 def transform_keys(&blk) self.class.new(super(&blk)) end
Source
# File lib/hashie/mash.rb, line 332 def transform_values(&blk) self.class.new(super(&blk)) end
Source
# File lib/hashie/mash.rb, line 153 def underbang_reader(key) ck = convert_key(key) if key?(ck) regular_reader(ck) else self.class.new end end
This is the under bang method reader, it will return a temporary new Mash
if there isn’t a value already assigned to the key requested.
Source
# File lib/hashie/mash.rb, line 170 def values_at(*keys) super(*keys.map { |key| convert_key(key) }) end
Source
# File lib/hashie/mash.rb, line 90 def with_accessors! extend Hashie::Extensions::Mash::DefineAccessors end
Protected Instance Methods
Source
# File lib/hashie/mash.rb, line 363 def method_name_and_suffix(method_name) method_name = method_name.to_s if method_name.end_with?(*ALLOWED_SUFFIXES) [method_name[0..-2], method_name[-1]] else [method_name[0..-1], nil] end end
Source
# File lib/hashie/mash.rb, line 372 def method_suffix(method_name) method_name = method_name.to_s method_name[-1] if method_name.end_with?(*ALLOWED_SUFFIXES) end
Private Instance Methods
Source
# File lib/hashie/mash.rb, line 244 def _deep_update(other_hash, &blk) other_hash.each_pair do |k, v| key = convert_key(k) if v.is_a?(::Hash) && key?(key) && regular_reader(key).is_a?(Mash) custom_reader(key).deep_update(v, &blk) else value = convert_value(v, true) value = convert_value(yield(key, self[k], value), true) if blk && key?(k) custom_writer(key, value, false) end end end
Source
# File lib/hashie/mash.rb, line 399 def log_built_in_message(method_key) return if self.class.disable_warnings?(method_key) method_information = Hashie::Utils.method_information(method(method_key)) Hashie.logger.warn( 'You are setting a key that conflicts with a built-in method ' \ "#{self.class}##{method_key} #{method_information}. " \ 'This can cause unexpected behavior when accessing the key as a ' \ 'property. You can still access the key via the #[] method.' ) end
Source
# File lib/hashie/mash.rb, line 412 def log_collision?(method_key) return unless method_key.is_a?(String) || method_key.is_a?(Symbol) return unless respond_to?(method_key) _, suffix = method_name_and_suffix(method_key) (!suffix || suffix == '='.freeze) && !self.class.disable_warnings?(method_key) && !(regular_key?(method_key) || regular_key?(method_key.to_s)) end