clean_pagination 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7871f574a1cd0cc4500390a3dd1930ecb8609203
+  data.tar.gz: e61becc7ff88048882a36f9fd87745ec8f26ad0a
+SHA512:
+  metadata.gz: b6aac0a85646fddc51ec8ecab02c9cd43e33d8e3d41341cb7fec6981be975cba69e01aa89519d9a2c24fa28ae6dff01a6f904532dba5c8b62d2b746c41478e55
+  data.tar.gz: b2b57c95951311739b1d93d92bc2cb5df1413bb10fce058c33110c764b36d610748e2b65a79ab851737cc50e4c797581b3b0b5100d0542f90495a9030e105fa3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CleanPagination'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/clean_pagination/version.rb

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

data/lib/clean_pagination.rb

@@ -0,0 +1,72 @@
+module CleanPagination
+
+  def paginate total_items, max_range_size
+    headers['Accept-Ranges'] = 'items'
+    headers['Range-Unit'] = 'items'
+
+    requested_from, requested_to = 0, total_items - 1
+
+    if request.headers['Range-Unit'] == 'items' &&
+       request.headers['Range'].present?
+      if request.headers['Range'] =~ /(\d+)-(\d+)/
+        requested_from, requested_to = $1.to_i, $2.to_i
+      end
+    end
+
+    if requested_from >= requested_to
+      response.status = 416
+      headers['Content-Range'] = "*/#{total_items}"
+      return
+    end
+
+    available_to = [requested_to,
+                    total_items - 1,
+                    requested_from + max_range_size - 1
+                   ].min
+    headers['Content-Range'] = "#{
+        requested_from
+      }-#{
+        available_to
+      }/#{
+        total_items < Float::INFINITY ? total_items : '*'
+      }"
+
+    available_limit = available_to - requested_from + 1
+    yield available_limit, requested_from
+    if available_limit < total_items && response.status == 200
+      response.status = 206
+    end
+
+    requested_limit = requested_to - requested_from + 1
+
+    links = []
+    if available_to < total_items - 1
+      links << "<#{request.path}>; rel=\"next\"; items=\"#{
+          available_to + 1
+        }-#{
+          available_to + requested_limit
+        }\""
+
+      links << "<#{request.path}>; rel=\"last\"; items=\"#{
+        # let rounding do the work
+        ((total_items-1) / available_limit) * available_limit
+      }-#{
+        (((total_items-1) / available_limit) * available_limit) + requested_limit - 1
+      }\""
+    end
+    if requested_from > 0
+      previous_from = [0, requested_from - [requested_limit, max_range_size].min].max
+
+      links << "<#{request.path}>; rel=\"prev\"; items=\"#{
+          previous_from
+        }-#{
+          previous_from + requested_limit - 1
+        }\""
+
+      links << "<#{request.path}>; rel=\"first\"; items=\"0-#{requested_limit-1}\""
+    end
+
+    headers['Link'] = links.join ', '
+  end
+
+end

data/lib/tasks/clean_pagination_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :clean_pagination do
+#   # Task goes here
+# end

data/test/clean_pagination_test.rb

