pager_api 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26830a930c08e28898bc2b08427937a650edbacdfa3f30ba5e772a00f106f853
-  data.tar.gz: 0d0ce3d051f008887e2a12056583446d3fd3eee62590928bca58635d874410ac
+  metadata.gz: 67a2baad4c6f702c2513b3660a6a6dea15254eb0a45f04115a5575e18ea79c2f
+  data.tar.gz: 3b29f1c7b4b9b523d06f5459e48fe526016166b0312d762aa21c5abf43fbcd55
 SHA512:
-  metadata.gz: c14e9e1d77e18b61ba966320e413746107f8e2535cbd5c57b9cca149b6578d6f65050c4a08c607bd2e91b277321adaa5a807016d63cb5329ba4e2147bda43918
-  data.tar.gz: 7353b9e6620269f4b87f9e01a89c3457542e89a0caf37327227e2fb4235dd9f60babc031841e638b583c2dd6c0e69068b1484e6b6a5af211e86cebaf0415188b
+  metadata.gz: dd773a056972e831875221c96785f0011dbad53df9843036f344d95aab019e4b6647a7480f0fa1e62560c2f313d7aafe51cd611a378daa5a27b469bc3cd156a2
+  data.tar.gz: 8ef3ff35c17a6524628c29a602f4673ce3ce4a66f631607dbc7b42b7cd91f7307a15d6e33136e4b7a980eab20c5fa1e2a8d37572b275ad05c1b98ad020e4dabb

data/README.md

@@ -22,11 +22,12 @@ API Pagination done right. Pager API is a library to help you add `meta` informa
 
 ## Quick Start
 
