asc_desc 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
 ## v0.0.1
 
-* initial release
+* initial release
+
+## v0.0.2
+
+* 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)

data/README.md

@@ -17,7 +17,7 @@ It was conducted on the basis of the excellent tutorials from Ryan Bates, namely
 Add to your Gemfile and run the `bundle` command to install it.
 
  ```ruby
- gem 'asc_desc', git: 'git@github.com:dwerlen/asc_desc.git'
+ gem 'asc_desc'
  ```
 
 
@@ -29,6 +29,8 @@ Add to your Gemfile and run the `bundle` command to install it.
 
 ## Usage
 
+### asc
+
 Call `asc` on an ActiveRecord object or on an ActiveRecord::Relation object to sort the column(s) in an ascending way.
 
  ```ruby
@@ -41,12 +43,16 @@ Call `asc` on an ActiveRecord object or on an ActiveRecord::Relation object to s
  # using multiple parameters to specify more than one column for the sort clause
  Candy.where(:sugar => true).asc(:classification, :name)
 
- # using an array to pass mutliple argument
+ # using an array to pass mutliple arguments
  Candy.where(:sugar => true).asc([:classification, :name])
  
  # using a string to specify more than one column for the sort clause
  Candy.where(:sugar => true).asc('classification, name')
  
+ # without argument, the method generates a sort by id (custom primary key supported)
+ # SELECT "candies".* FROM "candies" ORDER BY id ASC
+ Candy.where(:sugar => true).asc
+ 
  # the method is chainable
  Candy.where(:sugar => true).asc(:classification).asc(:name)
  ```
@@ -54,6 +60,8 @@ Call `asc` on an ActiveRecord object or on an ActiveRecord::Relation object to s
 `ascending` and `ascending_order` are aliases of `asc`.
 
 
+### desc
+
 Call `desc` on an ActiveRecord object or on an ActiveRecord::Relation object to sort the column(s) in a descending way.
 
  ```ruby
@@ -66,12 +74,16 @@ Call `desc` on an ActiveRecord object or on an ActiveRecord::Relation object to
  # using multiple parameters to specify more than one column for the sort clause
  Candy.where(:sugar => true).desc(:classification, :name)
  
- # using an array to pass mutliple argument
+ # using an array to pass mutliple arguments
  Candy.where(:sugar => true).desc([:classification, :name])
  
  # using a string to specify more than one column for the sort clause
  Candy.where(:sugar => true).desc('classification, name')
  
+ # without argument, the method generates a sort by id (custom primary key supported)
+ # SELECT "candies".* FROM "candies" ORDER BY id DESC
+ Candy.where(:sugar => true).desc
+ 
  # the method is chainable
  Candy.where(:sugar => true).desc(:classification).desc(:name)
  ```
