squeel 1.0.6 → 1.0.7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.7 (2012-07-14)
+
+* Prevent reorder(nil) on reversed SQL from adding an order by id.
+
 ## 1.0.6 (2012-06-16)
 
 * Prevent cloned KeyPaths from modifying each other. Fixes #135

data/lib/squeel/adapters/active_record.rb

@@ -20,7 +20,7 @@ when 3
     require 'squeel/adapters/active_record/3.1/relation_extensions'
     require 'squeel/adapters/active_record/3.1/preloader_extensions'
     require 'squeel/adapters/active_record/3.1/context'
-    
+
     ActiveRecord::Relation.send :include, Squeel::Adapters::ActiveRecord::RelationExtensions
     ActiveRecord::Associations::JoinDependency.send :include, Squeel::Adapters::ActiveRecord::JoinDependencyExtensions
     ActiveRecord::Associations::Preloader.send :include, Squeel::Adapters::ActiveRecord::PreloaderExtensions

data/lib/squeel/adapters/active_record/3.0/relation_extensions.rb

@@ -39,14 +39,18 @@ module Squeel
         # behavior with Squeel loaded is to visit the *_values arrays in
         # the relations we're merging, and then use the default AR merge
         # code on the result.
-        def merge(r, relations_visited = false)
-          if relations_visited or not ::ActiveRecord::Relation === r
+        def merge(r, skip_visit = false)
+          if skip_visit or not ::ActiveRecord::Relation === r
             super(r)
           else
-            clone.visit!.merge(r.clone.visit!, true)
+            visited.merge(r.visited, true)
           end
         end
 
+        def visited
+          clone.visit!
+        end
+
         def visit!
           predicate_viz = predicate_visitor
           attribute_viz = attribute_visitor

data/lib/squeel/adapters/active_record/3.1/relation_extensions.rb

@@ -39,22 +39,16 @@ module Squeel
         # behavior with Squeel loaded is to visit the *_values arrays in
         # the relations we're merging, and then use the default AR merge
         # code on the result.
-        def merge(r, relations_visited = false)
-          if relations_visited or not ::ActiveRecord::Relation === r
+        def merge(r, skip_visit = false)
+          if skip_visit or not ::ActiveRecord::Relation === r
             super(r)
           else
-            clone.visit!.merge(r.clone.visit!, true)
+            visited.merge(r.visited, true)
           end
         end
 
-        def prepare_relation_for_association_merge!(r, association_name)
-          r.where_values.map! {|w| Squeel::Visitors::PredicateVisitor.can_visit?(w) ? {association_name => w} : w}
-          r.having_values.map! {|h| Squeel::Visitors::PredicateVisitor.can_visit?(h) ? {association_name => h} : h}
-          r.group_values.map! {|g| Squeel::Visitors::AttributeVisitor.can_visit?(g) ? {association_name => g} : g}
-          r.order_values.map! {|o| Squeel::Visitors::AttributeVisitor.can_visit?(o) ? {association_name => o} : o}
-          r.select_values.map! {|s| Squeel::Visitors::AttributeVisitor.can_visit?(s) ? {association_name => s} : s}
-          r.joins_values.map! {|j| [Symbol, Hash, Nodes::Stub, Nodes::Join, Nodes::KeyPath].include?(j.class) ? {association_name => j} : j}
-          r.includes_values.map! {|i| [Symbol, Hash, Nodes::Stub, Nodes::Join, Nodes::KeyPath].include?(i.class) ? {association_name => i} : i}
+        def visited
+          clone.visit!
         end
 
         def visit!
@@ -89,9 +83,9 @@ module Squeel
           arel.group(*attribute_viz.accept(@group_values.uniq.reject{|g| g.blank?})) unless @group_values.empty?
 
           order = @reorder_value ? @reorder_value : @order_values
-          order = attribute_viz.accept(order.uniq.reject{|o| o.blank?})
+          order = attribute_viz.accept(order)
           order = reverse_sql_order(attrs_to_orderings(order)) if @reverse_order_value
-          arel.order(*order) unless order.empty?
+          arel.order(*order.uniq.reject{|o| o.blank?}) unless order.empty?
 
           build_select(arel, attribute_viz.accept(@select_values.uniq))
 
@@ -318,6 +312,33 @@ module Squeel
           }.compact.flatten
         end
 
