omg-activerecord 8.0.0.alpha1

data/lib/arel/nodes/matches.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class Matches < Binary
+      attr_reader :escape
+      attr_accessor :case_sensitive
+
+      def initialize(left, right, escape = nil, case_sensitive = false)
+        super(left, right)
+        @escape = escape && Nodes.build_quoted(escape)
+        @case_sensitive = case_sensitive
+      end
+    end
+
+    class DoesNotMatch < Matches; end
+  end
+end

data/lib/arel/nodes/named_function.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class NamedFunction < Arel::Nodes::Function
+      attr_accessor :name
+
+      def initialize(name, expr, aliaz = nil)
+        super(expr, aliaz)
+        @name = name
+      end
+
+      def hash
+        super ^ @name.hash
+      end
+
+      def eql?(other)
+        super && self.name == other.name
+      end
+      alias :== :eql?
+    end
+  end
+end

data/lib/arel/nodes/nary.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class Nary < Arel::Nodes::NodeExpression
+      attr_reader :children
+
+      def initialize(children)
+        super()
+        @children = children
+      end
+
+      def left
+        children.first
+      end
+
+      def right
+        children[1]
+      end
+
+      def fetch_attribute(&block)
+        children.any? && children.all? { |child| child.fetch_attribute(&block) }
+      end
+
+      def hash
+        [self.class, children].hash
+      end
+
+      def eql?(other)
+        self.class == other.class &&
+          self.children == other.children
+      end
+      alias :== :eql?
+    end
+
+    And = Class.new(Nary)
+    Or = Class.new(Nary)
+  end
+end

