paginate-responder 1.5.0 → 1.6.0.b0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98521af773941c3f0a5b2eca08ec3658433e3d0b
-  data.tar.gz: 3d8cbe19193e14d23abaea15fa1a95b34fbd5274
+  metadata.gz: fa30c367c32405ca6cc56ccee9ab1cad82e8894b
+  data.tar.gz: 5dd939187d91b5af8c9c35ac483a9d3c56d0b092
 SHA512:
-  metadata.gz: 6f43de22a9d8eabde4bab441f842d517f0b99c9c108a8895467674c89d2afea88c93d1e48102504b2740a84eaeb9186f6d2c06a26eb656c1dc10e9b48f8a0eb9
-  data.tar.gz: f3756e605e2036a5bd5513b69743b94c0ee41476b1b8a59e3e5a6ce08e3e18aa96d107521b147b738b523649818e92c823896f1f1fd982538e67293c45b38cd6
+  metadata.gz: be00e015691aeadf0d5174ee2010cb7b73e40ffc9c9c79ee6a6cef87a1617c065d85cd747f03d27d1f8ac99c6915ec7d526ecf06b3e38b6b428072c6a4a67747
+  data.tar.gz: 404cf3ad70bbfd40ee53a0c30268ccaaa922257022345f1d12d387580ec94a91d20726623032497fe2f16090edde4200ec7cba48f3d2e320adaf378dd5c7f323

data/.travis.yml

@@ -1,16 +1,22 @@
 sudo: false
 language: ruby
 rvm:
-  - '2.3.0'
-  - '2.2'
-  - '2.1'
+  - '2.3.1'
+  - '2.2.5'
+  - '2.1.10'
 env:
   - GEM=will_paginate
   - GEM=kaminari
 gemfile:
-  - gemfiles/Gemfile.rails-4-1
-  - gemfiles/Gemfile.rails-4-2
-  - gemfiles/Gemfile.rails-head
+  - gemfiles/rails_3_2.gemfile
+  - gemfiles/rails_4_2.gemfile
+  - gemfiles/rails_5_0.gemfile
+  - gemfiles/rails_head.gemfile
 matrix:
+  exclude:
+    - rvm: '2.1.10'
+      gemfile: gemfiles/rails_5_0.gemfile
+    - rvm: '2.1.10'
+      gemfile: gemfiles/rails_head.gemfile
   allow_failures:
-  - gemfile: gemfiles/Gemfile.rails-head
+  - gemfile: gemfiles/rails_head.gemfile

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "rails-3-2" do
+  gem 'rails', '~> 3.2.0'
+end
+
+appraise "rails-4-2" do
+  gem 'rails', '~> 4.2.0'
+end
+
+appraise "rails-5-0" do
+  gem 'rails', '~> 5.0.0'
+end
+
+appraise "rails-head" do
+  gem 'rails', github: 'rails/rails'
+end

data/Gemfile

@@ -2,9 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in paginate-responder.gemspec
 gemspec
-
-group :development do
-  gem 'actionpack', require: false
-  gem 'activerecord', require: false
-  gem 'responders', '~> 2.0', require: false
-end

data/Rakefile

@@ -1,11 +1,7 @@
-require "bundler/gem_tasks"
-require 'rake/testtask'
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new do |t|
-  t.libs.push "test"
-  t.test_files = FileList['test/*_test.rb']
-  t.verbose = true
-end
-
-task :default => :test
-task :spec => :test
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/gemfiles/rails_3_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_head.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", :github => "rails/rails"
+
+gemspec :path => "../"

data/lib/paginate-responder.rb

@@ -1,17 +1,12 @@
 require 'rack-link_headers'
 
 module Responders
-  autoload :PaginateResponder, 'responders/paginate_responder'
+  require 'responders/paginate_responder'
 end
 
 module PaginateResponder
-  autoload :VERSION, 'paginate-responder/version'
-  autoload :Paginator, 'paginate-responder/paginator'
-
-  module Adapter
-    autoload :Base, 'paginate-responder/adapter/base'
-  end
+  require 'paginate-responder/version'
+  require 'paginate-responder/base'
+  require 'paginate-responder/will_paginate_adapter'
+  require 'paginate-responder/kaminari_adapter'
 end
