paginate-responder 2.1.0 → 2.2.0

data/lib/paginate-responder/kaminari_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaginateResponder
   #
   # Pagination adapter for kaminari.
@@ -17,7 +19,8 @@ module PaginateResponder
 
     def total_pages
       return resource.total_pages if resource.respond_to? :total_pages
-      return resource.num_pages   if resource.respond_to? :num_pages
+
+      resource.num_pages   if resource.respond_to? :num_pages
     end
 
     def total_count
@@ -25,13 +28,11 @@ module PaginateResponder
     end
 
     class << self
-      def suitable?(resource, responder)
-        resource.respond_to?(:page) and not resource.respond_to?(:paginate)
+      def suitable?(resource, _responder)
+        resource.respond_to?(:page) && !resource.respond_to?(:paginate)
       end
     end
   end
 
-  if defined?(:Kaminari)
-    ::Responders::PaginateResponder.register KaminariAdapter
-  end
+  ::Responders::PaginateResponder.register(KaminariAdapter)
 end

data/lib/paginate-responder/pagy_adapter.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module PaginateResponder
   #
   # Pagination adapter for pagy.
   #
   class PagyAdapter < Base
     def paginate
-      self.pagy, self.pagy_resource = controller.send(self.class.pagy_method(resource), resource, page: page, items: per_page)
+      self.pagy, self.pagy_resource = controller.send(self.class.pagy_method(resource), resource, page: page,
+        items: per_page,)
       pagy_resource
     end
 
@@ -36,7 +39,7 @@ module PaginateResponder
       end
 
       def pagy_method(resource)
-        %i[limit offset].all? { |model_method| resource.respond_to?(model_method) } ? :pagy : :pagy_array
+        %i[limit offset].all? {|model_method| resource.respond_to?(model_method) } ? :pagy : :pagy_array
       end
     end
 
@@ -45,7 +48,5 @@ module PaginateResponder
     attr_accessor :pagy, :pagy_resource
   end
 
-  if defined?(:Pagy)
-    ::Responders::PaginateResponder.register PagyAdapter
-  end
+  ::Responders::PaginateResponder.register(PagyAdapter)
 end

data/lib/paginate-responder/version.rb

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

data/lib/paginate-responder/will_paginate_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PaginateResponder
   #
   # Pagination adapter for will_paginate.
@@ -24,13 +26,11 @@ module PaginateResponder
     end
 
     class << self
-      def suitable?(resource, responder)
-        resource.respond_to? :paginate
+      def suitable?(resource, _responder)
+        resource.respond_to?(:paginate)
       end
     end
   end
 
-  if defined?(:WillPaginate)
-    ::Responders::PaginateResponder.register WillPaginateAdapter
-  end
+  ::Responders::PaginateResponder.register(WillPaginateAdapter)
 end

data/lib/paginate-responder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack-link_headers'
 
 module Responders

data/lib/responders/paginate_responder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Responders
   module PaginateResponder
     def respond
@@ -19,7 +21,7 @@ module Responders
       end
 
       def adapters
-        @adpaters ||= ::Set.new
+        @adapters ||= ::Set.new
       end
 
       def init(responder)
@@ -28,7 +30,7 @@ module Responders
         end
 
         adapter = find(responder)
-        adapter.new(responder) if adapter
+        adapter&.new(responder)
       end
 
       def find(responder)

data/paginate-responder.gemspec

@@ -1,37 +1,30 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+require 'English'
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'paginate-responder/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "paginate-responder"
+  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      = "https://github.com/jgraichen/paginate-responder"
+  gem.email         = ['jgraichen@altimos.de']
+  gem.description   = 'A Rails pagination responder with link header support.'
+  gem.summary       = 'A Rails pagination responder with link header support.'
+  gem.homepage      = 'https://github.com/jgraichen/paginate-responder'
   gem.license       = 'MIT'
 
-  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.metadata = {
+    'rubygems_mfa_required' => 'true',
+  }
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map {|f| File.basename(f) }
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'rack-link_headers', '>= 2.2'
+  gem.required_ruby_version = '>= 2.7.0'
 
-  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 'pagy'
-  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', '~> 1.3.6'
-  gem.add_development_dependency 'will_paginate'
-  gem.add_development_dependency 'test-unit'
+  gem.add_dependency 'rack-link_headers', '>= 2.2'
+  gem.add_dependency 'responders'
 end

data/renovate.json5

@@ -0,0 +1,4 @@
+{
+  $schema: "https://docs.renovatebot.com/renovate-schema.json",
+  extends: ["local>jgraichen/renovate-config"],
+}

