asc_desc 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# Specify your gem's dependencies in asc_desc.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 David Werlen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# asc_desc [![Build Status](https://secure.travis-ci.org/dwerlen/asc_desc.png)](https://secure.travis-ci.org/dwerlen/asc_desc)
+
+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
+
+Add to your Gemfile and run the `bundle` command to install it.
+
+ ```ruby
+ gem 'asc_desc', git: 'git@github.com:dwerlen/asc_desc.git'
+ ```
+
+
+## Requirements
+
+* Ruby 1.8.7 or later
+* Ruby on Rails 3.0 or later
+
+
+## Usage
+
+Call `asc` on an ActiveRecord object or on an ActiveRecord::Relation object to sort the column(s) in an ascending way.
+
+ ```ruby
+ # using a symbol for the name of the column
+ Candy.where(:sugar => true).asc(:name)
+ 
+ # using a string for the name of the column
+ Candy.where(:sugar => true).asc('name')
+
+ # 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
+ 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')
+ 
+ # the method is chainable
+ Candy.where(:sugar => true).asc(:classification).asc(:name)
+ ```
+
+`ascending` and `ascending_order` are aliases of `asc`.
+
+
+Call `desc` on an ActiveRecord object or on an ActiveRecord::Relation object to sort the column(s) in a descending way.
+
+ ```ruby
+ # using a symbol for the name of the column
+ Candy.where(:sugar => true).desc(:name)
+ 
+ # using a string for the name of the column
+ Candy.where(:sugar => true).desc('name')
+ 
+ # 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
+ 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')
+ 
+ # the method is chainable
+ Candy.where(:sugar => true).desc(:classification).desc(:name)
+ ```
+
+`descending` and `descending_order` are aliases of `desc`.
+
+
+## Development
+
+Questions or problems? Please post them on the [issue tracker](https://github.com/dwerlen/asc_desc/issues).
+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.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/asc_desc.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'asc_desc/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'asc_desc'
+  s.version     = AscDesc::VERSION
+  s.authors     = ['David Werlen']
+  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.rubyforge_project = 'asc_desc'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'with_model'
+  s.add_development_dependency 'activerecord', '~> 3.2.1'
+  s.add_development_dependency 'sqlite3', '~> 1.3.5'
+end

data/lib/asc_desc/model_additions.rb

@@ -0,0 +1,60 @@
+module AscDesc
+  module ModelAdditions
+
+    # Call <tt>asc</tt> on an ActiveRecord object or on an ActiveRecord::Relation object to sort
+    # the column(s) in an ascending way.
+    #
+    # using a symbol for the name of the column
+    #   Candy.where(:sugar => true).asc(:name)
+    #
+    # using a string for the name of the column
+    #   Candy.where(:sugar => true).asc('name')
+    #
+    # 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
+    #   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')
+    #
+    # the method is chainable
+    #   Candy.where(:sugar => true).asc(:classification).asc(:name)
+    #
+    def asc(*args)
+      self.order AscDesc.format_order_clause(*args << AscDesc::ASC)
+    end
+    alias :ascending :asc
+    alias :ascending_order :asc
+
+
+    # Call <tt>desc</tt> on an ActiveRecord object or on an ActiveRecord::Relation object to sort
+    # the column(s) in a descending way.
+    #
+    # using a symbol for the name of the column
+    #   Candy.where(:sugar => true).desc(:name)
+    #
+    # using a string for the name of the column
+    #   Candy.where(:sugar => true).desc('name')
+    #
+    # 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
+    #   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')
+    #
+    # the method is chainable
+    #   Candy.where(:sugar => true).desc(:classification).desc(:name)
+    #
+    def desc(*args)
+      self.order AscDesc.format_order_clause(*args << AscDesc::DESC)
+    end
+    alias :descending :desc
+    alias :descending_order :desc
+
+  end
+end

data/lib/asc_desc/railtie.rb

@@ -0,0 +1,9 @@
+module AscDesc
+  class Railtie < Rails::Railtie
+    initializer 'asc_desc.model_additions' do
+      ActiveSupport.on_load :active_record do
+        extend ModelAdditions
+      end
+    end
+  end
+end

data/lib/asc_desc/version.rb

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

data/lib/asc_desc.rb

@@ -0,0 +1,23 @@
+require 'asc_desc/version'
+require 'asc_desc/model_additions'
+require 'asc_desc/railtie' if defined? Rails
+
+module AscDesc
+
+  ASC  = 'ASC'
+  DESC = 'DESC'
+
+  def self.format_order_clause(*args)
+    order = args.last
+    args[0..-2].map do |column|
+      if column.is_a?(Array)
+        format_order_clause(*column << order)
+      elsif column.respond_to?('include?') and column.include?(',')
+        format_order_clause(*column.split(',') << order)
+      else
+        "#{column.to_s.strip} #{order}"
+      end
+    end.join(', ')
+  end
+
+end

data/spec/asc_desc/model_additions_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+describe AscDesc::ModelAdditions do
+
+  with_model :Candy do
+    # The table block works just like a migration.
+    table 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
+    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
+    Candy.respond_to?(:ascending_order).should be_true
+  end
+
+  it 'respond to a class method named "desc"' do
+    Candy.respond_to?(:desc).should be_true
+    Candy.respond_to?(:descending).should be_true
+    Candy.respond_to?(:descending_order).should be_true
+  end
+
+  describe '.asc' do
+
+    it 'should return an ActiveRecord Relation' do
+      candies = Candy.asc(:name)
+      candies.should be_an_instance_of(ActiveRecord::Relation)
+    end
+
+    it 'can format a symbol for the name of the column' do
+      candies = Candy.asc(:name)
+      candies.to_sql.should be_end_with('ORDER BY name ASC')
+    end
+
+    it 'can format a string for the name of the column' do
+      candies = Candy.asc('name')
+      candies.to_sql.should be_end_with('ORDER BY name ASC')
+    end
+
+    it 'can format multiple parameters to specify more than one column for the sort clause' do
+      candies = Candy.asc(:classification, :name)
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC')
+
+      candies = Candy.asc('classification', 'name')
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC')
+    end
+
+    it 'can format an array as mutliple argument' 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)
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC, sugar ASC')
+
+      candies = Candy.asc(['classification', 'name'])
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC')
+      candies = Candy.asc(['classification', 'name'], 'sugar')
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC, sugar ASC')
+    end
+
+    it 'can format a string to specify more than one column for the sort clause' do
+      candies = Candy.asc('classification, name', :sugar)
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC, sugar ASC')
+
+      candies = Candy.asc(['classification, name', :sugar])
+      candies.to_sql.should be_end_with('ORDER BY classification ASC, name ASC, sugar ASC')
+    end
+
+    it 'should be chainable' do
+      candies = Candy.asc(:name)
+      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')
+    end
+
+  end
+
+  describe '.desc' do
+
+    it 'should return an ActiveRecord Relation' do
+      candies = Candy.desc(:name)
+      candies.should be_an_instance_of(ActiveRecord::Relation)
+    end
+
+    it 'can format a symbol for the name of the column' do
+      candies = Candy.desc(:name)
+      candies.to_sql.should be_end_with('ORDER BY name DESC')
+    end
+
+    it 'can format a string for the name of the column' do
+      candies = Candy.desc('name')
+      candies.to_sql.should be_end_with('ORDER BY name DESC')
+    end
+
+    it 'can format multiple parameters to specify more than one column for the sort clause' do
+      candies = Candy.desc(:classification, :name)
+      candies.to_sql.should be_end_with('ORDER BY classification DESC, name DESC')
+
+      candies = Candy.desc('classification', 'name')
+      candies.to_sql.should be_end_with('ORDER BY classification DESC, name DESC')
+    end
+
+    it 'can format an array as mutliple argument' 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)
+      candies.to_sql.should be_end_with('ORDER BY classification DESC, name DESC, sugar DESC')
+
+      candies = Candy.desc(['classification', 'name'])
+      candies.to_sql.should be_end_with('ORDER BY classification DESC, name DESC')
+      candies = Candy.desc(['classification', 'name'], 'sugar')
+      candies.to_sql.should be_end_with('ORDER BY classification DESC, name DESC, sugar DESC')
+    end
+
+    it 'can format a string to specify more than one column for the sort clause' do
+      candies = Candy.desc('classification, name', :sugar)
+      candies.to_sql.should be_end_with('ORDER BY classification DESC, name DESC, sugar DESC')
+
+      candies = Candy.desc(['classification, name', :sugar])
+      candies.to_sql.should be_end_with('ORDER BY classification DESC, name DESC, sugar DESC')
+    end
+
+    it 'should be chainable' do
+      candies = Candy.desc(:name)
+      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')
+    end
+
+  end
+
+end

