activerecord 6.0.0

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "arel/visitors/visitor"
+require "arel/visitors/depth_first"
+require "arel/visitors/to_sql"
+require "arel/visitors/sqlite"
+require "arel/visitors/postgresql"
+require "arel/visitors/mysql"
+require "arel/visitors/mssql"
+require "arel/visitors/oracle"
+require "arel/visitors/oracle12"
+require "arel/visitors/where_sql"
+require "arel/visitors/dot"
+require "arel/visitors/ibm_db"
+require "arel/visitors/informix"
+
+module Arel # :nodoc: all
+  module Visitors
+  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

data/lib/arel/visitors/dot.rb

@@ -0,0 +1,297 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Visitors
+    class Dot < Arel::Visitors::Visitor
+      class Node # :nodoc:
+        attr_accessor :name, :id, :fields
+
+        def initialize(name, id, fields = [])
+          @name   = name
+          @id     = id
+          @fields = fields
+        end
+      end
+
+      class Edge < Struct.new :name, :from, :to # :nodoc:
+      end
+
+      def initialize
+        super()
+        @nodes      = []
+        @edges      = []
+        @node_stack = []
+        @edge_stack = []
+        @seen       = {}
+      end
+
+      def accept(object, collector)
+        visit object
+        collector << to_dot
+      end
+
+      private
+
+        def visit_Arel_Nodes_Ordering(o)
+          visit_edge o, "expr"
+        end
+
+        def visit_Arel_Nodes_TableAlias(o)
+          visit_edge o, "name"
+          visit_edge o, "relation"
+        end
+
+        def visit_Arel_Nodes_Count(o)
+          visit_edge o, "expressions"
+          visit_edge o, "distinct"
+        end
+
+        def visit_Arel_Nodes_ValuesList(o)
+          visit_edge o, "rows"
+        end
+
+        def visit_Arel_Nodes_StringJoin(o)
+          visit_edge o, "left"
+        end
+
+        def visit_Arel_Nodes_InnerJoin(o)
+          visit_edge o, "left"
+          visit_edge o, "right"
+        end
+        alias :visit_Arel_Nodes_FullOuterJoin  :visit_Arel_Nodes_InnerJoin
+        alias :visit_Arel_Nodes_OuterJoin      :visit_Arel_Nodes_InnerJoin
+        alias :visit_Arel_Nodes_RightOuterJoin :visit_Arel_Nodes_InnerJoin
+
+        def visit_Arel_Nodes_DeleteStatement(o)
+          visit_edge o, "relation"
+          visit_edge o, "wheres"
+        end
+
+        def unary(o)
+          visit_edge o, "expr"
+        end
+        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_Limit             :unary
+        alias :visit_Arel_Nodes_Not               :unary
+        alias :visit_Arel_Nodes_Offset            :unary
+        alias :visit_Arel_Nodes_On                :unary
+        alias :visit_Arel_Nodes_UnqualifiedColumn :unary
+        alias :visit_Arel_Nodes_OptimizerHints    :unary
+        alias :visit_Arel_Nodes_Preceding         :unary
+        alias :visit_Arel_Nodes_Following         :unary
+        alias :visit_Arel_Nodes_Rows              :unary
+        alias :visit_Arel_Nodes_Range             :unary
+
+        def window(o)
+          visit_edge o, "partitions"
+          visit_edge o, "orders"
+          visit_edge o, "framing"
+        end
+        alias :visit_Arel_Nodes_Window            :window
+
+        def named_window(o)
+          visit_edge o, "partitions"
+          visit_edge o, "orders"
+          visit_edge o, "framing"
+          visit_edge o, "name"
+        end
+        alias :visit_Arel_Nodes_NamedWindow       :named_window
+
+        def function(o)
+          visit_edge o, "expressions"
+          visit_edge o, "distinct"
+          visit_edge o, "alias"
+        end
+        alias :visit_Arel_Nodes_Exists :function
+        alias :visit_Arel_Nodes_Min    :function
+        alias :visit_Arel_Nodes_Max    :function
+        alias :visit_Arel_Nodes_Avg    :function
+        alias :visit_Arel_Nodes_Sum    :function
+
+        def extract(o)
+          visit_edge o, "expressions"
+          visit_edge o, "alias"
+        end
+        alias :visit_Arel_Nodes_Extract :extract
+
+        def visit_Arel_Nodes_NamedFunction(o)
+          visit_edge o, "name"
+          visit_edge o, "expressions"
+          visit_edge o, "distinct"
+          visit_edge o, "alias"
+        end
+
+        def visit_Arel_Nodes_InsertStatement(o)
+          visit_edge o, "relation"
+          visit_edge o, "columns"
+          visit_edge o, "values"
+        end
+
+        def visit_Arel_Nodes_SelectCore(o)
+          visit_edge o, "source"
+          visit_edge o, "projections"
+          visit_edge o, "wheres"
+          visit_edge o,  "windows"
+        end
+
+        def visit_Arel_Nodes_SelectStatement(o)
+          visit_edge o, "cores"
+          visit_edge o, "limit"
+          visit_edge o, "orders"
+          visit_edge o, "offset"
+        end
+
+        def visit_Arel_Nodes_UpdateStatement(o)
+          visit_edge o, "relation"
+          visit_edge o, "wheres"
+          visit_edge o, "values"
+        end
+
+        def visit_Arel_Table(o)
+          visit_edge o, "name"
+        end
+
+        def visit_Arel_Nodes_Casted(o)
+          visit_edge o, "val"
+          visit_edge o, "attribute"
+        end
+
+        def visit_Arel_Attribute(o)
+          visit_edge o, "relation"
+          visit_edge 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
+
+        def nary(o)
+          o.children.each_with_index do |x, i|
+            edge(i) { visit x }
+          end
+        end
+        alias :visit_Arel_Nodes_And :nary
+
+        def binary(o)
+          visit_edge o, "left"
+          visit_edge 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_DoesNotMatch       :binary
+        alias :visit_Arel_Nodes_Equality           :binary
+        alias :visit_Arel_Nodes_GreaterThan        :binary
+        alias :visit_Arel_Nodes_GreaterThanOrEqual :binary
+        alias :visit_Arel_Nodes_In                 :binary
+        alias :visit_Arel_Nodes_JoinSource         :binary
+        alias :visit_Arel_Nodes_LessThan           :binary
+        alias :visit_Arel_Nodes_LessThanOrEqual    :binary
+        alias :visit_Arel_Nodes_IsNotDistinctFrom  :binary
+        alias :visit_Arel_Nodes_IsDistinctFrom     :binary
+        alias :visit_Arel_Nodes_Matches            :binary
+        alias :visit_Arel_Nodes_NotEqual           :binary
+        alias :visit_Arel_Nodes_NotIn              :binary
+        alias :visit_Arel_Nodes_Or                 :binary
+        alias :visit_Arel_Nodes_Over               :binary
+
+        def visit_String(o)
+          @node_stack.last.fields << o
+        end
+        alias :visit_Time :visit_String
+        alias :visit_Date :visit_String
+        alias :visit_DateTime :visit_String
+        alias :visit_NilClass :visit_String
+        alias :visit_TrueClass :visit_String
+        alias :visit_FalseClass :visit_String
+        alias :visit_Integer :visit_String
+        alias :visit_BigDecimal :visit_String
+        alias :visit_Float :visit_String
+        alias :visit_Symbol :visit_String
+        alias :visit_Arel_Nodes_SqlLiteral :visit_String
+
+        def visit_Arel_Nodes_BindParam(o); end
+
+        def visit_Hash(o)
+          o.each_with_index do |pair, i|
+            edge("pair_#{i}")   { visit pair }
+          end
+        end
+
+        def visit_Array(o)
+          o.each_with_index do |x, i|
+            edge(i) { visit x }
+          end
+        end
+        alias :visit_Set :visit_Array
+
+        def visit_Arel_Nodes_Comment(o)
+          visit_edge(o, "values")
+        end
+
+        def visit_edge(o, method)
+          edge(method) { visit o.send(method) }
+        end
+
+        def visit(o)
+          if node = @seen[o.object_id]
+            @edge_stack.last.to = node
+            return
+          end
+
+          node = Node.new(o.class.name, o.object_id)
+          @seen[node.id] = node
+          @nodes << node
+          with_node node do
+            super
+          end
+        end
+
+        def edge(name)
+          edge = Edge.new(name, @node_stack.last)
+          @edge_stack.push edge
+          @edges << edge
+          yield
+          @edge_stack.pop
+        end
+
+        def with_node(node)
+          if edge = @edge_stack.last
+            edge.to = node
+          end
+
+          @node_stack.push node
+          yield
+          @node_stack.pop
+        end
+
+        def quote(string)
+          string.to_s.gsub('"', '\"')
+        end
+
+        def to_dot
+          "digraph \"Arel\" {\nnode [width=0.375,height=0.25,shape=record];\n" +
+            @nodes.map { |node|
+              label = "<f0>#{node.name}"
+
+              node.fields.each_with_index do |field, i|
+                label += "|<f#{i + 1}>#{quote field}"
+              end
+
+              "#{node.id} [label=\"#{label}\"];"
+            }.join("\n") + "\n" + @edges.map { |edge|
+              "#{edge.from.id} -> #{edge.to.id} [label=\"#{edge.name}\"];"
+            }.join("\n") + "\n}"
+        end
+    end
+  end
+end