pagy 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a984f9eb44e5f2d637f92e5b5317edbff0691c2b2d4e89d8bf02f2e1a11939b8
-  data.tar.gz: 01dc6a1f9ca9bba43400f00a645a47c02cf4aa11868705193a9b4c33a50e1811
+  metadata.gz: c1f0144a6fd3d7656796cc0811c275402fa66db024bd9dfd08a2f76853b33b3d
+  data.tar.gz: '09ea67fbafb73195fd9efe1470860884f317800c455a40150ce533b2b1a74574'
 SHA512:
-  metadata.gz: b2ed0782436c442bb3127598cb1f8b8aaeb7afaf373836933e61a93b834bc91125a1f44fb34fad18b362a989c59b2c1ba3683483cf2098b36657be75420f3fc3
-  data.tar.gz: e7399e4568cf8fbfa537a4a193c928d0810ce47ea4d5c877765d5669d077618e7ab1e715d9892c7bf51e8e827a06b897afef12d417c2994f7be6f65c69cd7fe1
+  metadata.gz: 50ce6bb16a1ac0cb961cdbabcdf41065fdecdbccc4d6293b18fd345e34ffba60fd40a1855f4e77036420c46be848d6c4ae614a351418549854cefc51fab63ee7
+  data.tar.gz: 56f0b36c864d625775bf39ed574ea1996d1bb608a918ba57ef46082b8ae10fc927588fda1955e8b129a68fd97089a32ff3f47ce1abce202a7f037d6710a0b300

data/lib/locales/pagy.yml

@@ -16,3 +16,6 @@ en:
         zero: "items"
         one: "item"
         other: "items"
+    compact:
+      page: Page
+      of: of

data/lib/pagy.rb

@@ -2,7 +2,7 @@
 
 require 'pathname'
 
-class Pagy ; VERSION = '0.5.0'
+class Pagy ; VERSION = '0.6.0'
 
   autoload :Backend,  'pagy/backend'
   autoload :Frontend, 'pagy/frontend'
@@ -13,7 +13,7 @@ class Pagy ; VERSION = '0.5.0'
   def self.root; Pathname.new(__FILE__).dirname end
 
   # default core vars
-  VARS = { items:20, outset:0, initial:1, before:4, after:4, final:1 }
+  VARS = { items:20, outset:0, size:[1,4,4,1] }
 
   # default I18n vars
   I18N = { file: Pagy.root.join('locales', 'pagy.yml').to_s, plurals: -> (c) {c==0 && 'zero' || c==1 && 'one' || 'other'} }
@@ -23,11 +23,11 @@ class Pagy ; VERSION = '0.5.0'
 
   # merge and validate the options, do some simple aritmetic and set the instance variables
   def initialize(vars)
-    @vars        = VARS.merge(vars)                                       # default vars + instance vars
+    @vars = VARS.merge(vars)                                              # default vars + instance vars
     @vars[:page] = (@vars[:page]||1).to_i                                 # set page to 1 if nil
-    {count:0, items:1, outset:0, initial:0, before:0, page:1, after:0, final:0}.each do |k,min|
+    { count:0, items:1, outset:0, page:1 }.each do |k,min|                # validate core variables
       @vars[k] >= min rescue nil || raise(ArgumentError, "expected :#{k} >= #{min}; got #{@vars[k].inspect}")
-      instance_variable_set(:"@#{k}", @vars.delete(k))                    # set all the core variables
+      instance_variable_set(:"@#{k}", @vars.delete(k))                    # set instance variables
     end
     @pages  = @last = [(@count.to_f / @items).ceil, 1].max                # cardinal and ordinal meanings
     (1..@last).cover?(@page) || raise(OutOfRangeError, "expected :page in 1..#{@last}; got #{@page.inspect}")
@@ -40,18 +40,17 @@ class Pagy ; VERSION = '0.5.0'
   end
 
   # return the array of page numbers and :gap items e.g. [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
