asc_desc 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -6,3 +6,8 @@
 
 * generates a sort by id when no argument is passed (custom primary key supported)
 * adds "order_by" as an alias for the built-in "order" method (for future development)
+
+## v0.0.3
+
+* adds dynamic order_by mechanism
+

data/README.md

@@ -3,14 +3,6 @@
 This gem adds two new methods to ActiveRecord (and ActiveRecord::Relation) that allows to sort SQL queries without using
 the "ASC" and "DESC" SQL keywords.
 
-## Remark
-
-`asc_desc` was developed in order to experiment the creation of a ruby gem. 
-It was conducted on the basis of the excellent tutorials from Ryan Bates, namely:
-
-* ["#301 Extracting a Ruby Gem"](http://railscasts.com/episodes/301-extracting-a-ruby-gem)
-* ["#303 Publishing a Gem"](http://railscasts.com/episodes/303-publishing-a-gem)
-
 
 ## Installation
 
@@ -91,11 +83,35 @@ Call `desc` on an ActiveRecord object or on an ActiveRecord::Relation object to
 `descending` and `descending_order` are aliases of `desc`.
 
 
-### order_by
-
-The current version of this gem introduces a new method called `order_by`. At this time, it's just an alias of the
-built-in `order` method but will be extended in future versions of the library.
-
+### dynamic order_by
+
+The **dynamic order_by mechanism** is built the same way as the dynamic finders present from the beginning of
+Ruby On Rails and allows to easely write the order clause for ActiveRecord queries.
+
+  ````ruby
+  # a call to order_by just acts like the standard built-in "order" method (alias)
+  Candy.where(:sugar => true).order_by('classification ASC, name ASC')
+  
+  # using a column as part of the method name
+  Candy.where(:sugar => true).order_by_name
+  
+  # using a column and a sort direction (asc|desc) as part of the method name
+  Candy.where(:sugar => true).order_by_name_asc
+  Candy.where(:sugar => true).order_by_name_desc
+  
+  # using multiple columns as part of the method name
+  Candy.where(:sugar => true).order_by_classification_and_name
+  Candy.where(:sugar => true).order_by_classification_and_name_and_sugar
+  
+  # using multiple columns and sort directions (asc|desc) as part of the method name
+  Candy.where(:sugar => true).order_by_classification_asc_and_name_desc
+  Candy.where(:sugar => true).order_by_classification_desc_and_name_asc
+  Candy.where(:sugar => true).order_by_classification_asc_and_name_desc_and_sugar_asc
+  
+  # using multiple columns with or without sort direction (asc|desc) as part of the method name
+  Candy.where(:sugar => true).order_by_classification_and_name_desc
+  Candy.where(:sugar => true).order_by_classification_desc_and_name
+  ```
 
 ## Development
 
@@ -104,3 +120,13 @@ You can contribute changes by forking the project and submitting a pull request.
 You can ensure the tests passing by running `bundle` and `rake`.
 
 This gem is created by David Werlen and is under the MIT License.
+
+
+## Remark
+
+`asc_desc` was developed in order to experiment the creation of a ruby gem. 
+It was conducted on the basis of the excellent tutorials from Ryan Bates, namely:
+
+* ["#301 Extracting a Ruby Gem"](http://railscasts.com/episodes/301-extracting-a-ruby-gem)
+* ["#303 Publishing a Gem"](http://railscasts.com/episodes/303-publishing-a-gem)
+

data/lib/asc_desc/model_additions.rb

@@ -65,13 +65,56 @@ module AscDesc
     alias :descending_order :desc
 
 
-    # alias of the built-in `order` method.
-    #
-    # Will be extended in future versions of the library.
+    # a call to <tt>order_by</tt> just acts like the standard built-in "order" method (alias)
+    #   Candy.where(:sugar => true).order_by('classification ASC, name ASC')
     #
     def order_by(*args)
       self.order(*args)
     end
 
+
+private
+
+    # The **dynamic order_by mechanism** is built the same way as the dynamic finders present from the beginning of
+    # Ruby On Rails and allows to easely write the order clause for ActiveRecord queries.
+    #
+    # using a column as part of the method name
+    #   Candy.where(:sugar => true).order_by_name
+    #
+    # using a column and a sort direction (asc|desc) as part of the method name
+    #   Candy.where(:sugar => true).order_by_name_asc
+    #   Candy.where(:sugar => true).order_by_name_desc
+    #
+    # using multiple columns as part of the method name
+    #   Candy.where(:sugar => true).order_by_classification_and_name
+    #   Candy.where(:sugar => true).order_by_classification_and_name_and_sugar
+    #
+    # using multiple columns and sort directions (asc|desc) as part of the method name
+    #   Candy.where(:sugar => true).order_by_classification_asc_and_name_desc
+    #   Candy.where(:sugar => true).order_by_classification_desc_and_name_asc
+    #   Candy.where(:sugar => true).order_by_classification_asc_and_name_desc_and_sugar_asc
+    #
+    # using multiple columns with or without sort direction (asc|desc) as part of the method name
+    #   Candy.where(:sugar => true).order_by_classification_and_name_desc
+    #   Candy.where(:sugar => true).order_by_classification_desc_and_name
+    #
+    def method_missing(method_sym, *arguments, &block)
+      # the first argument is a Symbol, so we need to_s it if you want to match the pattern
+      if method_sym.to_s =~ /^order_by_([_a-zA-Z]\w*)$/
+        columns = $1.split('_and_').map do |column|
+          if column.ends_with?('_asc')
+            "#{column[0..-5]} ASC"
+          elsif column.ends_with?('_desc')
+            "#{column[0..-6]} DESC"
+          else
+            "#{column} ASC" # always use explicit sort direction
+          end
+        end
+        self.order(columns)
+      else
+        super
+      end
+    end
+
   end
 end

data/lib/asc_desc/railtie.rb

@@ -4,6 +4,8 @@ module AscDesc
       ActiveSupport.on_load :active_record do
         extend ModelAdditions
       end
+      # This is required to add <tt>method_missing</tt>.
+      ActiveRecord::Relation.send(:include, ModelAdditions)
     end
   end
 end

data/lib/asc_desc/version.rb

@@ -1,3 +1,3 @@
 module AscDesc
-  VERSION = '0.0.2'
-end
+  VERSION = '0.0.3'
+end

data/spec/asc_desc/model_additions_spec.rb

@@ -196,4 +196,53 @@ describe AscDesc::ModelAdditions do
 
   end
 
+  describe 'dynamic order_by' do
+
+    it 'should return an ActiveRecord Relation' do
+      candies = Candy.order_by_name
+      candies.should be_an_instance_of(ActiveRecord::Relation)
+    end
+
+    it 'should generate an order clause using a column as part of the method name' do
+      candies = Candy.order_by_name
+      candies.to_sql.should be_end_with('ORDER BY name ASC')
+    end
+
+    it 'should generate an order clause using a column and a sort direction (asc/desc) as part of the method name' do
+      candies = Candy.order_by_name_asc
+      candies.to_sql.should be_end_with('ORDER BY name ASC')
+
+      candies = Candy.order_by_name_desc
+      candies.to_sql.should be_end_with('ORDER BY name DESC')
+    end
+
+    it 'should generate an order clause using multiple columns as part of the method name' do
+      candies = Candy.order_by_classification_and_name
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC')
+
+      candies = Candy.order_by_classification_and_name_and_sugar
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC, sugar ASC')
+    end
+
+    it 'should generate an order clause using multiple columns and sort directions (asc/desc) as part of the method name' do
+      candies = Candy.order_by_classification_asc_and_name_desc
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name DESC')
+
+      candies = Candy.order_by_classification_desc_and_name_asc
+      candies.to_sql.should be_end_with('ORDER BY classification DESC, name ASC')
+
+      candies = Candy.order_by_classification_asc_and_name_desc_and_sugar_asc
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name DESC, sugar ASC')
+    end
+
+    it 'should generate an order clause using multiple columns with or without sort direction (asc/desc) as part of the method name' do
+      candies = Candy.order_by_classification_and_name_desc
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name DESC')
+
+      candies = Candy.order_by_classification_desc_and_name
+      candies.to_sql.should be_end_with('ORDER BY classification DESC, name ASC')
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asc_desc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-27 00:00:00.000000000Z
+date: 2012-03-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70194618974440 !ruby/object:Gem::Requirement
+  requirement: &70324219073340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70194618974440
+  version_requirements: *70324219073340
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70194618974020 !ruby/object:Gem::Requirement
+  requirement: &70324219072920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70194618974020
+  version_requirements: *70324219072920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70194618973560 !ruby/object:Gem::Requirement
+  requirement: &70324219072460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70194618973560
+  version_requirements: *70324219072460
 - !ruby/object:Gem::Dependency
   name: with_model
-  requirement: &70194618973140 !ruby/object:Gem::Requirement
+  requirement: &70324219072040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70194618973140
+  version_requirements: *70324219072040
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70194618972640 !ruby/object:Gem::Requirement
+  requirement: &70324219071540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 3.2.1
   type: :development
   prerelease: false
-  version_requirements: *70194618972640
+  version_requirements: *70324219071540
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70194618972140 !ruby/object:Gem::Requirement
+  requirement: &70324219071040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: 1.3.5
   type: :development
   prerelease: false
-  version_requirements: *70194618972140
+  version_requirements: *70324219071040
 description: This gem adds two new methods to ActiveRecord (and ActiveRecord::Relation)
   that allows to sort SQL queries without using the "ASC" and "DESC" SQL keywords.
 email: