Class: Attributor::Hash

Inherits:
Object
  • Object
show all
Includes:
Container, Enumerable
Defined in:
lib/attributor/types/hash.rb

Direct Known Subclasses

Model

Constant Summary collapse

MAX_EXAMPLE_DEPTH =
5
CIRCULAR_REFERENCE_MARKER =
'...'.freeze

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Container

included

Constructor Details

#initialize(contents = {}) ⇒ Hash

Returns a new instance of Hash


502
503
504
505
506
507
# File 'lib/attributor/types/hash.rb', line 502

def initialize(contents={})
  @validating = false
  @dumping = false

  @contents = contents
end

Class Attribute Details

.extra_keysObject

Returns the value of attribute extra_keys


31
32
33
# File 'lib/attributor/types/hash.rb', line 31

def extra_keys
  @extra_keys
end

.insensitive_mapObject (readonly)

Returns the value of attribute insensitive_map


30
31
32
# File 'lib/attributor/types/hash.rb', line 30

def insensitive_map
  @insensitive_map
end

.key_attributeObject (readonly)

Returns the value of attribute key_attribute


29
30
31
# File 'lib/attributor/types/hash.rb', line 29

def key_attribute
  @key_attribute
end

.key_typeObject

Returns the value of attribute key_type


27
28
29
# File 'lib/attributor/types/hash.rb', line 27

def key_type
  @key_type
end

.optionsObject (readonly)

Returns the value of attribute options


27
28
29
# File 'lib/attributor/types/hash.rb', line 27

def options
  @options
end

.value_attributeObject (readonly)

Returns the value of attribute value_attribute


28
29
30
# File 'lib/attributor/types/hash.rb', line 28

def value_attribute
  @value_attribute
end

.value_typeObject

Returns the value of attribute value_type


27
28
29
# File 'lib/attributor/types/hash.rb', line 27

def value_type
  @value_type
end

Instance Attribute Details

#contentsObject (readonly)

TODO: Think about the format of the subcontexts to use: let's use .at(key.to_s)


444
445
446
# File 'lib/attributor/types/hash.rb', line 444

def contents
  @contents
end

#dumpingObject (readonly)

Returns the value of attribute dumping


500
501
502
# File 'lib/attributor/types/hash.rb', line 500

def dumping
  @dumping
end

#validatingObject (readonly)

Returns the value of attribute validating


500
501
502
# File 'lib/attributor/types/hash.rb', line 500

def validating
  @validating
end

Class Method Details

.attributes(**options, &key_spec) ⇒ Object

Raises:

  • (@error)

80
81
82
83
84
# File 'lib/attributor/types/hash.rb', line 80

def self.attributes(**options, &key_spec)
  raise @error if @error

  self.keys(options, &key_spec)
end

.check_option!(name, definition) ⇒ Object


229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'lib/attributor/types/hash.rb', line 229

def self.check_option!(name, definition)
  case name
  when :reference
    :ok # FIXME ... actually do something smart
  when :dsl_compiler
    :ok
  when :case_insensitive_load
    unless self.key_type <= String
      raise Attributor::AttributorException, ":case_insensitive_load may not be used with keys of type #{self.key_type.name}"
    end
    :ok
  when :allow_extra
    :ok
  else
    :unknown
  end
end

.construct(constructor_block, **options) ⇒ Object


144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/attributor/types/hash.rb', line 144

def self.construct(constructor_block, **options)
  return self if constructor_block.nil?

  unless @concrete
    return self.of(key:self.key_type, value: self.value_type)
    .construct(constructor_block,**options)
  end

  if options[:case_insensitive_load] && !(self.key_type <= String)
    raise Attributor::AttributorException.new(":case_insensitive_load may not be used with keys of type #{self.key_type.name}")
  end

  self.keys(options, &constructor_block)
  self
end

.constructable?Boolean

Returns:


139
140
141
# File 'lib/attributor/types/hash.rb', line 139

def self.constructable?
  true
end

