Class: Hash

Inherits:
Object
  • Object
show all
Includes:
Everythingrb::InspectQuotable
Defined in:
lib/everythingrb/hash.rb

Overview

Extensions to Ruby’s core Hash class

Provides:

  • #to_struct, #to_ostruct, #to_istruct: Convert hashes to different structures

  • #join_map: Combine filter_map and join operations

  • #transform_values.with_key: Transform values with access to keys

  • #transform, #transform!: Transform keys and values

  • #value_where, #values_where: Find values based on conditions

  • #rename_key, #rename_keys: Rename hash keys while preserving order

  • ::new_nested_hash: Create automatically nesting hashes

  • #merge_if, #merge_if!: Conditionally merge based on key-value pairs

  • #merge_if_values, #merge_if_values!: Conditionally merge based on values

  • #compact_merge, #compact_merge!: Merge only non-nil values

  • #compact_blank_merge, #compact_blank_merge!: Merge only present values (ActiveSupport)

Examples:

require "everythingrb/hash"
config = {server: {port: 443}}.to_ostruct
config.server.port  # => 443

Constant Summary collapse

EMPTY_STRUCT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

A minimal empty struct for Ruby 3.2+ compatibility

Ruby 3.2 enforces stricter argument handling for Struct. This means trying to create a Struct from an empty Hash will result in an ArgumentError being raised. This is trying to keep a consistent experience with that version and newer versions.

Returns:

  • (Struct) —

    A struct with a single nil-valued field

Struct.new(:_).new(nil)

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Everythingrb::InspectQuotable

#in_quotes

Class Method Details

.new_nested_hash(depth: nil) ⇒ Hash

Note:

This implementation is not thread-safe for concurrent modifications of deeply nested structures. If you need thread safety, consider using a mutex when modifying the deeper levels of the hash.

Note:

While unlimited nesting is convenient, it can interfere with common Ruby patterns like ||= when initializing values at deep depths. Use the depth parameter to control this behavior.

Creates a new Hash that automatically initializes missing keys with nested hashes

This method creates a hash where any missing key access will automatically create another nested hash with the same behavior. You can control the nesting depth with the depth parameter.

Examples:

Unlimited nesting (default behavior)

users = Hash.new_nested_hash
users[:john][:role] = "admin"  # No need to initialize users[:john] first
users # => {john: {role: "admin"}}

Deep nesting without initialization

stats = Hash.new_nested_hash
stats[:server][:region][:us_east][:errors] = ["Error"]
stats # => {server: {region: {us_east: {errors: ["Error"]}}}}

Limited nesting depth

hash = Hash.new_nested_hash(depth: 1)
hash[:user][:name] = "Alice"  # Works fine - only one level of auto-creation

# This pattern works correctly with limited nesting:
(hash[:user][:roles] ||= []) << "admin"
hash # => {user: {name: "Alice", roles: ["admin"]}}

Parameters:

  • depth (Integer, nil) (defaults to: nil) —

    The maximum nesting depth for automatic hash creation When nil (default), creates unlimited nesting depth When 0, behaves like a regular hash (returns nil for missing keys) When > 0, automatically creates hashes only up to the specified level

Returns:

  • (Hash) —

    A hash that creates nested hashes for missing keys



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/everythingrb/hash.rb', line 80

def self.new_nested_hash(depth: nil)
  new do |hash, key|
    next if depth == 0

    hash[key] =
      if depth.nil?
        new_nested_hash
      else
        new_nested_hash(depth: depth - 1)
      end
  end
end

Instance Method Details

#compact_blank_merge(other = {}) ⇒ Hash

Note:

Only available when ActiveSupport is loaded

Merges only present (non-blank) values from another hash

This method merges key-value pairs from another hash, but only includes values that are present according to ActiveSupport’s definition (not nil, not empty strings, not empty arrays, etc.).

Examples:

Building API responses without blank values

user_data = {name: "Alice", role: "admin"}
user_data.compact_blank_merge(
  bio: "",           # excluded - blank string
  tags: [],          # excluded - empty array
  email: "[email protected]", # included - present
  phone: nil         # excluded - nil
)
# => {name: "Alice", role: "admin", email: "[email protected]"}

Configuration merging with blank filtering

