pagy 4.11.0 → 6.0.0

data/lib/javascripts/pagy.js

@@ -1,121 +1 @@
-// See the Pagy documentation: https://ddnexus.github.io/pagy/extras#javascript
-
-function Pagy(){}
-
-Pagy.version = '4.11.0'
-
-Pagy.delay = 100
-
-Pagy.init =
-  function(arg) {
-    var target   = arg instanceof Event || arg === undefined ? document : arg,
-        elements = target.querySelectorAll('[data-pagy-json]')
-    for (var i = 0, len = elements.length; i < len; i++) {
-      var args  = JSON.parse(elements[i].getAttribute('data-pagy-json')),
-          fname = args.shift()
-      args.unshift(elements[i])
-      Pagy[fname].apply(null, args)
-    }
-  }
-
-Pagy.nav =
-  function(pagyEl, tags, sequels, trimParam) {
-    var lastWidth,
-        pageREg = new RegExp(/__pagy_page__/g),
-        widths  = []
-    for (var width in sequels) {
-      if (sequels.hasOwnProperty(width)) { widths.push(parseInt(width, 10)) }
-    }
-    widths.sort(function(a, b) { return b - a })
-
-    pagyEl.render =
-      function() {
-        var width, i, len
-        for (i = 0, len = widths.length; i < len; i++) {
-          if (this.parentElement.clientWidth > widths[i]) { width = widths[i]; break }
-        }
-        if (width !== lastWidth) {
-          var html   = tags.before,
-              series = sequels[width]
-          for (i = 0, len = series.length; i < len; i++) {
-            var item = series[i]
-            if (typeof(trimParam) === 'string' && item === 1) { html += Pagy.trim(tags.link.replace(pageREg, item), trimParam) }
-            else if (typeof(item) === 'number') { html += tags.link.replace(pageREg, item) }
-            else if (item === 'gap') { html += tags.gap }
-            else if (typeof(item) === 'string') { html += tags.active.replace(pageREg, item) }
-          }
-          html += tags.after
-          this.innerHTML = ''
-          this.insertAdjacentHTML('afterbegin', html)
-          lastWidth = width
-        }
-      }.bind(pagyEl)
-    pagyEl.render()
- }
-
-Pagy.combo_nav =
-  function(pagyEl, page, link, trimParam) {
-    var input  = pagyEl.getElementsByTagName('input')[0],
-        toPage =
-          function() {
-            if (page !== input.value) {
-              var html = link.replace(/__pagy_page__/, input.value)
-              if (typeof (trimParam) === 'string' && input.value === '1') { html = Pagy.trim(html, trimParam) }
-              pagyEl.insertAdjacentHTML('afterbegin', html)
-              pagyEl.getElementsByTagName('a')[0].click()
-            }
-          }
-    Pagy.addInputEventListeners(input, toPage)
-  }
-
-Pagy.items_selector =
-  function(pagyEl, from, link, param) {
-    var input   = pagyEl.getElementsByTagName('input')[0],
-        current = input.value,
-        toPage  =
-          function() {
-            var items = input.value
-            if (current !== items) {
-              var page = Math.max(Math.ceil(from / items), 1),
-                  html = link.replace(/__pagy_page__/, page).replace(/__pagy_items__/, items)
-              if (typeof (param) === 'string' && page === 1) { html = Pagy.trim(html, param) }
-              pagyEl.insertAdjacentHTML('afterbegin', html)
-              pagyEl.getElementsByTagName('a')[0].click()
-            }
-          }
-    Pagy.addInputEventListeners(input, toPage)
-  }
-
-Pagy.addInputEventListeners =
-  function(input, toPage) {
-    // select the content on click: easier for typing a number
-    input.addEventListener('click', function() { this.select() })
-    // toPage when the input looses focus
-    input.addEventListener('focusout', toPage)
-    // … and when pressing enter inside the input
-    input.addEventListener('keyup', function(e) { if (e.which === 13) {toPage()} }.bind(this))
-  }
-
-Pagy.trim =
-  function(html, param) {
-    var re = new RegExp('[?&]' + param + '=1\\b(?!&)|\\b' + param + '=1&')
-    return html.replace(re, '')
-  }
-
-Pagy.renderNavs =
-  function() {
-    var navs = document.getElementsByClassName('pagy-njs')  // 'pagy-njs' is common to all *nav_js helpers
-    for (var i = 0, len = navs.length; i < len; i++) { navs[i].render() }
-  }
-
-Pagy.waitForMe =
-  function() {
-    if (typeof(Pagy.tid) === 'number') { clearTimeout(Pagy.tid) }
-    Pagy.tid = setTimeout(Pagy.renderNavs, Pagy.delay)
-  }
-
-
-if (typeof window !== "undefined") {
-  window.addEventListener('resize', Pagy.waitForMe, true)
-}
-
+!function(){var e=(()=>{const e=new ResizeObserver((e=>e.forEach((e=>e.target.querySelectorAll(".pagy-rjs").forEach((e=>e.pagyRender())))))),t=(t,[n,r,a,c])=>{const i=t.parentElement??t,s=Object.keys(r).map((e=>parseInt(e))).sort(((e,t)=>t-e));let p=-1;const l=(e,t,n)=>e.replace(/__pagy_page__/g,t).replace(/__pagy_label__/g,n);(t.pagyRender=function(){const e=s.find((e=>e<i.clientWidth))||0;if(e===p)return;let g=n.before;const y=r[e.toString()],f=a?.[e.toString()]??y.map((e=>e.toString()));for(const e in y){const t=y[e],r=f[e];g+="string"==typeof c&&1===t?o(l(n.link,t.toString(),r),c):"number"==typeof t?l(n.link,t.toString(),r):"gap"===t?n.gap:l(n.active,t,r)}g+=n.after,t.innerHTML="",t.insertAdjacentHTML("afterbegin",g),p=e})(),t.classList.contains("pagy-rjs")&&e.observe(i)},n=(e,[t,n])=>a(e,(e=>[e,t.replace(/__pagy_page__/,e)]),n),r=(e,[t,n,r])=>{a(e,(e=>{const r=Math.max(Math.ceil(t/parseInt(e)),1).toString();return[r,n.replace(/__pagy_page__/,r).replace(/__pagy_items__/,e)]}),r)},a=(e,t,n)=>{const r=e.querySelector("input"),a=r.value,c=function(){if(r.value===a)return;const[c,i,s]=[r.min,r.value,r.max].map((e=>parseInt(e)||0));if(i<c||i>s)return r.value=a,void r.select();let[p,l]=t(r.value);"string"==typeof n&&"1"===p&&(l=o(l,n)),e.insertAdjacentHTML("afterbegin",l),e.querySelector("a").click()};["change","focus"].forEach((e=>r.addEventListener(e,r.select))),r.addEventListener("focusout",c),r.addEventListener("keypress",(e=>{"Enter"===e.key&&c()}))},o=(e,t)=>e.replace(new RegExp(`(\\?|&amp;)${t}=1\\b(?!&amp;)|\\b${t}=1&amp;`),"");return{version:"6.0.0",init(e){const a=(e instanceof Element?e:document).querySelectorAll("[data-pagy]");for(const e of a)try{const a=Uint8Array.from(atob(e.getAttribute("data-pagy")),(e=>e.charCodeAt(0))),[o,...c]=JSON.parse((new TextDecoder).decode(a));"nav"===o?t(e,c):"combo"===o?n(e,c):"selector"===o?r(e,c):console.warn("Skipped Pagy.init() for: %o\nUnknown keyword '%s'",e,o)}catch(t){console.warn("Skipped Pagy.init() for: %o\n%s",e,t)}}}})();window.Pagy=e}();

