RubyGems - paginated_table - Versions diffs - 0.0.1 - Mend

paginated_table 0.0.1

Files changed (63) hide show

data/MIT-LICENSE +20 -0
data/README.md +132 -0
data/Rakefile +38 -0
data/lib/paginated_table.rb +7 -0
data/lib/paginated_table/controller_helpers.rb +14 -0
data/lib/paginated_table/engine.rb +7 -0
data/lib/paginated_table/page.rb +87 -0
data/lib/paginated_table/railtie.rb +12 -0
data/lib/paginated_table/version.rb +3 -0
data/lib/paginated_table/view_helpers.rb +168 -0
data/lib/tasks/paginated_table_tasks.rake +4 -0
data/test/dummy/README.rdoc +261 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/assets/javascripts/application.js +16 -0
data/test/dummy/app/assets/stylesheets/application.css +13 -0
data/test/dummy/app/controllers/application_controller.rb +3 -0
data/test/dummy/app/controllers/data_controller.rb +27 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/views/data/_data.html.erb +7 -0
data/test/dummy/app/views/data/index.html.erb +3 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +59 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/database.yml +25 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +37 -0
data/test/dummy/config/environments/production.rb +67 -0
data/test/dummy/config/environments/test.rb +37 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/inflections.rb +15 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +7 -0
data/test/dummy/config/initializers/session_store.rb +8 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/routes.rb +59 -0
data/test/dummy/db/test.sqlite3 +0 -0
data/test/dummy/log/test.log +56930 -0
data/test/dummy/public/404.html +26 -0
data/test/dummy/public/422.html +26 -0
data/test/dummy/public/500.html +25 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/script/rails +6 -0
data/test/dummy/tmp/cache/assets/CB7/360/sprockets%2F8334f01490cb91467dfd76ad25b67780 +0 -0
data/test/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
data/test/dummy/tmp/cache/assets/D25/810/sprockets%2F4ff88255fbab9775241c5d8c8c6e2088 +0 -0
data/test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
data/test/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
data/test/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
data/test/dummy/tmp/cache/assets/D62/6D0/sprockets%2F9b8014b0c5371c3bf5dd4f018a5ec71e +0 -0
data/test/dummy/tmp/cache/assets/D71/1A0/sprockets%2F32c631252aee35736d93e06f3edffd6d +0 -0
data/test/dummy/tmp/cache/assets/DD3/F90/sprockets%2Fc24290dff33aff9c3d2f971f6d8ae04b +0 -0
data/test/dummy/tmp/cache/assets/DD4/950/sprockets%2F09e7f24ef1ff59b4fc390bdf415c60af +0 -0
data/test/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +9809 -0
data/test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +9809 -0
data/test/dummy/tmp/capybara/capybara-201204041545476374284085.html +12 -0
data/test/integration/paginated_table_integration_test.rb +235 -0
data/test/test_helper.rb +31 -0
data/test/units/controller_helpers_test.rb +43 -0
data/test/units/page_test.rb +192 -0
data/test/units/view_helpers_test.rb +317 -0
metadata +276 -0

data/test/dummy/tmp/capybara/capybara-201204041545476374284085.html ADDED

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>Dummy</title>
+<link href="/assets/application.css" media="all" rel="stylesheet" type="text/css">
+<script src="/assets/application.js" type="text/javascript"></script>
+</head>
+<body>
+<table class="paginated"><tbody></tbody></table>
+</body>
+</html>

data/test/integration/paginated_table_integration_test.rb ADDED

