paginate-responder 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paginate-responder.gemspec
+gemspec
+
+group :development do
+  gem 'minitest'
+  gem 'rake'
+  gem 'rack-link_headers', :path => '../rack-link-headers'
+end
+
+group :test do
+  gem 'will_paginate'
+  gem 'actionpack'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jan Graichen
+
+MIT License
+
+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,86 @@
+# Paginate::Responder
+
+A Rails pagination responder with link header support.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paginate-responder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paginate-responder
+
+You will also need a pagination gem like
+[will_paginate](mislav/will_paginate).
+
+## Usage
+
+Add `Responders::PaginateResponder` to your responder chain:
+
+```ruby
+class AppResponder < Responder
+  include Responders::PaginateResponder
+end
+
+class MyController < ApplicationController
+  self.responder = AppResponder
+end
+```
+
+Or use it with [plataformatec/responders](https://github.com/plataformatec/responders):
+
+```ruby
+class MyController < ApplicationController
+  responders Responders::PaginateResponder
+end
+```
+
+`PaginateResponder` will add the following link headers to
+non HTML responses:
+
+* *first* First page's URL.
+* *last* Last page's URL.
+* *next* Next page's URL.
+* *prev* Previous page's URL.
+
+Next and previous page links will not be added if current
+page is first or last page.
+
+Also a `X-Total-Pages` header will be added with the total
+number of pages if available. This allows applications
+to display a progress bar or similar while fetching pages.
+
+`PaginateResponder` should work with any pagination gem that
+adds a `paginate` method to collections. Tests run with
+[will_paginate](mislav/will_paginate).
+
+The `total_pages` method on the collection will be used as
+total page count. If not total page method is present or
+nil is returned some link header may be missing.
+
+## TODOs
+
+* Documentation
+** Controller methods
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add tests for your feature.
+4. Add your feature.
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+## License
+
+[MIT License](http://www.opensource.org/licenses/mit-license.php)
+
+Copyright (c) 2013, Jan Graichen

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/paginate-responder.rb

@@ -0,0 +1,9 @@
+require 'rack-link_headers'
+
+module Responders
+  autoload :PaginateResponder, 'responders/paginate_responder'
+end
+
+module PaginateResponder
+  autoload :VERSION, 'paginate-responder/version'
+end

data/lib/paginate-responder/version.rb

@@ -0,0 +1,12 @@
+module PaginateResponder
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+    STAGE = nil
+
+    def self.to_s
+      [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join '.'
+    end
+  end
+end

data/lib/responders/paginate_responder.rb

@@ -0,0 +1,46 @@
+
+module Responders
+  module PaginateResponder
+    def to_format
+      if get? && resource.respond_to?(:paginate)
+        @resource = resource.paginate :page => self.page, :per_page => self.per_page
+
+        controller.response.link("first", controller.url_for(request.params.merge(:page => 1)))
+        controller.response.link("prev", controller.url_for(request.params.merge(:page => page - 1))) if page > 1
+        controller.response.link("next", controller.url_for(request.params.merge(:page => page + 1))) if total_pages && (page+1) < total_pages
+        controller.response.link("last", controller.url_for(request.params.merge(:page => total_pages))) if total_pages
+        controller.response.headers["X-Total-Pages"] = total_pages if total_pages
+      end
+      super
+    end
+
+    def page
+      @page ||= controller.page if controller.respond_to? :page
+      @page ||= controller.params[:page].try(:to_i)
+      @page ||= 1
+      @page
+    rescue
+      1
+    end
+
+    def total_pages
+      @total_pages ||= resource.total_pages if resource.respond_to? :total_pages
+      @total_pages
+    end
+
+    def per_page
+      @per_page ||= controller.per_page if controller.respond_to? :per_page
+      @per_page ||= controller.params[:per_page].try(:to_i)
+      @per_page = [[1, @per_page].max, max_per_page].min
+      @per_page
+    rescue
+      max_per_page
+    end
+
+    def max_per_page
+      @max_per_page ||= controller.max_per_page if controller.respond_to? :max_per_page
+      @max_per_page ||= 50
+      @max_per_page
+    end
+  end
+end

data/paginate-responder.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paginate-responder/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "paginate-responder"
+  gem.version       = PaginateResponder::VERSION
+  gem.authors       = ["Jan Graichen"]
+  gem.email         = ["jg@altimos.de"]
+  gem.description   = %q{A Rails pagination responder with link header support.}
+  gem.summary       = %q{A Rails pagination responder with link header support.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rack-link_headers'
+end

data/test/paginate_responder_test.rb

@@ -0,0 +1,104 @@
+require 'test_helper.rb'
+
+class PaginateResponderTest < ActionController::TestCase
+  tests PaginateController
+
+  def json; JSON[@response.body] end
+
+  def test_pagination
+    get :index, :format => :json
+
+    assert_equal 50, json.size
+    assert_equal ('AA'..'zz').to_a[0..49], json
+  end
+
+  def test_pagination_page_2
+    get :index, :format => :json, :page => 2
+
+    assert_equal 50, json.size
+    assert_equal ('AA'..'zz').to_a[50..99], json
+  end
+
+  def test_pagination_per_page
+    get :index, :format => :json, :page => 1, :per_page => 10
+
+    assert_equal 10, json.size
+    assert_equal ('AA'..'zz').to_a[0..9], json
+  end
+
+  def test_pagination_per_page_page_2
+    get :index, :format => :json, :page => 2, :per_page => 10
+
+    assert_equal 10, json.size
+    assert_equal ('AA'..'zz').to_a[10..19], json
+  end
+
+  def test_headers
+    get :index, :format => :json
+
+    assert_equal 3, response.links.size
+
+    assert_equal "first", response.links[0][:rel]
+    assert_equal "http://test.host/index.json?page=1", response.links[0][:url]
+
+    assert_equal "next", response.links[1][:rel]
+    assert_equal "http://test.host/index.json?page=2", response.links[1][:url]
+
+    assert_equal "last", response.links[2][:rel]
+    assert_equal "http://test.host/index.json?page=14", response.links[2][:url]
+  end
+
+  def test_headers_page_5
+    get :index, :format => :json, :page => 5
+
+    assert_equal 4, response.links.size
+
+    assert_equal "first", response.links[0][:rel]
+    assert_equal "http://test.host/index.json?page=1", response.links[0][:url]
+
+    assert_equal "prev", response.links[1][:rel]
+    assert_equal "http://test.host/index.json?page=4", response.links[1][:url]
+
+    assert_equal "next", response.links[2][:rel]
+    assert_equal "http://test.host/index.json?page=6", response.links[2][:url]
+
+    assert_equal "last", response.links[3][:rel]
+    assert_equal "http://test.host/index.json?page=14", response.links[3][:url]
+  end
+
+  def test_headers_last_page
+    get :index, :format => :json, :page => 14
+
+    assert_equal 3, response.links.size
+
+    assert_equal "first", response.links[0][:rel]
+    assert_equal "http://test.host/index.json?page=1", response.links[0][:url]
+
+    assert_equal "prev", response.links[1][:rel]
+    assert_equal "http://test.host/index.json?page=13", response.links[1][:url]
+
+    assert_equal "last", response.links[2][:rel]
+    assert_equal "http://test.host/index.json?page=14", response.links[2][:url]
+  end
+
+  def test_headers_per_page
+    get :index, :format => :json, :page => 1, :per_page => 10
+
+    assert_equal 3, response.links.size
+
+    assert_equal "first", response.links[0][:rel]
+    assert_equal "http://test.host/index.json?page=1&per_page=10", response.links[0][:url]
+
+    assert_equal "next", response.links[1][:rel]
+    assert_equal "http://test.host/index.json?page=2&per_page=10", response.links[1][:url]
+
+    assert_equal "last", response.links[2][:rel]
+    assert_equal "http://test.host/index.json?page=68&per_page=10", response.links[2][:url]
+  end
+
+  def test_headers_total_pages
+    get :index, :format => :json
+
+    assert_equal "14", response.headers["X-Total-Pages"].to_s
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+require 'minitest/autorun'
+require 'bundler'
+
+Bundler.setup
+
+# Configure Rails
+ENV["RAILS_ENV"] = "test"
+
+require 'active_support'
+require 'action_controller'
+require 'will_paginate/array'
+
+require 'paginate-responder'
+
+Responders::Routes = ActionDispatch::Routing::RouteSet.new
+Responders::Routes.draw do
+  match '/index' => 'paginate#index'
+end
+
+class ActiveSupport::TestCase
+  setup do
+    @routes = Responders::Routes
+  end
+end
+
+class PaginationResponder < ActionController::Responder
+  include Responders::PaginateResponder
+end
+
+class PaginateController < ActionController::Base
+  include Responders::Routes.url_helpers
+
+  self.responder = PaginationResponder
+  respond_to :json
+
+  def index
+    respond_with ('AA'..'zz').to_a
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: paginate-responder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jan Graichen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-link_headers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails pagination responder with link header support.
+email:
+- jg@altimos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paginate-responder.rb
+- lib/paginate-responder/version.rb
+- lib/responders/paginate_responder.rb
+- paginate-responder.gemspec
+- test/paginate_responder_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1984734961715854545
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1984734961715854545
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Rails pagination responder with link header support.
+test_files:
+- test/paginate_responder_test.rb
+- test/test_helper.rb