pagy 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d2f8c701f3ddef6d2c1d5ab7c75084a3bb070069806a992a07f85010d8bde15
-  data.tar.gz: e7a939c71093a97ada5592096ea48de3898b290d597e80fff15e27cf49c7eb78
+  metadata.gz: 231b1787febd199766fff19ee9e1f8a25b9ba94e92491f9899ea91b98cad82c3
+  data.tar.gz: 94c21814452385052d0a1ed3085074e1cc69c60534a9525d66946e3f556d32a7
 SHA512:
-  metadata.gz: 92295ab476345a4288261439e23b3fedbacdda8dcc8ec6123773d2389c002e1120bb61f17f003d920fb9cd78693d7029a13fda1735c29cc765593130e3cc742a
-  data.tar.gz: d67740ca65974f122c358496f734b83670656ae229d0e5985dbcac0b2006738d4c2f8f1e1dd53ad9f17b01033ed4c1bd3d6a5881c9c41fb772281e7b7cc9f641
+  metadata.gz: 206e2c4afb1398260ab713f2d85b6628c1594af65a857455b491c27788367b2a90f1f9eb9b943a2f4fcf6355f928d4228f36e76229e77cd75b9611c80a93c81a
+  data.tar.gz: d2690104a7de7e789600837504bed1f7f8d227d395d8a57c39cd51b3fc0ad3ed44522d0ee4211c29da1bc04603f36ce2116312e87afefe327b49dd75eec16d63

data/lib/config/pagy.rb

@@ -3,6 +3,7 @@
 
 # Pagy initializer file
 # Customize only what you really need and notice that Pagy works also without any of the following lines.
+# Should you just cherry pick part of this file, please maintain the require-order of the extras
 
 
 # Extras
@@ -64,6 +65,11 @@
 
 # Feature Extras
 
+# Headers extra: http response headers (and other helpers) useful for API pagination
+# See http://ddnexus.github.io/pagy/extras/headers
+# require 'pagy/extras/headers'
+# Pagy::VARS[:headers] = { items: 'Page-Items', count: 'Total-Count', pages: 'Total-Pages' }     # default
+
 # Support extra: Extra support for features like: incremental, infinite, auto-scroll pagination
 # See https://ddnexus.github.io/pagy/extras/support
 # require 'pagy/extras/support'
@@ -77,7 +83,7 @@
 # Overflow extra: Allow for easy handling of overflowing pages
 # See https://ddnexus.github.io/pagy/extras/overflow
 # require 'pagy/extras/overflow'
-# Pagy::VARS[:overflow] = :last_page    # default  (other options: :empty_page and :exception)
+# Pagy::VARS[:overflow] = :empty_page    # default  (other options: :last_page and :exception)
 
 # Trim extra: Remove the page=1 param from links
 # See https://ddnexus.github.io/pagy/extras/trim
@@ -117,7 +123,8 @@
 
 # Pagy internal I18n: ~18x faster using ~10x less memory than the i18n gem
 # See https://ddnexus.github.io/pagy/api/frontend#i18n
-# Notice: No need to use any of the following lines if you use the i18n extra below
+# Notice: No need to configure anything in this section if your app uses only "en"
+# or if you use the i18n extra below
 #
 # Examples:
 # load the "de" built-in locale:
@@ -133,7 +140,7 @@
 #                 {locale: 'es'})
 #
 # load the "en" built-in locale, a custom "es" locale,
-# and a totally custom locale complete with the :pluralize proc:
+# and a totally custom locale complete with a custom :pluralize proc:
 # (the first passed :locale will be used also as the default_locale)
 # Pagy::I18n.load({locale: 'en'},
 #                 {locale: 'es', filepath: 'path/to/pagy-es.yml'},

data/lib/locales/zh-hk.yml

@@ -0,0 +1,20 @@
+zh-hk:
+  pagy:
+    nav:
+      prev: "‹ 上一頁"
+      next: "下一頁 ›"
+      gap: "…"
+    info:
+      single_page:
+        zero: "%{item_name}未搵到"
+        one: "顯示 <b>1</b> %{item_name}"
+        other: "顯示<b>所有 %{count}</b> %{item_name}"
+      multiple_pages: "共 <b>%{count}</b> %{item_name}，顯示 <b>%{from}-%{to}</b>"
+      item_name:
+        zero: "記錄"
+        one: ""
+        other: ""
+    compact: "第 %{page_input} / %{pages} 頁"
+    items:
+      one: "每頁顯示 %{items_input} 記錄"
+      other: "每頁顯示 %{items_input} 記錄"

data/lib/pagy.rb

@@ -4,7 +4,7 @@
 
 require 'pathname'
 
-class Pagy ; VERSION = '2.0.1'
+class Pagy ; VERSION = '2.1.0'
 
   class OverflowError < StandardError; attr_reader :pagy; def initialize(pagy) @pagy = pagy end; end
 

data/lib/pagy/extras/elasticsearch_rails.rb

@@ -28,7 +28,12 @@ class Pagy
       options[:from] = vars[:items] * (vars[:page] - 1)
       response       = model.search(query_or_payload, options)
       vars[:count]   = response.raw_response['hits']['total']
-      return Pagy.new(vars), called.empty? ? response : response.send(*called)
+      pagy = Pagy.new(vars)
+      # with :last_page overflow we need to re-run the method in order to get the hits
+      if defined?(OVERFLOW) && pagy.overflow? && pagy.vars[:overflow] == :last_page
+        return pagy_elasticsearch_rails(search_args, vars.merge(page: pagy.page))
+      end
+      return pagy, called.empty? ? response : response.send(*called)
     end
 
     # Sub-method called only by #pagy_elasticsearch_rails: here for easy customization of variables by overriding

