squeel 0.5.5 → 0.6.0

data/spec/squeel/visitors/predicate_visitor_spec.rb

@@ -30,6 +30,34 @@ module Squeel
         predicate.right.should eq ['Joe', 'Bob']
       end
 
+      it 'allows a subquery on the value side of an explicit predicate' do
+        predicate = @v.accept dsl{name.in(Person.select{name}.where{name.in(['Aric Smith', 'Gladyce Kulas'])})}
+        predicate.should be_a Arel::Nodes::In
+        predicate.left.name.should eq :name
+        predicate.right.should be_a Arel::Nodes::SelectStatement
+      end
+
+      it 'allows a subquery on the value side of an implicit predicate' do
+        predicate = @v.accept(:name => Person.select{name}.where{name.in(['Aric Smith', 'Gladyce Kulas'])})
+        predicate.should be_a Arel::Nodes::In
+        predicate.left.name.should eq :name
+        predicate.right.should be_a Arel::Nodes::SelectStatement
+      end
+
+      it 'converts ActiveRecord::Base objects to their id' do
+        predicate = @v.accept(:id => Person.first)
+        predicate.should be_a Arel::Nodes::Equality
+        predicate.left.name.should eq :id
+        predicate.right.should eq 1
+      end
+
+      it 'converts arrays of ActiveRecord::Base objects to their ids' do
+        predicate = @v.accept(:id => [Person.first, Person.last])
+        predicate.should be_a Arel::Nodes::In
+        predicate.left.name.should eq :id
+        predicate.right.should eq [1, 332]
+      end
+
       it 'creates the node against the proper table for nested hashes' do
         predicate = @v.accept({
           :children => {
@@ -75,6 +103,12 @@ module Squeel
         keypath.to_sql.should eq standard.to_sql
       end
 
+      it 'honors absolute keypaths with only an endpoint' do
+        standard = @v.accept({:name => 'Joe'})
+        keypath = @v.accept(dsl{{children => {children => {~name => 'Joe'}}}})
+        keypath.to_sql.should eq standard.to_sql
+      end
+
       it 'allows incomplete predicates (missing value) as keys' do
         standard = @v.accept({
           :children => {
@@ -156,15 +190,6 @@ module Squeel
         predicate.right.should eq 'Joe%'
       end
 
-      it 'treats hash keys as an association when there is an array of "acceptables" on the value side' do
-        predicate = @v.accept(:children => [:name.matches % 'Joe%', :name.eq % 'Bob'])
-        predicate.should be_a Arel::Nodes::Grouping
-        predicate.expr.should be_a Arel::Nodes::And
-        predicate.expr.children.should have(2).items
-        predicate.expr.children.first.should be_a Arel::Nodes::Matches
-        predicate.expr.children.first.left.relation.table_alias.should eq 'children_people'
-      end
-
       it 'treats hash keys as an association when there is an Or on the value side' do
         predicate = @v.accept(:children => (:name.matches % 'Joe%' | :name.matches % 'Bob%'))
         predicate.should be_a Arel::Nodes::Grouping

data/squeel.gemspec

@@ -9,20 +9,17 @@ Gem::Specification.new do |s|
   s.authors     = ["Ernie Miller"]
   s.email       = ["ernie@metautonomo.us"]
   s.homepage    = "http://metautonomo.us/projects/squeel"
-  s.summary     = %q{ActiveRecord 3 query syntax on steroids.}
+  s.summary     = %q{ActiveRecord 3, improved.}
   s.description = %q{
-      Squeel offers the ability to call any Arel predicate methods
-      (with a few convenient aliases) on your model's attributes instead
-      of the ones normally offered by ActiveRecord's hash parameters. It also
-      adds convenient syntax for order clauses, smarter mapping of nested hash
-      conditions, and a debug_sql method to see the real SQL your code is
-      generating without running it against the database. If you like the new
-      AR 3.0 query interface, you'll love it with Squeel.
+      Squeel unlocks the power of ARel in your Rails 3 application with
+      a handy block-based syntax. You can write subqueries, access named
+      functions provided by your RDBMS, and more, all without writing
+      SQL strings.
     }
   s.post_install_message = %q{
 *** Thanks for installing Squeel! ***
 Be sure to check out http://metautonomo.us/projects/squeel/ for a
-walkthrough of Squeel's features, and click the donate button if
+walkthrough of Squeel's features, and click the donate link if
 you're feeling especially appreciative. It'd help me justify this
 "open source" stuff to my lovely wife. :)
 

metadata

@@ -2,7 +2,7 @@
 name: squeel
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors: 
 - Ernie Miller
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-20 00:00:00 Z
+date: 2011-05-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -78,7 +78,7 @@ dependencies:
         version: 1.3.3
   type: :development
   version_requirements: *id006
-description: "\n      Squeel offers the ability to call any Arel predicate methods\n      (with a few convenient aliases) on your model's attributes instead\n      of the ones normally offered by ActiveRecord's hash parameters. It also\n      adds convenient syntax for order clauses, smarter mapping of nested hash\n      conditions, and a debug_sql method to see the real SQL your code is\n      generating without running it against the database. If you like the new\n      AR 3.0 query interface, you'll love it with Squeel.\n    "
+description: "\n      Squeel unlocks the power of ARel in your Rails 3 application with\n      a handy block-based syntax. You can write subqueries, access named\n      functions provided by your RDBMS, and more, all without writing\n      SQL strings.\n    "
 email: 
 - ernie@metautonomo.us
 executables: []
@@ -89,9 +89,10 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .yardopts
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/core_ext/hash.rb
 - lib/core_ext/symbol.rb
@@ -129,10 +130,6 @@ files:
 - lib/squeel/nodes/stub.rb
 - lib/squeel/nodes/unary.rb
 - lib/squeel/predicate_methods.rb
-- lib/squeel/predicate_methods/function.rb
-- lib/squeel/predicate_methods/predicate.rb
-- lib/squeel/predicate_methods/stub.rb
-- lib/squeel/predicate_methods/symbol.rb
 - lib/squeel/version.rb
 - lib/squeel/visitors.rb
 - lib/squeel/visitors/attribute_visitor.rb
@@ -173,7 +170,7 @@ licenses: []
 post_install_message: "\n\
   *** Thanks for installing Squeel! ***\n\
   Be sure to check out http://metautonomo.us/projects/squeel/ for a\n\
-  walkthrough of Squeel's features, and click the donate button if\n\
+  walkthrough of Squeel's features, and click the donate link if\n\
   you're feeling especially appreciative. It'd help me justify this\n\
   \"open source\" stuff to my lovely wife. :)\n\n"
 rdoc_options: []
@@ -198,7 +195,7 @@ rubyforge_project: squeel
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: ActiveRecord 3 query syntax on steroids.
+summary: ActiveRecord 3, improved.
 test_files: 
 - spec/blueprints/articles.rb
 - spec/blueprints/comments.rb
@@ -227,3 +224,4 @@ test_files:
 - spec/squeel/visitors/predicate_visitor_spec.rb
 - spec/squeel/visitors/symbol_visitor_spec.rb
 - spec/support/schema.rb
+has_rdoc: 

data/README.rdoc

@@ -1,117 +0,0 @@
-=Squeel
-
-Squeel is a (Rails 3.1-only for now) rewrite of MetaWhere. It's rapidly approaching
-a point where I could recommend it for daily use. Once it hits feature completion, I'll
-work on backporting to Rails 3.0.x. In the meantime, please feel free to clone this repo
-and give it a test drive using <tt>rake console</tt> and the models in the
-<tt>spec/support/schema.rb</tt> file.
-
-== Getting started
-
-In your Gemfile:
-
-  gem "squeel"  # Last officially released gem
-  # gem "squeel", :git => "git://github.com/ernie/squeel.git" # Track git repo
-
-In an intitializer:
-
-  Squeel.configure do |config|
-    # To load hash extensions (to allow for AND (&), OR (|), and NOT (-) against
-    # hashes of conditions)
-    config.load_core_extensions :hash
-
-    # To load symbol extensions (for a subset of the old MetaWhere functionality,
-    # via ARel predicate methods on Symbols: :name.matches, etc)
-    # config.load_core_extensions :symbol
-
-    # To load both hash and symbol extensions
-    # config.load_core_extensions :hash, :symbol
-  end
-
-== The Squeel Query DSL
-
-Squeel enhances the normal ActiveRecord query methods by enabling them to accept
-blocks. Inside a block, the Squeel query DSL can be used. Note the use of curly braces
-in these examples instead of parentheses. {} denotes a Squeel DSL query.
-
-=== Stubs
-
-Stubs are, for most intents and purposes, just like Symbols in a normal call to
-Relation#where (note the need for doubling up on the curly braces here, the first ones
-start the block, the second are the hash braces):
-
-  Person.where{{name => 'Ernie'}}
-  => SELECT "people".* FROM "people"  WHERE "people"."name" = 'Ernie'
-
-You normally wouldn't bother using the DSL in this case, as a simple hash would
-suffice. However, stubs serve as a building block for keypaths, and keypaths are
-very handy.
-
-=== KeyPaths
-
-A Squeel keypath is essentially a more concise and readable alternative to a
-deeply nested hash. For instance, in standard ActiveRecord, you might join several
-associations like this to perform a query:
-
-  Person.joins(:articles => {:comments => :person})
-  => SELECT "people".* FROM "people"
-       INNER JOIN "articles" ON "articles"."person_id" = "people"."id"
-       INNER JOIN "comments" ON "comments"."article_id" = "articles"."id"
-       INNER JOIN "people" "people_comments" ON "people_comments"."id" = "comments"."person_id"
-
-With a keypath, this would look like:
-
-  Person.joins{articles.comments.person}
-
-A keypath can exist in the context of a hash, and is normally interpreted relative to
-the current level of nesting. It can be forced into an "absolute" path by anchoring it with
-a ~, like:
-
-  ~articles.comments.person
-
-This isn't quite so useful in the typical hash context, but can be very useful when it comes
-to interpreting functions and the like. We'll cover those later.
-
-=== Joins
-
-As you saw above, keypaths can be used as shorthand for joins. Additionally, you can
-specify join types (or join classes, in the case of polymorphic belongs_to joins):
-
-  Person.joins{articles.outer}
-  => SELECT "people".* FROM "people"
-     LEFT OUTER JOIN "articles" ON "articles"."person_id" = "people"."id"
-  Note.joins{notable(Person).outer}
-  => SELECT "notes".* FROM "notes"
-     LEFT OUTER JOIN "people"
-       ON "people"."id" = "notes"."notable_id"
-       AND "notes"."notable_type" = 'Person'
-
-These can also be used inside keypaths:
-
-  Note.joins{notable(Person).articles}
-  => SELECT "notes".* FROM "notes"
-     INNER JOIN "people" ON "people"."id" = "notes"."notable_id"
-       AND "notes"."notable_type" = 'Person'
-     INNER JOIN "articles" ON "articles"."person_id" = "people"."id"
-
-=== Functions
-
-You can call SQL functions just like you would call a method in Ruby...
-
-  Person.select{coalesce(name, '<no name given>')}
-  => SELECT coalesce("people"."name", '<no name given>') FROM "people"
-
-...and you can easily give it an alias:
-
-  person = Person.select{
-    coalesce(name, '<no name given>').as(name_with_default)
-  }.first
-  person.name_with_default # name or <no name given>, depending on data
-
-=== Operators
-
-You can use the standard mathematical operators (+, -, *, /)inside the Squeel DSL to
-specify operators in the resulting SQL, or the <tt>op</tt> method to specify another
-custom operator, such as the standard SQL concatenation operator, ||:
-
-...more docs to come...

data/lib/squeel/predicate_methods/function.rb

@@ -1,9 +0,0 @@
-module Squeel
-  module PredicateMethods
-    module Function
-      def predicate(method_name, value = :__undefined__)
-        Nodes::Predicate.new self, method_name, value
-      end
-    end
-  end
-end

data/lib/squeel/predicate_methods/predicate.rb

@@ -1,11 +0,0 @@
-module Squeel
-  module PredicateMethods
-    module Predicate
-      def predicate(method_name, value = :__undefined__)
-        @method_name = method_name
-        @value = value unless value == :__undefined__
-        self
-      end
-    end
-  end
-end

data/lib/squeel/predicate_methods/stub.rb

@@ -1,9 +0,0 @@
-module Squeel
-  module PredicateMethods
-    module Stub
-      def predicate(method_name, value = :__undefined__)
-        Nodes::Predicate.new self.symbol, method_name, value
-      end
-    end
-  end
-end

data/lib/squeel/predicate_methods/symbol.rb

@@ -1,9 +0,0 @@
-module Squeel
-  module PredicateMethods
-    module Symbol
-      def predicate(method_name, value = :__undefined__)
-        Nodes::Predicate.new self, method_name, value
-      end
-    end
-  end
-end