Class: Hash

Inherits:
Object show all
Defined in:
lib/lite/ruby/hash.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.zip(keys, values) ⇒ Object 



7
8
9
 
# File 'lib/lite/ruby/hash.rb', line 7

def zip(keys, values)
  keys.size.times.with_object({}) { |i, hash| hash[keys[i]] = values[i] }
end

Instance Method Details

#aka(new_key, old_key) ⇒ Object 



13
14
15
16
 
# File 'lib/lite/ruby/hash.rb', line 13

def aka(new_key, old_key)
  self[new_key] = self[old_key] if key?(old_key)
  self
end

#assert_all_valid_keys!(*valid_keys) ⇒ Object

Raises:

  • (ArgumentError) 


28
29
30
31
32
 
# File 'lib/lite/ruby/hash.rb', line 28

def assert_all_valid_keys!(*valid_keys)
  return assert_valid_keys!(*valid_keys) unless empty?

  raise ArgumentError, 'An empty hash is not allowed'
end

#assert_all_valid_values!(*valid_values) ⇒ Object

Raises:

  • (ArgumentError) 


44
45
46
47
48
 
# File 'lib/lite/ruby/hash.rb', line 44

def assert_all_valid_values!(*valid_values)
  return assert_valid_values!(*valid_values) unless empty?

  raise ArgumentError, 'An empty hash is not allowed'
end

#assert_valid_keys!(*valid_keys) ⇒ Object 



18
19
20
21
22
23
24
25
26
 
# File 'lib/lite/ruby/hash.rb', line 18

def assert_valid_keys!(*valid_keys)
  each_key do |key|
    next if valid_keys.include?(key)

    raise ArgumentError,
          "Invalid key: #{key.inspect}." \
          "Allowed keys are: #{valid_keys.map(&:inspect).join(', ')}"
  end
end

#assert_valid_values!(*valid_values) ⇒ Object 



34
35
36
37
38
39
40
41
42
 
# File 'lib/lite/ruby/hash.rb', line 34

def assert_valid_values!(*valid_values)
  each_value do |value|
    next if valid_values.include?(value)

    raise ArgumentError,
          "Invalid value: #{value.inspect}." \
          "Allowed values are: #{valid_values.map(&:inspect).join(', ')}"
  end
end

#bury(*args) ⇒ Object

rubocop:disable Style/GuardClause



51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/lite/ruby/hash.rb', line 51

def bury(*args)
  if args.count < 2
    raise ArgumentError, '2 or more arguments required'
  elsif args.count == 2
    self[args[0]] = args[1]
  else
    arg = args.shift
    self[arg] = {} unless self[arg]
    self[arg].bury(*args) unless args.empty?
  end

  self
end

#collate(*others) ⇒ Object

rubocop:disable Metrics/MethodLength



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/lite/ruby/hash.rb', line 67

def collate(*others)
  hash = {}

  each_key { |key| hash[key] = [] }

  others.each do |other|
    other.each_key { |key| hash[key] = [] }
  end

  each { |key, val| hash[key] << val }

  others.each do |other|
    other.each { |key, val| hash[key] << val }
  end

  hash.each_value(&:flatten!)
  hash
end

#collate!(other_hash) ⇒ Object

rubocop:enable Metrics/MethodLength



87
88
89
 
# File 'lib/lite/ruby/hash.rb', line 87

def collate!(other_hash)
  replace(collate(other_hash))
end

#collect_keys ⇒ Object 



91
92
93
 
# File 'lib/lite/ruby/hash.rb', line 91

def collect_keys
  collect { |key, _| yield(key) }
end

#collect_values ⇒ Object 



95
96
97
 
# File 'lib/lite/ruby/hash.rb', line 95

def collect_values
  collect { |_, val| yield(val) }
end

#dearray_singular_values ⇒ Object 



112
113
114
115
116
117
118
119
 
# File 'lib/lite/ruby/hash.rb', line 112

def dearray_singular_values
  each_with_object({}) do |(key, val), hash|
    hash[key] = case val
                when Array then val.size < 2 ? val[0] : val
                else val
                end
  end
end

#dearray_singular_values! ⇒ Object 



121
122
123
 
# File 'lib/lite/ruby/hash.rb', line 121

def dearray_singular_values!
  replace(dearray_singular_values)
end

