will_paginate_renderers 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in will_paginate_renderers.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    will_paginate_renderers (0.0.1)
+      will_paginate (= 3.0.pre2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    mocha (0.9.8)
+      rake
+    rake (0.8.7)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    will_paginate (3.0.pre2)
+    yard (0.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (~> 0.9)
+  rspec (~> 2.0.0)
+  will_paginate (= 3.0.pre2)
+  will_paginate_renderers!
+  yard

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 rspeicher
+
+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.md

@@ -0,0 +1,42 @@
+# Will Paginate Renderers
+
+A collection of custom renderers for use with the
+[will_paginate](http://github.com/mislav/will_paginate) view helper.
+
+## Renderers Provided
+
+### Gmail
+
+![](http://img.skitch.com/20101022-kf5u89brk4q66rfiyc2xs4wyug.jpg)
+
+### Twitter
+
+![](http://img.skitch.com/20101022-gsii3yq94kex2f2tgwnwuf1k8j.jpg)
+
+## Usage
+
+will_paginate_renderers requires the development version of will_paginate,
+which is currently 3.0.pre2
+
+### Rails 3
+
+**Gemfile**
+
+    gem 'will_paginate_renderers'
+
+**Views**
+
+    # Use the Twitter renderer
+    will_paginate(@posts, :renderer => WillPaginateRenderers::Twitter.new)
+
+## Note on Patches/Pull Requests
+
+* Fork
+* Code
+* Commit
+* Push
+* Pull Request
+
+## Copyright
+
+Copyright (c) 2010 Robert Speicher. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/will_paginate_renderers/gmail.rb

@@ -0,0 +1,83 @@
+module WillPaginateRenderers
+  # = Gmail
+  #
+  # A custom WillPaginate link renderer that emulates the Gmail-style
+  # Oldest, Older, (info), Newer, Newest links
+  #
+  # == Customization
+  #
+  # Changing the labels:
+  #   WillPaginateRenderers.pagination_options[:gmail_newest_label] = "Newest"
+  #   WillPaginateRenderers.pagination_options[:gmail_newer_label]  = "Newer"
+  #   WillPaginateRenderers.pagination_options[:gmail_older_label]  = "Older"
+  #   WillPaginateRenderers.pagination_options[:gmail_oldest_label] = "Oldest"
+  #
+  # Changing the CSS class of the links:
+  #   WillPaginateRenderers.pagination_options[:gmail_newest_class] = 'newest'
+  #   WillPaginateRenderers.pagination_options[:gmail_newer_class]  = 'newer'
+  #   WillPaginateRenderers.pagination_options[:gmail_older_class]  = 'older'
+  #   WillPaginateRenderers.pagination_options[:gmail_oldest_class] = 'oldest'
+  #   WillPaginateRenderers.pagination_options[:gmail_window_class] = 'window'
+  #
+  # == Option Defaults
+  #
+  # * +gmail_newest_label+: "« Newest"
+  # * +gmail_newer_label+: "< Newer"
+  # * +gmail_older_label+: "Older >"
+  # * +gmail_oldest_label+: "Oldest »"
+  # * +gmail_newest_class+: "gmail_newest"
+  # * +gmail_newer_class+: "gmail_newer"
+  # * +gmail_older_class+: "gmail_older"
+  # * +gmail_oldest_class+: "gmail_oldest"
+  # * +gmail:window_class+: "gmail_window"
+  class Gmail < ::WillPaginate::ViewHelpers::LinkRenderer
+    def pagination
+      [:newest, :newer, :window, :older, :oldest]
+    end
+
+    protected
+
+    def newest
+      return unless @collection.current_page > 2
+
+      previous_or_next_page(1,
+                            WillPaginateRenderers.pagination_options[:gmail_newest_label],
+                            WillPaginateRenderers.pagination_options[:gmail_newest_class])
+    end
+
+    def newer
+      return unless @collection.previous_page
+
+      previous_or_next_page(@collection.previous_page,
+                            WillPaginateRenderers.pagination_options[:gmail_newer_label],
+                            WillPaginateRenderers.pagination_options[:gmail_newer_class])
+    end
+
+    def older
+      return unless @collection.next_page
+
+      previous_or_next_page(@collection.next_page,
+                            WillPaginateRenderers.pagination_options[:gmail_older_label],
+                            WillPaginateRenderers.pagination_options[:gmail_older_class])
+    end
+
+    def oldest
+      return unless @collection.current_page < @collection.total_pages - 1
+
+      previous_or_next_page(@collection.total_pages,
+                            WillPaginateRenderers.pagination_options[:gmail_oldest_label],
+                            WillPaginateRenderers.pagination_options[:gmail_oldest_class])
+    end
+
+    # Renders the "x - y of z" text
+    def window
+      base = @collection.offset
+      high = base + @collection.per_page
+      high = @collection.total_entries if high > @collection.total_entries
+
+      # TODO: What's the best way to allow customization of this text, particularly "of"?
+      tag(:span, " #{base + 1} - #{high} of #{@collection.total_entries} ",
+          :class => WillPaginateRenderers.pagination_options[:gmail_window_class])
+    end
+  end
+end

data/lib/will_paginate_renderers/twitter.rb

@@ -0,0 +1,34 @@
+module WillPaginateRenderers
+  # = Twitter
+  #
+  # A custom WillPaginate link renderer that emulates the Twitter style
+  # "More" link.
+  #
+  # == Customization
+  #
+  # Changing the label:
+  #   WillPaginateRenderers.pagination_options[:twitter_label] = "View More"
+  #
+  # Changing the CSS class of the link:
+  #   WillPaginateRenderers.pagination_options[:twitter_class] = 'custom_css'
+  #
+  # == Option Defaults
+  #
+  # * +twitter_label+: "More"
+  # * +twitter_class+: +twitter_pagination+
+  class Twitter < ::WillPaginate::ViewHelpers::LinkRenderer
+    def pagination
+      [:next_page]
+    end
+
+    protected
+
+    def next_page
+      return unless @collection.next_page
+
+      previous_or_next_page(@collection.next_page,
+                            WillPaginateRenderers.pagination_options[:twitter_label],
+                            WillPaginateRenderers.pagination_options[:twitter_class])
+    end
+  end
+end

data/lib/will_paginate_renderers/version.rb

@@ -0,0 +1,3 @@
+module WillPaginateRenderers
+  VERSION = "0.0.1"
+end

data/lib/will_paginate_renderers.rb

@@ -0,0 +1,37 @@
+require 'will_paginate/view_helpers/link_renderer'
+
+# = Will Paginate Renderers
+#
+# A collection of custom renderers for the +will_paginate+ helper.
+#
+# == Renderers
+#
+# === Gmail
+#
+# Oldest/Older and Newer/Newest links as needed, as well as
+# "(start) - (end) of (total)" text.
+#
+# === Twitter
+#
+# A single "More" button when there are more results in the collection.
+module WillPaginateRenderers
+  autoload :Gmail,   'will_paginate_renderers/gmail'
+  autoload :Twitter, 'will_paginate_renderers/twitter'
+
+  def self.pagination_options() @pagination_options; end
+  def self.pagination_options=(value) @pagination_options = value; end
+  self.pagination_options = {
+    :twitter_label => 'More',
+    :twitter_class => 'twitter_pagination',
+
+    :gmail_newest_label => "« Newest",
+    :gmail_newer_label  => "< Newer",
+    :gmail_older_label  => "Older >",
+    :gmail_oldest_label => "Oldest »",
+    :gmail_newest_class => "gmail_newest",
+    :gmail_newer_class  => "gmail_newer",
+    :gmail_older_class  => "gmail_older",
+    :gmail_oldest_class => "gmail_oldest",
+    :gmail_window_class => "gmail_window",
+  }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'will_paginate_renderers'
+
+require 'will_paginate/collection'
+require 'will_paginate/view_helpers/base'
+
+# Copied from will_paginate's spec_helper
+module MyExtras
+  protected
+
+  def collection(params = {})
+    if params[:total_pages]
+      params[:per_page] = 1
+      params[:total_entries] = params[:total_pages]
+    end
+    WillPaginate::Collection.new(params[:page] || 1, params[:per_page] || 30, params[:total_entries])
+  end
+
+  def have_deprecation
+    DeprecationMatcher.new
+  end
+end
+
+# Copied from will_paginate's spec_helper
+class DeprecationMatcher
+  def initialize
+    @old_behavior = WillPaginate::Deprecation.behavior
+    @messages = []
+    WillPaginate::Deprecation.behavior = lambda { |message, callstack|
+      @messages << message
+    }
+  end
+
+  def matches?(block)
+    block.call
+    !@messages.empty?
+  ensure
+    WillPaginate::Deprecation.behavior = @old_behavior
+  end
+
+  def failure_message
+    "expected block to raise a deprecation warning"
+  end
+
+  def negative_failure_message
+    "expected block not to raise deprecation warnings, #{@messages.size} raised"
+  end
+end
+
+RSpec.configure do |c|
+  c.mock_with :mocha
+
+  c.include(WillPaginate::ViewHelpers::Base)
+  c.include(MyExtras)
+end

data/spec/will_paginate_renderers/gmail_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+module WillPaginateRenderers
+  describe Gmail do
+    before do
+      @renderer = Gmail.new
+      @renderer.stubs(:url).returns('')
+    end
+
+    it "should raise error when unprepared" do
+      expect { @renderer.send :param_name }.to raise_error
+    end
+
+    it "should prepare with collection and options" do
+      prepare({}, :param_name => 'mypage')
+      @renderer.send(:current_page).should eql(1)
+      @renderer.send(:param_name).should eql('mypage')
+    end
+
+    it "should have total_pages accessor" do
+      prepare :total_pages => 42
+      expect { @renderer.send(:total_pages).should eql(42) }.to_not have_deprecation
+    end
+
+    it "should have pagination definition" do
+      prepare({ :total_pages => 1 }, :page_links => true)
+      @renderer.pagination.should eql([:newest, :newer, :window, :older, :oldest])
+    end
+
+    it "should be empty when no more pages" do
+      prepare(:total_pages => 1)
+      @renderer.stubs(:window).returns('')
+      @renderer.to_html.should eql("")
+    end
+
+    it "should not have 'newest' or 'newer', but should have 'older' and 'oldest' when on page 1" do
+      prepare({:total_pages => 10, :page => 1})
+
+      html = @renderer.to_html
+      html.should_not match(/Newer/)
+      html.should_not match(/Newest/)
+      html.should match(/Older/)
+      html.should match(/Oldest/)
+    end
+
+    it "should have 'newer', 'older' and 'oldest' but not 'newest' when on page 2" do
+      prepare({:total_pages => 10, :page => 2})
+
+      html = @renderer.to_html
+      html.should match(/Newer/)
+      html.should_not match(/Newest/)
+      html.should match(/Older/)
+      html.should match(/Oldest/)
+    end
+
+    it "should not have 'older' or 'oldest' when on the last page" do
+      prepare({:total_pages => 10, :page => 10})
+
+      html = @renderer.to_html
+      html.should match(/Newest/)
+      html.should match(/Newer/)
+      html.should_not match(/Older/)
+      html.should_not match(/Oldest/)
+    end
+
+    it "should have 'older' but not 'oldest' when on second to last page" do
+      prepare({:total_pages => 10, :page => 9})
+
+      html = @renderer.to_html
+      html.should match(/Newest/)
+      html.should match(/Newer/)
+      html.should match(/Older/)
+      html.should_not match(/Oldest/)
+    end
+
+    it "should have the correct window text when on page 1" do
+      prepare({:per_page => 100, :total_entries => 895, :page => 1})
+      @renderer.to_html.should match(/1 - 100 of 895/)
+    end
+
+    it "should have the correct window text on page 2" do
+      prepare({:per_page => 100, :total_entries => 895, :page => 2})
+      @renderer.to_html.should match(/101 - 200 of 895/)
+    end
+
+    it "should have the correct window text on the last page" do
+      prepare({:per_page => 100, :total_entries => 895, :page => 9})
+      @renderer.to_html.should match(/801 - 895 of 895/)
+    end
+
+    context "options" do
+      before do
+        prepare({:per_page => 100, :total_entries => 895, :page => 5})
+
+        %w(newest newer older oldest).each do |name|
+          WillPaginateRenderers.pagination_options[:"gmail_#{name}_label"] = "custom_#{name}_label"
+          WillPaginateRenderers.pagination_options[:"gmail_#{name}_class"] = "custom_#{name}_class"
+        end
+      end
+
+      subject { @renderer.to_html }
+
+      it { should match(/custom_newest_label/) }
+      it { should match(/custom_newer_label/) }
+      it { should match(/custom_older_label/) }
+      it { should match(/custom_oldest_label/) }
+      it { should match(/custom_newest_class/) }
+      it { should match(/custom_newer_class/) }
+      it { should match(/custom_older_class/) }
+      it { should match(/custom_oldest_class/) }
+    end
+
+    protected
+
+    def prepare(collection_options, options = {})
+      @renderer.prepare(collection(collection_options), options, '')
+    end
+  end
+end

data/spec/will_paginate_renderers/twitter_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module WillPaginateRenderers
+  describe Twitter do
+    before do
+      @renderer = Twitter.new
+    end
+
+    it "should raise error when unprepared" do
+      expect { @renderer.send :param_name }.to raise_error
+    end
+
+    it "should prepare with collection and options" do
+      prepare({}, :param_name => 'mypage')
+      @renderer.send(:current_page).should eql(1)
+      @renderer.send(:param_name).should eql('mypage')
+    end
+
+    it "should have total_pages accessor" do
+      prepare :total_pages => 42
+      expect { @renderer.send(:total_pages).should eql(42) }.to_not have_deprecation
+    end
+
+    it "should have pagination definition" do
+      prepare({ :total_pages => 1 }, :page_links => true)
+      @renderer.pagination.should eql([:next_page])
+    end
+
+    it "should be empty when no more pages" do
+      prepare(:total_pages => 1)
+      @renderer.to_html.should eql("")
+    end
+
+    it "should use the :twitter_label option" do
+      WillPaginateRenderers.pagination_options[:twitter_label] = 'Custom Label'
+      prepare :total_pages => 2
+      @renderer.expects(:url).returns('')
+      @renderer.to_html.should match(/Custom Label/)
+    end
+
+    it "should use the :twitter_class option" do
+      WillPaginateRenderers.pagination_options[:twitter_class] = 'custom_class'
+      prepare :total_pages => 2
+      @renderer.expects(:url).returns('')
+      @renderer.to_html.should match(/custom_class/)
+    end
+
+    protected
+
+    def prepare(collection_options, options = {})
+      @renderer.prepare(collection(collection_options), options, '')
+    end
+  end
+end

data/will_paginate_renderers.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "will_paginate_renderers/version"
+
+Gem::Specification.new do |s|
+  s.name        = "will_paginate_renderers"
+  s.version     = WillPaginateRenderers::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Robert Speicher']
+  s.email       = ['rspeicher@gmail.com']
+  s.homepage    = "http://rubygems.org/gems/will_paginate_renderers"
+  s.summary     = %q{A collection of renderers for use with will_paginate}
+  s.description = %q{A collection of renderers for use with will_paginate.}
+
+  s.rubyforge_project = "will_paginate_renderers"
+
+  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_dependency "will_paginate", "3.0.pre2"
+  s.add_development_dependency "mocha", "~> 0.9"
+  s.add_development_dependency "rspec", "~> 2.0.0"
+  s.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: will_paginate_renderers
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Robert Speicher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-23 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: will_paginate
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: -1876988247
+        segments: 
+        - 3
+        - 0
+        - pre2
+        version: 3.0.pre2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: A collection of renderers for use with will_paginate.
+email: 
+- rspeicher@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- autotest/discover.rb
+- lib/will_paginate_renderers.rb
+- lib/will_paginate_renderers/gmail.rb
+- lib/will_paginate_renderers/twitter.rb
+- lib/will_paginate_renderers/version.rb
+- spec/spec_helper.rb
+- spec/will_paginate_renderers/gmail_spec.rb
+- spec/will_paginate_renderers/twitter_spec.rb
+- will_paginate_renderers.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/will_paginate_renderers
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: will_paginate_renderers
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A collection of renderers for use with will_paginate
+test_files: 
+- spec/spec_helper.rb
+- spec/will_paginate_renderers/gmail_spec.rb
+- spec/will_paginate_renderers/twitter_spec.rb