data/lib/pagy/extras/headers.rb

@@ -0,0 +1,38 @@
+# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/headers
+# encoding: utf-8
+# frozen_string_literal: true
+
+class Pagy
+  # Add specialized backend methods to add pagination response headers
+  module Backend ; private
+
+    VARS[:headers] = { items: 'Page-Items', count: 'Total-Count', pages: 'Total-Pages' }
+
+    include Helpers
+
+    def pagy_headers_merge(pagy)
+      response.headers.merge!(pagy_headers(pagy))
+    end
+
+    def pagy_headers(pagy)
+      hash = pagy_headers_hash(pagy)
+      hash['Link'] = hash['Link'].map{|rel, link| %(<#{link}>; rel="#{rel}")}.join(', ')
+      hash
+    end
+
+    def pagy_headers_hash(pagy)
+      countless = defined?(Pagy::Countless) && pagy.is_a?(Pagy::Countless)
+      rels      = { 'first' => 1, 'prev' => pagy.prev, 'next' => pagy.next }; rels['last'] = pagy.last unless countless
+      url_str   = pagy_url_for(Frontend::MARKER, pagy, :url)
+      hash      = { 'Link' => Hash[rels.map{|rel, n|[rel, url_str.sub(Frontend::MARKER, n.to_s)] if n}.compact] }
+      headers   = pagy.vars[:headers]
+      hash[headers[:items]] = pagy.vars[:items] if headers[:items]
+      unless countless
+        hash[headers[:pages]] = pagy.pages if headers[:pages]
+        hash[headers[:count]] = pagy.count if headers[:count]
+      end
+      hash
+    end
+
+  end
+end

data/lib/pagy/extras/overflow.rb

@@ -4,6 +4,8 @@
 
 class Pagy
 
+  OVERFLOW = true
+
   VARS[:overflow] = :empty_page
 
   def overflow?; @overflow end

data/lib/pagy/extras/searchkick.rb

@@ -28,7 +28,12 @@ class Pagy
       options[:page]     = vars[:page]
       results            = model.search(term, options, &block)
       vars[:count]       = results.total_count
-      return Pagy.new(vars), called.empty? ? results : results.send(*called)
+      pagy = Pagy.new(vars)
+      # with :last_page overflow we need to re-run the method in order to get the hits
+      if defined?(OVERFLOW) && pagy.overflow? && pagy.vars[:overflow] == :last_page
+        return pagy_searchkick(search_args, vars.merge(page: pagy.page))
+      end
+      return pagy, called.empty? ? results : results.send(*called)
     end
 
     # Sub-method called only by #pagy_searchkick: here for easy customization of variables by overriding

data/lib/pagy/frontend.rb

@@ -10,10 +10,23 @@ class Pagy
   # see https://ddnexus.github.io/pagy/api/frontend#i18n
   I18n = eval(Pagy.root.join('locales', 'utils', 'i18n.rb').read) #rubocop:disable Security/Eval
 
+  module Helpers
+    # This works with all Rack-based frameworks (Sinatra, Padrino, Rails, ...)
+    def pagy_url_for(page, pagy, path_or_url=:path)
+      p_vars = pagy.vars; params = request.GET; params[p_vars[:page_param].to_s] = page; params.merge!(p_vars[:params])
+      "#{request.send(path_or_url)}?#{Rack::Utils.build_nested_query(pagy_get_params(params))}#{p_vars[:anchor]}"
+    end
+
+    # Sub-method called only by #pagy_url_for: here for easy customization of params by overriding
+    def pagy_get_params(params) params end
+  end
+
   # All the code here has been optimized for performance: it may not look very pretty
   # (as most code dealing with many long strings), but its performance makes it very sexy! ;)
   module Frontend
 
+    include Helpers
+
     # We use EMPTY + 'whatever' that is almost as fast as +'whatever' but is also 1.9 compatible
     EMPTY = ''
 
@@ -41,15 +54,6 @@ class Pagy
       pagy_t(path, item_name: name, count: pagy.count, from: pagy.from, to: pagy.to)
     end
 
-    # This works with all Rack-based frameworks (Sinatra, Padrino, Rails, ...)
-    def pagy_url_for(page, pagy)
-      p_vars = pagy.vars; params = request.GET.merge(p_vars[:page_param].to_s => page).merge!(p_vars[:params])
-      "#{request.path}?#{Rack::Utils.build_nested_query(pagy_get_params(params))}#{p_vars[:anchor]}"
-    end
-
-    # Sub-method called only by #pagy_url_for: here for easy customization of params by overriding
-    def pagy_get_params(params) params end
-
     MARKER = "-pagy-#{'pagy'.hash}-"
 
     # Returns a performance optimized proc to generate the HTML links

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-06 00:00:00.000000000 Z
+date: 2019-03-12 00:00:00.000000000 Z
 dependencies: []
 description: 'Agnostic pagination in plain ruby: it works with any framework, ORM
   and DB type, with all kinds of collections, even pre-paginated, scopes, Arrays,
@@ -37,6 +37,7 @@ files:
 - lib/locales/utils/loader.rb
 - lib/locales/utils/p11n.rb
 - lib/locales/zh-cn.yml
+- lib/locales/zh-hk.yml
 - lib/pagy.rb
 - lib/pagy/backend.rb
 - lib/pagy/countless.rb
@@ -46,6 +47,7 @@ files:
 - lib/pagy/extras/countless.rb
 - lib/pagy/extras/elasticsearch_rails.rb
 - lib/pagy/extras/foundation.rb
+- lib/pagy/extras/headers.rb
 - lib/pagy/extras/i18n.rb
 - lib/pagy/extras/items.rb
 - lib/pagy/extras/materialize.rb