@@ -0,0 +1,235 @@
+require 'test_helper'
+require 'capybara/webkit'
+describe "paginated_table integration" do
+  describe "rendering" do
+    before do
+      visit "/data"
+    end
+    it "displays a pagination area" do
+      page.has_xpath?(pagination_xpath).must_equal true
+    end
+    it "displays a paginated table" do
+      page.has_xpath?(table_xpath).must_equal true
+    end
+    it "displays Name in the first column header" do
+      page.has_xpath?("#{th_xpath(1)}[.='Name']").must_equal true
+    end
+    it "displays Raw in the third column header" do
+      page.has_xpath?("#{th_xpath(3)}[.='Raw']").must_equal true
+    end
+    it "displays the data names in the first column" do
+      (1..10).each do |row|
+        page.has_xpath?("#{tr_xpath(row)}/td[1][.='Name #{row}']").must_equal true
+      end
+    end
+    it "displays links to the data in the second column" do
+      (1..10).each do |row|
+        page.has_xpath?("#{tr_xpath(row)}/td[2]/a[@href='/data/#{row}'][.='#{row}']").must_equal true
+      end
+    end
+    describe "with javascript" do
+      before do
+        Capybara.current_driver = Capybara.javascript_driver
+      end
+      it "updates only the pagination table from pagination table links" do
+        visit "/data"
+        click_link "2"
+        wait_for_ajax_request
+        page.has_xpath?("//h1[2]").must_equal false
+      end
+    end
+  end
+  describe "pagination" do
+    describe "without javascript" do
+      it "displays one page of results" do
+        visit "/data"
+        pagination_info_text.must_equal "Displaying data controller/data 1 - 10 of 100 in total"
+      end
+      it "follows the link to the second page of results" do
+        visit "/data"
+        click_link "2"
+        pagination_info_text.must_equal "Displaying data controller/data 11 - 20 of 100 in total"
+      end
+    end
+    describe "with javascript" do
+      before do
+        Capybara.current_driver = Capybara.javascript_driver
+      end
+      it "displays one page of results" do
+        visit "/data"
+        pagination_info_text.must_equal "Displaying data controller/data 1 - 10 of 100 in total"
+      end
+      it "follows the link to the second page of results" do
+        visit "/data"
+        click_link "2"
+        wait_for_ajax_request
+        pagination_info_text.must_equal "Displaying data controller/data 11 - 20 of 100 in total"
+      end
+      # Ensures the AJAX content is decorated with event handlers
+      it "follows the link to the fourth page, then back to the third page" do
+        visit "/data"
+        click_link "4"
+        wait_for_ajax_request
+        pagination_info_text.must_equal "Displaying data controller/data 31 - 40 of 100 in total"
+        click_link "3"
+        wait_for_ajax_request
+        pagination_info_text.must_equal "Displaying data controller/data 21 - 30 of 100 in total"
+      end
+    end
+  end
+  describe "sorting" do
+    describe "decoration" do
+      it "marks the sortable columns" do
+        visit "/data"
+        page.has_xpath?("#{th_xpath(1)}[@class='sortable'][.='Name']").must_equal true
+      end
+      it "marks the sort column when sorted in ascending order" do
+        visit "/data"
+        click_link "Name"
+        page.has_xpath?("#{th_xpath(1)}[@class='sortable sorted_asc'][.='Name']").must_equal true
+      end
+      it "marks the sort column when sorted in descending order" do
+        visit "/data"
+        click_link "Name"
+        click_link "Name"
+        page.has_xpath?("#{th_xpath(1)}[@class='sortable sorted_desc'][.='Name']").must_equal true
+      end
+    end
+    describe "without javascript" do
+      it "follows the link to sort the first column in ascending order" do
+        visit "/data"
+        click_link "Name"
+        [1, 10, 100, 11, 12, 13, 14, 15, 16, 17].each_with_index do |row, i|
+          page.has_xpath?("#{tr_xpath(i + 1)}/td[1][.='Name #{row}']").must_equal true
+        end
+      end
+      it "follows the link to sort the first column twice in descending order" do
+        visit "/data"
+        click_link "Name"
+        click_link "Name"
+        [99, 98, 97, 96, 95, 94, 93, 92, 91, 90].each_with_index do |row, i|
+          page.has_xpath?("#{tr_xpath(i + 1)}/td[1][.='Name #{row}']").must_equal true
+        end
+      end
+      it "follows the link to sort the first column, then to the second page" do
+        visit "/data"
+        click_link "Name"
+        click_link "2"
+        [18, 19, 2, 20, 21, 22, 23, 24, 25, 26].each_with_index do |row, i|
+          page.has_xpath?("#{tr_xpath(i + 1)}/td[1][.='Name #{row}']").must_equal true
+        end
+      end
+      it "has no link to sort the second column" do
+        visit "/data"
+        page.has_xpath?("a[.='Link']").must_equal false
+      end
+    end
+    describe "with javascript" do
+      before do
+        Capybara.current_driver = Capybara.javascript_driver
+      end
+      it "follows the link to sort the first column in ascending order" do
+        visit "/data"
+        click_link "Name"
+        wait_for_ajax_request
+        [1, 10, 100, 11, 12, 13, 14, 15, 16, 17].each_with_index do |row, i|
+          page.has_xpath?("#{tr_xpath(i + 1)}/td[1][.='Name #{row}']").must_equal true
+        end
+      end
+      it "follows the link to sort the first column twice in descending order" do
+        visit "/data"
+        click_link "Name"
+        wait_for_ajax_request
+        click_link "Name"
+        wait_for_ajax_request
+        [99, 98, 97, 96, 95, 94, 93, 92, 91, 90].each_with_index do |row, i|
+          page.has_xpath?("#{tr_xpath(i + 1)}/td[1][.='Name #{row}']").must_equal true
+        end
+      end
+      it "follows the link to sort the first column, then to the second page" do
+        visit "/data"
+        click_link "Name"
+        wait_for_ajax_request
+        click_link "2"
+        wait_for_ajax_request
+        [18, 19, 2, 20, 21, 22, 23, 24, 25, 26].each_with_index do |row, i|
+          page.has_xpath?("#{tr_xpath(i + 1)}/td[1][.='Name #{row}']").must_equal true
+        end
+      end
+    end
+  end
+  def pagination_xpath
+    "//div[@class='paginated_table']"
+  end
+  def pagination_header_xpath
+    "#{pagination_xpath}/div[@class='header']"
+  end
+  def pagination_info_xpath
+    "#{pagination_header_xpath}/div[@class='info']"
+  end
+  def table_xpath
+    "#{pagination_xpath}/table[@class='paginated']"
+  end
+  def th_xpath(column)
+    "#{table_xpath}/thead/tr[1]/th[#{column}]"
+  end
+  def tbody_xpath
+    "#{table_xpath}/tbody[1]"
+  end
+  def tr_xpath(row)
+    "#{tbody_xpath}/tr[#{row}]"
+  end
+  def pagination_info_text
+    info = find(:xpath, pagination_info_xpath)
+    replace_nbsp(info.text)
+  end
+  def replace_nbsp(str)
+    if str.respond_to?(:valid_encoding?)
+      str.force_encoding('UTF-8').gsub(/\xc2\xa0/u, ' ')
+    else
+      str.gsub(/\xc2\xa0/u, ' ')
+    end
+  end
+  def wait_for_ajax_request
+    wait_until do
+      page.evaluate_script('jQuery.active') == 0
+    end
+  end
+end

