Class: ActiveRecord::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/composite_primary_keys/base.rb,
lib/composite_primary_keys/connection_adapters/abstract/connection_specification_changes.rb

Defined Under Namespace

Modules: CompositeClassMethods, CompositeInstanceMethods

Constant Summary collapse

INVALID_FOR_COMPOSITE_KEYS =
'Not appropriate for composite primary keys'
NOT_IMPLEMENTED_YET =
'Not implemented for composite primary keys yet'

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.clear_active_connections!Object



64
65
66
# File 'lib/composite_primary_keys/connection_adapters/abstract/connection_specification_changes.rb', line 64

def clear_active_connections!
  connection_handler.clear_active_connections!
end

.composite?Boolean

Returns:

  • (Boolean)


53
54
55
# File 'lib/composite_primary_keys/base.rb', line 53

def composite?
  false
end

.connected?Boolean

Returns true if Active Record is connected.

Returns:

  • (Boolean)


56
57
58
# File 'lib/composite_primary_keys/connection_adapters/abstract/connection_specification_changes.rb', line 56

def connected?
  connection_handler.connected?(connection_specification_name)
end

.connectionObject

Returns the connection currently associated with the class. This can also be used to “borrow” the connection to do database work unrelated to any of the specific Active Records.



33
34
35
# File 'lib/composite_primary_keys/connection_adapters/abstract/connection_specification_changes.rb', line 33

def connection
  retrieve_connection
end

.connection_configObject

Returns the configuration of the associated connection as a hash:

ActiveRecord::Base.connection_config
# => {:pool=>5, :timeout=>5000, :database=>"db/development.sqlite3", :adapter=>"sqlite3"}

Please use only for reading.



43
44
45
# File 'lib/composite_primary_keys/connection_adapters/abstract/connection_specification_changes.rb', line 43

def connection_config
  connection_pool.spec.config
end

.connection_poolObject



47
48
49
# File 'lib/composite_primary_keys/connection_adapters/abstract/connection_specification_changes.rb', line 47

def connection_pool
  connection_handler.retrieve_connection_pool(connection_specification_name)
end

.establish_connection(spec = nil) ⇒ Object



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/composite_primary_keys/connection_adapters/abstract/connection_specification_changes.rb', line 12

def self.establish_connection(spec = nil)
  spec     ||= ActiveRecord::ConnectionHandling::DEFAULT_ENV.call.to_sym
  resolver =   ConnectionAdapters::ConnectionSpecification::Resolver.new configurations
  spec     =   resolver.spec(spec, self == Base ? "primary" : name)
  self.connection_specification_name = spec.name

  # CPK
  load_cpk_adapter(spec.config[:adapter])

  unless respond_to?(spec.adapter_method)
    raise AdapterNotFound, "database configuration specifies nonexistent #{spec.config[:adapter]} adapter"
  end

  remove_connection
  connection_handler.establish_connection spec
end

.load_cpk_adapter(adapter) ⇒ Object



3
4
5
6
7
8
9
10
# File 'lib/composite_primary_keys/connection_adapters/abstract/connection_specification_changes.rb', line 3

def self.load_cpk_adapter(adapter)
  if adapter.to_s =~ /postgresql/ || adapter.to_s =~ /postgis/
    require "composite_primary_keys/connection_adapters/postgresql_adapter.rb"
  end
  if adapter.to_s =~ /sqlserver/
    require "composite_primary_keys/connection_adapters/sqlserver_adapter.rb"
  end
end

.primary_key=(keys) ⇒ Object Also known as: primary_keys=



25
26
27
28
29
30
31
32
33
34
35
36
37
# File 'lib/composite_primary_keys/base.rb', line 25

def primary_key=(keys)
  unless keys.kind_of?(Array)
    self.primary_key_without_composite_key_support = keys
    return
  end

  @primary_keys = keys.map { |k| k.to_s }.to_composite_keys

  class_eval <<-EOV
    extend  CompositeClassMethods
    include CompositeInstanceMethods
  EOV
end

.primary_key_without_composite_key_support=Object



24
# File 'lib/composite_primary_keys/base.rb', line 24

alias_method :primary_key_without_composite_key_support=, :primary_key=

.primary_keysObject



10
11
12
13
14
15
# File 'lib/composite_primary_keys/base.rb', line 10

def primary_keys
  unless defined?(@primary_keys)
    reset_primary_keys
  end
  @primary_keys
end

.remove_connection(id = connection_specification_name) ⇒ Object



60
61
62
# File 'lib/composite_primary_keys/connection_adapters/abstract/connection_specification_changes.rb', line 60

def remove_connection(id = connection_specification_name)
  connection_handler.remove_connection(id)
end

.reset_primary_keysObject

Don’t like this method name, but its modeled after how AR does it



18
19
20
21
22
# File 'lib/composite_primary_keys/base.rb', line 18

def reset_primary_keys
  if self != base_class
    self.primary_keys = base_class.primary_keys
  end
end

.retrieve_connectionObject



51
52
53
# File 'lib/composite_primary_keys/connection_adapters/abstract/connection_specification_changes.rb', line 51

def retrieve_connection
  connection_handler.retrieve_connection(connection_specification_name)
end

.set_primary_keys(*keys) ⇒ Object



40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/composite_primary_keys/base.rb', line 40

def set_primary_keys(*keys)
  ActiveSupport::Deprecation.warn(
      "Calling set_primary_keys is deprecated. Please use `self.primary_keys = keys` instead."
  )

  keys = keys.first if keys.first.is_a?(Array)
  if keys.length == 1
    self.primary_key = keys.first
  else
    self.primary_keys = keys
  end
end

Instance Method Details

#composite?Boolean

Returns:

  • (Boolean)


58
59
60
# File 'lib/composite_primary_keys/base.rb', line 58

def composite?
  self.class.composite?
end