Module: ActiveRecord::ConnectionAdapters::Quoting

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

Overview

Active Record Connection Adapters Quoting

Instance Method Summary collapse

Instance Method Details

#cast_bound_value(value) ⇒ Object

Cast a value to be used as a bound parameter of unknown type. For example, MySQL might perform dangerous castings when comparing a string to a number, so this method will cast numbers to string.



69
70
71
 
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 69

def cast_bound_value(value) # :nodoc:
  value
end

#column_name_matcher ⇒ Object

:nodoc:



180
181
182
 
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 180

def column_name_matcher # :nodoc:
  COLUMN_NAME
end

#column_name_with_order_matcher ⇒ Object

:nodoc:



184
185
186
 
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 184

def column_name_with_order_matcher # :nodoc:
  COLUMN_NAME_WITH_ORDER
end

#lookup_cast_type_from_column(column) ⇒ 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.



82
83
84
 
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 82

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.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 12

def quote(value)
  case value
  when String, Symbol, ActiveSupport::Multibyte::Chars
    "'#{quote_string(value.to_s)}'"
  when true       then quoted_true
  when false      then quoted_false
  when nil        then "NULL"
  # BigDecimals need to be put in a non-normalized form and quoted.
  when BigDecimal then value.to_s("F")
  when Numeric then value.to_s
  when Type::Binary::Data then quoted_binary(value)
  when Type::Time::Value then "'#{quoted_time(value)}'"
  when Date, Time then "'#{quoted_date(value)}'"
  when Class      then "'#{value}'"
  when ActiveSupport::Duration
    warn_quote_duration_deprecated
    value.to_s
  else raise TypeError, "can't quote #{value.class.name}"
  end
end

#quote_bound_value(value) ⇒ Object

Quote a value to be used as a bound parameter of unknown type. For example, MySQL might perform dangerous castings when comparing a string to a number, so this method will cast numbers to string.

Deprecated: Consider ‘Arel.sql(“… ? …”, value)` or sanitize_sql instead.



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

def quote_bound_value(value)
  ActiveRecord.deprecator.warn(<<~MSG.squish)
    #quote_bound_value is deprecated and will be removed in Rails 7.2.
    Consider Arel.sql(".. ? ..", value) or #sanitize_sql instead.
  MSG

  quote(cast_bound_value(value))
end

#quote_column_name(column_name) ⇒ Object

Quotes the column name. Defaults to no quoting.



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

def quote_column_name(column_name)
  column_name.to_s
end

#quote_default_expression(value, column) ⇒ Object

:nodoc:



114
115
116
117
118
119
120
121
 
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 114

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.



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

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

#quote_table_name(table_name) ⇒ Object

Quotes the table name. Defaults to column name quoting.



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

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



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

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

#quoted_binary(value) ⇒ Object

:nodoc:



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

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.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 141

def quoted_date(value)
  if value.acts_like?(:time)
    if default_timezone == :utc
      value = value.getutc if !value.utc?
    else
      value = value.getlocal
    end
  end

  result = value.to_fs(:db)
  if value.respond_to?(:usec) && value.usec > 0
    result << "." << sprintf("%06d", value.usec)
  else
    result
  end
end

#quoted_false ⇒ Object 



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

def quoted_false
  "FALSE"
end

#quoted_time(value) ⇒ Object

:nodoc:



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

def quoted_time(value) # :nodoc:
  value = value.change(year: 2000, month: 1, day: 1)
  quoted_date(value).sub(/\A\d\d\d\d-\d\d-\d\d /, "")
end

#quoted_true ⇒ Object 



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

def quoted_true
  "TRUE"
end

#sanitize_as_sql_comment(value) ⇒ Object

:nodoc:



167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 167

def sanitize_as_sql_comment(value) # :nodoc:
  # Sanitize a string to appear within a SQL comment
  # For compatibility, this also surrounding "/*+", "/*", and "*/"
  # charcacters, possibly with single surrounding space.
  # Then follows that by replacing any internal "*/" or "/ *" with
  # "* /" or "/ *"
  comment = value.to_s.dup
  comment.gsub!(%r{\A\s*/\*\+?\s?|\s?\*/\s*\Z}, "")
  comment.gsub!("*/", "* /")
  comment.gsub!("/*", "/ *")
  comment
end

#type_cast(value) ⇒ 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.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 36

def type_cast(value)
  case value
  when Symbol, ActiveSupport::Multibyte::Chars, Type::Binary::Data
    value.to_s
  when true       then unquoted_true
  when false      then unquoted_false
  # BigDecimals need to be put in a non-normalized form and quoted.
  when BigDecimal then value.to_s("F")
  when nil, Numeric, String then value
  when Type::Time::Value then quoted_time(value)
  when Date, Time then quoted_date(value)
  else raise TypeError, "can't cast #{value.class.name}"
  end
end

#unquoted_false ⇒ Object 



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

def unquoted_false
  false
end

#unquoted_true ⇒ Object 



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

def unquoted_true
  true
end