defaults = {timeout: 30, retries: 3}
user_config = {timeout: "", retries: 5, debug: true}
defaults.compact_blank_merge(user_config)
# => {timeout: 30, retries: 5, debug: true}

Parameters:

  • other (Hash) (defaults to: {}) —

    The hash to merge from

Returns:

  • (Hash) —

    A new hash with present values merged



845
846
847
 
# File 'lib/everythingrb/hash.rb', line 845

def compact_blank_merge(other = {})
  merge_if_values(other) { |i| i.present? }
end

#compact_blank_merge!(other = {}) ⇒ self

Note:

Only available when ActiveSupport is loaded

Merges only present (non-blank) values from another hash, in place

This method merges key-value pairs from another hash into the current hash, but only includes values that are present according to ActiveSupport’s definition (not nil, not empty strings, not empty arrays, etc.).

Examples:

Building parameters while excluding blanks

params = {action: "search", format: "json"}
params.compact_blank_merge!(
  query: "",       # excluded - blank
  page: 2,         # included - present
  tags: []         # excluded - empty array
)
# => {action: "search", format: "json", page: 2}

Parameters:

  • other (Hash) (defaults to: {}) —

    The hash to merge from

Returns:

  • (self) —

    The modified hash



871
872
873
 
# File 'lib/everythingrb/hash.rb', line 871

def compact_blank_merge!(other = {})
  merge_if_values!(other) { |i| i.present? }
end

#compact_merge(other = {}) ⇒ Hash

Merges only non-nil values from another hash

This is a convenience method for the common pattern of merging only values that are not nil.

Examples:

Merge only non-nil values (common when building parameters)

user_id = 42
email = nil
name = "Alice"

{}.compact_merge(
  id: user_id,
  email: email,
  name: name
)
# => {id: 42, name: "Alice"}

Parameters:

  • other (Hash) (defaults to: {}) —

    The hash to merge from

Returns:

  • (Hash) —

    A new hash with non-nil values merged



787
788
789
 
# File 'lib/everythingrb/hash.rb', line 787

def compact_merge(other = {})
  merge_if_values(other) { |i| i.itself }
end

#compact_merge!(other = {}) ⇒ self

Merges only non-nil values from another hash, in place

This is a convenience method for the common pattern of merging only values that are not nil.

Examples:

Merge only non-nil values in place

params = {format: "json"}
params.compact_merge!(
  page: 1,
  per_page: nil,
  sort: "created_at"
)
# => {format: "json", page: 1, sort: "created_at"}

Parameters:

  • other (Hash) (defaults to: {}) —

    The hash to merge from

Returns:

  • (self) —

    The modified hash



810
811
812
 
# File 'lib/everythingrb/hash.rb', line 810

def compact_merge!(other = {})
  merge_if_values!(other) { |i| i.itself }
end

#deep_transform_values(with_key: false) {|value, key| ... } ⇒ Hash, Enumerator

Recursively transforms all values in the hash and nested structures

Walks through the hash and all nested hashes/arrays and yields each non-hash and non-array value to the block, replacing it with the block’s return value.

Examples:

Basic usage

hash = {a: 1, b: {c: 2, d: [3, 4]}}
hash.deep_transform_values { |v| v * 2 }
# => {a: 2, b: {c: 4, d: [6, 8]}}

With key access

hash = {a: 1, b: {c: 2}}
hash.deep_transform_values(with_key: true) { |v, k| "#{k}:#{v}" }
# => {a: "a:1", b: {c: "c:2"}}

Parameters:

  • with_key (Boolean) (defaults to: false) —

    Whether to yield both value and key to the block

Yields:

  • (value, key) —

    Block that transforms each value

Yield Parameters:

  • value (Object) —

    The value to transform

  • key (Object) —

    The corresponding key (only if with_key: true)

Yield Returns:

  • (Object) —

    The transformed value

Returns:

  • (Hash) —

    A new hash with all values recursively transformed

  • (Enumerator) —

    If no block is given



371
372
373
374
375
376
377
378
379
 
# File 'lib/everythingrb/hash.rb', line 371

def deep_transform_values(with_key: false, &block)
  return to_enum(:deep_transform_values, with_key:) if block.nil?

  if with_key
    _deep_transform_values_with_key(self, nil, &block)
  else
    og_deep_transform_values(&block)
  end
end

