Class ActiveRecord::Base
In: kirbybase_adapter.rb
Parent: Object

INSTANCE METHODS: Override SQL based methods in ActiveRecord::Base Instance methods: everything invoked from records instances, e.g. book = Book.find(:first); book.destroy

Methods

attributes_to_input_rec   begin_db_transaction   build_conditions_block   build_conditions_from_options   commit_db_transaction   construct_conditions_from_arguments   count   count_by_sql   create_without_callbacks   db   db   decrement_counter   delete   delete_all   destroy_without_callbacks   find   find_by_sql   increment_counter   parse_conditions_from_sql_array   parse_updates_from_sql_array   parse_updates_from_sql_string   rollback_db_transaction   select_all   select_one   serialize   table   table   translate_sql_to_code   type_condition   update_all   update_with_lock   update_without_callbacks   update_without_lock  

Constants

SQL_FRAGMENT_TRANSLATIONS = [ [/1\s*=\s*1/, 'true'], ['rec.', ''], ['==', '='], [/(\w+)\s*=\s*/, 'rec.\1 == '], [/(\w+)\s*<>\s*?/, 'rec.\1 !='], [/(\w+)\s*<\s*?/, 'rec.\1 <'], [/(\w+)\s*>\s*?/, 'rec.\1 >'], [/(\w+)\s*IS\s+NOT\s*?/, 'rec.\1 !='], [/(\w+)\s*IS\s*?/, 'rec.\1 =='], [/(\w+)\s+IN\s+/, 'rec.\1.in'], [/\.id(\W)/i, '.recno\1'], ['<>', '!='], [/\bNULL\b/i, 'nil'], [/\bAND\b/i, 'and'], [/\bOR\b/i, 'or'], ["'%s'", '?'], ['%d', '?'], [/:\w+/, '?'], [/\bid\b/i, 'rec.recno'], ]   TODO: handle LIKE

External Aliases

serialize -> __before_ackbar_serialize

Public Class methods

begin_db_transaction()

NOT SUPPORTED!!!

build_conditions_block(conditions)

Builds the :conditions block from various forms of input.

  • Procs are passed as is
  • Arrays are assumed to be in the format of [‘name = ?’, ‘Assaph’]
  • Fragment String are translated to code Full SQL statements will raise an error
  • No parameters will assume a true for all records
build_conditions_from_options(options)

One of the main methods: Assembles the :conditions block from the options argument (See build_conditions_block for actual translation). Then adds the scope and inheritance-type conditions (if present).

commit_db_transaction()

NOT SUPPORTED!!!

construct_conditions_from_arguments(attribute_names, arguments)

Override of AR::Base SQL construction to build a conditions block. Used only by AR::Base#method_missing to support dynamic finders (e.g. find_by_name).

count(*args)

May also be called with a block, e.g.: 

  Book.count {|rec| rec.author_id == @author.id}
count_by_sql(*args)

NOT SUPPORTED !!!

db()

The KirbyBase object

decrement_counter(counter_name, ids)

Override of AR::Base that was using raw SQL

delete(ids)

Deletes the selected rows from the DB.

delete_all(conditions = nil)

Deletes the matching rows from the table. If no conditions are specified, will clear the whole table.

find(*args)

This methods differs in the API from ActiveRecord::Base#find! The changed options are:

  • :conditions this should be a block for selecting the records
  • :order this should be the symbol of the field name
  • :include: Names associations that should be loaded alongside using KirbyBase Lookup fields

The following work as before:

  • :offset: An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
  • :readonly: Mark the returned records read-only so they cannot be saved or updated.
  • :limit: Max numer of records returned
  • :select: Field names from the table. Not as useful, as joins are irrelevant

The following are not supported (silently ignored);

  • :joins: An SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id".

As a more Kirby-ish way, you can also pass a block to find that will be used to select the matching records. It’s a shortcut to :conditions.

find_by_sql(*args)

NOT SUPPORTED !!!

increment_counter(counter_name, ids)

Override of AR::Base that was using raw SQL

parse_conditions_from_sql_array(sql_parameters_array)

Attempt to parse parameters in the format of [‘name = ? AND value = ?’, some_name, 1] in the :conditions clause

parse_updates_from_sql_array(sql_parameters_array)

Attempt to parse parameters in the format of [‘name = ?’, some_name] for updates

parse_updates_from_sql_string(sql_string)

Attempt to parse parameters in the format of ‘name = "Some Name"’ for updates

serialize(attr_name, class_name = Object)

Serializing a column will cause it to change the column type to :YAML in the database.

table()

The KBTable object for this AR model object

translate_sql_to_code(sql_string)

Translates SQL fragments to a code string. This code string can then be used to construct a code block for KirbyBase. Relies on the SQL_FRAGMENT_TRANSLATIONS series of transformations. Will also remove table names (e.g. people.name) so not safe to use for joins.

type_condition(class_name = nil)

For handling the table inheritance column.

update_all(updates, conditions = nil)

Updates the matching rows from the table. If no conditions are specified, will update all rows in the table.

Public Instance methods

attributes_to_input_rec()

translates the Active-Record instance attributes to a input hash for KirbyBase to be used in insert or update

create_without_callbacks()

Creates a new record with values matching those of the instance attributes.

db()

KirbyBase DB Object

destroy_without_callbacks()

Deletes the matching row for this object

table()

Table for the AR Model class for this record

update_with_lock()

Updates the associated record with values matching those of the instance attributes. Will also check for a lock (See ActiveRecord::Locking.

update_without_callbacks()

Alias for update_with_lock

update_without_lock()

Updates the associated record with values matching those of the instance attributes.

[Validate]