activerecord 4.2.0 → 6.0.0

data/lib/arel/select_manager.rb

@@ -0,0 +1,271 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  class SelectManager < Arel::TreeManager
+    include Arel::Crud
+
+    STRING_OR_SYMBOL_CLASS = [Symbol, String]
+
+    def initialize(table = nil)
+      super()
+      @ast = Nodes::SelectStatement.new
+      @ctx = @ast.cores.last
+      from table
+    end
+
+    def initialize_copy(other)
+      super
+      @ctx = @ast.cores.last
+    end
+
+    def limit
+      @ast.limit && @ast.limit.expr
+    end
+    alias :taken :limit
+
+    def constraints
+      @ctx.wheres
+    end
+
+    def offset
+      @ast.offset && @ast.offset.expr
+    end
+
+    def skip(amount)
+      if amount
+        @ast.offset = Nodes::Offset.new(amount)
+      else
+        @ast.offset = nil
+      end
+      self
+    end
+    alias :offset= :skip
+
+    ###
+    # Produces an Arel::Nodes::Exists node
+    def exists
+      Arel::Nodes::Exists.new @ast
+    end
+
+    def as(other)
+      create_table_alias grouping(@ast), Nodes::SqlLiteral.new(other)
+    end
+
+    def lock(locking = Arel.sql("FOR UPDATE"))
+      case locking
+      when true
+        locking = Arel.sql("FOR UPDATE")
+      when Arel::Nodes::SqlLiteral
+      when String
+        locking = Arel.sql locking
+      end
+
+      @ast.lock = Nodes::Lock.new(locking)
+      self
+    end
+
+    def locked
+      @ast.lock
+    end
+
+    def on(*exprs)
+      @ctx.source.right.last.right = Nodes::On.new(collapse(exprs))
+      self
+    end
+
+    def group(*columns)
+      columns.each do |column|
+        # FIXME: backwards compat
+        column = Nodes::SqlLiteral.new(column) if String === column
+        column = Nodes::SqlLiteral.new(column.to_s) if Symbol === column
+
+        @ctx.groups.push Nodes::Group.new column
+      end
+      self
+    end
+
+    def from(table)
+      table = Nodes::SqlLiteral.new(table) if String === table
+
+      case table
+      when Nodes::Join
+        @ctx.source.right << table
+      else
+        @ctx.source.left = table
+      end
+
+      self
+    end
+
+    def froms
+      @ast.cores.map { |x| x.from }.compact
+    end
+
+    def join(relation, klass = Nodes::InnerJoin)
+      return self unless relation
+
+      case relation
+      when String, Nodes::SqlLiteral
+        raise EmptyJoinError if relation.empty?
+        klass = Nodes::StringJoin
+      end
+
+      @ctx.source.right << create_join(relation, nil, klass)
+      self
+    end
+
+    def outer_join(relation)
+      join(relation, Nodes::OuterJoin)
+    end
+
+    def having(expr)
+      @ctx.havings << expr
+      self
+    end
+
+    def window(name)
+      window = Nodes::NamedWindow.new(name)
+      @ctx.windows.push window
+      window
+    end
+
+    def project(*projections)
+      # FIXME: converting these to SQLLiterals is probably not good, but
+      # rails tests require it.
+      @ctx.projections.concat projections.map { |x|
+        STRING_OR_SYMBOL_CLASS.include?(x.class) ? Nodes::SqlLiteral.new(x.to_s) : x
+      }
+      self
+    end
+
+    def projections
+      @ctx.projections
+    end
+
+    def projections=(projections)
+      @ctx.projections = projections
+    end
+
+    def optimizer_hints(*hints)
+      unless hints.empty?
+        @ctx.optimizer_hints = Arel::Nodes::OptimizerHints.new(hints)
+      end
+      self
+    end
+
+    def distinct(value = true)
+      if value
+        @ctx.set_quantifier = Arel::Nodes::Distinct.new
+      else
+        @ctx.set_quantifier = nil
+      end
+      self
+    end
+
+    def distinct_on(value)
+      if value
+        @ctx.set_quantifier = Arel::Nodes::DistinctOn.new(value)
+      else
+        @ctx.set_quantifier = nil
+      end
+      self
+    end
+
+    def order(*expr)
+      # FIXME: We SHOULD NOT be converting these to SqlLiteral automatically
+      @ast.orders.concat expr.map { |x|
+        STRING_OR_SYMBOL_CLASS.include?(x.class) ? Nodes::SqlLiteral.new(x.to_s) : x
+      }
+      self
+    end
+
+    def orders
+      @ast.orders
+    end
+
+    def where_sql(engine = Table.engine)
+      return if @ctx.wheres.empty?
+
+      viz = Visitors::WhereSql.new(engine.connection.visitor, engine.connection)
+      Nodes::SqlLiteral.new viz.accept(@ctx, Collectors::SQLString.new).value
+    end
+
+    def union(operation, other = nil)
+      if other
+        node_class = Nodes.const_get("Union#{operation.to_s.capitalize}")
+      else
+        other = operation
+        node_class = Nodes::Union
+      end
+
+      node_class.new self.ast, other.ast
+    end
+
+    def intersect(other)
+      Nodes::Intersect.new ast, other.ast
+    end
+
+    def except(other)
+      Nodes::Except.new ast, other.ast
+    end
+    alias :minus :except
+
+    def lateral(table_name = nil)
+      base = table_name.nil? ? ast : as(table_name)
+      Nodes::Lateral.new(base)
+    end
+
+    def with(*subqueries)
+      if subqueries.first.is_a? Symbol
+        node_class = Nodes.const_get("With#{subqueries.shift.to_s.capitalize}")
+      else
+        node_class = Nodes::With
+      end
+      @ast.with = node_class.new(subqueries.flatten)
+
+      self
+    end
+
+    def take(limit)
+      if limit
+        @ast.limit = Nodes::Limit.new(limit)
+      else
+        @ast.limit = nil
+      end
+      self
+    end
+    alias limit= take
+
+    def join_sources
+      @ctx.source.right
+    end
+
+    def source
+      @ctx.source
+    end
+
+    def comment(*values)
+      @ctx.comment = Nodes::Comment.new(values)
+      self
+    end
+
+    private
+      def collapse(exprs)
+        exprs = exprs.compact
+        exprs.map! { |expr|
+          if String === expr
+            # FIXME: Don't do this automatically
+            Arel.sql(expr)
+          else
+            expr
+          end
+        }
+
+        if exprs.length == 1
+          exprs.first
+        else
+          create_and exprs
+        end
+      end
+  end
+end

