Add StandardRB and set up a linting workflow

Author: davidcelis

.github/workflows/linting.yml

@@ -0,0 +1,25 @@
+name: Linting
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby and install gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.4
+          bundler-cache: true
+
+      - name: Lint Ruby code
+        run: |
+          bundle exec standardrb

.github/workflows/ci.yml .github/workflows/tests.yml.github/workflows/ci.yml renamed to .github/workflows/tests.yml

@@ -1,4 +1,4 @@
-name: CI
+name: Tests
 
 on:
   push:
@@ -17,7 +17,8 @@ jobs:
     env:
       PAGINATOR: ${{ matrix.paginator }}
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1

Gemfile

@@ -1,13 +1,15 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in api_pagination.gemspec
 gemspec
 
 # Explicitly specify version constraints to match gemspec requirements
 # Without these, Bundler may override gemspec constraints and install incompatible versions
-gem 'kaminari', '~> 1.2', '>= 1.2.1', require: false
-gem 'will_paginate', '~> 3.3', '>= 3.3.1', require: false
-gem 'pagy', '>= 9.4.0', '< 10.0.0', require: false
+gem "kaminari", "~> 1.2", ">= 1.2.1", require: false
+gem "will_paginate", "~> 3.3", ">= 3.3.1", require: false
+gem "pagy", ">= 9.4.0", "< 10.0.0", require: false
 
-gem 'sqlite3', require: false
-gem 'sequel', '~> 5.49', require: false
+gem "sqlite3", require: false
+gem "sequel", "~> 5.49", require: false
+
+gem "standardrb"

api-pagination.gemspec

@@ -1,31 +1,29 @@
-# encoding: utf-8
-$:.unshift(File.expand_path('../lib', __FILE__))
-require 'api-pagination/version'
+$:.unshift(File.expand_path("../lib", __FILE__))
+require "api-pagination/version"
 
 Gem::Specification.new do |s|
-  s.name          = 'api-pagination'
-  s.version       = ApiPagination::VERSION
-  s.authors       = ['David Celis']
-  s.email         = ['me@davidcel.is']
-  s.description   = 'Link header pagination for Rails and Grape APIs'
-  s.summary       = "Link header pagination for Rails and Grape APIs. Don't use the request body."
-  s.homepage      = 'https://github.com/davidcelis/api-pagination'
-  s.license       = 'MIT'
+  s.name = "api-pagination"
+  s.version = ApiPagination::VERSION
+  s.authors = ["David Celis"]
+  s.email = ["me@davidcel.is"]
+  s.description = "Link header pagination for Rails and Grape APIs"
+  s.summary = "Link header pagination for Rails and Grape APIs. Don't use the request body."
+  s.homepage = "https://github.com/davidcelis/api-pagination"
+  s.license = "MIT"
 
-  s.files         = Dir['lib/**/*']
-  s.test_files    = Dir['spec/**/*']
-  s.require_paths = ['lib']
+  s.files = Dir["lib/**/*"]
+  s.require_paths = ["lib"]
 
-  s.required_ruby_version = '> 2.7'
+  s.required_ruby_version = "> 2.7"
 
-  s.add_development_dependency 'kaminari', '~> 1.2', '>= 1.2.1'
-  s.add_development_dependency 'pagy', '>= 9.4.0', '< 10.0.0'
-  s.add_development_dependency 'will_paginate', '~> 3.3', '>= 3.3.1'
+  s.add_development_dependency "kaminari", "~> 1.2", ">= 1.2.1"
+  s.add_development_dependency "pagy", ">= 9.4.0", "< 10.0.0"
+  s.add_development_dependency "will_paginate", "~> 3.3", ">= 3.3.1"
 
-  s.add_development_dependency 'rspec', '~> 3.10'
-  s.add_development_dependency 'grape', '~> 1.6'
-  s.add_development_dependency 'railties', '~> 7.0'
-  s.add_development_dependency 'actionpack', '~> 7.0'
-  s.add_development_dependency 'sequel', '~> 5.49'
-  s.add_development_dependency 'activerecord-nulldb-adapter', '~> 0.9.0'
+  s.add_development_dependency "rspec", "~> 3.10"
+  s.add_development_dependency "grape", "~> 1.6"
+  s.add_development_dependency "railties", "~> 7.0"
+  s.add_development_dependency "actionpack", "~> 7.0"
+  s.add_development_dependency "sequel", "~> 5.49"
+  s.add_development_dependency "activerecord-nulldb-adapter", "~> 0.9.0"
 end

lib/api-pagination.rb

@@ -1,11 +1,11 @@
-require 'api-pagination/configuration'
-require 'api-pagination/version'
+require "api-pagination/configuration"
+require "api-pagination/version"
 
 module ApiPagination
   class << self
     def paginate(collection, options = {})