data/lib/arel/nodes/node.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    # = Using +Arel::Nodes::Node+
+    #
+    # Active Record uses Arel to compose SQL statements. Instead of building SQL strings directly, it's building an
+    # abstract syntax tree (AST) of the statement using various types of Arel::Nodes::Node. Each node represents a
+    # fragment of a SQL statement.
+    #
+    # The intermediate representation allows Arel to compile the statement into the database's specific SQL dialect
+    # only before sending it without having to care about the nuances of each database when building the statement.
+    # It also allows easier composition of statements without having to resort to (brittle and unsafe) string manipulation.
+    #
+    # == Building constraints
+    #
+    # One of the most common use cases of Arel is generating constraints for +SELECT+ statements. To help with that,
+    # most nodes include a couple of useful factory methods to create subtree structures for common constraints. For
+    # a full list of those, please refer to Arel::Predications.
+    #
+    # The following example creates an equality constraint where the value of the name column on the users table
+    # matches the value DHH.
+    #
+    #   users = Arel::Table.new(:users)
+    #   constraint = users[:name].eq("DHH")
+    #
+    #   # => Arel::Nodes::Equality.new(
+    #   #      Arel::Attributes::Attribute.new(users, "name"),
+    #   #      Arel::Nodes::Casted.new(
+    #   #        "DHH",
+    #   #        Arel::Attributes::Attribute.new(users, "name")
+    #   #      )
+    #   #    )
+    #
+    # The resulting SQL fragment will look like this:
+    #
+    #   "users"."name" = 'DHH'
+    #
+    # The constraint fragments can be used with regular ActiveRecord::Relation objects instead of a Hash. The
+    # following two examples show two ways of creating the same query.
+    #
+    #   User.where(name: 'DHH')
+    #
+    #   # SELECT "users".* FROM "users" WHERE "users"."name" = 'DHH'
+    #
+    #   users = User.arel_table
+    #
+    #   User.where(users[:name].eq('DHH'))
+    #
+    #   # SELECT "users".* FROM "users" WHERE "users"."name" = 'DHH'
+    #
+    # == Functions
+    #
+    # Arel comes with built-in support for SQL functions like +COUNT+, +SUM+, +MIN+, +MAX+, and +AVG+. The
+    # Arel::Expressions module includes factory methods for the default functions.
+    #
+    #   employees = Employee.arel_table
+    #
+    #   Employee.select(employees[:department_id], employees[:salary].average).group(employees[:department_id])
+    #
+    #   # SELECT "employees"."department_id", AVG("employees"."salary")
+    #   #   FROM "employees" GROUP BY "employees"."department_id"
+    #
+    # It’s also possible to use custom functions by using the Arel::Nodes::NamedFunction node type. It accepts a
+    # function name and an array of parameters.
+    #
+    #   Arel::Nodes::NamedFunction.new('date_trunc', [Arel::Nodes.build_quoted('day'), User.arel_table[:created_at]])
+    #
+    #   # date_trunc('day', "users"."created_at")
+    #
+    # == Quoting & bind params
+    #
+    # Values that you pass to Arel nodes need to be quoted or wrapped in bind params. This ensures they are properly
+    # converted into the correct format without introducing a possible SQL injection vulnerability. Most factory
+    # methods (like +eq+, +gt+, +lteq+, …) quote passed values automatically. When not using a factory method, it’s
+    # possible to convert a value and wrap it in an Arel::Nodes::Quoted node (if necessary) by calling +Arel::Nodes.
+    # build_quoted+.
+    #
+    #   Arel::Nodes.build_quoted("foo") # 'foo'
+    #   Arel::Nodes.build_quoted(12.3)  # 12.3
+    #
+    # Instead of quoting values and embedding them directly in the SQL statement, it’s also possible to create bind
+    # params. This keeps the actual values outside of the statement and allows using the prepared statement feature
+    # of some databases.
+    #
+    #   attribute = ActiveRecord::Relation::QueryAttribute.new(:name, "DHH", ActiveRecord::Type::String.new)
+    #   Arel::Nodes::BindParam.new(attribute)
+    #
+    # When ActiveRecord runs the query, bind params are replaced by placeholders (like +$1+) and the values are passed
+    # separately.
+    #
+    # == SQL Literals
+    #
+    # For cases where there is no way to represent a particular SQL fragment using Arel nodes, you can use an SQL
+    # literal. SQL literals are strings that Arel will treat “as is”.
+    #
+    #   Arel.sql('LOWER("users"."name")').eq('dhh')
+    #
+    #   # LOWER("users"."name") = 'dhh'
+    #
+    # Please keep in mind that passing data as raw SQL literals might introduce a possible SQL injection. However,
+    # `Arel.sql` supports binding parameters which will ensure proper quoting. This can be useful when you need to
+    # control the exact SQL you run, but you still have potentially user-supplied values.
+    #
+    #   Arel.sql('LOWER("users"."name") = ?', 'dhh')
+    #
+    #   # LOWER("users"."name") = 'dhh'
+    #
+    # You can also combine SQL literals.
+    #
+    #   sql = Arel.sql('SELECT * FROM "users" WHERE ')
+    #   sql += Arel.sql('LOWER("users"."name") = :name', name: 'dhh')
+    #   sql += Arel.sql('AND "users"."age" > :age', age: 35)
+    #
+    #   # SELECT * FROM "users" WHERE LOWER("users"."name") = 'dhh' AND "users"."age" > '35'
+    class Node
+      include Arel::FactoryMethods
+
+      ###
+      # Factory method to create a Nodes::Not node that has the recipient of
+      # the caller as a child.
+      def not
+        Nodes::Not.new self
+      end
+
+      ###
+      # Factory method to create a Nodes::Grouping node that has an Nodes::Or
+      # node as a child.
+      def or(right)
+        Nodes::Grouping.new Nodes::Or.new([self, right])
+      end
+
+      ###
+      # Factory method to create an Nodes::And node.
+      def and(right)
+        Nodes::And.new [self, right]
+      end
+
+      def invert
+        Arel::Nodes::Not.new(self)
+      end
+
+      # FIXME: this method should go away.  I don't like people calling
+      # to_sql on non-head nodes.  This forces us to walk the AST until we
+      # can find a node that has a "relation" member.
+      #
+      # Maybe we should just use `Table.engine`?  :'(
+      def to_sql(engine = Table.engine)
+        collector = Arel::Collectors::SQLString.new
+        engine.with_connection do |connection|
+          connection.visitor.accept(self, collector).value
+        end
+      end
+
+      def fetch_attribute
+      end
+
+      def equality?; false; end
+    end
+  end
+end