@@ -0,0 +1,251 @@
+require 'test_helper'
+
+def parse_link_ranges header
+  links = Hash.new
+  (header || '').split(',').each do |link|
+    link =~ /rel="(.*)".*items="(.*)"/
+    links[$1] = $2
+  end
+  links
+end
+
+class ApplicationControllerTest < ActionController::TestCase
+  setup do
+    @controller.stubs(:total_items).returns 101
+    @controller.stubs(:max_range).returns 100
+  end
+
+  test 'rangeless request range works normally if max_range >= total' do
+    @controller.stubs(:total_items).returns 100
+
+    @controller.expects(:action).with(100, 0)
+    get :index
+    assert_equal 200, response.status
+    assert_equal 'items', response.headers['Accept-Ranges']
+  end
+
+  test 'rangeless request truncates if max_range < total' do
+    @controller.expects(:action).with(100, 0)
+    get :index
+    assert_equal 206, response.status
+    assert_equal 'items', response.headers['Accept-Ranges']
+    assert_equal '0-99/101', response.headers['Content-Range']
+  end
+
+  test 'an acceptable range succeeds' do
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "0-99"
+
+    @controller.expects(:action).with(100, 0)
+    get :index
+    assert_equal 206, response.status
+    assert_equal 'items', response.headers['Range-Unit']
+    assert_equal '0-99/101', response.headers['Content-Range']
+  end
+
+  test 'an oversized range is truncated' do
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "0-100"
+
+    get :index
+    assert_equal 206, response.status
+    assert_equal 'items', response.headers['Range-Unit']
+    assert_equal '0-99/101', response.headers['Content-Range']
+  end
+
+  test "passes along exceptional status codes" do
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "0-99"
+
+    [100, 301, 404, 500].each do |code|
+      @controller.stubs(:index_status).returns code
+      get :index
+      assert_equal code, response.status
+    end
+  end
+
+  test "reports infinite/unknown collection" do
+    @controller.stubs(:total_items).returns Float::INFINITY
+
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "0-9"
+    get :index
+    assert_equal '0-9/*', response.headers['Content-Range']
+  end
+
+  test "refuses offside ranges" do
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "1-0"
+
+    @controller.expects(:action).never
+    get :index
+    assert_equal 416, response.status
+    assert_equal '*/101', response.headers['Content-Range']
+  end
+
+  test "handles ranges beyond collection length via truncation" do
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "50-200"
+
+    @controller.expects(:action).with(51, 50)
+    get :index
+
+    assert_equal 206, response.status
+    assert_equal '50-100/101', response.headers['Content-Range']
+  end
+
+  test "includes link headers" do
+    @controller.stubs(:total_items).returns 100
+
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "20-29"
+
+    get :index
+    links = parse_link_ranges response.headers['Link']
+
+    assert_equal '30-39', links['next']
+    assert_equal '10-19', links['prev']
+    assert_equal '0-9', links['first']
+    assert_equal '90-99', links['last']
+  end
+
+  test "next page range can extend beyond last item" do
+    @controller.stubs(:total_items).returns 100
+
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "50-89"
+
+    get :index
+    links = parse_link_ranges response.headers['Link']
+
+    assert_equal '90-129', links['next']
+  end
+
+  test "previous page range cannot go negative" do
+    @controller.stubs(:total_items).returns 100
+
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "10-99"
+
+    get :index
+    links = parse_link_ranges response.headers['Link']
+
+    assert_equal '0-89', links['prev']
+  end
+
+  test "first page range always starts at zero" do
+    @controller.stubs(:total_items).returns 100
+
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "63-72"
+
+    get :index
+    links = parse_link_ranges response.headers['Link']
+
+    assert_equal '0-9', links['first']
+  end
+
+  test "last page range can extend beyond the last item" do
+    @controller.stubs(:total_items).returns 100
+
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "0-6"
+
+    get :index
+    links = parse_link_ranges response.headers['Link']
+
+    assert_equal '98-104', links['last']
+  end
+
+  test "shifts penultimate page to beginning, preserving length" do
+    @controller.stubs(:total_items).returns 100
+
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "10-49"
+
+    get :index
+    links = parse_link_ranges response.headers['Link']
+
+    assert_equal '0-39', links['prev']
+    assert_equal '0-39', links['first']
+  end
+
+  test "prev is the left inverse of next" do
+    @request.headers['Range-Unit'] = 'items'
+
+    100.times do
+      total_items = rand(1..20)
+      to = rand(1..total_items)
+      from = rand(0...to)
+      max_range = rand(1..20)
+
+      msg = "#{from}-#{to}/#{total_items} max_range=#{max_range}"
+
+      @controller.stubs(:total_items).returns total_items
+      @controller.stubs(:max_range).returns max_range
+      @request.headers['Range'] = "#{from}-#{to}"
+      get :index
+
+      links = parse_link_ranges response.headers['Link']
+      if links['next']
+        msg += " thence to #{links['next']}/#{total_items}"
+        @request.headers['Range'] = links['next']
+        get :index
+
+        links = parse_link_ranges response.headers['Link']
+        assert_equal "#{from}-#{to}", links['prev'], msg
+      end
+    end
+  end
+
+  test "for from > to-from, next is the right inverse of prev" do
+    @request.headers['Range-Unit'] = 'items'
+
+    100.times do
+      total_items = rand(1..20)
+      to = rand(1..total_items)
+      from = rand(to/2+1...to)
+      max_range = rand(1..20)
+
+      msg = "#{from}-#{to}/#{total_items} max_range=#{max_range}"
+
+      @controller.stubs(:total_items).returns total_items
+      @controller.stubs(:max_range).returns max_range
+      @request.headers['Range'] = "#{from}-#{to}"
+      get :index
+
+      links = parse_link_ranges response.headers['Link']
+      if links['prev']
+        msg += " thence to #{links['prev']}/#{total_items}"
+        @request.headers['Range'] = links['prev']
+        get :index
+
+        links = parse_link_ranges response.headers['Link']
+        assert_equal "#{from}-#{to}", links['next'], msg
+      end
+    end
+  end
+
+  test "omits prev and first links at start" do
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "0-9"
+
+    get :index
+    links = parse_link_ranges response.headers['Link']
+
+    assert_nil links['first']
+    assert_nil links['prev']
+  end
+
+  test "omits next and last links at end" do
+    @controller.stubs(:total_items).returns 100
+    @request.headers['Range-Unit'] = 'items'
+    @request.headers['Range'] = "90-99"
+
+    get :index
+    links = parse_link_ranges response.headers['Link']
+
+    assert_nil links['last']
+    assert_nil links['next']
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,29 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+
+  include CleanPagination
+
+  def index
+    paginate total_items, max_range do |limit, offset|
+      action limit, offset
+      render status: index_status
+    end
+  end
+
+  def total_items
+    raise 'stub me'
+  end
+
+  def max_range
+    raise 'stub me'
+  end
+
+  def action limit, offset
+  end
+
+  def index_status
+    200
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/application/index.html.erb

@@ -0,0 +1 @@
+<p>hi</p>

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "clean_pagination"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end