Module: ActiveRecord::ConnectionAdapters::Quoting

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

Instance Method Summary collapse

Instance Method Details

#column_name_matcher ⇒ Object

:nodoc:



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

def column_name_matcher # :nodoc:
  COLUMN_NAME
end

#column_name_with_order_matcher ⇒ Object

:nodoc:



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

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.



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

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
20
21
 
# File 'lib/active_record/connection_adapters/abstract/quoting.rb', line 11

def quote(value)
  if value.is_a?(Base)
    ActiveSupport::Deprecation.warn(<<~MSG)
      Passing an Active Record object to `quote` directly is deprecated
      and will be no longer quoted as id value in Rails 7.0.
    MSG
    value = value.id_for_database
  end

  _quote(value)
end

#quote_column_name(column_name) ⇒ Object

Quotes the column name. Defaults to no quoting.



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

def quote_column_name(column_name)
  column_name.to_s
end

#quote_default_expression(value, column) ⇒ Object

:nodoc:



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

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.



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

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.



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

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



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

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.



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

def quoted_date(value)
  if value.acts_like?(:time)
    if ActiveRecord::Base.default_timezone == :utc
      value = value.getutc if value.respond_to?(:getutc) && !value.utc?
    else
      value = value.getlocal if value.respond_to?(:getlocal)
    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_false ⇒ Object 



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

def quoted_false
  "FALSE"
end

#quoted_time(value) ⇒ Object

:nodoc:



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

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 



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

def quoted_true
  "TRUE"
end

#sanitize_as_sql_comment(value) ⇒ Object

:nodoc:



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

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



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

def type_cast(value, column = nil)
  if value.is_a?(Base)
    ActiveSupport::Deprecation.warn(<<~MSG)
      Passing an Active Record object to `type_cast` directly is deprecated
      and will be no longer type casted as id value in Rails 7.0.
    MSG
    value = value.id_for_database
  end

  if column
    ActiveSupport::Deprecation.warn(<<~MSG)
      Passing a column to `type_cast` is deprecated and will be removed in Rails 7.0.
    MSG
    type = lookup_cast_type_from_column(column)
    value = type.serialize(value)
  end

  _type_cast(value)
end

#unquoted_false ⇒ Object 



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

def unquoted_false
  false
end

#unquoted_true ⇒ Object 



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

def unquoted_true
  true
end