activerecord 5.0.7 → 5.1.7

data/lib/active_record/result.rb

@@ -32,8 +32,6 @@ module ActiveRecord
   class Result
     include Enumerable
 
-    IDENTITY_TYPE = Type::Value.new # :nodoc:
-
     attr_reader :columns, :rows, :column_types
 
     def initialize(columns, rows, column_types = {})
@@ -43,10 +41,15 @@ module ActiveRecord
       @column_types = column_types
     end
 
+    # Returns the number of elements in the rows array.
     def length
       @rows.length
     end
 
+    # Calls the given block once for each element in row collection, passing
+    # row as parameter.
+    #
+    # Returns an +Enumerator+ if no block is given.
     def each
       if block_given?
         hash_rows.each { |row| yield row }
@@ -55,6 +58,7 @@ module ActiveRecord
       end
     end
 
+    # Returns an array of hashes representing each row record.
     def to_hash
       hash_rows
     end
@@ -62,11 +66,12 @@ module ActiveRecord
     alias :map! :map
     alias :collect! :map
 
-    # Returns true if there are no records.
+    # Returns true if there are no records, otherwise false.
     def empty?
       rows.empty?
     end
 
+    # Returns an array of hashes representing each row record.
     def to_ary
       hash_rows
     end
@@ -75,11 +80,15 @@ module ActiveRecord
       hash_rows[idx]
     end
 
+    # Returns the first record from the rows collection.
+    # If the rows collection is empty, returns +nil+.
     def first
       return nil if @rows.empty?
       Hash[@columns.zip(@rows.first)]
     end
 
+    # Returns the last record from the rows collection.
+    # If the rows collection is empty, returns +nil+.
     def last
       return nil if @rows.empty?
       Hash[@columns.zip(@rows.last)]
@@ -103,36 +112,36 @@ module ActiveRecord
 
     private
 
-    def column_type(name, type_overrides = {})
-      type_overrides.fetch(name) do
-        column_types.fetch(name, IDENTITY_TYPE)
+      def column_type(name, type_overrides = {})
+        type_overrides.fetch(name) do
+          column_types.fetch(name, Type.default_value)
+        end
       end
-    end
 
-    def hash_rows
-      @hash_rows ||=
-        begin
-          # We freeze the strings to prevent them getting duped when
-          # used as keys in ActiveRecord::Base's @attributes hash
-          columns = @columns.map { |c| c.dup.freeze }
-          @rows.map { |row|
-            # In the past we used Hash[columns.zip(row)]
-            #  though elegant, the verbose way is much more efficient
-            #  both time and memory wise cause it avoids a big array allocation
-            #  this method is called a lot and needs to be micro optimised
-            hash = {}
-
-            index = 0
-            length = columns.length
-
-            while index < length
-              hash[columns[index]] = row[index]
-              index += 1
-            end
-
-            hash
-          }
-        end
-    end
+      def hash_rows
+        @hash_rows ||=
+          begin
+            # We freeze the strings to prevent them getting duped when
+            # used as keys in ActiveRecord::Base's @attributes hash
+            columns = @columns.map { |c| c.dup.freeze }
+            @rows.map { |row|
+              # In the past we used Hash[columns.zip(row)]
+              #  though elegant, the verbose way is much more efficient
+              #  both time and memory wise cause it avoids a big array allocation
+              #  this method is called a lot and needs to be micro optimised
+              hash = {}
+
+              index = 0
+              length = columns.length
+
+              while index < length
+                hash[columns[index]] = row[index]
+                index += 1
+              end
+
+              hash
+            }
+          end
+      end
   end
 end

data/lib/active_record/runtime_registry.rb

@@ -1,4 +1,4 @@
-require 'active_support/per_thread_registry'
+require "active_support/per_thread_registry"
 
 module ActiveRecord
   # This is a thread locals registry for Active Record. For example:
@@ -12,9 +12,9 @@ module ActiveRecord
   class RuntimeRegistry # :nodoc:
     extend ActiveSupport::PerThreadRegistry
 
-    attr_accessor :connection_handler, :sql_runtime, :connection_id
+    attr_accessor :connection_handler, :sql_runtime
 
