arel 3.0.3 → 4.0.0

data/lib/arel/nodes/window.rb

@@ -17,7 +17,6 @@ module Arel
       end
 
       def frame(expr)
-        raise ArgumentError, "Window frame cannot be set more than once" if @frame
         @framing = expr
       end
 
@@ -33,6 +32,17 @@ module Arel
         super
         @orders = @orders.map { |x| x.clone }
       end
+
+      def hash
+        [@orders, @framing].hash
+      end
+
+      def eql? other
+        self.class == other.class &&
+          self.orders == other.orders &&
+          self.framing == other.framing
+      end
+      alias :== :eql?
     end
 
     class NamedWindow < Window
@@ -47,6 +57,15 @@ module Arel
         super
         @name = other.name.clone
       end
+
+      def hash
+        super ^ @name.hash
+      end
+
+      def eql? other
+        super && self.name == other.name
+      end
+      alias :== :eql?
     end
 
     class Rows < Unary
@@ -61,7 +80,15 @@ module Arel
       end
     end
 
-    class CurrentRow < Arel::Nodes::Node; end
+    class CurrentRow < Node
+      def hash
+        self.class.hash
+      end
+
+      def eql? other
+        self.class == other.class
+      end
+    end
 
     class Preceding < Unary
       def initialize(expr = nil)
@@ -75,4 +102,4 @@ module Arel
       end
     end
   end
-end
+end

data/lib/arel/nodes.rb

@@ -13,6 +13,7 @@ require 'arel/nodes/false'
 
 # unary
 require 'arel/nodes/unary'
+require 'arel/nodes/grouping'
 require 'arel/nodes/ascending'
 require 'arel/nodes/descending'
 require 'arel/nodes/unqualified_column'

data/lib/arel/predications.rb

@@ -29,7 +29,15 @@ module Arel
       when Arel::SelectManager
         Arel::Nodes::In.new(self, other.ast)
       when Range
-        if other.exclude_end?
+        if other.begin == -Float::INFINITY && other.end == Float::INFINITY
+          Nodes::NotIn.new self, []
+        elsif other.end == Float::INFINITY
+          Nodes::GreaterThanOrEqual.new(self, other.begin)
+        elsif other.begin == -Float::INFINITY && other.exclude_end?
+          Nodes::LessThan.new(self, other.end)
+        elsif other.begin == -Float::INFINITY
+          Nodes::LessThanOrEqual.new(self, other.end)
+        elsif other.exclude_end?
           left  = Nodes::GreaterThanOrEqual.new(self, other.begin)
           right = Nodes::LessThan.new(self, other.end)
           Nodes::And.new [left, right]
@@ -54,7 +62,15 @@ module Arel
       when Arel::SelectManager
         Arel::Nodes::NotIn.new(self, other.ast)
       when Range
-        if other.exclude_end?
+        if other.begin == -Float::INFINITY && other.end == Float::INFINITY
+          Nodes::In.new self, []
+        elsif other.end == Float::INFINITY
+          Nodes::LessThan.new(self, other.begin)
+        elsif other.begin == -Float::INFINITY && other.exclude_end?
+          Nodes::GreaterThanOrEqual.new(self, other.end)
+        elsif other.begin == -Float::INFINITY
+          Nodes::GreaterThan.new(self, other.end)
+        elsif other.exclude_end?
           left  = Nodes::LessThan.new(self, other.begin)
           right = Nodes::GreaterThanOrEqual.new(self, other.end)
           Nodes::Or.new left, right

data/lib/arel/select_manager.rb

@@ -141,6 +141,10 @@ module Arel
       self
     end
 
+    def projections
+      @ctx.projections
+    end
+
     def projections= projections
       @ctx.projections = projections
     end
@@ -166,7 +170,7 @@ module Arel
     end
 
     def wheres
-      warn "#{caller[0]}: SelectManager#wheres is deprecated and will be removed in ARel 4.0.0 with no replacement"
+      warn "#{caller[0]}: SelectManager#wheres is deprecated and will be removed in Arel 4.0.0 with no replacement"
       Compatibility::Wheres.new @engine.connection, @ctx.wheres
     end
 
@@ -272,7 +276,7 @@ module Arel
     def insert values
       if $VERBOSE
         warn <<-eowarn