-
-require 'paginate-responder/adapter/paginate_adapter'
-require 'paginate-responder/adapter/kaminari_adapter'

data/lib/paginate-responder/base.rb

@@ -0,0 +1,129 @@
+module PaginateResponder
+  class Base
+    attr_reader :responder, :resource
+
+    def initialize(responder)
+      @responder = responder
+      @resource  = responder.resource
+    end
+
+    def request
+      responder.request
+    end
+
+    def controller
+      responder.controller
+    end
+
+    def response
+      controller.response
+    end
+
+    def paginate!
+      @resource = paginate
+
+      update
+
+      @resource
+    end
+
+    protected
+
+    def paginate
+      resource
+    end
+
+    def update
+      link! 'first', page: first_page if first_page
+      link! 'prev',  page: prev_page  if prev_page
+      link! 'next',  page: next_page  if next_page
+      link! 'last',  page: last_page  if last_page
+
+      response.headers["X-Total-Pages"] = total_pages.to_s if total_pages
+      response.headers["X-Total-Count"] = total_count.to_s if total_count
+      response.headers["X-Per-Page"]    = per_page.to_s    if per_page
+    end
+
+    def page
+      @page ||= begin
+        val ||= controller.page if controller.respond_to? :page
+        val ||= controller.params[:page]
+        val ||= first_page
+        cast_page val
+      end
+    end
+
+    def cast_page(page)
+      Integer(page)
+    end
+
+    def per_page
+      @per_page ||= begin
+        val ||= controller.per_page if controller.respond_to? :per_page
+        val ||= controller.params[:per_page].try(:to_i)
+        val ||= default_per_page
+        val < 1 ? 1 : (val > max_per_page) ? max_per_page : val
+      end
+    end
+
+    def max_per_page
+      @max_per_page ||= begin
+        val ||= controller.max_per_page if controller.respond_to? :max_per_page
+        val ||= default_max_per_page
+        val
+      end
+    end
+
+    def first_page
+      1
+    end
+
+    def prev_page
+      page - 1 if page > 1
+    end
+
+    def next_page
+      page + 1 if total_pages && page < total_pages
+    end
+
+    def last_page
+      total_pages
+    end
+
+    def total_pages
+      nil
+    end
+
+    def total_count
+      nil
+    end
+
+    def default_per_page
+      50
+    end
+
+    def default_max_per_page
+      100
+    end
+
+    private
+
+    def link!(rel, params)
+      if request.params.key?(:per_page)
+        params = {per_page: per_page}.merge(params)
+      end
+
+      params = request.params.merge(params)
+
+      url = controller.url_for(params)
+
+      response.link(url, rel: rel)
+    end
+
+    class << self
+      def suitable?(resource)
+        false
+      end
+    end
+  end
+end

data/lib/paginate-responder/kaminari_adapter.rb

@@ -0,0 +1,37 @@
+module PaginateResponder
+  #
+  # Pagination adapter for kaminari.
+  #
+  class KaminariAdapter < Base
+    def paginate
+      resource.page(page).per(per_page)
+    end
+
+    def default_per_page
+      Kaminari.config.default_per_page
+    end
+
+    def default_max_per_page
+      Kaminari.config.max_per_page
+    end
+
+    def total_pages
+      return resource.total_pages if resource.respond_to? :total_pages
+      return resource.num_pages   if resource.respond_to? :num_pages
+    end
+
+    def total_count
+      resource.total_count if resource.respond_to? :total_count
+    end
+
+    class << self
+      def suitable?(resource, responder)
+        resource.respond_to?(:page) and not resource.respond_to?(:paginate)
+      end
+    end
+  end
+
+  if defined?(:Kaminari)
+    ::Responders::PaginateResponder.register KaminariAdapter
+  end
+end

data/lib/paginate-responder/version.rb

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

data/lib/paginate-responder/will_paginate_adapter.rb