data/lib/locales/de.yml

@@ -13,7 +13,7 @@ de:
       gap: "…"
 
     info:
-      no_items: "Kein %{item_name} gefunden"
+      no_items: "Keine %{item_name} gefunden"
       single_page: "Zeige <b>%{count}</b> %{item_name}"
       multiple_pages: "Zeige %{item_name} <b>%{from}-%{to}</b> von <b>%{count}</b> gesamt"
 

data/lib/locales/ko.yml

@@ -7,7 +7,7 @@ ko:
 
     nav:
       prev: "‹ 이전"
-      next: "이후 ›"
+      next: "다음 ›"
       gap: "…"
 
     info:

data/lib/locales/nn.yml

@@ -0,0 +1,22 @@
+# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
+nn:
+  pagy:
+
+    item_name:
+      one: "resultat"
+      other: "resultat"
+
+    nav:
+      prev: "‹ Førre"
+      next: "Neste ›"
+      gap: "…"
+
+    info:
+      no_items: "Ingen %{item_name} funne"
+      single_page: "Viser <b>%{count}</b> %{item_name}"
+      multiple_pages: "Viser %{item_name} <b>%{from}-%{to}</b> av totalt <b>%{count}</b>"
+
+    combo_nav_js: "<label>Side %{page_input} av %{pages}</label>"
+
+    items_selector_js: "<label>Vis %{items_input} %{item_name} per side</label>"

data/lib/locales/ta.yml

@@ -0,0 +1,22 @@
+# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
+ta:
+  pagy:
+
+    item_name:
+      one: "பதிவு"
+      other: "பதிவுகள்"
+
+    nav:
+      prev: "‹ முந்தையது"
+      next: "அடுத்தது ›"
+      gap: "…"
+
+    info:
+      no_items: "%{item_name} கிடைக்கவில்லை"
+      single_page: "<b>%{count}</b> %{item_name} காட்டப்படுகின்றது"
+      multiple_pages: "மொத்தம் <b>%{count}</b> %{item_name}, காட்டப்படுபவை <b>%{from}-%{to}</b>"
+
+    combo_nav_js: "<label>%{pages}-இல் %{page_input}-வது பக்கம்</label>"
+
+    items_selector_js: "<label>ஒரு பக்கத்திற்கு %{items_input} %{item_name} காட்டு</label>"

data/lib/pagy/backend.rb

@@ -2,34 +2,31 @@
 # frozen_string_literal: true
 
 class Pagy
-  # Defines a few generic methods to paginate an ORM collection out of the box,
+  # Define a few generic methods to paginate an ORM collection out of the box,
   # or any collection by overriding pagy_get_items and/or pagy_get_vars in your controller
-
   # See also the extras if you need specialized methods to paginate Arrays or other collections
-
-
   module Backend
-    private         # the whole module is private so no problem with including it in a controller
+    private
 
-    # Return Pagy object and items
-    def pagy(collection, vars={})
+    # Return Pagy object and paginated items/results
+    def pagy(collection, vars = {})
       pagy = Pagy.new(pagy_get_vars(collection, vars))
-      [ pagy, pagy_get_items(collection, pagy) ]
+      [pagy, pagy_get_items(collection, pagy)]
     end
 
     # Sub-method called only by #pagy: here for easy customization of variables by overriding
+    # You may need to override the count call for non AR collections
     def pagy_get_vars(collection, vars)
-      pagy_set_items_from_params(vars) if defined?(UseItemsExtra)
-      vars[:count] ||= (c = collection.count(:all)).is_a?(Hash) ? c.size : c
-      vars[:page]  ||= params[ vars[:page_param] || VARS[:page_param] ]
+      pagy_set_items_from_params(vars) if defined?(ItemsExtra)
+      vars[:count] ||= (count = collection.count(:all)).is_a?(Hash) ? count.size : count
+      vars[:page]  ||= params[vars[:page_param] || DEFAULT[:page_param]]
       vars
     end
 
     # Sub-method called only by #pagy: here for easy customization of record-extraction by overriding
+    # You may need to override this method for collections without offset|limit
     def pagy_get_items(collection, pagy)
-      # This should work with ActiveRecord, Sequel, Mongoid...
       collection.offset(pagy.offset).limit(pagy.items)
     end
-
   end
 end

data/lib/pagy/calendar/day.rb