-insert (#{caller.first}) is deprecated and will be removed in ARel 4.0.0. Please
+insert (#{caller.first}) is deprecated and will be removed in Arel 4.0.0. Please
 switch to `compile_insert`
         eowarn
       end

data/lib/arel/table.rb

@@ -32,7 +32,7 @@ module Arel
     def primary_key
       if $VERBOSE
         warn <<-eowarn
-primary_key (#{caller.first}) is deprecated and will be removed in ARel 4.0.0
+primary_key (#{caller.first}) is deprecated and will be removed in Arel 4.0.0
         eowarn
       end
       @primary_key ||= begin
@@ -123,6 +123,19 @@ Arel 4.0.0 with no replacement.  PEW PEW PEW!!!
       InsertManager.new(@engine)
     end
 
+    def hash
+      [@name, @engine, @aliases, @table_alias].hash
+    end
+
+    def eql? other
+      self.class == other.class &&
+        self.name == other.name &&
+        self.engine == other.engine &&
+        self.aliases == other.aliases &&
+        self.table_alias == other.table_alias
+    end
+    alias :== :eql?
+
     private
 
     def attributes_for columns

data/lib/arel/tree_manager.rb

@@ -1,7 +1,5 @@
 module Arel
   class TreeManager
-    # FIXME: Remove this.
-    include Arel::Relation
     include Arel::FactoryMethods
 
     attr_reader :ast, :engine

data/lib/arel/visitors/bind_visitor.rb

@@ -12,6 +12,15 @@ module Arel
       end
 
       private
+
+      def visit_Arel_Nodes_Assignment o
+        if o.right.is_a? Arel::Nodes::BindParam
+          "#{visit o.left} = #{visit o.right}"
+        else
+          super
+        end
+      end
+
       def visit_Arel_Nodes_BindParam o
         if @block
           @block.call
@@ -19,6 +28,7 @@ module Arel
           super
         end
       end
+      
     end
   end
 end

data/lib/arel/visitors/dot.rb

@@ -65,7 +65,6 @@ module Arel
         visit_edge o, "expr"
       end
       alias :visit_Arel_Nodes_Group             :unary
-      alias :visit_Arel_Nodes_BindParam         :unary
       alias :visit_Arel_Nodes_Grouping          :unary
       alias :visit_Arel_Nodes_Having            :unary
       alias :visit_Arel_Nodes_Limit             :unary
@@ -195,6 +194,7 @@ module Arel
       alias :visit_TrueClass :visit_String
       alias :visit_FalseClass :visit_String
       alias :visit_Arel_SqlLiteral :visit_String
+      alias :visit_Arel_Nodes_BindParam :visit_String
       alias :visit_Fixnum :visit_String
       alias :visit_BigDecimal :visit_String
       alias :visit_Float :visit_String
@@ -254,7 +254,7 @@ module Arel
       end
 
       def to_dot
-        "digraph \"ARel\" {\nnode [width=0.375,height=0.25,shape=record];\n" +
+        "digraph \"Arel\" {\nnode [width=0.375,height=0.25,shape=record];\n" +
           @nodes.map { |node|
             label = "<f0>#{node.name}"
 

data/lib/arel/visitors/to_sql.rb

@@ -4,6 +4,55 @@ require 'date'
 module Arel
   module Visitors
     class ToSql < Arel::Visitors::Visitor
+      ##
+      # This is some roflscale crazy stuff.  I'm roflscaling this because
+      # building SQL queries is a hotspot.  I will explain the roflscale so that
+      # others will not rm this code.
+      #
+      # In YARV, string literals in a method body will get duped when the byte
+      # code is executed.  Let's take a look:
+      #
+      # > puts RubyVM::InstructionSequence.new('def foo; "bar"; end').disasm
+      #
+      #   == disasm: <RubyVM::InstructionSequence:foo@<compiled>>=====
+      #    0000 trace            8
+      #    0002 trace            1
+      #    0004 putstring        "bar"
+      #    0006 trace            16
+      #    0008 leave
+      #
+      # The `putstring` bytecode will dup the string and push it on the stack.
+      # In many cases in our SQL visitor, that string is never mutated, so there
+      # is no need to dup the literal.
+      #
+      # If we change to a constant lookup, the string will not be duped, and we
+      # can reduce the objects in our system:
+      #
+      # > puts RubyVM::InstructionSequence.new('BAR = "bar"; def foo; BAR; end').disasm
+      #
+      #  == disasm: <RubyVM::InstructionSequence:foo@<compiled>>========
+      #  0000 trace            8
+      #  0002 trace            1
+      #  0004 getinlinecache   11, <ic:0>
+      #  0007 getconstant      :BAR
+      #  0009 setinlinecache   <ic:0>
+      #  0011 trace            16
+      #  0013 leave
+      #
+      # `getconstant` should be a hash lookup, and no object is duped when the
+      # value of the constant is pushed on the stack.  Hence the crazy
+      # constants below.
+
+      WHERE    = ' WHERE '    # :nodoc:
+      SPACE    = ' '          # :nodoc:
+      COMMA    = ', '         # :nodoc:
+      GROUP_BY = ' GROUP BY ' # :nodoc:
+      ORDER_BY = ' ORDER BY ' # :nodoc:
+      WINDOW   = ' WINDOW '   # :nodoc:
+      AND      = ' AND '      # :nodoc:
+
+      DISTINCT = 'DISTINCT'   # :nodoc:
+
       attr_accessor :last_column
 
       def initialize connection
@@ -23,7 +72,7 @@ module Arel
       def visit_Arel_Nodes_DeleteStatement o
         [
           "DELETE FROM #{visit o.relation}",
-          ("WHERE #{o.wheres.map { |x| visit x }.join ' AND '}" unless o.wheres.empty?)
+          ("WHERE #{o.wheres.map { |x| visit x }.join AND}" unless o.wheres.empty?)
         ].compact.join ' '
       end
 
@@ -47,7 +96,7 @@ module Arel
           unless key
             warn(<<-eowarn) if $VERBOSE
 (#{caller.first}) Using UpdateManager without setting UpdateManager#key is
-deprecated and support will be removed in ARel 4.0.0.  Please set the primary
+deprecated and support will be removed in Arel 4.0.0.  Please set the primary
 key on UpdateManager using UpdateManager#key=
             eowarn
             key = o.relation.primary_key
@@ -98,11 +147,11 @@ key on UpdateManager using UpdateManager#key=
 
         return nil unless table_exists? table
 
-        column_cache[table][name]
+        column_cache(table)[name]
       end
 
-      def column_cache
-        @schema_cache.columns_hash
+      def column_cache(table)
+        @schema_cache.columns_hash(table)
       end
 
       def visit_Arel_Nodes_Values o
@@ -116,28 +165,80 @@ key on UpdateManager using UpdateManager#key=
       end
 
       def visit_Arel_Nodes_SelectStatement o
-        [
-          (visit(o.with) if o.with),
-          o.cores.map { |x| visit_Arel_Nodes_SelectCore x }.join,
-          ("ORDER BY #{o.orders.map { |x| visit x }.join(', ')}" unless o.orders.empty?),
-          (visit(o.limit) if o.limit),
-          (visit(o.offset) if o.offset),
-          (visit(o.lock) if o.lock),
-        ].compact.join ' '
+        str = ''
+
+        if o.with
+          str << visit(o.with)
+          str << SPACE
+        end
+
+        o.cores.each { |x| str << visit_Arel_Nodes_SelectCore(x) }
+
+        unless o.orders.empty?
+          str << SPACE
+          str << ORDER_BY
+          len = o.orders.length - 1
+          o.orders.each_with_index { |x, i|
+            str << visit(x)
+            str << COMMA unless len == i
+          }
+        end
+
+        str << " #{visit(o.limit)}" if o.limit
+        str << " #{visit(o.offset)}" if o.offset
+        str << " #{visit(o.lock)}" if o.lock
+
+        str.strip!
+        str
       end
 
       def visit_Arel_Nodes_SelectCore o
-        [
-          "SELECT",
-          (visit(o.top) if o.top),
-          (visit(o.set_quantifier) if o.set_quantifier),
-          ("#{o.projections.map { |x| visit x }.join ', '}" unless o.projections.empty?),
-          ("FROM #{visit(o.source)}" if o.source && !o.source.empty?),
-          ("WHERE #{o.wheres.map { |x| visit x }.join ' AND ' }" unless o.wheres.empty?),
-          ("GROUP BY #{o.groups.map { |x| visit x }.join ', ' }" unless o.groups.empty?),
-          (visit(o.having) if o.having),
-          ("WINDOW #{o.windows.map { |x| visit x }.join ', ' }" unless o.windows.empty?)
-        ].compact.join ' '
+        str = "SELECT"
+
+        str << " #{visit(o.top)}"            if o.top
+        str << " #{visit(o.set_quantifier)}" if o.set_quantifier
+
+        unless o.projections.empty?
+          str << SPACE
+          len = o.projections.length - 1
+          o.projections.each_with_index do |x, i|
+            str << visit(x)
+            str << COMMA unless len == i
+          end
+        end
+
+        str << " FROM #{visit(o.source)}" if o.source && !o.source.empty?
+
+        unless o.wheres.empty?
+          str << WHERE
+          len = o.wheres.length - 1
+          o.wheres.each_with_index do |x, i|
+            str << visit(x)
+            str << AND unless len == i
+          end
+        end
+
+        unless o.groups.empty?
+          str << GROUP_BY
+          len = o.groups.length - 1
+          o.groups.each_with_index do |x, i|
+            str << visit(x)
+            str << COMMA unless len == i
+          end
+        end
+
+        str << " #{visit(o.having)}" if o.having
+
+        unless o.windows.empty?
+          str << WINDOW
+          len = o.windows.length - 1
+          o.windows.each_with_index do |x, i|
+            str << visit(x)
+            str << COMMA unless len == i
+          end
+        end
+
+        str
       end
 
       def visit_Arel_Nodes_Bin o
@@ -145,7 +246,7 @@ key on UpdateManager using UpdateManager#key=
       end
 
       def visit_Arel_Nodes_Distinct o
-        'DISTINCT'
+        DISTINCT
       end
 
       def visit_Arel_Nodes_DistinctOn o
@@ -254,6 +355,10 @@ key on UpdateManager using UpdateManager#key=
         "(#{visit o.expr})"
       end
 
+      def visit_Arel_SelectManager o
+        "(#{o.to_sql.rstrip})"
+      end
+
       def visit_Arel_Nodes_Ascending o
         "#{visit o.expr} ASC"
       end
@@ -283,22 +388,22 @@ key on UpdateManager using UpdateManager#key=
       end
 
       def visit_Arel_Nodes_Sum o
-        "SUM(#{o.expressions.map { |x|
+        "SUM(#{o.distinct ? 'DISTINCT ' : ''}#{o.expressions.map { |x|
           visit x }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
       end
 
       def visit_Arel_Nodes_Max o
-        "MAX(#{o.expressions.map { |x|
+        "MAX(#{o.distinct ? 'DISTINCT ' : ''}#{o.expressions.map { |x|
           visit x }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
       end
 
       def visit_Arel_Nodes_Min o
-        "MIN(#{o.expressions.map { |x|
+        "MIN(#{o.distinct ? 'DISTINCT ' : ''}#{o.expressions.map { |x|
           visit x }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
       end
 
       def visit_Arel_Nodes_Avg o
-        "AVG(#{o.expressions.map { |x|
+        "AVG(#{o.distinct ? 'DISTINCT ' : ''}#{o.expressions.map { |x|
           visit x }.join(', ')})#{o.alias ? " AS #{visit o.alias}" : ''}"
       end
 
