Module: ActiveRecord::ConnectionAdapters::Quoting

Included in:
AbstractAdapter
Defined in:
lib/active_record/connection_adapters/abstract/quoting.rb

Instance Method Summary collapse

Instance Method Details

#lookup_cast_type_from_column(column) ⇒ Object

See docs for #type_cast_from_column


56
57
58
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 56

def lookup_cast_type_from_column(column) # :nodoc:
  lookup_cast_type(column.sql_type)
end

#quote(value) ⇒ Object

Quotes the column value to help prevent SQL injection attacks.


11
12
13
14
15
16
17
18
19
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 11

def quote(value)
  value = id_value_for_database(value) if value.is_a?(Base)

  if value.respond_to?(:value_for_database)
    value = value.value_for_database
  end

  _quote(value)
end

#quote_column_name(column_name) ⇒ Object

Quotes the column name. Defaults to no quoting.


67
68
69
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 67

def quote_column_name(column_name)
  column_name.to_s
end

#quote_default_expression(value, column) ⇒ Object

:nodoc:


88
89
90
91
92
93
94
95
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 88

def quote_default_expression(value, column) # :nodoc:
  if value.is_a?(Proc)
    value.call
  else
    value = lookup_cast_type(column.sql_type).serialize(value)
    quote(value)
  end
end

#quote_string(s) ⇒ Object

Quotes a string, escaping any ' (single quote) and \ (backslash) characters.


62
63
64
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 62

def quote_string(s)
  s.gsub('\\'.freeze, '\&\&'.freeze).gsub("'".freeze, "''".freeze) # ' (for ruby-mode)
end

#quote_table_name(table_name) ⇒ Object

Quotes the table name. Defaults to column name quoting.


72
73
74
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 72

def quote_table_name(table_name)
  quote_column_name(table_name)
end

#quote_table_name_for_assignment(table, attr) ⇒ Object

Override to return the quoted table name for assignment. Defaults to table quoting.

This works for mysql2 where table.column can be used to resolve ambiguity.

We override this in the sqlite3 and postgresql adapters to use only the column name (as per syntax requirements).


84
85
86
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 84

def quote_table_name_for_assignment(table, attr)
  quote_table_name("#{table}.#{attr}")
end

#quoted_binary(value) ⇒ Object

:nodoc:


136
137
138
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 136

def quoted_binary(value) # :nodoc:
  "'#{quote_string(value.to_s)}'"
end

#quoted_date(value) ⇒ Object

Quote date/time values for use in SQL input. Includes microseconds if the value is a Time responding to usec.


115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 115

def quoted_date(value)
  if value.acts_like?(:time)
    zone_conversion_method = ActiveRecord::Base.default_timezone == :utc ? :getutc : :getlocal

    if value.respond_to?(zone_conversion_method)
      value = value.send(zone_conversion_method)
    end
  end

  result = value.to_s(:db)
  if value.respond_to?(:usec) && value.usec > 0
    "#{result}.#{sprintf("%06d", value.usec)}"
  else
    result
  end
end

#quoted_falseObject


105
106
107
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 105

def quoted_false
  "FALSE".freeze
end

#quoted_time(value) ⇒ Object

:nodoc:


132
133
134
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 132

def quoted_time(value) # :nodoc:
  quoted_date(value).sub(/\A\d\d\d\d-\d\d-\d\d /, "")
end

#quoted_trueObject


97
98
99
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 97

def quoted_true
  "TRUE".freeze
end

#type_cast(value, column = nil) ⇒ Object

Cast a value to a type that the database understands. For example, SQLite does not understand dates, so this method will convert a Date to a String.


24
25
26
27
28
29
30
31
32
33
34
35
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 24

def type_cast(value, column = nil)
  value = id_value_for_database(value) if value.is_a?(Base)

  if column
    value = type_cast_from_column(column, value)
  end

  _type_cast(value)
rescue TypeError
  to_type = column ? " to #{column.type}" : ""
  raise TypeError, "can't cast #{value.class}#{to_type}"
end

#type_cast_from_column(column, value) ⇒ Object

If you are having to call this function, you are likely doing something wrong. The column does not have sufficient type information if the user provided a custom type on the class level either explicitly (via Attributes::ClassMethods#attribute) or implicitly (via AttributeMethods::Serialization::ClassMethods#serialize, time_zone_aware_attributes). In almost all cases, the sql type should only be used to change quoting behavior, when the primitive to represent the type doesn't sufficiently reflect the differences (varchar vs binary) for example. The type used to get this primitive should have been provided before reaching the connection adapter.


46
47
48
49
50
51
52
53
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 46

def type_cast_from_column(column, value) # :nodoc:
  if column
    type = lookup_cast_type_from_column(column)
    type.serialize(value)
  else
    value
  end
end

#type_casted_binds(binds) ⇒ Object

:nodoc:


140
141
142
143
144
145
146
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 140

def type_casted_binds(binds) # :nodoc:
  if binds.first.is_a?(Array)
    binds.map { |column, value| type_cast(value, column) }
  else
    binds.map { |attr| type_cast(attr.value_for_database) }
  end
end

#unquoted_falseObject


109
110
111
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 109

def unquoted_false
  false
end

#unquoted_trueObject


101
102
103
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 101

def unquoted_true
  true
end