yfactorial-utility_scopes 0.2.1 → 0.2.2

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.2.2
+
+* More flexible @ordered@ syntax (by jney - http://github.com/jney)
+
 0.2.1
 
 * Fixed except named scope not correctly determining its base class

data/README.textile

@@ -110,11 +110,17 @@ h3. Ordered
 _Note: the @ordered@ scope cannot be chained with any other @order@ clauses_
 
 @ordered@ lets you dynamically specify the ordering of your result set.  If no
-arguments are given it will default to @created_at DESC@:
-
-  Article.ordered              # Get all articles ordered by "created_at DESC"
-  Article.ordered(:id)         # Get all articles ordered by "id"
-  Article.ordered("rank ASC")  # Get all articles ordered by "rank ASC"  
+arguments are given it will default to @created_at DESC@.  (@ordered@ is also
+available as @order_by@ and @sort_by@)
+
+  Article.ordered                 # Get all articles ordered by "created_at DESC"
+  Article.ordered(:id)            # Get all articles ordered by "id"
+  Article.ordered("rank ASC")     # Get all articles ordered by "rank ASC"
+  Article.order_by(:id)           # order_by and sort_by are alias to ordered
+  Article.order_by([:id, :desc], :popularity)           # can take a two-element array as parameter
+  Article.sort_by(:id => :desc, :popularity => :asc)   # can take a hash as parameter
+                                                        # only available for jruby/ruby 1.9
+  Article.order_by_id             # can be set as a sentence
 
 If you would like to specify a different default sort order you can do so on a per class basis
 using @ordered_by@:

data/Rakefile

@@ -1,8 +1,13 @@
 require 'rubygems'
 require 'rake'
 require 'rake/rdoctask'
+require 'spec/rake/spectask'
 
-# TODO add task to execute specs
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
  
 desc 'Generate RDoc documentation.'
 Rake::RDocTask.new(:rdoc) do |rdoc|

data/lib/utility_scopes/ordered.rb

@@ -2,20 +2,32 @@
 module UtilityScopes
   module Ordered
     
-    def self.included(within)
-      within.class_eval do
-        
+    def self.included(base)
+      base.extend ClassMethods
+      
+      base.class_eval do
         # Provide an ordered scope
-        named_scope :ordered, lambda { |*order|
-          { :order => order.flatten.first || self.default_ordering }
-        }
+        named_scope(:ordered, lambda { |*order|
+          { :order => case
+            when order.empty?
+              self.default_ordering
+            # allow hash support for jruby or ruby 1.9
+            when order.size == 1 && order[0].is_a?(Hash) && (PLATFORM=~/java/ || RUBY_VERSION=~/1\.9.*/)
+              order.first.collect{|(k,v)| "#{k} #{v.to_s.upcase}"}.join(', ')
+            else
+              order.collect{|e| e.is_a?(Array) ? "#{e[0]} #{e[1].to_s.upcase}" : e}.join(', ')
+            end
+          }
+        })
         
-        # Set the default order
         class << self
+          # Set alias order_by
+          alias_method :order_by, :ordered
+          # Set alias sort_by
+          alias_method :sort_by, :ordered
+          # Set the default order
           define_method(:default_ordering) { 'created_at DESC' }
         end
-        
-        extend ClassMethods
       end
     end
     
@@ -33,18 +45,35 @@ module UtilityScopes
       #   Article.default_ordering #=> "published_at DESC"
       #
       def ordered_by(clause)
-        
         # Override named scope on AR::Base so we can access default_ordering
         # on subclass
-        named_scope :ordered, lambda { |*order|
-          { :order => order.flatten.first || self.default_ordering }
-        }
+        named_scope(:ordered, lambda { |*order|
+          { :order => case
+            when order.empty?
+              self.default_ordering
+            # allow hash support for jruby or ruby 1.9
+            when order.size == 1 && order[0].is_a?(Hash) && (PLATFORM=~/java/ || RUBY_VERSION=~/1\.9.*/)
+              order.first.collect{|(k,v)| "#{k} #{v.to_s.upcase}"}.join(', ')
+            else
+              order.collect{|e| e.is_a?(Array) ? "#{e[0]} #{e[1].to_s.upcase}" : e}.join(', ') 
+            end
+          }
+        })
         
         metaclass.instance_eval do
           define_method(:default_ordering) { clause }
         end
       end
       
+      def method_missing(method, *args, &block)
+        col = method.to_s.match(/^(order_by_|sort_by_)(.*)$/)[2] rescue false
+        if col && self.columns.collect{ |c| c.name }.include?(col)
+          return self.order_by(col, *args, &block)
+        else
+          super
+        end
+      end
+      
       private
       
       def metaclass; class << self; self end; end

data/spec/ordered_spec.rb

@@ -2,7 +2,7 @@ require File.join(File.dirname(__FILE__), *%w[abstract_spec])
 
 describe "Ordered scope" do
 
-  before do
+  before(:each) do
     uses_fixture(:article)
   end
 
@@ -15,6 +15,38 @@ describe "Ordered scope" do
     Article.ordered('created_at ASC').proxy_options.should == {:order => 'created_at ASC'}
   end
   
+  it "should allow the order to use arrays as arg" do
+    Article.ordered([:popularity, :asc], [:second_param, :desc]).proxy_options.should == {:order => 'popularity ASC, second_param DESC'}
+  end
+  
+  it "should allow the order hash as arg" do
+    if (PLATFORM=~/java/ || RUBY_VERSION=~/1\.9.*/)
+      Article.ordered(:popularity => :asc, :second_param => :desc).proxy_options.should == {:order => 'popularity ASC, second_param DESC'}
+    end
+  end
+  
+  it "should allow the order with several args" do
+    Article.ordered(:popularity, :updated_at).proxy_options.should == {:order => 'popularity, updated_at'}
+  end
+
+  it "should sort by column popularity when calling order_by_popularity" do
+    require 'ostruct'
+    columns = [OpenStruct.new({:name => 'popularity'})]
+    Article.stub!(:columns).and_return(columns)
+    Article.order_by_popularity.proxy_options.should == {:order => 'popularity'}
+  end
+  
+  it "should raise an error when column does not exist" do
+    require 'ostruct'
+    columns = [OpenStruct.new({:name => 'popularity'})]
+    Article.stub!(:columns).and_return(columns)
+    lambda{ Article.order_by_unknown_columns }.should raise_error
+  end
+  
+  it "should have an alias" do
+    Article.order_by([:popularity, :asc]).proxy_options.should == {:order => 'popularity ASC'}
+  end
+  
   it "should allow the default to be overidden by using ordered_by" do
     Article.ordered_by 'published_at DESC'
     Article.default_ordering.should == 'published_at DESC'
@@ -27,6 +59,6 @@ describe "Ordered scope" do
   end
   
   it "should be able to handle symbol order criteria" do
-    Article.ordered(:id).proxy_options.should == { :order => :id }
+    Article.ordered(:id).proxy_options.should == { :order => 'id' }
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
 require 'spec'
- 
+
 Spec::Runner.configure do |config|
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yfactorial-utility_scopes
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Ryan Daigle
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-08 00:00:00 -07:00
+date: 2008-10-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency