squeel 1.0.1 → 1.0.2

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# v1.0.2
+## 2012-05-30
+
+* Add groupings to DSL. Allows control of matched sets of
+  parentheses in the absence of not/and/etc. Accessed via
+  `_()`.
+* Allow As nodes in predicates. This allows casting inside
+  a where/having clause with PostgreSQL: `cast(value.as type)`
+* Work around issue with Relation#count when where_values
+  contains InfixOperations. Fixes #122.
+
+# v1.0.1
+## 2012-05-02
+
+* Undefine `type` method on Stubs/KeyPaths for 1.8.x compat.
+
+# v1.0.0
+## 2012-04-22
+
+* Official 1.0.0 release.

data/README.md

@@ -1,4 +1,4 @@
-# Squeel [![Build Status](https://secure.travis-ci.org/ernie/squeel.png)](http://travis-ci.org/ernie/squeel)
+# Squeel [![Build Status](https://secure.travis-ci.org/ernie/squeel.png)](http://travis-ci.org/ernie/squeel) [![endorse](http://api.coderwall.com/ernie/endorsecount.png)](http://coderwall.com/ernie)
 
 Squeel lets you write your ActiveRecord queries with fewer strings, and more Ruby,
 by making the ARel awesomeness that lies beneath ActiveRecord more accessible.

data/lib/squeel.rb

@@ -22,7 +22,6 @@ module Squeel
 
 end
 
-require 'squeel/nodes'
 require 'squeel/dsl'
 require 'squeel/visitors'
-require 'squeel/adapters/active_record'
+require 'squeel/adapters/active_record'

data/lib/squeel/adapters/active_record.rb

@@ -16,6 +16,7 @@ when 3
     ActiveRecord::Associations::ClassMethods::JoinDependency.send :include, Squeel::Adapters::ActiveRecord::JoinDependencyExtensions
     ActiveRecord::Base.extend Squeel::Adapters::ActiveRecord::AssociationPreloadExtensions
   when 1
+    require 'squeel/adapters/active_record/3.1/compat'
     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'
@@ -24,6 +25,7 @@ when 3
     ActiveRecord::Associations::JoinDependency.send :include, Squeel::Adapters::ActiveRecord::JoinDependencyExtensions
     ActiveRecord::Associations::Preloader.send :include, Squeel::Adapters::ActiveRecord::PreloaderExtensions
   else
+    require 'squeel/adapters/active_record/compat'
     require 'squeel/adapters/active_record/relation_extensions'
     require 'squeel/adapters/active_record/preloader_extensions'
     require 'squeel/adapters/active_record/context'
@@ -34,4 +36,4 @@ when 3
   end
 else
   raise NotImplementedError, "Squeel does not support ActiveRecord version #{ActiveRecord::VERSION::STRING}"
-end
+end

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

@@ -95,6 +95,10 @@ module Arel
         super(:-, left, right)
       end
     end
+
+    class Grouping < Unary
+      include Arel::Predications
+    end unless Grouping.include?(Arel::Predications)
   end
 
   module Visitors
@@ -157,4 +161,4 @@ module Arel
     end
   end
 
-end
+end

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

@@ -38,7 +38,7 @@ module Squeel
 
         def traverse(keypath, parent = @base, include_endpoint = false)
           parent = @base if keypath.absolute?
-          keypath.path.each do |key|
+          keypath.path_without_endpoint.each do |key|
             parent = find(key, parent) || key
           end
           parent = find(keypath.endpoint, parent) if include_endpoint
@@ -73,4 +73,4 @@ module Squeel
       end
     end
   end
-end
+end

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

@@ -0,0 +1,22 @@
+module Arel
+
+  module Nodes
+
+    class Grouping < Unary
+      include Arel::Predications
+    end unless Grouping.include?(Arel::Predications)
+
+  end
+
+  module Visitors
+
+    class DepthFirst < Visitor
+
+      unless method_defined?(:visit_Arel_Nodes_InfixOperation)
+        alias :visit_Arel_Nodes_InfixOperation :binary
+      end
+
+    end
+
+  end
+end

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