.definitionObject


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/attributor/types/hash.rb', line 98

def self.definition
  opts = {
    :key_type => @key_type,
    :value_type => @value_type
  }.merge(@options)

  blocks = @saved_blocks.shift(@saved_blocks.size)
  compiler = dsl_class.new(self, opts)
  compiler.parse(*blocks)

  if opts[:case_insensitive_load] == true
    @insensitive_map = self.keys.keys.each_with_object({}) do |k, map|
      map[k.downcase] = k
    end
  end
rescue => e
  @error = InvalidDefinition.new(self, e)
  raise
end

.describe(shallow = false, example: nil) ⇒ Object


420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
# File 'lib/attributor/types/hash.rb', line 420

def self.describe(shallow=false, example: nil)
  hash = super(shallow)

  if key_type
    hash[:key] = {type: key_type.describe(true)}
  end

  if self.keys.any?
    # Spit keys if it's the root or if it's an anonymous structures
    if ( !shallow || self.name == nil)
      # FIXME: change to :keys when the praxis doc browser supports displaying those. or josep's demo is over.
      hash[:attributes] = self.keys.each_with_object({}) do |(sub_name, sub_attribute), sub_attributes|
        sub_example = example.get(sub_name) if example
        sub_attributes[sub_name] = sub_attribute.describe(true, example: sub_example)
      end
    end
  else
    hash[:value] = {type: value_type.describe(true)}
  end

  hash
end

.dsl_classObject


118
119
120
# File 'lib/attributor/types/hash.rb', line 118

def self.dsl_class
  @options[:dsl_compiler] || DSLCompiler
end

.dump(value, **opts) ⇒ Object


220
221
222
223
224
225
226
# File 'lib/attributor/types/hash.rb', line 220

def self.dump(value, **opts)
  if loaded = self.load(value)
    loaded.dump(**opts)
  else
    nil
  end
end

.example(context = nil, **values) ⇒ Object


190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/attributor/types/hash.rb', line 190

def self.example(context=nil, **values)

  if (key_type == Object && value_type == Object && self.keys.empty?)
    return self.new
  end

  context ||= ["#{Hash}-#{rand(10000000)}"]
  context = Array(context)

  if self.keys.any?
    result = self.new
    result.extend(ExampleMixin)

    result.lazy_attributes = self.example_contents(context, result, values)
  else
    hash = ::Hash.new

    (rand(3) + 1).times do |i|
      example_key = key_type.example(context + ["at(#{i})"])
      subcontext = context + ["at(#{example_key})"]
      hash[example_key] = value_type.example(subcontext)
    end

    result = self.new(hash)
  end

  result
end

.example_contents(context, parent, **values) ⇒ Object


161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
# File 'lib/attributor/types/hash.rb', line 161

def self.example_contents(context, parent, **values)

  hash = ::Hash.new
  example_depth = context.size

  self.keys.each do |sub_attribute_name, sub_attribute|


    if sub_attribute.attributes
      # TODO: add option to raise an exception in this case?
      next if example_depth > MAX_EXAMPLE_DEPTH
    end

    sub_context = self.generate_subcontext(context,sub_attribute_name)
    block = Proc.new do
      value = values.fetch(sub_attribute_name) do
        sub_attribute.example(sub_context, parent: parent)
      end
      sub_attribute.load(value,sub_context)

    end


    hash[sub_attribute_name] = block
  end

  hash
end

.familyObject


55
56
57
# File 'lib/attributor/types/hash.rb', line 55

def self.family
  'hash'
end

.from_hash(object, context, recurse: false) ⇒ Object


378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'lib/attributor/types/hash.rb', line 378

