Module: ActiveRecord::ConnectionAdapters::Quoting

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

Instance Method Summary collapse

Instance Method Details

#fetch_type_metadata(sql_type) ⇒ Object


71
72
73
74
75
76
77
78
79
80
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 71

def (sql_type)
  cast_type = lookup_cast_type(sql_type)
  SqlTypeMetadata.new(
    sql_type: sql_type,
    type: cast_type.type,
    limit: cast_type.limit,
    precision: cast_type.precision,
    scale: cast_type.scale,
  )
end

#lookup_cast_type_from_column(column) ⇒ Object

See docs for #type_cast_from_column


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

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.


9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 9

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

  if value.respond_to?(:quoted_id)
    at = value.method(:quoted_id).source_location
    at &&= " at %s:%d" % at

    owner = value.method(:quoted_id).owner.to_s
    klass = value.class.to_s
    klass += "(#{owner})" unless owner == klass

    ActiveSupport::Deprecation.warn \
      "Defining #quoted_id is deprecated and will be ignored in Rails 5.2. (defined on #{klass}#{at})"
    return value.quoted_id
  end

  _quote(value)
end

#quote_column_name(column_name) ⇒ Object

Quotes the column name. Defaults to no quoting.


89
90
91
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 89

def quote_column_name(column_name)
  column_name.to_s
end

#quote_default_expression(value, column) ⇒ Object

:nodoc:


110
111
112
113
114
115
116
117
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 110

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.


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

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.


94
95
96
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 94

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).


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

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

#quoted_binary(value) ⇒ Object

:nodoc:


158
159
160
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 158

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.


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 137

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


127
128
129
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 127

def quoted_false
  "'f'".freeze
end

#quoted_time(value) ⇒ Object

:nodoc:


154
155
156
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 154

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

#quoted_trueObject


119
120
121
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 119

def quoted_true
  "'t'".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.


31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 31

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

  if value.respond_to?(:quoted_id) && value.respond_to?(:id)
    return value.id
  end

  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.


57
58
59
60
61
62
63
64
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 57

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:


162
163
164
165
166
167
168
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 162

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


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

def unquoted_false
  "f".freeze
end

#unquoted_trueObject


123
124
125
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 123

def unquoted_true
  "t".freeze
end