spinels-will_paginate-bootstrap 0.2.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2e619c33a7349b0a0cd4a2374112a788bf3e7543bf05dcbb92432cf64b35d10
+  data.tar.gz: 5a022b5a74e7f83985f3912079d9839a42237003abd2098213a5ccbde6157653
+SHA512:
+  metadata.gz: 56891b6d798b9b57a3543ae7139d7e7a90f66e38a9bcf1ce50a5781438076b3372e5e8ee2be480e5ac7a19b10cd6d7ca0f7141094300677a0355ec3dd88fb570
+  data.tar.gz: 6e003dd2da2bb1a734355c991953c445b23f37c024e2d8bd6fb81a8604a98db7bfd8c0c8d1e2c2b784c201b0a0c21e975cf4de5b1d437c8abe24b807165d97e1

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  push:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+        ruby:
+          - 2.7
+          - 3.2
+          - ruby-head
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea/

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in will_paginate-bootstrap.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+  gem "nokogiri"
+  gem "minitest"
+  gem "minitest-global_expectations"
+end
+
+group :example_app do
+  gem "sinatra"
+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

@@ -0,0 +1,62 @@
+# will_paginate-bootstrap
+
+[![Code Climate](https://codeclimate.com/github/nickpad/will_paginate-bootstrap.png)](https://codeclimate.com/github/nickpad/will_paginate-bootstrap)
+
+![Bootstrap Pagination Component](https://raw.github.com/nickpad/will_paginate-bootstrap/master/pagination.png)
+
+This gem integrates the [Twitter Bootstrap](http://twitter.github.com/bootstrap/) [pagination component](http://twitter.github.com/bootstrap/components.html#pagination) with the [will_paginate](https://github.com/mislav/will_paginate) pagination gem.
+
+As with will_paginate itself, Rails and Sinatra are supported.
+
+## Install
+
+  * `gem install spinels-will_paginate-bootstrap`, *or*
+  * For projects using Bundler, add `gem 'spinels-will_paginate-bootstrap'` to your `Gemfile` (and then run `bundle install`).
+
+## Usage
+
+### Rails
+
+  1. Load the Bootstrap CSS in your template.
+  2. In your view, use the `renderer: BootstrapPagination::Rails` option with the `will_paginate` helper, for example:
+
+```ruby
+<%= will_paginate @collection, renderer: BootstrapPagination::Rails %>
+```
+
+### 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:
+
+```ruby
+<%= will_paginate @collection, renderer: BootstrapPagination::Sinatra %>
+```
+
+## Bootstrap 3
+
+For Bootstrap 3, the markup required has changed slightly from version 2. You can pass the `bootstrap` option with a value >= 3 when calling `will_paginate` to generate Bootstrap 3 compatible markup. For example:
+
+```ruby
+<%= will_paginate @collection, renderer: BootstrapPagination::Rails, bootstrap: 3 %>
+```
+
+By default version 2 compatible markup will be generated.
+
+## Compatibility
+
+<table>
+	<tr>
+		<th>Ruby</th>
+		<td>>= 1.9.2</td>
+	</tr>
+	<tr>
+		<th>will_paginate</th>
+		<td>>= 3.0.3</td>
+	</tr>
+	<tr>
+		<th>Bootstrap</th>
+		<td>>= 2.0.0</td>
+	</tr>
+</table>

data/Rakefile

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

data/example/app.rb

@@ -0,0 +1,59 @@
+require "sinatra"
+require "will_paginate-bootstrap"
+require "will_paginate/collection"
+
+CDN_PATHS = {
+  2 => "//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.min.css",
+  3 => "//netdna.bootstrapcdn.com/bootstrap/3.0.0-rc1/css/bootstrap.min.css"
+}
+
+$menu = <<EOHTML
+<html>
+<head>
+<title>will_paginate-boostrap Example App</title>
+</head>
+<body>
+<ul>
+<h1>Which Twitter Boostrap version?</h1>
+<li><a href="/2">Bootstrap 2</a></li>
+<li><a href="/3">Bootstrap 3</a></li>
+</ul>
+</body>
+</html>
+EOHTML
+
+$template = <<EOHTML
+<html>
+<head>
+<title>will_paginate-boostrap Example App</title>
+<link href="<%= href %>" rel="stylesheet">
+</head>
+<body>
+<%= will_paginate @collection, renderer: BootstrapPagination::Sinatra, bootstrap: version %>
+</body>
+</html>
+EOHTML
+
+def build_collection
+  page = if params[:page].to_i > 0
+    params[:page].to_i
+  else
+    1
+  end
+
+  @collection = WillPaginate::Collection.new page, 10, 100000
+end
+
+get "/" do
+  erb $menu
+end
+
+get "/2" do
+  build_collection
+  erb $template, locals: {href: CDN_PATHS[2], version: 2}
+end
+
+get "/3" do
+  build_collection
+  erb $template, locals: {href: CDN_PATHS[3], version: 3}
+end

data/lib/bootstrap_pagination/action_view.rb

@@ -0,0 +1,9 @@
+require "will_paginate/view_helpers/action_view"
+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 BootstrapRenderer
+  end
+end

data/lib/bootstrap_pagination/bootstrap_renderer.rb

@@ -0,0 +1,63 @@
+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 Integer
+            page_number(item)
+          else
+            send(item)
+        end
+      end.join(@options[:link_separator])
+
+      if @options[:bootstrap].to_i >= 3
+        tag("ul", list_items, class: "pagination")
+      else
+        html_container(tag("ul", list_items))
+      end
+    end
+
+    def container_attributes
+      super.except(*[:link_options])
+    end
+
+    protected
+
+    def page_number(page)
+      link_options = @options[:link_options] || {}
+      if page == current_page
+        tag("li", tag("span", page), class: "active")
+      else
+        tag("li", link(page, page, link_options.merge(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)
+      link_options = @options[:link_options] || {}
+      if page
+        tag("li", link(text, page, link_options), class: classname)
+      else
+        tag("li", tag("span", text), class: "%s disabled" % classname)
+      end
+    end
+  end
+end

data/lib/bootstrap_pagination/sinatra.rb

@@ -0,0 +1,9 @@
+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 BootstrapRenderer
+  end
+end

data/lib/bootstrap_pagination/version.rb

@@ -0,0 +1,3 @@
+module BootstrapPagination
+  VERSION = "0.2.5.1"
+end

data/lib/will_paginate/bootstrap.rb

@@ -0,0 +1,9 @@
+require 'will_paginate'
+
+if defined?(ActionView)
+  require "bootstrap_pagination/action_view"
+end
+
+if defined?(Sinatra)
+  require "bootstrap_pagination/sinatra"
+end

data/lib/will_paginate-bootstrap.rb

@@ -0,0 +1 @@
+require "will_paginate/bootstrap"

data/spec/pagination_spec.rb

@@ -0,0 +1,100 @@
+require 'minitest/global_expectations/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
+  # 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.
+  let(:collection_size) { 15 }
+  let(:page) { (collection_size / 2.0).to_i }
+  let(:collection) { 1.upto(collection_size).to_a }
+  let(:version) { nil }
+  let(:link_options) { nil}
+
+  let(:output) do
+    will_paginate(
+      collection.paginate(:page => page, :per_page => 1),
+      renderer: MockRenderer, bootstrap: version, link_options: link_options
+    )
+  end
+
+  let(:html) { Nokogiri::HTML.fragment(output) }
+
+  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 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 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 an anchor within each non-active list item" do
+    html.css('ul li:not(.active)').each { |li| li.at_css('a').wont_be_nil }
+  end
+
+  it "uses a span element for the active page" do
+    html.at_css('ul li.active span').wont_be_nil
+  end
+
+  describe "with markup for v2" do
+    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
+  end
+
+  describe "with markup for v3" do
+    let(:version) { 3 }
+
+    it "has no outer pagination div" do
+      html.at_css('div.pagination').must_be_nil
+    end
+
+    it "has an unordered list with the pagination class" do
+      html.at_css('ul.pagination').wont_be_nil
+    end
+  end
+
+  describe "with link attribute specified" do
+    let(:link_options) { {"data-remote" => true} }
+
+    it "includes the link attribute" do
+      html.at_css('li.prev a')["data-remote"].must_equal "true"
+    end
+  end
+end

data/will_paginate-bootstrap.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bootstrap_pagination/version"
+
+Gem::Specification.new do |s|
+  s.name        = "spinels-will_paginate-bootstrap"
+  s.version     = BootstrapPagination::VERSION
+  s.authors     = ["Nick Dainty"]
+  s.email       = ["nick@npad.co.uk"]
+  s.homepage    = "https://github.com/spinels/will_paginate-bootstrap"
+  s.summary     = %q{Integrates the Twitter Bootstrap pagination component with will_paginate}
+  s.description = %q{This gem integrates the Twitter Bootstrap pagination component with the will_paginate pagination gem. Supports Rails and Sinatra.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "will_paginate", ">= 3.0.3"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: spinels-will_paginate-bootstrap
+version: !ruby/object:Gem::Version
+  version: 0.2.5.1
+platform: ruby
+authors:
+- Nick Dainty
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+description: This gem integrates the Twitter Bootstrap pagination component with the
+  will_paginate pagination gem. Supports Rails and Sinatra.
+email:
+- nick@npad.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- example/app.rb
+- lib/bootstrap_pagination/action_view.rb
+- lib/bootstrap_pagination/bootstrap_renderer.rb
+- lib/bootstrap_pagination/sinatra.rb
+- lib/bootstrap_pagination/version.rb
+- lib/will_paginate-bootstrap.rb
+- lib/will_paginate/bootstrap.rb
+- pagination.png
+- spec/pagination_spec.rb
+- will_paginate-bootstrap.gemspec
+homepage: https://github.com/spinels/will_paginate-bootstrap
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.7
+signing_key:
+specification_version: 4
+summary: Integrates the Twitter Bootstrap pagination component with will_paginate
+test_files:
+- spec/pagination_spec.rb