module ActiveRecord::ConnectionAdapters::Quoting

Public Instance Methods

fetch_type_metadata(sql_type) click to toggle source
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 66
def fetch_type_metadata(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
quote(value, column = nil) click to toggle source

Quotes the column value to help prevent SQL injection attacks.

# File 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("            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.
".squish)
          value = type_cast_from_column(column, value)
        end

        _quote(value)
      end
quote_column_name(column_name) click to toggle source

Quotes the column name. Defaults to no quoting.

# File lib/active_record/connection_adapters/abstract/quoting.rb, line 84
def quote_column_name(column_name)
  column_name.to_s
end
quote_string(s) click to toggle source

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

# File 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) click to toggle source

Quotes the table name. Defaults to column name quoting.

# File 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) click to toggle source

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

# File 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) click to toggle source

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

# File 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_false() click to toggle source
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 122
def quoted_false
  "'f'"
end
quoted_true() click to toggle source
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 114
def quoted_true
  "'t'"
end
type_cast(value, column = nil) click to toggle source

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.

# File 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
unquoted_false() click to toggle source
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 126
def unquoted_false
  'f'
end
unquoted_true() click to toggle source
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 118
def unquoted_true
  't'
end

Private Instance Methods

_quote(value) click to toggle source
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 163
def _quote(value)
  case value
  when String, ActiveSupport::Multibyte::Chars, Type::Binary::Data
    "'#{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, ActiveSupport::Duration then value.to_s
  when Type::Time::Value then "'#{quoted_time(value)}'"
  when Date, Time then "'#{quoted_date(value)}'"
  when Symbol     then "'#{quote_string(value.to_s)}'"
  when Class      then "'#{value}'"
  else raise TypeError, "can't quote #{value.class.name}"
  end
end
_type_cast(value) click to toggle source
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 181
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 Type::Time::Value then quoted_time(value)
  when Date, Time then quoted_date(value)
  when *types_which_need_no_typecasting
    value
  else raise TypeError
  end
end
types_which_need_no_typecasting() click to toggle source
# File lib/active_record/connection_adapters/abstract/quoting.rb, line 159
def types_which_need_no_typecasting
  [nil, Numeric, String]
end