+        def flatten_nodes(nodes)
+          nodes.map { |node|
+            case node
+            when Array
+              flatten_nodes(node)
+            when Nodes::And
+              flatten_nodes(node.children)
+            when Nodes::Grouping
+              flatten_nodes(node.expr)
+            else
+              node
+            end
+          }.flatten
+        end
+
+        def overwrite_squeel_equalities(wheres)
+          seen = {}
+          flatten_nodes(wheres).reverse.reject { |n|
+            nuke = false
+            if Nodes::Predicate === n && n.method_name == :eq
+              nuke       = seen[n.expr]
+              seen[n.expr] = true
+            end
+            nuke
+          }.reverse
+        end
+
         # Simulate the logic that occurs in #to_a
         #
         # This will let us get a dump of the SQL that will be run against the
@@ -338,9 +359,11 @@ module Squeel
         # ...
         # Since you're still looking, let me explain this horrible
         # transgression you see before you.
-        # You see, Relation#where_values_hash is defined on the
-        # ActiveRecord::Relation class. Since it's defined there, but
-        # I would very much like to modify its behavior, I have three
+        #
+        # You see, Relation#where_values_hash and with_default_scope
+        # are defined on the ActiveRecord::Relation class, itself.
+        # ActiveRecord::Relation class. Since they're defined there, but
+        # I would very much like to modify their behavior, I have three
         # choices.
         #
         # 1. Inherit from ActiveRecord::Relation in a Squeel::Relation
@@ -349,7 +372,7 @@ module Squeel
         #    evil stuff with constant reassignment, all for the sake of
         #    being able to use super().
         #
-        # 2. Submit a patch to Rails core, breaking this method off into
+        # 2. Submit a patch to Rails core, breaking these methods off into
         #    another module, all for my own selfish desire to use super()
         #    while mucking about in Rails internals.
         #
@@ -357,19 +380,61 @@ module Squeel
         #
         # I opted to go with #3. Except for the hail Hansson thing.
         # Unless you're DHH, in which case, I totally said them.
+        #
+        # If you'd like to read more about alias_method_chain, see
+        # http://erniemiller.org/2011/02/03/when-to-use-alias_method_chain/
 
         def self.included(base)
           base.class_eval do
             alias_method_chain :where_values_hash, :squeel
+            alias_method_chain :with_default_scope, :squeel
           end
         end
 
+        # where_values_hash is used in scope_for_create. It's what allows
+        # new records to be created with any equality values that exist in
+        # your model's default scope. We hijack it in order to dig down into
+        # And and Grouping nodes, which are equivalent to seeing top-level
+        # Equality nodes in stock AR terms.
         def where_values_hash_with_squeel
           equalities = find_equality_predicates(predicate_visitor.accept(with_default_scope.where_values))
 
           Hash[equalities.map { |where| [where.left.name, where.right] }]
         end
 
+        # with_default_scope was added to ActiveRecord ~> 3.1 in order to
+        # address https://github.com/rails/rails/issues/1233. Unfortunately,
+        # it plays havoc with Squeel's approach of visiting both sides of
+        # a relation merge. Thankfully, when merging with a relation from
+        # the same AR::Base, it's unnecessary to visit...
+        #
+        # Except, of course, this means we have to handle the edge case
+        # where equalities are duplicated on both sides of the merge, in
+        # which case, unlike all other chained relation calls, the latter
+        # equality overwrites the former.
+        #
+        # The workaround using overwrite_squeel_equalities works as long
+        # as you stick to the Squeel DSL, but breaks down if you throw hash
+        # conditions into the mix. If anyone's got any suggestions, I'm all
+        # ears. Otherwise, just stick to the Squeel DSL.
+        #
+        # Or, don't use default scopes. They're the devil, anyway. I can't
+        # remember the last time I used one and didn't find myself
+        # regretting the decision later.
+        def with_default_scope_with_squeel
+          if default_scoped? &&
+            default_scope = klass.build_default_scope_with_squeel
+            default_scope = default_scope.merge(self, true)
+            default_scope.default_scoped = false
+            default_scope.where_values = overwrite_squeel_equalities(
+              default_scope.where_values + self.where_values
+            )
+            default_scope
+          else
+            self
+          end
+        end
+
       end
     end
   end

data/lib/squeel/adapters/active_record/base_extensions.rb

@@ -16,7 +16,26 @@ module Squeel
           end
         end
 
+        def build_default_scope_with_squeel #:nodoc:
+          if defined?(::ActiveRecord::Scoping) &&
+            method(:default_scope).owner != ::ActiveRecord::Scoping::Default::ClassMethods
+            evaluate_default_scope { default_scope }
+          elsif default_scopes.any?
+            evaluate_default_scope do
+              default_scopes.inject(relation) do |default_scope, scope|
+                if scope.is_a?(Hash)
+                  default_scope.apply_finder_options(scope)
+                elsif !scope.is_a?(::ActiveRecord::Relation) && scope.respond_to?(:call)
+                  default_scope.merge(scope.call, true)
+                else
+                  default_scope.merge(scope, true)
+                end
+              end
+            end
+          end
+        end
+
       end
     end
   end
