pagy 4.7.1 → 4.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67bf0b9d4c13c5ca1e0698f6e4fd928e07eaad4fd3e8dfe2ef8d95612e5eb8d9
-  data.tar.gz: 40fae4aadf56256885e813847a0df296bb857ea48ed629a49d6fd20092fe4dbf
+  metadata.gz: dfababb2b5f9594ebcf7827cde7c45e9073ba9a270ddca251714e0d8fa1ef711
+  data.tar.gz: b20c84d4099a7302d6324fa671001051275d01d363eff5b6007d4240b1700d8a
 SHA512:
-  metadata.gz: c2408b52d3e5cf97ea5d32cc2da809f2e9e38802767555b3ecd94a7947d9e52adf45e623c992acf2c1a12dcacf081f01823bc0e59fd97a6c980d68d08af1b8ea
-  data.tar.gz: d0ffa69cc1cff5e0d5eb767e77d8abe63fe1df47f19c6535677c481c87ea3bd0fdc81042571fb02b3015b72377d9a7b9aa738bce0353d8e8ec62120608927ffe
+  metadata.gz: ba6eadeb0285c6dcf1ae98dfe58fe8844916f3d517813fbc8add6b5b0e0d3933234e26eb15c9fa931c7fccd256844df26d72694f23a3596fa874c3288a4fd4aa
+  data.tar.gz: 35d1b022f3d4c85521e69b960be16812c5ffe276e1a015e6fa9ce1630f1abf05486908568585dcd0257fee4d2fb304fe6296839404a9091e54a3c6fa10d0068b

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017-2020 Domizio Demichelis
+Copyright (c) 2017-2021 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

data/lib/config/pagy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Pagy initializer file (4.7.1)
+# Pagy initializer file (4.10.1)
 # Customize only what you really need and notice that Pagy works also without any of the following lines.
 # Should you just cherry pick part of this file, please maintain the require-order of the extras
 

data/lib/javascripts/pagy.js

@@ -2,7 +2,7 @@
 
 function Pagy(){}
 
-Pagy.version = '4.7.1'
+Pagy.version = '4.10.1'
 
 Pagy.delay = 100
 

data/lib/locales/ar.yml

@@ -0,0 +1,26 @@
+# :arabic pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
+ar:
+  pagy:
+
+    item_name:
+      zero: "صفر"
+      one: "عنصر"
+      two: "عنصرين"
+      few: "قليل"
+      many: "كثير"
+      other: "عناصر"
+
+    nav:
+      prev: "‹ السابق"
+      next: "التالي ›"
+      gap: "…"
+
+    info:
+      no_items: "لا يوجد %{item_name}"
+      single_page: "عرض <b>%{count}</b> %{item_name}"
+      multiple_pages: "عرض %{item_name} <b>%{from}-%{to}</b> من اجمالي <b>%{count}</b>"
+
+    combo_nav_js: "الصفحة %{page_input} من %{pages}"
+
+    items_selector_js: "عرض %{items_input} %{item_name} لكل صفحة"

data/lib/locales/utils/p11n.rb

