class ActiveRecord::ConnectionAdapters::NullDBAdapter

Constants

TableDefinition

Public Class Methods

insinuate_into_spec(config) click to toggle source

A convenience method for integratinginto RSpec. See README for example of use.

# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 5
def self.insinuate_into_spec(config)
  config.before :all do
    ActiveRecord::Base.establish_connection(:adapter => :nulldb)
  end

  config.after :all do
    ActiveRecord::Base.establish_connection(:test)
  end
end
new(config={}) click to toggle source

Recognized options:

:schema

path to the schema file, relative to Rails.root

:table_definition_class_name

table definition class

(e.g. ActiveRecord::ConnectionAdapters::PostgreSQL::TableDefinition for Postgres) or nil.

Calls superclass method
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 20
def initialize(config={})
  @log            = StringIO.new
  @logger         = Logger.new(@log)
  @last_unique_id = 0
  @tables         = {'schema_info' => new_table_definition(nil)}
  @indexes        = Hash.new { |hash, key| hash[key] = [] }
  @schema_path    = config.fetch(:schema){ "db/schema.rb" }
  @config         = config.merge(:adapter => :nulldb)
  super *initialize_args
  @visitor ||= Arel::Visitors::ToSql.new self if defined?(Arel::Visitors::ToSql)

  if config[:table_definition_class_name]
    ActiveRecord::ConnectionAdapters::NullDBAdapter.send(:remove_const, 'TableDefinition')
    ActiveRecord::ConnectionAdapters::NullDBAdapter.const_set('TableDefinition',
      self.class.const_get(config[:table_definition_class_name]))
  end

  register_types unless NullDB::LEGACY_ACTIVERECORD || \
                        ActiveRecord::VERSION::MAJOR < 4
end

Public Instance Methods

adapter_name() click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 60
def adapter_name
  "NullDB"
end
add_fk_constraint(*args) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 118
def add_fk_constraint(*args)
  # NOOP
end
add_index(table_name, column_names, options = {}) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 80
def add_index(table_name, column_names, options = {})
  column_names = Array.wrap(column_names).map(&:to_s)
  index_name, index_type, ignore = add_index_options(table_name, column_names, options)
  @indexes[table_name] << IndexDefinition.new(table_name, index_name, (index_type == 'UNIQUE'), column_names, [], [])
end
add_index_options(table_name, column_name, options = {}) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 87
def add_index_options(table_name, column_name, options = {})
  column_names = Array.wrap(column_name)
  index_name   = index_name(table_name, :column => column_names)

  if Hash === options # legacy support, since this param was a string
    index_type = options[:unique] ? "UNIQUE" : ""
    index_name = options[:name].to_s if options.key?(:name)
  else
    index_type = options
  end

  if index_name.length > index_name_length
    raise ArgumentError, "Index name '#{index_name}' on table '#{table_name}' is too long; the limit is #{index_name_length} characters"
  end
  if index_name_exists?(table_name, index_name, false)
    raise ArgumentError, "Index name '#{index_name}' on table '#{table_name}' already exists"
  end
  index_columns = quoted_columns_for_index(column_names, options).join(", ")

  [index_name, index_type, index_columns]
end
add_pk_constraint(*args) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 122
def add_pk_constraint(*args)
  # NOOP
end
checkpoint!() click to toggle source

Inserts a checkpoint in the log. See also execution_log_since_checkpoint.

# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 56
def checkpoint!
  self.execution_log << Checkpoint.new
end
columns(table_name, name = nil) click to toggle source

Retrieve table columns as defined by the schema

# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 140
def columns(table_name, name = nil)
  if @tables.size <= 1
    ActiveRecord::Migration.verbose = false
    schema_path = if Pathname(@schema_path).absolute?
                    @schema_path
                  else
                    File.join(NullDB.configuration.project_root, @schema_path)
                  end
    Kernel.load(schema_path)
  end

  if table = @tables[table_name]
    table.columns.map do |col_def|
      col_args = new_column_arguments(col_def)
      ActiveRecord::ConnectionAdapters::NullDBAdapter::Column.new(*col_args)
    end
  else
    []
  end