@@ -350,7 +455,12 @@ key on UpdateManager using UpdateManager#key=
       end
 
       def visit_Arel_Nodes_InnerJoin o
-        "INNER JOIN #{visit o.left} #{visit o.right if o.right}"
+        s = "INNER JOIN #{visit o.left}"
+        if o.right
+          s << SPACE
+          s << visit(o.right)
+        end
+        s
       end
 
       def visit_Arel_Nodes_On o
@@ -475,10 +585,11 @@ key on UpdateManager using UpdateManager#key=
       alias :visit_Arel_Nodes_Division       :visit_Arel_Nodes_InfixOperation
 
       def visit_Array o
-        o.empty? ? 'NULL' : o.map { |x| visit x }.join(', ')
+        o.map { |x| visit x }.join(', ')
       end
 
       def quote value, column = nil
+        return value if Arel::Nodes::SqlLiteral === value
         @connection.quote value, column
       end
 

data/lib/arel.rb

@@ -12,8 +12,6 @@ require 'arel/attributes'
 require 'arel/compatibility/wheres'
 
 #### these are deprecated
-# The Arel::Relation constant is referenced in Rails
-require 'arel/relation'
 require 'arel/expression'
 ####
 
@@ -34,7 +32,7 @@ require 'arel/sql_literal'
 ####
 
 module Arel