@@ -38,7 +38,7 @@ module Squeel
 
         def traverse(keypath, parent = @base, include_endpoint = false)
           parent = @base if keypath.absolute?
-          keypath.path.each do |key|
+          keypath.path_without_endpoint.each do |key|
             parent = find(key, parent) || key
           end
           parent = find(keypath.endpoint, parent) if include_endpoint
@@ -73,4 +73,4 @@ module Squeel
       end
     end
   end
-end
+end

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

@@ -0,0 +1,22 @@
+module Arel
+
+  module Nodes
+
+    class Grouping < Unary
+      include Arel::Predications
+    end unless Grouping.include?(Arel::Predications)
+
+  end
+
+  module Visitors
+
+    class DepthFirst < Visitor
+
+      unless method_defined?(:visit_Arel_Nodes_InfixOperation)
+        alias :visit_Arel_Nodes_InfixOperation :binary
+      end
+
+    end
+
+  end
+end

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

@@ -21,7 +21,7 @@ module Squeel
 
           if Nodes::KeyPath === associations
             parent ||= _join_parts.last
-            associations.path_with_endpoint.each do |key|
+            associations.path.each do |key|
               parent = build(key, parent, join_type)
             end
             parent
@@ -33,4 +33,4 @@ module Squeel
       end
     end
   end
-end
+end

data/lib/squeel/configuration.rb

@@ -1,5 +1,5 @@
 require 'squeel/constants'
-require 'squeel/predicate_methods'
+require 'squeel/nodes'
 
 module Squeel
   # The Squeel configuration module. The Squeel module extends this to provide its
@@ -46,7 +46,7 @@ module Squeel
     def alias_predicate(new_name, existing_name)
       raise ArgumentError, 'the existing name should be the base name, not an _any/_all variation' if existing_name.to_s =~ /(_any|_all)$/
       ['', '_any', '_all'].each do |suffix|
-        PredicateMethods.class_eval "alias :#{new_name}#{suffix} :#{existing_name}#{suffix} unless defined?(#{new_name}#{suffix})"
+        Nodes::PredicateMethods.class_eval "alias :#{new_name}#{suffix} :#{existing_name}#{suffix} unless defined?(#{new_name}#{suffix})"
       end
     end
 

data/lib/squeel/core_ext/symbol.rb

@@ -1,6 +1,3 @@
-require 'squeel/predicate_methods'
-require 'squeel/nodes/aliasing'
-
 # These extensions to Symbol are loaded optionally, mostly to provide
 # a small amount of backwards compatibility with MetaWhere.
 #
@@ -9,16 +6,9 @@ require 'squeel/nodes/aliasing'
 #     config.load_core_extensions :symbol
 #   end
 class Symbol
-  include Squeel::PredicateMethods
+  include Squeel::Nodes::PredicateMethods
   include Squeel::Nodes::Aliasing
-
-  def asc
-    Squeel::Nodes::Order.new self, 1
-  end
-
-  def desc
-    Squeel::Nodes::Order.new self, -1
-  end
+  include Squeel::Nodes::Ordering
 
   def func(*args)
     Squeel::Nodes::Function.new(self, args)
@@ -36,4 +26,4 @@ class Symbol
     Squeel::Nodes::Join.new(self, Arel::InnerJoin, klass)
   end
 
-end
+end

data/lib/squeel/dsl.rb

@@ -71,6 +71,15 @@ module Squeel
       Nodes::Literal.new(string)
     end
 
+    # Create a Squeel Grouping node. This allows you to set balanced
+    # pairs of parentheses around your SQL.
+    #
+    # @param expr The expression to group
+    # @return [Nodes::Grouping] The grouping node
+    def _(expr)
+      Nodes::Grouping.new(expr)
+    end
+
     # Create a Squeel Sifter node. This essentially substitutes the
     # sifter block of the supplied name from the model.
     #
