will_paginate-bootstrap 0.0.1 → 0.1.0

data/Gemfile

@@ -2,3 +2,9 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in will_paginate-bootstrap.gemspec
 gemspec
+
+group :development do
+  gem 'rake'
+  gem 'nokogiri'
+  gem 'minitest'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Nicholas Dainty
+
+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.markdown

@@ -11,13 +11,18 @@ As with will_paginate itself, Rails and Sinatra are supported.
 ### Rails
 
   1. Load the Bootstrap CSS in your template.
-  3. `require "will_paginate/bootstrap"` (`config/initializers/will_paginate.rb` would be a good place to put this).
-  2. In your view, `<%= will_paginate @collection, :renderer => WillPaginate::Rails %>`
-  3. Done!
+  2. `require "will_paginate/bootstrap"` (`config/initializers/will_paginate.rb` would be a good place to put this).
+  3. In your view, use the `:renderer => BootstrapPagination::Rails` option with the `will_paginate` helper, for example:
+
+`<%= will_paginate @collection, :renderer => BootstrapPagination::Rails %>`
 
 ### Sinatra
 
-TODO: Add instructions for Sinatra!
+  1. Load the Bootstrap CSS in your template.
+  2. `require "will_paginate/bootstrap"` in your Sinatra app.
+  3. In your view, use the `:renderer => BootstrapPagination::Sinatra` option with the `will_paginate` helper, for example:
+
+`<%= will_paginate @collection, :renderer => BootstrapPagination::Sinatra %>`
 
 ## Compatibility
 

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+task :default => :test

data/lib/bootstrap_pagination/action_view.rb

@@ -1,9 +1,9 @@
 require "will_paginate/view_helpers/action_view"
-require "bootstrap_pagination/link_renderer"
+require "bootstrap_pagination/bootstrap_renderer"
 
 module BootstrapPagination
   # A custom renderer class for WillPaginate that produces markup suitable for use with Twitter Bootstrap.
   class Rails < WillPaginate::ActionView::LinkRenderer
-    include LinkRenderer
+    include BootstrapRenderer
   end
 end

data/lib/bootstrap_pagination/bootstrap_renderer.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require "bootstrap_pagination/version"
+
+module BootstrapPagination
+  # Contains functionality shared by all renderer classes.
+  module BootstrapRenderer
+    ELLIPSIS = '…'
+
+    def to_html
+      list_items = pagination.map do |item|
+        case item
+          when Fixnum
+            page_number(item)
+          else
+            send(item)
+        end
+      end
+
+      html_container(tag('ul', list_items.join(@options[:link_separator])))
+    end
+
+    protected
+
+    def page_number(page)
+      if page == current_page
+        tag('li', link(page, page), :class => 'active')
+      else
+        tag('li', link(page, page, :rel => rel_value(page)))
+      end
+    end
+
+    def gap
+      tag('li', link(ELLIPSIS, '#'), :class => 'disabled')
+    end
+
+    def previous_page
+      num = @collection.current_page > 1 && @collection.current_page - 1
+      previous_or_next_page(num, @options[:previous_label], 'prev')
+    end
+
+    def next_page
+      num = @collection.current_page < @collection.total_pages && @collection.current_page + 1
+      previous_or_next_page(num, @options[:next_label], 'next')
+    end
+
+    def previous_or_next_page(page, text, classname)
+      if page
+        tag('li', link(text, page), :class => classname)
+      else
+        tag('li', link(text, '#'), :class => "%s disabled" % classname)
+      end
+    end
+  end
+end

data/lib/bootstrap_pagination/sinatra.rb

@@ -1,9 +1,9 @@
-require "will_paginate/view_helpers/action_view"
-require "bootstrap_pagination/link_renderer"
+require "will_paginate/view_helpers/sinatra"
+require "bootstrap_pagination/bootstrap_renderer"
 
 module BootstrapPagination
   # A custom renderer class for WillPaginate that produces markup suitable for use with Twitter Bootstrap.
   class Sinatra < WillPaginate::Sinatra::LinkRenderer