@@ -19,6 +19,20 @@ from12to14 = [12,13,14].freeze
 p11n = {
   one_other: -> (n){ n == 1 ? 'one' : 'other' },    # default
 
+  arabic: lambda do |n|
+    n ||= 0
+    mod100 = n % 100
+
+    case
+    when n == 0                         then 'zero'      # rubocop:disable Style/NumericPredicate
+    when n == 1                         then 'one'
+    when n == 2                         then 'two'
+    when (3..10).to_a.include?(mod100)  then 'few'
+    when (11..99).to_a.include?(mod100) then 'many'
+    else                                     'other'
+    end
+  end,
+
   east_slavic: lambda do |n|
     n ||= 0
     mod10 = n % 10
@@ -32,14 +46,6 @@ p11n = {
     end
   end,
 
-  west_slavic: lambda do |n|
-    case n
-    when 1       then 'one'
-    when 2, 3, 4 then 'few'
-    else              'other'
-    end
-  end,
-
   one_two_other: lambda do |n|
     case n
     when 1 then 'one'
@@ -63,7 +69,16 @@ p11n = {
     when (from0to1 + from5to9).include?(mod10) || from12to14.include?(mod100) then 'many'
     else                                                                           'other'
     end
+  end,
+
+  west_slavic: lambda do |n|
+    case n
+    when 1       then 'one'
+    when 2, 3, 4 then 'few'
+    else              'other'
+    end
   end
+
 }
 
 # Hash of locale/pluralization pairs
@@ -71,6 +86,7 @@ p11n = {
 # The default pluralization for locales not explicitly listed here
 # is the :one_other pluralization proc (used for English)
 plurals = Hash.new(p11n[:one_other]).tap do |hash|
+  hash['ar']    = p11n[:arabic]
   hash['bs']    = p11n[:east_slavic]
   hash['cs']    = p11n[:west_slavic]
   hash['id']    = p11n[:other]

data/lib/pagy.rb

@@ -5,7 +5,7 @@ require 'pathname'
 
 # main class
 class Pagy
-  VERSION = '4.7.1'
+  VERSION = '4.10.1'
 
   # Root pathname to get the path of Pagy files like templates or dictionaries
   def self.root
@@ -23,7 +23,7 @@ class Pagy
   # Merge and validate the options, do some simple arithmetic and set the instance variables
   def initialize(vars)
     @vars = VARS.merge( vars.delete_if{|k,v| VARS.key?(k) && (v.nil? || v == '') } )
-    @vars[:fragment] = deprecated_var(:anchor, @vars[:anchor], :fragment, @vars[:fragment]) if @vars[:anchor]
+    @vars[:fragment] = Pagy.deprecated_var(:anchor, @vars[:anchor], :fragment, @vars[:fragment]) if @vars[:anchor]
 
     INSTANCE_VARS_MIN.each do |name,min|
       raise VariableError.new(self), "expected :#{name} >= #{min}; got #{@vars[name].inspect}" \

data/lib/pagy/deprecation.rb

@@ -4,22 +4,22 @@ class Pagy
 
     # deprecated variables
     def deprecated_var(var, val, new_var, new_val)
-      value = new_val || val
-      Warning.warn %([PAGY WARNING] deprecated use of `#{var}` var will not be supported in 5.0! Use `#{new_var}: #{value.inspect}` instead.)
+      value = val || new_val
+      Warning.warn %([PAGY WARNING] deprecated use of '#{var}' var will not be supported in 5.0! Use '#{new_var}: #{value.inspect}' instead.)
       value
     end
 
     # deprecated pagy_url_for argument order
     def deprecated_order(pagy, page)
-      Warning.warn '[PAGY WARNING] inverted use of pagy/page in pagy_url_for will not be supported in 5.0! Use pagy_url_for(pagy, page) instead.'
+      Warning.warn %([PAGY WARNING] inverted use of pagy/page in pagy_url_for will not be supported in 5.0! Use pagy_url_for(pagy, page) instead.)
       [page, pagy]
     end
 
 
     # deprecated posiitioal arguments
     def deprecated_arg(arg, val, new_key, new_val)
-      value = new_val || val  # we use the new_val if present
-      Warning.warn %([PAGY WARNING] deprecated use of positional `#{arg}` arg will not be supported in 5.0! Use only the keyword arg `#{new_key}: #{value.inspect}` instead.)
+      value = val || new_val  # we use the new_val if present
+      Warning.warn %([PAGY WARNING] deprecated use of positional '#{arg}' arg will not be supported in 5.0! Use only the keyword arg '#{new_key}: #{value.inspect}' instead.)
       value
     end
 

data/lib/pagy/exceptions.rb

@@ -16,7 +16,9 @@ class Pagy
       Regexp.last_match(1)&.to_sym
     end
 
-    def value = pagy.vars[variable]
+    def value
+      pagy.vars[variable]
+    end
   end
 
   # specific overflow error

data/lib/pagy/extras/bulma.rb

@@ -66,7 +66,7 @@ class Pagy
     private
 
       def pagy_bulma_prev_next_html(pagy, link)
-        html  = if (p_prev = pagy.prev)
+        html  = +if (p_prev = pagy.prev)
                   link.call p_prev, pagy_t('pagy.nav.prev'), 'class="pagination-previous" aria-label="previous page"'
                 else
                   %(<a class="pagination-previous" disabled>#{pagy_t 'pagy.nav.prev'}</a>)

data/lib/pagy/extras/headers.rb

@@ -25,10 +25,10 @@ class Pagy
       rels = { 'first' => 1, 'prev' => pagy.prev, 'next' => pagy.next }
       rels['last'] = pagy.last unless countless
       url_str = pagy_url_for(pagy, PAGE_PLACEHOLDER, absolute: true)
-      hash    = { 'Link' => rels.filter_map do |rel, num|
+      hash    = { 'Link' => rels.map do |rel, num| # filter_map if ruby >=2.7
                               next unless num
                               [ rel, url_str.sub(PAGE_PLACEHOLDER, num.to_s) ]
-                            end.to_h }
+                            end.compact.to_h }
       headers = pagy.vars[:headers]
       hash[headers[:page]]  = pagy.page.to_s         if headers[:page]
       hash[headers[:items]] = pagy.vars[:items].to_s if headers[:items]

data/lib/pagy/extras/i18n.rb

@@ -14,7 +14,9 @@ class Pagy
     end
 
     module UseI18nGem
-      def pagy_t(key, **opts) = ::I18n.t(key, **opts)
+      def pagy_t(key, **opts)
+        ::I18n.t(key, **opts)
+      end
     end
     prepend UseI18nGem
 

data/lib/pagy/extras/items.rb

@@ -40,7 +40,7 @@ class Pagy
       link           = pagy_marked_link(pagy_link_proc(pagy, link_extra: link_extra))
       p_vars[:items] = p_items # restore the items
 
-      html  = %(<span#{p_id} class="pagy-items-selector-js" #{pagy_json_attr pagy, :items_selector, pagy.from, link}>)
+      html  = +%(<span#{p_id} class="pagy-items-selector-js" #{pagy_json_attr pagy, :items_selector, pagy.from, link}>)
       input = %(<input type="number" min="1" max="#{p_vars[:max_items]}" value="#{p_items}" style="padding: 0; text-align: center; width: #{p_items.to_s.length+1}rem;">)
       html << pagy_t('pagy.items_selector_js', item_name:   item_name || pagy_t(i18n_key || p_vars[:i18n_key], count: p_items),
                                                items_input: input,

data/lib/pagy/extras/meilisearch.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+class Pagy
+
+  VARS[:meilisearch_search_method] ||= :pagy_search
+
+  module Meilisearch
+    # returns an array used to delay the call of #search
+    # after the pagination variables are merged to the options
+    def pagy_meilisearch(term = nil, **vars)
+      [self, term, vars]
+    end
+    alias_method VARS[:meilisearch_search_method], :pagy_meilisearch
+  end
+
+  # create a Pagy object from a Meilisearch results
+  def self.new_from_meilisearch(results, vars={})
+    vars[:items] = results.raw_answer['limit']
+    vars[:page]  = [results.raw_answer['offset'] / vars[:items], 1].max
+    vars[:count] = results.raw_answer['nbHits']
+    new(vars)
+  end
+
+  # Add specialized backend methods to paginate Meilisearch results
+  module Backend
+    private
+
+    # Return Pagy object and results
+    def pagy_meilisearch(pagy_search_args, vars = {})
+      model, term, options = pagy_search_args
+      vars             = pagy_meilisearch_get_vars(nil, vars)
+      options[:limit]  = vars[:items]
+      options[:offset] = (vars[:page] - 1) * vars[:items]
+      results          = model.search(term, **options)
+      vars[:count]     = results.raw_answer['nbHits']
+
+      pagy = Pagy.new(vars)
+      # with :last_page overflow we need to re-run the method in order to get the hits
+      return pagy_meilisearch(pagy_search_args, vars.merge(page: pagy.page)) \
+        if defined?(Pagy::UseOverflowExtra) && pagy.overflow? && pagy.vars[:overflow] == :last_page
+
+      [ pagy, results ]
+    end
+
+    # Sub-method called only by #pagy_meilisearch: here for easy customization of variables by overriding
+    # the _collection argument is not available when the method is called
+    def pagy_meilisearch_get_vars(_collection, vars)
+      pagy_set_items_from_params(vars) if defined?(UseItemsExtra)
+      vars[:items] ||= VARS[:items]
+      vars[:page]  ||= (params[ vars[:page_param] || VARS[:page_param] ] || 1).to_i
+      vars
+    end
+
+  end
+end

data/lib/pagy/extras/overflow.rb

@@ -6,7 +6,9 @@ class Pagy
   module UseOverflowExtra
     VARS[:overflow] = :empty_page
 
-    def overflow? = @overflow
+    def overflow?
+      @overflow
+    end
 
     def initialize(vars)
       @overflow ||= false                         # don't override if :last_page re-run the method after an overflow

data/lib/pagy/extras/standalone.rb

@@ -46,7 +46,11 @@ class Pagy
       "#{url_string}#{query_string}#{p_vars[:fragment]}"
     end
   end
-  Helpers.prepend UseStandaloneExtra
+
+  #  single line in order to avoid complicating simplecov already tested with other GitHub Actions
+  Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0') \
+      && Helpers.prepend(UseStandaloneExtra) \
+      || ( Frontend.prepend(UseStandaloneExtra); Backend.prepend(UseStandaloneExtra) if defined?(Pagy::Backend::METADATA) ) # rubocop:disable Style/Semicolon
 
   # defines a dummy #params method if not already defined in the including module
   module Backend

data/lib/pagy/extras/trim.rb

@@ -12,7 +12,7 @@ class Pagy
       link_proc = super(pagy, link_extra: link_extra)
       return link_proc unless pagy.vars[:enable_trim_extra]
       lambda do |num, text=num, extra=''|
-        link = link_proc.call(num, text, extra)
+        link = +link_proc.call(num, text, extra)
         return link unless num == 1
         link.sub!(/[?&]#{pagy.vars[:page_param]}=1\b(?!&)|\b#{pagy.vars[:page_param]}=1&/, '')
       end

data/lib/pagy/extras/uikit.rb

@@ -11,7 +11,7 @@ class Pagy
       p_id = %( id="#{pagy_id}") if pagy_id
       link = pagy_link_proc(pagy, link_extra: link_extra)
 
-      html = %(<ul#{p_id} class="pagy-uikit-nav uk-pagination uk-flex-center">#{pagy_uikit_prev_html pagy, link})
+      html = +%(<ul#{p_id} class="pagy-uikit-nav uk-pagination uk-flex-center">#{pagy_uikit_prev_html pagy, link})
       pagy.series.each do |item|
         html << case    item
                 when Integer then %(<li>#{link.call item}</li>)

data/lib/pagy/frontend.rb

@@ -25,7 +25,9 @@ class Pagy
     end
 
     # Sub-method called only by #pagy_url_for: here for easy customization of params by overriding
-    def pagy_get_params(params) = params
+    def pagy_get_params(params)
+      params
+    end
   end
 
   # All the code here has been optimized for performance: it may not look very pretty

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 4.7.1
+  version: 4.10.1
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-06-24 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,
@@ -22,6 +22,7 @@ files:
 - LICENSE.txt
 - lib/config/pagy.rb
 - lib/javascripts/pagy.js
+- lib/locales/ar.yml
 - lib/locales/bg.yml
 - lib/locales/bs.yml
 - lib/locales/ca.yml
@@ -72,6 +73,7 @@ files:
 - lib/pagy/extras/i18n.rb
 - lib/pagy/extras/items.rb
 - lib/pagy/extras/materialize.rb
+- lib/pagy/extras/meilisearch.rb
 - lib/pagy/extras/metadata.rb
 - lib/pagy/extras/navs.rb
 - lib/pagy/extras/overflow.rb
@@ -110,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="