squeel 1.0.18 → 1.1.0

data/lib/squeel/nodes/literal.rb

@@ -1,7 +1,7 @@
 module Squeel
   module Nodes
     # Literal nodes are a container for raw SQL.
-    class Literal
+    class Literal < Node
       include PredicateMethods
       include PredicateOperators
       include Operators

data/lib/squeel/nodes/nary.rb

@@ -1,7 +1,7 @@
 module Squeel
   module Nodes
     # A node containing multiple children. Just the And node for now.
-    class Nary
+    class Nary < Node
       include PredicateOperators
 
       # @return [Array] This node's children
@@ -17,20 +17,18 @@ module Squeel
         @children = children
       end
 
-      # Add a new child to the node's children
+      # Returns a new Nary node, with an additional child.
       # @param other A new child node
       # @return [Nary] This node, with its updated children.
       def &(other)
-        @children << other
-        self
+        self.class.new(@children + [other])
       end
 
-      # Append a new Not node to this node's children
+      # Returns a new Nary node, with an additional (negated) child.
       # @param other A new child node
       # @return [Nary] This node, with its new, negated child
       def -(other)
-        @children << Not.new(other)
-        self
+        self.class.new(@children + [Not.new(other)])
       end
 
       # Implemented for equality testing

data/lib/squeel/nodes/node.rb

@@ -0,0 +1,6 @@
+module Squeel
+  module Nodes
+    class Node
+    end
+  end
+end

data/lib/squeel/nodes/operation.rb

@@ -15,7 +15,7 @@ module Squeel
       end
 
       # An operation should probably call its "function" name an "operator", shouldn't it?
-      alias :operator :name
+      alias :operator :function_name
 
       # @return The left operand
       def left

data/lib/squeel/nodes/order.rb

@@ -1,7 +1,7 @@
 module Squeel
   module Nodes
     # A node that represents SQL orderings, such as "people.id DESC"
-    class Order
+    class Order < Node
       # @return The expression being ordered on. Might be an attribute, function, or operation
       attr_reader :expr
 

data/lib/squeel/nodes/predicate.rb

@@ -1,11 +1,11 @@
 module Squeel
   module Nodes
-    # This node is essentially a container that will result in ARel predicate nodes
+    # This node is essentially a container that will result in Arel predicate nodes
     # once visited. It stores the expression (normally an attribute name, function, or
-    # operation), the ARel predicate method name, and a value. these are then interpreted
+    # operation), the Arel predicate method name, and a value. these are then interpreted
     # when visited by the PredicateVisitor to generate a condition against the appropriate
     # columns.
-    class Predicate
+    class Predicate < Node
 
       include PredicateOperators
       include Aliasing
@@ -16,12 +16,12 @@ module Squeel
       # @return The expression on the left side of this predicate.
       attr_reader :expr
 
-      # @return [Symbol] The ARel "predication" method name, such as eq, matches, etc.
+      # @return [Symbol] The Arel "predication" method name, such as eq, matches, etc.
       attr_reader :method_name
 
       # Create a new Predicate node with the given expression, method name, and value
       # @param expr The expression for the left hand side of the predicate.
-      # @param [Symbol] method_name The ARel predication method
+      # @param [Symbol] method_name The Arel predication method
       # @param value An optional value. If not given, one will need to be supplied
       #   before the node can be visited properly.
       def initialize(expr, method_name = :eq, value = :__undefined__)

data/lib/squeel/nodes/predicate_methods.rb

@@ -1,9 +1,9 @@
 module Squeel
   module Nodes
-    # Defines Predicate factories named for each of the ARel predication methods
+    # Defines Predicate factories named for each of the Arel predication methods
     module PredicateMethods
 
-      Constants::PREDICATES.each do |method_name|
+      (Constants::PREDICATES - [:eq]).each do |method_name|
         class_eval <<-RUBY
           def #{method_name}(value = :__undefined__)
             Nodes::Predicate.new self, :#{method_name}, value
@@ -11,6 +11,15 @@ module Squeel
         RUBY
       end
 
+      # YAY WHERECHAIN
+      def eq(value = :__undefined__)
+        if :chain == value
+          false
+        else
+          Nodes::Predicate.new self, :eq, value
+        end
+      end
+
     end
   end
 end

data/lib/squeel/nodes/sifter.rb

@@ -1,6 +1,6 @@
 module Squeel
   module Nodes
-    class Sifter
+    class Sifter < Node
       include PredicateOperators
 
       attr_reader :name, :args
@@ -24,4 +24,4 @@ module Squeel
 
     end
   end
-end
+end

data/lib/squeel/nodes/stub.rb

@@ -3,7 +3,7 @@ module Squeel
     # Stub nodes are basically a container for a Symbol that can have handy predicate
     # methods and operators defined on it since doing so on Symbol will incur the
     # nerdrage of many.
-    class Stub
+    class Stub < Node
       include PredicateMethods
       include Operators
       include Aliasing
@@ -21,7 +21,7 @@ module Squeel
       alias :< :lt
       alias :<= :lteq
 
-      # We dn't want these default Object methods, because if we're
+      # We don't want these default Object methods, because if we're
       # calling them we are probably talking about a column name
       [:id, :type].each do |column_method|
         undef_method column_method if method_defined?(column_method) ||

data/lib/squeel/nodes/unary.rb

@@ -1,7 +1,7 @@
 module Squeel
   module Nodes
     # A node that contains a single expression.
-    class Unary
+    class Unary < Node
 
       include PredicateOperators
 

data/lib/squeel/version.rb

@@ -1,3 +1,3 @@
 module Squeel
-  VERSION = "1.0.18"
+  VERSION = '1.1.0'
 end

data/lib/squeel/visitors/predicate_visitation.rb

@@ -16,14 +16,14 @@ module Squeel
       # @return The result of visiting the executed block's return value
       def visit_Squeel_Nodes_Sifter(o, parent)
         klass = classify(parent)
-        visit(klass.send(o.name, *o.args), parent)
+        visit(klass.send("sifter_#{o.name}", *o.args), parent)
       end
 
-      # Visit a Squeel predicate, converting it into an ARel predicate
+      # Visit a Squeel predicate, converting it into an Arel predicate
       #
       # @param [Nodes::Predicate] o The predicate to visit
       # @param parent The parent object in the context
-      # @return An ARel predicate node
+      # @return An Arel predicate node
       #   (Arel::Nodes::Equality, Arel::Nodes::Matches, etc)
       def visit_Squeel_Nodes_Predicate(o, parent)
         value = o.value
@@ -59,10 +59,10 @@ module Squeel
       # Determine whether to use IN or equality testing for a predicate,
       # based on its value class, then return the appropriate predicate.
       #
-      # @param attribute The ARel attribute (or function/operation) the
+      # @param attribute The Arel attribute (or function/operation) the
       #   predicate will be created for
       # @param value The value to be compared against
-      # @return [Arel::Nodes::Node] An ARel predicate node
+      # @return [Arel::Nodes::Node] An Arel predicate node
       def arel_predicate_for(attribute, value, parent)
         if ActiveRecord::Relation === value && value.select_values.empty?
           value = visit(value.select(value.klass.arel_table[value.klass.primary_key]), parent)
@@ -102,7 +102,7 @@ module Squeel
         end
       end
 
-      # Certain nodes require us to do the quoting before the ARel
+      # Certain nodes require us to do the quoting before the Arel
       # visitor gets a chance to try, because we want to avoid having our
       # values quoted as a type of the last visited column. Otherwise, we
       # can end up with annoyances like having "joe" quoted to 0, if the

data/lib/squeel/visitors/predicate_visitor.rb

@@ -45,7 +45,7 @@ module Squeel
       # @param k The hash key
       # @param v The hash value
       # @param parent The current parent object in the context
-      # @return An ARel predicate
+      # @return An Arel predicate
       def visit_without_hash_context_shift(k, v, parent)
         case v
         when Nodes::Stub, Symbol

data/lib/squeel/visitors/visitor.rb

@@ -22,7 +22,7 @@ module Squeel
       # @param object The object to visit
       # @param parent The parent of this object, to track the object's place in
       #   any association hierarchy.
-      # @return The results of the node visitation, typically an ARel object of some kind.
+      # @return The results of the node visitation, typically an Arel object of some kind.
       def accept(object, parent = context.base)
         visit(object, parent)
       end
@@ -100,13 +100,13 @@ module Squeel
         v
       end
 
-      # Important to avoid accidentally allowing the default ARel visitor's
+      # Important to avoid accidentally allowing the default Arel visitor's
       # last_column quoting behavior (where a value is quoted as though it
       # is of the type of the last visited column). This can wreak havoc with
       # Functions and Operations.
       #
       # @param object The object to check
-      # @return [Boolean] Whether or not the ARel visitor will try to quote the
+      # @return [Boolean] Whether or not the Arel visitor will try to quote the
       #   object if not passed as an SqlLiteral.
       def quoted?(object)
         case object
