Class: ActiveSupport::HashWithIndifferentAccess

Inherits:

Hash

• Object
• Hash
• ActiveSupport::HashWithIndifferentAccess

show all

Defined in:

activesupport/lib/active_support/hash_with_indifferent_access.rb

Class Method Summary (collapse)

• + (Object) new_from_hash_copying_default(hash)

Instance Method Summary (collapse)

• - (Object) []=(key, value) (also: #regular_writer, #store)

  Assigns a new value to the hash:.

• - (Object) default(key = nil)
• - (Object) delete(key)

  Removes a specified key from the hash.

• - (Object) dup

  Returns an exact copy of the hash.

• - (Boolean) extractable_options?
• - (Object) fetch(key, *extras)

  Fetches the value for the specified key, same as doing hash.

• - (HashWithIndifferentAccess) initialize(constructor = {}) constructor

  A new instance of HashWithIndifferentAccess.

• - (Boolean) key?(key) (also: #include?, #has_key?, #member?)

  Checks the hash for a key matching the argument passed in:.

• - (Object) merge(hash)

  Merges the instantized and the specified hashes together, giving precedence to the values from the second hash Does not overwrite the existing hash.

• - (Object) reverse_merge(other_hash)

  Performs the opposite of merge, with the keys and values from the first hash taking precedence over the second.

• - (Object) reverse_merge!(other_hash)
• - (Object) stringify_keys
• - (Object) stringify_keys!
• - (Object) symbolize_keys
• - (Object) to_hash

  Convert to a Hash with String keys.

• - (Object) to_options!
• - (Object) update(other_hash) (also: #regular_update, #merge!)

  Updates the instantized hash with values from the second:.

• - (Object) values_at(*indices)

  Returns an array of the values at the specified indices:.

Methods inherited from Hash

#as_json, #assert_valid_keys, #deep_dup, #deep_merge, #deep_merge!, #diff, #encode_json, #except, #except!, #extract!, from_xml, #slice, #slice!, #symbolize_keys!, #to_param, #to_xml, #with_indifferent_access

13
14
15
16
17
18
19
20

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 13

def initialize(constructor = {})
  if constructor.is_a?(Hash)
    super()
    update(constructor)
  else
    super(constructor)
  end
end

30
31
32
33
34

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 30

def self.new_from_hash_copying_default(hash)
  new(hash).tap do |new_hash|
    new_hash.default = hash.default
  end
end

hash = HashWithIndifferentAccess.new
hash[:key] = "value"

44
45
46

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 44

def []=(key, value)
  regular_writer(convert_key(key), convert_value(value))
end

22
23
24
25
26
27
28

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 22

def default(key = nil)
  if key.is_a?(Symbol) && include?(key = key.to_s)
    self[key]
  else
    super
  end
end

122
123
124

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 122

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

99
100
101
102
103

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 99

def dup
  self.class.new(self).tap do |new_hash|
    new_hash.default = default
  end
end

9
10
11

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 9

def extractable_options?
  true
end

83
84
85

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 83

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

hash = HashWithIndifferentAccess.new
hash["key"] = "value"
hash.key? :key  # => true
hash.key? "key" # => true

74
75
76

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 74

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

107
108
109

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 107

def merge(hash)
  self.dup.update(hash)
end

113
114
115

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 113

def reverse_merge(other_hash)
  super self.class.new_from_hash_copying_default(other_hash)
end

117
118
119

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 117

def reverse_merge!(other_hash)
  replace(reverse_merge( other_hash ))
end

127

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 127

def stringify_keys; dup end

126

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 126

def stringify_keys!; self end

129

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 129

def symbolize_keys; to_hash.symbolize_keys end

133
134
135

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 133

def to_hash
  Hash.new(default).merge!(self)
end

130

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 130

def to_options!; self end

hash_1 = HashWithIndifferentAccess.new
hash_1[:key] = "value"

hash_2 = HashWithIndifferentAccess.new
hash_2[:key] = "New Value!"

hash_1.update(hash_2) # => {"key"=>"New Value!"}

60
61
62
63

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 60

def update(other_hash)
  other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
  self
end

hash = HashWithIndifferentAccess.new
hash[:a] = "x"
hash[:b] = "y"
hash.values_at("a", "b") # => ["x", "y"]

94
95
96

# File 'activesupport/lib/active_support/hash_with_indifferent_access.rb', line 94

def values_at(*indices)
  indices.collect {|key| self[convert_key(key)]}
end