sinatra-pagin 0.0.2 → 0.0.3

data/Changelog.md

@@ -1,3 +1,8 @@
+### sinatra-pagin - 0.0.3 / 2010-08-01
+
+* #href_for_pagin now accepts overrides for the base uri to be used when attaching the page/#
+* Helper registration is now manual, i've removed the registration call.
+
 ### sinatra-pagin - 0.0.2 / 2010-02-15
 
 * Added a new helper method `href_for_pagin` to help facilitate creating pagination hrefs for use with pagin.

data/README.md

@@ -3,30 +3,29 @@ Sinatra::Pagin*
 
 Small utility to process paginated urls without modifying the mapped paths in your Sinatra app
 
----
-
-### FEATURES/PROBLEMS:
+## Overview/Usage:
 
-* Parses ../page/# off your urls to allow simple route mappings
-* Saves page # for internal use
 
-### SYNOPSIS:
+#### Basics:
 
 Given you have mapped paths as such:
 
     get "/" do
       "hello world"
     end
-    
-    # => "http://example.org/"
+    #=> "http://example.org/"
     
     get "/a/pathed/path" do
       "foo bar"
     end
-    
-    # => "http://example.org/a/pathed/path"
+    #=> "http://example.org/a/pathed/path"
+
+Without changing those paths, you can run a paginated url. 
+
+    require 'sinatra/pagin
+    Sinatra::Application.register Sinatra::Pagin
 
-Without changing those paths, you can run a paginated url.
+###  
 
     http://example.org/page/2
     # => get "/"
@@ -34,18 +33,39 @@ Without changing those paths, you can run a paginated url.
     http://example.org/a/pathed/path/page/45
     # => get "/a/pathed/path"
 
-Use the helper method `page` to get the provide page number.
+*This is based on "pretty" style urls, page parameters sent in via the query string (.../?page=2) will be processed by Sinatra's usual params.
+
+#### Helpers:
+
+`page` returns the parsed "page" number.
 
     http://example.org/page/2
     
     get "/" do
       "hello world, you asked for page #{page}"
     end
-    
     # => hello world, you asked for page 2
 
 `page` returns 1 as a default.
 
+##  
+
+`href_for_pagin(total_pages, direction => :next)` href builder to build pagin valid hrefs for next & previous links based on the currently requested uri.
+
+- total_pages => Integer (Required)
+- direction => Symbol [:next | :prev] \(Defaults to => :next)
+
+---
+    http://example.org/2009/10/page/2
+    
+    href_for_pagin 4, :next
+    #=> /2009/10/page/3
+    
+    href_for_pagin 4, :prev
+    #=> /2009/10/page/1
+
+## Additional notes:
+
 It also supports `.:format` in your path.
 
     get "/a/pathed/path.:format" do
@@ -56,22 +76,27 @@ It also supports `.:format` in your path.
     # => path_info == /a/pathed/path.js
     # => page == 45
 
-### REQUIREMENTS:
+## Requirements:
 
 * [Sinatra](http://www.sinatrarb.com/)
 
-### INSTALL:
+## Install:
 
 Install the gem:
 
     sudo gem install sinatra-pagin
 
-Require in your app:
+Require & Register in your app:
 
     require 'sinatra/pagin'
 
----
-### LICENSE:
+    Sinatra::Application.register Sinatra::Pagin
+
+## Integrity
+
+[Checked by Integrity](http://ci.damncarousel.com)
+
+## License:
 
 (The MIT License)
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/sinatra/pagin.rb

@@ -26,8 +26,12 @@ module Sinatra
         @page || 1
       end
       
-      def href_for_pagin(total_pages, direction = :next)
-        path_info = request.path_info.gsub(/\/$/, '') # clear off the last slash just in case
+      def href_for_pagin(total_pages, direction = :next, override = nil)
+        if override.nil?
+          path_info = request.path_info.gsub(/\/$/, '') # clear off the last slash just in case
+        else
+          path_info = override
+        end
         page_num  = 1
         
         case
@@ -41,6 +45,4 @@ module Sinatra
       end
     end
   end
-  
-  Sinatra::Application.register Pagin
-end
+end

data/sinatra-pagin.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra-pagin}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Yung Hwa Kwon"]
-  s.date = %q{2010-02-15}
+  s.date = %q{2010-08-01}
   s.description = %q{Small utility to process paginated urls without modifying the mapped paths in your Sinatra app}
   s.email = %q{yung.kwon@nowk.net}
   s.extra_rdoc_files = [
@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/nowk/sinatra-pagin}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Small utility to process paginated urls without modifying the mapped paths in your Sinatra app}
   s.test_files = [
     "spec/pagin_spec.rb",
@@ -42,7 +42,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<sinatra>, [">= 0.9.4"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.8"])
       s.add_development_dependency(%q<webrat>, [">= 0.7.0"])

data/spec/pagin_spec.rb

@@ -194,6 +194,11 @@ describe 'Sinatra' do
           page 3
           href_for_pagin(3, :next).should == "/2009/10/page/3"
         end
+
+        it "allows for the base path to be overridden" do
+          page 2
+          href_for_pagin(3, :next, '/base/path').should == '/base/path/page/3'
+        end
       end
       
       context "within an actual app" do
@@ -244,4 +249,4 @@ describe 'Sinatra' do
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-pagin
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Yung Hwa Kwon
@@ -9,49 +15,73 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-15 00:00:00 -05:00
+date: 2010-08-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sinatra
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 9
+        - 4
         version: 0.9.4
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 2
+        - 8
         version: 1.2.8
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: webrat
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 7
+        - 0
         version: 0.7.0
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rack-test
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
         version: 0.5.2
-    version: 
+  type: :development
+  version_requirements: *id004
 description: Small utility to process paginated urls without modifying the mapped paths in your Sinatra app
 email: yung.kwon@nowk.net
 executables: []
@@ -82,21 +112,27 @@ 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"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Small utility to process paginated urls without modifying the mapped paths in your Sinatra app