@@ -119,7 +119,7 @@ module Squeel
       end
 
       # Quote a value based on its type, not on the last column used by the
-      # ARel visitor. This is occasionally necessary to avoid having ARel
+      # Arel visitor. This is occasionally necessary to avoid having Arel
       # quote a value according to an integer column, converting 'My String' to 0.
       #
       # @param value The value to quote
@@ -159,7 +159,7 @@ module Squeel
 
       # Pass an object through the visitor unmodified. This is
       # in order to allow objects that don't require modification
-      # to be handled by ARel directly.
+      # to be handled by Arel directly.
       #
       # @param object The object to visit
       # @param parent The object's parent within the context
@@ -231,7 +231,7 @@ module Squeel
         visit(o.endpoint, parent)
       end
 
-      # Visit a Literal by converting it to an ARel SqlLiteral
+      # Visit a Literal by converting it to an Arel SqlLiteral
       #
       # @param [Nodes::Literal] o The Literal to visit
       # @param parent The parent object in the context (unused)
@@ -240,7 +240,7 @@ module Squeel
         Arel.sql(o.expr)
       end
 
-      # Visit a Squeel As node, resulting in am ARel As node.
+      # Visit a Squeel As node, resulting in am Arel As node.
       #
       # @param [Nodes::As] The As node to visit
       # @param parent The parent object in the context
@@ -256,46 +256,46 @@ module Squeel
         end
       end
 
-      # Visit a Squeel And node, returning an ARel Grouping containing an
-      # ARel And node.
+      # Visit a Squeel And node, returning an Arel Grouping containing an
+      # Arel And node.
       #
       # @param [Nodes::And] o The And node to visit
       # @param parent The parent object in the context
-      # @return [Arel::Nodes::Grouping] A grouping node, containnig an ARel
+      # @return [Arel::Nodes::Grouping] A grouping node, containnig an Arel
       #   And node as its expression. All children will be visited before
       #   being passed to the And.
       def visit_Squeel_Nodes_And(o, parent)
         Arel::Nodes::Grouping.new(Arel::Nodes::And.new(visit(o.children, parent)))
       end
 
-      # Visit a Squeel Or node, returning an ARel Or node.
+      # Visit a Squeel Or node, returning an Arel Or node.
       #
       # @param [Nodes::Or] o The Or node to visit
       # @param parent The parent object in the context
-      # @return [Arel::Nodes::Or] An ARel Or node, with left and right sides visited
+      # @return [Arel::Nodes::Or] An Arel Or node, with left and right sides visited
       def visit_Squeel_Nodes_Or(o, parent)
         Arel::Nodes::Grouping.new(Arel::Nodes::Or.new(visit(o.left, parent), (visit(o.right, parent))))
       end
 
-      # Visit a Squeel Not node, returning an ARel Not node.
+      # Visit a Squeel Not node, returning an Arel Not node.
       #
       # @param [Nodes::Not] o The Not node to visit
       # @param parent The parent object in the context
-      # @return [Arel::Nodes::Not] An ARel Not node, with expression visited
+      # @return [Arel::Nodes::Not] An Arel Not node, with expression visited
       def visit_Squeel_Nodes_Not(o, parent)
         Arel::Nodes::Not.new(visit(o.expr, parent))
       end
 
-      # Visit a Squeel Grouping node, returning an ARel Grouping node.
+      # Visit a Squeel Grouping node, returning an Arel Grouping node.
       #
       # @param [Nodes::Grouping] o The Grouping node to visit
       # @param parent The parent object in the context
-      # @return [Arel::Nodes::Grouping] An ARel Grouping node, with expression visited
+      # @return [Arel::Nodes::Grouping] An Arel Grouping node, with expression visited
       def visit_Squeel_Nodes_Grouping(o, parent)
         Arel::Nodes::Grouping.new(visit(o.expr, parent))
       end
       #
-      # Visit a Squeel function, returning an ARel NamedFunction node.
+      # Visit a Squeel function, returning an Arel NamedFunction node.
       #
       # @param [Nodes::Function] o The function node to visit
       # @param parent The parent object in the context
@@ -315,10 +315,10 @@ module Squeel
           end
         end
 
-        Arel::Nodes::NamedFunction.new(o.name, args)
+        Arel::Nodes::NamedFunction.new(o.function_name, args)
       end
 
-      # Visit a Squeel operation node, convering it to an ARel InfixOperation
+      # Visit a Squeel operation node, convering it to an Arel InfixOperation
       # (or subclass, as appropriate)
       #
       # @param [Nodes::Operation] o The Operation node to visit
