with_order 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+spec/dummy/log/*.log

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in add_order.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Aaron Lasseigne
+
+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,42 @@
+# with_order
+
+Provide ordering for tables, lists, etc.
+
+This project follows [Semantic Versioning](http://semver.org/).
+
+## Installation
+
+    $ gem install with_order
+
+If you're using Bundler, add this to your Gemfile:
+
+    gem 'with_order', '~>0.1.0'
+
+## Support
+
+<table>
+  <tr>
+    <td><strong>Ruby</strong></td>
+    <td>1.9</td>
+  </tr>
+  <tr>
+    <td><strong>Rails</strong></td>
+    <td>3.1</td>
+  </tr>
+  <tr>
+    <td><strong>Database Framework</strong></td>
+    <td>ActiveRecord</td>
+  </tr>
+</table>
+
+## Usage
+
+In your controller:
+
+    @data = Data.with_order(params, default: :full_name, fields: {full_name: 'first_name ASC, last_name ASC'})
+
+In your view:
+
+    <th><%= link_with_order('ID', @data, :id) %></th>
+    <th><%= link_with_order('Full Name', @data, :full_name) %></th>
+    <th><%= link_with_order('Email', @data, :email) %></th>

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/changelog.markdown

@@ -0,0 +1,2 @@
+## 0.1.0
+ * initial release

data/lib/with_order.rb

@@ -0,0 +1,13 @@
+require 'with_order/engine'
+require 'with_order/hash_extraction'
+require 'with_order/active_record_extension'
+require 'with_order/active_record_model_extension'
+require 'with_order/action_view_extension'
+require 'with_order/version'
+
+ActiveSupport.on_load(:active_record) do
+  include WithOrder::ActiveRecordExtension
+end
+ActiveSupport.on_load(:action_view) do
+  include WithOrder::ActionViewExtension
+end

data/lib/with_order/action_view_extension.rb

@@ -0,0 +1,33 @@
+module WithOrder
+  module ActionViewExtension
+    include WithOrder::HashExtraction
+
+    def link_with_order(*args, &block)
+      text = scope = field = html_options = nil
+
+      if block_given?
+        text         = capture(&block)
+        scope        = args[0]
+        field        = args[1]
+        html_options = args[2] || {}
+      else
+        text         = args[0]
+        scope        = args[1]
+        field        = args[2]
+        html_options = args[3] || {}
+      end
+
+      dir = html_options.delete(:dir) || (
+        (scope.current_order[:field] == field and (scope.current_order[:dir].blank? or scope.current_order[:dir].downcase == :asc)) ?
+        'desc' :
+        'asc'
+      )
+
+      param_namespace = scope.current_order[:param_namespace]
+      scoped_params = (param_namespace ? self.extract_hash_value(params, param_namespace) : params).try(:dup) || {}
+      scoped_params.merge!({order: "#{field}-#{dir}"})
+
+      link_to(text, param_namespace ? params.merge({param_namespace => scoped_params}) : scoped_params, html_options)
+    end
+  end
+end

data/lib/with_order/active_record_extension.rb

@@ -0,0 +1,22 @@
+module WithOrder
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        alias_method_chain :inherited, :with_order
+      end
+
+      self.descendants.each do |descendant|
+        descendant.send(:include, WithOrder::ActiveRecordModelExtension) if descendant.superclass == ActiveRecord::Base
+      end
+    end
+
+    module ClassMethods
+      def inherited_with_with_order(base)
+        inherited_without_with_order(base)
+        base.send(:include, WithOrder::ActiveRecordModelExtension) if base.superclass == ActiveRecord::Base
+      end
+    end
+  end
+end

data/lib/with_order/active_record_model_extension.rb

@@ -0,0 +1,66 @@
+module WithOrder
+  module ActiveRecordModelExtension
+    extend ActiveSupport::Concern
+
+    module CurrentOrder
+      attr_accessor :current_order
+    end
+
+    included do
+      self.scope :with_order, ->(order = nil, options = {}) {
+        relation = self.scoped.extending do
+          extend WithOrder::HashExtraction
+
+          if order.is_a?(Hash)
+            order = self.extract_hash_value(order, options.has_key?(:param_namespace) ? "#{options[:param_namespace]}[:order]" : :order)
+          end
+          order = (order || options[:default]).to_s
+
+          define_method :current_order do
+            field = dir = nil
+            field, dir = order.match(/^(.*?)(?:-(asc|desc))?$/i).captures if order
+            dir ||= :asc
+
+            if field.blank?
+              {field: nil, dir: nil, param_namespace: options[:param_namespace].try(:to_sym)}
+            else
+              {
+                field:           field.to_sym,
+                dir:             (dir.to_sym || (self.reverse_order_value ? :desc : :asc)),
+                param_namespace: options[:param_namespace].try(:to_sym)
+              }
+            end
+          end
+
+          def to_a
+            a = super.extend(CurrentOrder)
+            a.current_order = self.current_order
+            a
+          end
+        end
+
+        return relation unless relation.current_order[:field]
+
+        order_text = ''
+        if options[:fields] and options[:fields][relation.current_order[:field]]
+          order_text = options[:fields][relation.current_order[:field]]
+        else
+          field = relation.current_order[:field].to_s
+
+          if field !~ /\./
+            quoted_field = relation.connection.quote_column_name(field)
+            field = relation.column_names.include?(field) ? "#{self.table_name}.#{quoted_field}" : quoted_field
+          end
+
+          order_text = "#{field} ASC"
+        end
+
+        if relation.current_order[:dir].try(:downcase) == :desc
+          relation.reorder(order_text).reverse_order
+        else
+          relation.reorder(order_text)
+        end
+      }
+    end
+  end
+end

data/lib/with_order/engine.rb

@@ -0,0 +1,4 @@
+module WithOrder
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/with_order/hash_extraction.rb

@@ -0,0 +1,15 @@
+module WithOrder
+  module HashExtraction
+    def extract_hash_value(hash, key)
+      return hash[key] if key.is_a?(Symbol)
+
+      first_key, remaining_content = key.to_s.match(/^([^\[]+)(.*)$/).captures
+
+      if remaining_content == ''
+        hash[first_key]
+      else
+        eval "hash[first_key.to_sym]#{remaining_content} rescue nil"
+      end
+    end
+  end
+end

data/lib/with_order/version.rb

@@ -0,0 +1,3 @@
+module WithOrder
+  VERSION = '0.1.0'
+end

data/spec/active_record_model_extension_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+
+describe 'WithOrder::ActiveRecordModelExtention' do
+  describe '#with_order(order, options = {})' do
+    context 'order' do
+      it 'can be a hash containing :order' do
+        npw = NobelPrizeWinner.with_order({order: 'first_name-asc'})
+        npw.order_values.should == ['nobel_prize_winners."first_name" ASC']
+        npw.reverse_order_value.should == nil
+      end
+
+      it 'can be a symbol' do
+        npw = NobelPrizeWinner.with_order(:first_name)
+        npw.order_values.should == ['nobel_prize_winners."first_name" ASC']
+        npw.reverse_order_value.should == nil
+      end
+
+      it 'can be a string' do
+        npw = NobelPrizeWinner.with_order('first_name-asc')
+        npw.order_values.should == ['nobel_prize_winners."first_name" ASC']
+        npw.reverse_order_value.should == nil
+      end
+
+      context 'does not include a direction' do
+        it 'defaults to "ASC"' do
+          npw = NobelPrizeWinner.with_order({order: 'first_name'})
+          npw.order_values.should == ['nobel_prize_winners."first_name" ASC']
+          npw.reverse_order_value.should == nil
+        end
+      end
+
+      it 'can be descending' do
+        npw = NobelPrizeWinner.with_order({order: 'first_name-desc'})
+        npw.order_values.should == ['nobel_prize_winners."first_name" ASC']
+        npw.reverse_order_value.should be true
+      end
+
+      it 'can be blank and have no default' do
+        npw = NobelPrizeWinner.with_order.limit(1)
+        npw.order_values.should == []
+      end
+    end
+
+    context 'limit the need for specifying table names to resolve ambiguity' do
+      it 'prepends the table name to the field if the field is in the primary table' do
+        npw = NobelPrizeWinner.joins(:nobel_prizes).with_order(:id)
+        npw.order_values.should == ['nobel_prize_winners."id" ASC']
+      end
+      
+      it 'skips fields where a table is already provided' do
+        npw = NobelPrizeWinner.joins(:nobel_prizes).with_order('nobel_prizes.year')
+        npw.order_values.should == ['nobel_prizes.year ASC']
+      end
+
+      it 'does not affect non-primary fields' do
+        npw = NobelPrizeWinner.joins(:nobel_prizes).with_order(:year)
+        npw.order_values.should == ['"year" ASC']
+      end
+    end
+
+    it 'does not break the chain' do
+      npw = NobelPrizeWinner.with_order({order: 'first_name-asc'}).limit(1)
+      npw.order_values.should == ['nobel_prize_winners."first_name" ASC']
+      npw.reverse_order_value.should == nil
+    end
+
+    it 'ignores order in the default_scope' do
+      npw = NobelPrizeWinner.with_order(:first_name)
+      npw.order_values.should == ['nobel_prize_winners."first_name" ASC']
+      npw.reverse_order_value.should == nil
+    end
+
+    context 'options' do
+      context ':fields' do
+        it 'orders the field by a custom ORDER BY statement' do
+          npw = NobelPrizeWinner.with_order({order: 'full_name'}, {
+            fields: {
+              full_name: 'first_name ASC, last_name ASC'
+            }
+          })
+          npw.order_values.should == ['first_name ASC, last_name ASC']
+          npw.reverse_order_value.should == nil
+        end
+
+        it 'can reverse the field order when using a custom ORDER BY statement' do
+          npw = NobelPrizeWinner.with_order({order: 'full_name-desc'}, {
+            fields: {
+            full_name: 'first_name ASC, last_name ASC'
+          }
+          })
+          npw.order_values.should == ['first_name ASC, last_name ASC']
+          npw.reverse_order_value.should be true
+        end
+      end
+
+      context ':default' do
+        it 'defaults to the field when no order is passed' do
+          npw = NobelPrizeWinner.with_order({}, {default: 'first_name-desc'})
+          npw.order_values.should == ['nobel_prize_winners."first_name" ASC']
+          npw.reverse_order_value.should be true
+        end
+
+        it 'does not default to the field when a order is passed' do
+          npw = NobelPrizeWinner.with_order({order: 'first_name'}, {default: 'last_name'})
+          npw.order_values.should == ['nobel_prize_winners."first_name" ASC']
+          npw.reverse_order_value.should == nil
+        end
+      end
+
+      context ':param_namespace' do
+        it 'finds the :order param from the hash using the namespace' do
+          npw = NobelPrizeWinner.with_order({foo: {order: 'first_name'}}, {param_namespace: :foo})
+          npw.order_values.should == ['nobel_prize_winners."first_name" ASC']
+          npw.reverse_order_value.should == nil
+        end
+
+        it 'skips order if it cannot find :order in the namespace' do
+          npw = NobelPrizeWinner.with_order({bar: {order: 'first_name'}}, {param_namespace: :foo})
+          npw.order_values.should == []
+          npw.reverse_order_value.should == nil
+        end
+      end
+    end
+  end
+
+  describe 'WithOrder::ActiveRecordModelExtension Relation' do
+    context '#current_order' do
+      it 'returns the field being ordered on' do
+        npw = NobelPrizeWinner.with_order({order: 'first_name-asc'})
+        npw.current_order[:field].should == :first_name
+        npw.current_order[:dir].should == :asc
+        npw.current_order[:param_namespace].should == nil 
+      end
+
+      it 'returns nil for all keys if no field is ordered on' do
+        npw = NobelPrizeWinner.with_order
+        npw.current_order[:field].should == nil
+        npw.current_order[:dir].should == nil 
+        npw.current_order[:param_namespace].should == nil 
+      end
+
+      it 'returns the :param_namespace if passed' do
+        npw = NobelPrizeWinner.with_order(:first_name, {param_namespace: :foo})
+        npw.current_order[:field].should == :first_name
+        npw.current_order[:dir].should == :asc
+        npw.current_order[:param_namespace].should == :foo 
+
+        npw = NobelPrizeWinner.with_order({}, {param_namespace: :foo})
+        npw.current_order[:field].should == nil
+        npw.current_order[:dir].should == nil
+        npw.current_order[:param_namespace].should == :foo 
+      end
+    end
+
+    context '#to_a' do
+      it 'returns an array with #current_order attached' do
+        npw = NobelPrizeWinner.with_order(:first_name, {param_namespace: :foo}).to_a
+        npw.current_order[:field].should == :first_name
+        npw.current_order[:dir].should == :asc
+        npw.current_order[:param_namespace].should == :foo 
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.