data/lib/arel/nodes/node_expression.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class NodeExpression < Arel::Nodes::Node
+      include Arel::Expressions
+      include Arel::Predications
+      include Arel::AliasPredication
+      include Arel::OrderPredications
+      include Arel::Math
+    end
+  end
+end

data/lib/arel/nodes/ordering.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class Ordering < Unary
+      def nulls_first
+        NullsFirst.new(self)
+      end
+
+      def nulls_last
+        NullsLast.new(self)
+      end
+    end
+
+    class NullsFirst < Ordering
+      def reverse
+        NullsLast.new(expr.reverse)
+      end
+    end
+
+    class NullsLast < Ordering
+      def reverse
+        NullsFirst.new(expr.reverse)
+      end
+    end
+  end
+end

data/lib/arel/nodes/outer_join.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class OuterJoin < Arel::Nodes::Join
+    end
+  end
+end

data/lib/arel/nodes/over.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class Over < Binary
+      include Arel::AliasPredication
+
+      def initialize(left, right = nil)
+        super(left, right)
+      end
+
+      def operator; "OVER" end
+    end
+  end
+end

data/lib/arel/nodes/regexp.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class Regexp < Binary
+      attr_accessor :case_sensitive
+
+      def initialize(left, right, case_sensitive = true)
+        super(left, right)
+        @case_sensitive = case_sensitive
+      end
+    end
+
+    class NotRegexp < Regexp; end
+  end
+end

data/lib/arel/nodes/right_outer_join.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class RightOuterJoin < Arel::Nodes::Join
+    end
+  end
+end

data/lib/arel/nodes/select_core.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class SelectCore < Arel::Nodes::Node
+      attr_accessor :projections, :wheres, :groups, :windows, :comment
+      attr_accessor :havings, :source, :set_quantifier, :optimizer_hints
+
+      def initialize(relation = nil)
+        super()
+        @source = JoinSource.new(relation)
+
+        # https://ronsavage.github.io/SQL/sql-92.bnf.html#set%20quantifier
+        @set_quantifier  = nil
+        @optimizer_hints = nil
+        @projections     = []
+        @wheres          = []
+        @groups          = []
+        @havings         = []
+        @windows         = []
+        @comment         = nil
+      end
+
+      def from
+        @source.left
+      end
+
+      def from=(value)
+        @source.left = value
+      end
+
+      alias :froms= :from=
+      alias :froms :from
+
+      def initialize_copy(other)
+        super
+        @source      = @source.clone if @source
+        @projections = @projections.clone
+        @wheres      = @wheres.clone
+        @groups      = @groups.clone
+        @havings     = @havings.clone
+        @windows     = @windows.clone
+      end
+
+      def hash
+        [
+          @source, @set_quantifier, @projections, @optimizer_hints,
+          @wheres, @groups, @havings, @windows, @comment
+        ].hash
+      end
+
+      def eql?(other)
+        self.class == other.class &&
+          self.source == other.source &&
+          self.set_quantifier == other.set_quantifier &&
+          self.optimizer_hints == other.optimizer_hints &&
+          self.projections == other.projections &&
+          self.wheres == other.wheres &&
+          self.groups == other.groups &&
+          self.havings == other.havings &&
+          self.windows == other.windows &&
+          self.comment == other.comment
+      end
+      alias :== :eql?
+    end
+  end
+end

data/lib/arel/nodes/select_statement.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class SelectStatement < Arel::Nodes::NodeExpression
+      attr_reader :cores
+      attr_accessor :limit, :orders, :lock, :offset, :with
+
+      def initialize(relation = nil)
+        super()
+        @cores          = [SelectCore.new(relation)]
+        @orders         = []
+        @limit          = nil
+        @lock           = nil
+        @offset         = nil
+        @with           = nil
+      end
+
+      def initialize_copy(other)
+        super
+        @cores  = @cores.map { |x| x.clone }
+        @orders = @orders.map { |x| x.clone }
+      end
+
+      def hash
+        [@cores, @orders, @limit, @lock, @offset, @with].hash
+      end
+
+      def eql?(other)
+        self.class == other.class &&
+          self.cores == other.cores &&
+          self.orders == other.orders &&
+          self.limit == other.limit &&
+          self.lock == other.lock &&
+          self.offset == other.offset &&
+          self.with == other.with
+      end
+      alias :== :eql?
+    end
+  end
+end

data/lib/arel/nodes/sql_literal.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class SqlLiteral < String
+      include Arel::Expressions
+      include Arel::Predications
+      include Arel::AliasPredication
+      include Arel::OrderPredications
+
+      attr_reader :retryable
+
+      def initialize(string, retryable: false)
+        @retryable = retryable
+        super(string)
+      end
+
+      def encode_with(coder)
+        coder.scalar = self.to_s
+      end
+
+      def fetch_attribute
+      end
+
+      def +(other)
+        raise ArgumentError, "Expected Arel node" unless Arel.arel_node?(other)
+
+        Fragments.new([self, other])
+      end
+    end
+  end
+end

data/lib/arel/nodes/string_join.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class StringJoin < Arel::Nodes::Join
+      def initialize(left, right = nil)
+        super
+      end
+    end
+  end
+end

data/lib/arel/nodes/table_alias.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class TableAlias < Arel::Nodes::Binary
+      alias :name :right
+      alias :relation :left
+      alias :table_alias :name
+
+      def [](name)
+        relation.is_a?(Table) ? relation[name, self] : Attribute.new(self, name)
+      end
+
+      def table_name
+        relation.respond_to?(:name) ? relation.name : name
+      end
+
+      def type_cast_for_database(attr_name, value)
+        relation.type_cast_for_database(attr_name, value)
+      end
+
+      def type_for_attribute(name)
+        relation.type_for_attribute(name)
+      end
+
+      def able_to_type_cast?
+        relation.respond_to?(:able_to_type_cast?) && relation.able_to_type_cast?
+      end
+
+      def to_cte
+        Arel::Nodes::Cte.new(name, relation)
+      end
+    end
+  end
+end

data/lib/arel/nodes/terminal.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class Distinct < Arel::Nodes::NodeExpression
+      def hash
+        self.class.hash
+      end
+
+      def eql?(other)
+        self.class == other.class
+      end
+      alias :== :eql?
+    end
+  end
+end

data/lib/arel/nodes/true.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class True < Arel::Nodes::NodeExpression
+      def hash
+        self.class.hash
+      end
+
+      def eql?(other)
+        self.class == other.class
+      end
+      alias :== :eql?
+    end
+  end
+end

data/lib/arel/nodes/unary.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class Unary < Arel::Nodes::NodeExpression
+      attr_accessor :expr
+      alias :value :expr
+
+      def initialize(expr)
+        super()
+        @expr = expr
+      end
+
+      def hash
+        @expr.hash
+      end
+
+      def eql?(other)
+        self.class == other.class &&
+          self.expr == other.expr
+      end
+      alias :== :eql?
+    end
+
+    %w{
+      Bin
+      Cube
+      DistinctOn
+      Group
+      GroupingElement
+      GroupingSet
+      Lateral
+      Limit
+      Lock
+      Not
+      Offset
+      On
+      OptimizerHints
+      RollUp
+    }.each do |name|
+      const_set(name, Class.new(Unary))
+    end
+  end
+end

data/lib/arel/nodes/unary_operation.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class UnaryOperation < Unary
+      attr_reader :operator
+
+      def initialize(operator, operand)
+        super(operand)
+        @operator = operator
+      end
+    end
+
+    class BitwiseNot < UnaryOperation
+      def initialize(operand)
+        super(:~, operand)
+      end
+    end
+  end
+end

data/lib/arel/nodes/unqualified_column.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Nodes
+    class UnqualifiedColumn < Arel::Nodes::Unary
+      alias :attribute :expr
+      alias :attribute= :expr=
+
+      def relation
+        @expr.relation
+      end
+
+      def column
+        @expr.column
+      end
+
+      def name
+        @expr.name
+      end
+    end
+  end
+end