-  VERSION = '3.0.3'
+  VERSION = '4.0.0'
 
   def self.sql raw_sql
     Arel::Nodes::SqlLiteral.new raw_sql

data/test/nodes/test_and.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+module Arel
+  module Nodes
+    describe 'And' do
+      describe 'equality' do
+        it 'is equal with equal ivars' do
+          array = [And.new(['foo', 'bar']), And.new(['foo', 'bar'])]
+          assert_equal 1, array.uniq.size
+        end
+
+        it 'is not equal with different ivars' do
+          array = [And.new(['foo', 'bar']), And.new(['foo', 'baz'])]
+          assert_equal 2, array.uniq.size
+        end
+      end
+    end
+  end
+end
+

data/test/nodes/test_as.rb

@@ -17,6 +17,18 @@ module Arel
           assert_kind_of Arel::Nodes::SqlLiteral, as.right
         end
       end
+
+      describe 'equality' do
+        it 'is equal with equal ivars' do
+          array = [As.new('foo', 'bar'), As.new('foo', 'bar')]
+          assert_equal 1, array.uniq.size
+        end
+
+        it 'is not equal with different ivars' do
+          array = [As.new('foo', 'bar'), As.new('foo', 'baz')]
+          assert_equal 2, array.uniq.size
+        end
+      end
     end
   end
 end

