module ActiveRecord::ConnectionAdapters::Quoting

Public Instance Methods

fetch_type_metadata(sql_type) Show source
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 71
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) Show source
# File activerecord/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

Quotes the column value to help prevent SQL injection attacks.

quote_column_name(column_name) Show source
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 89
def quote_column_name(column_name)
  column_name.to_s
end

Quotes the column name. Defaults to no quoting.

quote_string(s) Show source
# File activerecord/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

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

quote_table_name(table_name) Show source
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 94
def quote_table_name(table_name)
  quote_column_name(table_name)
end

Quotes the table name. Defaults to column name quoting.

quote_table_name_for_assignment(table, attr) Show source
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 106
def quote_table_name_for_assignment(table, attr)
  quote_table_name("#{table}.#{attr}")
end

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

quoted_date(value) Show source
# File activerecord/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

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

quoted_false() Show source
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 127
def quoted_false
  "'f'".freeze
end
quoted_true() Show source
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 119
def quoted_true
  "'t'".freeze
end
type_cast(value, column = nil) Show source
# File activerecord/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

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.

unquoted_false() Show source
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 131
def unquoted_false
  "f".freeze
end
unquoted_true() Show source
# File activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, line 123
def unquoted_true
  "t".freeze
end

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.