ryana-sortable_table 0.2.0

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,86 @@
+h1. Sortable Table
+
+Sort HTML tables in a Rails app.
+
+h2. Install
+
+    script/plugin install git://github.com/dancroak/sortable_table.git
+
+In test/test_helper.rb: 
+
+    class Test::Unit::TestCase
+      include SortableTable::Test::TestHelper
+    end
+
+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. Conventions
+
+params[:sort] and params[:order]
+
+h2. 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 => 'Name', :sort => 'name'
+        = sortable_table_header :name => '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

@@ -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.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,test}/**/*"]
+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: 2

data/lib/sortable_table.rb

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

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

@@ -0,0 +1,46 @@
+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           = 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] || 'created_on'
+              if params[:sort] && acceptable_columns.include?(column)
+                column = mappings[column.to_sym] || column
+                "#{column} #{direction}"
+              else
+                "#{acceptable_columns.first} #{default_sort_direction(default)}"
+              end
+            end
+          end
+        end
+        
+        module InstanceMethods
+          def default_sort_direction(default)
+            if default.any? && default.first.is_a?(Hash) && default.first.has_key?(:default)
+              default.first[:default] == 'ascending' ? 'asc' : 'desc'
+            else
+              'desc'  
+            end
+          end
+        end
+
+      end
+    end
+  end  
+end
+
+

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

@@ -0,0 +1,69 @@
+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(name_with_desc(opts), 
+                sortable_url(opts) + anchor, 
+                :title => opts[:title]),
+              :class => class_name_for_sortable_table_header_tag(opts)
+          end
+          
+          def class_name_for_sortable_table_header_tag(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 name_with_desc(opts)
+            return opts[:name] unless opts[:sort] == params[:sort]
+  
+            link_sort_order(opts) == 'descending' ? opts[:name] + " (asc)" : opts[:name] + " (desc)"
+          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/test/test_helper.rb

@@ -0,0 +1,50 @@
+module SortableTable 
+  module Test
+    module TestHelper
+    
+      def self.included(base)
+        base.class_eval do
+          extend ClassMethods
+        end
+      end
+    
+      module ClassMethods
+        def should_sort_by(attribute, &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
+          
+          if !block
+            if model_name.columns.select{|c| c.name == attribute.to_s }.first.type == :boolean
+              block = lambda{|x| x.send(attribute).to_s } 
+            end
+            block ||= attribute
+          end
+
+          %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
+
+              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.map(&block) == assigns(collection).map(&block), 
+                "expected - #{expected.map(&block).inspect}," <<
+                " but was - #{assigns(collection).map(&block).inspect}"
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/rails/init.rb

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

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 => 'Name', :sort => 'name' %>
+    <%= sortable_table_header :name => 'Email', :sort => 'email' %>
+    <%= sortable_table_header :name => '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!