-    [:connection_handler, :sql_runtime, :connection_id].each do |val|
+    [:connection_handler, :sql_runtime].each do |val|
       class_eval %{ def self.#{val}; instance.#{val}; end }, __FILE__, __LINE__
       class_eval %{ def self.#{val}=(x); instance.#{val}=x; end }, __FILE__, __LINE__
     end

data/lib/active_record/sanitization.rb

@@ -3,228 +3,212 @@ module ActiveRecord
     extend ActiveSupport::Concern
 
     module ClassMethods
-      # Used to sanitize objects before they're used in an SQL SELECT statement.
-      # Delegates to {connection.quote}[rdoc-ref:ConnectionAdapters::Quoting#quote].
-      def sanitize(object) # :nodoc:
-        connection.quote(object)
-      end
-      alias_method :quote_value, :sanitize
-
-      protected
-
-      # Accepts an array or string of SQL conditions and sanitizes
-      # them into a valid SQL fragment for a WHERE clause.
-      #
-      #   sanitize_sql_for_conditions(["name=? and group_id=?", "foo'bar", 4])
-      #   # => "name='foo''bar' and group_id=4"
-      #
-      #   sanitize_sql_for_conditions(["name=:name and group_id=:group_id", name: "foo'bar", group_id: 4])
-      #   # => "name='foo''bar' and group_id='4'"
-      #
-      #   sanitize_sql_for_conditions(["name='%s' and group_id='%s'", "foo'bar", 4])
-      #   # => "name='foo''bar' and group_id='4'"
-      #
-      #   sanitize_sql_for_conditions("name='foo''bar' and group_id='4'")
-      #   # => "name='foo''bar' and group_id='4'"
-      def sanitize_sql_for_conditions(condition)
-        return nil if condition.blank?
-
-        case condition
-        when Array; sanitize_sql_array(condition)
-        else        condition
+      private
+
+        # Accepts an array or string of SQL conditions and sanitizes
+        # them into a valid SQL fragment for a WHERE clause.
+        #
+        #   sanitize_sql_for_conditions(["name=? and group_id=?", "foo'bar", 4])
+        #   # => "name='foo''bar' and group_id=4"
+        #
+        #   sanitize_sql_for_conditions(["name=:name and group_id=:group_id", name: "foo'bar", group_id: 4])
+        #   # => "name='foo''bar' and group_id='4'"
+        #
+        #   sanitize_sql_for_conditions(["name='%s' and group_id='%s'", "foo'bar", 4])
+        #   # => "name='foo''bar' and group_id='4'"
+        #
+        #   sanitize_sql_for_conditions("name='foo''bar' and group_id='4'")
+        #   # => "name='foo''bar' and group_id='4'"
+        def sanitize_sql_for_conditions(condition) # :doc:
+          return nil if condition.blank?
+
+          case condition
+          when Array; sanitize_sql_array(condition)
+          else        condition
+          end
         end
-      end
-      alias_method :sanitize_sql, :sanitize_sql_for_conditions
-      alias_method :sanitize_conditions, :sanitize_sql
-
-      # Accepts an array, hash, or string of SQL conditions and sanitizes
-      # them into a valid SQL fragment for a SET clause.
-      #
-      #   sanitize_sql_for_assignment(["name=? and group_id=?", nil, 4])
-      #   # => "name=NULL and group_id=4"
-      #
-      #   sanitize_sql_for_assignment(["name=:name and group_id=:group_id", name: nil, group_id: 4])
-      #   # => "name=NULL and group_id=4"
-      #
-      #   Post.send(:sanitize_sql_for_assignment, { name: nil, group_id: 4 })
-      #   # => "`posts`.`name` = NULL, `posts`.`group_id` = 4"
-      #
-      #   sanitize_sql_for_assignment("name=NULL and group_id='4'")
-      #   # => "name=NULL and group_id='4'"
-      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
+        alias :sanitize_sql :sanitize_sql_for_conditions
+        alias :sanitize_conditions :sanitize_sql
+        deprecate sanitize_conditions: :sanitize_sql
+
+        # Accepts an array, hash, or string of SQL conditions and sanitizes
+        # them into a valid SQL fragment for a SET clause.
+        #
+        #   sanitize_sql_for_assignment(["name=? and group_id=?", nil, 4])
+        #   # => "name=NULL and group_id=4"
+        #
+        #   sanitize_sql_for_assignment(["name=:name and group_id=:group_id", name: nil, group_id: 4])
+        #   # => "name=NULL and group_id=4"
+        #
+        #   Post.send(:sanitize_sql_for_assignment, { name: nil, group_id: 4 })
+        #   # => "`posts`.`name` = NULL, `posts`.`group_id` = 4"
+        #
+        #   sanitize_sql_for_assignment("name=NULL and group_id='4'")
+        #   # => "name=NULL and group_id='4'"
+        def sanitize_sql_for_assignment(assignments, default_table_name = table_name) # :doc:
+          case assignments
+          when Array; sanitize_sql_array(assignments)
+          when Hash;  sanitize_sql_hash_for_assignment(assignments, default_table_name)
+          else        assignments
+          end
         end
-      end
 
-      # Accepts an array, or string of SQL conditions and sanitizes
-      # them into a valid SQL fragment for an ORDER clause.
-      #
-      #   sanitize_sql_for_order(["field(id, ?)", [1,3,2]])
-      #   # => "field(id, 1,3,2)"
-      #
-      #   sanitize_sql_for_order("id ASC")
-      #   # => "id ASC"
-      def sanitize_sql_for_order(condition)
-        if condition.is_a?(Array) && condition.first.to_s.include?('?')
-          sanitize_sql_array(condition)
-        else
-          condition
+        # Accepts an array, or string of SQL conditions and sanitizes
+        # them into a valid SQL fragment for an ORDER clause.
+        #
+        #   sanitize_sql_for_order(["field(id, ?)", [1,3,2]])
+        #   # => "field(id, 1,3,2)"
+        #
+        #   sanitize_sql_for_order("id ASC")
+        #   # => "id ASC"
+        def sanitize_sql_for_order(condition) # :doc:
+          if condition.is_a?(Array) && condition.first.to_s.include?("?")
+            sanitize_sql_array(condition)
+          else
+            condition
+          end
         end
-      end
 
-      # Accepts a hash of SQL conditions and replaces those attributes
-      # that correspond to a {#composed_of}[rdoc-ref:Aggregations::ClassMethods#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" }
-      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)
+        # Accepts a hash of SQL conditions and replaces those attributes
+        # that correspond to a {#composed_of}[rdoc-ref:Aggregations::ClassMethods#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" }
+        def expand_hash_conditions_for_aggregates(attrs) # :doc:
+          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
-          else
-            expanded_attrs[attr] = value
           end
+          expanded_attrs
         end
-        expanded_attrs
-      end
 
-      # Sanitizes a hash of attribute/value pairs into SQL conditions for a SET clause.
-      #
-      #   sanitize_sql_hash_for_assignment({ status: nil, group_id: 1 }, "posts")
-      #   # => "`posts`.`status` = NULL, `posts`.`group_id` = 1"
-      def sanitize_sql_hash_for_assignment(attrs, table)
-        c = connection
-        attrs.map do |attr, value|
-          if value.is_a?(Base)
-            require "active_support/core_ext/string/filters"
-            ActiveSupport::Deprecation.warn(<<-WARNING.squish)
-              Passing `ActiveRecord::Base` objects to
-              `sanitize_sql_hash_for_assignment` (or methods which call it,
-              such as `update_all`) is deprecated. Please pass the id directly,
-              instead.
-            WARNING
-          else
+        # Sanitizes a hash of attribute/value pairs into SQL conditions for a SET clause.
+        #
+        #   sanitize_sql_hash_for_assignment({ status: nil, group_id: 1 }, "posts")
+        #   # => "`posts`.`status` = NULL, `posts`.`group_id` = 1"
+        def sanitize_sql_hash_for_assignment(attrs, table) # :doc:
+          c = connection
+          attrs.map do |attr, value|
             value = type_for_attribute(attr.to_s).serialize(value)
-          end
-          "#{c.quote_table_name_for_assignment(table, attr)} = #{c.quote(value)}"
-        end.join(', ')
-      end
-
-      # 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 "%".
-      #
-      #   sanitize_sql_like("100%")
-      #   # => "100\\%"
-      #
-      #   sanitize_sql_like("snake_cased_string")
-      #   # => "snake\\_cased\\_string"
-      #
-      #   sanitize_sql_like("100%", "!")
-      #   # => "100!%"
-      #
-      #   sanitize_sql_like("snake_cased_string", "!")
-      #   # => "snake!_cased!_string"
-      def sanitize_sql_like(string, escape_character = "\\")
-        pattern = Regexp.union(escape_character, "%", "_")
-        string.gsub(pattern) { |x| [escape_character, x].join }
-      end
+            "#{c.quote_table_name_for_assignment(table, attr)} = #{c.quote(value)}"
+          end.join(", ")
+        end
 
-      # Accepts an array of conditions. The array has each value
-      # sanitized and interpolated into the SQL statement.
-      #
-      #   sanitize_sql_array(["name=? and group_id=?", "foo'bar", 4])
-      #   # => "name='foo''bar' and group_id=4"
-      #
-      #   sanitize_sql_array(["name=:name and group_id=:group_id", name: "foo'bar", group_id: 4])
-      #   # => "name='foo''bar' and group_id=4"
-      #
-      #   sanitize_sql_array(["name='%s' and group_id='%s'", "foo'bar", 4])
-      #   # => "name='foo''bar' and group_id='4'"
-      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) }
+        # 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 "%".
+        #
+        #   sanitize_sql_like("100%")
+        #   # => "100\\%"
+        #
+        #   sanitize_sql_like("snake_cased_string")
+        #   # => "snake\\_cased\\_string"
+        #
+        #   sanitize_sql_like("100%", "!")
+        #   # => "100!%"
+        #
+        #   sanitize_sql_like("snake_cased_string", "!")
+        #   # => "snake!_cased!_string"
+        def sanitize_sql_like(string, escape_character = "\\") # :doc:
+          pattern = Regexp.union(escape_character, "%", "_")
+          string.gsub(pattern) { |x| [escape_character, x].join }
         end