data/lib/arel/table.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  class Table
+    include Arel::Crud
+    include Arel::FactoryMethods
+
+    @engine = nil
+    class << self; attr_accessor :engine; end
+
+    attr_accessor :name, :table_alias
+
+    # TableAlias and Table both have a #table_name which is the name of the underlying table
+    alias :table_name :name
+
+    def initialize(name, as: nil, type_caster: nil)
+      @name = name.to_s
+      @type_caster = type_caster
+
+      # Sometime AR sends an :as parameter to table, to let the table know
+      # that it is an Alias.  We may want to override new, and return a
+      # TableAlias node?
+      if as.to_s == @name
+        as = nil
+      end
+      @table_alias = as
+    end
+
+    def alias(name = "#{self.name}_2")
+      Nodes::TableAlias.new(self, name)
+    end
+
+    def from
+      SelectManager.new(self)
+    end
+
+    def join(relation, klass = Nodes::InnerJoin)
+      return from unless relation
+
+      case relation
+      when String, Nodes::SqlLiteral
+        raise EmptyJoinError if relation.empty?
+        klass = Nodes::StringJoin
+      end
+
+      from.join(relation, klass)
+    end
+
+    def outer_join(relation)
+      join(relation, Nodes::OuterJoin)
+    end
+
+    def group(*columns)
+      from.group(*columns)
+    end
+
+    def order(*expr)
+      from.order(*expr)
+    end
+
+    def where(condition)
+      from.where condition
+    end
+
+    def project(*things)
+      from.project(*things)
+    end
+
+    def take(amount)
+      from.take amount
+    end
+
+    def skip(amount)
+      from.skip amount
+    end
+
+    def having(expr)
+      from.having expr
+    end
+
+    def [](name)
+      ::Arel::Attribute.new self, name
+    end
+
+    def hash
+      # Perf note: aliases and table alias is excluded from the hash
+      #  aliases can have a loop back to this table breaking hashes in parent
+      #  relations, for the vast majority of cases @name is unique to a query
+      @name.hash
+    end
+
+    def eql?(other)
+      self.class == other.class &&
+        self.name == other.name &&
+        self.table_alias == other.table_alias
+    end
+    alias :== :eql?
+
+    def type_cast_for_database(attribute_name, value)
+      type_caster.type_cast_for_database(attribute_name, value)
+    end
+
+    def able_to_type_cast?
+      !type_caster.nil?
+    end
+
+    private
+      attr_reader :type_caster
+  end
+end