data/spec/asc_desc_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe AscDesc do
+
+  it 'has a constant for the ASC SQL keyword' do
+    AscDesc.const_defined?(:ASC).should be_true
+    AscDesc.const_get(:ASC).should eq('ASC')
+  end
+
+  it 'has a constant for the DESC SQL keyword' do
+    AscDesc.const_defined?(:DESC).should be_true
+    AscDesc.const_get(:DESC).should eq('DESC')
+  end
+
+  describe '.format_order_clause' do
+
+    it 'respond to a class method named "format_order_clause"' do
+      AscDesc.respond_to?(:format_order_clause)
+    end
+
+    it 'can format a symbol for the name of the column' do
+      AscDesc.format_order_clause(:name, AscDesc::ASC).should eq('name ASC')
+      AscDesc.format_order_clause(:name, AscDesc::DESC).should eq('name DESC')
+    end
+
+    it 'can format a string for the name of the column' do
+      AscDesc.format_order_clause('name', AscDesc::ASC).should eq('name ASC')
+      AscDesc.format_order_clause('name', AscDesc::DESC).should eq('name DESC')
+    end
+
+    it 'can format multiple parameters to specify more than one column for the sort clause' 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', AscDesc::ASC).should eq('classification ASC, name ASC')
+      AscDesc.format_order_clause('classification', 'name', AscDesc::DESC).should eq('classification DESC, name DESC')
+    end
+
+    it 'can format an array as mutliple argument' 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')
+      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')
+    end
+
+    it 'can formata 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
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+require 'with_model'
+require 'asc_desc'
+
+RSpec.configure do |config|
+  config.extend ::WithModel
+end
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: asc_desc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Werlen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70196428113380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70196428113380
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70196428112960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70196428112960
+- !ruby/object:Gem::Dependency
+  name: with_model
+  requirement: &70196428112540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70196428112540
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70196428112040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :development
+  prerelease: false
+  version_requirements: *70196428112040
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70196428111540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: *70196428111540
+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.
+email:
+- werlen@icare.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- asc_desc.gemspec
+- lib/asc_desc.rb
+- lib/asc_desc/model_additions.rb
+- lib/asc_desc/railtie.rb
+- lib/asc_desc/version.rb
+- spec/asc_desc/model_additions_spec.rb
+- spec/asc_desc_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dwerlen/asc_desc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: asc_desc
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: add "asc" and "desc" methods to ActiveRecord
+test_files:
+- spec/asc_desc/model_additions_spec.rb
+- spec/asc_desc_spec.rb
+- spec/spec_helper.rb