#deep_transform_values!(with_key: false) {|value, key| ... } ⇒ self, Enumerator

Recursively transforms all values in the hash and nested structures in place

Same as #deep_transform_values but modifies the hash in place.

Examples:

Basic usage

hash = {a: 1, b: {c: 2, d: [3, 4]}}
hash.deep_transform_values! { |v| v * 2 }
# => {a: 2, b: {c: 4, d: [6, 8]}}
# hash is now {a: 2, b: {c: 4, d: [6, 8]}}

With key access

hash = {a: 1, b: {c: 2}}
hash.deep_transform_values!(with_key: true) { |v, k| "#{k}:#{v}" }
# => {a: "a:1", b: {c: "c:2"}}
# hash is now {a: "a:1", b: {c: "c:2"}}

Parameters:

  • with_key (Boolean) (defaults to: false) —

    Whether to yield both value and key to the block

Yields:

  • (value, key) —

    Block that transforms each value

Yield Parameters:

  • value (Object) —

    The value to transform

  • key (Object) —

    The corresponding key (only if with_key: true)

Yield Returns:

  • (Object) —

    The transformed value

Returns:

  • (self) —

    The transformed hash

  • (Enumerator) —

    If no block is given



408
409
410
411
412
413
414
415
416
 
# File 'lib/everythingrb/hash.rb', line 408

def deep_transform_values!(with_key: false, &block)
  return to_enum(:deep_transform_values!, with_key:) if block.nil?

  if with_key
    _deep_transform_values_with_key!(self, nil, &block)
  else
    og_deep_transform_values!(&block)
  end
end

#join_map(join_with = "", with_index: false) {|key_value_pair, index| ... } ⇒ String

Combines filter_map and join operations

Examples:

Basic usage without index

{ a: 1, b: nil, c: 2, d: nil, e: 3 }.join_map(", ") { |k, v| "#{k}-#{v}" if v }
# => "a-1, c-2, e-3"

With index for position-aware formatting

users = {alice: "Alice", bob: "Bob", charlie: "Charlie"}
users.join_map(", ", with_index: true) do |(k, v), i|
  "#{i + 1}. #{v}"
end
# => "1. Alice, 2. Bob, 3. Charlie"

Without a block (default behavior)

{ a: 1, b: nil, c: 2 }.join_map(" ")
# => "a 1 b c 2"

Parameters:

  • join_with (String) (defaults to: "") —

    The delimiter to join elements with (defaults to empty string)

  • with_index (Boolean) (defaults to: false) —

    Whether to include the index in the block (defaults to false)

Yields:

  • (key_value_pair, index) —

    Block that filters and transforms hash entries

Yield Parameters:

  • key_value_pair (Array) —

    Two-element array containing [key, value] (can be destructured as |key, value|)

  • index (Integer) —

    The index of the current entry (only if with_index: true)

Returns:

  • (String) —

    Joined string of filtered and transformed entries



120
121
122
123
124
125
126
127
128
 
# File 'lib/everythingrb/hash.rb', line 120

def join_map(join_with = "", with_index: false, &block)
  block = ->(kv_pair) { kv_pair.compact } if block.nil?

  if with_index
    filter_map.with_index(&block).join(join_with)
  else
    filter_map(&block).join(join_with)
  end
end

#merge_if(other = {}) {|key, value| ... } ⇒ Hash

Conditionally merges key-value pairs from another hash based on a block

Examples:

Merge only even-numbered keys

{a: 1, b: 2}.merge_if(c: 3, d: 4) { |key, _| key.to_s.ord.even? }
# => {a: 1, b: 2, d: 4}

Merge only positive values

{a: 1, b: 2}.merge_if(c: 3, d: -4) { |_, value| value > 0 }
# => {a: 1, b: 2, c: 3}

Parameters:

  • other (Hash) (defaults to: {}) —

    The hash to merge from

Yields:

  • (key, value) —

    Block that determines whether to include each key-value pair

Yield Parameters:

  • key (Object) —

    The key from the other hash

  • value (Object) —

    The value from the other hash

Yield Returns:

  • (Boolean) —

    Whether to include this key-value pair

Returns:

  • (Hash) —

    A new hash with conditionally merged key-value pairs



697
698
699
700
701
 
# File 'lib/everythingrb/hash.rb', line 697

