squeel 0.7.0 → 0.7.1

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

@@ -49,7 +49,7 @@ module Squeel
         private
 
         def get_table(object)
-          if [Symbol, Nodes::Stub].include?(object.class)
+          if [Symbol, String, Nodes::Stub].include?(object.class)
             Arel::Table.new(object.to_sym, :engine => @engine)
           elsif Nodes::Join === object
             object._klass ? object._klass.arel_table : Arel::Table.new(object._name, :engine => @engine)

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

@@ -49,7 +49,7 @@ module Squeel
         private
 
         def get_table(object)
-          if [Symbol, Nodes::Stub].include?(object.class)
+          if [Symbol, String, Nodes::Stub].include?(object.class)
             Arel::Table.new(object.to_sym, :engine => @engine)
           elsif Nodes::Join === object
             object._klass ? object._klass.arel_table : Arel::Table.new(object._name, :engine => @engine)

data/lib/squeel/version.rb

@@ -1,3 +1,3 @@
 module Squeel
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/lib/squeel/visitors/attribute_visitor.rb

@@ -24,47 +24,6 @@ module Squeel
         end.flatten
       end
 
-      # @return [Boolean] Whether the given value implies a context change
-      # @param v The value to consider
-      def implies_context_change?(v)
-        can_accept?(v)
-      end
-
-      # Change context (by setting the new parent to the result of a #find or
-      # #traverse on the key), then accept the given value.
-      #
-      # @param k The hash key
-      # @param v The hash value
-      # @param parent The current parent object in the context
-      # @return The visited value
-      def visit_with_context_change(k, v, parent)
-        parent = case k
-          when Nodes::KeyPath
-            traverse(k, parent, true)
-          else
-            find(k, parent)
-          end
-
-        if Array === v
-          v.map {|val| accept(val, parent || k)}
-        else
-          can_accept?(v) ? accept(v, parent || k) : v
-        end
-      end
-
-      # If there is no context change, we'll just return the value unchanged,
-      # currently. Is this really the right behavior? I don't think so, but
-      # it works in this case.
-      #
-      # @param k The hash key
-      # @param v The hash value
-      # @param parent The current parent object in the context
-      # @return The same value we just received. Yeah, this method's pretty pointless,
-      #   for now, and only here for consistency's sake.
-      def visit_without_context_change(k, v, parent)
-        v
-      end
-
       # Visit elements of an array that it's possible to visit -- leave other
       # elements untouched.
       #
@@ -177,6 +136,47 @@ module Squeel
         o.alias ? op.as(o.alias) : op
       end
 
+      # @return [Boolean] Whether the given value implies a context change
+      # @param v The value to consider
+      def implies_context_change?(v)
+        can_accept?(v)
+      end
+
+      # Change context (by setting the new parent to the result of a #find or
+      # #traverse on the key), then accept the given value.
+      #
+      # @param k The hash key
+      # @param v The hash value
+      # @param parent The current parent object in the context
+      # @return The visited value
+      def visit_with_context_change(k, v, parent)
+        parent = case k
+          when Nodes::KeyPath
+            traverse(k, parent, true)
+          else
+            find(k, parent)
+          end
+
+        if Array === v
+          v.map {|val| accept(val, parent || k)}
+        else
+          can_accept?(v) ? accept(v, parent || k) : v
+        end
+      end
+
+      # If there is no context change, we'll just return the value unchanged,
+      # currently. Is this really the right behavior? I don't think so, but
+      # it works in this case.
+      #
+      # @param k The hash key
+      # @param v The hash value
+      # @param parent The current parent object in the context
+      # @return The same value we just received. Yeah, this method's pretty pointless,
+      #   for now, and only here for consistency's sake.
+      def visit_without_context_change(k, v, parent)
+        v
+      end
+
     end
   end
 end

data/lib/squeel/visitors/predicate_visitor.rb

@@ -6,6 +6,12 @@ module Squeel
 
       private
 
+      # Visit a Hash. This entails iterating through each key and value and
+      # visiting each value in turn.
+      #
+      # @param [Hash] o The Hash to visit
+      # @param parent The current parent object in the context
+      # @return [Array] An array of values for use in a where or having clause
       def visit_Hash(o, parent)
         predicates = o.map do |k, v|
           if implies_context_change?(v)
@@ -24,24 +30,53 @@ module Squeel
         end
       end
 
+      # Visit an array, which involves accepting any values we know how to
+      # accept, and skipping the rest.
+      #
+      # @param [Array] o The Array to visit
+      # @param parent The current parent object in the context
+      # @return [Array] The visited array
       def visit_Array(o, parent)
         o.map { |v| can_accept?(v) ? accept(v, parent) : v }.flatten
       end
 
+      # Visit ActiveRecord::Base objects. These should be converted to their
+      # id before being used in a comparison.
+      #
+      # @param [ActiveRecord::Base] o The AR::Base object to visit
+      # @param parent The current parent object in the context
+      # @return [Fixnum] The id of the object
       def visit_ActiveRecord_Base(o, parent)
         o.id
       end
 
+      # Visit a KeyPath by traversing the path and then visiting the endpoint.
+      #
+      # @param [Nodes::KeyPath] o The KeyPath to visit
+      # @param parent The parent object in the context
+      # @return The visited endpoint, in the context of the KeyPath's path
       def visit_Squeel_Nodes_KeyPath(o, parent)
         parent = traverse(o, parent)
 
         accept(o.endpoint, parent)
       end
 
