better_ar 0.0.3 → 0.0.4

data/HISTORY.txt

@@ -1,2 +1,5 @@
+## 0.0.4
+  SQL operator keys must now end with '!'
+
 ## 0.0.3
   Supports legacy calls to .all, .first, .count if the :conditions key is present

data/README.markdown

@@ -1,10 +1,23 @@
 # BetterAr
 
-BetterAr adds replaces the .all, .first and .count methods for ActiveRecord.
+BetterAr replaces the .all, .first and .count methods for ActiveRecord.
+
+
+## Install
+
+Bundler:
+
+    gem 'better_ar'
+
+Command line:
+
+    gem install better_ar
+
+## Usage
 
 Now a single hash can be passed to ActiveRecord::Base.all that contains not only the where values but also other scopes like 'limit' and 'order'
 
-    User.all(:age => 10, :limit => 5, :offset => 10, :order => :name)
+    User.all(:age => 10, :limit! => 5, :offset! => 10, :order! => :name)
 
 is the same as
 
@@ -12,7 +25,15 @@ is the same as
 
 While this may seem less concise the advantage is being able to dynamically construct the query with a single hash in code.
 
-This library completely removes the old .all, .first and .count class methods on ActiveRecord::Base. As these methods were just delegated to the ActiveRecord::Base.scoped they can still be called.
+This library completely removes the old .all, .first and .count class methods from ActiveRecord::Base. As these methods were just delegated to ActiveRecord::Base.scoped they can still be called.
+
+### Legacy
+
+If the params contain :condition it will fall back to the legacy method.
+
+## Other
+
+Brian Cardarella (c) 2011
 
-Brian Cardarella - 2011
+License: MIT (see MIT-LICENSE.txt)
 

data/lib/better_ar.rb

@@ -3,12 +3,14 @@ module BetterAr
 
     # Breaks down the hash to do a ActiveRecord::Relation query
     #
-    # example: User.all(:age => 10, :limit => 2, :offset => 3, :order => :name)
+    # example: User.all(:age => 10, :limit! => 2, :offset! => 3, :order! => :name)
     #
     # is the same as: User.where(:age => 10).limit(2).offset(3).order(:name)
     #
     # if the key :conditions is present it will fall back to legacy
     #
+    # any key with the '!' at the end will be assumed to be a sql operator. The key should match either an ActiveRecord::Relation instance method or an ARel predicate.
+    #
     # @param [Hash]
     #   Optional
     # @return [ActiveRecord::Relation]
@@ -17,9 +19,9 @@ module BetterAr
 
       unless opts.key?(:conditions)
         unless opts.empty?
-          [:order, :limit, :offset].each do |predicate|
+          opts.keys.select { |key| key.to_s =~ /!$/ }.each do |predicate|
             if value = opts.delete(predicate)
-              relation = relation.send(predicate, value)
+              relation = relation.send(predicate.to_s.sub('!',''), value)
             end
           end
           relation.where(opts)
@@ -45,11 +47,11 @@ module BetterAr
     # if the key :conditions is present it will fall back to legacy
     #
     # @param [Hash]
-    #   Optional
+    #   Optional follows same convention as .all
     # @return [ActiveRecord::Base]
     def first(opts = {})
       unless opts.key?(:conditions)
-        all(opts.merge(:limit => 1)).first
+        all(opts.merge(:limit! => 1)).first
       else
         scoped.first(opts)
       end
@@ -64,7 +66,7 @@ module BetterAr
     # if the key :conditions is present it will fall back to legacy
     #
     # @param [Hash]
-    #   Optional
+    #   Optional follows same convention as .all
     # @return [Integer]
     def count(opts = {})
       unless opts.key?(:conditions)

data/lib/better_ar/version.rb

@@ -1,3 +1,3 @@
 module BetterAr
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/test_finder_methods.rb

@@ -13,7 +13,7 @@ describe 'Enhanced Finder Methods' do
     end
 
     it 'extracts the non-where scopes and applies' do
-      test_sql = User.all(:limit => 1, :offset => 2, :order => :name, :age => 10).to_sql
+      test_sql = User.all(:limit! => 1, :offset! => 2, :order! => :name, :age => 10).to_sql
       expected_sql = User.where(:age => 10).limit(1).offset(2).order(:name).to_sql
       test_sql.must_be_like expected_sql
     end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Brian Cardarella