-`pager_api` depends on [Kaminari](https://github.com/amatsuda/kaminari) or [WillPaginate](https://github.com/mislav/will_paginate) to handle pagination. You need to add one of these gems to your Gemfile **before** the `pager_api` gem:
+`pager_api` depends on [Pagy](https://github.com/ddnexus/pagy), [Kaminari](https://github.com/amatsuda/kaminari), [WillPaginate](https://github.com/mislav/will_paginate) to handle pagination. You need to add one of these gems to your Gemfile **before** the `pager_api` gem:
 
 ```ruby
 # gem 'will_paginate'
 # gem 'kaminari'
+# gem 'pagy'
 gem 'pager_api'
 ```
 
@@ -48,7 +49,7 @@ The gem comes with an installer for you to configure it, for example to switch b
 
 This will create a file under the `initializers` directory called `pager_api.rb`. You can easily configure it there to meet your needs.
 
-By default `pager_api` uses [Kaminari](https://github.com/amatsuda/kaminari). Configure the `pager_api.rb` initializer in order to use [WillPaginate](https://github.com/mislav/will_paginate).
+By default `pager_api` uses [Pagy](https://github.com/ddnexus/pagy). Configure the `pager_api.rb` initializer in order to use [WillPaginate](https://github.com/mislav/will_paginate) or [Kaminari](https://github.com/amatsuda/kaminari).
 
 **We highly recommend you use [Active Model Serializers](https://github.com/rails-api/active_model_serializers) for rendering your JSON responses**
 

data/lib/generators/pager_api/install_generator.rb

@@ -1,7 +1,7 @@
 module PagerApi
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__) 
+      source_root File.expand_path("../templates", __FILE__)
 
       desc "Creates a PagerApi initializer in your application"
 

data/lib/pager_api/hooks.rb

@@ -1,20 +1,21 @@
+begin; require "kaminari"; rescue LoadError; end
+begin; require "will_paginate"; rescue LoadError; end
+begin; require "pagy"; rescue LoadError; end
+
 # Dynamic pagination handler call
 require "pager_api/pagination/#{PagerApi.pagination_handler}"
 
-begin; require 'kaminari';           rescue LoadError; end
-begin; require 'will_paginate';      rescue LoadError; end
-
-if defined?(ActionController::API)
-  ActionController::API.send(:include, "PagerApi::Pagination::#{PagerApi.pagination_handler.to_s.classify}".constantize)
-else
+if defined?(ActionController::Base)
   ActionController::Base.send(:include, "PagerApi::Pagination::#{PagerApi.pagination_handler.to_s.classify}".constantize)
+else
+  ActionController::API.send(:include, "PagerApi::Pagination::#{PagerApi.pagination_handler.to_s.classify}".constantize)
 end
 
-unless defined?(Kaminari) or defined?(WillPaginate)
-  Kernel.warn <<-WARNING.gsub(/^\s{4}/, '')
-    Warning: pager-api needs Kaminari or Will Paginate as a dependency.
+unless defined?(Kaminari) or defined?(WillPaginate) or defined?(Pagy)
+  Kernel.warn <<-WARNING.gsub(/^\s{4}/, "")
+    Warning: pager-api needs Kaminari, Will Paginate or Pagy as a dependency.
     You need to add it to your Gemfile
 
-    gem 'kaminari' or gem 'will_paginate'
+    gem 'kaminari', gem 'will_paginate' or gem 'pagy'
   WARNING
 end

data/lib/pager_api/pagination/pagy.rb

@@ -0,0 +1,87 @@
+module PagerApi
+  module Pagination
+    module Pagy
+      include ::Pagy::Backend
+
+      def paginate(*args)
+        options = args.extract_options!
+        collection = args.first
+
+        pagy, paginated_collection = paginate_collection(collection, options)
+
+        options[:json] = paginated_collection
+
+        options[:meta] = meta(pagy, options) if PagerApi.include_pagination_on_meta?
+
+        pagination_headers(pagy) if PagerApi.include_pagination_headers?
+
+        render options
+      end
+
+      private
+
+      # Link: <http://example.com/api/v1/users?page="2">; rel="next",
+      # <http://example.com/api/v1//users?page="5">; rel="last",
+      # <http://example.com/api/v1//users?page="1">; rel="first",
+      # <http://example.com/api/v1/users?page="1">; rel="prev",
+      def pagination_headers(pagy)
+        links = (headers["Link"] || "").split(",").map(&:strip)
+        clean_url = request.original_url.sub(/\?.*$/, "")
+
+        paging_info = pages(pagy)
+
+        paging_info.each do |key, value|
+          query_params = request.query_parameters.merge(page: value)
+          links << %Q{ <#{clean_url}?#{query_params.to_param}>; rel="#{key}" }
+        end
+
+        headers["Link"] = links.join(", ") unless links.empty?
+        headers[PagerApi.total_pages_header] = pagy.pages
+        headers[PagerApi.total_count_header] = pagy.count
+
+        return nil
+      end
+
+      def pagination_links(pagy)
+        current_uri = request.env["PATH_INFO"]
+        meta_links = {}
+
+        pages(pagy).each do |key, value|
+          query_params = request.query_parameters.merge(page: value)
+          meta_links[key] = "#{current_uri}?#{query_params.to_param}"
+        end
+
+        meta_links
+      end
+
+      def pages(pagy)
+        {}.tap do |paging|
+          paging[:first] = 1
+          paging[:last] = pagy.pages
+
+          paging[:prev] = pagy.prev unless pagy.prev.nil?
+          paging[:next] = pagy.next unless pagy.next.nil?
+        end
+      end
+
+      def paginate_collection(collection, options = {})
+        options[:page] = params[:page] || 1
+        options[:items] = options.delete(:per_page) || params[:per_page] || ::Pagy::VARS[:items]
+
+        meta, collection = pagy(collection, options)
+        [meta, collection]
+      end
+
+      def meta(pagy, options = {})
+        {
+          pagination: {
+            per_page: pagy.items,
+            total_pages: pagy.pages,
+            total_objects: pagy.count,
+            links: pagination_links(pagy),
+          },
+        }
+      end
+    end
+  end
+end

data/lib/pager_api/railtie.rb

@@ -1,6 +1,6 @@
 module PagerApi
   class Railtie < Rails::Railtie
-    initializer "pager_api.configure_pagination_helpers" do
+    config.after_initialize do
       require 'pager_api/hooks'
     end
   end

data/lib/pager_api/version.rb

@@ -1,3 +1,3 @@
 module PagerApi
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

data/lib/pager_api.rb

@@ -2,7 +2,7 @@ module PagerApi
 
   # pagination handler
   mattr_accessor :pagination_handler
-  @@pagination_handler = :kaminari
+  @@pagination_handler = :pagy
 
   # Meta tag information for pagination
   mattr_accessor :include_pagination_on_meta
@@ -32,7 +32,6 @@ module PagerApi
   def self.setup
     yield self
   end
-
 end
 
 require "pager_api/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pager_api
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Abraham Kuri
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2019-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - lib/pager_api.rb
 - lib/pager_api/hooks.rb
 - lib/pager_api/pagination/kaminari.rb
+- lib/pager_api/pagination/pagy.rb
 - lib/pager_api/pagination/will_paginate.rb
 - lib/pager_api/railtie.rb
 - lib/pager_api/version.rb