@@ -0,0 +1,36 @@
+module PaginateResponder
+  #
+  # Pagination adapter for will_paginate.
+  #
+  class WillPaginateAdapter < Base
+    def paginate
+      resource.paginate page: page, per_page: per_page
+    end
+
+    def total_pages
+      resource.total_pages if resource.respond_to? :total_pages
+    end
+
+    def total_count
+      resource.total_entries if resource.respond_to? :total_entries
+    end
+
+    def default_per_page
+      50
+    end
+
+    def default_max_per_page
+      50
+    end
+
+    class << self
+      def suitable?(resource, responder)
+        resource.respond_to? :paginate
+      end
+    end
+  end
+
+  if defined?(:WillPaginate)
+    ::Responders::PaginateResponder.register WillPaginateAdapter
+  end
+end

data/lib/responders/paginate_responder.rb

@@ -1,12 +1,32 @@
 module Responders
-
   module PaginateResponder
-
     def to_format
-      if get?
-        @resource = ::PaginateResponder::Paginator.new(self).paginate!
-      end
+      paginate! if get?
+
       super
     end
+
+    private
+
+    def paginate!
+      adapter = ::Responders::PaginateResponder.find(self)
+      @resource = adapter.new(self).paginate! if adapter
+    end
+
+    class << self
+      def register(adapter)
+        adapters << adapter
+      end
+
+      def adapters
+        @adpaters ||= ::Set.new
+      end
+
+      def find(responder)
+        adapters.find do |adapter|
+          adapter.suitable?(responder.resource, responder)
+        end
+      end
+    end
   end
 end

data/paginate-responder.gemspec

@@ -20,12 +20,17 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'rack-link_headers', '>= 2.2'
 
-  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'actionpack', '>= 3.2.0'
   gem.add_development_dependency 'activerecord', '>= 3.2.0'
+  gem.add_development_dependency 'appraisal'
+  gem.add_development_dependency 'kaminari'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-byebug'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'responders'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-rails'
   gem.add_development_dependency 'sqlite3'
-  gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'minitest-reporters'
   gem.add_development_dependency 'will_paginate'
-  gem.add_development_dependency 'kaminari'
+  gem.add_development_dependency 'test-unit'
 end