data/lib/arel/tree_manager.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  class TreeManager
+    include Arel::FactoryMethods
+
+    module StatementMethods
+      def take(limit)
+        @ast.limit = Nodes::Limit.new(Nodes.build_quoted(limit)) if limit
+        self
+      end
+
+      def offset(offset)
+        @ast.offset = Nodes::Offset.new(Nodes.build_quoted(offset)) if offset
+        self
+      end
+
+      def order(*expr)
+        @ast.orders = expr
+        self
+      end
+
+      def key=(key)
+        @ast.key = Nodes.build_quoted(key)
+      end
+
+      def key
+        @ast.key
+      end
+
+      def wheres=(exprs)
+        @ast.wheres = exprs
+      end
+
+      def where(expr)
+        @ast.wheres << expr
+        self
+      end
+    end
+
+    attr_reader :ast
+
+    def initialize
+      @ctx = nil
+    end
+
+    def to_dot
+      collector = Arel::Collectors::PlainString.new
+      collector = Visitors::Dot.new.accept @ast, collector
+      collector.value
+    end
+
+    def to_sql(engine = Table.engine)
+      collector = Arel::Collectors::SQLString.new
+      collector = engine.connection.visitor.accept @ast, collector
+      collector.value
+    end
+
+    def initialize_copy(other)
+      super
+      @ast = @ast.clone
+    end
+
+    def where(expr)
+      if Arel::TreeManager === expr
+        expr = expr.ast
+      end
+      @ctx.wheres << expr
+      self
+    end
+  end
+end

data/lib/arel/update_manager.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  class UpdateManager < Arel::TreeManager
+    include TreeManager::StatementMethods
+
+    def initialize
+      super
+      @ast = Nodes::UpdateStatement.new
+      @ctx = @ast
+    end
+
+    ###
+    # UPDATE +table+
+    def table(table)
+      @ast.relation = table
+      self
+    end
+
+    def set(values)
+      if String === values
+        @ast.values = [values]
+      else
+        @ast.values = values.map { |column, value|
+          Nodes::Assignment.new(
+            Nodes::UnqualifiedColumn.new(column),
+            value
+          )
+        }
+      end
+      self
+    end
+  end
+end