-end
+end

data/lib/squeel/adapters/active_record/relation_extensions.rb

@@ -22,10 +22,9 @@ module Squeel
 
           arel.group(*attribute_viz.accept(@group_values.uniq.reject{|g| g.blank?})) unless @group_values.empty?
 
-          order = @reorder_value ? @reorder_value : @order_values
-          order = attribute_viz.accept(order.uniq.reject{|o| o.blank?})
+          order = attribute_viz.accept(@order_values)
           order = reverse_sql_order(attrs_to_orderings(order)) if @reverse_order_value
-          arel.order(*order) unless order.empty?
+          arel.order(*order.uniq.reject{|o| o.blank?}) unless order.empty?
 
           build_select(arel, attribute_viz.accept(@select_values.uniq))
 

data/lib/squeel/nodes/function.rb

@@ -7,6 +7,7 @@ module Squeel
       include PredicateOperators
       include Operators
       include Ordering
+      include Aliasing
 
       alias :== :eq
       alias :'^' :not_eq
@@ -26,10 +27,6 @@ module Squeel
       # @return [Array] The arguments to be passed to the SQL function
       attr_reader :args
 
-      # @return [String] The SQL function's alias
-      # @return [NilClass] If no alias
-      attr_reader :alias
-
       # Create a node representing an SQL Function with the given name and arguments
       # @param [Symbol] name The function name
       # @param [Array] args The array of arguments to pass to the function.
@@ -37,14 +34,6 @@ module Squeel
         @name, @args = name, args
       end
 
-      # Set an alias for the function
-      # @param [String, Symbol] The alias name
-      # @return [Function] This function with the new alias value.
-      def as(alias_name)
-        @alias = alias_name.to_s
-        self
-      end
-
       # expand_hash_conditions_for_aggregates assumes our hash keys can be
       # converted to symbols, so this has to be implemented, but it doesn't
       # really have to do anything useful.

data/lib/squeel/nodes/operation.rb

@@ -29,4 +29,4 @@ module Squeel
 
     end
   end
-end
+end

data/lib/squeel/version.rb

@@ -1,3 +1,3 @@
 module Squeel
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end

data/lib/squeel/visitors/attribute_visitor.rb

@@ -99,9 +99,8 @@ module Squeel
             quote arg
           end
         end
-        func = Arel::Nodes::NamedFunction.new(o.name, args)
 
-        o.alias ? func.as(o.alias) : func
+        Arel::Nodes::NamedFunction.new(o.name, args)
       end
 
       # Visit an Operation node. Each operand will be accepted or
@@ -134,7 +133,8 @@ module Squeel
         else
           Arel.sql("#{arel_visitor.accept(args[0])} #{o.operator} #{arel_visitor.accept(args[1])}")
         end
-        o.alias ? op.as(o.alias) : op
+
+        op
       end
 
       # Visit a Squeel Grouping node, resulting in am ARel Grouping node.

data/lib/squeel/visitors/predicate_visitor.rb

@@ -152,9 +152,8 @@ module Squeel
             quote arg
           end
         end
-        func = Arel::Nodes::NamedFunction.new(o.name, args)
 
-        o.alias ? func.as(o.alias) : func
+        Arel::Nodes::NamedFunction.new(o.name, args)
       end
 
       # Visit an ActiveRecord Relation, returning an Arel::SelectManager
@@ -199,7 +198,8 @@ module Squeel
         else
           Arel::Nodes::InfixOperation.new(o.operator, args[0], args[1])
         end
-        o.alias ? op.as(o.alias) : op
+
+        op
       end
 
       # Visit a Squeel And node, returning an ARel Grouping containing an

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

@@ -258,12 +258,25 @@ module Squeel
             block.debug_sql.should eq standard.debug_sql
           end
 
-          it 'eager loads belongs_to_associations' do
-            relation = Article.includes(:person).
-              where{person.name == 'Ernie'}
-            sql = relation.debug_sql
-            sql.should match /LEFT OUTER JOIN "people"/
-            sql.should match /"people"."name" = 'Ernie'/
+          it 'eager loads belongs_to associations' do
+            queries = queries_for do
+              Article.includes(:person).
+                      where{person.name == 'Ernie'}.all
+            end
+            queries.should have(1).item
+            queries.first.should match /LEFT OUTER JOIN "people"/
+            queries.first.should match /"people"."name" = 'Ernie'/
+          end
+
+          it 'eager loads belongs_to associations on models with default_scopes' do
+            queries = queries_for do
+              PersonNamedBill.includes(:parent).
+                              where{parent.name == 'Ernie'}.all
+            end
+            queries.should have(1).item
+            queries.first.should match /LEFT OUTER JOIN "people"/
+            queries.first.should match /"people"."name" = 'Bill'/
+            queries.first.should match /"parents_people"."name" = 'Ernie'/
           end
 
           it 'eager loads polymorphic belongs_to associations' do
