pagy 2.1.5 → 3.0.0

data/lib/pagy/extras/shared.rb

@@ -1,42 +1,45 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
-require 'json'
 require 'digest'
 
 class Pagy
 
-  # Default :breakpoints
-  VARS[:breakpoints] = { 0 => [1,4,4,1] }
-
-  # Helper for building the page_nav with javascript. For example:
-  # with an object like:
-  #   Pagy.new count:1000, page: 20, breakpoints: {0 => [1,2,2,1], 350 => [2,3,3,2], 550 => [3,4,4,3]}
-  # it returns something like:
-  #   { :items  => [1, :gap, 18, 19, "20", 21, 22, 50, 2, 17, 23, 49, 3, 16, 24, 48],
-  #     :series => { 0   => [1, :gap, 18, 19, "20", 21, 22, :gap, 50],
-  #                  350 => [1, 2, :gap, 17, 18, 19, "20", 21, 22, 23, :gap, 49, 50],
-  #                  550 => [1, 2, 3, :gap, 16, 17, 18, 19, "20", 21, 22, 23, 24, :gap, 48, 49, 50] },
-  #     :widths => [550, 350, 0] }
-  # where :items  is the unordered array union of all the page numbers for all sizes (passed to the PagyResponsive javascript function)
-  #       :series is the hash of the series keyed by width (used by the *_responsive helpers to create the JSON string)
-  #       :widths is the desc-ordered array of widths (passed to the PagyResponsive javascript function)
-  def responsive
-    @responsive ||= {items: [], series: {}, widths:[]}.tap do |r|
-      @vars[:breakpoints].key?(0) || raise(ArgumentError, "expected :breakpoints to contain the 0 size; got #{@vars[:breakpoints].inspect}")
-      @vars[:breakpoints].each {|width, size| r[:items] |= r[:series][width] = series(size)}
-      r[:widths] = r[:series].keys.sort!{|a,b| b <=> a}
-    end
+  # default :steps: false will use {0 => @vars[:size]}
+  VARS[:steps] = false
+
+  # `Pagy` instance method used by the `pagy*_nav_js` helpers.
+  # It returns the sequels of width/series generated from the :steps hash
+  # Example:
+  # >> pagy = Pagy.new(count:1000, page: 20, steps: {0 => [1,2,2,1], 350 => [2,3,3,2], 550 => [3,4,4,3]})
+  # >> pagy.sequels
+  # #=> { "0"   => [1, :gap, 18, 19, "20", 21, 22, :gap, 50],
+  #       "350" => [1, 2, :gap, 17, 18, 19, "20", 21, 22, 23, :gap, 49, 50],
+  #       "550" => [1, 2, 3, :gap, 16, 17, 18, 19, "20", 21, 22, 23, 24, :gap, 48, 49, 50] }
+  # Notice: if :steps is false it will use the single {0 => @vars[:size]} size
+  def sequels
+    steps = @vars[:steps] || {0 => @vars[:size]}
+    steps.key?(0) or raise(ArgumentError, "expected :steps to define the 0 width; got #{steps.inspect}")
+    sequels = {}; steps.each {|width, size| sequels[width.to_s] = series(size)}; sequels
   end
 
   module Frontend
 
