Class: Hashie::Mash

Inherits:
Hash
  • Object
show all
Includes:
Extensions::PrettyInspect
Defined in:
lib/hashie/mash.rb

Overview

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.
  • Existence (?): Returns true or false depending on whether that key has been 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 new Mash 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 = => {:b => 23, :d => {:e => "abc"}, :f => [=> 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.new mash.author!.name = "Michael Bleigh" mash.author # =>

== Under Bang Example

mash = Mash.new mash.author # => nil mash.author_ # => mash.author_.name # => nil

mash = Mash.new mash.author_.name = "Michael Bleigh" (assigned to temp object) mash.author # =>

Constant Summary

ALLOWED_SUFFIXES =
%w(? ! = _)
SUFFIXES_PARSER =
/(.*?)([#{ALLOWED_SUFFIXES.join}]?)$/

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Extensions::PrettyInspect

#hashie_inspect, included

Methods inherited from Hash

#to_hash, #to_json, #to_mash

Methods included from Extensions::StringifyKeys

#stringify_keys, #stringify_keys!

Methods included from Extensions::StringifyKeys::ClassMethods

#stringify_keys, #stringify_keys!, #stringify_keys_recursively!

Constructor Details

#initialize(source_hash = nil, default = nil, &blk) ⇒ Mash

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.



88
89
90
91
# File 'lib/hashie/mash.rb', line 88

def initialize(source_hash = nil, default = nil, &blk)
  deep_update(source_hash) if source_hash
  default ? super(default) : super(&blk)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args, &blk) ⇒ Object



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/hashie/mash.rb', line 236

def method_missing(method_name, *args, &blk)
  return self.[](method_name, &blk) if key?(method_name)
  name, suffix = method_suffix(method_name)
  case suffix
  when '='
    assign_property(name, args.first)
  when '?'
    !!self[name]
  when '!'
    initializing_reader(name)
  when '_'
    underbang_reader(name)
  else
    self[method_name]
  end
end

Class Method Details

.load(path, options = {}) ⇒ Object



63
64
65
66
67
68
69
70
71
# File 'lib/hashie/mash.rb', line 63

def self.load(path, options = {})
  @_mashes ||= new

  return @_mashes[path] if @_mashes.key?(path)
  fail ArgumentError, "The following file doesn't exist: #{path}" unless File.file?(path)

  parser = options.fetch(:parser) {  Hashie::Extensions::Parsers::YamlErbParser }
  @_mashes[path] = new(parser.perform(path)).freeze
end

Instance Method Details

#assign_property(name, value) ⇒ Object

Assigns a value to a key



196
197
198
# File 'lib/hashie/mash.rb', line 196

def assign_property(name, value)
  self[name] = value
end

#custom_reader(key) {|value| ... } ⇒ Object Also known as: []

Retrieves an attribute set in the Mash. Will convert any key passed in to a string before retrieving.

Yields:

  • (value)


108
109
110
111
112
113
# File 'lib/hashie/mash.rb', line 108

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

#custom_writer(key, value, convert = true) ⇒ Object Also known as: []=

Sets an attribute in the Mash. Key will be converted to a string before it is set, and Hashes will be converted into Mashes for nesting purposes.



118
119
120
# File 'lib/hashie/mash.rb', line 118

def custom_writer(key, value, convert = true) #:nodoc:
  regular_writer(convert_key(key), convert ? convert_value(value) : value)
end

#deep_merge(other_hash, &blk) ⇒ Object Also known as: merge

Performs a deep_update on a duplicate of the current mash.



171
172
173
# File 'lib/hashie/mash.rb', line 171

def deep_merge(other_hash, &blk)
  dup.deep_update(other_hash, &blk)
end

#deep_update(other_hash, &blk) ⇒ Object Also known as: deep_merge!, update

Recursively merges this mash with the passed in hash, merging each hash in the hierarchy.



178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/hashie/mash.rb', line 178

def deep_update(other_hash, &blk)
  other_hash.each_pair do |k, v|
    key = convert_key(k)
    if regular_reader(key).is_a?(Mash) && v.is_a?(::Hash)
      custom_reader(key).deep_update(v, &blk)
    else
      value = convert_value(v, true)
      value = convert_value(blk.call(key, self[k], value), true) if blk && self.key?(k)
      custom_writer(key, value, false)
    end
  end
  self
end

#delete(key) ⇒ Object



148
149
150
# File 'lib/hashie/mash.rb', line 148

def delete(key)
  super(convert_key(key))
end

#dupObject

Duplicates the current mash as a new mash.



158
159
160
# File 'lib/hashie/mash.rb', line 158

def dup
  self.class.new(self, default)
end

#extractable_options?Boolean

play nice with ActiveSupport Array#extract_options!

Returns:

  • (Boolean)


254
255
256
# File 'lib/hashie/mash.rb', line 254

def extractable_options?
  true
end

#fetch(key, *args) ⇒ Object



144
145
146
# File 'lib/hashie/mash.rb', line 144

def fetch(key, *args)
  super(convert_key(key), *args)
end

#idObject

:nodoc:



95
96
97
# File 'lib/hashie/mash.rb', line 95

def id #:nodoc:
  self['id']
end

#initializing_reader(key) ⇒ Object

This is the bang method reader, it will return a new Mash if there isn't a value already assigned to the key requested.



127
128
129
130
131
# File 'lib/hashie/mash.rb', line 127

def initializing_reader(key)
  ck = convert_key(key)
  regular_writer(ck, self.class.new) unless key?(ck)
  regular_reader(ck)
end

#key?(key) ⇒ Boolean Also known as: has_key?, include?, member?

Returns:

  • (Boolean)


162
163
164
# File 'lib/hashie/mash.rb', line 162

def key?(key)
  super(convert_key(key))
end

#prefix_method?(method_name) ⇒ Boolean

Returns:

  • (Boolean)


231
232
233
234
# File 'lib/hashie/mash.rb', line 231

def prefix_method?(method_name)
  method_name = method_name.to_s
  method_name.end_with?(*ALLOWED_SUFFIXES) && key?(method_name.chop)
end

#regular_dupObject



156
# File 'lib/hashie/mash.rb', line 156

alias_method :regular_dup, :dup

#replace(other_hash) ⇒ Object



214
215
216
217
218
# File 'lib/hashie/mash.rb', line 214

def replace(other_hash)
  (keys - other_hash.keys).each { |key| delete(key) }
  other_hash.each { |key, value| self[key] = value }
  self
end

#respond_to_missing?(method_name, *args) ⇒ Boolean

Returns:

  • (Boolean)


220
221
222
223
224
225
226
227
228
229
# File 'lib/hashie/mash.rb', line 220

def respond_to_missing?(method_name, *args)
  return true if key?(method_name)
  _, suffix = method_suffix(method_name)
  case suffix
  when '=', '?', '!', '_'
    return true
  else
    super
  end
end

#reverse_merge(other_hash) ⇒ Object

another ActiveSupport method, see issue #270



259
260
261
# File 'lib/hashie/mash.rb', line 259

def reverse_merge(other_hash)
  Hashie::Mash.new(other_hash).merge(self)
end

#shallow_merge(other_hash) ⇒ Object

Performs a shallow_update on a duplicate of the current mash



201
202
203
# File 'lib/hashie/mash.rb', line 201

def shallow_merge(other_hash)
  dup.shallow_update(other_hash)
end

#shallow_update(other_hash) ⇒ Object

Merges (non-recursively) the hash from the argument, changing the receiving hash



207
208
209
210
211
212
# File 'lib/hashie/mash.rb', line 207

def shallow_update(other_hash)
  other_hash.each_pair do |k, v|
    regular_writer(convert_key(k), convert_value(v, true))
  end
  self
end

#to_module(mash_method_name = :settings) ⇒ Object



73
74
75
76
77
78
79
80
# File 'lib/hashie/mash.rb', line 73

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

#typeObject

:nodoc:



99
100
101
# File 'lib/hashie/mash.rb', line 99

def type #:nodoc:
  self['type']
end

#underbang_reader(key) ⇒ Object

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.



135
136
137
138
139
140
141
142
# File 'lib/hashie/mash.rb', line 135

def underbang_reader(key)
  ck = convert_key(key)
  if key?(ck)
    regular_reader(ck)
  else
    self.class.new
  end
end

#values_at(*keys) ⇒ Object



152
153
154
# File 'lib/hashie/mash.rb', line 152

def values_at(*keys)
  super(*keys.map { |key| convert_key(key) })
end