Class: ActiveHash::Base

Inherits:
Object
  • Object
show all
Extended by:
ActiveModel::Naming
Includes:
ActiveModel::Conversion
Defined in:
lib/active_hash/base.rb

Direct Known Subclasses

ActiveFile::Base

Defined Under Namespace

Classes: WhereChain

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) {|_self| ... } ⇒ Base

Returns a new instance of Base.

Yields:

  • (_self)

Yield Parameters:


404
405
406
407
408
409
410
411
# File 'lib/active_hash/base.rb', line 404

def initialize(attributes = {})
  attributes.symbolize_keys!
  @attributes = attributes
  attributes.dup.each do |key, value|
    send "#{key}=", value
  end
  yield self if block_given?
end

Class Method Details

.add_default_value(field_name, default_value) ⇒ Object


277
278
279
280
# File 'lib/active_hash/base.rb', line 277

def add_default_value field_name, default_value
  self.default_attributes ||= {}
  self.default_attributes[field_name] = default_value
end

.add_to_record_index(entry) ⇒ Object


160
161
162
# File 'lib/active_hash/base.rb', line 160

def add_to_record_index(entry)
  record_index.merge!(entry)
end

.all(options = {}) ⇒ Object


187
188
189
# File 'lib/active_hash/base.rb', line 187

def all(options = {})
  ActiveHash::Relation.new(self, @records || [], options[:conditions] || {})
end

.auto_assign_fields(array_of_hashes) ⇒ Object


346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/active_hash/base.rb', line 346

def auto_assign_fields(array_of_hashes)
  (array_of_hashes || []).inject([]) do |array, row|
    row.symbolize_keys!
    row.keys.each do |key|
      unless key.to_s == "id"
        array << key
      end
    end
    array
  end.uniq.each do |key|
    field key
  end
end

.base_classObject

Needed for ActiveRecord polymorphic associations


363
364
365
# File 'lib/active_hash/base.rb', line 363

def base_class
  ActiveHash::Base
end

.cache_keyObject


72
73
74
75
76
77
78
# File 'lib/active_hash/base.rb', line 72

def cache_key
  if Object.const_defined?(:ActiveModel)
    model_name.cache_key
  else
    ActiveSupport::Inflector.tableize(self.name).downcase
  end
end

.compute_type(type_name) ⇒ Object


94
95
96
# File 'lib/active_hash/base.rb', line 94

def compute_type(type_name)
  self
end

.configuration_for_custom_finder(finder_name) ⇒ Object


265
266
267
268
269
270
271
272
273
# File 'lib/active_hash/base.rb', line 265

def configuration_for_custom_finder(finder_name)
  if finder_name.to_s.match(/^find_(all_)?by_(.*?)(!)?$/) && !($1 && $3)
    {
      :all? => !!$1,
      :bang? => !!$3,
      :fields => $2.split('_and_')
    }
  end
end

.create(attributes = {}) ⇒ Object Also known as: add


172
173
174
175
176
177
# File 'lib/active_hash/base.rb', line 172

def create(attributes = {})
  record = new(attributes)
  record.save
  mark_dirty
  record
end

.create!(attributes = {}) ⇒ Object


181
182
183
184
185
# File 'lib/active_hash/base.rb', line 181

def create!(attributes = {})
  record = new(attributes)
  record.save!
  record
end

.dataObject


106
107
108
# File 'lib/active_hash/base.rb', line 106

def data
  _data
end

.data=(array_of_hashes) ⇒ Object


110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/active_hash/base.rb', line 110

def data=(array_of_hashes)
  mark_dirty
  @records = nil
  reset_record_index
  self._data = array_of_hashes
  if array_of_hashes
    auto_assign_fields(array_of_hashes)
    array_of_hashes.each do |hash|
      insert new(hash)
    end
  end
end

.define_custom_find_all_method(field_name) ⇒ Object


329
330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'lib/active_hash/base.rb', line 329

def define_custom_find_all_method(field_name)
  method_name = :"find_all_by_#{field_name}"
  unless singleton_methods.include?(method_name)
    the_meta_class.instance_eval do
      unless singleton_methods.include?(method_name)
        define_method(method_name) do |*args|
          args.extract_options!
          identifier = args[0]
          all.select { |record| record.send(field_name) == identifier }
        end
      end
    end
  end
end

.define_custom_find_method(field_name) ⇒ Object


314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/active_hash/base.rb', line 314

def define_custom_find_method(field_name)
  method_name = :"find_by_#{field_name}"
  unless singleton_methods.include?(method_name)
    the_meta_class.instance_eval do
      define_method(method_name) do |*args|
        args.extract_options!
        identifier = args[0]
        all.detect { |record| record.send(field_name) == identifier }
      end
    end
  end
end

.define_getter_method(field, default_value) ⇒ Object


282
283
284
285
286
287
288
# File 'lib/active_hash/base.rb', line 282

def define_getter_method(field, default_value)
  unless instance_methods.include?(field.to_sym)
    define_method(field) do
      attributes[field].nil? ? default_value : attributes[field]
    end
  end
