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, attributes, construct, constructable?, definition, #delete, describe, dsl_class, dump, #each, #empty?, example_contents, family, from_hash, #generate_subcontext, #get, #key?, #key_attribute, #key_type, keys, #keys, load, #merge, native_type, of, #set, #size, valid_type?, validate, #value_attribute, #value_type, #values

Methods included from Container

included

Constructor Details

#initialize(data = nil) ⇒ Model

Returns a new instance of Model.



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

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 



176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/attributor/types/model.rb', line 176

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

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

  super
end

Class Method Details

.check_option!(name, value) ⇒ Object 



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

def self.check_option!(name, value)
  case name
  when :identity
    raise AttributorException, "Invalid identity type #{value.inspect}" unless value.kind_of?(::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



55
56
57
58
59
 
# File 'lib/attributor/types/model.rb', line 55

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

.define_reader(name) ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/attributor/types/model.rb', line 61

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

.define_writer(name) ⇒ Object 



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

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

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



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

def self.example(context=nil, **values)
  context ||= ["#{self.name || 'Struct'}-#{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
    result = self.new
  end
  result
end

.generate_subcontext(context, subname) ⇒ Object 



95
96
97
 
# File 'lib/attributor/types/model.rb', line 95

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

.inherited(klass) ⇒ Object 



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

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

  v = self.value_type
  va = self.value_attribute

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

    @key_attribute = ka
    @value_attribute = va

    @requirements = []
    @error = false
  end
end

Instance Method Details

#attributes ⇒ Object 



161
162
163
 
# File 'lib/attributor/types/model.rb', line 161

def attributes
  @contents
end

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/attributor/types/model.rb', line 189

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

  self.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] )
  end
ensure
  @dumping = false
end

#respond_to_missing?(name) ⇒ Boolean

Returns:



166
167
168
169
170
171
172
173
 
# File 'lib/attributor/types/model.rb', line 166

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

#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.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/attributor/types/model.rb', line 127

def validate(context=Attributor::DEFAULT_ROOT_CONTEXT)

  raise AttributorException, "validation conflict" if @validating
  @validating = true

  context = [context] if context.is_a? ::String
  keys_with_values = []
  errors = []

  self.class.attributes.each do |sub_attribute_name, sub_attribute|
    sub_context = self.class.generate_subcontext(context,sub_attribute_name)

    value = self.__send__(sub_attribute_name)
    unless value.nil?
      keys_with_values << sub_attribute_name
    end

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

    errors.push(*sub_attribute.validate(value, sub_context))
  end
  self.class.requirements.each do |req|
    validation_errors = req.validate(keys_with_values, context)
    errors.push(*validation_errors) unless validation_errors.empty?
  end

  errors
ensure
  @validating = false
end