-      options[:page]     = options[:page].to_i
-      options[:page]     = 1 if options[:page] <= 0
+      options[:page] = options[:page].to_i
+      options[:page] = 1 if options[:page] <= 0
       options[:per_page] = options[:per_page].to_i
 
       case ApiPagination.config.paginator
@@ -26,10 +26,10 @@ def pages_from(collection, options = {})
       {}.tap do |pages|
         unless collection.first_page?
           pages[:first] = 1
-          pages[:prev]  = collection.current_page - 1
+          pages[:prev] = collection.current_page - 1
         end
 
-        unless collection.last_page? || (ApiPagination.config.paginator == :kaminari && collection.out_of_range?)
+        if !(collection.last_page? || (ApiPagination.config.paginator == :kaminari && collection.out_of_range?))
           pages[:last] = collection.total_pages if ApiPagination.config.include_total
           pages[:next] = collection.current_page + 1
         end
@@ -38,9 +38,9 @@ def pages_from(collection, options = {})
 
     def total_from(collection)
       case ApiPagination.config.paginator
-        when :pagy          then collection.count.to_s
-        when :kaminari      then collection.total_count.to_s
-        when :will_paginate then collection.total_entries.to_s
+      when :pagy then collection.count.to_s
+      when :kaminari then collection.total_count.to_s
+      when :will_paginate then collection.total_entries.to_s
       end
     end
 
@@ -60,14 +60,14 @@ def paginate_with_pagy(collection, options)
         collection[pagy.offset, pagy.limit]
       end
 
-      return [collection, pagy]
+      [collection, pagy]
     end
 
     def pagy_from(collection, options)
-      if options[:count]
-        count = options[:count]
+      count = if options[:count]
+        options[:count]
       else
-        count = collection.is_a?(Array) ? collection.count : collection.count(:all)
+        collection.is_a?(Array) ? collection.count : collection.count(:all)
       end
 
       # Pagy 9.x requires keyword arguments
@@ -80,7 +80,7 @@ def pagy_pages_from(pagy)
       {}.tap do |pages|
         unless pagy.page == 1
           pages[:first] = 1
-          pages[:prev]  = pagy.prev
+          pages[:prev] = pagy.prev
         end
 
         unless pagy.page == pagy.pages
@@ -108,11 +108,11 @@ def paginate_with_will_paginate(collection, options)
         options[:per_page] = default_per_page_for_will_paginate(collection)
       end
 
-      collection = if defined?(Sequel::Dataset) && collection.kind_of?(Sequel::Dataset)
+      collection = if defined?(Sequel::Dataset) && collection.is_a?(Sequel::Dataset)
         collection.paginate(options[:page], options[:per_page])
       else
         supported_options = [:page, :per_page, :total_entries]
-        options = options.dup.keep_if { |k,v| supported_options.include?(k.to_sym) }
+        options = options.dup.keep_if { |k, v| supported_options.include?(k.to_sym) }
         collection.paginate(options)
       end
 
@@ -142,4 +142,4 @@ def extract_per_page_from_model(collection, accessor)
   end
 end
 
-require 'api-pagination/hooks'
+require "api-pagination/hooks"

lib/api-pagination/configuration.rb

@@ -17,15 +17,15 @@ def configure(&block)
     end
 
     def initialize
-      @total_header    = 'Total'
-      @per_page_header = 'Per-Page'
-      @page_header     = nil
-      @include_total   = true
-      @base_url   = nil
+      @total_header = "Total"
+      @per_page_header = "Per-Page"
+      @page_header = nil
+      @include_total = true
+      @base_url = nil
       @response_formats = [:json, :xml]
     end
 
-    ['page', 'per_page'].each do |param_name|
+    ["page", "per_page"].each do |param_name|
       method_name = "#{param_name}_param"
       instance_variable_name = "@#{method_name}"
 
@@ -37,15 +37,15 @@ def initialize
 
         if instance_variable_get(instance_variable_name).nil?
           # use :page & :per_page by default
-          instance_variable_set(instance_variable_name, (lambda { |p| p[param_name.to_sym] }))
+          instance_variable_set(instance_variable_name, lambda { |p| p[param_name.to_sym] })
         end
 
         instance_variable_get(instance_variable_name).call(params)
       end
 
       define_method "#{method_name}=" do |param|
         if param.is_a?(Symbol) || param.is_a?(String)
-          instance_variable_set(instance_variable_name, (lambda { |params| params[param] }))
+          instance_variable_set(instance_variable_name, lambda { |params| params[param] })
         else
           raise ArgumentError, "Cannot set page_param option"
         end