@@ -356,7 +356,7 @@ module Squeel
       # Visit an Active Record Relation, returning an Arel::SelectManager
       # @param [ActiveRecord::Relation] o The Relation to visit
       # @param parent The parent object in the context
-      # @return [Arel::SelectManager] The ARel select manager that represents
+      # @return [Arel::SelectManager] The Arel select manager that represents
       #   the relation's query
       def visit_ActiveRecord_Relation(o, parent)
         o.arel

data/spec/spec_helper.rb

@@ -3,12 +3,10 @@ require 'sham'
 require 'faker'
 
 module ActiveRecord
+  # Shamelessly swiped from the AR test code
   class SQLCounter
     IGNORED_SQL = [/^PRAGMA /, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /^SHOW max_identifier_length/,
       /SELECT name\s+FROM sqlite_master\s+WHERE type = 'table' AND NOT name = 'sqlite_sequence'/]
-
-    # FIXME: this needs to be refactored so specific database can add their own
-    # ignored SQL.  This ignored SQL is for Oracle.
     IGNORED_SQL.concat [/^select .*nextval/i, /^SAVEPOINT/, /^ROLLBACK TO/, /^\s*select .* from all_triggers/im]
 
     def initialize
@@ -26,6 +24,10 @@ module ActiveRecord
   ActiveSupport::Notifications.subscribe('sql.active_record', SQLCounter.new)
 end
 
+unless ENV['DEPRECATIONS']
+  ActiveSupport::Deprecation.silenced = true
+end
+
 Dir[File.expand_path('../helpers/*.rb', __FILE__)].each do |f|
   require f
 end
@@ -45,7 +47,7 @@ end
 RSpec.configure do |config|
   config.before(:suite) do
     puts '=' * 80
-    puts "Running specs against Active Record #{ActiveRecord::VERSION::STRING} and ARel #{Arel::VERSION}..."
+    puts "Running specs against Active Record #{ActiveRecord::VERSION::STRING} and Arel #{Arel::VERSION}..."
     puts '=' * 80
     Models.make
   end

data/spec/squeel/adapters/active_record/base_extensions_spec.rb

@@ -22,19 +22,19 @@ module Squeel
               end
             end
 
-            it { should respond_to :title_or_body_contains }
-            specify { subject.title_or_body_contains('ernie').should be_a Nodes::Or }
+            it { should respond_to :sifter_title_or_body_contains }
+            specify { subject.sifter_title_or_body_contains('ernie').should be_a Nodes::Or }
           end
 
           context 'with a sifter defined via method' do
             before :all do
-              def subject.title_starts_with(val)
+              def subject.sifter_title_starts_with(val)
                 squeel{title =~ "#{val}%"}
               end
             end
 
-            it { should respond_to :title_starts_with }
-            specify { subject.title_starts_with('ernie').should be_a Nodes::Predicate }
+            it { should respond_to :sifter_title_starts_with }
+            specify { subject.sifter_title_starts_with('ernie').should be_a Nodes::Predicate }
           end
 
         end
@@ -42,4 +42,4 @@ module Squeel
       end
     end
   end
-end
+end

data/spec/squeel/adapters/active_record/relation_extensions_spec.rb

@@ -78,7 +78,7 @@ module Squeel
             Article.first.uniq_commenters.length.should eq Article.first.uniq_commenters.count
           end
 
-          it 'visits wheres with a PredicateVisitor, converting them to ARel nodes' do
+          it 'visits wheres with a PredicateVisitor, converting them to Arel nodes' do
             relation = Person.where(:name.matches => '%bob%')
             arel = relation.build_arel
             arel.to_sql.should match /"people"."name" LIKE '%bob%'/
@@ -155,25 +155,29 @@ module Squeel
           end
 
           it 'maps orders inside a hash to their appropriate association table' do