@@ -409,10 +422,25 @@ module Squeel
             aric.last_article_id.should eq Article.where(:person_id => 1).last.id
           end
 
-          it "doesn't break #count if non-strings are used" do
+        end
+
+        describe '#count' do
+
+          it 'works with non-strings in select' do
             Article.select{distinct(title)}.count.should eq 51
           end
 
+          it 'works with non-strings in wheres' do
+            first_name = Person.first.name
+            Person.where{name.op('=', first_name)}.count.should eq 1
+          end
+
+          it 'works with non-strings in group' do
+            pending "Requires some big hacks to execute_grouped_calculation"
+            counts = Person.group{name.op('||', '-diddly')}.count
+            counts.should eq Person.group{name.op('||', '-diddly')}.count
+          end
+
         end
 
         describe '#group' do
@@ -476,11 +504,6 @@ module Squeel
             old_and_busted.to_a.should eq new_hotness.to_a
           end
 
-          it "doesn't break #count if wheres contain InfixOperations" do
-            first_name = Person.first.name
-            Person.where{name.op('=', first_name)}.count.should eq 1
-          end
-
         end
 
         describe '#joins' do
@@ -570,11 +593,23 @@ module Squeel
           end
 
           it 'builds options with a block' do
-            block = Person.reorder{id}
+            block = @standard.reorder{id}
             block.to_sql.should_not eq @standard.to_sql
             block.to_sql.should match /ORDER BY "people"."id"/
           end
 
+          it 'drops order by clause when passed nil' do
+            block = @standard.reorder(nil)
+            sql = block.to_sql
+            sql.should_not match /ORDER BY/
+          end
+
+          it 'drops order by clause when passed nil if reversed' do
+            block = @standard.reverse_order.reorder(nil)
+            sql = block.to_sql
+            sql.should_not match /ORDER BY/
+          end
+
         end
 
         describe '#build_where' do
@@ -689,6 +724,13 @@ module Squeel
             sql.should match /Bert/
           end
 
+          it 'uses the given equality condition in the case of a conflicting where from a default scope in AR >= 3.1' do
+            relation = PersonNamedBill.where{name == 'Ernie'}
+            sql = relation.to_sql
+            sql.should_not match /Bill/
+            sql.should match /Ernie/
+          end unless ::ActiveRecord::VERSION::MINOR == 0
+
           it "doesn't ruin everything when a scope returns nil" do
             relation = Person.nil_scope
             relation.should eq Person.scoped

data/spec/squeel/nodes/function_spec.rb

@@ -153,20 +153,6 @@ module Squeel
         negated.expr.should eq @f
       end
 
-      describe '#as' do
-
-        it 'aliases the function' do
-          @f.as('the_alias')
-          @f.alias.should eq 'the_alias'
-        end
-
-        it 'casts the alias to a string' do
-          @f.as(:the_alias)
-          @f.alias.should eq 'the_alias'
-        end
-
-      end
-
     end
   end
 end

data/spec/squeel/nodes/operation_spec.rb

@@ -153,20 +153,6 @@ module Squeel
         negated.expr.should eq @o
       end
 
-      describe '#as' do
-
-        it 'aliases the function' do
-          @o.as('the_alias')
-          @o.alias.should eq 'the_alias'
-        end
-
-        it 'casts the alias to a string' do
-          @o.as(:the_alias)
-          @o.alias.should eq 'the_alias'
-        end
-
-      end
-
     end
   end
 end

data/spec/support/schema.rb

@@ -37,7 +37,8 @@ end
 
 class PersonNamedBill < ActiveRecord::Base
   self.table_name = 'people'
-  default_scope where(:name => 'Bill')
+  belongs_to :parent, :class_name => 'Person', :foreign_key => :parent_id
+  default_scope where{name == 'Bill'}
 end
 
 class Message < ActiveRecord::Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: squeel
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-16 00:00:00.000000000 Z
+date: 2012-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -240,7 +240,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4410929732049188226
+      hash: -1051407331683440462
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -249,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4410929732049188226
+      hash: -1051407331683440462
 requirements: []
 rubyforge_project: squeel
 rubygems_version: 1.8.24