aub-record_filter 0.9.0 → 0.9.1

data/README.rdoc

@@ -1,6 +1,6 @@
 = record_filter
 
-record_filter is a DSL for specifying criteria for ActiveRecord queries in pure Ruby.
+record_filter is a DSL for specifying ActiveRecord queries in pure Ruby.
 It has support for filters created on the fly and for named filters that are associated with object types.
 record_filter has the following top-level features:
 
@@ -10,9 +10,14 @@ record_filter has the following top-level features:
 * Allows chaining of filters with each other and with named scopes to create complex queries.
 * Takes advantage of the associations in your ActiveRecord objects for a clean implicit join API.
 
+== Documentation
+
+The complete RDoc documentation is available at http://aub.github.com/record_filter/rdoc/. This page is
+intended to be a getting started guide that should cover the most common uses.
+
 == Installation
 
-  gem install outoftime-record_filter --source=http://gems.github.com
+  gem install aub-record_filter --source=http://gems.github.com
 
 == Using Filters
 
@@ -31,7 +36,7 @@ This could be expressed in ActiveRecord as:
     :joins => :posts, 
     :conditions => ['posts.permalink IS NULL AND blogs.created_at > ?', 'blog-post', 1.day.ago)
 
-and it returns the same result, a list of Blog objects that are returned from the query. This
+and it returns the same result, a list of Blog objects that are the result of the query. This
 type of filter is designed to be created on the fly, but if you have a filter that you would like
 to use in more than one place, it can be added to a class as a named filter. The following example
 creates the same filter as above and executes it:
@@ -51,7 +56,7 @@ complex query:
 
   class Post < ActiveRecord::Base
     named_filter(:title_is_monkeys) { with(:title, 'monkeys') }
-    named_filter(:permalink_is_donkeys) { with(:title, 'donkeys') }
+    named_filter(:permalink_is_donkeys) { with(:permalink, 'donkeys') }
   end
 
   Post.title_is_monkeys.permalink_is_donkeys
@@ -89,7 +94,7 @@ model even if called from a join.
 
 == Specifying Filters
 
-record_filter supports all of SQL query abstractions provided by ActiveRecord, specifically:
+record_filter supports all of the SQL query abstractions provided by ActiveRecord, specifically:
 
 * Conditions
 * Boolean operations
@@ -141,7 +146,7 @@ The following condition types are supported through the Restriction API:
 
 Conditions can be combined with boolean operators using the methods all_of, any_of, none_of
 and not_all_of. These methods take a block where any conditions they contain will be combined
-using AND, OR and NOT to create the correct condition. The block can also contain any number of
+using AND, OR and NOT to create the correct clause. The block can also contain any number of
 joins or other boolean operations. The default operator is all_of.
 
   Post.filter do
@@ -198,6 +203,7 @@ added. Explicit joins also allow conditions to be set on columns of the table be
   join(Comment, :inner) do
     on(:id => :commentable_id)
     on(:commentable_type).equal_to('Post')
+    with(:created_at).less_than(1.year.ago)
   end
 
 With implicit joins, it is also possible to use a hash as the association name, in which case
@@ -249,7 +255,7 @@ order in which they were given.
 
 (The MIT License)
 
-Copyright (c) 2008 Mat Brown, Aubrey Holland
+Copyright (c) 2008 Aubrey Holland, Mat Brown
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -13,10 +13,10 @@ begin
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = 'record_filter'
     gemspec.summary = 'Pure-ruby criteria API for building complex queries in ActiveRecord'
-    gemspec.email = 'mat@patch.com'
-    gemspec.homepage = 'http://github.com/outoftime/record_filter/tree/master'
+    gemspec.email = 'aubreyholland@gmail.com'
+    gemspec.homepage = 'http://github.com/aub/record_filter/tree/master'
     gemspec.description = 'Pure-ruby criteria API for building complex queries in ActiveRecord'
-    gemspec.authors = ['Mat Brown', 'Aubrey Holland']
+    gemspec.authors = ['Aubrey Holland', 'Mat Brown']
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 9
-:patch: 0
+:patch: 1

data/lib/record_filter/dsl/dsl.rb

@@ -94,13 +94,15 @@ module RecordFilter
       # column<Symbol, Hash>::
       #   If a symbol is specified, it is taken to represent the name of a column on the
       #   class being filtered. If a hash is given, it should represent a path through the
-      #   joins to a column in one of the joined tables.
+      #   joins to a column in one of the joined tables. If a string is given, it is used
+      #   without modification as the grouping parameter.
       #
       # ==== Returns
       # nil
       #
       # ==== Alternatives
-      # As described above, it is possible to pass either a symbol or a hash as the argument.
+      # As described above, it is possible to pass either a symbol, a hash, or a string 
+      # as the argument.
       #
       # @public
       def group_by(column)

data/lib/record_filter/group_by.rb

@@ -13,11 +13,11 @@ module RecordFilter
         column = column.values[0]
       end
 
-      if (!table.has_column(column))
-        raise ColumnNotFoundException.new("The column #{column} was not found in #{table.table_name}.")
+      if (table.has_column(column))
+        "#{table.table_alias}.#{column}"
+      else
+        column
       end
-
-      "#{table.table_alias}.#{column}"
     end
   end
 end

data/spec/exception_spec.rb

@@ -42,12 +42,12 @@ describe 'raising exceptions' do
       }.should raise_error(RecordFilter::ColumnNotFoundException)
     end
 
-    it 'should get ColumnNotFoundException for group_by' do
+    it 'should not get ColumnNotFoundException for group_by' do
       lambda {
         Post.filter do
           group_by(:this_is_not_there)
         end.inspect
-      }.should raise_error(RecordFilter::ColumnNotFoundException)
+      }.should_not raise_error(RecordFilter::ColumnNotFoundException)
     end
 
     it 'should get AssociationNotFoundException for orders on bad associations' do

data/spec/limits_and_ordering_spec.rb

@@ -145,5 +145,12 @@ describe 'filter qualifiers' do
       end.inspect
       Post.last_find[:group].should == %q("posts".created_at, posts__photo.format)
     end
+
+    it 'should accept random strings as the column name' do
+      Post.filter do
+        group_by("abcdef")
+      end.find(:all, :select => 'posts.id as abcdef').inspect
+      Post.last_find[:group].should == 'abcdef'
+    end
   end
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: aub-record_filter
 version: !ruby/object:Gem::Version 
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors: 
-- Mat Brown
 - Aubrey Holland
+- Mat Brown
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -15,7 +15,7 @@ default_executable:
 dependencies: []
 
 description: Pure-ruby criteria API for building complex queries in ActiveRecord
-email: mat@patch.com
+email: aubreyholland@gmail.com
 executables: []
 
 extensions: []
@@ -65,7 +65,7 @@ files:
 - test/performance_test.rb
 - test/test.db
 has_rdoc: true
-homepage: http://github.com/outoftime/record_filter/tree/master
+homepage: http://github.com/aub/record_filter/tree/master
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8