+      # Visit a Stub by converting it to an ARel attribute
+      #
+      # @param [Nodes::Stub] o The Stub to visit
+      # @param parent The parent object in the context
+      # @return [Arel::Attribute] An attribute of the parent table with the
+      #   Stub's column
       def visit_Squeel_Nodes_Stub(o, parent)
         contextualize(parent)[o.symbol]
       end
 
+      # 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
+      #   (Arel::Nodes::Equality, Arel::Nodes::Matches, etc)
       def visit_Squeel_Nodes_Predicate(o, parent)
         value = o.value
         if Nodes::KeyPath === value
@@ -60,6 +95,12 @@ module Squeel
         end
       end
 
+      # 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
+      # @return [Arel::Nodes::NamedFunction] A named function node. Function
+      #   arguments are visited, if necessary, before being passed to the NamedFunction.
       def visit_Squeel_Nodes_Function(o, parent)
         args = o.args.map do |arg|
           case arg
@@ -76,10 +117,22 @@ module Squeel
         Arel::Nodes::NamedFunction.new(o.name, args, o.alias)
       end
 
+      # Visit an ActiveRecord 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
+      #   the relation's query
       def visit_ActiveRecord_Relation(o, parent)
         o.arel
       end
 
+      # Visit a Squeel operation node, convering it to an ARel InfixOperation
+      # (or subclass, as appropriate)
+      #
+      # @param [Nodes::Operation] o The Operation node to visit
+      # @param parent The parent object in the context
+      # @return [Arel::Nodes::InfixOperation] The InfixOperation (or Addition,
+      #   Multiplication, etc) node, with both operands visited, if needed.
       def visit_Squeel_Nodes_Operation(o, parent)
         args = o.args.map do |arg|
           case arg
@@ -109,10 +162,23 @@ module Squeel
         o.alias ? op.as(o.alias) : op
       end
 
+      # Visit a Squeel And node, returning an ARel Grouping containing an
+      # ARel And node.
+      #
+      # @param [Nodes::And] The And node to visit
+      # @param parent The parent object in the context
+      # @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(accept(o.children, parent)))
       end
 
+      # Visit a Squeel Or node, returning an ARel Or node.
+      #
+      # @param [Nodes::Or] The Or node to visit
+      # @param parent The parent object in the context
+      # @return [Arel::Nodes::Or] An ARel Or node, with left and ride sides visited
       def visit_Squeel_Nodes_Or(o, parent)
         accept(o.left, parent).or(accept(o.right, parent))
       end
@@ -121,6 +187,8 @@ module Squeel
         accept(o.expr, parent).not
       end
 
+      # @return [Boolean] Whether the given value implies a context change
+      # @param v The value to consider
       def implies_context_change?(v)
         case v
         when Hash, Nodes::Predicate, Nodes::Unary, Nodes::Binary, Nodes::Nary
@@ -132,6 +200,13 @@ module Squeel
         end
       end
 
+      # Change context (by setting the new parent to the result of a #find or
+      # #traverse on the key), then accept the given value.
+      #
+      # @param k The hash key
+      # @param v The hash value
+      # @param parent The current parent object in the context
+      # @return The visited value
       def visit_with_context_change(k, v, parent)
         parent = case k
           when Nodes::KeyPath
@@ -154,6 +229,14 @@ module Squeel
         end
       end
 
+      # Create a predicate for a given key/value pair. If the value is
+      # a Symbol, Stub, or KeyPath, it's converted to a table.column for
+      # the predicate value.
+      #
+      # @param k The hash key
+      # @param v The hash value
+      # @param parent The current parent object in the context
+      # @return An ARel predicate
       def visit_without_context_change(k, v, parent)
         case v
         when Nodes::Stub, Symbol
@@ -175,6 +258,13 @@ module Squeel
         end
       end
 
+      # 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
+      #   predicate will be created for
+      # @param value The value to be compared against
+      # @return [Arel::Nodes::Node] An ARel predicate node
       def arel_predicate_for(attribute, value, parent)
         value = can_accept?(value) ? accept(value, parent) : value
         if [Array, Range, Arel::SelectManager].include?(value.class)
@@ -184,6 +274,14 @@ module Squeel
         end
       end
 
+      # Function 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
+      # last visited column was of an integer type.
+      #
+      # @param node The node we (might) be quoting for
+      # @param v The value to (possibly) quote
       def quote_for_node(node, v)
         case node
         when Nodes::Function

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

@@ -37,6 +37,7 @@ module Squeel
           table.name.should eq 'notes'
           table.table_alias.should be_nil
         end
+
       end
     end
   end

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

@@ -589,6 +589,12 @@ module Squeel
             sql.should match /"articles"."title" = 'Hello world!'/
           end
 
+          it 'does not break hm:t with conditions' do
+            relation = Person.first.condition_article_comments
+            sql = relation.to_sql
+            sql.should match /"articles"."title" = 'Condition'/
+          end
+
         end
 
         describe '#to_a' do

data/spec/support/schema.rb

@@ -9,7 +9,9 @@ class Person < ActiveRecord::Base
   belongs_to :parent, :class_name => 'Person', :foreign_key => :parent_id
   has_many   :children, :class_name => 'Person', :foreign_key => :parent_id
   has_many   :articles
+  has_many   :articles_with_condition, :class_name => 'Article', :conditions => {:title => 'Condition'}
   has_many   :comments
+  has_many   :condition_article_comments, :through => :articles_with_condition, :source => :comments
   has_many   :authored_article_comments, :through => :articles,
              :source => :comments
   has_many   :notes, :as => :notable

metadata

@@ -2,7 +2,7 @@
 name: squeel
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors: 
 - Ernie Miller
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-13 00:00:00 Z
+date: 2011-05-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord