pagy 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea9f5556f76cbbc137144639af45e161a9caf36bde512201911ed04103c7707
-  data.tar.gz: c3a0337dd4d124275e33bab79e2ff30d0f7a56a6a715a602dfc06deef88dda86
+  metadata.gz: 681052934a39cf55ae637f4760440afea264bdef4edb5b6d3f42cfc1a22f78d5
+  data.tar.gz: '0728e6ad1211af132b074c0a41419136b4554406a78d002c07af29db9b6e97eb'
 SHA512:
-  metadata.gz: b8be1f7f3369f8ce276d04bf67436e3bd40c3a1f788720f04a9928da63a60a4157fea59344c5bebabb6f7303f8a45d094aa6993c7b87bc1534ac219fa4efa6f0
-  data.tar.gz: e676ffa46c89159efe7272b4250e3819762355b3c45e73f4a1ad5e6d378697bfe5048ec27c2fef2a19dd597fd288d3bf7b453c19839c00f8fd4cdfd37eeea87a
+  metadata.gz: 2577f76f006a80e85001f0d16eb85f87b4f47d1439040754355131e5032e75e997273d9174c18fd2979b21e57fe709dcee5acdbc7c6c8264b0d5a438bbede6e2
+  data.tar.gz: 0a0d7c7a41ea3020c60b1e3461ff5a3a68e6ddbc592f74492e17a3741905e5dd0219734ad0361058dba0a7b15432462cc41fa5fcb391742ee1917ee442e3d97e

data/lib/pagy.rb

@@ -3,7 +3,7 @@
 
 require 'pathname'
 
-class Pagy ; VERSION = '0.14.0'
+class Pagy ; VERSION = '0.15.0'
 
   class OutOfRangeError < StandardError; attr_reader :pagy; def initialize(pagy) @pagy = pagy end; end
 

data/lib/pagy/extras/compact.rb

@@ -12,13 +12,14 @@ class Pagy
 
       html << %(<nav id="pagy-nav-#{id}" class="pagy-nav-compact pagination" role="navigation" aria-label="pager">)
         html << link.call(MARKER, '', %(style="display: none;" ))
-        html << (p_prev ? %(<span class="page prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</span> )
+        (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} #{pagy_t('pagy.compact.of')} #{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><script type="application/json" class="pagy-compact-json">["#{id}", "#{MARKER}", "#{p_page}"]</script>)
+      html << %(</nav><script type="application/json" class="pagy-compact-json">["#{id}", "#{MARKER}", "#{p_page}", #{!!defined?(TRIM)}]</script>)
     end
 
     # Compact pagination for bootstrap: it returns the html with the series of links to the pages
@@ -28,14 +29,15 @@ class Pagy
 
       html << %(<nav id="pagy-nav-#{id}" class="pagy-nav-compact-bootstrap pagination" role="navigation" aria-label="pager">)
         html << link.call(MARKER, '', %(style="display: none;" ))
-        html << %(<div class="btn-group" role="group">)
+        (html << link.call(1, '', %(style="display: none;" ))) if defined?(TRIM)
+      html << %(<div class="btn-group" role="group">)
         html << (p_prev ? link.call(p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous" class="prev btn btn-primary"')
                         : %(<a class="prev btn btn-primary disabled" href="#">#{pagy_t('pagy.nav.prev')}</a>))
         input = %(<input type="number" min="1" max="#{p_pages}" value="#{p_page}" style="padding: 0; border: none; text-align: center; width: #{p_pages.to_s.length+1}rem;">)
         html << %(<div class="pagy-compact-input btn btn-primary disabled">#{pagy_t('pagy.compact.page')} #{input} #{pagy_t('pagy.compact.of')} #{p_pages}</div>)
         html << (p_next ? link.call(p_next, pagy_t('pagy.nav.next'), 'aria-label="next" class="next btn btn-primary"')
                         : %(<a class="next btn btn-primary disabled" href="#">#{pagy_t('pagy.nav.next')}</a>))
-      html << %(</div></nav><script type="application/json" class="pagy-compact-json">["#{id}", "#{MARKER}", "#{p_page}"]</script>)
+      html << %(</div></nav><script type="application/json" class="pagy-compact-json">["#{id}", "#{MARKER}", "#{p_page}", #{!!defined?(TRIM)}]</script>)
     end
 
     # Compact pagination for Bulma: it returns the html with the series of links to the pages
@@ -45,6 +47,7 @@ class Pagy
 
       html << %(<nav id="pagy-nav-#{id}" class="pagy-nav-compact-bulma" role="navigation" aria-label="pagination">)
         html << link.call(MARKER, '', 'style="display: none;"')
+        (html << link.call(1, '', %(style="display: none;"))) if defined?(TRIM)
         html << %(<div class="field is-grouped is-grouped-centered" role="group">)
         html << (p_prev ? %(<p class="control">#{link.call(p_prev, pagy_t('pagy.nav.prev'), 'class="button" aria-label="previous page"')}</p>)
                         : %(<p class="control"><a class="button" disabled>#{pagy_t('pagy.nav.prev')}</a></p>))
@@ -52,7 +55,7 @@ class Pagy
         html << %(<div class="pagy-compact-input control level is-mobile">#{pagy_t('pagy.compact.page')}&nbsp;#{input}&nbsp;#{pagy_t('pagy.compact.of')} #{p_pages}</div>)
         html << (p_next ? %(<p class="control">#{link.call(p_next, pagy_t('pagy.nav.next'), 'class="button" aria-label="next page"')}</p>)
                         : %(<p class="control"><a class="button" disabled>#{pagy_t('pagy.nav.next')}</a></p>))
-      html << %(</div></nav><script type="application/json" class="pagy-compact-json">["#{id}", "#{MARKER}", "#{p_page}"]</script>)
+      html << %(</div></nav><script type="application/json" class="pagy-compact-json">["#{id}", "#{MARKER}", "#{p_page}", #{!!defined?(TRIM)}]</script>)
     end
 
     # Compact pagination for materialize: it returns the html with the series of links to the pages
@@ -62,6 +65,7 @@ class Pagy
 
       html << %(<div id="pagy-nav-#{id}" class="pagy-nav-compact-materialize pagination" role="navigation" aria-label="pager">)
       html << link.call(MARKER, '', %(style="display: none;" ))
+      (html << link.call(1, '', %(style="display: none;" ))) if defined?(TRIM)
       html << %(<div class="pagy-compact-chip role="group" style="height: 35px; border-radius: 18px; background: #e4e4e4; display: inline-block;">)
       html << '<ul class="pagination" style="margin: 0px;">'
       li_style = 'style="vertical-align: middle;"'
@@ -71,7 +75,7 @@ class Pagy
       html << %(<div class="pagy-compact-input btn-flat" style="cursor: default; padding: 0px">#{pagy_t('pagy.compact.page')} #{input} #{pagy_t('pagy.compact.of')} #{p_pages}</div>)
       html << (p_next ? %(<li class="waves-effect next" #{li_style}>#{link.call p_next, '<i class="material-icons">chevron_right</i>', 'aria-label="next"'}</li>)
                       : %(<li class="next disabled" #{li_style}><a href="#"><i class="material-icons">chevron_right</i></a></li>))
-      html << %(</ul></div><script type="application/json" class="pagy-compact-json">["#{id}", "#{MARKER}", "#{p_page}"]</script>)
+      html << %(</ul></div><script type="application/json" class="pagy-compact-json">["#{id}", "#{MARKER}", "#{p_page}", #{!!defined?(TRIM)}]</script>)
     end
 
   end

data/lib/pagy/extras/initializer_example.rb

@@ -41,6 +41,10 @@
 # See https://ddnexus.github.io/pagy/extras/responsive#breakpoints
 # Pagy::VARS[:breakpoints] = { 0 => [1,2,2,1], 350 => [2,3,3,2], 550 => [3,4,4,3] }    # example of width/size pairs
 
+# Trim: Remove the page=1 param from links
+# See https://ddnexus.github.io/pagy/extras/trim
+# require 'pagy/extras/trim'
+
 
 # Pagy Variables
 # See https://ddnexus.github.io/pagy/api/pagy#variables

data/lib/pagy/extras/items.rb

@@ -10,23 +10,24 @@ class Pagy
   # Handle a custom number of :items from params
   module Backend ; private
 
-    alias_method :built_in_pagy_get_vars, :pagy_get_vars
-
-    def pagy_get_vars(collection, vars)
+    alias_method :pagy_get_vars_without_items, :pagy_get_vars
+    def pagy_get_vars_with_items(collection, 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
-      built_in_pagy_get_vars(collection, vars)
+      pagy_get_vars_without_items(collection, vars)
     end
+    alias_method :pagy_get_vars, :pagy_get_vars_with_items
 
   end
 
   module Frontend
 
-    # This works with all Rack-based frameworks (Sinatra, Padrino, Rails, ...)
-    def pagy_url_for(page, pagy)
+    alias_method :pagy_url_for_without_items, :pagy_url_for
+    def pagy_url_for_with_items(page, pagy)
       p_vars = pagy.vars; params = request.GET.merge(p_vars[:page_param] => page, p_vars[:items_param] => p_vars[:items]).merge!(p_vars[:params])
       "#{request.path}?#{Rack::Utils.build_nested_query(pagy_get_params(params))}#{p_vars[:anchor]}"
     end
+    alias_method :pagy_url_for, :pagy_url_for_with_items
 
     # Return the items selector HTML. For example "Show [20] items per page"
     def pagy_items_selector(pagy, id=caller(1,1)[0].hash)

data/lib/pagy/extras/javascripts/pagy.js

@@ -13,15 +13,19 @@ Pagy.addInputEventListeners = function(input, handler){
                                 input.addEventListener('keyup', function(e){ if (e.which === 13) handler() }.bind(this));
                               };
 
-Pagy.compact = function(id, marker, page){
+Pagy.compact = function(id, marker, page, trim){
                  var pagyNav = document.getElementById('pagy-nav-'+id),
                      input   = pagyNav.getElementsByTagName('input')[0],
                      link    = pagyNav.getElementsByTagName('a')[0],
+                     linkP1  = pagyNav.getElementsByTagName('a')[1],
                      go      = function(){
                                  if (page !== input.value) {
-                                   var href = link.getAttribute('href').replace(marker, input.value);
-                                   link.setAttribute('href', href);
-                                   link.click();
+                                   if (trim === true && input.value === '1') { linkP1.click() }
+                                   else {
+                                     var href = link.getAttribute('href').replace(marker, input.value);
+                                     link.setAttribute('href', href);
+                                     link.click();
+                                   }
                                  }
                                };
                  Pagy.addInputEventListeners(input, go);

data/lib/pagy/extras/trim.rb

@@ -0,0 +1,30 @@
+# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/trim
+# frozen_string_literal: true
+
+class Pagy
+
+  module Frontend
+
+    # boolean used by the compact extra
+    TRIM = true
+
+    def pagy_trim_url(url, param_string)
+      url.sub(/((?:[?&])#{param_string}\z|\b(?<=[?&])#{param_string}&)/, '')
+    end
+
+    alias_method :pagy_link_proc_without_trim, :pagy_link_proc
+    def pagy_link_proc_with_trim(pagy, link_extra='')
+      p_prev, p_next, p_vars = pagy.prev, pagy.next, pagy.vars
+      url   = pagy_url_for(MARKER, pagy)
+      p1url = pagy_trim_url(url, "#{p_vars[:page_param]}=#{MARKER}")
+      p1    = %(<a href="#{p1url}" #{p_vars[:link_extra]} #{link_extra})
+      a, b = %(<a href="#{url}" #{p_vars[:link_extra]} #{link_extra}).split(MARKER, 2)
+      -> (n, text=n, extra='') { start = n == 1 ? p1 : "#{a}#{n}#{b}"
+                                 "#{start}#{ if    n == p_prev ; ' rel="prev"'
+                                             elsif n == p_next ; ' rel="next"'
+                                             else                           '' end } #{extra}>#{text}</a>" }
+    end
+    alias_method :pagy_link_proc, :pagy_link_proc_with_trim
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-17 00:00:00.000000000 Z
+date: 2018-07-29 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,
@@ -45,6 +45,7 @@ files:
 - lib/pagy/extras/templates/nav_bulma.html.erb
 - lib/pagy/extras/templates/nav_bulma.html.haml
 - lib/pagy/extras/templates/nav_bulma.html.slim
+- lib/pagy/extras/trim.rb
 - lib/pagy/frontend.rb
 - pagy.gemspec
 homepage: https://github.com/ddnexus/pagy