pagy 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91857948aecc487fd59b4f35a1463fe0ae9fd5a3696fa831aebb23a8d79c439f
-  data.tar.gz: 8c867cbbe116fbd0da51072a53394aafa9a8c428d6410bc4a26edafe9605d393
+  metadata.gz: 1bc238e37f6ae65c1581b464c1ac3b2d3d96a1168aea4d05e6f4c093a6d2a574
+  data.tar.gz: a3cbe116d1279fce48a91ba0c78b1a59d22445fe37f17aff5660305c9b5dc0d2
 SHA512:
-  metadata.gz: 35aa754fd0ab91e77054e850f0d5b0b545300bf0dc20c768351345ebbb81e2e2846aabc648cbe9e80121f7523051f677d29b4b384fe64927b26779c13702a7df
-  data.tar.gz: f7d926209081fa8b7f250bb2183d30f41a432524750dc2e832ec656473e0bf1e313b251caf054283535a515746740e619190f66ecb91a816091963fa531c9e79
+  metadata.gz: a6c0979f616fd8cac7c20ef6f6242ddd8a1a1099fa6b2cf0b3678b180705bc2e74e8e25e29d761a0f497c99aa3120783661f73044dc35bea701ea97c637526c1
+  data.tar.gz: db8389ae56438687fb038915e4a7406d263797f05718fe22bad9b67ec3002f7befd7f21777a09d62023ed1fc1fa74ee50dc82619b685f79419fb9abcafd3e137

data/lib/config/pagy.rb

@@ -12,6 +12,10 @@
 # See https://ddnexus.github.io/pagy/extras/array
 # require 'pagy/extras/array'
 
+# Countless: Paginate without any count, saving one query per rendering
+# See https://ddnexus.github.io/pagy/extras/countless
+# require 'pagy/extras/countless'
+
 # Elasticsearch Rails: Paginate `ElasticsearchRails::Results` objects efficiently, avoiding expensive object-wrapping and without overriding.
 # See https://ddnexus.github.io/pagy/extras/elasticsearch_rails
 # require 'pagy/extras/elasticsearch_rails'

data/lib/pagy.rb

@@ -3,7 +3,7 @@
 
 require 'pathname'
 
-class Pagy ; VERSION = '1.0.0'
+class Pagy ; VERSION = '1.1.0'
 
   class OverflowError < StandardError; attr_reader :pagy; def initialize(pagy) @pagy = pagy end; end
 
@@ -15,7 +15,7 @@ class Pagy ; VERSION = '1.0.0'
 
   attr_reader :count, :page, :items, :vars, :pages, :last, :offset, :from, :to, :prev, :next
 
-  # Merge and validate the options, do some simple aritmetic and set the instance variables
+  # Merge and validate the options, do some simple arithmetic and set the instance variables
   def initialize(vars)
     @vars = VARS.merge(vars.delete_if{|_,v| v.nil? || v == '' })               # default vars + cleaned vars
     { count:0, items:1, outset:0, page:1 }.each do |k,min|                     # validate instance variables
@@ -34,8 +34,8 @@ class Pagy ; VERSION = '1.0.0'
 
   # Return the array of page numbers and :gap items e.g. [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
   def series(size=@vars[:size])
+    (series = []) and size.empty? and return series
     4.times{|i| (size[i]>=0 rescue nil) or raise(ArgumentError, "expected 4 items >= 0 in :size; got #{size.inspect}")}
-    series = []
     [*0..size[0], *@page-size[1]..@page+size[2], *@last-size[3]+1..@last+1].sort!.each_cons(2) do |a, b|
       if    a<0 || a==b || a>@last                                        # skip out of range and duplicates
       elsif a+1 == b; series.push(a)                                      # no gap     -> no additions

data/lib/pagy/countless.rb

@@ -0,0 +1,30 @@
+require 'pagy'
+
+class Pagy
+
+  class Countless < Pagy
+
+    # Merge and validate the options, do some simple arithmetic and set a few instance variables
+    def initialize(vars={})
+      @vars ||= VARS.merge(vars.delete_if{|_,v| v.nil? || v == '' })    # default vars + cleaned vars (can be overridden)
+      { items:1, outset:0, page:1 }.each do |k,min|                     # validate instance variables
+        (@vars[k] && instance_variable_set(:"@#{k}", @vars[k].to_i) >= min) \
+         or raise(ArgumentError, "expected :#{k} >= #{min}; got #{@vars[k].inspect}")
+      end
+      @offset = @items * (@page - 1) + @outset                          # pagination offset + outset (initial offset)
+    end
+
+    # Finalize the instance variables based on the retrieved items
+    def finalize(items)
+      items == 0 && @page > 1 and raise(OverflowError.new(self), "page #{@page} got no items")
+      @pages = @last = (items > @items ? @page + 1 : @page)             # set the @pages and @last
+      @items = items if items < @items && items > 0                     # adjust items for last non-empty page
+      @from  = items == 0 ? 0 : @offset+1 - @outset                     # page begins from item
+      @to    = items == 0 ? 0 : @offset + @items - @outset              # page ends to item
+      @prev  = (@page-1 unless @page == 1)                              # nil if no prev page
+      @next  = (@page+1 unless @page == @last)                          # nil if no next page
+      self
+    end
+
+  end
+end

