sort_this 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p327@sort_this"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.17.3 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v1.0.0
+
+* Initial Release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Scott Pullen
+
+MIT License
+
+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,82 @@
+# SortThis
+
+SortThis provides a way to sort.
+
+The controller/view code is based off of railscasts [episode 228 - Sortable Table Columns](http://railscasts.com/episodes/228-sortable-table-columns).
+
+Here is an [example app](https://github.com/spullen/sort_example) that demonstrates the usage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sort_this', :git => 'git://github.com/spullen/sort_this.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Model
+
+Add a call to the `sortable` method with a hash of sorts
+
+    class YourModel < ActiveRecord::Base
+      
+      sort_this :sort_name => {:column_name => :name, :default => 'ASC', :joins => :association, :clause => "some.clause"}
+      
+    end
+    
+The options are
+
+    sort_name: Is the name of the sort, this in most cases will be the same as the column_name, but can be anything
+    
+    Sort Options:
+    
+      column_name: (Required) The name of the column to sort on.
+      default:     (Optional) Defines a default sort if provided. The valid options are 'ASC' or 'DESC'.
+      joins:       (Optional) Defines an association to join on, this should be provided if the column is in another table.
+      clause:      (Optional) Overrides the clause used for the sort.
+      
+Then to sort
+
+    YourModel.sort("sort_name", "asc|desc") => sorted list of YourModel objects
+    
+### Controller
+
+In you controller define a default sort
+
+    class SomeController < ApplicationController
+      sortable "sort_name"
+      
+      def index
+        SomeModel.sort(sort_column, sort_direction)
+      end
+    end
+    
+### In Views
+
+    sortable(sort_name, title = nil, html_options = {})
+    
+    <%= sortable("sort_name") %>
+    
+    or custom title
+
+    <%= sortable("sort_name", "Sort Different Name") %>
+    
+## TODO:
+
+- Add error handling to active record sortable
+- Add the ability to customize the sort and direction parameters
+- Define scopes for each sort defined (individual sort scopes)
+
+- Testing on different databases (should probably hit postgresql and mysql unless the way SQLite handles it in the same way)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/sort_this/action_controller.rb

@@ -0,0 +1,31 @@
+require 'action_controller'
+
+module SortThis
+  module ActionController
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        class_attribute :default_sort_column
+      end
+    end
+    
+    module ClassMethods
+    
+      def sortable(sort_column)
+        self.default_sort_column = sort_column
+      end
+      
+    end
+    
+    protected
+    
+    def sort_column
+      params[:sort].blank? ? self.default_sort_column : params[:sort]
+    end
+    
+    def sort_direction
+      %w[asc desc].include?(params[:direction]) ? params[:direction] : "asc"
+    end
+  
+  end
+end

data/lib/sort_this/active_record.rb

@@ -0,0 +1,100 @@
+require 'memoist'
+require 'active_record'
+
+module SortThis
+  module ActiveRecord
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        
+        class << self; extend Memoist; self; end.memoize :sort
+        
+        
+        class_attribute :sort_columns, :default_sort_columns
+      end
+    end
+  
+    module ClassMethods
+       
+      #
+      # Input is a hash of sort_name => sort_options pairs
+      #
+      # :column_name  => (required) Column name to sort on
+      # :default      => (optional) 'ASC'|'DESC'
+      # :joins        => (optional) Association to join on. Note: must be an association of the model being sorted.
+      #                             Prefixes the column_name with the table name to prevent collisions
+      # :clause       => (optional) Override the clause of the sort
+      #
+      # ex.
+      # products  have many  quotes
+      # vendors   have many  quotes
+      #
+      # sorting on the quotes table
+      #
+      # :sort_name1 => { :column_name => :quantity }
+      # :sort_name2 => { :column_name => :price, :default => 'DESC' }
+      # :sort_name3 => { :column_name => :name, :joins => :product }
+      #
+      def sort_this(sorts = {})
+        self.sort_columns = {}
+        self.default_sort_columns = {}
+        
+        empty_sort_options = { :column_name => nil, :default => nil, :joins => nil, :clause => nil }
+        
+        sorts.each do |sort_name, sort_options|
+          sort_options = empty_sort_options.merge(sort_options)
+          
+          self.sort_columns[sort_name] = sort_options
+          
+          column  = sort_options[:column_name] # TODO: raise exception if this is nil
+          table   = (sort_options[:joins].blank?)   ? table_name            : sort_options[:joins].to_s.pluralize
+          clause  = (sort_options[:clause].blank?)  ? "#{table}.#{column}"  : sort_options[:clause]
+          
+          self.sort_columns[sort_name][:clause] = clause if sort_options[:clause].blank?
+          
+          unless sort_options[:default].blank?
+            # TODO: raise exception if the default is not ASC|DESC
+            default_sort_direction = sort_options[:default].upcase
+            self.default_sort_columns[sort_name] = "#{clause} #{default_sort_direction}"
+          end
+          
+        end
+      end
+      
+      def sort(sort_column = nil, sort_direction = DEFAULT_SORT_DIRECTION)
+        query = scoped
+    
+        # sanitize the sort column and direction
+        sort_column     = sort_column.to_s.downcase.to_sym
+        sort_direction  = sort_direction.upcase
+        sort_direction  = (VALID_SORT_DIRECTIONS.include?(sort_direction) ? sort_direction : DEFAULT_SORT_DIRECTION)
+        
+        table_joins   = []
+        order_clauses = []
+        
+        if !sort_column.blank? && sort_columns.include?(sort_column)      
+          join = sort_columns[sort_column][:joins]
+          table_joins   << join unless join.nil?
+          order_clauses << "#{sort_columns[sort_column][:clause]} #{sort_direction}"
+        end
+        
+        default_sorts = default_sort_columns.clone
+        default_sorts.delete(sort_column) unless sort_column.blank? # remove the sort column's default if it exists
+        
+        default_sorts.each do |column_name, sort_clause|
+          join = sort_columns[column_name][:joins]
+          tables_joins  << join unless join.nil?
+          order_clauses << sort_clause
+        end
+        
+        table_joins.uniq!
+        query = query.joins(table_joins) unless table_joins.empty?
+        
+        query = query.order(order_clauses.join(', '))
+        
+        query
+      end
+      
+    end
+  end
+end

data/lib/sort_this/railtie.rb

@@ -0,0 +1,18 @@
+module SortThis
+  class Railtie < Rails::Railtie
+    initializer 'sortable' do |app|
+      ActiveSupport.on_load :active_record do
+        include SortThis::ActiveRecord
+      end
+      
+      ActiveSupport.on_load :action_controller do
+        include SortThis::ActionController
+        helper_method :sort_column, :sort_direction
+      end
+      
+      ActiveSupport.on_load :action_view do
+        include SortThis::ViewHelpers::ActionView
+      end
+    end
+  end
+end

data/lib/sort_this/version.rb

@@ -0,0 +1,3 @@
+module SortThis
+  VERSION = "1.0.0"
+end

data/lib/sort_this/view_helpers/action_view.rb

@@ -0,0 +1,16 @@
+require 'action_view'
+
+module SortThis
+  module ViewHelpers
+    module ActionView
+      
+      def sortable(sort_name, title = nil, html_options = {})
+        title ||= sort_name.titleize
+        css_class = (sort_name == sort_column) ? "sortable-current sortable-#{sort_direction}" : nil
+        direction = (sort_name == sort_column && sort_direction == "asc") ? "desc" : "asc"
+        link_to title, params.merge(:sort => sort_name, :direction => direction), {:class => css_class}.merge(html_options)
+      end
+      
+    end
+  end
+end

data/lib/sort_this.rb

@@ -0,0 +1,12 @@
+require 'sort_this/version'
+require 'sort_this/active_record'
+require 'sort_this/action_controller'
+require 'sort_this/view_helpers/action_view'
+require 'sort_this/railtie' if defined?(Rails)
+
+module SortThis
+  SORT_ASC                = 'ASC'
+  SORT_DESC               = 'DESC'
+  DEFAULT_SORT_DIRECTION  = SORT_ASC
+  VALID_SORT_DIRECTIONS   = [SORT_ASC, SORT_DESC]
+end

data/sort_this.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sort_this/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sort_this"
+  gem.version       = SortThis::VERSION
+  gem.authors       = ["Scott Pullen"]
+  gem.email         = ["s.pullen05@gmail.com"]
+  gem.description   = %q{SortThis}
+  gem.summary       = %q{SortThis}
+  gem.homepage      = "https://github.com/spullen/sort_this"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency 'rails', '>= 3.0'
+  gem.add_dependency 'memoist', '0.2.0'
+  
+  gem.add_development_dependency 'debugger', '1.2.2'
+  gem.add_development_dependency 'rspec', '2.12.0'
+  gem.add_development_dependency 'sqlite3', '1.3.6'
+  gem.add_development_dependency 'factory_girl', '4.1.0'
+  gem.add_development_dependency 'database_cleaner', '0.9.1'
+  gem.add_development_dependency 'capybara', '2.0.1'
+end

data/spec/action_controller_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+class TestController < ActionController::Base
+  include SortThis::ActionController
+  sortable "price"
+  
+  def index
+    render :text => 'OK'
+  end
+end
+
+# get access to the protected methods
+TestController.send(:public, *TestController.protected_instance_methods)
+
+describe SortThis::ActionController do
+  
+  it 'should respond to sortable' do
+    TestController.should respond_to(:sortable)
+  end
+  
+  it 'should set the default sort column' do
+    TestController.default_sort_column.should == "price"
+  end
+  
+  describe 'instance methods' do
+    subject { @controller }
+  
+    before(:each) do
+      @controller = TestController.new
+    end
+    
+    it 'should respond to sort_column' do
+      @controller.should respond_to(:sort_column)
+    end
+    
+    it 'should respond to sort_direction' do
+      @controller.should respond_to(:sort_direction)
+    end
+    
+    describe '#sort_column' do
+      context 'given that the sort param is not set' do
+        it 'should return the default sort column' do
+          @controller.stub!(:params).and_return({})
+          @controller.sort_column.should == "price"
+        end
+      end
+      
+      context 'given that the sort param is set' do
+        it 'should return the sort provided by the params' do
+          sort = "quantity"
+          @controller.stub!(:params).and_return({:sort => sort})
+          @controller.sort_column.should == sort
+        end
+      end
+    end
+    
+    describe '#sort_direction' do
+      context 'given that the direction param is not set' do
+        it 'should return the default sort direction' do
+          @controller.stub!(:params).and_return({})
+          @controller.sort_direction.should == "asc"
+        end
+      end
+      
+      context 'given that the direction param is set' do
+        it 'should return the sort direction provided by the params' do
+          @controller.stub!(:params).and_return({:direction => "desc"})
+          @controller.sort_direction.should == "desc"
+        end
+        
+        context 'when the param is invalid' do
+          it 'should return the default sort direction' do
+            @controller.stub!(:params).and_return({})
+            @controller.sort_direction.should == "asc"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/active_record_spec.rb

@@ -0,0 +1,219 @@
+require 'spec_helper'
+
+describe SortThis::ActiveRecord do
+
+  before(:all) do
+    setup_db
+    DatabaseCleaner.strategy = :truncation
+  end
+  
+  after(:all) do
+    teardown_db
+  end
+  
+  before(:each) do
+    DatabaseCleaner.start
+  end
+
+  after(:each) do
+    DatabaseCleaner.clean
+  end
+  
+  it 'should have a sort_this class method' do
+    Quote.should respond_to(:sort_this)
+  end
+  
+  it 'should have a sort class method' do
+    Quote.should respond_to(:sort)
+  end
+  
+  describe '.sort_this' do
+  
+    shared_examples_for 'sort_columns_defined' do
+      it 'should set the sort_columns options for the specified sort name' do
+        Quote.sort_columns.should have_key(sort_name)
+      end
+      
+      describe 'sort_columns for the specified sort name' do
+        it 'should properly set the column_name option' do
+          Quote.sort_columns[sort_name][:column_name].should == column_name_option
+        end
+        
+        it 'should properly set the default option' do
+          Quote.sort_columns[sort_name][:default].should == default_option
+        end
+        
+        it 'should properly set the joins option' do
+          Quote.sort_columns[sort_name][:joins].should == joins_option
+        end
+        
+        it 'should properly set the clause option' do
+          Quote.sort_columns[sort_name][:clause].should == clause_option      
+        end
+      end
+    end
+    
+    context 'given no parameters' do
+      before(:each) do
+        Quote.sort_this()
+      end
+    
+      it 'should set sort_columns to an empty hash' do
+        Quote.sort_columns.should == {}
+      end
+      
+      it 'should set default_sort_columns to an empty hash' do
+        Quote.default_sort_columns.should == {}
+      end
+    end
+    
+    context 'given a sort column with just the required sort options' do
+      let!(:sort_name)          { :price }
+      let!(:column_name_option) { :price }
+      let!(:default_option)     { nil }
+      let!(:joins_option)       { nil }
+      let!(:clause_option)      { "quotes.price" }
+    
+      before(:each) do
+        Quote.sort_this sort_name => {:column_name => column_name_option}
+      end
+      
+      it_should_behave_like 'sort_columns_defined'
+      
+      it 'should set default_sort_columns to an empty hash' do
+        Quote.default_sort_columns.should == {}
+      end
+    end
+    
+    context 'given a sort column with a default specified in the sort options' do
+      let!(:sort_name)          { :price }
+      let!(:column_name_option) { :price }
+      let!(:default_option)     { 'DESC' }
+      let!(:joins_option)       { nil }
+      let!(:clause_option)      { "quotes.price" }
+    
+      before(:each) do
+        Quote.sort_this sort_name => {:column_name => column_name_option, :default => default_option}
+      end
+      
+      it_should_behave_like 'sort_columns_defined'
+      
+      it 'should set the default_sort_columns options for the specified sort name' do
+        Quote.default_sort_columns.should have_key(sort_name)
+      end
+      
+      it 'should set the clause of the default_sort_columns for the specified sort name' do
+        Quote.default_sort_columns[sort_name].should == "#{clause_option} #{default_option}"
+      end
+    end
+    
+    context 'given a sort column with a joins specified in the sort options' do
+      let!(:sort_name)          { :product_name }
+      let!(:column_name_option) { :name }
+      let!(:default_option)     { nil }
+      let!(:joins_option)       { :product }
+      let!(:clause_option)      { "products.name" }
+
+      before(:each) do
+        Quote.sort_this sort_name => {:column_name => column_name_option, :joins => joins_option}
+      end
+      
+      it_should_behave_like 'sort_columns_defined'
+      
+      it 'should set default_sort_columns to an empty hash' do
+        Quote.default_sort_columns.should == {}
+      end
+    end
+    
+    context 'given a sort column with a custom clause specified in the sort options' do
+      let!(:sort_name)          { :price }
+      let!(:column_name_option) { :price }
+      let!(:default_option)     { nil }
+      let!(:joins_option)       { nil }
+      let!(:clause_option)      { "custom.joins_clause" }
+    
+      before(:each) do
+        Quote.sort_this sort_name => {:column_name => column_name_option, :clause => clause_option}
+      end
+      
+      it_should_behave_like 'sort_columns_defined'
+      
+      it 'should set default_sort_columns to an empty hash' do
+        Quote.default_sort_columns.should == {}
+      end
+    end
+    
+    context 'given a sort column with a custom clause and default specified in the sort options' do
+      let!(:sort_name)          { :quantity }
+      let!(:column_name_option) { :quantity }
+      let!(:default_option)     { 'DESC' }
+      let!(:joins_option)       { nil }
+      let!(:clause_option)      { "custom.joins_clause" }
+    
+      before(:each) do
+        Quote.sort_this sort_name => {:column_name => column_name_option, :default => default_option, :clause => clause_option}
+      end
+      
+      it_should_behave_like 'sort_columns_defined'
+      
+      it 'should set the default_sort_columns options for the specified sort name' do
+        Quote.default_sort_columns.should have_key(sort_name)
+      end
+      
+      it 'should set the clause of the default_sort_columns for the specified sort name' do
+        Quote.default_sort_columns[sort_name].should == "#{clause_option} #{default_option}"
+      end
+    end
+  end
+  
+  describe '.sort' do
+    let!(:product1) { create(:product, :name => 'D Name') }
+    let!(:product2) { create(:product, :name => 'B Name') }
+    let!(:product3) { create(:product, :name => 'A Name') }
+    let!(:product4) { create(:product, :name => 'C Name') }
+    
+    let!(:vendor1) { create(:vendor, :name => 'D Name') }
+    let!(:vendor2) { create(:vendor, :name => 'B Name') }
+    let!(:vendor3) { create(:vendor, :name => 'A Name') }
+    let!(:vendor4) { create(:vendor, :name => 'C Name') }
+    
+    let!(:quote1) { create(:quote, :product => product1, :vendor => vendor4, :price => 10.55, :quantity => 4) }
+    let!(:quote2) { create(:quote, :product => product3, :vendor => vendor2, :price => 9.31, :quantity => 2) }
+    let!(:quote3) { create(:quote, :product => product2, :vendor => vendor1, :price => 8.25, :quantity => 10) }
+    let!(:quote4) { create(:quote, :product => product4, :vendor => vendor3, :price => 15.12, :quantity => 8) } 
+  
+    before(:each) do
+      Quote.sort_this :price         => {:column_name => :price, :default => 'ASC'},
+                      :quantity      => {:column_name => :quantity},
+                      :product_name  => {:column_name => :name, :joins => :product},
+                      :vendor_name   => {:column_name => :name, :joins => :vendor}
+    end
+    
+    context 'default parameters' do
+      it 'should sort by quote price ascending' do
+        Quote.sort.should == [quote3, quote2, quote1, quote4]
+      end
+    end
+    
+    context 'given a sort column' do
+      context 'without specifying an order' do
+        it 'should sort by the specified column in ascending order' do
+          Quote.sort(:quantity).should == [quote2, quote1, quote4, quote3]
+        end
+      end
+      
+      context 'specifying an order' do
+        it 'should sort by the specified column in descending order' do
+          Quote.sort(:quantity, 'DESC').should == [quote3, quote4, quote1, quote2]
+        end
+      end
+    end
+    
+    context 'given a sort column from another table' do
+      it 'should sort by the specified column in descending order' do
+        Quote.sort(:product_name, 'DESC').should == [quote1, quote4, quote3, quote2]
+      end
+    end
+  end
+  
+end

data/spec/factories.rb

@@ -0,0 +1,18 @@
+FactoryGirl.define do
+
+  factory :product do
+    sequence(:name) { |n| "ProductName#{n}" }
+  end
+  
+  factory :vendor do
+    sequence(:name) { |n| "VendorName#{n}" }
+  end
+  
+  factory :quote do
+    product
+    vendor
+    price 10.99
+    quantity 10
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'debugger'
+require 'sqlite3'
+require 'active_record'
+require 'factory_girl'
+require 'database_cleaner'
+require 'capybara'
+require 'rspec'
+
+require 'sort_this'
+
+Dir[File.expand_path("support/**/*.rb", File.dirname(__FILE__))].each {|f| require f}
+
+FactoryGirl.find_definitions
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/models.rb

@@ -0,0 +1,50 @@
+def setup_db
+  puts "\nSetting up the database...\n"
+  
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+  
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table("products") do |t|
+      t.string   "name"
+    end
+  
+    create_table("quotes") do |t|
+      t.integer  "product_id"
+      t.integer  "vendor_id"
+      t.decimal  "price",      :precision => 10, :scale => 2, :default => 0.0
+      t.integer  "quantity",                                  :default => 0
+    end
+  
+    create_table("vendors") do |t|
+      t.string   "name"
+    end
+  end
+end
+
+def teardown_db
+  puts "\nTearing down the database...\n"
+  
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Product < ActiveRecord::Base
+  has_many :quotes
+end
+
+class Vendor < ActiveRecord::Base
+  has_many :quotes
+end
+
+class Quote < ActiveRecord::Base
+  include SortThis::ActiveRecord
+
+  belongs_to :product
+  belongs_to :vendor
+  
+  #sortable :price         => {:column_name => :price, :default => 'ASC'},
+  #         :quantity      => {:column_name => :quantity},
+  #         :product_name  => {:column_name => :name, :joins => :product},
+  #         :vendor_name   => {:column_name => :name, :joins => :vendor}
+end

data/spec/view_helpers/action_view_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+# there's probably a better way to test this
+# check out https://github.com/mislav/will_paginate/blob/master/spec/view_helpers/action_view_spec.rb#L28
+
+class TestActionView < ActionView::Base
+  include SortThis::ViewHelpers::ActionView
+end
+
+describe SortThis::ViewHelpers::ActionView do
+  
+  let!(:params_base) { {:controller => 'quotes', :action => 'index'} }
+  
+  before(:each) do
+    @helper = TestActionView.new
+    @helper.stub!(:url_for).and_return('/quotes/index')
+    @helper.stub!(:params).and_return(params_base)
+    @helper.stub!(:sort_column).and_return("price")
+    @helper.stub!(:sort_direction).and_return("asc")
+  end
+  
+  describe '#sortable' do
+    context 'given the column is the only specified parameter' do
+      before(:each) do
+        @node = Capybara::Node::Simple.new(@helper.sortable("test"))
+      end
+      
+      it 'should set the title to be the capitalized version of the column name' do
+        @node.should have_content("Test")
+      end
+    end
+    
+    context 'given the sort column is the current column being sorted' do
+      before(:each) do
+        @node = Capybara::Node::Simple.new(@helper.sortable("price"))
+      end
+      
+      it 'should set the sortable-current class' do
+        @node.should have_css('a.sortable-current')
+      end
+      
+      it 'should set the sortable-<direction>' do
+        @node.should have_css('a.sortable-asc')
+      end
+    end
+    
+    context 'given the sort column is not the current column being sorted' do
+      before(:each) do
+        @node = Capybara::Node::Simple.new(@helper.sortable("other_column"))
+      end
+      
+      it 'should set the sortable-current class' do
+        @node.should_not have_css('a.sortable-current')
+      end
+      
+      it 'should set the sortable-<direction>' do
+        @node.should_not have_css('a.sortable-asc')
+      end
+    end
+    
+    context 'given the title is specified' do
+      before(:each) do
+        @node = Capybara::Node::Simple.new(@helper.sortable("column", "Custom Title"))
+      end
+      
+      it 'should set the sortable-current class' do
+        @node.should have_content("Custom Title")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: sort_this
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Scott Pullen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: SortThis
+email:
+- s.pullen05@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sort_this.rb
+- lib/sort_this/action_controller.rb
+- lib/sort_this/active_record.rb
+- lib/sort_this/railtie.rb
+- lib/sort_this/version.rb
+- lib/sort_this/view_helpers/action_view.rb
+- sort_this.gemspec
+- spec/action_controller_spec.rb
+- spec/active_record_spec.rb
+- spec/factories.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+- spec/support/models.rb
+- spec/view_helpers/action_view_spec.rb
+homepage: https://github.com/spullen/sort_this
+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: 2103404262135696406
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2103404262135696406
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: SortThis
+test_files:
+- spec/action_controller_spec.rb
+- spec/active_record_spec.rb
+- spec/factories.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+- spec/support/models.rb
+- spec/view_helpers/action_view_spec.rb