end
create(statement, name = nil, primary_key = nil, object_id = nil, sequence_name = nil, binds = [])
Alias for: insert
create_table(table_name, options = {}) { |table_definition| ... } click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 68
def create_table(table_name, options = {})
  table_definition = new_table_definition(self, table_name, options.delete(:temporary), options)

  unless options[:id] == false
    table_definition.primary_key(options[:primary_key] || "id")
  end

  yield table_definition if block_given?

  @tables[table_name] = table_definition
end
delete(statement, name=nil, binds = []) click to toggle source
Calls superclass method
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 197
def delete(statement, name=nil, binds = [])
  with_entry_point(:delete) do
    super(statement, name).size
  end
end
enable_extension(*) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 126
def enable_extension(*)
  # NOOP
end
exec_query(statement, name = 'SQL', binds = [], options = {}) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 171
def exec_query(statement, name = 'SQL', binds = [], options = {})
  self.execution_log << Statement.new(entry_point, statement)
  EmptyResult.new
end
execute(statement, name = nil) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 166
def execute(statement, name = nil)
  self.execution_log << Statement.new(entry_point, statement)
  NullObject.new
end
execution_log() click to toggle source

A log of every statement that has been “executed” by this connection adapter instance.

# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 43
def execution_log
  (@execution_log ||= [])
end
execution_log_since_checkpoint() click to toggle source

A log of every statement that has been “executed” since the last time checkpoint! was called, or since the connection was created.

# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 49
def execution_log_since_checkpoint
  checkpoint_index = @execution_log.rindex(Checkpoint.new)
  checkpoint_index = checkpoint_index ? checkpoint_index + 1 : 0
  @execution_log[(checkpoint_index..-1)]
end
index_name_exists?(table_name, index_name, default) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 111
def index_name_exists?(table_name, index_name, default)
  return default unless respond_to?(:indexes)
  index_name = index_name.to_s
  indexes(table_name).detect { |i| i.name == index_name }
end
indexes(table_name, name = nil) click to toggle source

Retrieve table indexes as defined by the schema

# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 162
def indexes(table_name, name = nil)
  @indexes[table_name]
end
insert(statement, name = nil, primary_key = nil, object_id = nil, sequence_name = nil, binds = []) click to toggle source
Calls superclass method
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 182
def insert(statement, name = nil, primary_key = nil, object_id = nil, sequence_name = nil, binds = [])
  (object_id || next_unique_id).tap do
    with_entry_point(:insert) do
      super(statement, name, primary_key, object_id, sequence_name)
    end
  end
end
Also aliased as: create
primary_key(table_name) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 227
def primary_key(table_name)
  columns(table_name).detect { |col| col.sql_type == :primary_key }.try(:name)
end
select_all(statement, name=nil, binds = [], options = {}) click to toggle source
Calls superclass method
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 203
def select_all(statement, name=nil, binds = [], options = {})
  with_entry_point(:select_all) do
    super(statement, name)
  end
end
select_one(statement, name=nil, binds = []) click to toggle source
Calls superclass method
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 209
def select_one(statement, name=nil, binds = [])
  with_entry_point(:select_one) do
    super(statement, name)
  end
end
select_rows(statement, name = nil, binds = []) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 176
def select_rows(statement, name = nil, binds = [])
  [].tap do
    self.execution_log << Statement.new(entry_point, statement)
  end
end
select_value(statement, name=nil, binds = []) click to toggle source
Calls superclass method
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 215
def select_value(statement, name=nil, binds = [])
  with_entry_point(:select_value) do
    super(statement, name)
  end
end
select_values(statement, name=nil) click to toggle source
Calls superclass method
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 221
def select_values(statement, name=nil)
  with_entry_point(:select_values) do
    super(statement, name)
  end
end
supports_migrations?() click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 64
def supports_migrations?
  true
end
tables() click to toggle source

Retrieve the table names defined by the schema

# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 131
def tables
  @tables.keys.map(&:to_s)
end
update(statement, name=nil, binds = []) click to toggle source
Calls superclass method
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 191
def update(statement, name=nil, binds = [])
  with_entry_point(:update) do
    super(statement, name)
  end
end
views() click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 135
def views
  [] # TODO: Implement properly if needed - This is new method in rails
end

Protected Instance Methods