data/spec/paginate_responder_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+RSpec.describe Responders::PaginateResponder, type: :controller do
+  case $gem
+    when 'will_paginate'
+      let(:array_resource) do
+        ('AA'..'zz').to_a
+      end
+    when 'kaminari'
+      let(:array_resource) do
+        Kaminari.paginate_array ('AA'..'zz').to_a
+      end
+  end
+
+  before do
+    if ActiveRecord::VERSION::MAJOR >= 4
+      self.resource = ArModel.all
+    else
+      self.resource = ArModel.scoped
+    end
+  end
+
+  let(:response) { action.call; @response }
+  let(:json)     { JSON.parse response.body }
+  let(:params)   { {format: :json} }
+
+  if ActionPack::VERSION::MAJOR >= 5
+    let(:action)   { -> { get :index, params: params } }
+  else
+    let(:action)   { -> { get :index, params } }
+  end
+
+  context 'with AR resource' do
+    it { expect(json).to eq (1..50).to_a }
+
+    describe '?page' do
+      let(:params) { super().merge page: 2 }
+
+      it { expect(json).to eq (51..100).to_a }
+    end
+
+    describe '?per_page' do
+      let(:params) { super().merge per_page: 10 }
+
+      it { expect(json).to eq (1..10).to_a }
+    end
+
+    describe '?per_page&page' do
+      let(:params) { super().merge page: 2, per_page: 10 }
+
+      it { expect(json).to eq (11..20).to_a }
+    end
+  end
+
+  context 'with array resource' do
+    before { @controller.resource = array_resource }
+
+    it { expect(json).to eq ('AA'..'zz').to_a[0..49] }
+
+    describe '?page' do
+      let(:params) { super().merge page: 2 }
+
+      it { expect(json).to eq ('AA'..'zz').to_a[50..99] }
+    end
+
+    describe '?per_page' do
+      let(:params) { super().merge per_page: 10 }
+
+      it { expect(json).to eq ('AA'..'zz').to_a[0..9] }
+    end
+
+    describe '?per_page&page' do
+      let(:params) { super().merge page: 2, per_page: 10 }
+
+      it { expect(json).to eq ('AA'..'zz').to_a[10..19] }
+    end
+  end
+
+  context 'with AR association' do
+    before { @controller.resource = ArModel.find(1).ar_assoc_models }
+
+    it { expect(json).to eq (1..5).to_a }
+  end
+
+  describe 'links' do
+    subject { response.links.map{|l| [l[:params][:rel], l[:url]]}.to_h }
+
+    it { expect(subject.size).to eq 3 }
+    it { is_expected.to include 'first' => 'http://test.host/index.json?page=1'  }
+    it { is_expected.to include 'next'  => 'http://test.host/index.json?page=2'  }
+    it { is_expected.to include 'last'  => 'http://test.host/index.json?page=14' }
+
+    context '?page' do
+      let(:params) { super().merge page: 2 }
+
+      it { expect(subject.size).to eq 4 }
+      it { is_expected.to include 'first' => 'http://test.host/index.json?page=1'  }
+      it { is_expected.to include 'prev'  => 'http://test.host/index.json?page=1'  }
+      it { is_expected.to include 'next'  => 'http://test.host/index.json?page=3'  }
+      it { is_expected.to include 'last'  => 'http://test.host/index.json?page=14' }
+    end
+
+    context '?page=5' do
+      let(:params) { super().merge page: 5 }
+
+      it { expect(subject.size).to eq 4 }
+      it { is_expected.to include 'first' => 'http://test.host/index.json?page=1'  }
+      it { is_expected.to include 'prev'  => 'http://test.host/index.json?page=4'  }
+      it { is_expected.to include 'next'  => 'http://test.host/index.json?page=6'  }
+      it { is_expected.to include 'last'  => 'http://test.host/index.json?page=14' }
+    end
+
+    context '?page last' do
+      let(:params) { super().merge page: 14 }
+
+      it { expect(subject.size).to eq 3 }
+      it { is_expected.to include 'first' => 'http://test.host/index.json?page=1'  }
+      it { is_expected.to include 'prev'  => 'http://test.host/index.json?page=13' }
+      it { is_expected.to include 'last'  => 'http://test.host/index.json?page=14' }
+    end
+
+    context '?page before last' do
+      let(:params) { super().merge page: 13 }
+
+      it { expect(subject.size).to eq 4 }
+      it { is_expected.to include 'first' => 'http://test.host/index.json?page=1'  }
+      it { is_expected.to include 'prev'  => 'http://test.host/index.json?page=12' }
+      it { is_expected.to include 'next'  => 'http://test.host/index.json?page=14' }
+      it { is_expected.to include 'last'  => 'http://test.host/index.json?page=14' }
+    end
+
+    context '?per_page' do
+      let(:params) { super().merge page: 1, per_page: 10 }
+
+      it { expect(subject.size).to eq 3 }
+      it { is_expected.to include 'first' => 'http://test.host/index.json?page=1&per_page=10'  }
+      it { is_expected.to include 'next'  => 'http://test.host/index.json?page=2&per_page=10'  }
+      it { is_expected.to include 'last'  => 'http://test.host/index.json?page=68&per_page=10' }
+    end
+
+    context '?per_page above max per page limit' do
+      let(:params) { super().merge page: 1, per_page: 100 }
+
+      it { expect(subject.size).to eq 3 }
+      it { is_expected.to include 'first' => 'http://test.host/index.json?page=1&per_page=50'  }
+      it { is_expected.to include 'next'  => 'http://test.host/index.json?page=2&per_page=50'  }
+      it { is_expected.to include 'last'  => 'http://test.host/index.json?page=14&per_page=50' }
+    end
+  end
+
+  describe 'headers' do
+    subject { response.headers.to_h }
+
+    it { is_expected.to include 'X-Total-Pages' => '14' }
+    it { is_expected.to include 'X-Total-Count' => '676' }
+    it { is_expected.to include 'X-Per-Page' => '50' }
+  end
+end