def merge_if(other = {}, &block)
  other = other.select(&block) unless block.nil?

  merge(other)
end

#merge_if!(other = {}) {|key, value| ... } ⇒ self

Conditionally merges key-value pairs from another hash in place

Examples:

Merge only even-numbered keys in place

hash = {a: 1, b: 2}
hash.merge_if!(c: 3, d: 4) { |key, _| key.to_s.ord.even? }
# => {a: 1, b: 2, d: 4}

Parameters:

  • other (Hash) (defaults to: {}) —

    The hash to merge from

Yields:

  • (key, value) —

    Block that determines whether to include each key-value pair

Yield Parameters:

  • key (Object) —

    The key from the other hash

  • value (Object) —

    The value from the other hash

Yield Returns:

  • (Boolean) —

    Whether to include this key-value pair

Returns:

  • (self) —

    The modified hash



720
721
722
723
724
 
# File 'lib/everythingrb/hash.rb', line 720

def merge_if!(other = {}, &block)
  other = other.select(&block) unless block.nil?

  merge!(other)
end

#merge_if_values(other = {}) {|value| ... } ⇒ Hash

Conditionally merges key-value pairs based only on values

Examples:

Merge only string values

{a: 1, b: "old"}.merge_if_values(c: "new", d: 2) { |v| v.is_a?(String) }
# => {a: 1, b: "old", c: "new"}

Parameters:

  • other (Hash) (defaults to: {}) —

    The hash to merge from

Yields:

  • (value) —

    Block that determines whether to include each value

Yield Parameters:

  • value (Object) —

    The value from the other hash

Yield Returns:

  • (Boolean) —

    Whether to include this value

Returns:

  • (Hash) —

    A new hash with conditionally merged values



741
742
743
 
# File 'lib/everythingrb/hash.rb', line 741

def merge_if_values(other = {}, &block)
  merge_if(other) { |k, v| block.call(v) }
end

#merge_if_values!(other = {}) {|value| ... } ⇒ self

Conditionally merges key-value pairs based only on values, in place

Examples:

Merge only numeric values in place

hash = {a: 1, b: "text"}
hash.merge_if_values!(c: "ignore", d: 2) { |v| v.is_a?(Numeric) }
# => {a: 1, b: "text", d: 2}

Parameters:

  • other (Hash) (defaults to: {}) —

    The hash to merge from

Yields:

  • (value) —

    Block that determines whether to include each value

Yield Parameters:

  • value (Object) —

    The value from the other hash

Yield Returns:

  • (Boolean) —

    Whether to include this value

Returns:

  • (self) —

    The modified hash



761
762
763
 
# File 'lib/everythingrb/hash.rb', line 761

def merge_if_values!(other = {}, &block)
  merge_if!(other) { |k, v| block.call(v) }
end

#rename_key(old_key, new_key) ⇒ Hash

Renames a key in the hash while preserving the original order of elements

Examples:

Renames a single key

{a: 1, b: 2, c: 3}.rename_key(:b, :middle)
# => {a: 1, middle: 2, c: 3}

Parameters:

  • old_key (Object) —

    The key to rename

  • new_key (Object) —

    The new key to use

Returns:

  • (Hash) —

    A new hash with the key renamed



561
562
563
 
# File 'lib/everythingrb/hash.rb', line 561

def rename_key(old_key, new_key)
  rename_keys(old_key => new_key)
end

#rename_key!(old_key, new_key) ⇒ self

Renames a key in the hash in place while preserving the original order of elements

Examples:

Renames a key in place

hash = {a: 1, b: 2, c: 3}
hash.rename_key!(:b, :middle)
# => {a: 1, middle: 2, c: 3}

Parameters:

  • old_key (Object) —

    The key to rename

  • new_key (Object) —

    The new key to use

Returns:

  • (self) —

    The modified hash



578
579
580
 
# File 'lib/everythingrb/hash.rb', line 578

def rename_key!(old_key, new_key)
  rename_keys!(old_key => new_key)
end

#rename_key_unordered(old_key, new_key) ⇒ Hash

Renames a key in the hash without preserving element order (faster)

This method is significantly faster than #rename_key but does not guarantee that the order of elements in the hash will be preserved.

Examples:

Rename a single key without preserving order

