Module: Origin::Extensions::Hash

Defined in:
lib/origin/extensions/hash.rb

Overview

This module contains additional hash behaviour.

Instance Method Summary collapse

Instance Method Details

#__add__(object) ⇒ Hash

Add an object to a hash using the merge strategies.

Examples:

Add an object to a hash.

{ field: value }.__add__({ field: other_value })

Parameters:

  • object (Hash) —

    The other hash to add.

Returns:

  • (Hash) —

    The hash with object added.

Since:

  • 1.0.0



18
19
20
 
# File 'lib/origin/extensions/hash.rb', line 18

def __add__(object)
  apply_strategy(:__add__, object)
end

#__add_from_array__(array) ⇒ Hash

Merge this hash into the provided array.

Examples:

Merge the hash into the array.

{ field: value }.__add_from_array__([ 1, 2 ])

Parameters:

  • value (Array) —

    The array to add to.

Returns:

  • (Hash) —

    The merged hash.

Since:

  • 1.0.0



32
33
34
 
# File 'lib/origin/extensions/hash.rb', line 32

def __add_from_array__(array)
  { keys.first => array.__add__(values.first) }
end

#__deep_copy__ ⇒ Hash

Make a deep copy of this hash.

Examples:

Make a deep copy of the hash.

{ field: value }.__deep_copy__

Returns:

  • (Hash) —

    The copied hash.

Since:

  • 1.0.0



114
115
116
117
118
119
120
 
# File 'lib/origin/extensions/hash.rb', line 114

def __deep_copy__
  {}.tap do |copy|
    each_pair do |key, value|
      copy.store(key, value.__deep_copy__)
    end
  end
end

#__expand_complex__ ⇒ Hash

Get the object as expanded.

Examples:

Get the object expanded.

obj.__expand_complex__

Returns:

  • (Hash) —

    The expanded hash.

Since:

  • 1.0.5



146
147
148
149
150
151
152
 
# File 'lib/origin/extensions/hash.rb', line 146

def __expand_complex__
  replacement = {}
  each_pair do |key, value|
    replacement.merge!(key.__expr_part__(value.__expand_complex__))
  end
  replacement
end

#__intersect__(object) ⇒ Hash

Add an object to a hash using the merge strategies.

Examples:

Add an object to a hash.

{ field: value }.__intersect__({ field: other_value })

Parameters:

  • object (Hash) —

    The other hash to intersect.

Returns:

  • (Hash) —

    The hash with object intersected.

Since:

  • 1.0.0



46
47
48
 
# File 'lib/origin/extensions/hash.rb', line 46

def __intersect__(object)
  apply_strategy(:__intersect__, object)
end

#__intersect_from_array__(array) ⇒ Hash

Merge this hash into the provided array.

Examples:

Merge the hash into the array.

{ field: value }.__intersect_from_array__([ 1, 2 ])

Parameters:

  • value (Array) —

    The array to intersect to.

Returns:

  • (Hash) —

    The merged hash.

Since:

  • 1.0.0



60
61
62
 
# File 'lib/origin/extensions/hash.rb', line 60

def __intersect_from_array__(array)
  { keys.first => array.__intersect__(values.first) }
end

#__intersect_from_object__(object) ⇒ Hash

Merge this hash into the provided object.

Examples:

Merge the hash into the object.

{ field: value }.__intersect_from_object__([ 1, 2 ])

Parameters:

  • value (Object) —

    The object to intersect to.

Returns:

  • (Hash) —

    The merged hash.

Since:

  • 1.0.0



74
75
76
 
# File 'lib/origin/extensions/hash.rb', line 74

def __intersect_from_object__(object)
  { keys.first => object.__intersect__(values.first) }
end

#__sort_option__ ⇒ Hash

Get the hash as a sort option.

Examples:

Get the hash as a sort option.

{ field: 1 }.__sort_option__

Returns:

  • (Hash) —

    The hash as sort option.

Since:

  • 1.0.0



130
131
132
133
134
135
136
 
# File 'lib/origin/extensions/hash.rb', line 130

def __sort_option__
  tap do |hash|
    hash.each_pair do |key, value|
      hash.store(key, value.to_direction)
    end
  end
end

#__union__(object) ⇒ Hash

Add an object to a hash using the merge strategies.

Examples:

Add an object to a hash.

{ field: value }.__union__({ field: other_value })

Parameters:

  • object (Hash) —

    The other hash to union.

Returns:

  • (Hash) —

    The hash with object unioned.

Since:

  • 1.0.0



88
89
90
 
# File 'lib/origin/extensions/hash.rb', line 88

def __union__(object)
  apply_strategy(:__union__, object)
end

#__union_from_object__(object) ⇒ Hash

Merge this hash into the provided object.

Examples:

Merge the hash into the object.

{ field: value }.__union_from_object__([ 1, 2 ])

Parameters:

  • value (Object) —

    The object to union to.

Returns:

  • (Hash) —

    The merged hash.

Since:

  • 1.0.0



102
103
104
 
# File 'lib/origin/extensions/hash.rb', line 102

def __union_from_object__(object)
  { keys.first => object.__union__(values.first) }
end

#update_values(&block) ⇒ Hash

Update all the values in the hash with the provided block.

Examples:

Update the values in place.

{ field: "1" }.update_values(&:to_i)

Parameters:

  • block (Proc) —

    The block to execute on each value.

Returns:

  • (Hash) —

    the hash.

Since:

  • 1.0.0



164
165
166
167
168
 
# File 'lib/origin/extensions/hash.rb', line 164

def update_values(&block)
  each_pair do |key, value|
    store(key, block[value])
  end
end