dancroak-sortable_table 0.1.1 → 0.2.0

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/VERSION.yml

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

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

@@ -20,3 +20,9 @@ config.action_controller.allow_forgery_protection    = false
 # The :test delivery method accumulates sent emails in the
 # ActionMailer::Base.deliveries array.
 config.action_mailer.delivery_method = :test
+
+require 'mocha'
+require 'quietbacktrace'
+require 'shoulda'
+require 'factory_girl'
+require 'redgreen'

data/test/rails_root/log/test.log

@@ -690,3 +690,75 @@ Processing UsersController#index (for 0.0.0.0 at 2008-10-16 15:21:37) [GET]
 Rendering template within layouts/users
 Rendering users/index
 Completed in 0.00504 (198 reqs/sec) | Rendering: 0.00305 (60%) | DB: 0.00258 (51%) | 200 OK [http://test.host/users?order=descending&sort=name]
+  User Create (0.000534)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name1', '2008-10-16 20:12:20', NULL, 1, 'email1@example.com', '2008-10-16 20:12:20')
+  User Create (0.000111)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name2', '2008-10-16 20:12:20', NULL, 2, 'email2@example.com', '2008-10-16 20:12:20')
+  User Load (0.000499)   SELECT * FROM "users" 
+
+
+Processing UsersController#index (for 0.0.0.0 at 2008-10-16 16:12:20) [GET]
+  Session ID: 
+  Parameters: {"order"=>"ascending", "action"=>"index", "controller"=>"users", "sort"=>"age"}
+  User Load (0.001521)   SELECT * FROM "users" ORDER BY age asc
+Rendering template within layouts/users
+Rendering users/index
+Completed in 0.04991 (20 reqs/sec) | Rendering: 0.04470 (89%) | DB: 0.00266 (5%) | 200 OK [http://test.host/users?order=ascending&sort=age]
+  User Create (0.000524)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name3', '2008-10-16 20:12:20', NULL, 3, 'email3@example.com', '2008-10-16 20:12:20')
+  User Create (0.000182)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name4', '2008-10-16 20:12:20', NULL, 4, 'email4@example.com', '2008-10-16 20:12:20')
+  User Load (0.000692)   SELECT * FROM "users" 
+
+
+Processing UsersController#index (for 0.0.0.0 at 2008-10-16 16:12:20) [GET]
+  Session ID: 
+  Parameters: {"order"=>"descending", "action"=>"index", "controller"=>"users", "sort"=>"age"}
+  User Load (0.001342)   SELECT * FROM "users" ORDER BY age desc
+Rendering template within layouts/users
+Rendering users/index
+Completed in 0.09649 (10 reqs/sec) | Rendering: 0.09439 (97%) | DB: 0.00274 (2%) | 200 OK [http://test.host/users?order=descending&sort=age]
+  User Create (0.000418)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name5', '2008-10-16 20:12:20', NULL, 5, 'email5@example.com', '2008-10-16 20:12:20')
+  User Create (0.000117)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name6', '2008-10-16 20:12:20', NULL, 6, 'email6@example.com', '2008-10-16 20:12:20')
+  User Load (0.000577)   SELECT * FROM "users" 
+
+
+Processing UsersController#index (for 0.0.0.0 at 2008-10-16 16:12:20) [GET]
+  Session ID: 
+  Parameters: {"order"=>"ascending", "action"=>"index", "controller"=>"users", "sort"=>"email"}
+  User Load (0.001013)   SELECT * FROM "users" ORDER BY users.email asc
+Rendering template within layouts/users
+Rendering users/index
+Completed in 0.00416 (240 reqs/sec) | Rendering: 0.00256 (61%) | DB: 0.00213 (51%) | 200 OK [http://test.host/users?order=ascending&sort=email]
+  User Create (0.000362)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name7', '2008-10-16 20:12:20', NULL, 7, 'email7@example.com', '2008-10-16 20:12:20')
+  User Create (0.000112)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name8', '2008-10-16 20:12:20', NULL, 8, 'email8@example.com', '2008-10-16 20:12:20')
+  User Load (0.000486)   SELECT * FROM "users" 
+
+
+Processing UsersController#index (for 0.0.0.0 at 2008-10-16 16:12:20) [GET]
+  Session ID: 
+  Parameters: {"order"=>"descending", "action"=>"index", "controller"=>"users", "sort"=>"email"}
+  User Load (0.000859)   SELECT * FROM "users" ORDER BY users.email desc
+Rendering template within layouts/users
+Rendering users/index
+Completed in 0.00385 (259 reqs/sec) | Rendering: 0.00238 (61%) | DB: 0.00182 (47%) | 200 OK [http://test.host/users?order=descending&sort=email]
+  User Create (0.000348)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name9', '2008-10-16 20:12:20', NULL, 9, 'email9@example.com', '2008-10-16 20:12:20')
+  User Create (0.000116)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name10', '2008-10-16 20:12:20', NULL, 10, 'email10@example.com', '2008-10-16 20:12:20')
+  User Load (0.000485)   SELECT * FROM "users" 
+
+
+Processing UsersController#index (for 0.0.0.0 at 2008-10-16 16:12:20) [GET]
+  Session ID: 
+  Parameters: {"order"=>"ascending", "action"=>"index", "controller"=>"users", "sort"=>"name"}
+  User Load (0.000839)   SELECT * FROM "users" ORDER BY name asc
+Rendering template within layouts/users
+Rendering users/index
+Completed in 0.00378 (264 reqs/sec) | Rendering: 0.00238 (62%) | DB: 0.00179 (47%) | 200 OK [http://test.host/users?order=ascending&sort=name]
+  User Create (0.000407)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name11', '2008-10-16 20:12:20', NULL, 11, 'email11@example.com', '2008-10-16 20:12:20')
+  User Create (0.000150)   INSERT INTO "users" ("name", "updated_at", "admin", "age", "email", "created_at") VALUES('name12', '2008-10-16 20:12:20', NULL, 12, 'email12@example.com', '2008-10-16 20:12:20')
+  User Load (0.000521)   SELECT * FROM "users" 
+
+
+Processing UsersController#index (for 0.0.0.0 at 2008-10-16 16:12:20) [GET]
+  Session ID: 
+  Parameters: {"order"=>"descending", "action"=>"index", "controller"=>"users", "sort"=>"name"}
+  User Load (0.000986)   SELECT * FROM "users" ORDER BY name desc
+Rendering template within layouts/users
+Rendering users/index
+Completed in 0.00440 (227 reqs/sec) | Rendering: 0.00279 (63%) | DB: 0.00206 (46%) | 200 OK [http://test.host/users?order=descending&sort=name]

data/test/rails_root/test/helper_testcase.rb

@@ -0,0 +1,38 @@
+# TODO Add this to your test_helper.rb
+#require File.expand_path(File.dirname(__FILE__) + '/helper_testcase')
+
+# Re-raise errors caught by the controller.
+class StubController < ApplicationController
+  def rescue_action(e) raise e end;
+  attr_accessor :request, :url
+end
+
+class HelperTestCase < Test::Unit::TestCase
+
+  # Add other helpers here if you need them
+  include ActionView::Helpers::ActiveRecordHelper
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::FormTagHelper
+  include ActionView::Helpers::FormOptionsHelper
+  include ActionView::Helpers::FormHelper
+  include ActionView::Helpers::UrlHelper
+  include ActionView::Helpers::AssetTagHelper
+  include ActionView::Helpers::PrototypeHelper
+
+  def setup
+    super
+
+    @request    = ActionController::TestRequest.new
+    @controller = StubController.new
+    @controller.request = @request
+
+    # Fake url rewriter so we can test url_for
+    @controller.url = ActionController::UrlRewriter.new @request, {}
+    
+    ActionView::Helpers::AssetTagHelper::reset_javascript_include_default
+  end
+
+  def test_dummy
+    # do nothing - required by test/unit
+  end
+end

data/test/rails_root/test/test_helper.rb

@@ -3,17 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
 require 'test_help'
 require 'rubygems'
 
-gem 'mocha'
-gem 'thoughtbot-quietbacktrace'
-gem 'thoughtbot-shoulda'
-gem 'thoughtbot-factory_girl'
-gem 'redgreen'
-
-require 'mocha'
-require 'quietbacktrace'
-require 'shoulda'
-require 'factory_girl'
-require 'redgreen'
+require File.expand_path(File.dirname(__FILE__) + '/helper_testcase')
 
 Dir[File.join(RAILS_ROOT, 'test', 'factories', '*.rb')].each do |file|
   require file

data/test/rails_root/test/unit/helpers/application_helper_test.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class ApplicationHelperTest < HelperTestCase
+
+  include ApplicationHelper
+  
+  context 'sortable_table_header' do
+    setup do
+      self.stubs(:params).returns({ :controller => :jobs, :action => :index, :sort => nil, :order => nil })
+    end
+
+    [:name, :sort].each do |param|
+      should "raise an error without default param #{param}" do
+        opts = { :name => 'name', :sort => 'sort' }
+        opts.delete param
+        assert_raise(ArgumentError) do
+          sortable_table_header opts
+        end
+      end
+    end
+
+    context 'with no params[:sort] or params[:order]' do
+      setup do
+        @html = sortable_table_header(:name => 'Title', :sort => 'title', :title => 'Sort by title')
+      end
+
+      should 'return a table header without a class attribute' do
+        assert @html.include?('<th>')
+      end
+    end
+
+    context "without an :anchor" do
+      setup do
+        @html = sortable_table_header(:name => 'Title', :sort => 'title', :title => 'Sort by title')
+      end
+
+      should 'return a link that contains a url with no anchor' do
+        assert @html.match(/href="[^#]+?"/)
+      end
+    end
+
+    context "with an :anchor" do
+      setup do
+        @html = sortable_table_header(:name => 'Title', :sort => 'title', :title => 'Sort by title', :anchor => 'search-results')
+      end
+
+      should 'return a link that contains a url with that anchor' do
+        assert @html.match(/href="[^"]*?#search-results"/)
+      end
+    end
+  end
+
+end

data/test/rails_root/vendor/plugins/helper_test/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Geoffrey Grosenbach
+
+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/test/rails_root/vendor/plugins/helper_test/README

@@ -0,0 +1,33 @@
+= Helper Test Generator
+
+Makes stubs so you can test helpers.
+
+The helpers are placed in test/unit/helpers and will be run automatically when you run unit tests.
+
+= Usage
+
+Run the helper_test generator with the shortened name of the helper you want to test.
+
+  # For TaskHelper
+  ./script/generate helper_test Task
+
+Require the parent testcase class in your test_helper.rb
+
+  require File.expand_path(File.dirname(__FILE__) + '/helper_testcase')
+
+The testcase includes common helpers, but you can add others if necessary.
+
+= Examples
+
+  # Make a test for the BlogHelper
+  ./script/generate helper_test Blog
+
+  # Make a test for Admin::UsersHelper
+  ./script/generate helper_test Admin::Users
+
+Sub-folders will be made, if necessary.
+
+= Authors
+
+* Test stub by Ryan Davis http://zenspider.com
+* Generator by Geoffrey Grosenbach http://nubyonrails.com

data/test/rails_root/vendor/plugins/helper_test/about.yml

@@ -0,0 +1,7 @@
+author: topfunky
+summary: Generates a test case for testing plugins that work as view helpers.
+homepage: http://nubyonrails.com
+plugin: http://topfunky.net/svn/plugins/helper_test
+license: MIT
+version: 0.2
+rails_version: 1.0+

data/test/rails_root/vendor/plugins/helper_test/generators/helper_test/helper_test_generator.rb

@@ -0,0 +1,22 @@
+class HelperTestGenerator < Rails::Generator::NamedBase  
+
+  attr_reader :helper_class_name, :directory_slashes
+
+  def initialize(runtime_args, runtime_options = {})
+    @helper_class_name = Inflector.camelize(runtime_args.first)
+    super
+  end
+
+  def manifest
+    record do |m|
+      m.template 'helper_testcase.rb', 'test/helper_testcase.rb'
+      
+      output_path = File.join('test/unit/helpers', "#{@helper_class_name.underscore}_helper_test.rb")
+      m.directory File.join(File.dirname(output_path))
+
+      # Make slashes relative to the test/unit/helpers folder
+      @directory_slashes = '/..' * (output_path.split('/').length - 3)
+      m.template 'helper_test.rb', File.join(output_path)
+    end
+  end
+end

data/test/rails_root/vendor/plugins/helper_test/generators/helper_test/templates/helper_test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '<%= directory_slashes %>/../test_helper'
+
+class <%= helper_class_name %>HelperTest < HelperTestCase
+
+  include <%= helper_class_name %>Helper
+
+  #fixtures :users, :articles
+
+  def setup
+    super
+  end
+  
+end

data/test/rails_root/vendor/plugins/helper_test/generators/helper_test/templates/helper_testcase.rb

@@ -0,0 +1,38 @@
+# TODO Add this to your test_helper.rb
+#require File.expand_path(File.dirname(__FILE__) + '/helper_testcase')
+
+# Re-raise errors caught by the controller.
+class StubController < ApplicationController
+  def rescue_action(e) raise e end;
+  attr_accessor :request, :url
+end
+
+class HelperTestCase < Test::Unit::TestCase
+
+  # Add other helpers here if you need them
+  include ActionView::Helpers::ActiveRecordHelper
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::FormTagHelper
+  include ActionView::Helpers::FormOptionsHelper
+  include ActionView::Helpers::FormHelper
+  include ActionView::Helpers::UrlHelper
+  include ActionView::Helpers::AssetTagHelper
+  include ActionView::Helpers::PrototypeHelper
+
+  def setup
+    super
+
+    @request    = ActionController::TestRequest.new
+    @controller = StubController.new
+    @controller.request = @request
+
+    # Fake url rewriter so we can test url_for
+    @controller.url = ActionController::UrlRewriter.new @request, {}
+    
+    ActionView::Helpers::AssetTagHelper::reset_javascript_include_default
+  end
+
+  def test_dummy
+    # do nothing - required by test/unit
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dancroak-sortable_table
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dan Croak
@@ -26,7 +26,7 @@ extra_rdoc_files: []
 files: 
 - MIT-LICENSE
 - Rakefile
-- README.markdown
+- README.textile
 - VERSION.yml
 - lib/sortable_table
 - lib/sortable_table/app
@@ -122,16 +122,30 @@ files:
 - test/rails_root/test/factories/user_factory.rb
 - test/rails_root/test/functional
 - test/rails_root/test/functional/users_controller_test.rb
+- test/rails_root/test/helper_testcase.rb
 - test/rails_root/test/test_helper.rb
+- test/rails_root/test/unit
+- test/rails_root/test/unit/helpers
+- test/rails_root/test/unit/helpers/application_helper_test.rb
 - test/rails_root/test/units
 - test/rails_root/test/units/helpers
-- test/rails_root/test/units/helpers/application_helper_test.rb
 - test/rails_root/tmp
 - test/rails_root/tmp/cache
 - test/rails_root/tmp/pids
 - test/rails_root/tmp/sessions
 - test/rails_root/tmp/sockets
 - test/rails_root/vendor
+- test/rails_root/vendor/plugins
+- test/rails_root/vendor/plugins/helper_test
+- test/rails_root/vendor/plugins/helper_test/about.yml
+- test/rails_root/vendor/plugins/helper_test/generators
+- test/rails_root/vendor/plugins/helper_test/generators/helper_test
+- test/rails_root/vendor/plugins/helper_test/generators/helper_test/helper_test_generator.rb
+- test/rails_root/vendor/plugins/helper_test/generators/helper_test/templates
+- test/rails_root/vendor/plugins/helper_test/generators/helper_test/templates/helper_test.rb
+- test/rails_root/vendor/plugins/helper_test/generators/helper_test/templates/helper_testcase.rb
+- test/rails_root/vendor/plugins/helper_test/MIT-LICENSE
+- test/rails_root/vendor/plugins/helper_test/README
 has_rdoc: false
 homepage: http://github.com/dancroak/sortable_table
 post_install_message: 

data/README.markdown

@@ -1,72 +0,0 @@
-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/test/rails_root/test/units/helpers/application_helper_test.rb

@@ -1,46 +0,0 @@
-# this needs way more tests
-context 'sortable_table_header' do
-  setup do
-    self.stubs(:params).returns({ :controller => :jobs, :action => :index, :sort => nil, :order => nil })
-  end
-
-  [:name, :sort].each do |param|
-    should "raise an error without default param #{param}" do
-      opts = { :name => 'name', :sort => 'sort' }
-      opts.delete param
-      assert_raise(ArgumentError) do
-        sortable_table_header opts
-      end
-    end
-  end
-
-  context 'with no params[:sort] or params[:order]' do
-    setup do
-      @html = sortable_table_header(:name => 'Title', :sort => 'title', :title => 'Sort by title')
-    end
-
-    should 'return a table header without a class attribute' do
-      assert @html.include?('<th>')
-    end
-  end
-
-  context "without an :anchor" do
-    setup do
-      @html = sortable_table_header(:name => 'Title', :sort => 'title', :title => 'Sort by title')
-    end
-
-    should 'return a link that contains a url with no anchor' do
-      assert @html.match(/href="[^#]+?"/)
-    end
-  end
-
-  context "with an :anchor" do
-    setup do
-      @html = sortable_table_header(:name => 'Title', :sort => 'title', :title => 'Sort by title', :anchor => 'search-results')
-    end
-
-    should 'return a link that contains a url with that anchor' do
-      assert @html.match(/href="[^"]*?#search-results"/)
-    end
-  end
-end