data/spec/{paginate_responder_spec.rb → responders/paginate_responder_spec.rb}

@@ -1,36 +1,18 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-RSpec.describe Responders::PaginateResponder, type: :controller do
-  case $gem
-    when 'will_paginate',
-         'pagy'
-      let(:array_resource) do
-        ('AA'..'zz').to_a
-      end
-    when 'kaminari'
-      let(:array_resource) do
-        Kaminari.paginate_array ('AA'..'zz').to_a
-      end
+RSpec.describe Responders::PaginateResponder do
+  subject(:json) do
+    action.call
+    JSON.parse(response.body)
   end
 
-  before do
-    if ActiveRecord::VERSION::MAJOR >= 4
-      self.resource = ArModel.all
-    else
-      self.resource = ArModel.scoped
-    end
-  end
+  let(:resource) { ArModel.all }
 
   let(:method)   { :get }
-  let(:response) { action.call; @response }
-  let(:json)     { JSON.parse response.body }
   let(:params)   { {format: :json} }
-
-  if ActionPack::VERSION::MAJOR >= 5
-    let(:action)   { -> { send(method, :index, params: params) } }
-  else
-    let(:action)   { -> { send(method, :index, params) } }
-  end
+  let(:action)   { -> { send(method, :index, params: params) } }
 
   context 'with AR resource' do
     it { expect(json).to eq (1..50).to_a }
@@ -71,7 +53,14 @@ RSpec.describe Responders::PaginateResponder, type: :controller do
   end
 
   context 'with array resource' do
-    before { @controller.resource = array_resource }
+    let(:resource) do
+      case GEM
+        when 'will_paginate', 'pagy'
+          ('AA'..'zz').to_a
+        when 'kaminari'
+          Kaminari.paginate_array ('AA'..'zz').to_a
+      end
+    end
 
     it { expect(json).to eq ('AA'..'zz').to_a[0..49] }
 
@@ -95,15 +84,18 @@ RSpec.describe Responders::PaginateResponder, type: :controller do
   end
 
   context 'with AR association' do
-    before { @controller.resource = ArModel.find(1).ar_assoc_models }
+    let(: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 }
+    subject(:links) do
+      action.call
+      response.links.to_h {|l| [l[:params][:rel], l[:url]] }
+    end
 