@@ -0,0 +1,39 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  class Calendar # :nodoc:
+    # Calendar day subclass
+    class Day < Calendar
+      DEFAULT = { order:  :asc,      # rubocop:disable Style/MutableConstant
+                  format: '%Y-%m-%d' }
+
+      protected
+
+      # Setup the calendar variables
+      def setup_unit_vars
+        super
+        @initial = @starting.beginning_of_day
+        @final   = @ending.tomorrow.beginning_of_day
+        @pages   = @last = page_offset(@initial, @final)
+        @from    = starting_time_for(@page)
+        @to      = @from.tomorrow
+      end
+
+      # Starting time for the page
+      def starting_time_for(page)
+        @initial.days_since(time_offset_for(page))
+      end
+
+      def page_offset_at(time)
+        page_offset(@initial, time.beginning_of_day)
+      end
+
+      private
+
+      def page_offset(time_a, time_b)  # remove in 6.0
+        (time_b.time - time_a.time).to_i / 1.day
+      end
+    end
+  end
+end

data/lib/pagy/calendar/helper.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  class Calendar # :nodoc:
+    # Initializes the calendar objects, reducing complexity in the extra
+    # The returned calendar is a simple hash of units/objects with an added helper
+    # returning the last_object_at(time) used in the extra
+    class Helper < Hash
+      class << self
+        private
+
+        def init(conf, period, params)
+          new.send(:init, conf, period, params)
+        end
+      end
+
+      private
+
+      def init(conf, period, params)
+        @units = Calendar::UNITS & conf.keys # get the units in time length desc order
+        raise ArgumentError, 'no calendar unit found in pagy_calendar @configuration' if @units.empty?
+
+        @period     = period
+        @params     = params
+        @page_param = conf[:pagy][:page_param] || DEFAULT[:page_param]
+        @conf       = Marshal.load(Marshal.dump(conf))  # store a copy
+        @units.each do |unit|  # set all the :page_param vars for later deletion
+          unit_page_param         = :"#{unit}_#{@page_param}"
+          conf[unit][:page_param] = unit_page_param
+          conf[unit][:page]       = @params[unit_page_param]
+        end
+        calendar = {}
+        object   = nil
+        @units.each_with_index do |unit, index|
+          params_to_delete    = @units[(index + 1), @units.size].map { |sub| conf[sub][:page_param] } + [@page_param]
+          conf[unit][:params] = lambda do |unit_params|  # delete page_param from the sub-units
+                                  # Hash#except missing from ruby 2.5 baseline
+                                  params_to_delete.each { |p| unit_params.delete(p.to_s) }
+                                  unit_params
+                                end
+          conf[unit][:period] = object&.send(:active_period) || @period
+          calendar[unit]      = object = Calendar.send(:create, unit, conf[unit])
+        end
+        [replace(calendar), object.from, object.to]
+      end
+
+      def last_object_at(time)
+        conf        = Marshal.load(Marshal.dump(@conf))
+        page_params = {}
+        @units.inject(nil) do |object, unit|
+          conf[unit][:period] = object&.send(:active_period) || @period
+          conf[unit][:page]   = page_params[:"#{unit}_#{@page_param}"] \
+                              = Calendar.send(:create, unit, conf[unit]).send(:page_at, time)
+          conf[unit][:params] ||= {}
+          conf[unit][:params].merge!(page_params)
+          Calendar.send(:create, unit, conf[unit])
+        end
+      end
+    end
+  end
+end

data/lib/pagy/calendar/month.rb

@@ -0,0 +1,40 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  class Calendar # :nodoc:
+    # Calendar month subclass
+    class Month < Calendar
+      DEFAULT = { order: :asc, # rubocop:disable Style/MutableConstant
+                  format: '%Y-%m' }
+
+      protected
+
+      # Setup the calendar variables
+      def setup_unit_vars
+        super
+        @initial = @starting.beginning_of_month
+        @final   = @ending.next_month.beginning_of_month
+        @pages   = @last = (months_in(@final) - months_in(@initial))
+        @from    = starting_time_for(@page)
+        @to      = @from.next_month
+      end
+
+      # Starting time for the page
+      def starting_time_for(page)
+        @initial.months_since(time_offset_for(page))
+      end
+
+      def page_offset_at(time)
+        months_in(time.beginning_of_month) - months_in(@initial)
+      end
+
+      private
+
+      # Number of months in time
+      def months_in(time)
+        (time.year * 12) + time.month
+      end
+    end
+  end
+end

data/lib/pagy/calendar/quarter.rb