data/lib/pagy/extras/countless.rb

@@ -0,0 +1,35 @@
+# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/countless
+
+require 'pagy/countless'
+
+class Pagy
+
+  # used by the items extra
+  COUNTLESS = true
+
+  module Backend ; private         # the whole module is private so no problem with including it in a controller
+
+    # Return Pagy object and items
+    def pagy_countless(collection, vars={})
+      pagy = Pagy::Countless.new(pagy_countless_get_vars(collection, vars))
+      return pagy, pagy_countless_get_items(collection, pagy)
+    end
+
+    # Sub-method called only by #pagy_countless: here for easy customization of variables by overriding
+    def pagy_countless_get_vars(_collection, vars)
+      # Return the merged variables to initialize the Pagy object
+      { page: params[vars[:page_param]||VARS[:page_param]] }.merge!(vars)
+    end
+
+    # Sub-method called only by #pagy_countless: here for easy customization of record-extraction by overriding
+    def pagy_countless_get_items(collection, pagy)
+      # This should work with ActiveRecord, Sequel, Mongoid...
+      items      = collection.offset(pagy.offset).limit(pagy.items + 1).to_a
+      items_size = items.size
+      items.pop if items_size == pagy.items + 1
+      pagy.finalize(items_size)                  # finalize may adjust pagy.items, so must be used after checking the size
+      items
+    end
+
+  end
+end

data/lib/pagy/extras/items.rb

@@ -10,14 +10,28 @@ class Pagy
   # Handle a custom number of :items from params
   module Backend ; private
 
-    alias_method :pagy_get_vars_without_items, :pagy_get_vars
-    def pagy_get_vars_with_items(collection, vars)
+    def pagy_with_items(vars)
       vars[:items] ||= (items = params[vars[:items_param] || VARS[:items_param]]) &&                           # :items from :items_param
                        [items&.to_i, vars.key?(:max_items) ? vars[:max_items] : VARS[:max_items]].compact.min  # :items capped to :max_items
+    end
+
+    alias_method :pagy_get_vars_without_items, :pagy_get_vars
+    def pagy_get_vars_with_items(collection, vars)
+      pagy_with_items(vars)
       pagy_get_vars_without_items(collection, vars)
     end
     alias_method :pagy_get_vars, :pagy_get_vars_with_items
 
+    # support for countless extra
+    if defined?(Pagy::COUNTLESS)   # defined in the countless extra
+      alias_method :pagy_countless_get_vars_without_items, :pagy_countless_get_vars
+      def pagy_countless_get_vars_with_items(collection, vars)
+        pagy_with_items(vars)
+        pagy_countless_get_vars_without_items(collection, vars)
+      end
+      alias_method :pagy_countless_get_vars, :pagy_countless_get_vars_with_items
+    end
+
   end
 
   module Frontend

data/lib/pagy/extras/overflow.rb

@@ -3,9 +3,9 @@
 
 class Pagy
 
-  VARS[:overflow] = :last_page
+  VARS[:overflow] = :empty_page
 
-  def overflow?; @overflow end
+  def overflow?; !!@overflow end
 
   module Overflow
 
@@ -29,20 +29,41 @@ class Pagy
       end
     end
 
+    module Series
+      def series(size=@vars[:size])
+        @page = @last                               # series for last page
+        super(size).tap do |s|                      # call original series
+          s[s.index(@page.to_s)] = @page            # string to integer (i.e. no current page)
+          @page = @vars[:page]                      # restore the actual page
+        end
+      end
+    end
+
   end
+  prepend Overflow
 
-  module Series
+  # support for Pagy::Countless
+  if defined?(Pagy::Countless)
+    module CountlessOverflow
 
-    def series(size=@vars[:size])
-      @page = @last                               # series for last page
-      super(size).tap do |s|                      # call original series
-        s[s.index(@page.to_s)] = @page            # string to integer (i.e. no current page)
-        @page = @vars[:page]                      # restore the actual page
+      def finalize(items)
+        super
+      rescue OverflowError
+        @overflow = true                            # add the overflow flag
+        case @vars[:overflow]
+        when :exception
+          raise                                     # same as without the extra
+        when :empty_page
+          @offset = @items = @from = @to = 0        # vars relative to the actual page
+          @vars[:size] = []                         # no page in the series
+          self
+        else
+          raise ArgumentError, "expected :overflow variable in [:empty_page, :exception]; got #{@vars[:overflow].inspect}"
+        end
       end
-    end
 
+    end
+    Countless.prepend CountlessOverflow
   end
 
-  prepend Overflow
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-18 00:00:00.000000000 Z
+date: 2018-11-20 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,
@@ -36,9 +36,11 @@ files:
 - lib/locales/zh-cn.yml
 - lib/pagy.rb
 - lib/pagy/backend.rb
+- lib/pagy/countless.rb
 - lib/pagy/extras/array.rb
 - lib/pagy/extras/bootstrap.rb
 - lib/pagy/extras/bulma.rb
+- lib/pagy/extras/countless.rb
 - lib/pagy/extras/elasticsearch_rails.rb
 - lib/pagy/extras/foundation.rb
 - lib/pagy/extras/i18n.rb