-    it { expect(subject.size).to eq 3 }
+    it { expect(links.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' }
@@ -111,7 +103,7 @@ RSpec.describe Responders::PaginateResponder, type: :controller do
     context '?page' do
       let(:params) { super().merge page: 2 }
 
-      it { expect(subject.size).to eq 4 }
+      it { expect(links.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'  }
@@ -121,7 +113,7 @@ RSpec.describe Responders::PaginateResponder, type: :controller do
     context '?page=5' do
       let(:params) { super().merge page: 5 }
 
-      it { expect(subject.size).to eq 4 }
+      it { expect(links.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'  }
@@ -131,7 +123,7 @@ RSpec.describe Responders::PaginateResponder, type: :controller do
     context '?page last' do
       let(:params) { super().merge page: 14 }
 
-      it { expect(subject.size).to eq 3 }
+      it { expect(links.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' }
@@ -140,7 +132,7 @@ RSpec.describe Responders::PaginateResponder, type: :controller do
     context '?page before last' do
       let(:params) { super().merge page: 13 }
 
-      it { expect(subject.size).to eq 4 }
+      it { expect(links.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' }
@@ -150,7 +142,7 @@ RSpec.describe Responders::PaginateResponder, type: :controller do
     context '?per_page' do
       let(:params) { super().merge page: 1, per_page: 10 }
 
-      it { expect(subject.size).to eq 3 }
+      it { expect(links.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' }
@@ -159,7 +151,7 @@ RSpec.describe Responders::PaginateResponder, type: :controller do
     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 { expect(links.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' }
@@ -168,7 +160,7 @@ RSpec.describe Responders::PaginateResponder, type: :controller do
     context 'when method is HEAD' do
       let(:method) { :head }
 
-      it { expect(subject.size).to eq 3 }
+      it { expect(links.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' }
@@ -176,20 +168,23 @@ RSpec.describe Responders::PaginateResponder, type: :controller do
   end
 
   describe 'headers' do
-    subject { response.headers.to_h }
+    subject do
+      action.call
+      response.headers.to_h.transform_keys(&:downcase)
+    end
 
-    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' }
-    it { is_expected.to include 'X-Current-Page' => '1' }
+    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' }
+    it { is_expected.to include 'x-current-page' => '1' }
 
     context 'when method is HEAD' do
       let(:method) { :head }
 
-      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' }
-      it { is_expected.to include 'X-Current-Page' => '1' }
+      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' }
+      it { is_expected.to include 'x-current-page' => '1' }
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler/setup'
 
+# Workaround for older Rails versions not explicitly requiring logger
+require 'logger'
+
 # Configure Rails
 ENV['RAILS_ENV'] = 'test'
 
@@ -12,18 +17,13 @@ require 'active_record'
 require 'rspec'
 
 require 'responders'
-
 require 'paginate-responder'
 
-require 'pry'
-require 'pry-byebug'
-
-Dir[File.expand_path('spec/support/**/*.rb')].each {|f| require f }
+Dir[File.expand_path('spec/support/**/*.rb')].sort.each {|f| require f }
 
-$gem = ENV['GEM'].to_s
-$gem = 'will_paginate' if $gem.empty?
+GEM = ENV.fetch('GEM', 'will_paginate')
 
-case $gem
+case GEM
   when 'will_paginate'
     require 'will_paginate/array'
     require 'will_paginate/active_record'

data/spec/support/{10-application.rb → application.rb}

@@ -1,35 +1,28 @@
-
-$routes = ActionDispatch::Routing::RouteSet.new
-$routes.draw do
-  get '/index' => 'test#index'
-end
-
-class ActiveSupport::TestCase
-  setup do
-    @routes = $routes
-  end
-end
+# frozen_string_literal: true
 
 class ArModel < ActiveRecord::Base
   has_many :ar_assoc_models
-  def as_json(opts = {})
+
+  def as_json(_opts = {})
     id
   end
 end
 
 class ArAssocModel < ActiveRecord::Base
-  def as_json(opts = {})
+  def as_json(_opts = {})
     id
   end
 end
 
 ActiveRecord::Base.establish_connection(
   adapter: 'sqlite3',
-  database: ':memory:'
+  database: ':memory:',
 )
+
 ActiveRecord::Base.connection.execute <<SQL
   CREATE TABLE ar_models (id INTEGER PRIMARY KEY AUTOINCREMENT);
 SQL
+
 ActiveRecord::Base.connection.execute <<SQL
   CREATE TABLE ar_assoc_models (
     id INTEGER PRIMARY KEY AUTOINCREMENT, ar_model_id INTEGER
@@ -48,35 +41,31 @@ class TestResponder < ActionController::Responder
   include Responders::PaginateResponder
 end
 
-class TestController < ActionController::Base
-  include $routes.url_helpers
+ROUTES = ActionDispatch::Routing::RouteSet.new
+ROUTES.draw do
+  get '/index' => 'test#index'
+end
 
-  attr_accessor :resource
+class TestController < ActionController::Base
+  include ROUTES.url_helpers
 
   self.responder = TestResponder
 
   respond_to :json
 
-  def index
-    respond_with resource
+  def initialize(&block)
+    super
+    @cb = block
   end
-end
-
-module TestSpecConfiguration
-  extend ActiveSupport::Concern
 
-  included do
-    before do
-      @routes = $routes
-      @controller = TestController.new
-    end
-
-    def resource=(resource)
-      @controller.resource = resource
-    end
+  def index
+    respond_with @cb.call
   end
 end
 
 RSpec.configure do |config|
-  config.include TestSpecConfiguration
+  config.before do
+    @routes = ROUTES
+    @controller = TestController.new { resource }
+  end
 end

data/spec/support/{05-setup-and-teardown-adapter.rb → setup_and_teardown_adapter.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SetupAndTeardownAdapter
   extend ActiveSupport::Concern
 
@@ -6,7 +8,7 @@ module SetupAndTeardownAdapter
     # hooks.
     def setup(*methods, &block)
       methods.each do |method|
-        if method.to_s =~ /^setup_(with_controller|fixtures|controller_request_and_response)$/
+        if /^setup_(with_controller|fixtures|controller_request_and_response)$/.match?(method.to_s)
           prepend_before { __send__ method }
         else
           before         { __send__ method }
@@ -20,7 +22,7 @@ module SetupAndTeardownAdapter
     # Wraps `teardown` calls from within Rails' testing framework in
     # `after` hooks.
     def teardown(*methods, &block)
-      methods.each { |method| after { __send__ method } }
+      methods.each {|method| after { __send__ method } }
       after(&block) if block
     end
   end