@@ -0,0 +1,47 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  class Calendar # :nodoc:
+    # Calendar quarter subclass
+    class Quarter < Calendar
+      DEFAULT = { order:  :asc,      # rubocop:disable Style/MutableConstant
+                  format: '%Y-Q%q' } # '%q' token
+
+      # The label for any page, with the substitution of the '%q' token
+      def label_for(page, opts = {})
+        starting_time = starting_time_for(page.to_i)  # page could be a string
+        opts[:format] = (opts[:format] || @vars[:format]).gsub('%q') { (starting_time.month / 3.0).ceil }
+        localize(starting_time, opts)
+      end
+
+      protected
+
+      # Setup the calendar variables
+      def setup_unit_vars
+        super
+        @initial = @starting.beginning_of_quarter
+        @final   = @ending.next_quarter.beginning_of_quarter
+        @pages   = @last = (months_in(@final) - months_in(@initial)) / 3
+        @from    = starting_time_for(@page)
+        @to      = @from.next_quarter
+      end
+
+      # Starting time for the page
+      def starting_time_for(page)
+        @initial.months_since(time_offset_for(page) * 3)
+      end
+
+      def page_offset_at(time)
+        (months_in(time.beginning_of_quarter) - months_in(@initial)) / 3
+      end
+
+      private
+
+      # Number of months in time
+      def months_in(time)
+        (time.year * 12) + time.month
+      end
+    end
+  end
+end

data/lib/pagy/calendar/week.rb

@@ -0,0 +1,39 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  class Calendar # :nodoc:
+    # Calendar week subclass
+    class Week < Calendar
+      DEFAULT  = { order:  :asc,      # rubocop:disable Style/MutableConstant
+                   format: '%Y-%W' }
+
+      protected
+
+      # Setup the calendar variables
+      def setup_unit_vars
+        super
+        @initial = @starting.beginning_of_week
+        @final   = @ending.next_week.beginning_of_week
+        @pages   = @last = page_offset(@initial, @final)
+        @from    = starting_time_for(@page)
+        @to      = @from.next_week
+      end
+
+      # Starting time for the page
+      def starting_time_for(page)
+        @initial.weeks_since(time_offset_for(page))
+      end
+
+      def page_offset_at(time)
+        page_offset(@initial, time.beginning_of_week)
+      end
+
+      private
+
+      def page_offset(time_a, time_b)  # remove in 6.0
+        (time_b.time - time_a.time).to_i / 1.week
+      end
+    end
+  end
+end

data/lib/pagy/calendar/year.rb

@@ -0,0 +1,33 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  class Calendar # :nodoc:
+    # Calendar year subclass
+    class Year < Calendar
+      DEFAULT = { order:  :asc,      # rubocop:disable Style/MutableConstant
+                  format: '%Y' }
+
+      protected
+
+      # Setup the calendar variables
+      def setup_unit_vars
+        super
+        @initial = @starting.beginning_of_year
+        @final   = @ending.next_year.beginning_of_year
+        @pages   = @last = @final.year - @initial.year
+        @from    = starting_time_for(@page)
+        @to      = @from.next_year
+      end
+
+      # Starting time for the page
+      def starting_time_for(page)
+        @initial.years_since(time_offset_for(page))
+      end
+
+      def page_offset_at(time)
+        time.beginning_of_year.year - @initial.year
+      end
+    end
+  end
+end

data/lib/pagy/calendar.rb