@@ -79,6 +91,12 @@ 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.
+
+
 ## Development
 
 Questions or problems? Please post them on the [issue tracker](https://github.com/dwerlen/asc_desc/issues).

data/asc_desc.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ['werlen@icare.ch']
   s.homepage    = 'http://github.com/dwerlen/asc_desc'
   s.summary     = %q{add "asc" and "desc" methods to ActiveRecord}
-  s.description = %q{This gem adds two new methods to ActiveRecord (and ActiveRecord::Relation) that allow to sort SQL queries without using the "ASC" and "DESC" SQL keywords.}
+  s.description = %q{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.}
 
   s.rubyforge_project = 'asc_desc'
 
@@ -18,6 +18,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
+  s.add_runtime_dependency     'activerecord', '>= 3.0.0'
+
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'with_model'

data/lib/asc_desc/model_additions.rb

@@ -19,11 +19,15 @@ module AscDesc
     # using a string to specify more than one column for the sort clause
     #   Candy.where(:sugar => true).asc('classification, name')
     #
+    # without argument, the method generates a sort by id (custom primary key supported)
+    #   SELECT "candies".* FROM "candies" ORDER BY id ASC
+    #   Candy.where(:sugar => true).asc
+    #
     # the method is chainable
     #   Candy.where(:sugar => true).asc(:classification).asc(:name)
     #
     def asc(*args)
-      self.order AscDesc.format_order_clause(*args << AscDesc::ASC)
+      self.order AscDesc.format_order_clause(*(args.presence || [self.primary_key]) << AscDesc::ASC)
     end
     alias :ascending :asc
     alias :ascending_order :asc
@@ -47,14 +51,27 @@ module AscDesc
     # using a string to specify more than one column for the sort clause
     #   Candy.where(:sugar => true).desc('classification, name')
     #
+    # without argument, the method generates a sort by id (custom primary key supported)
+    #   SELECT "candies".* FROM "candies" ORDER BY id DESC
+    #   Candy.where(:sugar => true).desc
+    #
     # the method is chainable
     #   Candy.where(:sugar => true).desc(:classification).desc(:name)
     #
     def desc(*args)
-      self.order AscDesc.format_order_clause(*args << AscDesc::DESC)
+      self.order AscDesc.format_order_clause(*(args.presence || [self.primary_key]) << AscDesc::DESC)
     end
     alias :descending :desc
     alias :descending_order :desc
 
+
+    # alias of the built-in `order` method.
+    #
+    # Will be extended in future versions of the library.
+    #
+    def order_by(*args)
+      self.order(*args)
+    end
+
   end
 end

data/lib/asc_desc/version.rb

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

data/spec/asc_desc/model_additions_spec.rb

@@ -16,6 +16,21 @@ describe AscDesc::ModelAdditions do
     end
   end
 
+  with_model :Bonbon do
+    # The table block works just like a migration.
+    table :primary_key => :id_bonbon do |t|
+      t.string  :name
+      t.string  :classification
+      t.boolean :sugar
+      t.timestamps
+    end
+    # The model block works just like the class definition.
+    model do
+      extend AscDesc::ModelAdditions
+      self.primary_key = :id_bonbon
+    end
+  end
+
   it 'respond to a class method named "asc"' do
     Candy.respond_to?(:asc).should be_true
     Candy.respond_to?(:ascending).should be_true
@@ -28,6 +43,10 @@ describe AscDesc::ModelAdditions do
     Candy.respond_to?(:descending_order).should be_true
   end
 
+  it 'respond to a class method named "order_by"' do
+    Candy.respond_to?(:order_by).should be_true
+  end
+
   describe '.asc' do
 
     it 'should return an ActiveRecord Relation' do
@@ -53,7 +72,7 @@ describe AscDesc::ModelAdditions do
       candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC')
     end
 
-    it 'can format an array as mutliple argument' do
+    it 'can format an array as mutliple arguments' do
       candies = Candy.asc([:classification, :name])
       candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC')
       candies = Candy.asc([:classification, :name], :sugar)
@@ -73,11 +92,22 @@ describe AscDesc::ModelAdditions do
       candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC, sugar ASC')
     end
 
+    it 'generates a sort by id when no argument is passed' do
+      candies = Candy.asc
+      candies.to_sql.should be_end_with('ORDER BY id ASC')
+    end
+
+    it 'generates a sort by id when no argument is passed even with a custom primary key' do
+      bonbons = Bonbon.asc
+      bonbons.to_sql.should be_end_with('ORDER BY id_bonbon ASC')
+    end
+
     it 'should be chainable' do
       candies = Candy.asc(:name)
+      candies = candies.asc
       candies = candies.asc(:sugar)
       candies.should be_an_instance_of(ActiveRecord::Relation)
-      candies.to_sql.should be_end_with('ORDER BY name ASC, sugar ASC')
+      candies.to_sql.should be_end_with('ORDER BY name ASC, id ASC, sugar ASC')
     end
 
   end
@@ -107,7 +137,7 @@ describe AscDesc::ModelAdditions do
       candies.to_sql.should be_end_with('ORDER BY classification DESC, name DESC')
     end
 
-    it 'can format an array as mutliple argument' do
+    it 'can format an array as mutliple arguments' do
       candies = Candy.desc([:classification, :name])
       candies.to_sql.should be_end_with('ORDER BY classification DESC, name DESC')
       candies = Candy.desc([:classification, :name], :sugar)
@@ -127,11 +157,41 @@ describe AscDesc::ModelAdditions do
       candies.to_sql.should be_end_with('ORDER BY classification DESC, name DESC, sugar DESC')
     end
 
+    it 'generates a sort by id when no argument is passed' do
+      candies = Candy.desc
+      candies.to_sql.should be_end_with('ORDER BY id DESC')
+    end
+
+    it 'generates a sort by id when no argument is passed even with a custom primary key' do
+      bonbons = Bonbon.desc
+      bonbons.to_sql.should be_end_with('ORDER BY id_bonbon DESC')
+    end
+
     it 'should be chainable' do
       candies = Candy.desc(:name)
+      candies = candies.desc
       candies = candies.desc(:sugar)
       candies.should be_an_instance_of(ActiveRecord::Relation)
-      candies.to_sql.should be_end_with('ORDER BY name DESC, sugar DESC')
+      candies.to_sql.should be_end_with('ORDER BY name DESC, id DESC, sugar DESC')
+    end
+
+  end
+
+  describe '.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 define the "ORDER BY" clause of the underlying SQL query' do
+      candies = Candy.order_by('classification ASC, name DESC')
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name DESC')
+    end
+
+    it 'should accept multiple parameters' do
+      candies = Candy.order_by('classification DESC', 'name ASC')
+      candies.to_sql.should be_end_with('ORDER BY classification DESC, name ASC')
     end
 
   end

data/spec/asc_desc_spec.rb

@@ -35,7 +35,7 @@ describe AscDesc do
       AscDesc.format_order_clause('classification', 'name', AscDesc::DESC).should eq('classification DESC, name DESC')
     end
 
-    it 'can format an array as mutliple argument' do
+    it 'can format an array as mutliple arguments' do
       AscDesc.format_order_clause([:classification, :name], AscDesc::ASC).should eq('classification ASC, name ASC')
       AscDesc.format_order_clause([:classification, :name], AscDesc::DESC).should eq('classification DESC, name DESC')
       AscDesc.format_order_clause([:classification, :name], :sugar, AscDesc::DESC).should eq('classification DESC, name DESC, sugar DESC')
@@ -44,7 +44,7 @@ describe AscDesc do
       AscDesc.format_order_clause(['classification', 'name'], 'sugar', AscDesc::DESC).should eq('classification DESC, name DESC, sugar DESC')
     end
 
-    it 'can formata string to specify more than one column for the sort clause' do
+    it 'can format a string to specify more than one column for the sort clause' do
       AscDesc.format_order_clause('classification, name', :sugar, AscDesc::ASC).should eq('classification ASC, name ASC, sugar ASC')
       AscDesc.format_order_clause(['classification, name', :sugar], AscDesc::ASC).should eq('classification ASC, name ASC, sugar ASC')
     end

metadata

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