{a: 1, b: 2, c: 3}.rename_key_unordered(:b, :middle)
# => {a: 1, c: 3, middle: 2}  # Order may differ

Parameters:

  • old_key (Object) —

    The key to rename

  • new_key (Object) —

    The new key to use

Returns:

  • (Hash) —

    A new hash with the key renamed



640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/everythingrb/hash.rb', line 640

def rename_key_unordered(old_key, new_key)
  # Fun thing I learned. For small hashes, using #except is 1.5x faster than using dup and delete.
  # But as the hash becomes larger, the performance improvements become diminished until they're roughly the same.
  # Neat!
  hash = except(old_key)

  # Only modify the hash if the old key exists
  return hash unless key?(old_key)

  hash[new_key] = self[old_key]
  hash
end

#rename_key_unordered!(old_key, new_key) ⇒ self

Renames a key in the hash in place without preserving element order (faster)

This method is significantly faster than #rename_key! but does not guarantee that the order of elements in the hash will be preserved.

Examples:

Rename a key in place without preserving order

hash = {a: 1, b: 2, c: 3}
hash.rename_key_unordered!(:b, :middle)
# => {a: 1, c: 3, middle: 2}  # Order may differ

Parameters:

  • old_key (Object) —

    The key to rename

  • new_key (Object) —

    The new key to use

Returns:

  • (self) —

    The modified hash



669
670
671
672
673
674
675
 
# File 'lib/everythingrb/hash.rb', line 669

def rename_key_unordered!(old_key, new_key)
  # Only modify the hash if the old key exists
  return self unless key?(old_key)

  self[new_key] = delete(old_key)
  self
end

#rename_keys(**keys) ⇒ Hash

Renames multiple keys in the hash while preserving the original order of elements

This method maintains the original order of all keys in the hash, renaming only the specified keys while keeping their positions unchanged.

Examples:

Renames multiple keys

{a: 1, b: 2, c: 3, d: 4}.rename_keys(a: :first, c: :third)
# => {first: 1, b: 2, third: 3, d: 4}

Parameters:

  • keys (Hash) —

    A mapping of old_key => new_key pairs

Returns:

  • (Hash) —

    A new hash with keys renamed



596
597
598
599
600
601
 
# File 'lib/everythingrb/hash.rb', line 596

def rename_keys(**keys)
  # I tried multiple different ways to rename the key while preserving the order, this was the fastest
  transform_keys do |key|
    keys.key?(key) ? keys[key] : key
  end
end

#rename_keys!(**keys) ⇒ self

Renames multiple keys in the hash in place while preserving the original order of elements

This method maintains the original order of all keys in the hash, renaming only the specified keys while keeping their positions unchanged.

Examples:

Rename multiple keys in place

hash = {a: 1, b: 2, c: 3, d: 4}
hash.rename_keys!(a: :first, c: :third)
# => {first: 1, b: 2, third: 3, d: 4}

Parameters:

  • keys (Hash) —

    A mapping of old_key => new_key pairs

Returns:

  • (self) —

    The modified hash



618
619
620
621
622
623
 
# File 'lib/everythingrb/hash.rb', line 618

def rename_keys!(**keys)
  # I tried multiple different ways to rename the key while preserving the order, this was the fastest
  transform_keys! do |key|
    keys.key?(key) ? keys[key] : key
  end
end

#to_deep_h ⇒ Hash

Recursively converts all values that respond to #to_h

Similar to #to_h but recursively traverses the Hash structure and calls #to_h on any object that responds to it. Useful for normalizing nested data structures and parsing nested JSON.

Examples:

Converting nested Data objects

user = { name: "Alice", metadata: Data.define(:source).new(source: "API") }
user.to_deep_h  # => {name: "Alice", metadata: {source: "API"}}

Parsing nested JSON strings

nested = { profile: '{"role":"admin"}' }
nested.to_deep_h  # => {profile: {role: "admin"}}

Mixed nested structures

data = {
  config: OpenStruct.new(api_key: "secret"),
  users: [
    Data.define(:name).new(name: "Bob"),
    {role: "admin"}
  ]
}
data.to_deep_h
# => {
#      config: {api_key: "secret"},
#      users: [{name: "Bob"}, {role: "admin"}]
#    }

Returns:

  • (Hash) —

    A deeply converted hash with all nested objects



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/everythingrb/hash.rb', line 161

def to_deep_h
  transform_values do |value|
    case value
    when Hash
      value.to_deep_h
    when Array
      value.to_deep_h
    when String
      # If the string is not valid JSON, #to_deep_h will return `nil`
      value.to_deep_h || value
    else
      value.respond_to?(:to_h) ? value.to_h : value
    end
  end
end

#to_istruct ⇒ Data

Converts hash to an immutable Data structure

Examples:

hash = { person: { name: "Bob", age: 30 } }
data = hash.to_istruct
data.person.name # => "Bob"
data.class # => Data

Returns:

  • (Data) —

    An immutable Data object with the same structure



188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/everythingrb/hash.rb', line 188

def to_istruct
  recurse = lambda do |input|
    case input
    when Hash
      input.to_istruct
    when Array
      input.map(&recurse)
    else
      input
    end
  end

  Data.define(*keys.map(&:to_sym)).new(*values.map { |value| recurse.call(value) })
end

#to_ostruct ⇒ OpenStruct

Converts hash to an OpenStruct recursively

Examples:

hash = { config: { api_key: "secret" } }
config = hash.to_ostruct
config.config.api_key # => "secret"

Returns:

  • (OpenStruct) —

    An OpenStruct with methods matching hash keys



242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/everythingrb/hash.rb', line 242

def to_ostruct
  recurse = lambda do |value|
    case value
    when Hash
      value.to_ostruct
    when Array
      value.map(&recurse)
    else
      value
    end
  end

  OpenStruct.new(**transform_values { |value| recurse.call(value) })
end

#to_struct ⇒ Struct

Converts hash to a Struct recursively

Examples:

hash = { user: { name: "Alice", roles: ["admin"] } }
struct = hash.to_struct
struct.user.name # => "Alice"
struct.class # => Struct

Returns:

  • (Struct) —

    A struct with methods matching hash keys



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/everythingrb/hash.rb', line 214

def to_struct
  # For Ruby 3.2, it raises if you attempt to create a Struct with no keys
  return EMPTY_STRUCT if RUBY_VERSION.start_with?("3.2") && empty?

  recurse = lambda do |value|
    case value
    when Hash
      value.to_struct
    when Array
      value.map(&recurse)
    else
      value
    end
  end

  Struct.new(*keys.map(&:to_sym)).new(*values.map { |value| recurse.call(value) })
end

#transform {|key, value| ... } ⇒ Hash, Enumerator

Transforms keys and values to create a new hash

Examples:

Transform both keys and values

{a: 1, b: 2}.transform { |k, v| ["#{k}_key", v * 2] }
# => {a_key: 2, b_key: 4}

Yields:

  • (key, value) —

    Block that returns a new key-value pair

Yield Parameters:

  • key (Object) —

    The original key

  • value (Object) —

    The original value

Yield Returns:

  • (Array) —

    Two-element array containing the new key and value

Returns:

  • (Hash) —

    A new hash with transformed keys and values

  • (Enumerator) —

    If no block is given



470
471
472
473
474
 
# File 'lib/everythingrb/hash.rb', line 470

def transform(&block)
  return to_enum(:transform) if block.nil?

  to_h(&block)
end

#transform! {|key, value| ... } ⇒ self, Enumerator

Transforms keys and values in place

Examples:

Transform both keys and values in place

hash = {a: 1, b: 2}
hash.transform! { |k, v| ["#{k}_key", v * 2] }
# => {a_key: 2, b_key: 4}

Yields:

  • (key, value) —

    Block that returns a new key-value pair

Yield Parameters:

  • key (Object) —

    The original key

  • value (Object) —

    The original value

Yield Returns:

  • (Array) —

    Two-element array containing the new key and value

Returns:

  • (self) —

    The transformed hash

  • (Enumerator) —

    If no block is given



492
493
494
495
496
 
# File 'lib/everythingrb/hash.rb', line 492

def transform!(&block)
  return to_enum(:transform!) if block.nil?

  replace(transform(&block))
end

#transform_values(with_key: false) {|value, key| ... } ⇒ Hash, Enumerator

Returns a new hash with all values transformed by the block

Enhances Ruby’s standard transform_values with key access capability.

Examples:

Standard usage

{a: 1, b: 2}.transform_values { |v| v * 2 }
# => {a: 2, b: 4}