end

.define_interrogator_method(field) ⇒ Object


303
304
305
306
307
308
309
310
# File 'lib/active_hash/base.rb', line 303

def define_interrogator_method(field)
  method_name = :"#{field}?"
  unless instance_methods.include?(method_name)
    define_method(method_name) do
      send(field).present?
    end
  end
end

.define_setter_method(field) ⇒ Object


292
293
294
295
296
297
298
299
# File 'lib/active_hash/base.rb', line 292

def define_setter_method(field)
  method_name = :"#{field}="
  unless instance_methods.include?(method_name)
    define_method(method_name) do |new_val|
      @attributes[field] = new_val
    end
  end
end

.delete_allObject


203
204
205
206
207
# File 'lib/active_hash/base.rb', line 203

def delete_all
  mark_dirty
  reset_record_index
  @records = []
end

.empty?Boolean

Returns:

  • (Boolean)

102
103
104
# File 'lib/active_hash/base.rb', line 102

def empty?
  false
end

.exists?(record) ⇒ Boolean

Returns:

  • (Boolean)

123
124
125
126
127
# File 'lib/active_hash/base.rb', line 123

def exists?(record)
  if record.id.present?
    record_index[record.id.to_s].present?
  end
end

.field(field_name, options = {}) ⇒ Object


216
217
218
219
220
221
222
223
224
225
226
# File 'lib/active_hash/base.rb', line 216

def field(field_name, options = {})
  validate_field(field_name)
  field_names << field_name

  add_default_value(field_name, options[:default]) if options[:default]
  define_getter_method(field_name, options[:default])
  define_setter_method(field_name)
  define_interrogator_method(field_name)
  define_custom_find_method(field_name)
  define_custom_find_all_method(field_name)
end

.field_namesObject


84
85
86
# File 'lib/active_hash/base.rb', line 84

def field_names
  @field_names ||= []
end

.fields(*args) ⇒ Object


209
210
211
212
213
214
# File 'lib/active_hash/base.rb', line 209

def fields(*args)
  options = args.extract_options!
  args.each do |field|
    field(field, options)
  end
end

.insert(record) ⇒ Object


129
130
131
132
133
134
135
136
137
# File 'lib/active_hash/base.rb', line 129

def insert(record)
  @records ||= []
  record[:id] ||= next_id
  validate_unique_id(record) if dirty
  mark_dirty

  add_to_record_index({ record.id.to_s => @records.length })
  @records << record
end

.mark_cleanObject


386
387
388
# File 'lib/active_hash/base.rb', line 386

def mark_clean
  self.dirty = false
end

.mark_dirtyObject


380
381
382
# File 'lib/active_hash/base.rb', line 380

def mark_dirty
  self.dirty = true
end

.method_missing(method_name, *args) ⇒ Object


246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/active_hash/base.rb', line 246

def method_missing(method_name, *args)
  return super unless respond_to? method_name

  config = configuration_for_custom_finder(method_name)
  attribute_pairs = config[:fields].zip(args)
  matches = all.select { |base| attribute_pairs.all? { |field, value| base.send(field).to_s == value.to_s } }

  if config[:all?]
    matches
  else
    result = matches.first
    if config[:bang?]
      result || raise(RecordNotFound, "Couldn\'t find #{name} with #{attribute_pairs.collect { |pair| "#{pair[0]} = #{pair[1]}" }.join(', ')}")
    else
      result
    end
  end
end

.next_idObject


139
140
141
142
143
144
145
146
# File 'lib/active_hash/base.rb', line 139

def next_id
  max_record = all.max { |a, b| a.id <=> b.id }
  if max_record.nil?
    1
  elsif max_record.id.is_a?(Numeric)
    max_record.id.succ
  end
end

.pluralize_table_namesObject


98
99
100
# File 'lib/active_hash/base.rb', line 98

def pluralize_table_names
  true
end

.polymorphic_nameObject

Needed for ActiveRecord polymorphic associations(rails/rails#32148)


368
369
370
# File 'lib/active_hash/base.rb', line 368

def polymorphic_name
  base_class.name
end

.primary_keyObject


80
81
82
# File 'lib/active_hash/base.rb', line 80

def primary_key
  "id"
end

.record_indexObject


148
149
150
# File 'lib/active_hash/base.rb', line 148

def record_index
  @record_index ||= {}
end

.reloadObject


372
373
374
375
376
# File 'lib/active_hash/base.rb', line 372

def reload
  reset_record_index
  self.data = _data
  mark_clean
end

.reset_record_indexObject


154
155
156
# File 'lib/active_hash/base.rb', line 154

def reset_record_index
  record_index.clear
end

.respond_to?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean)

236
237
238
239
240
241
242
243
244
# File 'lib/active_hash/base.rb', line 236

def respond_to?(method_name, include_private=false)
  super ||
    begin
      config = configuration_for_custom_finder(method_name)
      config && config[:fields].all? do |field|
        field_names.include?(field.to_sym) || field.to_sym == :id
      end
    end
end

.scope(name, body) ⇒ Object

Raises:

  • (ArgumentError)

392
393
394
395
396
397
398
399
400
# File 'lib/active_hash/base.rb', line 392

def scope(name, body)
  raise ArgumentError, 'body needs to be callable' unless body.respond_to?(:call)
  
  the_meta_class.instance_eval do
    define_method(name) do |*args|
      instance_exec(*args, &body)
    end
  end
end

.the_meta_classObject


88
89
90
91
92
# File 'lib/active_hash/base.rb', line 88

def the_meta_class
  class << self
    self
  end
end

.transactionObject


193
194
195
196
197
198
199
200
201
# File 'lib/active_hash/base.rb', line 193

def transaction
  yield
rescue LocalJumpError => err
  raise err
rescue StandardError => e
  unless Object.const_defined?(:ActiveRecord) && e.is_a?(ActiveRecord::Rollback)
    raise e
  end
end

.validate_field(field_name) ⇒ Object


228
229
230
231
232
# File 'lib/active_hash/base.rb', line 228

def validate_field(field_name)
  if [:attributes].include?(field_name.to_sym)
    raise ReservedFieldError.new("#{field_name} is a reserved field in ActiveHash.  Please use another name.")
  end
end

.validate_unique_id(record) ⇒ Object

Raises:


166
167
168
# File 'lib/active_hash/base.rb', line 166

def validate_unique_id(record)
  raise IdError.new("Duplicate ID found for record #{record.attributes.inspect}") if record_index.has_key?(record.id.to_s)
end

Instance Method Details

#[](key) ⇒ Object


421
422
423
# File 'lib/active_hash/base.rb', line 421

def [](key)
  attributes[key]
end

#[]=(key, val) ⇒ Object


430
431
432
# File 'lib/active_hash/base.rb', line 430

def []=(key, val)
  @attributes[key] = val
end

#_read_attribute(key) ⇒ Object Also known as: read_attribute


425
426
427
# File 'lib/active_hash/base.rb', line 425

def _read_attribute(key)
  attributes[key]
end

#attributesObject


413
414
415
416
417
418
419
# File 'lib/active_hash/base.rb', line 413

def attributes
  if self.class.default_attributes
    (self.class.default_attributes.merge @attributes).freeze
  else
    @attributes
  end
end

#cache_keyObject


470
471
472
473
474
475
476
477
478
479
# File 'lib/active_hash/base.rb', line 470

def cache_key
  case
    when new_record?
      "#{self.class.cache_key}/new"
    when timestamp = self[:updated_at]
      "#{self.class.cache_key}/#{id}-#{timestamp.to_s(:number)}"
    else
      "#{self.class.cache_key}/#{id}"
  end
end

#destroyed?Boolean

Returns:

  • (Boolean)

448
449
450
# File 'lib/active_hash/base.rb', line 448

def destroyed?
  false
end

#eql?(other) ⇒ Boolean Also known as: ==

Returns:

  • (Boolean)

460
461
462
# File 'lib/active_hash/base.rb', line 460

def eql?(other)
  other.instance_of?(self.class) and not id.nil? and (id == other.id)
end

#errorsObject


481
482
483
484
485
486
487
488
489
490
491
492
493
# File 'lib/active_hash/base.rb', line 481

def errors
  obj = Object.new

  def obj.[](key)
    []
  end

  def obj.full_messages()
    []
  end

  obj
end

#hashObject


466
467
468
# File 'lib/active_hash/base.rb', line 466

def hash
  id.hash
end

#idObject Also known as: quoted_id


434
435
436
# File 'lib/active_hash/base.rb', line 434

def id
  attributes[:id] ? attributes[:id] : nil
end

#id=(id) ⇒ Object


438
439
440
# File 'lib/active_hash/base.rb', line 438

def id=(id)
  @attributes[:id] = id
end

#marked_for_destruction?Boolean

Returns:

  • (Boolean)

508
509
510
# File 'lib/active_hash/base.rb', line 508

def marked_for_destruction?
  false
end

#new_record?Boolean

Returns:

  • (Boolean)

444
445
446
# File 'lib/active_hash/base.rb', line 444

def new_record?
  !self.class.all.include?(self)
end

#persisted?Boolean

Returns:

  • (Boolean)

452
453
454
# File 'lib/active_hash/base.rb', line 452

def persisted?
  self.class.all.map(&:id).include?(id)
end

#readonly?Boolean

Returns:

  • (Boolean)

456
457
458
# File 'lib/active_hash/base.rb', line 456

def readonly?
  true
end

#save(*args) ⇒ Object Also known as: save!


495
496
497
498
499
500
# File 'lib/active_hash/base.rb', line 495

def save(*args)
  unless self.class.exists?(self)
    self.class.insert(self)
  end
  true
end

#to_paramObject


65
66
67
# File 'lib/active_hash/base.rb', line 65

def to_param
  id.present? ? id.to_s : nil
end

#valid?Boolean

Returns:

  • (Boolean)

504
505
506
# File 'lib/active_hash/base.rb', line 504

def valid?
  true
end