dancroak-sortable_table 0.0.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Dan Croak
+
+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.textile

@@ -0,0 +1,136 @@
+h1. Sortable Table
+
+Sort HTML tables in a Rails app.
+
+h2. Install
+
+    script/plugin install git://github.com/dancroak/sortable_table.git
+
+In app/controllers/application_controller.rb:
+
+    class ApplicationController < ActionController::Base
+      include SortableTable::App::Controllers::ApplicationController
+    end
+
+In app/helpers/application_helper.rb:
+
+    module ApplicationHelper
+      include SortableTable::App::Helpers::ApplicationHelper
+    end
+
+h2. Testing
+
+    context "enough Users to sort" do
+      setup do 
+        5.times { Factory :user }
+      end
+
+      should_sort_by_attributes :name, :email, :age, :group => "groups.name"
+
+      context "GET to #index" do
+        setup { get :index }
+
+        should_display_sortable_table_header_for :name, :email, :age, :group
+      end
+    end
+
+This is the common case for a RESTful UsersController.
+
+* should_sort_by_attributes tests that the controller's index action can sort by the attributes.
+* should_display_sortable_header_for tests that a sortable header displays for the attributes.
+
+h2. Controller
+
+    class UsersController < Admin::BaseController
+      sortable_attributes :name, :email, :age, :group => "groups.name"
+
+      def index
+        @users = User.paginate :page => params[:page], :order => sort_order
+      end
+    end
+
+sortable_attributes defines a sort_order method that gets called in your action.
+
+If the index action is rendered without a params[:sort] option, @users will be sorted by :name, the first option in the list of sortable_attributes.
+
+h2. View
+
+<pre><code>
+  <h1>Users</h1>
+  <table>
+    <tr>
+      <%= sortable_table_header :name => "Name",  :sort => "name" %>
+      <%= sortable_table_header :name => "Email", :sort => "email" %>
+      <%= sortable_table_header :name => "Age",   :sort => "age" %>
+      <%= sortable_table_header :name => "Group", :sort => "group" %>
+    </tr>
+    <% @users.each do |user| %>
+      <tr>
+        <td><%= html_escape(user.name) %></td>
+        <td><%= html_escape(user.email) %></td>
+        <td><%= html_escape(user.age) %></td>
+        <td><%= html_escape(user.group.name) %></td>
+      </tr>
+    <% end %>
+  </table>
+</code></pre>
+
+sortable_table_header creates a table header containing a link with the correct :sort and :order params. It also has a class of "ascending" or "descending" so you can add styles with arrows.
+
+h2. Example styles
+
+		th.ascending a {
+		  background: url(/images/sort-ascending-arrow.gif) 0% 50% no-repeat;
+		  padding-left: 15px;
+		}
+		
+		th.descending a {
+		  background: url(/images/sort-descending-arrow.gif) 0% 50% no-repeat;
+		  padding-left: 15px;
+		}
+
+h2. Overriding defaults
+
+h3. should_sort_by_attributes 
+
+Opinionated defaults:
+
+* GET to :index
+* collection same name as controller (@users for UsersController)
+* model name same name as controller (User for UsersController
+
+If you need to test another action (or a nested controller), pass a block:
+
+    should_sort_by_attributes :age do |sort, order|
+      get :show, :sort => sort, :order => order, :group_id => @group.id
+    end
+
+If you need to test another collection or model name, use should_sort_by.
+
+h3. should_sort_by
+
+The :collection, :model_name, and :action options of should_sort_by.
+
+    context "with a non-standard collection name" do
+      action = lambda { |sort, order| get :members, :sort => sort, :order => order }
+      should_sort_by :name, { :collection => "members", 
+                              :model_name => "user",
+                              :action     => action } do |user|
+        user.name
+      end
+    end
+
+h3. sort_order
+
+The default sort order is descending. This applies to the first time you click on a table header. You can override this to be ascending:
+
+    def index
+	    @users = User.find :all, :order => sort_order("ascending")
+	  end
+
+Authors
+-------
+
+Dan Croak, Joe Ferris, Jason Morrison and Boston.rb.
+
+Copyright (c) 2008 Dan Croak, released under the MIT license

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rake'
+require 'rake/testtask'
+require 'date'
+ 
+test_files_pattern = 'test/rails_root/test/{unit,functional,other}/**/*_test.rb'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = test_files_pattern
+  t.verbose = false
+end
+ 
+desc "Run the test suite"
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.version = '0.0.4'
+  s.name = "sortable_table"
+  s.summary = "Sort HTML tables in a Rails app."
+  s.email = "dcroak@thoughtbot.com"
+  s.homepage = "http://github.com/dancroak/sortable_table"
+  s.description = "Sort HTML tables in a Rails app."
+  s.authors = ["Dan Croak", "Joe Ferris", "Boston.rb"]
+  s.files = FileList["[A-Z]*", "{lib,rails}/**/*"]
+end
+
+desc "Generate a gemspec file"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_yaml
+  end
+end

data/TODO.textile

@@ -0,0 +1,2 @@
+* replace created_on with created_at
+

data/lib/sortable_table/app/controllers/application_controller.rb

@@ -0,0 +1,82 @@
+module SortableTable
+  module App
+    module Controllers
+      module ApplicationController
+
+        def self.included(base)
+          base.class_eval do
+            include InstanceMethods
+            extend ClassMethods
+          end
+        end
+        
+        module ClassMethods
+          def sortable_attributes(*args)
+            mappings           = pop_hash_from_list(args)
+            acceptable_columns = join_array_and_hash_values(args, mappings)
+            define_sort_order(acceptable_columns, mappings)
+          end
+          
+          def pop_hash_from_list(*args)
+            if args.last.is_a?(Hash)
+              args.pop
+            else
+              {}
+            end
+          end
+          
+          def join_array_and_hash_values(array, hash)
+            array.collect { |each| each.to_s } + 
+              hash.values.collect { |each| each.to_s }
+          end
+          
+          def define_sort_order(acceptable_columns, mappings)
+            define_method(:sort_order) do |*default| 
+              direction = params[:order] == 'ascending' ? 'asc' : 'desc'
+              column    = params[:sort] || acceptable_columns.first
+              if params[:sort] && acceptable_columns.include?(column)
+                column = mappings[column.to_sym] || column
+                handle_compound_sorting(column, direction)
+              else
+                "#{acceptable_columns.first} #{default_sort_direction(default)}"
+              end
+            end
+          end
+        end
+        
+        module InstanceMethods
+          def default_sort_direction(default)
+            if hash_with_default_key?(default)
+              case default.first[:default]
+              when "ascending",  "asc" then "asc"
+              when "descending", "asc" then "desc"
+              else
+                raise RuntimeError, 
+                  "valid :default sort orders are 'ascending' & 'descending'"
+              end
+            else
+              "desc"  
+            end
+          end
+          
+          def hash_with_default_key?(object)
+            object.any? && 
+              object.first.is_a?(Hash) && 
+              object.first.has_key?(:default)
+          end
+          
+          def handle_compound_sorting(column, direction)
+            if column.is_a?(Array)
+              column.collect { |each| "#{each} #{direction}" }.join(',')
+            else
+              "#{column} #{direction}"
+            end
+          end
+        end
+
+      end
+    end
+  end  
+end
+
+

data/lib/sortable_table/app/helpers/application_helper.rb

@@ -0,0 +1,70 @@
+module SortableTable
+  module App
+    module Helpers
+      module ApplicationHelper
+      
+        def self.included(base)
+          base.class_eval do
+            include InstanceMethods
+          end
+        end
+        
+        module InstanceMethods
+          def sortable_table_header(opts = {})
+            raise ArgumentError if opts[:name].nil? || opts[:sort].nil?
+            anchor = opts[:anchor].blank? ? "" : "##{opts[:anchor]}"
+            content_tag :th, 
+              link_to(opts[:name], 
+                sortable_url(opts) + anchor, 
+                :title => opts[:title]),
+              :class => sortable_table_header_classes(opts)
+          end
+
+          def sortable_table_header_classes(opts)
+            class_names = []
+            class_names << sortable_table_header_class(opts) 
+            class_names << opts[:class]
+            class_names.compact.blank? ? nil : class_names.compact.join(" ")
+          end
+          
+          def sortable_table_header_class(opts)
+            if default_sort_to_most_recent? opts
+              'descending'
+            elsif re_sort? opts
+              params[:order]
+            else
+              nil
+            end
+          end
+          
+          def default_sort_to_most_recent?(opts)
+            params[:sort].nil? && opts[:sort] == 'date'
+          end
+          
+          def re_sort?(opts)
+            params[:sort] == opts[:sort]
+          end
+          
+          def reverse_order(order)
+            order == 'ascending' ? 'descending' : 'ascending'
+          end
+          
+          def sortable_url(opts)
+            url_for(params.merge(:sort => opts[:sort], :order => link_sort_order(opts), :page => 1))
+          end
+          
+          def link_sort_order(opts)
+            if default_sort_to_most_recent? opts
+              'ascending'
+            elsif re_sort? opts
+              reverse_order params[:order]
+            else
+              'ascending'
+            end
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/sortable_table.rb

@@ -0,0 +1,2 @@
+require "sortable_table/app/controllers/application_controller"
+require "sortable_table/app/helpers/application_helper"

data/rails/init.rb

@@ -0,0 +1 @@
+require "sortable_table"

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: dancroak-sortable_table
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Dan Croak
+- Joe Ferris
+- Boston.rb
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-01 21:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Sort HTML tables in a Rails app.
+email: dcroak@thoughtbot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- Rakefile
+- README.textile
+- TODO.textile
+- lib/sortable_table
+- lib/sortable_table/app
+- lib/sortable_table/app/controllers
+- lib/sortable_table/app/controllers/application_controller.rb
+- lib/sortable_table/app/helpers
+- lib/sortable_table/app/helpers/application_helper.rb
+- lib/sortable_table.rb
+- rails/init.rb
+has_rdoc: false
+homepage: http://github.com/dancroak/sortable_table
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Sort HTML tables in a Rails app.
+test_files: []
+