WIP: small improvements

CHANGELOG-10.md

@@ -103,7 +103,8 @@ Added `Pagy::Javascript.install` function to avoid messing up with complicated j
 
 No setup required. The locales and their pluralization are autoloaded when you app use them.
 
-The code is simpler and lighter, you can also override the lookup of dictionary files with `Pagy::I18n::PATHNAMES.unshift(Pathname.new('my/customized/dictionaries'))`. 
+The code is simpler and lighter, you can also override the lookup of dictionary files with
+`Pagy::I18n::PATHNAMES.unshift(Pathname.new('my/customized/dictionaries'))`.
 
 ### Breaking Changes
 
@@ -137,10 +138,10 @@ to start with the new version of the file.
 
 #### The `Pagy::DEFAULT` is now frozen
 
-- The `Pagy::DEFAULT` is now an internal hash and it's frozen. If you had any default set there, you should pass the options to
-  the paginator constructors.
-- As an alternative to avoid repetitions, define your own default hash and pass it to the different paginator methods/helpers.
-- See the new initializer for details.
+- The `Pagy::DEFAULT` is now an internal hash and it's frozen. If you set any option with it, you should pass them to the
+  paginator methods.
+- As an alternative to avoid repetitions, define your own PAGY_OPTIONS hash and pass it to the different paginator
+  methods/helpers. See the new initializer for details.
 
 #### Core changes
 

gem/apps/demo.ru

@@ -45,15 +45,15 @@ require 'sinatra/base'
 # Sinatra application
 class PagyDemo < Sinatra::Base
   include Pagy::Backend
-  PAGY_DEFAULT = { requestable_limit: 100 }.freeze
+  PAGY_OPTIONS = { requestable_limit: 100 }.freeze
 
   get '/' do
     redirect '/pagy'
   end
 
   get '/template' do
     collection = MockCollection.new
-    @pagy, @records = pagy_offset(collection, **PAGY_DEFAULT)
+    @pagy, @records = pagy_offset(collection, **PAGY_OPTIONS)
 
     erb :template, locals: { pagy: @pagy, style: 'pagy' }
   end
@@ -79,7 +79,7 @@ class PagyDemo < Sinatra::Base
 
     get("/#{style}") do
       collection = MockCollection.new
-      @pagy, @records = pagy_offset(collection, **PAGY_DEFAULT)
+      @pagy, @records = pagy_offset(collection, **PAGY_OPTIONS)
 
       erb :helpers, locals: { style:, prefix: }
     end

gem/apps/keynav.ru

@@ -35,7 +35,7 @@ require 'sinatra/base'
 # Sinatra application
 class PagyKeynav < Sinatra::Base
   include Pagy::Backend
-  PAGY_DEFAULT = { limit: 4, requestable_limit: 100 }.freeze
+  PAGY_OPTIONS = { limit: 4, requestable_limit: 100 }.freeze
 
   get('/javascripts/:file') do
     format = params[:file].split('.').last
@@ -52,7 +52,7 @@ class PagyKeynav < Sinatra::Base
     Time.zone = 'UTC'
 
     @order       = { animal: :asc, name: :asc, birthdate: :desc, id: :asc }
-    @pagy, @pets = pagy_keynav_js(Pet.order(@order), **PAGY_DEFAULT)
+    @pagy, @pets = pagy_keynav_js(Pet.order(@order), **PAGY_OPTIONS)
     @ids         = @pets.pluck(:id)
     erb :main
   end

gem/apps/keyset.ru

@@ -35,7 +35,7 @@ require 'sinatra/base'
 # Sinatra application
 class PagyKeyset < Sinatra::Base
   include Pagy::Backend
-  PAGY_DEFAULT = { limit: 10, requestable_limit: 100 }.freeze
+  PAGY_OPTIONS = { limit: 10, requestable_limit: 100 }.freeze
 
   # Root route/action
   get '/' do

gem/apps/keyset_sequel.ru

@@ -36,7 +36,7 @@ require 'logger'
 # Sinatra application
 class PagyKeysetSequel < Sinatra::Base
   include Pagy::Backend