-  def series
-    @series ||= [].tap do |series|
-      [*0..@initial, *@page-@before..@page+@after, *@last-@final+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
-        elsif a+2 == b; series.push(a, a+1)                               # 1 page gap -> fill with missing page
-        else            series.push(a, :gap)                              # n page gap -> add :gap
-        end                                                               # skip the end boundary (last+1)
-      end
-      series.shift                                                        # remove the start boundary (0)
-      series[series.index(@page)] = @page.to_s                            # convert the current page to String
-    end
+  def series(size=@vars[:size])
+    (0..3).each{|i| size[i]>=0 rescue nil || raise(ArgumentError, "expected 4 items in :size >= 0; 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
+      elsif a+2 == b; series.push(a, a+1)                                 # 1 page gap -> fill with missing page
+      else            series.push(a, :gap)                                # n page gap -> add :gap
+      end                                                                 # skip the end boundary (last+1)
+    end                                                                   # shift the start boundary (0) and
+    series.tap{|s| s.shift; s[s.index(@page)] = @page.to_s}               # convert the current page to String
   end
 
 end

data/lib/pagy/frontend.rb

@@ -1,7 +1,5 @@
 # See Pagy::Frontend API documentation: https://ddnexus.github.io/pagy/api/frontend
 
-# this file will get autoloaded, so environment constants like ::I18n will be already set
-require 'yaml'
 class Pagy
 
   # All the code here has been optimized for performance: it may not look very pretty
@@ -10,37 +8,19 @@ class Pagy
 
     # Generic pagination: it returns the html with the series of links to the pages
     def pagy_nav(pagy)
-      tags = []; link = pagy_link_proc(pagy)
+      tags = ''; link = pagy_link_proc(pagy)
 
-      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>))
+      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> ))
       pagy.series.each do |item|  # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
-        tags << 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'.freeze)}</span>) # page gap
+        tags << 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'.freeze)}</span> ) # page gap
                 end
       end
       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>))
-      %(<nav class="pagination" role="navigation" aria-label="pager">#{tags.join(' '.freeze)}</nav>)
-    end
-
-
-    # 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="pagination" role="navigation" aria-label="pager"><ul class="pagination">#{tags.join}</ul></nav>)
+      %(<nav class="pagy-nav pagination" role="navigation" aria-label="pager">#{tags}</nav>)
     end
 
 
@@ -77,10 +57,12 @@ class Pagy
 
 
     # define #pagy_t depending on I18N[:gem] and I18n
+    # this file will get autoloaded, so environment constants like ::I18n will be already set
     if I18N[:gem] || I18N[:gem].nil? && defined?(I18n)
       I18n.load_path << I18N[:file]
-      def pagy_t(*a); I18n.t(*a) end
+      def pagy_t(*a) I18n.t(*a) end
     else
+      require 'yaml'
       # load data from the first locale in the file
       I18N_DATA = YAML.load_file(I18N[:file]).first[1].freeze
       # Similar to I18n.t for interpolation and pluralization but without translation

data/lib/templates/nav.html.erb

@@ -6,7 +6,7 @@
   Usage: link.call( page_number [, text [, extra_attributes_string ]])
 -%>
 <% link = pagy_link_proc(pagy) -%>
-<%#                            -%><nav aria-label="pager" class="pagination" role="navigation">
+<%#                            -%><nav aria-label="pager" class="pagy_nav agination" role="navigation">
 <% if pagy.prev                -%>  <span class="page prev"><%== link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"') %></span>
 <% else                        -%>  <span class="page prev disabled"><%== pagy_t('pagy.nav.prev') %></span>
 <% end                         -%>

data/lib/templates/nav.html.haml

@@ -6,7 +6,7 @@
 
 - link = pagy_link_proc(pagy)
 
-%nav.pagination{"aria-label" => "pager", :role => "navigation"}
+%nav.pagy_nav.pagination{"aria-label" => "pager", :role => "navigation"}
 
   - if pagy.prev
     %span.page.prev!= link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"')

data/lib/templates/nav.html.slim

@@ -6,7 +6,7 @@
 
 - link = pagy_link_proc(pagy)
 
-nav.pagination role="navigation" aria-label="pager"
+nav.pagy_nav.pagination role="navigation" aria-label="pager"
 
   - if pagy.prev
     span.page.prev ==> link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"')

data/pagy.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.license       = 'MIT'
   s.require_paths = ['lib']
 
-  s.files         = `git ls-files -z`.split("\x0").select{|f| f.start_with?('lib', 'pagy.gemspec', 'LICENSE', 'README', 'images') }
+  s.files         = `git ls-files -z`.split("\x0").select{|f| f.start_with?('lib', 'pagy.gemspec', 'LICENSE') }
 
 
   s.add_development_dependency 'bundler',  '~> 1.16'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2018-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,11 +133,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
-- README.md
-- images/efficiency-table.png
-- images/ips-chart.png
-- images/memory-chart.png
-- images/objects-chart.png
 - lib/locales/pagy.yml
 - lib/pagy.rb
 - lib/pagy/backend.rb
@@ -145,9 +140,6 @@ files:
 - lib/templates/nav.html.erb
 - lib/templates/nav.html.haml
 - lib/templates/nav.html.slim
-- lib/templates/nav_bootstrap.html.erb
-- lib/templates/nav_bootstrap.html.haml
-- lib/templates/nav_bootstrap.html.slim
 - pagy.gemspec
 homepage: https://github.com/ddnexus/pagy
 licenses:

data/README.md

@@ -1,93 +0,0 @@
-# Pagy
-
-Pagy is the ultimate pagination gem that outperforms the others in each and every benchmark and comparison. 
-
-### Benchmarks
-
-The best way to quickly get an idea about its features is comparing it to the other well known gems.
-
-The values shown in the charts below have been recorded while each gem was producing the exact same output: same environment conditions, same task, just different gems _(see the complete [Gems Comparison](http://ddnexus.github.io/pagination-comparison/gems.html))_
-
-#### Pagy is a lot faster
-
-![IPS Chart](images/ips-chart.png)
-
-#### Pagy uses a lot less memory
-
-![Memory Chart](images/memory-chart.png)
-
-#### Pagy is a lot simpler
-
-![Objects Chart](images/objects-chart.png)
-
-#### Pagy is a lot more efficient
-
-![Efficiency Table](images/efficiency-table.png)
-
-_The [IPS/Kb ratio](http://ddnexus.github.io/pagination-comparison/gems.html#efficiency-ratio) is calculated out of speed (IPS) and Memory (Kb): it shows how well each gem uses any Kb of memory it allocates/consumes._ 
-
-#### Pagy does not suffer the typical limitations of the other gems:
-
-- it works with collections/scopes that already used `limit` and `offset`
-- it works with both helpers or templates (your choice)
-- it raises real `Pagy::OutOfRangeError` exceptions that you can rescue from
-- it does not impose any difficult-to-override logic or output
-
-### Features
-
-#### Straightforward code
-
-- Pagy is just ~120 lines of simple ruby, organized in 3 flat modules very easy to understand and use
-- it produces its own HTML, URLs, pluralization and interpolation with its own specialized and fast code
-- 100% of its methods are public API, accessible and overridable **right where you use them** (no need of monkey patching or subclassing)
-
-#### Totally agnostic
-
-- it doesn't need to know anything about your models, ORM or Storage, so it doesn't add any code to them
-- it works with all kind of collections, even pre-paginated, records, Arrays, JSON data... and just whatever you can count
-- it works with all Rack frameworks (Rails, Sinatra, Padrino, ecc.) out of the box 
-- it works with any possible non-Rack envoronment by just overriding one or two one-liner methods
-
-#### Simple Usage
-
-You can use pagy in a quite familiar way: 
-
-Paginate your collection in some controller:
-
-```ruby
-@pagy, @records = pagy(Product.some_scope)
-```
-
-Render the navigation links with a super-fast helper in some view:
-
-```HTML+ERB
-<%= pagy_nav(@pagy) %>
-```
-
-Or - if you prefer - render the navigation links with a template:
-
-```HTML+ERB
-<%= render 'pagy/nav', locals: {pagy: @pagy} %>
-```
-
-## Support, Comments and Feature Requests
-
-[![Join the chat at https://gitter.im/ruby-pagy/Lobby](https://badges.gitter.im/ruby-pagy/Lobby.svg)](https://gitter.im/ruby-pagy/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
-## Useful Links
-
-- [Documentation](https://ddnexus.github.io/pagy/index)
-- [Pagination Comparison App](http://github.com/ddnexus/pagination-comparison)
-
-## Help Wanted
-
-Pagy is a fresh project and your help would be great. If you like it, you have a few options to contribute:
-
-- write a tutorial or a post or even just a tweet (pagy is young and needs to be known)
-- write a "How To" topic (the documentation is covering the basics and there is a lot of space for additions)
-- submit a pull request to make pagy even faster, save more memory or improve its usability
-- create an issue if anything should be improved/fixed
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/templates/nav_bootstrap.html.erb

@@ -1,24 +0,0 @@
-<%#
-  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="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

@@ -1,34 +0,0 @@
--# 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.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

@@ -1,34 +0,0 @@
-/ 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.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')