column_sort 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 0.0.1
+
+* Basic features complete

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.4)
+  rcov
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jeremiah Hemphill
+
+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.rdoc

@@ -0,0 +1,51 @@
+= column_sort
+
+Sort columns for index pages on admins.
+
+== Installation
+
+Add to your Gemfile
+
+    gem "column_sort"
+
+Mark sortable fields in the model
+
+    class Person < ActiveRecord::Base
+
+      scope :column_sort_first_name_asc, lambda { order("people.first_name ASC")  }
+      scope :column_sort_first_name_desc, lambda { order("people.first_name DESC")  }
+      ...
+      sortable_fields [:first_name, :last_name, :date_of_birth]
+
+* IMPORTANT NOTE: the sortable fields call must go after all of the sorting scopes due to ruby mixin load order
+* Complex sorts can always be added with the syntax scope :column_sort_<fieldname>_asc
+
+Add the sorting scope to the query in the controller and set a default sort (optional)
+
+    class PeopleController < ApplicationController
+      def index
+        default_column_sort(:last_name)
+        @people = Person.active.column_sort(params[:column_sort])
+      end
+
+Use the helper on the view to link to sorted links to the page
+
+    %table
+      %th
+        First Name
+        = column_sort :first_name
+
+== Contributing to column_sort
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Jeremiah Hemphill. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "column_sort"
+  gem.homepage = "http://github.com/jeremiahishere/column_sort"
+  gem.license = "MIT"
+  gem.summary = "Column sorting for index pages" 
+  gem.description = "Column sorting for index pages"
+  gem.email = "jeremiah@cloudspace.com"
+  gem.authors = ["Jeremiah Hemphill"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "column_sort #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/column_sort.rb

@@ -0,0 +1,2 @@
+require "column_sort/railtie"
+# require "column_sort/engine"

data/lib/column_sort/column_sort_helper.rb

@@ -0,0 +1,58 @@
+module ColumnSort
+  module ColumnSortHelper
+
+    # Sets the default column sort for the view
+    # Updates the params directly
+    # 
+    # @param [String or Symbol] column The name of the sort column
+    # @param [String or Symbol] column The direction of the sort
+    def set_default_column_sort(column, direction)
+      if params.present?
+        if params[:column_sort].nil?
+          params[:column_sort] = { 
+            :column => column,
+            :direction => direction
+          }   
+        end 
+      end 
+    end 
+
+    # Generates a link that sorts the page based on the current params
+    #
+    # @param [Symbol] column_symbol The name of the sort column
+    # @param [String] column_name Display name for the sort column, defaults to the titlezed sort column
+    #
+    # @return [String] Link back to the current page with the new sorting parameters
+    def column_sort_link(column_symbol, column_name = nil)
+      # default column name to column symbol titleized
+      column_name = column_symbol.to_s.titleize if column_name.nil?
+
+      # set default link attributes
+      # note that we default to ascending search
+      link_attributes = {:column_sort => { :column => column_symbol, :direction => "asc" }}
+
+      # start building the link text
+      link_text = column_name
+      if params[:column_sort].present?
+        if params[:column_sort][:column].to_s == column_symbol.to_s
+          # if sorting on the current column, add an arrow for the current direction and make the link sort in the opposite direction
+          if params[:column_sort][:direction].to_s == "desc"
+            link_text += '▼' # ▼
+            link_attributes[:column_sort][:direction] = "asc"
+          else
+            link_text += '▲' # ▲
+            link_attributes[:column_sort][:direction] = "desc"
+          end 
+        else
+          # if not sorting on the current column, add a diamond and use the default sort direction
+          link_text += ' ♦' # ♦
+        end 
+      else
+        # if no sort is specified, add a diamond and use the default sort direction
+        link_text += ' ♦' # ♦
+      end 
+      # return html string for an a tag with the correct request parameters
+      link_to link_text.html_safe, link_attributes 
+    end 
+  end
+end

data/lib/column_sort/column_sort_in_model.rb

@@ -0,0 +1,67 @@
+module ColumnSort
+  module ColumnSortInModel
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      # Set the different types of sorts the front end can call
+      #
+      # This method is used to ensure that whatever sort is called from the column_sort scope will not
+      # trigger a missing method exception.  This will throw exceptions for the missing scopes when the
+      # application.  Additionally, sorts that are not included in this list will not be executed when 
+      # column_sort is called.  Taking strings from a params hash and directly converting them to method
+      # names without any security is a little scary.
+      #
+      # This method is optional.  If it is not called, column_sort will blindly attempt to call any scope
+      # given to it.
+      #
+      # @param [Array] An array of column names
+      def sortable_columns(columns)
+        columns = [columns] unless columns.is_a? Array
+        mattr_accessor :sortable_column_list
+        self.sortable_column_list = columns
+
+        columns.each do |column|
+          if !self.respond_to?("column_sort_#{column}_asc") || !self.respond_to?("column_sort_#{column}_desc")
+            throw "Missing sort scope for #{column}"
+          end 
+        end 
+      end 
+
+      # Calls a sorting scope based on the given parameters
+      #
+      # If the column and direction parameters are set, attempt to find a matching scope and call it.
+      # Otherwise, returns a chainable object that does not affect the outcome of the query.
+      #
+      # See the sortable_columns method for more information on how this works.
+      #
+      #
+      # @params [Hash] params A hash with two optional keys, column and direction
+      def column_sort(params)
+        # if parameters are present, attempt to run a scope, otherwise add an empty where
+        if params.present? && params[:column].present? && params[:direction].present?
+          # if sortable_column_list is empty, just run the scope
+          # otherwise, check if the parameters match the values in sortable_column_list
+          if sortable_column_list.nil?
+            scope_name = "column_sort_#{params[:column]}_#{params[:direction]}".downcase
+            send(scope_name)
+          else
+            # if sortable_column_list is not empty, check to make sure the column is a member of the list 
+            # before continuing
+            if !sortable_column_list.include?(params[:column].to_sym) || params[:direction].nil?
+              where({}) 
+            else
+              scope_name = "column_sort_#{params[:column]}_#{params[:direction]}".downcase
+              send(scope_name)
+            end 
+          end 
+        else
+          where({})
+        end 
+      end 
+    end
+  end
+end

data/lib/column_sort/engine.rb

@@ -0,0 +1,6 @@
+# no engine needed for now
+
+# module ColumnSort
+#   class Engine < ::Rails::Engine
+#   end
+# end

data/lib/column_sort/railtie.rb

@@ -0,0 +1,21 @@
+require 'rails'
+
+# no config for now
+# require 'column_sort/config'
+
+module ColumnSort 
+  class Railtie < ::Rails::Railtie
+    initializer 'column_sort' do |app|
+      require "column_sort/column_sort_in_model"
+      ActiveRecord::Base.send :include, ColumnSort::ColumnSortInModel
+
+      # note that the helpers are required in both views and controllers
+      # There is a way in rails to make helpers available in controllers but I am
+      # not sure how to use it here.  A potentially better way to do this is to convert
+      # the gem to an engine and put it in app/helpers/column_sort/
+      require "column_sort/column_sort_helper"
+      ActionView::Base.send :include, ColumnSort::ColumnSortHelper
+      ActionController::Base.send :include, ColumnSort::ColumnSortHelper
+    end
+  end
+end

data/spec/column_sort_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ColumnSort" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "column_sort"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end