@@ -109,4 +118,4 @@ module Squeel
     end
 
   end
-end
+end

data/lib/squeel/nodes.rb

@@ -4,6 +4,13 @@ module Squeel
   module Nodes
   end
 end
+
+require 'squeel/nodes/predicate_methods'
+require 'squeel/nodes/operators'
+require 'squeel/nodes/predicate_operators'
+require 'squeel/nodes/aliasing'
+require 'squeel/nodes/ordering'
+
 require 'squeel/nodes/literal'
 require 'squeel/nodes/stub'
 require 'squeel/nodes/key_path'
@@ -16,4 +23,5 @@ require 'squeel/nodes/and'
 require 'squeel/nodes/or'
 require 'squeel/nodes/as'
 require 'squeel/nodes/not'
-require 'squeel/nodes/join'
+require 'squeel/nodes/join'
+require 'squeel/nodes/grouping'

data/lib/squeel/nodes/aliasing.rb

@@ -5,9 +5,9 @@ module Squeel
     module Aliasing
 
       def as(name)
-        As.new(self, Arel.sql(name))
+        As.new(self, Arel.sql(name.to_s))
       end
 
     end
   end
-end
+end

data/lib/squeel/nodes/as.rb

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

data/lib/squeel/nodes/binary.rb

@@ -1,5 +1,3 @@
-require 'squeel/nodes/predicate_operators'
-
 module Squeel
   module Nodes
     # A node that represents an operation with two operands.
@@ -25,8 +23,7 @@ module Squeel
         self.left.eql?(other.left) &&
         self.right.eql?(other.right)
       end
-      alias :== :eql?
 
     end
   end
-end
+end

data/lib/squeel/nodes/function.rb

@@ -1,5 +1,3 @@
-require 'squeel/predicate_methods'
-
 module Squeel
   module Nodes
     # A node that represents an SQL function call
@@ -8,6 +6,7 @@ module Squeel
       include PredicateMethods
       include PredicateOperators
       include Operators
+      include Ordering
 
       alias :== :eq
       alias :'^' :not_eq
@@ -46,14 +45,6 @@ module Squeel
         self
       end
 
-      def asc
-        Order.new self, 1
-      end
-
-      def desc
-        Order.new self, -1
-      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/grouping.rb

@@ -0,0 +1,35 @@
+module Squeel
+  module Nodes
+    # A node that represents an SQL function call
+    class Grouping < Unary
+
+      include PredicateMethods
+      include PredicateOperators
+      include Operators
+      include Aliasing
+      include Ordering
+
+      alias :== :eq
+      alias :'^' :not_eq
+      alias :'!=' :not_eq if respond_to?(:'!=')
+      alias :>> :in
+      alias :<< :not_in
+      alias :=~ :matches
+      alias :'!~' :does_not_match if respond_to?(:'!~')
+      alias :> :gt
+      alias :>= :gteq
+      alias :< :lt
+      alias :<= :lteq
+
+      # 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.
+      # @return [NilClass] Just to avoid bombing out on expand_hash_conditions_for_aggregates
+      def to_sym
+        nil
+      end
+
+    end
+  end
+end
+

data/lib/squeel/nodes/join.rb

@@ -61,9 +61,9 @@ module Squeel
       def method_missing(method_id, *args)
         super if method_id == :to_ary
         if (args.size == 1) && (Class === args[0])
-          KeyPath.new(self, Join.new(method_id, Arel::InnerJoin, args[0]))
+          KeyPath.new([self, Join.new(method_id, Arel::InnerJoin, args[0])])
         else
-          KeyPath.new(self, method_id)
+          KeyPath.new([self, method_id])
         end
       end
 
@@ -72,7 +72,7 @@ module Squeel
       # DSL is likely to think of them as such.
       # @return [KeyPath] An absolute KeyPath, containing only this Join
       def ~
-        KeyPath.new [], self, true
+        KeyPath.new [self], true
       end
 
       # expand_hash_conditions_for_aggregates assumes our hash keys can be