-    include LinkRenderer
+    include BootstrapRenderer
   end
 end

data/lib/bootstrap_pagination/version.rb

@@ -1,3 +1,3 @@
 module BootstrapPagination
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/pagination_spec.rb

@@ -0,0 +1,72 @@
+require 'minitest/autorun'
+require 'nokogiri'
+require 'will_paginate/array'
+require 'will_paginate/view_helpers/link_renderer'
+require 'bootstrap_pagination/bootstrap_renderer'
+
+include WillPaginate::ViewHelpers
+
+# Renderer class that's not tied to any web framework.
+class MockRenderer < WillPaginate::ViewHelpers::LinkRenderer
+  include BootstrapPagination::BootstrapRenderer
+
+  HASH = '#'
+
+  def url(args)
+    HASH
+  end
+end
+
+describe "Bootstrap Renderer" do
+  before do
+    # Render pagination for the middle page so that we can test for the presence of
+    # start, prev and next links. We should also be able to test for test for the
+    # presence of a "gap" item if the collection size is large enough.
+    collection_size = 15
+    page = (collection_size / 2.0).to_i
+
+    @collection = 1.upto(collection_size).to_a
+    @output = will_paginate(@collection.paginate(:page => page, :per_page => 1), :renderer => MockRenderer)
+    @html = Nokogiri::HTML.fragment(@output)
+  end
+
+  it "returns a string" do
+    @output.must_be_kind_of String
+  end
+
+  it "returns a string containing HTML" do
+    @html.must_be_kind_of Nokogiri::HTML::DocumentFragment
+  end
+
+  it "has an outer pagination div" do
+    @html.at_css('div.pagination').wont_be_nil
+  end
+
+  it "has an unordered list within the pagination div" do
+    @html.at_css('div.pagination ul').wont_be_nil
+  end
+
+  it "has an active list item" do
+    @html.at_css('ul li.active').wont_be_nil
+  end
+
+  it "has a gap item with class disabled" do
+    @html.at_css('ul li.disabled').wont_be_nil
+  end
+
+  it "has one item with rel start value" do
+    @html.css('[rel~=start]').size.must_equal 1
+  end
+
+  it "has two items with rel prev value" do
+    @html.css('[rel~=prev]').size.must_equal 2
+  end
+
+  it "has two items with rel next value" do
+    @html.css('[rel~=next]').size.must_equal 2
+  end
+
+  it "has anchors within each list item" do
+    @html.css('ul li').each { |li| li.at_css('a').wont_be_nil }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: will_paginate-bootstrap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-06 00:00:00.000000000 Z
+date: 2012-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: will_paginate
-  requirement: &70134158075500 !ruby/object:Gem::Requirement
+  requirement: &70312336639340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 3.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *70134158075500
+  version_requirements: *70312336639340
 description: This gem integrates the Twitter Bootstrap pagination component with the
   will_paginate pagination gem. Supports Rails and Sinatra.
 email:
@@ -32,14 +32,17 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- MIT-LICENSE
 - README.markdown
 - Rakefile
 - lib/bootstrap_pagination/action_view.rb
+- lib/bootstrap_pagination/bootstrap_renderer.rb
 - lib/bootstrap_pagination/link_renderer.rb
 - lib/bootstrap_pagination/sinatra.rb
 - lib/bootstrap_pagination/version.rb
 - lib/will_paginate/bootstrap.rb
 - pagination.png
+- spec/pagination_spec.rb
 - will_paginate-bootstrap.gemspec
 homepage: https://github.com/nickpad/will_paginate-bootstrap
 licenses: []
@@ -53,16 +56,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4530517534669726234
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4530517534669726234
 requirements: []
 rubyforge_project: will_paginate-bootstrap
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Integrates the Twitter Bootstrap pagination component with will_paginate
-test_files: []
+test_files:
+- spec/pagination_spec.rb