select(statement, name = nil, binds = []) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 233
def select(statement, name = nil, binds = [])
  EmptyResult.new.tap do |r|
    r.bind_column_meta(columns_for(name))
    self.execution_log << Statement.new(entry_point, statement)
  end
end

Private Instance Methods

args_with_optional_cast_type(col_def) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 299
def args_with_optional_cast_type(col_def)
  default_column_arguments(col_def).tap do |args|
    if defined?(ActiveRecord::ConnectionAdapters::SqlTypeMetadata)
      meta = ActiveRecord::ConnectionAdapters::SqlTypeMetadata.new(sql_type: col_def.type)
      args.insert(2, meta_with_limit!(meta, col_def))
    elsif initialize_column_with_cast_type?
      args.insert(2, meta_with_limit!(lookup_cast_type(col_def.type), col_def))
    else
      args[2] = args[2].to_s + "(#{col_def.limit})" if col_def.limit
    end
  end
end
columns_for(table_name) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 242
def columns_for(table_name)
  table_meta = @tables[table_name]
  return [] unless table_meta
  table_meta.columns
end
default_column_arguments(col_def) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 317
def default_column_arguments(col_def)
  if ActiveRecord::VERSION::MAJOR >= 5
    [
      col_def.name.to_s,
      col_def.default,
      col_def.null.nil? || col_def.null # cast  [false, nil, true] => [false, true, true], other adapters default to null=true
    ]
  else
    [
      col_def.name.to_s,
      col_def.default,
      col_def.type,
      col_def.null.nil? || col_def.null # cast  [false, nil, true] => [false, true, true], other adapters default to null=true
    ]
  end
end
entry_point() click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 262
def entry_point
  Thread.current[:entry_point]
end
includes_column?() click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 276
def includes_column?
  false
end
initialize_args() click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 338
def initialize_args
  return [nil, @logger, @config] if ActiveRecord::VERSION::MAJOR > 3
  [nil, @logger]
end
initialize_column_with_cast_type?() click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 334
def initialize_column_with_cast_type?
  ::ActiveRecord::VERSION::MAJOR == 4 && ::ActiveRecord::VERSION::MINOR >= 2
end
meta_with_limit!(meta, col_def) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 312
def meta_with_limit!(meta, col_def)
  meta.instance_variable_set('@limit', col_def.limit)
  meta
end
new_column_arguments(col_def) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 295
def new_column_arguments(col_def)
  args_with_optional_cast_type(col_def)
end
new_table_definition(adapter = nil, table_name = nil, is_temporary = nil, options = {}) click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 280
def new_table_definition(adapter = nil, table_name = nil, is_temporary = nil, options = {})
  case ::ActiveRecord::VERSION::MAJOR
  when 6
    TableDefinition.new(self, table_name, temporary: is_temporary, options: options.except(:id))
  when 5
    TableDefinition.new(table_name, is_temporary, options.except(:id), nil)
  when 4
    TableDefinition.new(native_database_types, table_name, is_temporary, options)
  when 2,3
    TableDefinition.new(adapter)
  else
    raise "Unsupported ActiveRecord version #{::ActiveRecord::VERSION::STRING}"
  end
end
next_unique_id() click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 248
def next_unique_id
  @last_unique_id += 1
end
register_types() click to toggle source

4.2 introduced ActiveRecord::Type github.com/rails/rails/tree/4-2-stable/activerecord/lib/active_record

# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 345
def register_types
  if ActiveRecord::VERSION::MAJOR < 5
    type_map.register_type(:primary_key, ActiveRecord::Type::Integer.new)
  else      
    require 'active_model/type'
    ActiveRecord::Type.register(
      :primary_key,
      ActiveModel::Type::Integer,
      adapter: adapter_name,
      override: true
    )
  end
end
with_entry_point(method) { || ... } click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 252
def with_entry_point(method)
  if entry_point.nil?
    with_thread_local_variable(:entry_point, method) do
      yield
    end
  else
    yield
  end
end
with_thread_local_variable(name, value) { || ... } click to toggle source
# File lib/active_record/connection_adapters/nulldb_adapter/core.rb, line 266
def with_thread_local_variable(name, value)
  old_value = Thread.current[name]
  Thread.current[name] = value
  begin
    yield
  ensure
    Thread.current[name] = old_value
  end
end