@@ -78,24 +78,24 @@ def paginator=(paginator)
     def set_paginator
       conditions = [defined?(Pagy), defined?(Kaminari), defined?(WillPaginate::CollectionMethods)]
       if conditions.compact.size > 1
-        Kernel.warn <<-WARNING
-Warning: api-pagination relies on Pagy, Kaminari, or WillPaginate, but more than
-one are currently active. If possible, you should remove one or the other. If
-you can't, you _must_ configure api-pagination on your own. For example:
-
-ApiPagination.configure do |config|
-  config.paginator = :kaminari
-end
-
-You should also configure Kaminari to use a different `per_page` method name as
-using these gems together causes a conflict; some information can be found at
-https://github.com/activeadmin/activeadmin/wiki/How-to-work-with-will_paginate
-
-Kaminari.configure do |config|
-  config.page_method_name = :per_page_kaminari
-end
-
-WARNING
+        Kernel.warn <<~WARNING
+          Warning: api-pagination relies on Pagy, Kaminari, or WillPaginate, but more than
+          one are currently active. If possible, you should remove one or the other. If
+          you can't, you _must_ configure api-pagination on your own. For example:
+          
+          ApiPagination.configure do |config|
+            config.paginator = :kaminari
+          end
+          
+          You should also configure Kaminari to use a different `per_page` method name as
+          using these gems together causes a conflict; some information can be found at
+          https://github.com/activeadmin/activeadmin/wiki/How-to-work-with-will_paginate
+          
+          Kaminari.configure do |config|
+            config.page_method_name = :per_page_kaminari
+          end
+          
+        WARNING
       elsif defined?(Pagy)
         use_pagy
       elsif defined?(Kaminari)
@@ -110,14 +110,19 @@ def use_pagy
     end
 
     def use_kaminari
-      require 'kaminari/models/array_extension'
+      require "kaminari/models/array_extension"
       @paginator = :kaminari
     end
 
     def use_will_paginate
       WillPaginate::CollectionMethods.module_eval do
-        def first_page?() !previous_page end
-        def last_page?() !next_page end
+        def first_page?
+          !previous_page
+        end
+
+        def last_page?
+          !next_page
+        end
       end
 
       @paginator = :will_paginate
@@ -132,6 +137,6 @@ def configure
     def config
       @config ||= Configuration.new
     end
-    alias :configuration :config
+    alias_method :configuration, :config
   end
 end

lib/api-pagination/hooks.rb

@@ -1,8 +1,8 @@
-begin; require 'grape'; rescue LoadError; end
+begin; require "grape"; rescue LoadError; end
 if defined?(Grape::API)
-  require 'grape/pagination'
+  require "grape/pagination"
 
-  klass = if Grape::VERSION >= '1.2.0' || defined?(Grape::API::Instance)
+  klass = if Grape::VERSION >= "1.2.0" || defined?(Grape::API::Instance)
     Grape::API::Instance
   else
     Grape::API
@@ -11,12 +11,12 @@
   klass.send(:include, Grape::Pagination)
 end
 
-begin; require 'pagy';          rescue LoadError; end
-begin; require 'kaminari';      rescue LoadError; end
-begin; require 'will_paginate'; rescue LoadError; end
+begin; require "pagy"; rescue LoadError; end
+begin; require "kaminari"; rescue LoadError; end
+begin; require "will_paginate"; rescue LoadError; end
 
 unless defined?(Pagy) || defined?(Kaminari) || defined?(WillPaginate::CollectionMethods)
-  Kernel.warn <<-WARNING.gsub(/^\s{4}/, '')
+  Kernel.warn <<-WARNING.gsub(/^\s{4}/, "")
     Warning: api-pagination relies on either Pagy, Kaminari, or WillPaginate.
     Please install a paginator by adding one of the following to your Gemfile:
 
@@ -39,5 +39,5 @@ def self.rails_parent_controller
     end
   end
 
-  require 'api-pagination/railtie'
+  require "api-pagination/railtie"
 end

lib/api-pagination/railtie.rb

@@ -1,10 +1,10 @@
-require 'rails/railtie'
+require "rails/railtie"
 
 module ApiPagination
   class Railtie < ::Rails::Railtie
     initializer :api_pagination do
       ActiveSupport.on_load(:action_controller) do
-        require 'rails/pagination'
+        require "rails/pagination"
 
         klass = if Rails::VERSION::MAJOR >= 5 || defined?(ActionController::API)
           ActionController::API

lib/api-pagination/version.rb

@@ -5,7 +5,7 @@ class Version
     PATCH = 0
 
     def self.to_s
-      [MAJOR, MINOR, PATCH].join('.')
+      [MAJOR, MINOR, PATCH].join(".")
     end
   end