-
Notifications
You must be signed in to change notification settings - Fork 229
/
attribute.rb
227 lines (196 loc) · 5.04 KB
/
attribute.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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
159
160
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
189
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
218
219
220
221
222
223
224
225
226
227
module Virtus
# Abstract class implementing base API for attribute types
#
# @abstract
class Attribute
extend DescendantsTracker, TypeLookup, Options
include Adamantium::Flat
include Equalizer.new(inspect) << :name
accept_options :primitive, :accessor, :reader,
:writer, :coerce, :coercion_method, :default, :lazy
accessor :public
coerce true
# Returns name of the attribute
#
# @example
# User.attributes[:age].name # => :age
#
# @return [Symbol]
#
# @api public
attr_reader :name
# Return accessor object
#
# @return [Accessor]
#
# @api private
attr_reader :accessor
# Builds an attribute instance
#
# @param [Symbol] name
# the name of an attribute
#
# @param [Class] type
# optional type class of an attribute
#
# @param [#to_hash] options
# optional extra options hash
#
# @return [Attribute]
#
# @api private
def self.build(name, type = Object, options = {})
klass = determine_type(type) or raise(
ArgumentError, "#{type.inspect} does not map to an attribute type"
)
attribute_options = klass.merge_options(type, options)
accessor = Accessor.build(name, klass, attribute_options)
klass.new(name, accessor)
end
# @api public
def self.coercer(*)
Coercer.new(Virtus.coercer, coercion_method)
end
# @api private
def self.reader_class(*)
Reader
end
# @api private
def self.writer_class(type, options)
options[:coerce] ? coercible_writer_class(type, options) : Writer
end
# @api private
def self.coercible_writer_class(_type, _options)
Writer::Coercible
end
# @api private
def self.reader_options(*)
{}
end
# Return options accepted by Writer
#
# @return [Array<Symbol>]
#
# @api private
def self.writer_options(attribute_options)
::Hash[writer_option_names.zip(attribute_options.values_at(*writer_option_names))]
end
# @api private
def self.writer_option_names
[ :coercer, :primitive, :default ]
end
# Determine attribute type based on class or name
#
# Returns Attribute::EmbeddedValue if a virtus class is passed
#
# @example
# address_class = Class.new { include Virtus }
# Virtus::Attribute.determine_type(address_class) # => Virtus::Attribute::EmbeddedValue
#
# @see Virtus::Support::TypeLookup.determine_type
#
# @return [Class]
#
# @api public
def self.determine_type(class_or_name)
case class_or_name
when ::Class
EmbeddedValue.determine_type(class_or_name) or super
when ::String
super
when ::Enumerable
super(class_or_name.class)
else
super
end
end
# A hook for Attributes to update options based on the type from the caller
#
# @param [Object] type
# The raw type, typically given by the caller of ClassMethods#attribute
# @param [Hash] options
# Attribute configuration options
#
# @return [Hash]
# New Hash instance, potentially updated with information from the args
#
# @api private
def self.merge_options(type, options)
merged_options = self.options.merge(options)
if merged_options[:coerce]
merged_options.update(
:coercer => merged_options.fetch(:coercer) { coercer(type, options) }
)
end
merged_options
end
# Initializes an attribute instance
#
# @param [#to_sym] name
# the name of an attribute
#
# @param [#to_hash] options
# hash of extra options which overrides defaults set on an attribute class
#
# @return [undefined]
#
# @api private
def initialize(name, accessor)
@name = name.to_sym
@accessor = accessor
end
# @api public
def reader
accessor.reader
end
# @api public
def writer
accessor.writer
end
# Define reader and writer methods for an Attribute
#
# @param [AttributeSet] mod
#
# @return [self]
#
# @api private
def define_accessor_methods(attribute_set)
reader.define_method(accessor, attribute_set)
writer.define_method(accessor, attribute_set)
self
end
# Returns a Boolean indicating whether the reader method is public
#
# @return [Boolean]
#
# @api private
def public_reader?
accessor.public_reader?
end
# Returns a Boolean indicating whether the writer method is public
#
# @return [Boolean]
#
# @api private
def public_writer?
accessor.public_writer?
end
# Returns if the given value is coerced into the target type
#
# @return [Boolean]
#
# @api private
def value_coerced?(value)
coercer.coerced?(value)
end
private
# Return coercer for this attribute
#
# @return [Object]
#
# @api private
def coercer
writer.coercer[self.class.primitive]
end
end # class Attribute
end # module Virtus