With key access

{a: 1, b: 2}.transform_values(with_key: true) { |v, k| "#{k}:#{v}" }
# => {a: "a:1", b: "b:2"}

Parameters:

  • with_key (Boolean) (defaults to: false) —

    Whether to yield both value and key to the block

Yields:

  • (value, key) —

    Block that transforms each value

Yield Parameters:

  • value (Object) —

    The value to transform

  • key (Object) —

    The corresponding key (only if with_key: true)

Yield Returns:

  • (Object) —

    The transformed value

Returns:

  • (Hash) —

    A new hash with transformed values

  • (Enumerator) —

    If no block is given



286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/everythingrb/hash.rb', line 286

def transform_values(with_key: false, &block)
  return to_enum(:transform_values, with_key:) if block.nil?

  if with_key
    each_pair.with_object({}) do |(key, value), output|
      output[key] = block.call(value, key)
    end
  else
    og_transform_values(&block)
  end
end

#transform_values!(with_key: false) {|value, key| ... } ⇒ self, Enumerator

Transforms all values in the hash in place

Enhances Ruby’s standard transform_values! with key access capability.

Examples:

Standard usage

hash = {a: 1, b: 2}
hash.transform_values! { |v| v * 2 }
# => {a: 2, b: 4}
# hash is now {a: 2, b: 4}

With key access

hash = {a: 1, b: 2}
hash.transform_values!(with_key: true) { |v, k| "#{k}:#{v}" }
# => {a: "a:1", b: "b:2"}
# hash is now {a: "a:1", b: "b:2"}

Parameters:

  • with_key (Boolean) (defaults to: false) —

    Whether to yield both value and key to the block

Yields:

  • (value, key) —

    Block that transforms each value

Yield Parameters:

  • value (Object) —

    The value to transform

  • key (Object) —

    The corresponding key (only if with_key: true)

Yield Returns:

  • (Object) —

    The transformed value

Returns:

  • (self) —

    The transformed hash

  • (Enumerator) —

    If no block is given



325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/everythingrb/hash.rb', line 325

def transform_values!(with_key: false, &block)
  return to_enum(:transform_values!, with_key:) if block.nil?

  if with_key
    each_pair do |key, value|
      self[key] = block.call(value, key)
    end
  else
    og_transform_values!(&block)
  end
end

#value_where {|key, value| ... } ⇒ Object, ...

Returns the first value where the key-value pair satisfies the given condition

Examples:

Find first admin user by role

users = {
  alice: {name: "Alice", role: "admin"},
  bob: {name: "Bob", role: "user"},
  charlie: {name: "Charlie", role: "admin"}
}
users.value_where { |k, v| v[:role] == "admin" } # => {name: "Alice", role: "admin"}

Yields:

  • (key, value) —

    Block that determines whether to include the value

Yield Parameters:

  • key (Object) —

    The current key

  • value (Object) —

    The current value

Yield Returns:

  • (Boolean) —

    Whether to include this value

Returns:

  • (Object, nil) —

    The first matching value or nil if none found

  • (Enumerator) —

    If no block is given



517
518
519
520
521
 
# File 'lib/everythingrb/hash.rb', line 517

def value_where(&block)
  return to_enum(:value_where) if block.nil?

  find(&block)&.last
end

#values_where {|key, value| ... } ⇒ Array, Enumerator

Returns all values where the key-value pairs satisfy the given condition

Examples:

Find all admin users by role

users = {
  alice: {name: "Alice", role: "admin"},
  bob: {name: "Bob", role: "user"},
  charlie: {name: "Charlie", role: "admin"}
}
users.values_where { |k, v| v[:role] == "admin" }
# => [{name: "Alice", role: "admin"}, {name: "Charlie", role: "admin"}]

Yields:

  • (key, value) —

    Block that determines whether to include the value

Yield Parameters:

  • key (Object) —

    The current key

  • value (Object) —

    The current value

Yield Returns:

  • (Boolean) —

    Whether to include this value

Returns:

  • (Array) —

    All matching values

  • (Enumerator) —

    If no block is given



543
544
545
546
547
 
# File 'lib/everythingrb/hash.rb', line 543

def values_where(&block)
  return to_enum(:values_where) if block.nil?

  select(&block).values
end