-    def pagy_json_tag(*args)
-      %(<script type="application/json" class="pagy-json">#{args.to_json}</script>)
+    if defined?(Oj)
+      # returns a script tag with the JSON-serialized args generated with the faster oj gem
+      def pagy_json_tag(*args)
+        %(<script type="application/json" class="pagy-json">#{Oj.dump(args, mode: :strict)}</script>)
+      end
+    else
+      require 'json'
+      # returns a script tag with the JSON-serialized args generated with the slower to_json
+      def pagy_json_tag(*args)
+        %(<script type="application/json" class="pagy-json">#{args.to_json}</script>)
+      end
     end
 
+    # returns the SHA1 (fastest on modern ruby) string used as default `id` attribute by all the `*_js` tags
     def pagy_id
-      # SHA1 is the fastest on modern ruby
       "pagy-#{Digest::SHA1.hexdigest(caller(2..2)[0].split(':in')[0])}"
     end
 

data/lib/pagy/extras/support.rb

@@ -2,25 +2,8 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
-
 class Pagy
 
-  def to_h
-    { count:  defined?(@count) && @count,
-      page:   @page,
-      items:  @items,
-      pages:  @pages,
-      last:   @last,
-      offset: @offset,
-      from:   @from,
-      to:     @to,
-      prev:   @prev,
-      next:   @next,
-      vars:   @vars,
-      series: series }
-  end
-
   module Frontend
 
     def pagy_prev_url(pagy)
@@ -41,15 +24,6 @@ class Pagy
                 : %(<span class="page next disabled">#{text}</span>)
     end
 
-    def pagy_serialized(pagy)
-      pagy.to_h.merge(prev_url: pagy_prev_url(pagy), next_url: pagy_next_url(pagy))
-    end
-
-    # Multi purpose JSON tag for custom javascript initialization
-    def pagy_apply_init_tag(pagy, function, payload=pagy_serialized(pagy))
-      pagy_json_tag(:applyInit, function, payload)
-    end
-
   end
 
 end

data/lib/pagy/frontend.rb

@@ -47,11 +47,12 @@ class Pagy
       %(<nav class="pagy-nav pagination" role="navigation" aria-label="pager">#{html}</nav>)
     end
 
-    # Return examples: "Displaying items 41-60 of 324 in total"  or "Displaying Products 41-60 of 324 in total"
+    # Return examples: "Displaying items 41-60 of 324 in total" of "Displaying Products 41-60 of 324 in total"
     def pagy_info(pagy)
-      name = pagy_t(pagy.vars[:item_path], count: pagy.count)
-      path = pagy.pages == 1 ? 'pagy.info.single_page' : 'pagy.info.multiple_pages'
-      pagy_t(path, item_name: name, count: pagy.count, from: pagy.from, to: pagy.to)
+      path = if (count = pagy.count) == 0 ; 'pagy.info.no_items'
+             else pagy.pages == 1 ? 'pagy.info.single_page' : 'pagy.info.multiple_pages'
+             end
+      pagy_t(path, item_name: pagy_t(pagy.vars[:i18n_key], count: count), count: count, from: pagy.from, to: pagy.to)
     end
 
     MARKER = "-pagy-#{'pagy'.hash}-"
@@ -67,7 +68,7 @@ class Pagy
     end
 
     # Similar to I18n.t: just ~18x faster using ~10x less memory
-    def pagy_t(path, vars={}) Pagy::I18n.t(@pagy_locale, path, vars) end
+    def pagy_t(path, vars={}) Pagy::I18n.t(@pagy_locale||=nil, path, vars) end
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 3.0.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2019-04-28 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,
@@ -26,10 +26,12 @@ files:
 - lib/locales/de.yml
 - lib/locales/en.yml
 - lib/locales/es.yml
+- lib/locales/fr.yml
 - lib/locales/id.yml
 - lib/locales/ja.yml
 - lib/locales/nb.yml
 - lib/locales/nl.yml
+- lib/locales/pl.yml
 - lib/locales/pt-br.yml
 - lib/locales/ru.yml
 - lib/locales/se.yml
@@ -53,9 +55,9 @@ files:
 - lib/pagy/extras/i18n.rb
 - lib/pagy/extras/items.rb
 - lib/pagy/extras/materialize.rb
+- lib/pagy/extras/navs.rb
 - lib/pagy/extras/overflow.rb
 - lib/pagy/extras/pagy_search.rb
-- lib/pagy/extras/plain.rb
 - lib/pagy/extras/searchkick.rb
 - lib/pagy/extras/semantic.rb
 - lib/pagy/extras/shared.rb
@@ -94,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The Ultimate Pagination Ruby Gem

data/lib/pagy/extras/plain.rb

@@ -1,50 +0,0 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/plain
-# encoding: utf-8
-# frozen_string_literal: true
-
-require 'pagy/extras/shared'
-
-class Pagy
-  module Frontend
-
-    # added alias for symmetry
-    alias :pagy_plain_nav :pagy_nav
-
-    # Plain compact pagination: it returns the html with the series of links to the pages
-    # we use a numeric input tag to set the page and the Pagy.compact javascript to navigate
-    def pagy_plain_compact_nav(pagy, id=pagy_id)
-      link, p_prev, p_next, p_page, p_pages = pagy_link_proc(pagy), pagy.prev, pagy.next, pagy.page, pagy.pages
-
-      html = EMPTY + %(<nav id="#{id}" class="pagy-plain-compact-nav pagination" role="navigation" aria-label="pager">)
-        html << link.call(MARKER, '', %(style="display: none;" ))
-        (html << link.call(1, '', %(style="display: none;" ))) if defined?(TRIM)
-        html << (p_prev ? %(<span class="page prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</span> )
-                        : %(<span class="page prev disabled">#{pagy_t('pagy.nav.prev')}</span> ))
-        input = %(<input type="number" min="1" max="#{p_pages}" value="#{p_page}" style="padding: 0; text-align: center; width: #{p_pages.to_s.length+1}rem;">)
-        html << %(<span class="pagy-compact-input" style="margin: 0 0.6rem;">#{pagy_t('pagy.compact', page_input: input, count: p_page, pages: p_pages)}</span> )
-        html << (p_next ? %(<span class="page next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</span>)
-                        : %(<span class="page next disabled">#{pagy_t('pagy.nav.next')}</span>))
-      html << %(</nav>#{pagy_json_tag(:compact, id, MARKER, p_page, !!defined?(TRIM))})
-    end
-
-    # Plain responsive pagination: it returns the html with the series of links to the pages
-    # rendered by the Pagy.responsive javascript
-    def pagy_plain_responsive_nav(pagy, id=pagy_id)
-      tags, link, p_prev, p_next, responsive = {}, pagy_link_proc(pagy), pagy.prev, pagy.next, pagy.responsive
-
-      tags['before'] = (p_prev ? %(<span class="page prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</span> )
-                               : %(<span class="page prev disabled">#{pagy_t('pagy.nav.prev')}</span> ))
-      responsive[:items].each do |item|  # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
-        tags[item.to_s] = if    item.is_a?(Integer); %(<span class="page">#{link.call item}</span> )             # page link
-                          elsif item.is_a?(String) ; %(<span class="page active">#{item}</span> )                # current page
-                          elsif item == :gap       ; %(<span class="page gap">#{pagy_t('pagy.nav.gap')}</span> ) # page gap
-                          end
-      end
-      tags['after'] = (p_next ? %(<span class="page next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</span>)
-                              : %(<span class="page next disabled">#{pagy_t('pagy.nav.next')}</span>))
-      script = pagy_json_tag(:responsive, id, tags,  responsive[:widths], responsive[:series])
-      %(<nav id="#{id}" class="pagy-plain-responsive-nav pagination" role="navigation" aria-label="pager"></nav>#{script})
-    end
-
-  end
-end