def self.from_hash(object,context, recurse: false)
  hash = self.new

  # if the hash definition includes named extra keys, initialize
  # its value from the object in case it provides some already.
  # this is to ensure it exists when we handle any extra keys
  # that may exist in the object later
  if self.extra_keys
    sub_context = self.generate_subcontext(context,self.extra_keys)
    v = object.fetch(self.extra_keys, {})
    hash.set(self.extra_keys, v, context: sub_context, recurse: recurse)
  end

  object.each do |k,val|
    next if k == self.extra_keys

    sub_context = self.generate_subcontext(context,k)
    hash.set(k, val, context: sub_context, recurse: recurse)
  end

  # handle default values for missing keys
  self.keys.each do |key_name, attribute|
    next if hash.key?(key_name)
    sub_context = self.generate_subcontext(context,key_name)
    default = attribute.load(nil, sub_context, recurse: recurse)
    hash[key_name] = default unless default.nil?
  end

  hash
end

.generate_subcontext(context, key_name) ⇒ Object


280
281
282
# File 'lib/attributor/types/hash.rb', line 280

def self.generate_subcontext(context, key_name)
  context + ["key(#{key_name.inspect})"]
end

.inherited(klass) ⇒ Object


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/attributor/types/hash.rb', line 63

def self.inherited(klass)
  k = self.key_type
  v = self.value_type

  klass.instance_eval do
    @saved_blocks = []
    @options = {allow_extra: false}
    @keys = {}
    @key_type = k
    @value_type = v
    @key_attribute = Attribute.new(@key_type)
    @value_attribute = Attribute.new(@value_type)

    @error = false
  end
end

.keys(**options, &key_spec) ⇒ Object

Raises:

  • (@error)

86
87
88
89
90
91
92
93
94
95
96
# File 'lib/attributor/types/hash.rb', line 86

def self.keys(**options, &key_spec)
  raise @error if @error

  if block_given?
    @saved_blocks << key_spec
    @options.merge!(options)
  elsif @saved_blocks.any?
    self.definition
  end
  @keys
end

.load(value, context = Attributor::DEFAULT_ROOT_CONTEXT, recurse: false, **options) ⇒ Object


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/attributor/types/hash.rb', line 248

def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, recurse: false,  **options)
  context = Array(context)

  if value.nil?
    if recurse
      loaded_value = {}
    else
      return nil
    end
  elsif value.is_a?(self)
    return value
  elsif value.kind_of?(Attributor::Hash)
    loaded_value = value.contents
  elsif value.is_a?(::Hash)
    loaded_value = value
  elsif value.is_a?(::String)
    loaded_value = decode_json(value,context)
  elsif value.respond_to?(:to_hash)
    loaded_value = value.to_hash
  else
    raise Attributor::IncompatibleTypeError, context: context, value_type: value.class, type: self
  end

  return self.from_hash(loaded_value,context, recurse: recurse) if self.keys.any?
  return self.new(loaded_value) if (key_type == Object && value_type == Object)

  loaded_value.each_with_object(self.new) do| (k, v), obj |
    obj[self.key_type.load(k,context)] = self.value_type.load(v,context)
  end

end

.native_typeObject


122
123
124
# File 'lib/attributor/types/hash.rb', line 122

def self.native_type
  self
end

.of(key: @key_type, value: @value_type) ⇒ Object

Examples:

Hash.of(key: String, value: Integer)


131
132
133
134
135
136
137
# File 'lib/attributor/types/hash.rb', line 131

def self.of(key: @key_type, value: @value_type)
  ::Class.new(self) do
    self.key_type = key
    self.value_type = value
    @keys = {}
  end
end

.valid_type?(type) ⇒ Boolean

Returns:


126
127
128
# File 'lib/attributor/types/hash.rb', line 126

def self.valid_type?(type)
  type.kind_of?(self) || type.kind_of?(::Hash)
end

.validate(object, context = Attributor::DEFAULT_ROOT_CONTEXT, _attribute) ⇒ Object


410
411
412
413
414
415
416
417
418
# File 'lib/attributor/types/hash.rb', line 410

def self.validate(object,context=Attributor::DEFAULT_ROOT_CONTEXT,_attribute)
  context = [context] if context.is_a? ::String

  unless object.kind_of?(self)
    raise ArgumentError, "#{self.name} can not validate object of type #{object.class.name} for #{Attributor.humanize_context(context)}."
  end

  object.validate(context)