-            relation = Person.joins({
-              :children => {
+            unless activerecord_version_at_least '4.0.0'
+              relation = Person.joins({
                 :children => {
-                  :parent => :parent
+                  :children => {
+                    :parent => :parent
+                  }
                 }
-              }
-            }).order({
-              :children => {
+              }).order({
                 :children => {
-                  :parent => {
-                    :parent => :id.asc
+                  :children => {
+                    :parent => {
+                      :parent => :id.asc
+                    }
                   }
                 }
-              }
-            })
+              })
 
-            arel = relation.build_arel
+              arel = relation.build_arel
 
-            arel.to_sql.should match /ORDER BY "parents_people_2"."id" ASC/
+              arel.to_sql.should match /ORDER BY "parents_people_2"."id" ASC/
+            else
+              pending 'Unsupported in ActiveRecord 4.0.0+'
+            end
           end
 
           it 'does not inadvertently convert KeyPaths to booleans when uniqing where_values' do
@@ -186,7 +190,7 @@ module Squeel
           end
 
           it 'reverses order of Arel::Attributes when #last is called' do
-            sorted_people = Person.all.sort {|a, b| a.name.downcase <=> b.name.downcase}
+            sorted_people = Person.all.to_a.sort {|a, b| a.name.downcase <=> b.name.downcase}
 
             Person.order{name}.last.should eq sorted_people.last
           end
@@ -242,7 +246,7 @@ module Squeel
           it 'eager loads belongs_to associations' do
             queries = queries_for do
               Article.includes(:person).
-                      where{person.name == 'Ernie'}.all
+                      where{person.name == 'Ernie'}.to_a
             end
             queries.should have(1).item
             queries.first.should match /LEFT OUTER JOIN "people"/
@@ -252,7 +256,7 @@ module Squeel
           it 'eager loads belongs_to associations on models with default_scopes' do
             queries = queries_for do
               PersonNamedBill.includes(:parent).
-                              where{parent.name == 'Ernie'}.all
+                              where{parent.name == 'Ernie'}.to_a
             end
             queries.should have(1).item
             queries.first.should match /LEFT OUTER JOIN "people"/
@@ -289,13 +293,13 @@ module Squeel
 
           it 'builds options with a block' do
             relation = Person.preload{children}
-            queries_for {relation.all}.should have(2).items
+            queries_for {relation.to_a}.should have(2).items
             queries_for {relation.first.children}.should have(0).items
           end
 
           it 'builds options with a keypath' do
             relation = Person.preload{articles.comments}
-            queries_for {relation.all}.should have(3).items
+            queries_for {relation.to_a}.should have(3).items
             queries_for {relation.first.articles.first.comments}.should have(0).items
           end
 
@@ -306,7 +310,7 @@ module Squeel
               }
             }}
 
-            queries_for {relation.all}.should have(4).items
+            queries_for {relation.to_a}.should have(4).items
 
             queries_for {
               relation.first.articles
@@ -323,7 +327,7 @@ module Squeel
             standard = Person.eager_load(:children => :children)
             block = Person.eager_load{{children => children}}
             block.debug_sql.should eq standard.debug_sql
-            queries_for {block.all}.should have(1).item
+            queries_for {block.to_a}.should have(1).item
             queries_for {block.first.children}.should have(0).items
           end
 
@@ -417,7 +421,11 @@ module Squeel
         describe '#count' do
 
           it 'works with non-strings in select' do
-            Article.select{distinct(title)}.count.should eq 51
+            if activerecord_version_at_least '4.0.0'
+              pending 'broken on current 4-0-stable'
+            else
+              Article.select{distinct(title)}.count.should eq 51
+            end
           end
 
           it 'works with non-strings in wheres' do
@@ -496,6 +504,16 @@ module Squeel
             old_and_busted.to_a.should eq new_hotness.to_a
           end
 
+          it 'is backwards-compatible with "where.not"' do
+            if activerecord_version_at_least '4.0.0'
+              name = Person.first.name
+              result = Person.where.not(:name => name)
+              result.should_not include Person.first
+            else
+              pending 'Not required pre-4.0'
+            end
+          end
+
         end
 
         describe '#joins' do
@@ -572,9 +590,22 @@ module Squeel
         describe '#order' do
 
           it 'builds options with a block' do
-            standard = Person.order(:name)
             block = Person.order{name}
-            block.to_sql.should eq standard.to_sql
+            block.to_sql.should match /ORDER BY "people"\."name"/
+          end
+
+          it 'allows AR 4.0-style hash options' do
+            if activerecord_version_at_least '4.0.0'
+              block = Person.order(:name => :desc)
+              block.to_sql.should match /ORDER BY "people"\."name" DESC/
+            else
+              pending 'Not required in AR versions < 4.0.0'
+            end
+          end
+
+          it 'allows ordering by an attributes of a joined table' do
+            relation = Article.joins(:person).order { person.id.asc }
+            relation.to_sql.should match /ORDER BY "people"\."id" ASC/
           end
 
         end
@@ -631,7 +662,7 @@ module Squeel
             wheres.should eq ["name like '%bob%'"]
           end
 
-          it 'adds hash where values without converting to ARel predicates' do
+          it 'adds hash where values without converting to Arel predicates' do
             wheres = Person.where({:name => 'bob'}).where_values
             wheres.should eq [{:name => 'bob'}]
           end