Module: Cistern::Attributes::InstanceMethods

Included in:
Model, Singular
Defined in:
lib/cistern/attributes.rb

Instance Method Summary collapse

Instance Method Details

#_dump(level) ⇒ Object 



119
120
121
 
# File 'lib/cistern/attributes.rb', line 119

def _dump(level)
  Marshal.dump(attributes)
end

#attributes ⇒ Object 



161
162
163
 
# File 'lib/cistern/attributes.rb', line 161

def attributes
  @attributes ||= {}
end

#attributes=(attributes) ⇒ Object 



165
166
167
 
# File 'lib/cistern/attributes.rb', line 165

def attributes=(attributes)
  @attributes = attributes
end

#changed ⇒ Object 



263
264
265
 
# File 'lib/cistern/attributes.rb', line 263

def changed
  @changes ||= {}
end

#dirty? ⇒ Boolean

Returns:

  • (Boolean) 


255
256
257
 
# File 'lib/cistern/attributes.rb', line 255

def dirty?
  changed.any?
end

#dirty_attributes ⇒ Object 



259
260
261
 
# File 'lib/cistern/attributes.rb', line 259

def dirty_attributes
  changed.inject({}) { |r,(k,(_,v))| r.merge(k => v) }
end

#dup ⇒ Object 



169
170
171
172
173
 
# File 'lib/cistern/attributes.rb', line 169

def dup
  copy = super
  copy.attributes = copy.attributes.dup
  copy
end

#identity ⇒ Object 



175
176
177
178
179
180
181
 
# File 'lib/cistern/attributes.rb', line 175

def identity
  key = self.class.instance_variable_get('@identity')

  if key
    public_send(key)
  end
end

#identity=(new_identity) ⇒ Object 



183
184
185
186
187
188
189
190
191
 
# File 'lib/cistern/attributes.rb', line 183

def identity=(new_identity)
  key = self.class.instance_variable_get('@identity')

  if key
    public_send("#{key}=", new_identity)
  else
    raise ArgumentError, "Identity not specified"
  end
end

#merge_attributes(new_attributes = {}) ⇒ Object 



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
228
229
230
231
232
 
# File 'lib/cistern/attributes.rb', line 193

def merge_attributes(new_attributes = {})
  protected_methods  = (Cistern::Model.instance_methods - [:service, :identity, :collection])
  ignored_attributes = self.class.ignored_attributes
  class_attributes   = self.class.attributes
  class_aliases      = self.class.aliases

  new_attributes.each do |_key, value|
    string_key = _key.kind_of?(String) ? _key : _key.to_s
    symbol_key = case _key
          when String
            _key.to_sym
          when Symbol
            _key
          else
            string_key.to_sym
          end

    # find nested paths
    value.is_a?(::Hash) && class_attributes.each do |name, options|
      if options[:squash] && options[:squash].first == string_key
        send("#{name}=", {symbol_key => value})
      end
    end

    unless ignored_attributes.include?(symbol_key)
      if class_aliases.has_key?(symbol_key)
        class_aliases[symbol_key].each do |aliased_key|
          send("#{aliased_key}=", value)
        end
      end

      assignment_method = "#{string_key}="
      if !protected_methods.include?(symbol_key) && self.respond_to?(assignment_method, true)
        send(assignment_method, value)
      end
    end
  end
  changed.clear
  self
end

#new_record? ⇒ Boolean

Returns:

  • (Boolean) 


234
235
236
 
# File 'lib/cistern/attributes.rb', line 234

def new_record?
  identity.nil?
end

#read_attribute(name) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/cistern/attributes.rb', line 123

def read_attribute(name)
  options = self.class.attributes[name] || {}
  # record the attribute was accessed
  self.class.attributes[name.to_s.to_sym][:coverage_hits] += 1 rescue nil

  default = options[:default]

  unless default.nil?
    default = Marshal.load(Marshal.dump(default))
  end

  attributes.fetch(name.to_s.to_sym, default)
end

#requires(*args) ⇒ Object

check that the attributes specified in args exist and is not nil



239
240
241
242
243
244
245
246
 
# File 'lib/cistern/attributes.rb', line 239

def requires(*args)
  missing = missing_attributes(args)
  if missing.length == 1
    raise(ArgumentError, "#{missing.first} is required for this operation")
  elsif missing.any?
    raise(ArgumentError, "#{missing[0...-1].join(", ")} and #{missing[-1]} are required for this operation")
  end
end

#requires_one(*args) ⇒ Object 



248
249
250
251
252
253
 
# File 'lib/cistern/attributes.rb', line 248

def requires_one(*args)
  missing = missing_attributes(args)
  if missing.length == args.length
    raise(ArgumentError, "#{missing[0...-1].join(", ")} or #{missing[-1]} are required for this operation")
  end
end

#write_attribute(name, value) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/cistern/attributes.rb', line 137

def write_attribute(name, value)
  options = self.class.attributes[name] || {}

  transform = Cistern::Attributes.transforms[options[:squash] ? :squash : :none] ||
    Cistern::Attributes.default_transform

  parser = Cistern::Attributes.parsers[options[:type]] ||
    options[:parser] ||
    Cistern::Attributes.default_parser

  transformed = transform.call(name, value, options)

  new_value = parser.call(transformed, options)
  attribute = name.to_s.to_sym

  previous_value = attributes[attribute]

  attributes[attribute] = new_value

  changed!(attribute, previous_value, new_value)

  new_value
end