data/test/test_helper.rb ADDED

@@ -0,0 +1,31 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+require 'minitest/autorun'
+require 'capybara/rails'
+require 'mocha/integration/mini_test'
+Rails.backtrace_cleaner.remove_silencers!
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+# Load fixtures from the engine
+if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+end
+Capybara.javascript_driver = :webkit
+class IntegrationTest < MiniTest::Spec
+  include Capybara::DSL
+  after do
+    Capybara.reset_sessions!
+    Capybara.use_default_driver
+  end
+end
+MiniTest::Spec.register_spec_type(/integration$/, IntegrationTest)

data/test/units/controller_helpers_test.rb ADDED

@@ -0,0 +1,43 @@
+module PaginatedTable
+  describe ControllerHelpers do
+    let(:params) { stub("params") }
+    let(:request) { stub("request", :xhr? => false) }
+    let(:controller) {
+      controller = Object.new
+      controller.extend(ControllerHelpers)
+      controller.stubs(:params => params, :request => request)
+      controller
+    }
+    describe "#paginated_table" do
+      let(:collection) { stub("collection") }
+      let(:tables) { { "collection_name" => collection } }
+      let(:page) { stub("page") }
+      let(:data) { stub("data") }
+      let(:data_page) { stub("data_page", :data => data, :page => page) }
+      before do
+        PageParams.stubs(:create_page_from_params).with(params).returns(page)
+        DataPage.stubs(:new).with(collection, page).returns(data_page)
+      end
+      it "sets an instance variable on the controller with the data page" do
+        controller.paginated_table(tables)
+        controller.instance_variable_get("@collection_name").must_equal data_page
+      end
+      it "renders the named partial without layout if request is xhr?" do
+        request.stubs(:xhr? => true)
+        controller.expects(:render).
+          with(:partial => "collection_name", :layout => false)
+        controller.paginated_table(tables)
+      end
+      it "does not render if request is not xhr?" do
+        request.stubs(:xhr? => false)
+        controller.expects(:render).never
+        controller.paginated_table(tables)
+      end
+    end
+  end
+end

data/test/units/page_test.rb ADDED

