Class: ActiveRecord::ConnectionAdapters::NullDBAdapter

Inherits:
AbstractAdapter
  • Object
show all
Defined in:
lib/active_record/connection_adapters/nulldb_adapter/table_definition.rb,
lib/active_record/connection_adapters/nulldb_adapter/index_definition.rb,
lib/active_record/connection_adapters/nulldb_adapter/configuration.rb,
lib/active_record/connection_adapters/nulldb_adapter/empty_result.rb,
lib/active_record/connection_adapters/nulldb_adapter/null_object.rb,
lib/active_record/connection_adapters/nulldb_adapter/checkpoint.rb,
lib/active_record/connection_adapters/nulldb_adapter/statement.rb,
lib/active_record/connection_adapters/nulldb_adapter/column.rb,
lib/active_record/connection_adapters/nulldb_adapter/core.rb

Defined Under Namespace

Classes: Checkpoint, Column, Configuration, EmptyResult, IndexDefinition, NullObject, Statement

Constant Summary collapse

TableDefinition =
ActiveRecord::ConnectionAdapters::TableDefinition

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = {}) ⇒ NullDBAdapter

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.


20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# 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

Class Method Details

.insinuate_into_spec(config) ⇒ Object

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


5
6
7
8
9
10
11
12
13
# 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

Instance Method Details

#adapter_nameObject


60
61
62
# File 'lib/active_record/connection_adapters/nulldb_adapter/core.rb', line 60

def adapter_name
  "NullDB"
end

#add_fk_constraint(*args) ⇒ Object


118
119
120
# 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 = {}) ⇒ Object


80
81
82
83
84
# 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 = {}) ⇒ Object


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# 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) ⇒ Object


122
123
124
# File 'lib/active_record/connection_adapters/nulldb_adapter/core.rb', line 122

def add_pk_constraint(*args)
  # NOOP
end

#checkpoint!Object

Inserts a checkpoint in the log. See also #execution_log_since_checkpoint.


56
57
58
# 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) ⇒ Object

Retrieve table columns as defined by the schema


140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# 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_table(table_name, options = {}) {|table_definition| ... } ⇒ Object

Yields:

  • (table_definition)

68
69
70
71
72
73
74
75
76
77
78
# 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 = []) ⇒ Object


197
198
199
200
201
# 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_extensionObject


126
127
128
# File 'lib/active_record/connection_adapters/nulldb_adapter/core.rb', line 126

def enable_extension(*)
  # NOOP
end

#exec_query(statement, name = 'SQL', binds = [], options = {}) ⇒ Object


171
172
173
174
# 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) ⇒ Object


166
167
168
169
# 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_logObject

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


43
44
45
# File 'lib/active_record/connection_adapters/nulldb_adapter/core.rb', line 43

def execution_log
  (@execution_log ||= [])
end

#execution_log_since_checkpointObject

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


49
50
51
52
53
# 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) ⇒ Boolean

Returns:

  • (Boolean)

111
112
113
114
115
# 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) ⇒ Object

Retrieve table indexes as defined by the schema


162
163
164
# 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 = []) ⇒ Object Also known as: create


182
183
184
185
186
187
188
# 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

#primary_key(table_name) ⇒ Object


227
228
229
# 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 = {}) ⇒ Object


203
204
205
206
207
# 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 = []) ⇒ Object


209
210
211
212
213
# 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 = []) ⇒ Object


176
177
178
179
180
# 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 = []) ⇒ Object


215
216
217
218
219
# 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) ⇒ Object


221
222
223
224
225
# 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?Boolean

Returns:

  • (Boolean)

64
65
66
# File 'lib/active_record/connection_adapters/nulldb_adapter/core.rb', line 64

def supports_migrations?
  true
end

#tablesObject

Retrieve the table names defined by the schema


131
132
133
# 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 = []) ⇒ Object


191
192
193
194
195
# 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

#viewsObject


135
136
137
# 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