data/lib/squeel/nodes/key_path.rb

@@ -1,5 +1,3 @@
-require 'squeel/nodes/operators'
-require 'squeel/nodes/predicate_operators'
 require 'active_support/core_ext/module'
 
 module Squeel
@@ -20,18 +18,13 @@ module Squeel
       # @return [Array<Symbol, Stub, Join>] The path
       attr_reader :path
 
-      # @return The endpoint, either another key as in the path, or a predicate, function, etc.
-      attr_reader :endpoint
-
       # Create a new KeyPath.
       # @param [Array, Object] path The intial path. Will be converted to an array if it isn't already.
-      # @param endpoint the endpoint of the KeyPath
       # @param [Boolean] absolute If the KeyPath should start from the base
       #   or remain relative to whatever location it's found.
-      def initialize(path, endpoint, absolute = false)
-        @path, @endpoint = path, endpoint
-        @path = [@path] unless Array === @path
-        @endpoint = Stub.new(@endpoint) if Symbol === @endpoint
+      def initialize(path, absolute = false)
+        @path = Array(path)
+        self.endpoint = Stub.new(endpoint) if Symbol === endpoint
         @absolute = absolute
       end
 
@@ -42,11 +35,22 @@ module Squeel
         @absolute
       end
 
+      # @return The endpoint, either another key as in the path, or a predicate, function, etc.
+      def endpoint
+        @path[-1]
+      end
+
+      # Set the new value of the KeyPath's endpoint.
+      # @param [Object] val The new endpoint.
+      # @return The value just set.
+      def endpoint=(val)
+        @path[-1] = val
+      end
+
       # Object comparison
       def eql?(other)
         self.class.eql?(other.class) &&
         self.path.eql?(other.path) &&
-        self.endpoint.eql?(other.endpoint) &&
         self.absolute?.eql?(other.absolute?)
       end
 
@@ -120,8 +124,7 @@ module Squeel
       # @return [KeyPath] This keypath, with a sifter as its endpoint
       def sift(name, *args)
         if Stub === endpoint || Join === endpoint
-          @path << endpoint
-          @endpoint = Sifter.new(name, args)
+          @path << Sifter.new(name, args)
           self
         else
           no_method_error :sift
@@ -137,7 +140,7 @@ module Squeel
 
       # For use with equality tests
       def hash
-        [self.class, endpoint, *path].hash
+        [self.class, *path].hash
       end
 
       # expand_hash_conditions_for_aggregates assumes our hash keys can be
@@ -162,14 +165,14 @@ module Squeel
         end
       end
 
-      # @return [Array] The KeyPath's path, including its endpoint, as a single array.
-      def path_with_endpoint
-        path + [endpoint]
+      # @return [Array] The KeyPath's path, minus its endpoint, as a single array.
+      def path_without_endpoint
+        path[0..-2]
       end
 
-      # Implement (and alias to :to_str) to play nicely with ActiveRecord grouped calculations
+      # Implement #to_s (and alias to #to_str) to play nicely with ActiveRecord grouped calculations
       def to_s
-        path.map(&:to_s).join('.') << ".#{endpoint}"
+        path.map(&:to_s).join('.')
       end
       alias :to_str :to_s
 
@@ -179,16 +182,15 @@ module Squeel
         super if method_id == :to_ary
 
         if endpoint.respond_to? method_id
-          @endpoint = @endpoint.send(method_id, *args)
+          self.endpoint = endpoint.send(method_id, *args)
           self
         elsif Stub === endpoint || Join === endpoint
-          @path << endpoint
           if args.empty?
-            @endpoint = Stub.new(method_id)
+            @path << Stub.new(method_id)
           elsif (args.size == 1) && (Class === args[0])
-            @endpoint = Join.new(method_id, Arel::InnerJoin, args[0])
+            @path << Join.new(method_id, Arel::InnerJoin, args[0])
           else
-            @endpoint = Nodes::Function.new method_id, args
+            @path << Nodes::Function.new(method_id, args)
           end
           self
         else