Class: ActiveHash::Base

Inherits:
Object
  • Object
show all
Extended by:
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:



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

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 



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

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 



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

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

.all(options = {}) ⇒ Object 



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

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

.all_in_process ⇒ Object 



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

def all_in_process
  all
end

.auto_assign_fields(array_of_hashes) ⇒ Object 



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

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



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

def base_class
  ActiveHash::Base
end

.cache_key ⇒ Object 



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

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.



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

def column_names
  field_names.map(&:name)
end

.composite_primary_key? ⇒ Boolean

Needed for ActiveRecord since rails/rails#47664

Returns:

  • (Boolean) 


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

def composite_primary_key?
  false
end

.compute_type(type_name) ⇒ Object 



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

def compute_type(type_name)
  self
end

.configuration_for_custom_finder(finder_name) ⇒ Object 



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

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 



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

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

.create!(attributes = {}) ⇒ Object 



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

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

.data ⇒ Object 



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

def data
  _data
end

.data=(array_of_hashes) ⇒ Object 



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

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 



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

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 



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

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 



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

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 



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

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 



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

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 



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

def delete_all
  mark_dirty
  reset_record_index
  @records = []
end

.empty? ⇒ Boolean

Returns:

  • (Boolean) 


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

def empty?
  false
end

.exists?(args = :none) ⇒ Boolean

Returns:

  • (Boolean) 


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

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_i).present?
  end
end

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



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

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 



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

def field_names
  @field_names ||= []
end

.fields(*args) ⇒ Object 



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

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

.has_query_constraints? ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_query_constraints?
  false
end

.insert(record) ⇒ Object 



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

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 



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

def mark_clean
  self.dirty = false
end

.mark_dirty ⇒ Object 



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

def mark_dirty
  self.dirty = true
end

.method_missing(method_name, *args) ⇒ Object 



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

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 



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

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 



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

def pluralize_table_names
  true
end

.polymorphic_name ⇒ Object

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



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

def polymorphic_name
  base_class.name
end

.primary_key ⇒ Object 



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

def primary_key
  "id"
end

.record_index ⇒ Object 



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

def record_index
  @record_index ||= {}
end

.reload ⇒ Object 



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

def reload
  reset_record_index
  self.data = _data
  mark_clean
end

.reset_record_index ⇒ Object 



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

def reset_record_index
  record_index.clear
end

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

Returns:

  • (Boolean) 


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

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) 


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

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 



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

def the_meta_class
  class << self
    self
  end
end

.transaction ⇒ Object 



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

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 



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

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:



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

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 



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

def [](key)
  attributes[key]
end

#[]=(key, val) ⇒ Object 



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

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

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



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

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

#attributes ⇒ Object 



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

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

#cache_key ⇒ Object 



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

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) 


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

def destroyed?
  false
end

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

Returns:

  • (Boolean) 


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

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

#errors ⇒ Object 



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

def errors
  obj = Object.new

  def obj.[](key)
    []
  end

  def obj.full_messages()
    []
  end

  obj
end

#hash ⇒ Object 



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

def hash
  id.hash
end

#id ⇒ Object Also known as: quoted_id 



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

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

#id=(id) ⇒ Object 



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

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

#marked_for_destruction? ⇒ Boolean

Returns:

  • (Boolean) 


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

def marked_for_destruction?
  false
end

#new_record? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#persisted? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#readonly? ⇒ Boolean

Returns:

  • (Boolean) 


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

def readonly?
  true
end

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



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

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

#to_param ⇒ Object 



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

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

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def valid?
  true
end