pagy-extras 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8559ae8ed8572a4a9bc2d6c021a073cb80ed844710735b3aea1ad5792ef139f
+  data.tar.gz: bca19b74ca938d5bfa5a7f1e6f6b7dfc9d127ec84702464c2fad33e508a676d4
+SHA512:
+  metadata.gz: 03f6a0ec22f9008eac34d6e057235bf823695a4b22110f1c3e916a018f0d3de5d70d2f3693c06b6705f2676e31c7e9e7f33eab6727c0f8a3bdaa239891771f5a
+  data.tar.gz: 362938896a1418e460b6b2a7338523257965650a970f0dd0343a2d6c189c921ebe952317b42e4de374d7d7c65bc00edbe49ef088d7215b021ed4bdd24738dae2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-2018 Domizio Demichelis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/javascripts/pagy-compact.js

@@ -0,0 +1,15 @@
+function PagyCompact(id, marker, page){
+  var pagyNav = document.getElementById('pagy-nav-'+id),
+      input   = pagyNav.getElementsByTagName('input')[0],
+      link    = pagyNav.getElementsByTagName('a')[0];
+
+  this.go = function(){
+    if (page !== input.value) {
+      var href = link.getAttribute('href').replace(marker, input.value);
+      link.setAttribute('href', href);
+      link.click();
+    }
+  };
+
+  input.addEventListener("focusout", this.go);
+}

data/lib/javascripts/pagy-responsive.js

@@ -0,0 +1,24 @@
+function PagyResponsive(id, items, widths, series){
+  var pagyNav    = document.getElementById('pagy-nav-'+id),
+      pagyBox    = pagyNav.firstChild || pagyNav,
+      pagyParent = pagyNav.parentElement,
+      lastWidth  = undefined;
+
+  this.render = function(){
+                  var parentWidth = parseInt(pagyParent.clientWidth),
+                      width       = widths.find(function(w){return parentWidth > w});
+                  if (width !== lastWidth) {
+                    while (pagyBox.firstChild) { pagyBox.removeChild(pagyBox.firstChild) }
+                    var tags = items['prev'];
+                    series[width].forEach(function(item){tags += items[item]});
+                    tags += items['next'];
+                    pagyBox.insertAdjacentHTML('beforeend', tags);
+                    lastWidth = width;
+                  }
+                };
+
+  if (window.attachEvent) { window.attachEvent('onresize', this.render) }
+  else if (window.addEventListener) { window.addEventListener('resize', this.render, true) }
+
+  this.render();
+};

data/lib/pagy-extras.rb

@@ -0,0 +1,12 @@
+# See the Pagy Extras documentation: https://ddnexus.github.io/pagy/pagy-extras
+
+require 'pagy'
+
+module Pagy
+  def self.extras_root; Pathname.new(__FILE__).dirname end
+end
+
+require 'pagy-extras/bootstrap'
+require 'pagy-extras/compact'
+require 'pagy-extras/responsive'
+

data/lib/pagy-extras/bootstrap.rb