data/lib/arel/visitors/depth_first.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Visitors
+    class DepthFirst < Arel::Visitors::Visitor
+      def initialize(block = nil)
+        @block = block || Proc.new
+        super()
+      end
+
+      private
+
+        def visit(o, _ = nil)
+          super
+          @block.call o
+        end
+
+        def unary(o)
+          visit o.expr
+        end
+        alias :visit_Arel_Nodes_Else              :unary
+        alias :visit_Arel_Nodes_Group             :unary
+        alias :visit_Arel_Nodes_Cube              :unary
+        alias :visit_Arel_Nodes_RollUp            :unary
+        alias :visit_Arel_Nodes_GroupingSet       :unary
+        alias :visit_Arel_Nodes_GroupingElement   :unary
+        alias :visit_Arel_Nodes_Grouping          :unary
+        alias :visit_Arel_Nodes_Having            :unary
+        alias :visit_Arel_Nodes_Lateral           :unary
+        alias :visit_Arel_Nodes_Limit             :unary
+        alias :visit_Arel_Nodes_Not               :unary
+        alias :visit_Arel_Nodes_Offset            :unary
+        alias :visit_Arel_Nodes_On                :unary
+        alias :visit_Arel_Nodes_Ordering          :unary
+        alias :visit_Arel_Nodes_Ascending         :unary
+        alias :visit_Arel_Nodes_Descending        :unary
+        alias :visit_Arel_Nodes_UnqualifiedColumn :unary
+        alias :visit_Arel_Nodes_OptimizerHints    :unary
+        alias :visit_Arel_Nodes_ValuesList        :unary
+
+        def function(o)
+          visit o.expressions
+          visit o.alias
+          visit o.distinct
+        end
+        alias :visit_Arel_Nodes_Avg    :function
+        alias :visit_Arel_Nodes_Exists :function
+        alias :visit_Arel_Nodes_Max    :function
+        alias :visit_Arel_Nodes_Min    :function
+        alias :visit_Arel_Nodes_Sum    :function
+
+        def visit_Arel_Nodes_NamedFunction(o)
+          visit o.name
+          visit o.expressions
+          visit o.distinct
+          visit o.alias
+        end
+
+        def visit_Arel_Nodes_Count(o)
+          visit o.expressions
+          visit o.alias
+          visit o.distinct
+        end
+
+        def visit_Arel_Nodes_Case(o)
+          visit o.case
+          visit o.conditions
+          visit o.default
+        end
+
+        def nary(o)
+          o.children.each { |child| visit child }
+        end
+        alias :visit_Arel_Nodes_And :nary
+
+        def binary(o)
+          visit o.left
+          visit o.right
+        end
+        alias :visit_Arel_Nodes_As                 :binary
+        alias :visit_Arel_Nodes_Assignment         :binary
+        alias :visit_Arel_Nodes_Between            :binary
+        alias :visit_Arel_Nodes_Concat             :binary
+        alias :visit_Arel_Nodes_DeleteStatement    :binary
+        alias :visit_Arel_Nodes_DoesNotMatch       :binary
+        alias :visit_Arel_Nodes_Equality           :binary
+        alias :visit_Arel_Nodes_FullOuterJoin      :binary
+        alias :visit_Arel_Nodes_GreaterThan        :binary
+        alias :visit_Arel_Nodes_GreaterThanOrEqual :binary
+        alias :visit_Arel_Nodes_In                 :binary
+        alias :visit_Arel_Nodes_InfixOperation     :binary
+        alias :visit_Arel_Nodes_JoinSource         :binary
+        alias :visit_Arel_Nodes_InnerJoin          :binary
+        alias :visit_Arel_Nodes_LessThan           :binary
+        alias :visit_Arel_Nodes_LessThanOrEqual    :binary
+        alias :visit_Arel_Nodes_Matches            :binary
+        alias :visit_Arel_Nodes_NotEqual           :binary
+        alias :visit_Arel_Nodes_NotIn              :binary
+        alias :visit_Arel_Nodes_NotRegexp          :binary
+        alias :visit_Arel_Nodes_IsNotDistinctFrom  :binary
+        alias :visit_Arel_Nodes_IsDistinctFrom     :binary
+        alias :visit_Arel_Nodes_Or                 :binary
+        alias :visit_Arel_Nodes_OuterJoin          :binary
+        alias :visit_Arel_Nodes_Regexp             :binary
+        alias :visit_Arel_Nodes_RightOuterJoin     :binary
+        alias :visit_Arel_Nodes_TableAlias         :binary
+        alias :visit_Arel_Nodes_When               :binary
+
+        def visit_Arel_Nodes_StringJoin(o)
+          visit o.left
+        end
+
+        def visit_Arel_Attribute(o)
+          visit o.relation
+          visit o.name
+        end
+        alias :visit_Arel_Attributes_Integer :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_Float :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_String :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_Time :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_Boolean :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_Attribute :visit_Arel_Attribute
+        alias :visit_Arel_Attributes_Decimal :visit_Arel_Attribute
+
+        def visit_Arel_Table(o)
+          visit o.name
+        end
+
+        def terminal(o)
+        end
+        alias :visit_ActiveSupport_Multibyte_Chars :terminal
+        alias :visit_ActiveSupport_StringInquirer  :terminal
+        alias :visit_Arel_Nodes_Lock               :terminal
+        alias :visit_Arel_Nodes_Node               :terminal
+        alias :visit_Arel_Nodes_SqlLiteral         :terminal
+        alias :visit_Arel_Nodes_BindParam          :terminal
+        alias :visit_Arel_Nodes_Window             :terminal
+        alias :visit_Arel_Nodes_True               :terminal
+        alias :visit_Arel_Nodes_False              :terminal
+        alias :visit_BigDecimal                    :terminal
+        alias :visit_Class                         :terminal
+        alias :visit_Date                          :terminal
+        alias :visit_DateTime                      :terminal
+        alias :visit_FalseClass                    :terminal
+        alias :visit_Float                         :terminal
+        alias :visit_Integer                       :terminal
+        alias :visit_NilClass                      :terminal
+        alias :visit_String                        :terminal
+        alias :visit_Symbol                        :terminal
+        alias :visit_Time                          :terminal
+        alias :visit_TrueClass                     :terminal
+
+        def visit_Arel_Nodes_InsertStatement(o)
+          visit o.relation
+          visit o.columns
+          visit o.values
+        end
+
+        def visit_Arel_Nodes_SelectCore(o)
+          visit o.projections
+          visit o.source
+          visit o.wheres
+          visit o.groups
+          visit o.windows
+          visit o.havings
+        end
+
+        def visit_Arel_Nodes_SelectStatement(o)
+          visit o.cores
+          visit o.orders
+          visit o.limit
+          visit o.lock
+          visit o.offset
+        end
+
+        def visit_Arel_Nodes_UpdateStatement(o)
+          visit o.relation
+          visit o.values
+          visit o.wheres
+          visit o.orders
+          visit o.limit
+        end
+
+        def visit_Arel_Nodes_Comment(o)
+          visit o.values
+        end
+
+        def visit_Array(o)
+          o.each { |i| visit i }
+        end
+        alias :visit_Set :visit_Array
+
+        def visit_Hash(o)
+          o.each { |k, v| visit(k); visit(v) }
+        end
+
+        DISPATCH = dispatch_cache
+
+        def get_dispatch_cache
+          DISPATCH
+        end
+    end
+  end
+end