-  PAGY_DEFAULT = { limit: 10, requestable_limit: 100 }.freeze
+  PAGY_OPTIONS = { limit: 10, requestable_limit: 100 }.freeze
 
   # Root route/action
   get '/' do

gem/apps/rails.ru

@@ -106,11 +106,11 @@ end
 class CommentsController < ActionController::Base # :nodoc:
   include Rails.application.routes.url_helpers
   include Pagy::Backend
-  PAGY_DEFAULT = { limit:             10,
+  PAGY_OPTIONS = { limit:             10,
                    requestable_limit: 100 }.freeze
 
   def index
-    @pagy, @comments = pagy_offset(Comment.all, **PAGY_DEFAULT)
+    @pagy, @comments = pagy_offset(Comment.all, **PAGY_OPTIONS)
     # pagy_headers_merge(@pagy)
     render inline: TEMPLATE
   end

gem/apps/repro.ru

@@ -37,7 +37,7 @@ require 'sinatra/base'
 # Sinatra application
 class PagyRepro < Sinatra::Base
   include Pagy::Backend
-  PAGY_DEFAULT = { requestable_limit: 100 }.freeze
+  PAGY_OPTIONS = { requestable_limit: 100 }.freeze
 
   get('/javascripts/:file') do
     format = params[:file].split('.').last
@@ -52,9 +52,9 @@ class PagyRepro < Sinatra::Base
   # Edit this action as needed
   get '/' do
     collection = MockCollection.new
-    @pagy, @records = pagy_offset(collection, **PAGY_DEFAULT)
-    # @pagy, @records = pagy_countless(collection, **PAGY_DEFAULT)
-    # @pagy, @records = pagy_array(Array(1..1000), **PAGY_DEFAULT)
+    @pagy, @records = pagy_offset(collection, **PAGY_OPTIONS)
+    # @pagy, @records = pagy_countless(collection, **PAGY_OPTIONS)
+    # @pagy, @records = pagy_array(Array(1..1000), **PAGY_OPTIONS)
     erb :main
   end
 

gem/config/pagy.rb

@@ -6,35 +6,31 @@
 ###################################### DEFAULT #######################################
 # Customizing the static and frozen Pagy::DEFAULT is NOT SUPPORTED anymore!
 #
-# As an alternative to avoid repetitions, define your own default hash and pass it
+# As an alternative to avoid repetitions, define your own options hash and pass it
 # to the different paginator methods.
 # For example:
 #
-# PAGY_DEFAULT = { limit: 10 }.freeze
-# pagy_offset(collection, **PAGY_DEFAULT, **other_vars)
-# pagy_keyset(set, **PAGY_DEFAULT, **other_vars)
+# PAGY_OPTIONS = { limit: 10 }.freeze
+# pagy_offset(collection, **PAGY_OPTIONS, **other_options)
+# pagy_keyset(set, **PAGY_OPTIONS, **other_options)
 
 
 ############ Install Pagy Javascript #####################################################
-# If you use any pagy method ending with '*_js',
-# uncomment/customize one of the following:
+# If you use any pagy method ending with '*_js', uncomment/customize one of the following:
 
 # Generic reference to customize
 # Available file formats: 'pagy.mjs', 'pagy.js', 'pagy.js.map', 'pagy.min.js'
 # Pagy::Javascript.install('pagy.mjs', 'pagy.js', ..., javascript_path) if env_dev
 
 # Example for Rails
-# javascript_path = Rails.root.join('app/javascript')
-# Install all files...
-# Pagy::Javascript.install(javascript_path)) if Rails.env.development?
-# Install only 'pagy.mjs'...
-# Pagy::Javascript.install('pagy.mjs', javascript_path) if Rails.env.development?
+# Install 'pagy.mjs' in the dir 'app/javascript'
+# Pagy::Javascript.install('pagy.mjs', 'app/javascript') if Rails.env.development?
 
 
 ############# Overriding Pagy::I18n dictionary lookup ######################################
 # Override the dictionary lookup for customization. Just drop your customized
-# dictionary/dictionaries in a dir and add its pathname to the lookup:
-# Pagy::I18n::PATHNAMES.unshift(Pathname.new('my/customized/dictionaries'))
+# dictionary/dictionaries in a dir and unshift its pathname to the lookup:
+# Pagy::I18n::LOOKUP_PATHNAMES.unshift(Pathname.new('my/customized/dictionaries'))
 
 
 ############# I18n gem translation ######################################

gem/lib/pagy/i18n.rb

@@ -9,8 +9,8 @@ module I18n
     extend self
 
     # rubocop:disable Style/MutableConstant
-    PATHNAMES = [ROOT.join('locales')]
-    DATA      = {}
+    LOOKUP_PATHNAMES = [ROOT.join('locales')]
+    DATA = {}
     # rubocop:enable Style/MutableConstant
 
     # Translate and pluralize the key with the locale DATA
@@ -24,7 +24,7 @@ def translate(key, locale:, **options)
     private
 
     def load(locale)
-      path = PATHNAMES.map { |p| p.join("#{locale}.yml") }.find(&:exist?)
+      path = LOOKUP_PATHNAMES.map { |p| p.join("#{locale}.yml") }.find(&:exist?)
       raise Errno::ENOENT, "missing dictionary file for #{locale.inspect} locale" unless path
 
       dictionary   = YAML.load_file(path)[locale]
@@ -33,8 +33,9 @@ def load(locale)
     end
 
     # Create a flat hash with dotted notation keys
+    # e.g. { 'a' => { 'b' => {'c' => 3, 'd' => 4 }}} -> { 'a.b.c' => 3, 'a.b.d' => 4 }
     def flatten_to_dot_keys(initial, prefix = '')
-      initial.each.reduce({}) do |hash, (key, value)|
+      initial.reduce({}) do |hash, (key, value)|
         hash.merge!(value.is_a?(Hash) ? flatten_to_dot_keys(value, "#{prefix}#{key}.") : { "#{prefix}#{key}" => value })
       end
     end

test/pagy/backend/keynav_test.rb

@@ -8,7 +8,7 @@
 
 describe 'Keynav' do
   [Pet, PetSequel].each do |model|
-    describe 'pagy_augmented' do
+    describe "pagy_augmented #{model}" do
       it 'works for page 1' do
         app           = MockApp.new(params: {})
         pagy, records = app.send(:pagy_keynav_js,

test/pagy/backend/keyset_test.rb

@@ -6,7 +6,7 @@
 
 describe 'keyset' do
   [Pet, PetSequel].each do |model|
-    describe '#pagy_keyset' do
+    describe "#pagy_keyset #{model}" do
       it 'returns Pagy::Keyset object and records' do
         app = MockApp.new(params: { page: nil })
         pagy, records = app.send(:pagy_keyset,
@@ -27,7 +27,7 @@
         _(pagy.next).must_equal "WzIwXQ"
       end
     end
-    describe 'URL helpers' do
+    describe "URL helpers #{model}" do
       it 'returns the URLs for first page' do
         app = MockApp.new(params: { page: nil, limit: 10 })
         pagy, _records = app.send(:pagy_keyset,

test/pagy/frontend/i18n_test.rb

@@ -3,7 +3,7 @@
 require_relative '../../test_helper'
 require_relative '../../mock_helpers/app'
 
-describe 'pagy/legacy/i18n' do
+describe 'pagy/i18n' do
   let(:app) { MockApp.new }
 
   ##### pagy.rb initializer ###############

test/pagy/frontend/i18n_test.rb.yaml

@@ -9,3 +9,8 @@ pagy/legacy/i18n___pagy_info_with_I18n_test_0001_renders_info:
   :info_1: <span class="pagy info">Displaying 1 item</span>
   :info_13: <span class="pagy info">Displaying 13 items</span>
   :info_100: <span class="pagy info">Displaying items 41-60 of 100 in total</span>
+pagy/i18n___pagy_info_with_I18n_test_0001_renders_info:
+  :info_0: <span class="pagy info">No items found</span>
+  :info_1: <span class="pagy info">Displaying 1 item</span>
+  :info_13: <span class="pagy info">Displaying 13 items</span>
+  :info_100: <span class="pagy info">Displaying items 41-60 of 100 in total</span>