-      end
 
-      def replace_bind_variables(statement, values) # :nodoc:
-        raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
-        bound = values.dup
-        c = connection
-        statement.gsub(/\?/) do
-          replace_bind_variable(bound.shift, c)
+        # Accepts an array of conditions. The array has each value
+        # sanitized and interpolated into the SQL statement.
+        #
+        #   sanitize_sql_array(["name=? and group_id=?", "foo'bar", 4])
+        #   # => "name='foo''bar' and group_id=4"
+        #
+        #   sanitize_sql_array(["name=:name and group_id=:group_id", name: "foo'bar", group_id: 4])
+        #   # => "name='foo''bar' and group_id=4"
+        #
+        #   sanitize_sql_array(["name='%s' and group_id='%s'", "foo'bar", 4])
+        #   # => "name='foo''bar' and group_id='4'"
+        def sanitize_sql_array(ary) # :doc:
+          statement, *values = ary
+          if values.first.is_a?(Hash) && /:\w+/.match?(statement)
+            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
-      end
 
-      def replace_bind_variable(value, c = connection) # :nodoc:
-        if ActiveRecord::Relation === value
-          value.to_sql
-        else
-          quote_bound_value(value, c)
+        def replace_bind_variables(statement, values)
+          raise_if_bind_arity_mismatch(statement, statement.count("?"), values.size)
+          bound = values.dup
+          c = connection
+          statement.gsub(/\?/) do
+            replace_bind_variable(bound.shift, c)
+          end
         end
