Module: Cistern::Attributes::InstanceMethods

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

Instance Method Summary collapse

Instance Method Details

#_dump(level) ⇒ Object 



117
118
119
 
# File 'lib/cistern/attributes.rb', line 117

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

#attributes ⇒ Object 



153
154
155
 
# File 'lib/cistern/attributes.rb', line 153

def attributes
  @attributes ||= {}
end

#attributes=(attributes) ⇒ Object 



157
158
159
 
# File 'lib/cistern/attributes.rb', line 157

def attributes=(attributes)
  @attributes = attributes
end

#changed ⇒ Object 



232
233
234
 
# File 'lib/cistern/attributes.rb', line 232

def changed
  @changes ||= {}
end

#dirty? ⇒ Boolean

Returns:

  • (Boolean) 


224
225
226
 
# File 'lib/cistern/attributes.rb', line 224

def dirty?
  changed.any?
end

#dirty_attributes ⇒ Object 



228
229
230
 
# File 'lib/cistern/attributes.rb', line 228

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

#dup ⇒ Object 



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

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

#identity ⇒ Object 



167
168
169
 
# File 'lib/cistern/attributes.rb', line 167

def identity
  send(self.class.instance_variable_get('@identity'))
end

#identity=(new_identity) ⇒ Object 



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

def identity=(new_identity)
  send("#{self.class.instance_variable_get('@identity')}=", new_identity)
end

#merge_attributes(new_attributes = {}) ⇒ Object 



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
 
# File 'lib/cistern/attributes.rb', line 175

def merge_attributes(new_attributes = {})
  new_attributes.each do |_key, value|
    key = _key.to_s.to_sym
    # find nested paths
    value.is_a?(::Hash) && self.class.attributes.each do |name, options|
      if (options[:squash] || []).first == key.to_s
        send("#{name}=", {key => value})
      end
    end

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

      protected_methods = Cistern::Model.instance_methods - [:connection, :identity, :collection]

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

#new_record? ⇒ Boolean

Returns:

  • (Boolean) 


203
204
205
 
# File 'lib/cistern/attributes.rb', line 203

def new_record?
  !identity
end

#read_attribute(name) ⇒ Object 



121
122
123
124
125
126
127
 
# File 'lib/cistern/attributes.rb', line 121

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

  attributes.fetch(name.to_s.to_sym, options[:default])
end

#requires(*args) ⇒ Object

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



208
209
210
211
212
213
214
215
 
# File 'lib/cistern/attributes.rb', line 208

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 



217
218
219
220
221
222
 
# File 'lib/cistern/attributes.rb', line 217

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 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/cistern/attributes.rb', line 129

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