@@ -0,0 +1,192 @@
+module PaginatedTable
+  describe Page do
+    let(:page) { Page.new(:number => 2, :rows => 5, :sort_column => 'name', :sort_direction => 'desc') }
+    it "has a page number" do
+      page.number.must_equal 2
+    end
+    it "does not accept a negative page number" do
+      lambda { Page.new(:number => -1) }.must_raise ArgumentError
+    end
+    it "does not accept a zero page number" do
+      lambda { Page.new(:number => 0) }.must_raise ArgumentError
+    end
+    it "does not accept an invalid page number" do
+      lambda { Page.new(:number => 'foo') }.must_raise ArgumentError
+    end
+    it "has a rows number" do
+      page.rows.must_equal 5
+    end
+    it "does not accept a negative number of rows" do
+      lambda { Page.new(:rows => -1) }.must_raise ArgumentError
+    end
+    it "does not accept a zero number of rows "do
+      lambda { Page.new(:rows => 0) }.must_raise ArgumentError
+    end
+    it "does not accept an invalid page number" do
+      lambda { Page.new(:rows => 'foo') }.must_raise ArgumentError
+    end
+    it "has a sort column" do
+      page.sort_column.must_equal 'name'
+    end
+    it "has a sort direction" do
+      page.sort_direction.must_equal 'desc'
+    end
+    it "does not accept an invalid sort direction" do
+      lambda { Page.new(:sort_direction => 'foo') }.must_raise ArgumentError
+    end
+    describe ".opposite_sort_direction" do
+      it "returns asc for desc" do
+        Page.opposite_sort_direction('asc').must_equal 'desc'
+      end
+      it "returns desc for asc" do
+        Page.opposite_sort_direction('desc').must_equal 'asc'
+      end
+    end
+    describe "#page_for_number" do
+      describe "with a new page number" do
+        let(:number_page) { page.page_for_number(3) }
+        it "returns a new page with the new page number" do
+          number_page.number.must_equal 3
+        end
+        it "returns a new page with the same number of rows" do
+          number_page.rows.must_equal 5
+        end
+        it "returns a new page with the same sort column" do
+          number_page.sort_column.must_equal 'name'
+        end
+        it "returns a new page with the same sort direction" do
+          number_page.sort_direction.must_equal 'desc'
+        end
+      end
+    end
+    describe "#page_for_sort_column" do
+      describe "on a new sort column" do
+        let(:sort_page) { page.page_for_sort_column('title') }
+        it "returns a new page with page number 1" do
+          sort_page.number.must_equal 1
+        end
+        it "returns a new page with the same number of rows" do
+          sort_page.rows.must_equal 5
+        end
+        it "returns a new page with the given sort column" do
+          sort_page.sort_column.must_equal 'title'
+        end
+        it "returns a new page with sort direction asc" do
+          sort_page.sort_direction.must_equal 'asc'
+        end
+      end
+      describe "on the same sort column" do
+        let(:sort_page) { page.page_for_sort_column('name') }
+        it "returns a new page with page number 1" do
+          sort_page.number.must_equal 1
+        end
+        it "returns a new page with the same number of rows" do
+          sort_page.rows.must_equal 5
+        end
+        it "returns a new page with the same sort column" do
+          sort_page.sort_column.must_equal 'name'
+        end
+        it "returns a new page with the opposite sort direction" do
+          sort_page.sort_direction.must_equal 'asc'
+          sort_page.page_for_sort_column('name').sort_direction.must_equal 'desc'
+        end
+      end
+    end
+  end
+  describe PageParams do
+    describe ".create_from_params" do
+      it "returns a new page created from the request params" do
+        page = PageParams.create_page_from_params(
+          :page => '2',
+          :per_page => '5',
+          :sort_column => 'name',
+          :sort_direction => 'desc'
+        )
+        page.number.must_equal 2
+        page.rows.must_equal 5
+        page.sort_column.must_equal 'name'
+        page.sort_direction.must_equal 'desc'
+      end
+    end
+    describe ".to_params" do
+      it "creates a params hash from the page" do
+        page = Page.new(
+          :number => 2,
+          :rows => 5,
+          :sort_column => 'name',
+          :sort_direction => 'desc'
+        )
+        PageParams.to_params(page).must_equal(
+          :page => '2',
+          :per_page => '5',
+          :sort_column => 'name',
+          :sort_direction => 'desc'
+        )
+      end
+    end
+  end
+  describe DataPage do
+    describe "#data" do
+      let(:page) {
+        Page.new(
+          :number => 2,
+          :rows => 5,
+          :sort_column => 'name',
+          :sort_direction => 'asc'
+        )
+      }
+      let(:collection) {
+        collection = (1..10).map { |i| "Name #{i}" }
+        def collection.order(clause)
+          raise unless clause == "name asc"
+          sort
+        end
+        collection
+      }
+      it "sorts the collection and pages to the given page number" do
+        DataPage.new(collection, page).data.must_equal(
+          ["Name 5", "Name 6", "Name 7", "Name 8", "Name 9"]
+        )
+      end
+      describe "#page" do
+        it "provides a reference to the given page" do
+          DataPage.new(collection, page).page.must_equal page
+        end
+      end
+    end
+  end
+end