data/test/nodes/test_ascending.rb

@@ -29,6 +29,16 @@ module Arel
         ascending = Ascending.new 'zomg'
         assert !ascending.descending?
       end
+
+      def test_equality_with_same_ivars
+        array = [Ascending.new('zomg'), Ascending.new('zomg')]
+        assert_equal 1, array.uniq.size
+      end
+
+      def test_inequality_with_different_ivars
+        array = [Ascending.new('zomg'), Ascending.new('zomg!')]
+        assert_equal 2, array.uniq.size
+      end
     end
   end
 end

data/test/nodes/test_bin.rb

@@ -18,6 +18,16 @@ module Arel
         node = Arel::Nodes::Bin.new(Arel.sql('zomg'))
         assert_equal 'BINARY zomg', viz.accept(node)
       end
+
+      def test_equality_with_same_ivars
+        array = [Bin.new('zomg'), Bin.new('zomg')]
+        assert_equal 1, array.uniq.size
+      end
+
+      def test_inequality_with_different_ivars
+        array = [Bin.new('zomg'), Bin.new('zomg!')]
+        assert_equal 2, array.uniq.size
+      end
     end
   end
 end

data/test/nodes/test_count.rb

@@ -24,4 +24,16 @@ describe Arel::Nodes::Count do
       }
     end
   end
+
+  describe 'equality' do
+    it 'is equal with equal ivars' do
+      array = [Arel::Nodes::Count.new('foo'), Arel::Nodes::Count.new('foo')]
+      assert_equal 1, array.uniq.size
+    end
+
+    it 'is not equal with different ivars' do
+      array = [Arel::Nodes::Count.new('foo'), Arel::Nodes::Count.new('foo!')]
+      assert_equal 2, array.uniq.size
+    end
+  end
 end

data/test/nodes/test_delete_statement.rb

@@ -11,4 +11,24 @@ describe Arel::Nodes::DeleteStatement do
       dolly.wheres.wont_be_same_as statement.wheres
     end
   end
+
+  describe 'equality' do
+    it 'is equal with equal ivars' do
+      statement1 = Arel::Nodes::DeleteStatement.new
+      statement1.wheres = %w[a b c]
+      statement2 = Arel::Nodes::DeleteStatement.new
+      statement2.wheres = %w[a b c]
+      array = [statement1, statement2]
+      assert_equal 1, array.uniq.size
+    end
+
+    it 'is not equal with different ivars' do
+      statement1 = Arel::Nodes::DeleteStatement.new
+      statement1.wheres = %w[a b c]
+      statement2 = Arel::Nodes::DeleteStatement.new
+      statement2.wheres = %w[1 2 3]
+      array = [statement1, statement2]
+      assert_equal 2, array.uniq.size
+    end
+  end
 end

data/test/nodes/test_descending.rb

@@ -29,6 +29,16 @@ module Arel
         descending = Descending.new 'zomg'
         assert descending.descending?
       end
+
+      def test_equality_with_same_ivars
+        array = [Descending.new('zomg'), Descending.new('zomg')]
+        assert_equal 1, array.uniq.size
+      end
+
+      def test_inequality_with_different_ivars
+        array = [Descending.new('zomg'), Descending.new('zomg!')]
+        assert_equal 2, array.uniq.size
+      end
     end
   end
 end

data/test/nodes/test_distinct.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+module Arel
+  module Nodes
+    describe 'Distinct' do
+      describe 'equality' do
+        it 'is equal to other distinct nodes' do
+          array = [Distinct.new, Distinct.new]
+          assert_equal 1, array.uniq.size
+        end
+
+        it 'is not equal with other nodes' do
+          array = [Distinct.new, Node.new]
+          assert_equal 2, array.uniq.size
+        end
+      end
+    end
+  end
+end
+

data/test/nodes/test_equality.rb

@@ -69,6 +69,16 @@ module Arel
           node.right.must_equal right
         end
       end
+
+      it 'is equal with equal ivars' do
+        array = [Equality.new('foo', 'bar'), Equality.new('foo', 'bar')]
+        assert_equal 1, array.uniq.size
+      end
+
+      it 'is not equal with different ivars' do
+        array = [Equality.new('foo', 'bar'), Equality.new('foo', 'baz')]
+        assert_equal 2, array.uniq.size
+      end
     end
   end
 end