dancroak-sortable_table 0.0.4 → 0.1.0

data/README.markdown

@@ -0,0 +1,72 @@
+Sortable Table
+==============
+
+Rails plugin to sort tables of ActiveRecord data.
+
+Install
+-------
+
+    script/plugin install git://github.com/dancroak/sortable_table.git
+
+Conventions
+-----------
+
+params[:sort] and params[:order]
+
+Examples
+--------
+
+Use the sortable_attributes macro to list the... sortable attributes.
+
+Then, in your index action, pass the sort_order method to your usual
+order parameter for will paginate or named scope call.
+
+    class UsersController < Admin::BaseController
+
+		  sortable_attributes :name, :email
+
+		  def index
+		    @users = User.paginate :page => params[:page], :order => sort_order
+		  end
+		
+		end
+
+Time-saving Shoulda macros for your tests:
+
+    class UsersControllerTest < ActionController::TestCase
+
+    	context 'GET to index with sort and order params' do
+		    setup do
+		      5.times do |each|
+			      Factory :user,
+			        :name => "name #{each}",
+			        :email => "email#{each}@example.com"
+			    end
+		    end
+
+		    should_sort_by :name
+		    should_sort_by :email
+		  end
+		
+		end
+
+And some sugar for your views:
+
+    %h1 Users
+
+		%table
+		  %tr
+		    = sortable_table_header 'Name', :sort => 'name'
+		    = sortable_table_header 'E-mail', :sort => 'email'
+
+		  - @users.each do |each|
+		    %tr
+		      %td= each.name
+		      %td= each.email
+
+Authors
+-------
+
+Dan Croak, Joe Ferris, and Boston.rb.
+
+Copyright (c) 2008 Dan Croak, released under the MIT license

data/Rakefile

@@ -11,21 +11,21 @@ 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}/**/*"]
+  s.files = FileList["[A-Z]*", "{lib,rails,test}/**/*"]
 end
-
-desc "Generate a gemspec file"
-task :gemspec do
-  File.open("#{spec.name}.gemspec", 'w') do |f|
-    f.write spec.to_yaml
-  end
+ 
+begin
+  require 'rubygems'
+  require 'jeweler'
+  Jeweler.gemspec = spec
+rescue LoadError 
+  puts "Jeweler not available. sudo gem install technicalpickles-jeweler --source=http://gems.github.com"
 end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+patch: 0
+major: 0
+minor: 1

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

@@ -2,7 +2,7 @@ module SortableTable
   module App
     module Controllers
       module ApplicationController
-
+  
         def self.included(base)
           base.class_eval do
             include InstanceMethods
@@ -12,33 +12,21 @@ module SortableTable
         
         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)
+            mappings           = args.last.is_a?(Hash) ? args.pop : {}
+            acceptable_columns = args.collect(&:to_s) + mappings.keys.collect(&:to_s)
+
             define_method(:sort_order) do |*default| 
-              direction = params[:order] == 'ascending' ? 'asc' : 'desc'
-              column    = params[:sort] || acceptable_columns.first
+              direction = if params[:order]
+                params[:order] == 'ascending' ? 'asc' : 'desc'
+              else
+                default_sort_direction(default)
+              end
+              column    = params[:sort] || 'created_at'
               if params[:sort] && acceptable_columns.include?(column)
                 column = mappings[column.to_sym] || column
-                handle_compound_sorting(column, direction)
+                "#{column} #{direction}"
               else
-                "#{acceptable_columns.first} #{default_sort_direction(default)}"
+                "#{acceptable_columns.first} #{direction}"
               end
             end
           end
@@ -46,30 +34,10 @@ module SortableTable
         
         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(',')
+            if default.any? && default.first.is_a?(Hash) && default.first.has_key?(:default)
+              default.first[:default] == 'ascending' ? 'asc' : 'desc'
             else
-              "#{column} #{direction}"
+              'desc'  
             end
           end
         end

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

@@ -10,49 +10,53 @@ module SortableTable
         end
         
         module InstanceMethods