#dearray_values(idx = 0) ⇒ Object 



99
100
101
102
103
104
105
106
 
# File 'lib/lite/ruby/hash.rb', line 99

def dearray_values(idx = 0)
  each_with_object({}) do |(key, val), hash|
    hash[key] = case val
                when Array then val[idx] || val[-1]
                else val
                end
  end
end

#dearray_values!(idx = 0) ⇒ Object 



108
109
110
 
# File 'lib/lite/ruby/hash.rb', line 108

def dearray_values!(idx = 0)
  replace(dearray_values(idx))
end

#deep_merge(other_hash, &block) ⇒ Object 



125
126
127
 
# File 'lib/lite/ruby/hash.rb', line 125

def deep_merge(other_hash, &block)
  dup.deep_merge!(other_hash, &block)
end

#deep_merge!(other_hash, &block) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/lite/ruby/hash.rb', line 129

def deep_merge!(other_hash, &block)
  other_hash.each_pair.with_object(self) do |(current_key, other_value), hash|
    this_value = hash[current_key]

    hash[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
                          this_value.deep_merge(other_value, yield(block))
                        elsif block_given? && key?(current_key)
                          yield(current_key, this_value, other_value)
                        else
                          other_value
                        end
  end
end

#delete_unless ⇒ Object 



143
144
145
 
# File 'lib/lite/ruby/hash.rb', line 143

def delete_unless
  delete_if { |key, val| !yield(key, val) }
end

#delete_values(*values) ⇒ Object 



147
148
149
150
151
152
153
154
 
# File 'lib/lite/ruby/hash.rb', line 147

def delete_values(*values)
  each_key.with_object([]) do |key, array|
    next unless values.include?(self[key])

    array << key
    delete(key)
  end
end

#demote(key) ⇒ Object 



156
157
158
 
# File 'lib/lite/ruby/hash.rb', line 156

def demote(key)
  dup.demote!(key)
end

#demote!(key) ⇒ Object 



160
161
162
163
164
165
 
# File 'lib/lite/ruby/hash.rb', line 160

def demote!(key)
  return self unless key?(key)

  self[key] = delete(key)
  self
end

#denillify(identity = 0) ⇒ Object 



167
168
169
 
# File 'lib/lite/ruby/hash.rb', line 167

def denillify(identity = 0)
  dup.denillify!(identity)
end

#denillify!(identity = 0) ⇒ Object 



171
172
173
 
# File 'lib/lite/ruby/hash.rb', line 171

def denillify!(identity = 0)
  each { |key, val| self[key] = val || identity }
end

#diff(hash) ⇒ Object 



175
176
177
178
179
 
# File 'lib/lite/ruby/hash.rb', line 175

def diff(hash)
  h1 = dup.delete_if { |k, v| hash[k] == v }
  h2 = hash.dup.delete_if { |k, _| key?(k) }
  h1.merge(h2)
end

#except(*keys) ⇒ Object 



181
182
183
 
# File 'lib/lite/ruby/hash.rb', line 181

def except(*keys)
  dup.except!(*keys)
end

#except!(*keys) ⇒ Object 



185
186
187
 
# File 'lib/lite/ruby/hash.rb', line 185

def except!(*keys)
  keys.each_with_object(self) { |key, _| delete(key) }
end

#extract!(*keys) ⇒ Object 



189
190
191
 
# File 'lib/lite/ruby/hash.rb', line 189

def extract!(*keys)
  keys.each_with_object(self) { |key, hash| hash[key] = delete(key) if key?(key) }
end

#hmap(&block) ⇒ Object 



193
194
195
 
# File 'lib/lite/ruby/hash.rb', line 193

def hmap(&block)
  dup.hmap!(&block)
end

#hmap! ⇒ Object 



197
198
199
 
# File 'lib/lite/ruby/hash.rb', line 197

def hmap!
  inject(self) { |hash, (key, val)| hash.merge(yield(key, val)) }
end

#insert(name, value) ⇒ Object 



201
202
203
204
205
206
 
# File 'lib/lite/ruby/hash.rb', line 201

def insert(name, value)
  return false if key?(name)

  store(name, value)
  true
end

#invert ⇒ Object 



208
209
210
211
212
213
214
215
216
 
# File 'lib/lite/ruby/hash.rb', line 208

def invert
  each_pair.with_object({}) do |(key, val), hash|
    if val.is_a?(Array)
      val.each { |x| hash[x] = (hash.key?(x) ? [key, hash[x]].flatten : key) }
    else
      hash[val] = (hash.key?(val) ? [key, hash[val]].flatten : key)
    end
  end
end

#keys?(*check_keys) ⇒ Boolean Also known as: has_keys?

Returns:

  • (Boolean) 


218
219
220
221
 
# File 'lib/lite/ruby/hash.rb', line 218

def keys?(*check_keys)
  unknown_keys = check_keys - keys
  unknown_keys.empty?
end

#nillify ⇒ Object 



225
226
227
 
# File 'lib/lite/ruby/hash.rb', line 225

def nillify
  dup.nillify!
end

#nillify! ⇒ Object 



229
230
231
232
233
 
# File 'lib/lite/ruby/hash.rb', line 229

def nillify!
  each do |key, val|
    self[key] = nil if !val.nil? && (val.try(:blank?) || val.try(:to_s).blank?)
  end
end

#only_fill(*keys, placeholder: nil) ⇒ Object 



235
236
237
 
# File 'lib/lite/ruby/hash.rb', line 235

def only_fill(*keys, placeholder: nil)
  keys.each_with_object({}) { |key, hash| hash[key] = key?(key) ? self[key] : placeholder }
end

#only_fill!(*keys, placeholder: nil) ⇒ Object 



239
240
241
 
# File 'lib/lite/ruby/hash.rb', line 239

def only_fill!(*keys, placeholder: nil)
  replace(only_fill(*keys, placeholder: placeholder))
end

#only_keys?(*check_keys) ⇒ Boolean Also known as: has_only_keys?

Returns:

  • (Boolean) 


243
244
245
246
 
# File 'lib/lite/ruby/hash.rb', line 243

def only_keys?(*check_keys)
  unknown_keys = keys - check_keys
  unknown_keys.empty?
end

#pair?(key, value) ⇒ Boolean

Returns:

  • (Boolean) 


250
251
252
 
# File 'lib/lite/ruby/hash.rb', line 250

def pair?(key, value)
  self[key] == value
end

#promote(key) ⇒ Object 



254
255
256
 
# File 'lib/lite/ruby/hash.rb', line 254

def promote(key)
  dup.promote!(key)
end

#promote!(key) ⇒ Object 



258
259
260
261
262
 
# File 'lib/lite/ruby/hash.rb', line 258

def promote!(key)
  return self unless key?(key)

  { key => delete(key) }.merge(self)
end

#rename_keys(*keys) ⇒ Object 



264
265
266
 
# File 'lib/lite/ruby/hash.rb', line 264

def rename_keys(*keys)
  dup.rename_keys!(*keys)
end

#rename_keys!(*keys) ⇒ Object 



268
269
270
271
 
# File 'lib/lite/ruby/hash.rb', line 268

def rename_keys!(*keys)
  keys = Hash[*keys]
  keys.each_with_object(self) { |(key, val), hash| hash[val] = delete(key) if hash[key] }
end

#reverse_merge(other_hash) ⇒ Object 



273
274
275
 
# File 'lib/lite/ruby/hash.rb', line 273

def reverse_merge(other_hash)
  other_hash.merge(self)
end

#reverse_merge!(other_hash) ⇒ Object 



277
278
279
 
# File 'lib/lite/ruby/hash.rb', line 277

def reverse_merge!(other_hash)
  other_hash.merge!(self)
end

#sample ⇒ Object 



281
282
283
284
 
# File 'lib/lite/ruby/hash.rb', line 281

def sample
  key = sample_key
  [key, fetch(key)]
end

#sample! ⇒ Object 



286
287
288
289
290
 
# File 'lib/lite/ruby/hash.rb', line 286

def sample!
  key, value = sample
  delete(key)
  [key, value]
end

#sample_key ⇒ Object 



292
293
294
295
 
# File 'lib/lite/ruby/hash.rb', line 292

def sample_key
  hash_keys = keys
  hash_keys.at(Random.rand(hash_keys.size - 1))
end

#sample_key! ⇒ Object 



297
298
299
300
301
 
# File 'lib/lite/ruby/hash.rb', line 297

def sample_key!
  key, = sample
  delete(key)
  key
end

#sample_value ⇒ Object 



303
304
305
 
# File 'lib/lite/ruby/hash.rb', line 303

def sample_value
  fetch(sample_key)
end

#sample_value! ⇒ Object 



307
308
309
310
311
 
# File 'lib/lite/ruby/hash.rb', line 307

def sample_value!
  key, value = sample
  delete(key)
  value
end

#shuffle ⇒ Object 



313
314
315
 
# File 'lib/lite/ruby/hash.rb', line 313

def shuffle
  Hash[to_a.sample(size)]
end

#shuffle! ⇒ Object 



317
318
319
 
# File 'lib/lite/ruby/hash.rb', line 317

def shuffle!
  replace(shuffle)
end

#slice!(*keys) ⇒ Object Also known as: only! 



321
322
323
324
325
326
327
328
 
# File 'lib/lite/ruby/hash.rb', line 321

def slice!(*keys)
  omit = slice(*self.keys - keys)
  hash = slice(*keys)
  hash.default = default
  hash.default_proc = default_proc if default_proc
  replace(hash)
  omit
end

#stringify_keys ⇒ Object 



333
334
335
 
# File 'lib/lite/ruby/hash.rb', line 333

def stringify_keys
  each_with_object({}) { |(key, val), hash| hash[key.to_s] = val }
end

#stringify_keys! ⇒ Object 



337
338
339
 
# File 'lib/lite/ruby/hash.rb', line 337

def stringify_keys!
  replace(stringify_keys)
end

#strip ⇒ Object 



341
342
343
 
# File 'lib/lite/ruby/hash.rb', line 341

def strip
  select { |_, val| !val.blank? }
end

#strip! ⇒ Object 



345
346
347
 
# File 'lib/lite/ruby/hash.rb', line 345

def strip!
  reject! { |_, val| val.blank? }
end

#symbolize_and_underscore_keys ⇒ Object

rubocop:disable Metrics/MethodLength



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/lite/ruby/hash.rb', line 366

def symbolize_and_underscore_keys
  each_with_object({}) do |(key, val), hash|
    new_key = begin
                key.to_s
                   .gsub(/::/, '/')
                   .gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
                   .gsub(/([a-z\d])([A-Z])/, '\1_\2')
                   .tr(' -', '_')
                   .downcase
                   .to_sym
              rescue StandardError
                key
              end

    hash[new_key] = val
  end
end

#symbolize_and_underscore_keys! ⇒ Object

rubocop:enable Metrics/MethodLength



385
386
387
 
# File 'lib/lite/ruby/hash.rb', line 385

def symbolize_and_underscore_keys!
  replace(symbolize_and_underscore_keys)
end

#symbolize_keys ⇒ Object 



349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/lite/ruby/hash.rb', line 349

def symbolize_keys
  each_with_object({}) do |(key, val), hash|
    new_key = begin
                key.to_s.to_sym
              rescue StandardError
                key
              end

    hash[new_key] = val
  end
end

#symbolize_keys! ⇒ Object 



361
362
363
 
# File 'lib/lite/ruby/hash.rb', line 361

def symbolize_keys!
  replace(symbolize_keys)
end

#to_object ⇒ Object Also known as: to_o 



389
390
391
 
# File 'lib/lite/ruby/hash.rb', line 389

def to_object
  JSON.parse(to_json, object_class: OpenStruct)
end

#update_each ⇒ Object 



395
396
397
 
# File 'lib/lite/ruby/hash.rb', line 395

def update_each
  replace(each_with_object({}) { |(key, val), hash| hash.update(yield(key, val)) })
end

#update_keys ⇒ Object 



399
400
401
402
403
 
# File 'lib/lite/ruby/hash.rb', line 399

def update_keys
  return to_enum(:update_keys) unless block_given?

  replace(each_with_object({}) { |(key, val), hash| hash[yield(key)] = val })
end

#update_values ⇒ Object 



405
406
407
408
409
 
# File 'lib/lite/ruby/hash.rb', line 405

def update_values
  return to_enum(:update_values) unless block_given?

  replace(each_with_object({}) { |(key, val), hash| hash[key] = yield(val) })
end

#vacant?(key) ⇒ Boolean

Returns:

  • (Boolean) 


411
412
413
 
# File 'lib/lite/ruby/hash.rb', line 411

def vacant?(key)
  self[key].blank?
end