module ActiveRecord::Sanitization::ClassMethods - activerecord-4.2.3 Documentation

# module ActiveRecord::Sanitization::ClassMethods

### Protected Instance Methods

expand_hash_conditions_for_aggregates(attrs) click to toggle source

Accepts a hash of SQL conditions and replaces those attributes that correspond to a `composed_of` relationship with their expanded aggregate attribute values. Given:

    class Person < ActiveRecord::Base
      composed_of :address, class_name: "Address",
        mapping: [%w(address_street street), %w(address_city city)]
    end

Then:

    { address: Address.new("813 abc st.", "chicago") }
      # => { address_street: "813 abc st.", address_city: "chicago" }

    # File lib/active_record/sanitization.rb, line 56
    def expand_hash_conditions_for_aggregates(attrs)
      expanded_attrs = {}
      attrs.each do |attr, value|
        if aggregation = reflect_on_aggregation(attr.to_sym)
          mapping = aggregation.mapping
          mapping.each do |field_attr, aggregate_attr|
            if mapping.size == 1 && !value.respond_to?(aggregate_attr)
              expanded_attrs[field_attr] = value
            else
              expanded_attrs[field_attr] = value.send(aggregate_attr)
            end
          end
        else
          expanded_attrs[attr] = value
        end
      end
      expanded_attrs
    end

sanitize_conditions(condition, table_name = self.table_name)
Alias for: sanitize_sql
sanitize_sql(condition, table_name = self.table_name)
Also aliased as: sanitize_conditions
Alias for: sanitize_sql_for_conditions
sanitize_sql_array(ary) click to toggle source

Accepts an array of conditions. The array has each value sanitized and interpolated into the SQL statement.

    ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"

    # File lib/active_record/sanitization.rb, line 123
    def sanitize_sql_array(ary)
      statement, *values = ary
      if values.first.is_a?(Hash) && statement =~ /:\w+/
        replace_named_bind_variables(statement, values.first)
      elsif statement.include?('?')
        replace_bind_variables(statement, values)
      elsif statement.blank?
        statement
      else
        statement % values.collect { |value| connection.quote_string(value.to_s) }
      end
    end

sanitize_sql_for_assignment(assignments, default_table_name = self.table_name) click to toggle source

Accepts an array, hash, or string of SQL conditions and sanitizes them into a valid SQL fragment for a SET clause.

    { name: nil, group_id: 4 }  returns "name = NULL , group_id='4'"

    # File lib/active_record/sanitization.rb, line 37
    def sanitize_sql_for_assignment(assignments, default_table_name = self.table_name)
      case assignments
      when Array; sanitize_sql_array(assignments)
      when Hash;  sanitize_sql_hash_for_assignment(assignments, default_table_name)
      else        assignments
      end
    end

sanitize_sql_for_conditions(condition, table_name = self.table_name) click to toggle source

Accepts an array, hash, or string of SQL conditions and sanitizes them into a valid SQL fragment for a WHERE clause.

    ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
    { name: "foo'bar", group_id: 4 }  returns "name='foo''bar' and group_id='4'"
    "name='foo''bar' and group_id='4'" returns "name='foo''bar' and group_id='4'"

    # File lib/active_record/sanitization.rb, line 22
    def sanitize_sql_for_conditions(condition, table_name = self.table_name)
      return nil if condition.blank?

      case condition
      when Array; sanitize_sql_array(condition)
      when Hash;  sanitize_sql_hash_for_conditions(condition, table_name)
      else        condition
      end
    end

Also aliased as: sanitize_sql
sanitize_sql_hash(attrs, default_table_name = self.table_name)
Alias for: sanitize_sql_hash_for_conditions
sanitize_sql_hash_for_assignment(attrs, table) click to toggle source

Sanitizes a hash of attribute/value pairs into SQL conditions for a SET clause.

    { status: nil, group_id: 1 }
      # => "status = NULL , group_id = 1"

    # File lib/active_record/sanitization.rb, line 106
    def sanitize_sql_hash_for_assignment(attrs, table)
      c = connection
      attrs.map do |attr, value|
        "#{c.quote_table_name_for_assignment(table, attr)} = #{quote_bound_value(value, c, columns_hash[attr.to_s])}"
      end.join(', ')
    end

sanitize_sql_hash_for_conditions(attrs, default_table_name = self.table_name) click to toggle source

Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.

    { name: "foo'bar", group_id: 4 }
      # => "name='foo''bar' and group_id= 4"
    { status: nil, group_id: [1,2,3] }
      # => "status IS NULL and group_id IN (1,2,3)"
    { age: 13..18 }
      # => "age BETWEEN 13 AND 18"
    { 'other_records.id' => 7 }
      # => "`other_records`.`id` = 7"
    { other_records: { id: 7 } }
      # => "`other_records`.`id` = 7"

And for value objects on a composed_of relationship:

    { address: Address.new("123 abc st.", "chicago") }
      # => "address_street='123 abc st.' and address_city='chicago'"

    # File lib/active_record/sanitization.rb, line 89
          def sanitize_sql_hash_for_conditions(attrs, default_table_name = self.table_name)
            ActiveSupport::Deprecation.warn("sanitize_sql_hash_for_conditions is deprecated, and will be removed in Rails 5.0
    ")
            attrs = PredicateBuilder.resolve_column_aliases self, attrs
            attrs = expand_hash_conditions_for_aggregates(attrs)

            table = Arel::Table.new(table_name, arel_engine).alias(default_table_name)
            PredicateBuilder.build_from_hash(self, attrs, table).map { |b|
              connection.visitor.compile b
            }.join(' AND ')
          end

Also aliased as: sanitize_sql_hash
sanitize_sql_like(string, escape_character = "\\") click to toggle source

Sanitizes a `string` so that it is safe to use within an SQL LIKE statement. This method uses `escape_character` to escape all occurrences of “", ”_“ and ”%“

    # File lib/active_record/sanitization.rb, line 115
    def sanitize_sql_like(string, escape_character = "\\")
      pattern = Regexp.union(escape_character, "%", "_")
      string.gsub(pattern) { |x| [escape_character, x].join }
    end