@@ -0,0 +1,100 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/time'
+require 'active_support/core_ext/date_and_time/calculations'
+require 'active_support/core_ext/numeric/time'
+require 'active_support/core_ext/integer/time'
+
+require 'pagy'
+
+class Pagy # :nodoc:
+  # Base class for time units subclasses (Year, Quarter, Month, Week, Day)
+  class Calendar < Pagy
+    # Specific out of range error
+    class OutOfRangeError < StandardError; end
+
+    # List of units in desc order of duration. It can be used for custom units.
+    UNITS = %i[year quarter month week day]  # rubocop:disable Style/MutableConstant
+
+    attr_reader :order
+
+    # Merge and validate the options, do some simple arithmetic and set a few instance variables
+    def initialize(vars) # rubocop:disable Lint/MissingSuper
+      raise InternalError, 'Pagy::Calendar is a base class; use one of its subclasses' if instance_of?(Pagy::Calendar)
+
+      vars = self.class::DEFAULT.merge(vars)  # subclass specific default
+      normalize_vars(vars)                    # general default
+      setup_vars(page: 1)
+      setup_unit_vars
+      setup_params_var
+      raise OverflowError.new(self, :page, "in 1..#{@last}", @page) if @page > @last
+
+      @prev = (@page - 1 unless @page == 1)
+      @next = @page == @last ? (1 if @vars[:cycle]) : @page + 1
+    end
+
+    # The label for the current page (it can pass along the I18n gem opts when it's used with the i18n extra)
+    def label(opts = {})
+      label_for(@page, opts)
+    end
+
+    # The label for any page (it can pass along the I18n gem opts when it's used with the i18n extra)
+    def label_for(page, opts = {})
+      opts[:format] ||= @vars[:format]
+      localize(starting_time_for(page.to_i), opts)  # page could be a string
+    end
+
+    protected
+
+    # The page that includes time
+    def page_at(time)
+      raise OutOfRangeError unless time.between?(@initial, @final)
+
+      offset = page_offset_at(time)   # offset starts from 0
+      @order == :asc ? offset + 1 : @pages - offset
+    end
+
+    # Base class method for the setup of the unit variables (subclasses must implement it and call super)
+    def setup_unit_vars
+      raise VariableError.new(self, :format, 'to be a strftime format', @vars[:format]) unless @vars[:format].is_a?(String)
+      raise VariableError.new(self, :order, 'to be in [:asc, :desc]', @order) \
+            unless %i[asc desc].include?(@order = @vars[:order])
+
+      @starting, @ending = @vars[:period]
+      raise VariableError.new(self, :period, 'to be a an Array of min and max TimeWithZone instances', @vars[:period]) \
+            unless @starting.is_a?(ActiveSupport::TimeWithZone) \
+                && @ending.is_a?(ActiveSupport::TimeWithZone) && @starting <= @ending
+    end
+
+    # Apply the strftime format to the time (overridden by the i18n extra when localization is required)
+    def localize(time, opts)
+      time.strftime(opts[:format])
+    end
+
+    # Number of time units to offset from the @initial time, in order to get the ordered starting time for the page.
+    # Used in starting_time_for(page) where page starts from 1 (e.g. page to starting_time means subtracting 1)
+    def time_offset_for(page)
+      @order == :asc ? page - 1 : @pages - page
+    end
+
+    # Period of the active page (used internally for nested units)
+    def active_period
+      [[@starting, @from].max, [@to - 1, @ending].min] # -1 sec: include only last unit day
+    end
+
+    class << self
+      # Create a subclass instance by unit name (internal use)
+      def create(unit, vars)
+        raise InternalError, "unit must be in #{UNITS.inspect}; got #{unit}" unless UNITS.include?(unit)
+
+        name    = unit.to_s
+        name[0] = name[0].capitalize
+        Object.const_get("Pagy::Calendar::#{name}").new(vars)
+      end
+    end
+  end
+  # Require the subclass files in UNITS (no custom unit at this point yet)
+  Calendar::UNITS.each { |unit| require "pagy/calendar/#{unit}" }
+end

data/lib/pagy/console.rb

@@ -1,21 +1,23 @@
+# See Pagy::Console API documentation: https://ddnexus.github.io/pagy/api/console
 # frozen_string_literal: true
 
 require 'pagy'  # so you can require just the extra in the console
 require 'pagy/extras/standalone'
 
 class Pagy
-  # include Pagy::Console in irb/rails console for a ready to use pagy environment
+  # Provide a ready to use pagy environment when included in irb/rails console
   module Console
+    # Include Backend, Frontend and set the default URL
     def self.included(main)
       main.include(Backend)
       main.include(Frontend)
-      VARS[:url] = 'http://www.example.com/subdir'
+      DEFAULT[:url] = 'http://www.example.com/subdir'
     end
 
+    # Require the extras passed as arguments
     def pagy_extras(*extras)
-      extras.each {|extra| require "pagy/extras/#{extra}"}
+      extras.each { |extra| require "pagy/extras/#{extra}" }
       puts "Required extras: #{extras.map(&:inspect).join(', ')}"
     end
   end
-
 end