end

Instance Method Details

#==(other) ⇒ Object


526
527
528
# File 'lib/attributor/types/hash.rb', line 526

def ==(other)
  contents == other || (other.respond_to?(:contents) ? contents == other.contents : false)
end

#[](k) ⇒ Object


446
447
448
# File 'lib/attributor/types/hash.rb', line 446

def [](k)
  @contents[k]
end

#[]=(k, v) ⇒ Object


454
455
456
# File 'lib/attributor/types/hash.rb', line 454

def []=(k,v)
  @contents[k] = v
end

#_get_attr(k) ⇒ Object


450
451
452
# File 'lib/attributor/types/hash.rb', line 450

def _get_attr(k)
  self[k]
end

#delete(key) ⇒ Object


496
497
498
# File 'lib/attributor/types/hash.rb', line 496

def delete(key)
  @contents.delete(key)
end

#dump(**opts) ⇒ Object


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'lib/attributor/types/hash.rb', line 569

def dump(**opts)
  return CIRCULAR_REFERENCE_MARKER if @dumping
  @dumping = true

  contents.each_with_object({}) do |(k,v),hash|
    k = self.key_attribute.dump(k,opts)

    if (attribute_for_value = self.class.keys[k])
      v = attribute_for_value.dump(v,opts)
    else
      v = self.value_attribute.dump(v,opts)
    end

    hash[k] = v
  end
ensure
  @dumping = false
end

#each(&block) ⇒ Object Also known as: each_pair


458
459
460
# File 'lib/attributor/types/hash.rb', line 458

def each(&block)
  @contents.each(&block)
end

#empty?Boolean

Returns:


476
477
478
# File 'lib/attributor/types/hash.rb', line 476

def empty?
  @contents.empty?
end

#generate_subcontext(context, key_name) ⇒ Object


284
285
286
# File 'lib/attributor/types/hash.rb', line 284

def generate_subcontext(context, key_name)
  self.class.generate_subcontext(context,key_name)
end

#get(key, context: self.generate_subcontext(Attributor::DEFAULT_ROOT_CONTEXT,key)) ⇒ Object


288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
# File 'lib/attributor/types/hash.rb', line 288

def get(key, context: self.generate_subcontext(Attributor::DEFAULT_ROOT_CONTEXT,key))
  key = self.class.key_attribute.load(key, context)

  if self.class.keys.empty?
    if @contents.key? key
      value = @contents[key]
      loaded_value = value_attribute.load(value, context)
      return self[key] = loaded_value
    else
      if self.class.options[:case_insensitive_load]
        key = key.downcase
        @contents.each do |k,v|
          if key == k.downcase
            return self.get(key, context: context)
          end
        end
      end
    end
    return nil
  end

  value = @contents[key]

  # FIXME: getting an unset value here should not force it in the hash
  if (attribute = self.class.keys[key])
    loaded_value = attribute.load(value, context)
    if loaded_value.nil?
      return nil
    else
      return self[key] = loaded_value
    end
  end

  if self.class.options[:case_insensitive_load]
    key = self.class.insensitive_map[key.downcase]
    return self.get(key, context: context)
  end

  if self.class.options[:allow_extra]
    if self.class.extra_keys.nil?
      return @contents[key] = self.class.value_attribute.load(value, context)
    else
      extra_keys_key = self.class.extra_keys

      if @contents.key? extra_keys_key
        return @contents[extra_keys_key].get(key, context: context)
      end

    end
  end


  raise AttributorException, "Unknown key received: #{key.inspect} for #{Attributor.humanize_context(context)}"
end

#key?(k) ⇒ Boolean Also known as: has_key?

Returns:


480
481
482
# File 'lib/attributor/types/hash.rb', line 480

def key?(k)
  @contents.key?(k)
end

#key_attributeObject


517
518
519
# File 'lib/attributor/types/hash.rb', line 517

