Module: ActiveRecord::ConnectionAdapters::Quoting

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

Instance Method Summary collapse

Instance Method Details

#fetch_type_metadata(sql_type) ⇒ Object


66
67
68
69
70
71
72
73
74
75
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 66

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


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

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

#prepare_binds_for_database(binds) ⇒ Object

:nodoc:


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

def prepare_binds_for_database(binds) # :nodoc:
  binds.map(&:value_for_database)
end

#quote(value, column = nil) ⇒ Object

Quotes the column value to help prevent SQL injection attacks.


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

def quote(value, column = nil)
  # records are quoted as their primary key
  return value.quoted_id if value.respond_to?(:quoted_id)

  if column
    ActiveSupport::Deprecation.warn(<<-MSG.squish)
      Passing a column to `quote` has been deprecated. It is only used
      for type casting, which should be handled elsewhere. See
      https://github.com/rails/arel/commit/6160bfbda1d1781c3b08a33ec4955f170e95be11
      for more information.
    MSG
    value = type_cast_from_column(column, value)
  end

  _quote(value)
end

#quote_column_name(column_name) ⇒ Object

Quotes the column name. Defaults to no quoting.


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

def quote_column_name(column_name)
  column_name.to_s
end

#quote_default_expression(value, column) ⇒ Object

:nodoc:


105
106
107
108
109
110
111
112
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 105

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.


79
80
81
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 79

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.


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

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


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

def quote_table_name_for_assignment(table, attr)
  quote_table_name("#{table}.#{attr}")
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.


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 132

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


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

def quoted_false
  "'f'".freeze
end

#quoted_time(value) ⇒ Object

:nodoc:


149
150
151
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 149

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

#quoted_trueObject


114
115
116
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 114

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.


28
29
30
31
32
33
34
35
36
37
38
39
40
41
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 28

def type_cast(value, column = nil)
  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.


52
53
54
55
56
57
58
59
# File 'activerecord/lib/active_record/connection_adapters/abstract/quoting.rb', line 52

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

#unquoted_falseObject


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

def unquoted_false
  'f'.freeze
end

#unquoted_trueObject


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

def unquoted_true
  't'.freeze
end