class ActiveHash::Base

Public Class Methods

add(attributes = {})
Alias for: create
add_default_value(field_name, default_value) click to toggle source
# 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
all(options = {}) click to toggle source
# File lib/active_hash/base.rb, line 187
def all(options = {})
  ActiveHash::Relation.new(self, @records || [], options[:conditions] || {})
end
base_class() click to toggle source

Needed for ActiveRecord polymorphic associations

# File lib/active_hash/base.rb, line 363
def base_class
  ActiveHash::Base
end
cache_key() click to toggle source
# 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) click to toggle source
# File lib/active_hash/base.rb, line 94
def compute_type(type_name)
  self
end
create(attributes = {}) click to toggle source
# File lib/active_hash/base.rb, line 172
def create(attributes = {})
  record = new(attributes)
  record.save
  mark_dirty
  record
end
Also aliased as: add
create!(attributes = {}) click to toggle source
# File lib/active_hash/base.rb, line 181
def create!(attributes = {})
  record = new(attributes)
  record.save!
  record
end
data() click to toggle source
# File lib/active_hash/base.rb, line 106
def data
  _data
end
data=(array_of_hashes) click to toggle source
# 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
delete_all() click to toggle source
# File lib/active_hash/base.rb, line 203
def delete_all
  mark_dirty
  reset_record_index
  @records = []
end
empty?() click to toggle source
# File lib/active_hash/base.rb, line 102
def empty?
  false
end
exists?(record) click to toggle source
# 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 = {}) click to toggle source
# 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_names() click to toggle source
# File lib/active_hash/base.rb, line 84
def field_names
  @field_names ||= []
end
fields(*args) click to toggle source
# 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) click to toggle source
# 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
method_missing(method_name, *args) click to toggle source
Calls superclass method
# 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
new(attributes = {}) { |self| ... } click to toggle source
# 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
next_id() click to toggle source
# 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_names() click to toggle source
# File lib/active_hash/base.rb, line 98
def pluralize_table_names
  true
end
polymorphic_name() click to toggle source

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

# File lib/active_hash/base.rb, line 368
def polymorphic_name
  base_class.name
end
primary_key() click to toggle source
# File lib/active_hash/base.rb, line 80
def primary_key
  "id"
end
respond_to?(method_name, include_private=false) click to toggle source
Calls superclass method
# 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) click to toggle source
# 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_class() click to toggle source
# File lib/active_hash/base.rb, line 88
def the_meta_class
  class << self
    self
  end
end
transaction() { || ... } click to toggle source
# 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

Private Class Methods

add_to_record_index(entry) click to toggle source
# File lib/active_hash/base.rb, line 160
def add_to_record_index(entry)
  record_index.merge!(entry)
end
auto_assign_fields(array_of_hashes) click to toggle source
# 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
configuration_for_custom_finder(finder_name) click to toggle source
# 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
define_custom_find_all_method(field_name) click to toggle source
# 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) click to toggle source
# 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) click to toggle source
# 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) click to toggle source
# 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) click to toggle source
# 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
mark_clean() click to toggle source
# File lib/active_hash/base.rb, line 386
def mark_clean
  self.dirty = false
end
mark_dirty() click to toggle source
# File lib/active_hash/base.rb, line 380
def mark_dirty
  self.dirty = true
end
record_index() click to toggle source
# File lib/active_hash/base.rb, line 148
def record_index
  @record_index ||= {}
end
reload() click to toggle source
# File lib/active_hash/base.rb, line 372
def reload
  reset_record_index
  self.data = _data
  mark_clean
end
reset_record_index() click to toggle source
# File lib/active_hash/base.rb, line 154
def reset_record_index
  record_index.clear
end
validate_field(field_name) click to toggle source
# 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) click to toggle source
# 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

Public Instance Methods

==(other)
Alias for: eql?
[](key) click to toggle source
# File lib/active_hash/base.rb, line 421
def [](key)
  attributes[key]
end
[]=(key, val) click to toggle source
# File lib/active_hash/base.rb, line 430
def []=(key, val)
  @attributes[key] = val
end
_read_attribute(key) click to toggle source
# File lib/active_hash/base.rb, line 425
def _read_attribute(key)
  attributes[key]
end
Also aliased as: read_attribute
attributes() click to toggle source
# 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_key() click to toggle source
# 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?() click to toggle source
# File lib/active_hash/base.rb, line 448
def destroyed?
  false
end
eql?(other) click to toggle source
# 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
Also aliased as: ==
errors() click to toggle source
# File lib/active_hash/base.rb, line 481
def errors
  obj = Object.new

  def obj.[](key)
    []
  end

  def obj.full_messages()
    []
  end

  obj
end
hash() click to toggle source
# File lib/active_hash/base.rb, line 466
def hash
  id.hash
end
id() click to toggle source
# File lib/active_hash/base.rb, line 434
def id
  attributes[:id] ? attributes[:id] : nil
end
Also aliased as: quoted_id
id=(id) click to toggle source
# File lib/active_hash/base.rb, line 438
def id=(id)
  @attributes[:id] = id
end
marked_for_destruction?() click to toggle source
# File lib/active_hash/base.rb, line 508
def marked_for_destruction?
  false
end
new_record?() click to toggle source
# File lib/active_hash/base.rb, line 444
def new_record?
  !self.class.all.include?(self)
end
persisted?() click to toggle source
# File lib/active_hash/base.rb, line 452
def persisted?
  self.class.all.map(&:id).include?(id)
end
quoted_id()
Alias for: id
read_attribute(key)
Alias for: _read_attribute
readonly?() click to toggle source
# File lib/active_hash/base.rb, line 456
def readonly?
  true
end
save(*args) click to toggle source
# File lib/active_hash/base.rb, line 495
def save(*args)
  unless self.class.exists?(self)
    self.class.insert(self)
  end
  true
end
Also aliased as: save!
save!(*args)
Alias for: save
to_param() click to toggle source
# File lib/active_hash/base.rb, line 65
def to_param
  id.present? ? id.to_s : nil
end
valid?() click to toggle source
# File lib/active_hash/base.rb, line 504
def valid?
  true
end