Class: ActiveHash::Base

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

Direct Known Subclasses

ActiveFile::Base

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Base.

Yields:

  • (_self)

Yield Parameters:



419
420
421
422
423
424
425
426
 
# File 'lib/active_hash/base.rb', line 419

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 



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

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
190
191
 
# File 'lib/active_hash/base.rb', line 187

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

.all_in_process ⇒ Object 



139
140
141
 
# File 'lib/active_hash/base.rb', line 139

def all_in_process
  all
end

.auto_assign_fields(array_of_hashes) ⇒ Object 



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/active_hash/base.rb', line 353

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_class ⇒ Object

Needed for ActiveRecord polymorphic associations



370
371
372
 
# File 'lib/active_hash/base.rb', line 370

def base_class
  ActiveHash::Base
end

.cache_key ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/active_hash/base.rb', line 38

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

.column_names ⇒ Array<String>

Useful for CSV integration needing column names as strings.

Examples:

Usage

class Country < ActiveHash::Base
  fields :name, :code
end

Country.column_names
# => ["id", "name", "code"]

Returns:

  • (Array<String>) —

    An array of column names as strings.



67
68
69
 
# File 'lib/active_hash/base.rb', line 67

def column_names
  field_names.map(&:name)
end

.composite_primary_key? ⇒ Boolean

Needed for ActiveRecord since rails/rails#47664

Returns:

  • (Boolean) 


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

def composite_primary_key?
  false
end

.compute_type(type_name) ⇒ Object 



77
78
79
 
# File 'lib/active_hash/base.rb', line 77

def compute_type(type_name)
  self
end

.configuration_for_custom_finder(finder_name) ⇒ Object 



270
271
272
273
274
275
276
277
278
 
# File 'lib/active_hash/base.rb', line 270

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

.data ⇒ Object 



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

def data
  _data
end

.data=(array_of_hashes) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/active_hash/base.rb', line 93

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 



336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/active_hash/base.rb', line 336

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 



321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/active_hash/base.rb', line 321

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 



289
290
291
292
293
294
295
 
# File 'lib/active_hash/base.rb', line 289

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

.define_interrogator_method(field) ⇒ Object 



310
311
312
313
314
315
316
317
 
# File 'lib/active_hash/base.rb', line 310

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 



299
300
301
302
303
304
305
306
 
# File 'lib/active_hash/base.rb', line 299

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_all ⇒ Object 



205
206
207
208
209
 
# File 'lib/active_hash/base.rb', line 205

def delete_all
  mark_dirty
  reset_record_index
  @records = []
end

.empty? ⇒ Boolean

Returns:

  • (Boolean) 


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

def empty?
  false
end

.exists?(args = :none) ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/active_hash/base.rb', line 106

def exists?(args = :none)
  if args.respond_to?(:id)
    record_index[args.id.to_s].present?
  elsif !args
    false
  elsif args == :none
    all.present?
  elsif args.is_a?(Hash)
    all.where(args).present?
  else
    all.where(id: args.to_s).present?
  end
end

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



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/active_hash/base.rb', line 218

def field(field_name, options = {})
  field_name = field_name.to_sym
  validate_field(field_name)

  field_names << field_name

  add_default_value(field_name, options[:default]) if options.key?(: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_names ⇒ Object 



50
51
52
 
# File 'lib/active_hash/base.rb', line 50

def field_names
  @field_names ||= []
end

.fields(*args) ⇒ Object 



211
212
213
214
215
216
 
# File 'lib/active_hash/base.rb', line 211

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

.has_query_constraints? ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_query_constraints?
  false
end

.insert(record) ⇒ Object 



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

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_clean ⇒ Object 



398
399
400
 
# File 'lib/active_hash/base.rb', line 398

def mark_clean
  self.dirty = false
end

.mark_dirty ⇒ Object 



392
393
394
 
# File 'lib/active_hash/base.rb', line 392

def mark_dirty
  self.dirty = true
end

.method_missing(method_name, *args) ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/active_hash/base.rb', line 251

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_id ⇒ Object 



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

def next_id
  max_record = all_in_process.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_names ⇒ Object 



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

def pluralize_table_names
  true
end

.polymorphic_name ⇒ Object

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



375
376
377
 
# File 'lib/active_hash/base.rb', line 375

def polymorphic_name
  base_class.name
end

.primary_key ⇒ Object 



46
47
48
 
# File 'lib/active_hash/base.rb', line 46

def primary_key
  "id"
end

.record_index ⇒ Object 



144
145
146
 
# File 'lib/active_hash/base.rb', line 144

def record_index
  @record_index ||= {}
end

.reload ⇒ Object 



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

def reload
  reset_record_index
  self.data = _data
  mark_clean
end

.reset_record_index ⇒ Object 



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) 


241
242
243
244
245
246
247
248
249
 
# File 'lib/active_hash/base.rb', line 241

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) 


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

def scope(name, body)
  raise ArgumentError, 'body needs to be callable' unless body.respond_to?(:call)

  self.scopes ||= {}
  self.scopes[name] = body

  the_meta_class.instance_eval do
    define_method(name) do |*args|
      instance_exec(*args, &body)
    end
  end
end

.the_meta_class ⇒ Object 



71
72
73
74
75
 
# File 'lib/active_hash/base.rb', line 71

def the_meta_class
  class << self
    self
  end
end

.transaction ⇒ Object 



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

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 



232
233
234
235
236
237
 
# File 'lib/active_hash/base.rb', line 232

def validate_field(field_name)
  field_name = field_name.to_sym
  if [:attributes].include?(field_name)
    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 



436
437
438
 
# File 'lib/active_hash/base.rb', line 436

def [](key)
  attributes[key]
end

#[]=(key, val) ⇒ Object 



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

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

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



440
441
442
 
# File 'lib/active_hash/base.rb', line 440

def _read_attribute(key)
  attributes[key.to_sym]
end

#attributes ⇒ Object 



428
429
430
431
432
433
434
 
# File 'lib/active_hash/base.rb', line 428

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

#cache_key ⇒ Object 



485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/active_hash/base.rb', line 485

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

#destroyed? ⇒ Boolean

Returns:

  • (Boolean) 


463
464
465
 
# File 'lib/active_hash/base.rb', line 463

def destroyed?
  false
end

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

Returns:

  • (Boolean) 


475
476
477
 
# File 'lib/active_hash/base.rb', line 475

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

#errors ⇒ Object 



500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/active_hash/base.rb', line 500

def errors
  obj = Object.new

  def obj.[](key)
    []
  end

  def obj.full_messages()
    []
  end

  obj
end

#hash ⇒ Object 



481
482
483
 
# File 'lib/active_hash/base.rb', line 481

def hash
  id.hash
end

#id ⇒ Object Also known as: quoted_id 



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

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

#id=(id) ⇒ Object 



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

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

#marked_for_destruction? ⇒ Boolean

Returns:

  • (Boolean) 


527
528
529
 
# File 'lib/active_hash/base.rb', line 527

def marked_for_destruction?
  false
end

#new_record? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#persisted? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#readonly? ⇒ Boolean

Returns:

  • (Boolean) 


471
472
473
 
# File 'lib/active_hash/base.rb', line 471

def readonly?
  true
end

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



514
515
516
517
518
519
 
# File 'lib/active_hash/base.rb', line 514

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

#to_param ⇒ Object 



31
32
33
 
# File 'lib/active_hash/base.rb', line 31

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

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


523
524
525
 
# File 'lib/active_hash/base.rb', line 523

def valid?
  true
end