sinatra-pagin 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+doc
+pkg
+rcov
+vendor
+bin

data/Changelog.md

@@ -0,0 +1,3 @@
+### sinatra-pagin - 0.0.1 / 2010-02-14
+
+* Initial Release

data/Gemfile

@@ -0,0 +1,8 @@
+
+only :test do
+  gem 'sinatra', '>= 0.9.4'
+  # these should be installed on your testing location
+  #gem 'rack-test', '>= 0.5.2'
+  #gem 'rspec', '>= 1.2.8'
+  #gem 'webrat', '>= 0.7.0'
+end

data/README.md

@@ -0,0 +1,97 @@
+Sinatra::Pagin*
+=
+
+Small utility to process paginated urls without modifying the mapped paths in your Sinatra app
+
+---
+
+### FEATURES/PROBLEMS:
+
+* Parses ../page/# off your urls to allow simple route mappings
+* Saves page # for internal use
+
+### SYNOPSIS:
+
+Given you have mapped paths as such:
+
+    get "/" do
+      "hello world"
+    end
+    
+    # => "http://example.org/"
+    
+    get "/a/pathed/path" do
+      "foo bar"
+    end
+    
+    # => "http://example.org/a/pathed/path"
+
+Without changing those paths, you can run a paginated url.
+
+    http://example.org/page/2
+    # => get "/"
+    
+    http://example.org/a/pathed/path/page/45
+    # => get "/a/pathed/path"
+
+Use the helper method `page` to get the provide 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.
+
+It also supports `.:format` in your path.
+
+    get "/a/pathed/path.:format" do
+      "foo bar"
+    end
+    
+    http://example.org/a/pathed/path/page/45.js
+    # => path_info == /a/pathed/path.js
+    # => page == 45
+
+### REQUIREMENTS:
+
+* [Sinatra](http://www.sinatrarb.com/)
+
+### INSTALL:
+
+Install the gem:
+
+    sudo gem install sinatra-pagin
+
+Require in your app:
+
+    require 'sinatra/pagin'
+
+---
+### LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Yung Hwa Kwon (yung.kwon@nowk.net)
+
+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/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+
+# GEM
+begin
+  require 'jeweler'
+  
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra-pagin"
+    gem.summary = %Q{Small utility to process paginated urls without modifying the mapped paths in your Sinatra app}
+    gem.description = %Q{Small utility to process paginated urls without modifying the mapped paths in your Sinatra app}
+    gem.email = "yung.kwon@nowk.net"
+    gem.homepage = "http://github.com/nowk/sinatra-pagin"
+    gem.authors = ["Yung Hwa Kwon"]
+    gem.add_dependency "sinatra", ">= 0.9.4"
+    
+    { 'rack-test' => '>= 0.5.2',
+      'rspec' => '>= 1.2.8',
+      'webrat' => '>= 0.7.0'
+    }.each_pair do |g, v|
+      gem.add_development_dependency g, v
+    end
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+# Test Rakes
+begin
+  require 'spec'
+  require 'spec/rake/spectask'
+  
+  task :default => :spec
+  
+  desc "Run Rspec tests"
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    #t.spec_opts = ['spec/spec.opts']
+    t.spec_files = FileList['spec/*_spec.rb']
+  end
+  
+  desc "Run CI tests"
+  task :ci => 'setup:gem_bundle'  do
+    Rake::Task[:spec].invoke
+  end
+  
+  namespace :setup do
+    desc "Setup required gems/goodies for CI test. Server has only the essential minimums."
+    task :gem_bundle do
+      sh "gem bundle --only test"
+      require "vendor/gems/environment"
+    end
+  end
+  
+rescue LoadError
+  puts "I <3 Rspec, or any good testing unit for that matter."
+  puts "RSpec required. To install Rspec, please run sudo gem install rspec."
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/sinatra/pagin.rb

@@ -0,0 +1,32 @@
+require 'sinatra/base'
+
+module Sinatra
+  module Pagin
+    def self.registered(app)
+      app.helpers Pagin::Helpers
+      
+      app.before do
+        page_pattern = /\/page\/(\d+)(\/)?(\.[^\.\/]+)?$/
+        request.path_info.match(page_pattern)
+        
+        if $1
+          page $1
+          request.path_info = request.path_info.gsub!(page_pattern, '')+$3.to_s
+          request.path_info.gsub!(/^(?!\/)/) { |s| "/"+s } # force the first slash if not avail
+        end
+      end
+    end
+    
+    module Helpers
+      def page(pg = 1)
+        unless pg == 1
+          @page = pg.to_i
+        end
+        
+        @page || 1
+      end
+    end
+  end
+  
+  Sinatra::Application.register Pagin
+end

data/sinatra-pagin.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sinatra-pagin}
+  s.version = "0.0.1"
+
+  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.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 = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "Changelog.md",
+     "Gemfile",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/sinatra/pagin.rb",
+     "sinatra-pagin.gemspec",
+     "spec/pagin_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  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.summary = %q{Small utility to process paginated urls without modifying the mapped paths in your Sinatra app}
+  s.test_files = [
+    "spec/pagin_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= 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"])
+      s.add_development_dependency(%q<rack-test>, [">= 0.5.2"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+      s.add_dependency(%q<rspec>, [">= 1.2.8"])
+      s.add_dependency(%q<webrat>, [">= 0.7.0"])
+      s.add_dependency(%q<rack-test>, [">= 0.5.2"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+    s.add_dependency(%q<rspec>, [">= 1.2.8"])
+    s.add_dependency(%q<webrat>, [">= 0.7.0"])
+    s.add_dependency(%q<rack-test>, [">= 0.5.2"])
+  end
+end
+

data/spec/pagin_spec.rb

@@ -0,0 +1,167 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class MyTestApp < Sinatra::Base
+  set :environment, :test
+  
+  get "/"do
+    "Hello World!"
+  end
+  
+  get "/a/pathed" do
+    "Foo Bar!"
+  end
+end
+
+describe 'Sinatra' do
+  
+  def app
+    @app ||= MyTestApp
+  end
+  
+  def get_absolute(uri)
+    page_pattern = /\/page\/(\d+)(\/)?(\.[^\.\/]+)?$/
+    uri.match(page_pattern)
+    
+    if $1
+      uri = uri.gsub(page_pattern, '')+$3.to_s
+      uri.gsub!(/^(?!\/)/) { |s| "/"+s }
+    end
+    
+    return uri
+  end
+  
+  describe "MyTestApp" do
+    it "should actually work" do
+      get "/" do |response|
+        response.should be_ok
+        response.should contain "Hello World!"
+      end
+      
+      get "/a/pathed" do |response|
+        response.should be_ok
+        response.should contain "Foo Bar!"
+      end
+    end
+  end
+  
+  describe "without Pagin" do
+    ["/", "/a/pathed"].each do |uri|
+      it "should respond ok to #{uri}" do
+        get uri
+        last_response.should be_ok
+        last_request.url.should == "http://example.org#{uri}"
+      end
+    end
+    
+    ["/page/45", "/a/pathed/page/2"].each do |uri|
+      it "should not respond ok to #{uri}" do
+        get uri
+        last_response.should_not be_ok
+        last_response.status.should == 404
+        last_request.url.should == "http://example.org#{uri}"
+      end
+    end
+  end
+  
+  describe "with Pagin" do
+    before(:all) do
+      MyTestApp.register Sinatra::Pagin
+    end
+    
+    ["/", "/a/pathed"].each do |uri|
+      it "should respond ok to #{uri}" do
+        get uri
+        last_response.should be_ok
+        last_request.url.should == "http://example.org#{uri}"
+      end
+    end
+    
+    ["/page/123", "/a/pathed/page/32"].each do |uri|
+      it "should respond ok to #{uri}" do
+        get uri
+        last_response.should be_ok
+        last_request.url.should == "http://example.org#{get_absolute(uri)}"
+      end
+    end
+    
+    [
+      "/page",
+      "/page/",
+      "/page/a",
+      "/a/pathed/page", 
+      "/a/pathed/page/",
+      "/a/pathed/page/1two", 
+      "/a/pathed/page/one2three"
+    ].each do |uri|
+      it "should not respond ok to #{uri}" do
+        get uri
+        last_response.should_not be_ok
+        last_response.status.should == 404
+        last_request.url.should == "http://example.org#{uri}"
+      end
+    end
+    
+    it "should not respond ok to multiple interations of /page/# ex: /page/1/page/2" do
+      get "/page/1/page/2"
+      last_response.should_not be_ok
+      last_response.status.should == 404
+      last_request.url.should == "http://example.org/page/1"
+    end
+    
+    it "should accept a page/0" do
+      get "/page/0"
+      last_response.should be_ok
+      last_request.url.should == "http://example.org/"
+    end
+    
+    describe ".:format" do
+      before(:all) do
+        app.get "/a/pathed/with.:format" do
+          "Howdy!"
+        end
+      end
+      
+      it "should respond ok to a path with a .:format" do
+        get "/a/pathed/with.html"
+        last_response.should be_ok
+        last_response.body.should contain "Howdy!"
+        last_request.url.should == "http://example.org/a/pathed/with.html"
+      end
+      
+      it "should reattach the .:format back to the url" do
+        get "/a/pathed/with/page/3.html"
+        last_response.should be_ok
+        last_response.body.should contain "Howdy!"
+        last_request.url.should == "http://example.org/a/pathed/with.html"
+      end
+    end
+  end
+  
+  describe "Helpers" do
+    include Sinatra::Pagin::Helpers
+    
+    describe "current_page" do
+      it "should return 1 if @page.nil?" do
+        page.should == 1
+      end
+      
+      [1, 21, 302, "4", "501", "602"].each do |p|
+        it "should return value of page #{p} in it's integer format" do
+          page p
+          page.should == p.to_i
+        end
+      end
+      
+      it "should actually work inside the app" do
+        app.get "/get/page/value/if" do
+          "The page is #{page}"
+        end
+        
+        get "/get/page/value/if/page/123"
+        last_response.should be_ok
+        last_response.body.should == "The page is 123"
+        last_request.url.should == "http://example.org/get/page/value/if"
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'sinatra'
+require 'sinatra/pagin'
+require 'rack/test'
+require 'spec'
+require 'spec/autorun'
+require "webrat"
+#require 'mocha'
+
+Webrat.configure do |config|
+  config.mode = :rack
+end
+
+Spec::Runner.configure do |config|
+  config.include Rack::Test::Methods
+  config.include Webrat::Methods
+  config.include Webrat::Matchers
+  # config.mock_with :mocha
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-pagin
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Yung Hwa Kwon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-15 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: webrat
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.2
+    version: 
+description: Small utility to process paginated urls without modifying the mapped paths in your Sinatra app
+email: yung.kwon@nowk.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- Changelog.md
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- lib/sinatra/pagin.rb
+- sinatra-pagin.gemspec
+- spec/pagin_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nowk/sinatra-pagin
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Small utility to process paginated urls without modifying the mapped paths in your Sinatra app
+test_files: 
+- spec/pagin_spec.rb
+- spec/spec_helper.rb