def key_attribute
  self.class.key_attribute
end

#key_typeObject


509
510
511
# File 'lib/attributor/types/hash.rb', line 509

def key_type
  self.class.key_type
end

#keysObject


468
469
470
# File 'lib/attributor/types/hash.rb', line 468

def keys
  @contents.keys
end

#merge(h) ⇒ Object


485
486
487
488
489
490
491
492
493
494
# File 'lib/attributor/types/hash.rb', line 485

def merge(h)
  case h
  when self.class
    self.class.new(contents.merge(h.contents))
  when Attributor::Hash
    raise ArgumentError, "cannot merge Attributor::Hash instances of different types" unless h.is_a?(self.class)
  else
    raise TypeError, "no implicit conversion of #{h.class} into Attributor::Hash"
  end
end

#set(key, value, context: self.generate_subcontext(Attributor::DEFAULT_ROOT_CONTEXT,key), recurse: false) ⇒ Object


344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/attributor/types/hash.rb', line 344

def set(key, value, context: self.generate_subcontext(Attributor::DEFAULT_ROOT_CONTEXT,key), recurse: false)
  key = self.class.key_attribute.load(key, context)

  if self.class.keys.empty?
    return self[key] = self.class.value_attribute.load(value, context)
  end

  if (attribute = self.class.keys[key])
    return self[key] = attribute.load(value, context, recurse: recurse)
  end

  if self.class.options[:case_insensitive_load]
    key = self.class.insensitive_map[key.downcase]
    return self.set(key, value, context: context)
  end

  if self.class.options[:allow_extra]
    if self.class.extra_keys.nil?
      return self[key] = self.class.value_attribute.load(value, context)
    else
      extra_keys_key = self.class.extra_keys

      unless @contents.key? extra_keys_key
        extra_keys_value = self.class.keys[extra_keys_key].load({})
        @contents[extra_keys_key] = extra_keys_value
      end

      return self[extra_keys_key].set(key, value, context: context)
    end
  end

  raise AttributorException, "Unknown key received: #{key.inspect} while loading #{Attributor.humanize_context(context)}"
end

#sizeObject


464
465
466
# File 'lib/attributor/types/hash.rb', line 464

def size
  @contents.size
end

#validate(context = Attributor::DEFAULT_ROOT_CONTEXT) ⇒ Object


530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
# File 'lib/attributor/types/hash.rb', line 530

def validate(context=Attributor::DEFAULT_ROOT_CONTEXT)
  context = [context] if context.is_a? ::String

  if self.class.keys.any?
    extra_keys = @contents.keys - self.class.keys.keys
    if extra_keys.any? && !self.class.options[:allow_extra]
      return extra_keys.collect do |k|
        "#{Attributor.humanize_context(context)} can not have key: #{k.inspect}"
      end
    end

    self.class.keys.each_with_object(Array.new) do |(key, attribute), errors|
      sub_context = self.class.generate_subcontext(context,key)

      value = @contents[key]

      if value.respond_to?(:validating) # really, it's a thing with sub-attributes
        next if value.validating
      end

      errors.push *attribute.validate(value, sub_context)
    end
  else
    @contents.each_with_object(Array.new) do |(key, value), errors|
      # FIXME: the sub contexts and error messages don't really make sense here
      unless key_type == Attributor::Object
        sub_context = context + ["key(#{key.inspect})"]
        errors.push *key_attribute.validate(key, sub_context)
      end

      unless value_type == Attributor::Object
        sub_context = context + ["value(#{value.inspect})"]
        errors.push *value_attribute.validate(value, sub_context)
      end
    end
  end
end

#value_attributeObject


521
522
523
# File 'lib/attributor/types/hash.rb', line 521

def value_attribute
  self.class.value_attribute
end

#value_typeObject


513
514
515
# File 'lib/attributor/types/hash.rb', line 513

def value_type
  self.class.value_type
end

#valuesObject


472
473
474
# File 'lib/attributor/types/hash.rb', line 472

def values
  @contents.values
end