peiji-san 1.0.0 → 1.1.0

data/README.rdoc

@@ -1,5 +1,7 @@
 = Peiji-San
 
+{<img src="https://secure.travis-ci.org/Fingertips/peiji-san.png" />}[http://travis-ci.org/Fingertips/peiji-san]
+
 Peiji-San uses scopes to create a thin pagination layer.
 
 We try to stay out of the way of your application as much as possible. That's
@@ -32,6 +34,26 @@ After that the helpers will be usable in your view.
     <% end %>
   <% end %>
 
+== Sinatra
+
+Peiji-san is adept at working together with Sinatra. The only caveat is that
+it uses the *url_for* method, which Sinatra does not provide by default. So you will
+need a recent version of https://github.com/emk/sinatra-url-for. Unfortunately there
+has been no gem releases for it in a while, so we recommend you use
+tobias-sinatra-url-for until the situation improves. Afterwards, in your Sinatra application
+
+  class MyApp < Sinatra::Base
+    helpers Sinatra::UrlForHelper, PeijiSan::ViewHelper
+    
+    get '/' do
+      # ...do the job
+      @collection = Item.page(params[:page])
+      erb :items
+    end
+  end
+
+and in your view you can do exactly the same thing you see in the Rails example.
+
 == Rails 2.3 and earlier
 
 The latest version of Peiji only works in Rails 3 because of extensive

data/Rakefile

@@ -1,28 +1,14 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name     = "peiji-san"
-    s.homepage = "http://github.com/Fingertips/peiji-san"
-    s.email    = "eloy.de.enige@gmail.com"
-    s.authors  = ["Eloy Duran"]
-    s.summary  = s.description = "PeijiSan is a Rails plugin which uses named scopes to create a thin pagination layer."
-    s.files    = FileList['**/**'] # tmp until we've patched Jeweler to be able to easily add files to defaults
+# Fix for those annoying issues when using an older system rake
+module Rake
+  module DSL
   end
-rescue LoadError
 end
 
-begin
-  require 'jewelry_portfolio/tasks'
-  JewelryPortfolio::Tasks.new do |p|
-    p.account = 'Fingertips'
-  end
-rescue LoadError
-end
+require 'rubygems'
+require 'bundler'
+Bundler.require
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = 'PeijiSan'

data/init.rb

@@ -1,2 +1,3 @@
+# -*- encoding : utf-8 -*-
 require 'peiji_san'
-require 'peiji_san/view_helper'
+require 'peiji_san/view_helper'

data/lib/peiji_san.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Peiji-San uses named scopes to create a thin pagination layer.
 #
 #   class Member < ActiveRecord::Base
@@ -117,4 +118,4 @@ module PeijiSan
     
     entries.limit(entries_per_page).offset((page - 1) * entries_per_page)
   end
-end
+end

data/lib/peiji_san/view_helper.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module PeijiSan
   # Optionally defines the peiji_san_options method in your helper to override
   # the default options.
@@ -46,10 +47,41 @@ module PeijiSan
     #     collection. Defaults to <tt>:current</tt>.
     def link_to_page(page, paginated_set, options = {}, html_options = {})
       page_parameter = peiji_san_option(:page_parameter, options)
-      url_options = (page == 1 ? controller.params.except(page_parameter) : controller.params.merge(page_parameter => page))
-      url_options[:anchor] = peiji_san_option(:anchor, options)
+      
+      # Sinatra/Rails differentiator
+      pageable_params = respond_to?(:controller) ? controller.params : self.params
+      
+      url_options = (page == 1 ? pageable_params.except(page_parameter) : pageable_params.merge(page_parameter => page))
+      anchor = peiji_san_option(:anchor, options)
+      url_options[:anchor] = anchor if anchor
       html_options[:class] = peiji_san_option(:current_class, options) if paginated_set.current_page?(page)
-      link_to page, url_for(url_options), html_options
+      
+      # Again a little fork here
+      normalized_url_options = if respond_to?(:controller) # Rails
+        url_for(url_options)
+      else # Sinatra
+        root_path = env['SCRIPT_NAME'].blank? ? "/" : env["SCRIPT_NAME"]
+        url_for(root_path, url_options)
+      end
+      
+      link_to page, normalized_url_options, html_options
+    end
+    
+    # This Rails method is overridden to provide compatibility with other frameworks. By default it will just call super
+    # if super is provided. However, you will need your application to provide a standard url_for method
+    # in the context where this helper is used. For that you could use https://github.com/emk/sinatra-url-for/
+    def link_to(*arguments)
+      return super if defined?(super)
+      
+      # What follows is a very simplistic implementation of link_to
+      link_text, url, html_options = arguments[0..2]
+      html_options[:href] = url
+      attr_string = html_options.map do | attribute, value |
+        '%s="%s"' %  [Rack::Utils.escape_html(attribute), Rack::Utils.escape_html(value)]
+      end.join(' ')
+      
+      # Compose the tag
+      return "<a %s>%s</a>" % [attr_string, Rack::Utils::escape_html(link_text)]
     end
     
     # Returns an array of pages to link to. This array includes the separator, so
@@ -100,4 +132,4 @@ module PeijiSan
       end
     end
   end
-end
+end

data/test/peiji_san_test.rb

@@ -1,17 +1,18 @@
+# -*- encoding : utf-8 -*-
 require File.expand_path('../test_helper', __FILE__)
 
 describe "A model extended by PeijiSan" do
   it "should define an #entries_per_page= class method with which the max amount of entries per page is specified" do
-    Member.should.respond_to :entries_per_page=
-    Member.instance_variable_get(:@entries_per_page).should.be 10
+    Member.must_respond_to :entries_per_page=
+    Member.instance_variable_get(:@entries_per_page).must_equal 10
   end
   
   it "should define an #entries_per_page reader method" do
-    Member.entries_per_page.should == 10
+    Member.entries_per_page.must_equal 10
   end
   
   it "should have defined a #page class method and added it to the class's scopes" do
-    Member.should.respond_to :page
+    Member.must_respond_to :page
   end
 end
 
@@ -27,38 +28,38 @@ describe "The PeijiSan extended scope" do
   
   it "returns entries for the specified page" do
     page_1 = Member.page(1)
-    page_1.length.should.be 10
-    page_1.should == Member.find(:all, :offset => 0, :limit => 10)
+    page_1.length.must_equal 10
+    page_1.must_equal Member.find(:all, :offset => 0, :limit => 10)
   end
   
   it "returns the correct count of pages" do
-    Member.all_like_krs_1.page(1).page_count.should.be 11
+    Member.all_like_krs_1.page(1).page_count.must_equal 11
   end
   
   it "knows the current page number" do
-    Member.page(2).current_page.should.be 2
-    Member.page(4).current_page.should.be 4
+    Member.page(2).current_page.must_equal 2
+    Member.page(4).current_page.must_equal 4
   end
   
   it "knows if there's a next page" do
-    Member.page(1).should.next_page
-    Member.page(20).should.not.next_page
-    Member.all_like_krs_1.but_ending_with_9.page(1).should.not.next_page
+    Member.page(1).next_page.wont_be_nil
+    Member.page(20).next_page.must_be_nil
+    Member.all_like_krs_1.but_ending_with_9.page(1).next_page.must_be_nil
   end
   
   it "returns the next page number" do
-    Member.page(1).next_page.should.be 2
-    Member.page(20).next_page.should.be nil
+    Member.page(1).next_page.must_equal 2
+    Member.page(20).next_page.must_be_nil
   end
   
   it "knows if there's a previous page" do
-    Member.page(1).should.not.previous_page
-    Member.page(20).should.previous_page
+    Member.page(1).previous_page.must_be_nil
+    Member.page(20).previous_page.wont_be_nil
   end
   
   it "returns the previous page" do
-    Member.page(1).previous_page.should.be nil
-    Member.page(20).previous_page.should.be 19
+    Member.page(1).previous_page.must_equal nil
+    Member.page(20).previous_page.must_equal 19
   end
   
   it "knows if a given page number is the current page" do
@@ -67,30 +68,30 @@ describe "The PeijiSan extended scope" do
   end
   
   it "defaults to page 1 if no valid page argument was given" do
-    Member.page(nil).current_page.should.be 1
-    Member.page('').current_page.should.be 1
+    Member.page(nil).current_page.must_equal 1
+    Member.page('').current_page.must_equal 1
   end
   
   it "casts the page argument to an integer" do
-    Member.page('2').current_page.should.be 2
+    Member.page('2').current_page.must_equal 2
   end
   
   it "takes an optional second argument which overrides the entries_per_page setting" do
-    Member.all_like_krs_1.page(1, 20).page_count.should.be 6
+    Member.all_like_krs_1.page(1, 20).page_count.must_equal 6
   end
   
   it "returns the count of all the entries across all pages for the current scope" do
-    Member.all_like_krs_1.page(1).unpaged_count.should.be 110
-    Member.all_like_krs_1.page(2).unpaged_count.should.be 110
-    Member.all_like_krs_1.but_ending_with_9.page(1).unpaged_count.should.be 10
+    Member.all_like_krs_1.page(1).unpaged_count.must_equal 110
+    Member.all_like_krs_1.page(2).unpaged_count.must_equal 110
+    Member.all_like_krs_1.but_ending_with_9.page(1).unpaged_count.must_equal 10
   end
   
   it "works when chained with other regular named scopes" do
-    Member.all_like_krs_1.page(1).page_count.should.be 11
-    Member.all_like_krs_1.but_ending_with_9.page(2).page_count.should.be 1
+    Member.all_like_krs_1.page(1).page_count.must_equal 11
+    Member.all_like_krs_1.but_ending_with_9.page(2).page_count.must_equal 1
     
-    Member.all_like_krs_1.page(2).should == Member.find(:all, :conditions => "name LIKE 'KRS 1%'", :offset => 10, :limit => 10)
-    Member.all_like_krs_1.but_ending_with_9.page(1).should == Member.find(:all, :conditions => "name LIKE 'KRS 1%' AND name LIKE '%9'", :offset => 0, :limit => 10)
+    Member.all_like_krs_1.page(2).must_equal Member.find(:all, :conditions => "name LIKE 'KRS 1%'", :offset => 10, :limit => 10)
+    Member.all_like_krs_1.but_ending_with_9.page(1).must_equal Member.find(:all, :conditions => "name LIKE 'KRS 1%' AND name LIKE '%9'", :offset => 0, :limit => 10)
   end
   
   it "should still work when chained through an association proxy" do
@@ -99,10 +100,10 @@ describe "The PeijiSan extended scope" do
     5.times { member.works.create(:status => 'new') }
     
     page = member.reload.works.uploaded.page(1)
-    page.length.should.be 5
-    page.page_count.should.be 4
-    member.works.uploaded.page(4).length.should.be 1
+    page.length.must_equal 5
+    page.page_count.must_equal 4
+    member.works.uploaded.page(4).length.must_equal 1
     
-    member.works.page(1).page_count.should.be 5
+    member.works.page(1).page_count.must_equal 5
   end
-end
+end

data/test/sinatra_test.rb

@@ -0,0 +1,43 @@
+# -*- encoding : utf-8 -*-
+require File.expand_path('../test_helper', __FILE__)
+require 'rack/test'
+require 'sinatra/base'
+require 'sinatra/url_for'
+require 'rexml/document'
+
+class SimplisticApp < Sinatra::Base
+  helpers Sinatra::UrlForHelper, PeijiSan::ViewHelper
+  include Mocha::API
+  
+  enable :raise_errors
+  
+  get '/' do
+    collection = stub('Artists paginated collection')
+    collection.stubs(:current_page?).with(1).returns(false)
+    collection.stubs(:current_page?).with(2).returns(false)
+    collection.stubs(:page_count).returns(125)
+    link_to_page(2, collection)
+  end
+end
+
+ENV['RACK_ENV'] = 'test'
+
+describe "A Sinatra app that uses Peiji-San" do
+  include Rack::Test::Methods
+  
+  def app
+    SimplisticApp
+  end
+  
+  def query_hash(link)
+    query = REXML::Document.new(link).root.attributes['href'].match(/\?(.+)$/)[1]
+    Rack::Utils.parse_query(query)
+  end
+  
+  it "has it's link_to_page method put in place and operational" do
+    get '/'
+    last_response.status.must_equal 200
+    query_hash(last_response.body).must_equal 'page' => '2'
+  end
+end
+

data/test/test_helper.rb

@@ -1,17 +1,21 @@
+# -*- encoding : utf-8 -*-
+
 module PeijiSanTest
   module Initializer
     def self.load_dependencies
-      $:.unshift File.expand_path('../../lib', __FILE__)
-      
-      require 'rubygems' rescue LoadError
-      
+      require 'rubygems'
+      require 'bundler'
+      Bundler.require
+
+      require 'minitest/autorun'
+      require 'minitest/spec'
+      require 'mocha'
+
       require 'active_support'
       require 'active_record'
       require 'action_view'
-      
-      require 'test/spec'
-      require 'mocha'
-      
+
+      $:.unshift File.expand_path('../../lib', __FILE__)
       require File.expand_path('../../init', __FILE__)
     end
     
@@ -65,4 +69,4 @@ class Work < ActiveRecord::Base
   self.entries_per_page = 5
   
   scope :uploaded, where(:status => 'uploaded')
-end
+end

data/test/view_helper_test.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require File.expand_path('../test_helper', __FILE__)
 
 class TestController
@@ -44,35 +45,35 @@ describe "PeijiSan::ViewHelper::link_to_page" do
   include PeijiSan::ViewHelper
   
   it "should return a link for a given page number" do
-    link_to_page(2, collection).should == '<a href="/collections?page=2">2</a>'
+    link_to_page(2, collection).must_equal '<a href="/collections?page=2">2</a>'
   end
   
   it "should return a link for a given page number with the specified page parameter" do
-    link_to_page(2, collection, :page_parameter => 'pagina').should == '<a href="/collections?pagina=2">2</a>'
+    link_to_page(2, collection, :page_parameter => 'pagina').must_equal '<a href="/collections?pagina=2">2</a>'
   end
   
   it "should return a link for a given page number with the specified anchor" do
-    link_to_page(2, collection, :anchor => 'dude_so_many_pages').should == '<a href="/collections?page=2#dude_so_many_pages">2</a>'
+    link_to_page(2, collection, :anchor => 'dude_so_many_pages').must_equal '<a href="/collections?page=2#dude_so_many_pages">2</a>'
   end
   
   it "should return a link for a given page number and include the original params" do
     controller.params[:starts_with] = 'h'
-    link_to_page(2, collection).should == '<a href="/collections?page=2&amp;starts_with=h">2</a>'
+    link_to_page(2, collection).must_equal '<a href="/collections?page=2&amp;starts_with=h">2</a>'
   end
   
   it "should return a link which does not include the page GET variable if it's page number 1" do
     controller.params[:page] = 34
-    link_to_page(1, collection).should.not.match /page=\d+/
+    link_to_page(1, collection).wont_match /page=\d+/
   end
   
   it "should return a link with the class current if it's for the currently selected page" do
     collection.stubs(:current_page?).with(2).returns(true)
-    link_to_page(2, collection).should == '<a href="/collections?page=2" class="current">2</a>'
+    link_to_page(2, collection).must_equal '<a href="/collections?page=2" class="current">2</a>'
   end
   
   it "should return a link with the class current if it's for the currently selected page" do
     collection.stubs(:current_page?).with(2).returns(true)
-    link_to_page(2, collection, :current_class => 'looking_at').should == '<a href="/collections?page=2" class="looking_at">2</a>'
+    link_to_page(2, collection, :current_class => 'looking_at').must_equal '<a href="/collections?page=2" class="looking_at">2</a>'
   end
 end
 
@@ -82,56 +83,56 @@ describe "PeijiSan::ViewHelper::pages_to_link_to" do
   
   it "should return a list of page numbers that should be included in the pagination list" do
     collection.stubs(:current_page).returns(83)
-    pages_to_link_to(collection).should == [1, '…', 80, 81, 82, 83, 84, 85, 86, '…', 125]
+    pages_to_link_to(collection).must_equal [1, '…', 80, 81, 82, 83, 84, 85, 86, '…', 125]
   end
   
   it "should return a list of page links with an ellips between page 1 and the next if the current page is at the end of the list" do
     collection.stubs(:current_page).returns(119)
-    pages_to_link_to(collection).should == [1, '…', 116, 117, 118, 119, 120, 121, 122, '…', 125]
+    pages_to_link_to(collection).must_equal [1, '…', 116, 117, 118, 119, 120, 121, 122, '…', 125]
     
     120.upto(124) do |page|
       collection.stubs(:current_page).returns(page)
-      pages_to_link_to(collection).should == [1, '…', 117, 118, 119, 120, 121, 122, 123, 124, 125]
+      pages_to_link_to(collection).must_equal [1, '…', 117, 118, 119, 120, 121, 122, 123, 124, 125]
     end
   end
   
   it "should return a list of page links with an ellips between the last page and the previous one if the current page is at the beginning of the list" do
     1.upto(6) do |page|
       collection.stubs(:current_page).returns(page)
-      pages_to_link_to(collection).should == [1, 2, 3, 4, 5, 6, 7, 8, 9, '…', 125]
+      pages_to_link_to(collection).must_equal [1, 2, 3, 4, 5, 6, 7, 8, 9, '…', 125]
     end
     
     collection.stubs(:current_page).returns(7)
-    pages_to_link_to(collection).should == [1, '…', 4, 5, 6, 7, 8, 9, 10, '…', 125]
+    pages_to_link_to(collection).must_equal [1, '…', 4, 5, 6, 7, 8, 9, 10, '…', 125]
   end
   
   it "should not show an ellips but all pages if there are only 10 pages, this is the threshold for when an ellips starts to be necessary" do
     collection.stubs(:page_count).returns(10)
     collection.stubs(:current_page).returns(5)
-    pages_to_link_to(collection).should == (1..10).to_a
+    pages_to_link_to(collection).must_equal((1..10).to_a)
   end
   
   it "should not return more page links if there aren't that many pages" do
     1.upto(9) do |page|
       collection.stubs(:page_count).returns(page)
       collection.stubs(:current_page).returns(page)
-      pages_to_link_to(collection).should == (1..page).to_a
+      pages_to_link_to(collection).must_equal((1..page).to_a)
     end
   end
   
   it "should return a list of page numbers that should be included in the pagination list with the specified number of :max_visible" do
     collection.stubs(:current_page).returns(83)
-    pages_to_link_to(collection, :max_visible => 5).should == [1, '…', 83, '…', 125]
-    pages_to_link_to(collection, :max_visible => 15).should == [1, '…', 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, '…', 125]
+    pages_to_link_to(collection, :max_visible => 5).must_equal [1, '…', 83, '…', 125]
+    pages_to_link_to(collection, :max_visible => 15).must_equal [1, '…', 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, '…', 125]
     
     collection.stubs(:current_page).returns(3)
-    pages_to_link_to(collection, :max_visible => 5).should == [1, 2, 3, '…', 125]
-    pages_to_link_to(collection, :max_visible => 15).should == (1..13).to_a + ['…', 125]
+    pages_to_link_to(collection, :max_visible => 5).must_equal [1, 2, 3, '…', 125]
+    pages_to_link_to(collection, :max_visible => 15).must_equal( (1..13).to_a + ['…', 125] )
   end
   
   it "should return a list of page numbers with the specified separator instead of the default ellips" do
     collection.stubs(:current_page).returns(83)
-    pages_to_link_to(collection, :separator => '...').should == [1, '...', 80, 81, 82, 83, 84, 85, 86, '...', 125]
+    pages_to_link_to(collection, :separator => '...').must_equal [1, '...', 80, 81, 82, 83, 84, 85, 86, '...', 125]
   end
 end
 
@@ -148,25 +149,25 @@ describe "ApplicationHelper, when overriding defaults" do
   include ApplicationHelperWithDefaults
   
   it "should return a link for a given page number with the specified page parameter" do
-    link_to_page(2, collection).should == '<a href="/collections?pagina=2#dude_so_many_pages">2</a>'
+    link_to_page(2, collection).must_equal '<a href="/collections?pagina=2#dude_so_many_pages">2</a>'
   end
   
   it "should return a link for a given page number with the specified anchor" do
-    link_to_page(2, collection).should == '<a href="/collections?pagina=2#dude_so_many_pages">2</a>'
+    link_to_page(2, collection).must_equal '<a href="/collections?pagina=2#dude_so_many_pages">2</a>'
   end
   
   it "should return a link with the class current if it's for the currently selected page" do
     collection.stubs(:current_page?).with(2).returns(true)
-    link_to_page(2, collection, :current_class => 'looking_at').should == '<a href="/collections?pagina=2#dude_so_many_pages" class="looking_at">2</a>'
+    link_to_page(2, collection, :current_class => 'looking_at').must_equal '<a href="/collections?pagina=2#dude_so_many_pages" class="looking_at">2</a>'
   end
   
   it "should return a list of page numbers that should be included in the pagination list with the specified number of :max_visible" do
     collection.stubs(:current_page).returns(3)
-    pages_to_link_to(collection).should == [1, 2, 3, '...', 125]
+    pages_to_link_to(collection).must_equal [1, 2, 3, '...', 125]
   end
   
   it "should return a list of page numbers with the specified separator instead of the default ellips" do
     collection.stubs(:current_page).returns(83)
-    pages_to_link_to(collection).should == [1, '...', 83, '...', 125]
+    pages_to_link_to(collection).must_equal [1, '...', 83, '...', 125]
   end
-end
+end