order 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore simplecov generated files
+/coverage
+/doc
+/pkg
+.yardoc

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'sqlite3'
+  gem 'simplecov', :require => false
+  gem 'rspec', '~> 2.12'
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    order (0.1.0)
+      activerecord (~> 3.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+    activerecord (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    multi_json (1.5.0)
+    rake (10.0.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  order!
+  rake
+  rspec (~> 2.12)
+  simplecov
+  sqlite3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jay Hayes
+
+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.markdown

@@ -0,0 +1,84 @@
+# Order
+Convenient ActiveRecord ordering.
+
+## Introduction
+
+Order provides a convenient DSL for adding ordering scopes to ActiveRecord
+models. Additionally it provides an `order_by` method that allows you to 
+get records by multiple orderings using a simple syntax. This is great for
+APIs. Take this model for example:
+
+## Getting Started
+
+Add `order` to your `Gemfile`:
+
+    gem 'order', '~> 0.1'
+
+Bundle it up:
+
+    # From the command line
+    bundle install
+
+## Usage
+
+Add some ordering to your models:
+
+    Person < ActiveRecord::Base
+      belongs_to :job
+      attr_accessible :first_name, :last_name
+
+      orderable :first_name, :last_name
+      orderable :name => [:last_name, :first_name]
+      orderable :job_title do |direction|
+        joins(:job).order "jobs.title #{direction}"
+      end
+    end
+
+Now you can retrieve people in order!
+
+    Person.order_by_first_name
+    => SELECT "people".* FROM "people" ORDER BY "first_name" ASC
+
+    Person.order_by_first_name(:desc)
+    => SELECT "people".* FROM "people" ORDER BY "first_name" DESC
+
+    Person.order_by_name
+    => SELECT "people".* FROM "people" ORDER BY "last_name" ASC, "first_name" ASC
+
+    Person.order_by_job_title
+    => SELECT "people".* FROM "people" INNER JOIN "jobs" ON "jobs"."id" = "person"."job_id" ORDER BY jobs.title ASC
+
+You can also get at ordering using the `order_by` method:
+
+    Person.order_by 'name.desc, job_title'
+    => SELECT "people".* FROM "people" INNER JOIN "jobs" ON "jobs"."id" = "person"."job_id" ORDER BY "last_name" DESC, "first_name" DESC, jobs.title ASC
+
+This is super helpful when developing APIs that need to provide ordered
+results. Consider the following:
+
+    PeopleController < ApplicationController
+      respond_to :html
+      def index
+        @requests = Person.order_by params[:order]
+        respond_with @requests
+      end
+    end
+
+A simple request to "/people?order=name.desc,job_title" will give you ordered results! :)
+
+## Contributing
+
+This is a baby library! _Cute_? Absolutely. But also hoping to grow up into a
+big, useful tool to be take advantage of! (Something about that really
+doesn't sound right)
+
+* Use it.
+* Pick it apart.
+* Let me know what you think.
+* Tell others.
+
+Please add issues and send pull requests!
+
+## Copyright
+
+Copyright © 2012 Jay Hayes

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new
+task :default => :spec

data/lib/order.rb

@@ -0,0 +1,67 @@
+require 'active_record'
+require 'order/version'
+
+module Order
+  DIRECTION_DESC = /\Adesc/i
+
+  # Given and ordering such as "state.desc,site,name.descending", it orders the results as such
+  # using the +order_by_*+ scopes.
+  def order_by(ordering)
+    ordering.split(',').inject(self) do |relation, orderer|
+      attribute, direction = *orderer.split('.')
+      relation.send "order_by_#{attribute.strip}", direction
+    end
+  end
+
+  # Generates +order_by_*+ scopes used for ordering resulting records.
+  # @overload orderable(*attribute_names)
+  #   Generates simple ordering scopes that can accept a direction such as "desc"
+  #   @param [Array] of attribute names
+  # @overload orderable(attribute_map)
+  #   Generates simple ordering scope using aliased mapping to one or more attributes
+  #   @param [Hash] mapping ordering name to attribute(s)
+  # @overload orderable(order_name, &block)
+  #   Generates an ordering scope using a custom strategy specified by the given block
+  # @example Custom ordering strategy
+  #   orderable(:category_name){ |direction| joins(:category).order "category.name #{direction}" }
+  def orderable(*attributes, &block)
+    if block_given?
+      raise ArgumentError.new('Cannot provide mapped naming for custom ordering strategy') if attributes.first.is_a? Hash
+      order_scope attributes.first, &block
+    elsif attributes.first.is_a? Hash
+      attributes.first.each{ |name, attribute| order_scope name, attribute }
+    else
+      attributes.each{ |attribute| order_scope attribute }
+    end
+  end
+
+  # Adds an +order_by_(name)+ scope. Optionally you can provide an +attribute+ to order on in case
+  # the +name+ is to be an alias for the ordering. You may also provide a block that defines a
+  # custom ordering strategy.
+  def order_scope(name, attribute = nil, &block)
+    scope "order_by_#{name}", lambda{ |direction = nil|
+      if block_given?
+        yield normalize_direction(direction)
+      else
+        if attribute.is_a? Array
+          order attribute.map{ |bute| order_clause bute, direction }.join ', '
+        else
+          order order_clause attribute || name, direction
+        end
+      end
+    }
+  end
+
+  # Builds an ordering clause string such as "some_table.some_attribute DESC". The direction will
+  # be normalized to either "ASC" or "DESC".
+  def order_clause(attribute, direction)
+    "\"#{attribute || name}\" #{normalize_direction direction}"
+  end
+
+  # Converts a direction into either "ASC" or "DESC". It uses +DIRECTION_DESC+ to match the +String+.
+  def normalize_direction(direction)
+    (direction =~ DIRECTION_DESC) ? 'DESC' : 'ASC'
+  end
+end
+
+ActiveRecord::Base.extend Order

data/lib/order/version.rb

@@ -0,0 +1,13 @@
+module Order
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    PRE   = nil
+
+    def self.to_s
+      [MAJOR, MINOR, PATCH, PRE].compact.join '.'
+    end
+  end
+end
+

data/order.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'order/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'order'
+  s.version     = Order::Version
+  s.authors     = ['Jay Hayes']
+  s.email       = 'ur@iamvery.com'
+  s.homepage    = 'http://github.com/iamvery/order'
+  s.summary     = %q(DSL for defining ActiveRecord orderings)
+  s.description = %q(Provides a simple DSL for creating named scopes for ordering records)
+
+  s.files         = `git ls-files`.split "\n"
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split "\n"
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activerecord', '~> 3.2'
+end

data/spec/lib/order_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+# Re-opened. See support/models.rb
+class Person
+  orderable :first_name, :last_name
+  orderable :fname => :first_name,
+    :created => :created_at,
+    :updated => :updated_at,
+    :name => [:last_name, :first_name]
+
+  orderable :job do |dir|
+    joins(:job).
+      order "jobs.title #{dir}"
+  end
+
+  orderable :company do |dir|
+    joins(:job => :company).
+      order "companies.name #{dir}"
+  end
+end
+
+describe Order do
+
+  describe '#orderable' do
+    it 'handles attributes' do
+      Person.order_by_first_name.to_sql.should match /"first_name" ASC/
+      Person.order_by_first_name('desc').to_sql.should match /"first_name" DESC/
+      Person.order_by_last_name.to_sql.should match /"last_name" ASC/
+      Person.order_by_last_name('desc').to_sql.should match /"last_name" DESC/
+    end
+  
+    it 'handles aliased attributes' do
+      Person.order_by_fname.to_sql.should match /"first_name" ASC/
+      Person.order_by_fname('desc').to_sql.should match /"first_name" DESC/
+      Person.order_by_created.to_sql.should match /"created_at" ASC/
+      Person.order_by_created('desc').to_sql.should match /"created_at" DESC/
+      Person.order_by_updated.to_sql.should match /"updated_at" ASC/
+      Person.order_by_updated('desc').to_sql.should match /"updated_at" DESC/
+    end
+  
+    it 'handles multiple aliased attributes' do
+      Person.order_by_name.to_sql.should match /"last_name" ASC, "first_name" ASC/
+      Person.order_by_name('desc').to_sql.should match /"last_name" DESC, "first_name" DESC/
+    end
+  
+    it 'handles custom ordering strategies' do
+      Person.order_by_job.to_sql.should match /jobs.title ASC/
+      Person.order_by_job('desc').to_sql.should match /jobs.title DESC/
+      Person.order_by_company.to_sql.should match /companies.name ASC/
+      Person.order_by_company('desc').to_sql.should match /companies.name DESC/
+    end
+  end
+  
+  describe '#order_by' do
+    it 'chains multiple orderings together from comma-separated string' do
+      Person.order_by('name.desc, job').to_sql.should match /"last_name" DESC, "first_name" DESC, jobs.title ASC/
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'order'
+require 'support/setup_sample_db'
+require 'support/models'

data/spec/support/models.rb

@@ -0,0 +1,12 @@
+class Person < ActiveRecord::Base
+  belongs_to :job
+  has_many :pet_relationships
+  has_many :pets, :through => :pet_relationships
+end
+
+class Job < ActiveRecord::Base
+  belongs_to :company
+end
+
+class Company < ActiveRecord::Base
+end

data/spec/support/setup_sample_db.rb

@@ -0,0 +1,28 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => ':memory:'
+)
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+
+  ActiveRecord::Schema.define do
+    create_table :people, :force => true do |t|
+      t.string     :first_name
+      t.string     :last_name
+      t.references :job
+      t.timestamps
+    end
+
+    create_table :jobs, :force => true do |t|
+      t.string     :title
+      t.references :company
+    end
+
+    create_table :companies, :force => true do |t|
+      t.string :name
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: order
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jay Hayes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Provides a simple DSL for creating named scopes for ordering records
+email: ur@iamvery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/order.rb
+- lib/order/version.rb
+- order.gemspec
+- spec/lib/order_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/setup_sample_db.rb
+homepage: http://github.com/iamvery/order
+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'
+      segments:
+      - 0
+      hash: -2075213003283050010
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2075213003283050010
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: DSL for defining ActiveRecord orderings
+test_files:
+- spec/lib/order_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/setup_sample_db.rb