-      end
 
-      def replace_named_bind_variables(statement, bind_vars) # :nodoc:
-        statement.gsub(/(:?):([a-zA-Z]\w*)/) do |match|
-          if $1 == ':' # skip postgresql casts
-            match # return the whole match
-          elsif bind_vars.include?(match = $2.to_sym)
-            replace_bind_variable(bind_vars[match])
+        def replace_bind_variable(value, c = connection)
+          if ActiveRecord::Relation === value
+            value.to_sql
           else
-            raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
+            quote_bound_value(value, c)
           end
         end
-      end
 
-      def quote_bound_value(value, c = connection) # :nodoc:
-        if value.respond_to?(:map) && !value.acts_like?(:string)
-          if value.respond_to?(:empty?) && value.empty?
-            c.quote(nil)
+        def replace_named_bind_variables(statement, bind_vars)
+          statement.gsub(/(:?):([a-zA-Z]\w*)/) do |match|
+            if $1 == ":" # skip postgresql casts
+              match # return the whole match
+            elsif bind_vars.include?(match = $2.to_sym)
+              replace_bind_variable(bind_vars[match])
+            else
+              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
+            end
+          end
+        end
+
+        def quote_bound_value(value, c = connection)
+          if value.respond_to?(:map) && !value.acts_like?(:string)
+            if value.respond_to?(:empty?) && value.empty?
+              c.quote(nil)
+            else
+              value.map { |v| c.quote(v) }.join(",")
+            end
           else
-            value.map { |v| c.quote(v) }.join(',')
+            c.quote(value)
           end
-        else
-          c.quote(value)
         end
-      end
 
-      def raise_if_bind_arity_mismatch(statement, expected, provided) # :nodoc:
-        unless expected == provided
-          raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
+        def raise_if_bind_arity_mismatch(statement, expected, provided)
+          unless expected == provided
+            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
+          end
         end
-      end
     end
 
-    # TODO: Deprecate this
     def quoted_id # :nodoc:
-      self.class.quote_value(@attributes[self.class.primary_key].value_for_database)
+      self.class.connection.quote(@attributes[self.class.primary_key].value_for_database)
     end
+    deprecate :quoted_id
   end
 end

data/lib/active_record/schema.rb

@@ -40,7 +40,7 @@ module ActiveRecord
     #   ActiveRecord::Schema.define(version: 20380119000001) do
     #     ...
     #   end
-    def self.define(info={}, &block)
+    def self.define(info = {}, &block)
       new.define(info, &block)
     end
 
@@ -48,7 +48,7 @@ module ActiveRecord
       instance_eval(&block)
 
       if info[:version].present?
-        initialize_schema_migrations_table
+        ActiveRecord::SchemaMigration.create_table
         connection.assume_migrated_upto_version(info[:version], migrations_paths)
       end
 
@@ -61,7 +61,7 @@ module ActiveRecord
       #
       #   ActiveRecord::Schema.new.migrations_paths
       #   # => ["db/migrate"] # Rails migration path by default.
-      def migrations_paths # :nodoc:
+      def migrations_paths
         ActiveRecord::Migrator.migrations_paths
       end
   end