Class: Attributor::Model

Inherits:
Hash
  • Object
show all
Defined in:
lib/attributor/types/model.rb

Direct Known Subclasses

FileUpload, Struct

Constant Summary

Constants inherited from Hash

Hash::CIRCULAR_REFERENCE_MARKER, Hash::MAX_EXAMPLE_DEPTH

Instance Attribute Summary

Attributes inherited from Hash

#contents, #dumping, #validating

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Hash

#==, #[], #[]=, #_get_attr, add_requirement, as_json_schema, attributes, construct, constructable?, definition, #delete, describe, dsl_class, dump, #each, #empty?, example_contents, family, from_hash, #generate_subcontext, #get, #get_generic, json_schema_type, #key?, #key_attribute, #key_type, keys, #keys, load, load_generic, #merge, native_type, of, parse, #set, #size, slice!, #to_h, valid_type?, validate, #validate_generic, #validate_keys, #value_attribute, #value_type, #values

Methods included from Container

included

Constructor Details

#initialize(data = nil) ⇒ Model

Returns a new instance of Model.



116
117
118
119
120
121
122
123
 
# File 'lib/attributor/types/model.rb', line 116

def initialize(data = nil)
  if data
    loaded = self.class.load(data)
    @contents = loaded.attributes
  else
    @contents = {}
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/attributor/types/model.rb', line 153

def method_missing(name, *args)
  attribute_name = name.to_s
  attribute_name.chomp!('=')

  if self.class.attributes.key?(attribute_name.to_sym)
    self.class.define_accessors(attribute_name)
    return __send__(name, *args)
  end

  super
end

Class Method Details

.check_option!(name, value) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/attributor/types/model.rb', line 81

def self.check_option!(name, value)
  case name
  when :identity
    raise AttributorException, "Invalid identity type #{value.inspect}" unless value.is_a?(::Symbol)
    :ok # FIXME: ... actually do something smart, that doesn't break lazy attribute creation
  when :reference
    :ok # FIXME: ... actually do something smart
  when :dsl_compiler
    :ok # FIXME: ... actually do something smart
  when :dsl_compiler_options
    :ok
  else
    super
  end
end

.define_accessors(name) ⇒ Object

Define accessors for attribute of given name.

Parameters:

  • name (::Symbol) —

    attribute name



58
59
60
61
62
 
# File 'lib/attributor/types/model.rb', line 58

def self.define_accessors(name)
  name = name.to_sym
  define_reader(name)
  define_writer(name)
end

.define_reader(name) ⇒ Object 



64
65
66
67
68
69
70
 
# File 'lib/attributor/types/model.rb', line 64

def self.define_reader(name)
  module_eval <<-RUBY, __FILE__, __LINE__ + 1
    def #{name}
      @contents[:#{name}]
    end
  RUBY
end

.define_writer(name) ⇒ Object 



72
73
74
75
76
77
78
79
 
# File 'lib/attributor/types/model.rb', line 72

def self.define_writer(name)
  context = ['assignment', "of(#{name})"].freeze
  module_eval do
    define_method(name.to_s + '=') do |value|
      set(name, value, context: context)
    end
  end
end

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/attributor/types/model.rb', line 101

def self.example(context = nil, **values)
  context ||= ["#{name || 'Struct'}-#{rand(10_000_000)}"]
  context = Array(context)

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

    result.lazy_attributes = example_contents(context, result, **values)
  else
    result = new
  end
  result
end

.generate_subcontext(context, subname) ⇒ Object 



97
98
99
 
# File 'lib/attributor/types/model.rb', line 97

def self.generate_subcontext(context, subname)
  context + [subname]
end

.inherited(klass) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/attributor/types/model.rb', line 31

def self.inherited(klass)
  k = key_type
  ka = key_attribute

  v = value_type
  va = value_attribute

  klass.instance_eval do
    @saved_blocks = []
    @options = {}
    @keys = {}
    @key_type = k
    @value_type = v

    @key_attribute = ka
    @value_attribute = va

    @requirements = []
    @cached_defaults = {}
    @error = false
  end
end

Instance Method Details

#attributes ⇒ Object 



140
141
142
 
# File 'lib/attributor/types/model.rb', line 140

def attributes
  @contents
end

#dump(context: Attributor::DEFAULT_ROOT_CONTEXT, **_opts) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/attributor/types/model.rb', line 165

def dump(context: Attributor::DEFAULT_ROOT_CONTEXT, **_opts)
  return CIRCULAR_REFERENCE_MARKER if @dumping
  @dumping = true

  attributes.each_with_object({}) do |(name, value), hash|
    attribute = self.class.attributes[name]

    # skip dumping undefined attributes
    unless attribute
      warn "WARNING: Trying to dump unknown attribute: #{name.inspect} with context: #{context.inspect}"
      next
    end

    hash[name.to_sym] = attribute.dump(value, context: context + [name], **_opts)
  end
ensure
  @dumping = false
end

#respond_to_missing?(name) ⇒ Boolean

Returns:



144
145
146
147
148
149
150
151
 
# File 'lib/attributor/types/model.rb', line 144

def respond_to_missing?(name, *)
  attribute_name = name.to_s
  attribute_name.chomp!('=')

  return true if self.class.attributes.key?(attribute_name.to_sym)

  super
end

#to_hash ⇒ Object

This allows the splatting of these instances into method calls (top level hash conversion only)



185
186
187
 
# File 'lib/attributor/types/model.rb', line 185

def to_hash
  @contents
end

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

TODO: memoize validation results here, but only after rejiggering how we store the context.

Two calls to validate() with different contexts should return get the same errors,
but with their respective contexts.



128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/attributor/types/model.rb', line 128

def validate(context = Attributor::DEFAULT_ROOT_CONTEXT)
  raise AttributorException, 'validation conflict' if @validating
  @validating = true

  context = [context] if context.is_a? ::String
  # Use the common, underlying attribute validation of the hash (which will use our _get_attr)
  # to know how to retrieve a value from a model (instead of a hash)
  validate_keys(context)
ensure
  @validating = false
end