@@ -0,0 +1,25 @@
+# See the Pagy Extras documentation: https://ddnexus.github.io/pagy/pagy-extras
+
+class Pagy
+  module Frontend
+
+    # Pagination for bootstrap: it returns the html with the series of links to the pages
+    def pagy_nav_bootstrap(pagy)
+      tags = ''; link = pagy_link_proc(pagy, 'class="page-link"'.freeze)
+
+      tags << (pagy.prev ? %(<li class="page-item prev">#{link.call pagy.prev, pagy_t('pagy.nav.prev'.freeze), 'aria-label="previous"'.freeze}</li>)
+                         : %(<li class="page-item prev disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.prev'.freeze)}</a></li>))
+      pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+        tags << if    item.is_a?(Integer); %(<li class="page-item">#{link.call item}</li>)                                                               # page link
+                elsif item.is_a?(String) ; %(<li class="page-item active">#{link.call item}</li>)                                                        # active page
+                elsif item == :gap       ; %(<li class="page-item gap disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.gap'.freeze)}</a></li>) # page gap
+                end
+      end
+      tags << (pagy.next ? %(<li class="page-item next">#{link.call pagy.next, pagy_t('pagy.nav.next'.freeze), 'aria-label="next"'.freeze}</li>)
+                         : %(<li class="page-item next disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.next'.freeze)}</a></li>))
+      %(<nav class="pagy-nav-boostrap pagination" role="navigation" aria-label="pager"><ul class="pagination">#{tags}</ul></nav>)
+    end
+
+  end
+end
+

data/lib/pagy-extras/compact.rb

@@ -0,0 +1,51 @@
+# See the Pagy Extras documentation: https://ddnexus.github.io/pagy/pagy-extras
+
+class Pagy
+
+  module Frontend
+
+    # Generic 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 PagyCompact javascript to navigate
+    def pagy_nav_compact(pagy, id=caller(1,1)[0].hash)
+      tags = ''; link = pagy_link_proc(pagy)
+
+      tags << %(<nav id="pagy-nav-#{id}" class="pagy-nav-compact pagination" role="navigation" aria-label="pager">)
+
+        tags << link.call(MARKER, '', %(style="display: none;" ))
+        tags << (pagy.prev ? %(<span class="page prev">#{link.call pagy.prev, pagy_t('pagy.nav.prev'.freeze), 'aria-label="previous"'.freeze}</span> )
+                           : %(<span class="page prev disabled">#{pagy_t('pagy.nav.prev'.freeze)}</span> ))
+
+        input = %(<input type="number" min="1" max="#{pagy.last}" value="#{pagy.page}" style="padding: 0; text-align: center; width: #{pagy.pages.to_s.length+1}rem;">)
+        tags << %(<span class="pagy-compact-input" style="margin: 0 0.6rem;">#{pagy_t('pagy.compact.page'.freeze)} #{input} #{pagy_t('pagy.compact.of'.freeze)} #{pagy.pages}</span> )
+
+        tags << (pagy.next ? %(<span class="page next">#{link.call pagy.next, pagy_t('pagy.nav.next'.freeze), 'aria-label="next"'.freeze}</span>)
+                           : %(<span class="page next disabled">#{pagy_t('pagy.nav.next'.freeze)}</span>))
+
+      tags << %(</nav><script>PagyCompact('#{id}', '#{MARKER}', '#{pagy.page}');</script>)
+    end
+
+    # Compact pagination for bootstrap: it returns the html with the series of links to the pages
+    # we use a numeric input tag to set the page and the PagyCompact javascript to navigate
+    def pagy_nav_bootstrap_compact(pagy, id=caller(1,1)[0].hash)
+      tags = ''; link = pagy_link_proc(pagy, 'class="btn btn-primary"')
+
+      tags << %(<nav id="pagy-nav-#{id}" class="pagy-nav-bootstrap-compact pagination" role="navigation" aria-label="pager">)
+
+        tags << link.call(MARKER, '', %(style="display: none;" ))
+
+        tags << %(<div class="btn-group" role="group">)
+        tags << (pagy.prev ? link.call(pagy.prev, pagy_t('pagy.nav.prev'.freeze), 'aria-label="previous"'.freeze)
+                           : %(<a class="btn btn-primary disabled" href="#">#{pagy_t('pagy.nav.prev'.freeze)}</a>))
+
+        input = %(<input type="number" min="1" max="#{pagy.last}" value="#{pagy.page}" style="padding: 0; border: none; text-align: center; width: #{pagy.pages.to_s.length+1}rem;">)
+        tags << %(<button type="button" class="pagy-compact-input btn btn-primary disabled">#{pagy_t('pagy.compact.page'.freeze)} #{input} #{pagy_t('pagy.compact.of'.freeze)} #{pagy.pages}</button>)
+
+        tags << (pagy.next ? link.call(pagy.next, pagy_t('pagy.nav.next'.freeze), 'aria-label="next"'.freeze)
+                           : %(<a class="btn btn-primary disabled" href="#">#{pagy_t('pagy.nav.next'.freeze)}</a>))
+
+      tags << %(</div></nav><script>PagyCompact('#{id}', '#{MARKER}', '#{pagy.page}');</script>)
+    end
+
+  end
+end
+

data/lib/pagy-extras/responsive.rb

@@ -0,0 +1,60 @@
+# See the Pagy Extras documentation: https://ddnexus.github.io/pagy/pagy-extras
+
+require 'json'
+
+class Pagy
+
+  VARS[:breakpoints] = { 0 => [1,4,4,1] }
+
+  def responsive
+    @responsive ||= {items: [], series: {}, widths:[]}.tap do |r|
+      @vars[:breakpoints].key?(0) || raise(ArgumentError, "expected :breakpoints to contain the 0 size; got #{@vars[:breakpoint].inspect}")
+      @vars[:breakpoints].each {|width, size| r[:items] |= r[:series][width] = series(size)}
+      r[:widths] = r[:series].keys.sort!{|a,b| b <=> a}
+    end
+  end
+
+
+  module Frontend
+
+    # Generic responsive pagination: it returns the html with the series of links to the pages
+    # we build the tags as a json object string and render them with the PagyResponsive javascript
+    def pagy_nav_responsive(pagy, id=caller(1,1)[0].hash)
+      tags = '{'; link = pagy_link_proc(pagy); responsive = pagy.responsive
+
+      tags << (pagy.prev ? %('prev':'<span class="page prev">#{link.call pagy.prev, pagy_t('pagy.nav.prev'.freeze), 'aria-label="previous"'.freeze}</span> ',)
+                         : %('prev':'<span class="page prev disabled">#{pagy_t('pagy.nav.prev'.freeze)}</span> ',))
+      responsive[:items].each do |item|  # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+        tags << if    item.is_a?(Integer); %('#{item}':'<span class="page">#{link.call item}</span> ',)                    # page link
+                elsif item.is_a?(String) ; %('#{item}':'<span class="page active">#{item}</span> ',)                       # current page
+                elsif item == :gap       ; %('#{item}':'<span class="page gap">#{pagy_t('pagy.nav.gap'.freeze)}</span> ',) # page gap
+                end
+      end
+      tags << (pagy.next ? %('next':'<span class="page next">#{link.call pagy.next, pagy_t('pagy.nav.next'.freeze), 'aria-label="next"'.freeze}</span>'})
+                         : %('next':'<span class="page next disabled">#{pagy_t('pagy.nav.next'.freeze)}</span>'}))
+      script = %(<script>PagyResponsive('#{id}', #{tags}, #{responsive[:widths].to_json}, #{responsive[:series].to_json});</script>)
+      %(<nav id="pagy-nav-#{id}" class="pagy-nav-responsive pagination" role="navigation" aria-label="pager"></nav>#{script})
+    end
+
+
+    # Responsive pagination for bootstrap: it returns the html with the series of links to the pages
+    # we build the tags as a json object string and render them with the PagyResponsive javascript
+    def pagy_nav_bootstrap_responsive(pagy, id=caller(1,1)[0].hash)
+      tags = '{'; link = pagy_link_proc(pagy, 'class="page-link"'.freeze); responsive = pagy.responsive
+
+      tags << (pagy.prev ? %('prev':'<li class="page-item prev">#{link.call pagy.prev, pagy_t('pagy.nav.prev'.freeze), 'aria-label="previous"'.freeze}</li>',)
+                         : %('prev':'<li class="page-item prev disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.prev'.freeze)}</a></li>',))
+      responsive[:items].each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+        tags << if    item.is_a?(Integer); %('#{item}':'<li class="page-item">#{link.call item}</li>',)                                                               # page link
+                elsif item.is_a?(String) ; %('#{item}':'<li class="page-item active">#{link.call item}</li>',)                                                        # active page
+                elsif item == :gap       ; %('#{item}':'<li class="page-item gap disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.gap'.freeze)}</a></li>',) # page gap
+                end
+      end
+      tags << (pagy.next ? %('next':'<li class="page-item next">#{link.call pagy.next, pagy_t('pagy.nav.next'.freeze), 'aria-label="next"'.freeze}</li>'})
+                         : %('next':'<li class="page-item next disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.next'.freeze)}</a></li>'}))
+      script = %(<script>PagyResponsive('#{id}', #{tags}, #{responsive[:widths].to_json}, #{responsive[:series].to_json});</script>)
+      %(<nav id="pagy-nav-#{id}" class="pagy-nav-bootstrap-responsive pagination" role="navigation" aria-label="pager"><ul class="pagination"></ul></nav>#{script})
+    end
+
+  end
+end

data/lib/templates/nav_bootstrap.html.erb

@@ -0,0 +1,24 @@
+<%#
+  This template is i18n-ready: if you don't use i18n, then you can replace the pagy_t
+  calls with the actual strings ("&lsaquo; Prev", "Next &rsaquo;", "&hellip;").
+
+  The link variable is set to a proc that returns the link tag.
+  Usage: link.call( page_number [, text [, extra_attributes_string ]])
+-%>
+<% link = pagy_link_proc(pagy, 'class="page-link"') -%>
+<%#                            -%><nav aria-label="pager"  class="pagy-nav-bootstrap pagination" role="navigation">
+<%#                            -%>  <ul class="pagination">
+<% if pagy.prev                -%>    <li class="page-item prev"><%== link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"') %></li>
+<% else                        -%>    <li class="page-item prev disabled"><a href="#" class="page-link"><%== pagy_t('pagy.nav.prev') %></a></li>
+<% end                         -%>
+<% pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36] -%>
+<%   if    item.is_a?(Integer) -%>    <li class="page-item"><%== link.call(item) %></li>
+<%   elsif item.is_a?(String)  -%>    <li class="page-item active"><%== link.call(item) %></li>
+<%   elsif item == :gap        -%>    <li class="page-item disabled gap"><a href="#" class="page-link"><%== pagy_t('pagy.nav.gap') %></a></li>
+<%   end                       -%>
+<% end                         -%>
+<% if pagy.next                -%>    <li class="page-item next"><%== link.call(pagy.next, pagy_t('pagy.nav.next'), 'aria-label="next"') %></li>
+<% else                        -%>    <li class="page-item next disabled"><a href="#" class="page-link"><%== pagy_t('pagy.nav.next') %></a></li>
+<% end                         -%>
+<%#                            -%>  </ul>
+<%#                            -%></nav>

data/lib/templates/nav_bootstrap.html.haml

@@ -0,0 +1,34 @@
+-# This template is i18n-ready: if you don't use i18n, then you can replace the pagy_t
+-# calls with the actual strings ("‹ Prev", "Next ›", "…").
+
+-# The link variable is set to a proc that returns the link tag.
+-# Usage: link.call( page_number [, text [, extra_attributes_string ]])
+
+- link = pagy_link_proc(pagy, 'class="page-link"')
+
+%nav.pagy-nav-bootstrap.pagination{"aria-label" => "pager", :role => "navigation"}
+
+  %ul.pagination
+
+    - if pagy.prev
+      %li.page-item.prev!= link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"')
+    - else
+      %li.page-item.prev.disabled
+        %a.page-link{:href => '#'}!= pagy_t('pagy.nav.prev')
+
+    - pagy.series.each do |item|                      # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+      - if item.is_a?(Integer)                        # page link
+        %li.page-item!= link.call(item)
+
+      - elsif item.is_a?(String)                      # current page
+        %li.page-item.active!= link.call(item)
+
+      - elsif item == :gap                            # page gap
+        %li.page-item.disabled.gap
+          %a.page-link{:href => "#"}!= pagy_t('pagy.nav.gap')
+
+    - if pagy.next
+      %li.page-item.next!= link.call(pagy.next, pagy_t('pagy.nav.next'), 'aria-label="next"')
+    - else
+      %li.page-item.next.disabled
+        %a.page-link{:href => '#'}!= pagy_t('pagy.nav.next')

data/lib/templates/nav_bootstrap.html.slim

@@ -0,0 +1,34 @@
+/ This template is i18n-ready: if you don't use i18n, then you can replace the pagy_t
+/ calls with the actual strings ("‹ Prev", "Next ›", "…").
+
+/ The link variable is set to a proc that returns the link tag.
+/ Usage: link.call( page_number [, text [, extra_attributes_string ]])
+
+- link = pagy_link_proc(pagy, 'class="page-link"')
+
+nav.pagy-nav-bootstrap.pagination role="navigation" aria-label="pager"
+
+  ul.pagination
+
+    - if pagy.prev
+      li.page-item.prev == link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"')
+    - else
+      li.page-item.prev.disabled
+        a.page-link href="#" == pagy_t('pagy.nav.prev')
+
+    - pagy.series.each do |item|                 # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+      - if item.is_a?(Integer)                   # page link
+        li.page-item == link.call(item)
+
+      - elsif item.is_a?(String)                 # current page
+        li.page-item.active == link.call(item)
+
+      - elsif item == :gap                       # page gap
+        li.page-item.disabled.gap
+          a.page-link href="#" == pagy_t('pagy.nav.gap')
+
+    - if pagy.next
+      li.page-item.next == link.call(pagy.next, pagy_t('pagy.nav.next'), 'aria-label="next"')
+    - else
+      li.page-item.next.disabled
+        a.page-link href="#" == pagy_t('pagy.nav.next')

data/pagy-extras.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name          = 'pagy-extras'
+  s.version       = '0.1.0'
+  s.authors       = ['Domizio Demichelis']
+  s.email         = ['dd.nexus@gmail.com']
+  s.date          = Date.today.to_s
+
+  s.summary       = 'Pagy extra features'
+  s.description   = 'Pagy extra features: bootstrap, responsive, compact, ...'
+  s.homepage      = 'https://github.com/ddnexus/pagy-extras'
+  s.license       = 'MIT'
+  s.require_paths = ['lib']
+
+  s.files         = `git ls-files -z`.split("\x0").select{|f| f.start_with?('lib', 'pagy-extras.gemspec', 'LICENSE') }
+
+
+  s.add_dependency 'pagy', '~> 0.6.0'
+
+  s.add_development_dependency 'bundler',  '~> 1.16'
+  s.add_development_dependency 'rake',     '~> 10.0'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: pagy-extras
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Domizio Demichelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 'Pagy extra features: bootstrap, responsive, compact, ...'
+email:
+- dd.nexus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/javascripts/pagy-compact.js
+- lib/javascripts/pagy-responsive.js
+- lib/pagy-extras.rb
+- lib/pagy-extras/bootstrap.rb
+- lib/pagy-extras/compact.rb
+- lib/pagy-extras/responsive.rb
+- lib/templates/nav_bootstrap.html.erb
+- lib/templates/nav_bootstrap.html.haml
+- lib/templates/nav_bootstrap.html.slim
+- pagy-extras.gemspec
+homepage: https://github.com/ddnexus/pagy-extras
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Pagy extra features
+test_files: []