-          def sortable_table_header(opts = {})
-            raise ArgumentError if opts[:name].nil? || opts[:sort].nil?
-            anchor = opts[:anchor].blank? ? "" : "##{opts[:anchor]}"
+          def sortable_table_header(*args)
+            opts = args.extract_options!
+
+            inner_html = args
+            if inner_html.blank?
+              raise ArgumentError("Must specify inner_html as first argument")
+            end
+
+            # if args.first.is_a?(String)
+            #   inner_html = args.shift
+            # elsif opts.first.is_a?(Hash)
+            #   if opts.has_key?(:inner_html)
+            #     inner_html = opts[:inner_html]
+            #   else
+            #     # raise ArgumentError unless opts.has_key?(:sort)
+            #     inner_html = opts[:sort].humanize
+            #   end
+            # else
+            #   raise ArgumentError, 
+            #     "calling signature must be String, Hash or Hash"
+            # end
+
+            # anchor = opts[:anchor].blank? ? "" : "##{opts[:anchor]}"
+            # sortable_url(opts) + anchor
+
             content_tag :th, 
-              link_to(opts[:name], 
-                sortable_url(opts) + anchor, 
+              link_to(inner_html, 
+                sortable_url(opts), 
                 :title => opts[:title]),
-              :class => sortable_table_header_classes(opts)
+              :class => class_name_for_sortable_table_header_tag(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)
+          def class_name_for_sortable_table_header_tag(opts)
             if default_sort_to_most_recent? opts
-              'descending'
+              class_name = 'descending'
             elsif re_sort? opts
-              params[:order]
+              class_name = params[:order]
             else
-              nil
+              class_name = ""
             end
+            class_name << " #{opts[:class_name]}"
           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'
@@ -62,6 +66,18 @@ module SortableTable
               'ascending'
             end
           end
+
+          def default_sort_to_most_recent?(opts)
+            params[:sort].nil? && opts[:sort] == @sorted_column
+          end
+
+          def re_sort?(opts)
+            params[:sort] == opts[:sort]
+          end
+
+          def reverse_order(order)
+            order == 'ascending' ? 'descending' : 'ascending'
+          end  
         end
         
       end

data/lib/sortable_table/test/test_helper.rb

@@ -0,0 +1,65 @@
+module SortableTable 
+  module Test
+    module TestHelper
+    
+      def self.included(base)
+        base.class_eval do
+          include InstanceMethods
+          extend ClassMethods
+        end
+      end
+
+      module InstanceMethods
+        def stubbed_action_view
+          view = ActionView::Base.new(@controller.class.view_paths, {}, @controller)
+          yield view
+          ActionView::Base.stubs(:new).returns(view)
+        end
+      end
+    
+      module ClassMethods
+        def should_sort_by(attribute, params = {}, &block)
+          collection = self.name.underscore.gsub(/_controller_test/, '')
+          collection.slice!(0..collection.rindex('/')) if collection.include?('/')
+          collection = collection.to_sym
+          model_name = collection.to_s.singularize.camelize.constantize
+          block ||= attribute
+
+          %w(ascending descending).each do |direction|
+            should "sort by #{attribute.to_s} #{direction}" do
+              assert_not_nil model_name.find(:all).any?,
+                "#{model_name}.find(:all) is nil"
+
+              get :index, :sort => attribute.to_s, :order => direction
+
+              # controller tests
+
+              assert_not_nil assigns(collection), 
+                "assigns(:#{collection}) is nil"
+              assert assigns(collection).size >= 2, 
+                "cannot test sorting without at least 2 sortable objects"
+
+              expected = assigns(collection).sort_by(&block)
+              expected = expected.reverse if direction == 'descending'
+
+              assert expected == assigns(collection), 
+                "expected - #{expected.map(&block).inspect}," <<
+                " but was - #{assigns(collection).map(&block).inspect}"
+
+              # view tests
+
+              view_helper_error_message = "Include the sortable_table_header" <<
+                " helper in your view with the option :sort => '#{attribute}'"
+
+              assert_select "th" do
+                assert_select "a[href*=?]", "sort=#{attribute.to_s}", 
+                  true, view_helper_error_message
+              end
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/sortable_table.rb

@@ -1,2 +1,3 @@
 require "sortable_table/app/controllers/application_controller"
 require "sortable_table/app/helpers/application_helper"
+require "sortable_table/test/test_helper"

data/test/rails_root/Rakefile

@@ -0,0 +1,10 @@
+# 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.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/test/rails_root/app/controllers/application.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  helper :all
+  protect_from_forgery
+  include SortableTable::App::Controllers::ApplicationController
+end

data/test/rails_root/app/controllers/users_controller.rb

@@ -0,0 +1,9 @@
+class UsersController < ApplicationController
+  
+  sortable_attributes :name, :age, :email => 'users.email'
+  
+  def index
+    @users = User.find :all#, :order => sort_order('ascending')
+  end
+
+end

data/test/rails_root/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+module ApplicationHelper
+  include SortableTable::App::Helpers::ApplicationHelper
+end

data/test/rails_root/app/helpers/users_helper.rb

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

data/test/rails_root/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/test/rails_root/app/views/layouts/users.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>Users: <%= controller.action_name %></title>
+  <%= stylesheet_link_tag 'scaffold', 'sortable' %>
+</head>
+<body>
+
+<p style="color: green"><%= flash[:notice] %></p>
+
+<%= yield  %>
+
+</body>
+</html>

data/test/rails_root/app/views/users/index.html.erb

@@ -0,0 +1,19 @@
+<h1>Users</h1>
+
+<table>
+  <tr>
+    <%= sortable_table_header 'Name', :sort => 'name' %>
+    <%= sortable_table_header 'Email', :sort => 'email' %>
+    <%= sortable_table_header 'Age', :sort => 'age' %>
+    <th>Created On</th>
+  </tr>
+
+<% @users.each do |user| %>
+  <tr>
+    <td><%=h user.name %></td>
+    <td><%=h user.email %></td>
+    <td><%=h user.age %></td>
+    <td><%=h user.created_at.to_s %></td>
+  </tr>
+<% end %>
+</table>

data/test/rails_root/config/boot.rb

@@ -0,0 +1,109 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion if defined? Gem::RubyGemsVersion
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+
+        unless rubygems_version >= '0.9.4'
+          $stderr.puts %(Rails requires RubyGems >= 0.9.4 (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %(Rails requires RubyGems >= 0.9.4. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/rails_root/config/database.yml

@@ -0,0 +1,19 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  timeout: 5000

data/test/rails_root/config/environment.rb

@@ -0,0 +1,26 @@
+# Be sure to restart your server when you modify this file
+
+# Uncomment below to force Rails into production mode when
+# you don't control web/app server and can't set it the proper way
+# ENV['RAILS_ENV'] ||= 'production'
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.1.0' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  
+  config.time_zone = 'UTC'
+
+  # Your secret key for verifying cookie session data integrity.
+  # If you change this key, all old sessions will become invalid!
+  # Make sure the secret is at least 30 characters and all random, 
+  # no regular words or you'll be exposed to dictionary attacks.
+  config.action_controller.session = {
+    :session_key => '_rails_root_session',
+    :secret      => '6042b566bbfa8e55bdb33a4b3b39b3c373e035c0a87b587a614db4c8bfea19a7adbd49f2098d4c995e37b28f6539e309f4bc5885cf023b47d5fe9d4450be2d46'
+  }
+
+end

data/test/rails_root/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/test/rails_root/config/environments/test.rb

@@ -0,0 +1,22 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test

data/test/rails_root/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,15 @@
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+# Include Active Record class name as root for JSON serialized output.
+ActiveRecord::Base.include_root_in_json = true
+
+# Store the full class name (including module namespace) in STI type column.
+ActiveRecord::Base.store_full_sti_class = true
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/test/rails_root/config/routes.rb

@@ -0,0 +1,6 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :users
+
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end