bridgetown-paginate 0.21.2 → 1.0.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45369a416f343109e2bdc1ffe5a67996100127813567b0874c207dd10ff86282
-  data.tar.gz: a7ef8b903febea7709b7e7af642e98b454bf464a50acc7f2a6c09f068d5b8431
+  metadata.gz: 7f4ddd4a70ec92776ef3aa0ef66b3962795bed297e7a9dc82823254b9ed0192a
+  data.tar.gz: c8f3a2c8df7fc1fcc53cc5dff9a55241bbdba95f9779fc350ab11caaece8fce6
 SHA512:
-  metadata.gz: 0b719ca33f468ee9f8ba22d372c96810076d6b729d96f0e95bcdd0efad982ec9a168c0c9026c5b6556d77826ac684441a5759a84afd4b45b55acc9cc3ab80e84
-  data.tar.gz: 1347ab6fb4fa5ab2ee4fceed385fbf5feb03b7d536556bb300d146397aef37656de164f7f6d066355265a338564c7b5c675344d40464d8edb266d9c982818815
+  metadata.gz: fe5262a059bb676c9c16f9d81c50cf3b006319da0c6fe28aeba1c6b1faaec84b0b8e158d6e15b4719b20c39e249222a2a54cef12d1c88c342079572d5778ac42
+  data.tar.gz: cfda5839ca555de2c8bb99a1639656bbb26a6c0074b99491db9469e4f451b3cdeb9cfb48a98d0fdad035802199bb800799bafe963cbe39e767ed16d59ac8650c

data/.rubocop.yml

@@ -2,9 +2,8 @@
 inherit_from: ../.rubocop.yml
 
 AllCops:
-  Include:
-    - lib/**/*.rb
-    - spec/**/*.rb
+  Exclude:
+    - "*.gemspec"
 
 Bridgetown/NoPutsAllowed:
   Exclude:

data/bridgetown-paginate.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.author        = "Bridgetown Team"
   spec.email         = "maintainers@bridgetownrb.com"
   spec.summary       = "A Bridgetown plugin to add pagination support for posts and collection indices."
-  spec.homepage      = "https://github.com/bridgetownrb/bridgetown/tree/master/bridgetown-paginate"
+  spec.homepage      = "https://github.com/bridgetownrb/bridgetown/tree/main/bridgetown-paginate"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }

data/lib/bridgetown-paginate/hooks.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Handles Generated Pages
-Bridgetown::Hooks.register :pages, :post_init, reloadable: false do |page|
+Bridgetown::Hooks.register :generated_pages, :post_init, reloadable: false do |page|
   if page.class != Bridgetown::Paginate::PaginationPage &&
       page.site.config.dig("pagination", "enabled")
     data = page.data.with_dot_access

data/lib/bridgetown-paginate/pagination_generator.rb

@@ -32,19 +32,18 @@ module Bridgetown
           DEFAULT,
           site.config["pagination"] || {}
         )
-        default_config["collection"] = "posts" unless site.uses_resource?
 
         # If disabled then simply quit
         unless default_config["enabled"]
           Bridgetown.logger.info "Pagination:", "disabled. Enable in site config" \
-            " with pagination:\\n  enabled: true"
+                                                " with pagination:\\n  enabled: true"
           return
         end
 
         Bridgetown.logger.debug "Pagination:", "Starting"
 
         # Get all matching pages in the site found by the init hooks, and ensure they're
-        # still in the site.pages array
+        # still in the site.generated_pages array
         templates = self.class.matching_templates.select do |page|
           site.generated_pages.include?(page) || site.resources.include?(page)
         end
@@ -96,18 +95,19 @@ module Bridgetown
           if page_to_remove.is_a?(Bridgetown::Resource::Base)
             page_to_remove.collection.resources.delete(page_to_remove)
           else
-            site.pages.delete(page_to_remove)
+            site.generated_pages.delete(page_to_remove)
           end
         end
 
         # Create a proc that will delegate logging
         # Decoupling Bridgetown specific logging
         logging_lambda = ->(message, type = "info") do
-          if type == "debug"
+          case type
+          when "debug"
             Bridgetown.logger.debug "Pagination:", message.to_s
-          elsif type == "error"
+          when "error"
             Bridgetown.logger.error "Pagination:", message.to_s
-          elsif type == "warn"
+          when "warn"
             Bridgetown.logger.warn "Pagination:", message.to_s
           else
             Bridgetown.logger.info "Pagination:", message.to_s

data/lib/bridgetown-paginate/pagination_indexer.rb

@@ -7,7 +7,7 @@ module Bridgetown
     # filtering said collections when requested by the defined filters.
     #
     class PaginationIndexer
-      @cached_index = {}
+      @cached_index = {}.compare_by_identity
 
       class << self
         attr_accessor :cached_index
@@ -53,10 +53,8 @@ module Bridgetown
           end
         end
 
-        unless cached_index[all_documents.object_id].is_a?(Hash)
-          cached_index[all_documents.object_id] = {}
-        end
-        cached_index[all_documents.object_id][index_key] = index
+        cached_index[all_documents] = {} unless cached_index[all_documents].is_a?(Hash)
+        cached_index[all_documents][index_key] = index
         index
       end
 

data/lib/bridgetown-paginate/pagination_model.rb

@@ -12,7 +12,7 @@ module Bridgetown
       @logging_lambda = nil
       # The lambda used to create pages and add them to the site
       @page_add_lambda = nil
-      # Lambda to remove a page from the site.pages collection
+      # Lambda to remove a page
       @page_remove_lambda = nil
       # Lambda to get all documents/posts in a particular collection (by name)
       @collection_by_name_lambda = nil
@@ -32,8 +32,11 @@ module Bridgetown
       # rubocop:disable Metrics/BlockLength
       def run(default_config, templates, site_title) # rubocop:todo Metrics/AbcSize
         if templates.size.to_i <= 0
-          @logging_lambda.call "is enabled in the config, but no paginated pages found." \
-            " Add 'pagination:\\n  collection: <label>' to the front-matter of a page.", "warn"
+          @logging_lambda.call(
+            "is enabled in the config, but no paginated pages found." \
+            " Add 'pagination:\\n  collection: <label>' to the front-matter of a page.",
+            "warn"
+          )
           return
         end
 
@@ -50,15 +53,20 @@ module Bridgetown
           template_config = Bridgetown::Utils.deep_merge_hashes(
             default_config,
             template.data["pagination"] || template.data["paginate"] || {}
-          )
+          ).tap do |config|
+            config["collection"] = config["collection"].to_s if config["collection"].is_a?(Symbol)
+            config["category"] = config["category"].to_s if config["category"].is_a?(Symbol)
+            config["tag"] = config["tag"].to_s if config["tag"].is_a?(Symbol)
+            config["locale"] = config["locale"].to_s if config["locale"].is_a?(Symbol)
+          end
 
           # Is debugging enabled on the page level
           @debug = template_config["debug"]
           _debug_print_config_info(template_config, template.path)
 
-          next if template_config["enabled"] == false
+          next unless template_config["enabled"]
 
-          @logging_lambda.call "found page: " + template.path, "debug" unless @debug
+          @logging_lambda.call "found page: #{template.path}", "debug" unless @debug
 
           # Request all documents in all collections that the user has requested
           all_posts = get_docs_in_collections(template_config["collection"], template)
@@ -149,34 +157,34 @@ module Bridgetown
         r = 20
         f = "Pagination: ".rjust(20)
         # Debug print the config
-        if @debug
-          puts f + "----------------------------"
-          puts f + "Page: " + page_path.to_s
-          puts f + " Active configuration"
-          puts f + "  Enabled: ".ljust(r) + config["enabled"].to_s
-          puts f + "  Items per page: ".ljust(r) + config["per_page"].to_s
-          puts f + "  Permalink: ".ljust(r) + config["permalink"].to_s
-          puts f + "  Title: ".ljust(r) + config["title"].to_s
-          puts f + "  Limit: ".ljust(r) + config["limit"].to_s
-          puts f + "  Sort by: ".ljust(r) + config["sort_field"].to_s
-          puts f + "  Sort reverse: ".ljust(r) + config["sort_reverse"].to_s
-
-          puts f + " Active Filters"
-          puts f + "  Collection: ".ljust(r) + config["collection"].to_s
-          puts f + "  Offset: ".ljust(r) + config["offset"].to_s
-          puts f + "  Category: ".ljust(r) + (config["category"].nil? || config["category"] == "posts" ? "[Not set]" : config["category"].to_s)
-          puts f + "  Tag: ".ljust(r) + (config["tag"].nil? ? "[Not set]" : config["tag"].to_s)
-          puts f + "  Locale: ".ljust(r) + (config["locale"].nil? ? "[Not set]" : config["locale"].to_s)
-        end
+        return unless @debug
+
+        puts "#{f}----------------------------"
+        puts "#{f}Page: #{page_path}"
+        puts "#{f} Active configuration"
+        puts f + "  Enabled: ".ljust(r) + config["enabled"].to_s
+        puts f + "  Items per page: ".ljust(r) + config["per_page"].to_s
+        puts f + "  Permalink: ".ljust(r) + config["permalink"].to_s
+        puts f + "  Title: ".ljust(r) + config["title"].to_s
+        puts f + "  Limit: ".ljust(r) + config["limit"].to_s
+        puts f + "  Sort by: ".ljust(r) + config["sort_field"].to_s
+        puts f + "  Sort reverse: ".ljust(r) + config["sort_reverse"].to_s
+
+        puts "#{f} Active Filters"
+        puts f + "  Collection: ".ljust(r) + config["collection"].to_s
+        puts f + "  Offset: ".ljust(r) + config["offset"].to_s
+        puts f + "  Category: ".ljust(r) + (config["category"].nil? || config["category"] == "posts" ? "[Not set]" : config["category"].to_s)
+        puts f + "  Tag: ".ljust(r) + (config["tag"].nil? ? "[Not set]" : config["tag"].to_s)
+        puts f + "  Locale: ".ljust(r) + (config["locale"].nil? ? "[Not set]" : config["locale"].to_s)
       end
       # rubocop:enable Layout/LineLength
 
       # rubocop:disable Layout/LineLength
       def _debug_print_filtering_info(filter_name, before_count, after_count)
         # Debug print the config
-        if @debug
-          puts "Pagination: ".rjust(20) + " Filtering by: " + filter_name.to_s.ljust(9) + " " + before_count.to_s.rjust(3) + " => " + after_count.to_s
-        end
+        return unless @debug
+
+        puts "#{"Pagination: ".rjust(20)} Filtering by: #{filter_name.to_s.ljust(9)} #{before_count.to_s.rjust(3)} => #{after_count}"
       end
       # rubocop:enable Layout/LineLength
 
@@ -258,7 +266,7 @@ module Bridgetown
           # So to unblock this common issue for the date field I simply iterate
           # once over every document and initialize the .date field explicitly
           if @debug
-            puts "Pagination: ".rjust(20) + "Rolling through the date fields for all documents"
+            puts "#{"Pagination: ".rjust(20)}Rolling through the date fields for all documents"
           end
           using_posts.each do |u_post|
             next unless u_post.respond_to?("date")
@@ -340,13 +348,14 @@ module Bridgetown
                                  else
                                    template.dir
                                  end
-          first_index_page_url = Utils.ensure_trailing_slash(first_index_page_url)
+          first_index_page_url = Utils.ensure_trailing_slash(
+            Utils.remove_double_slash(first_index_page_url)
+          )
           paginated_page_url = File.join(first_index_page_url, paginated_page_url)
 
           # 3. Create the paginator logic for this page, pass in the prev and next
           # page numbers, assign paginator to in-memory page
-          # TODO: remove .pager by v1.0, deprecated
-          newpage.paginator = newpage.pager = Paginator.new(
+          newpage.paginator = Paginator.new(
             config["per_page"],
             first_index_page_url,
             paginated_page_url,
@@ -372,11 +381,7 @@ module Bridgetown
           newpage.data["permalink"] = newpage.paginator.page_path if template.data["permalink"]
 
           # Transfer the title across to the new page
-          tmp_title = if !template.data["title"]
-                        site_title
-                      else
-                        template.data["title"]
-                      end
+          tmp_title = template.data["title"] || site_title
 
           # If the user specified a title suffix to be added then let's add that
           # to all the pages except the first
@@ -413,40 +418,40 @@ module Bridgetown
         # simplest is to include all of the links to the pages preceeding the
         # current one (e.g for page 1 you get the list 2, 3, 4.... and for
         # page 2 you get the list 3,4,5...)
-        if config["trail"] && !config["trail"].nil? && newpages.size.to_i.positive?
-          trail_before = [config["trail"]["before"].to_i, 0].max
-          trail_after = [config["trail"]["after"].to_i, 0].max
-          trail_length = trail_before + trail_after + 1
-
-          if trail_before.positive? || trail_after.positive?
-            newpages.select do |npage|
-              # Selecting the beginning of the trail
-              idx_start = [npage.paginator.page - trail_before - 1, 0].max
-              # Selecting the end of the trail
-              idx_end = [idx_start + trail_length, newpages.size.to_i].min
-
-              # Always attempt to maintain the max total of <trail_length> pages
-              # in the trail (it will look better if the trail doesn't shrink)
-              if idx_end - idx_start < trail_length
-                # Attempt to pad the beginning if we have enough pages
-                # Never go beyond the zero index
-                idx_start = [
-                  idx_start - (trail_length - (idx_end - idx_start)),
-                  0,
-                ].max
-              end
-
-              # Convert the newpages array into a two dimensional array that has
-              # [index, page_url] as items
-              npage.paginator.page_trail = newpages[idx_start...idx_end] \
-                .each_with_index.map do |ipage, idx|
-                PageTrail.new(
-                  idx_start + idx + 1,
-                  ipage.paginator.page_path,
-                  ipage.data["title"]
-                )
-              end
-            end
+        return unless config["trail"] && !config["trail"].nil? && newpages.size.to_i.positive?
+
+        trail_before = [config["trail"]["before"].to_i, 0].max
+        trail_after = [config["trail"]["after"].to_i, 0].max
+        trail_length = trail_before + trail_after + 1
+
+        return unless trail_before.positive? || trail_after.positive?
+
+        newpages.select do |npage|
+          # Selecting the beginning of the trail
+          idx_start = [npage.paginator.page - trail_before - 1, 0].max
+          # Selecting the end of the trail
+          idx_end = [idx_start + trail_length, newpages.size.to_i].min
+
+          # Always attempt to maintain the max total of <trail_length> pages
+          # in the trail (it will look better if the trail doesn't shrink)
+          if idx_end - idx_start < trail_length
+            # Attempt to pad the beginning if we have enough pages
+            # Never go beyond the zero index
+            idx_start = [
+              idx_start - (trail_length - (idx_end - idx_start)),
+              0,
+            ].max
+          end
+
+          # Convert the newpages array into a two dimensional array that has
+          # [index, page_url] as items
+          npage.paginator.page_trail = newpages[idx_start...idx_end] \
+            .each_with_index.map do |ipage, idx|
+            PageTrail.new(
+              idx_start + idx + 1,
+              ipage.paginator.page_path,
+              ipage.data["title"]
+            )
           end
         end
       end

data/lib/bridgetown-paginate/pagination_page.rb

@@ -11,15 +11,14 @@ module Bridgetown
     # not read from disk
     #
     class PaginationPage < Bridgetown::GeneratedPage
-      def initialize(page_to_copy, cur_page_nr, total_pages, index_pageandext, template_ext)
+      def initialize(page_to_copy, cur_page_nr, total_pages, index_pageandext, template_ext) # rubocop:disable Lint/MissingSuper
         @site = page_to_copy.site
         @base = ""
         @url = ""
         @name = index_pageandext.nil? ? "index#{template_ext}" : index_pageandext
         @path = page_to_copy.path
-
-        # Creates the basename and ext member values
-        process(@name)
+        @basename = File.basename(@path, ".*")
+        @ext = File.extname(@name)
 
         # Only need to copy the data part of the page as it already contains the
         # layout information
@@ -29,11 +28,7 @@ module Bridgetown
         # Store the current page and total page numbers in the pagination_info construct
         data["pagination_info"] = { "curr_page" => cur_page_nr, "total_pages" => total_pages }
 
-        # Perform some validation that is also performed in Bridgetown::Page
-        validate_data! page_to_copy.path
-        validate_permalink! page_to_copy.path
-
-        Bridgetown::Hooks.trigger :pages, :post_init, self
+        Bridgetown::Hooks.trigger :generated_pages, :post_init, self
       end
 
       # rubocop:disable Naming/AccessorMethodName

data/lib/bridgetown-paginate/paginator.rb

@@ -29,7 +29,7 @@ module Bridgetown
 
         if @page > @total_pages
           raise "page number can't be greater than total pages:" \
-            " #{@page} > #{@total_pages}"
+                " #{@page} > #{@total_pages}"
         end
 
         init = (@page - 1) * @per_page
@@ -63,7 +63,7 @@ module Bridgetown
         @documents = documents[init..offset]
         @page_path = Utils.format_page_number(this_page_url, cur_page_nr, @total_pages)
 
-        @previous_page = @page != 1 ? @page - 1 : nil
+        @previous_page = @page == 1 ? nil : @page - 1
         @previous_page_path = unless @page == 1
                                 if @page == 2
                                   Utils.format_page_number(
@@ -77,7 +77,7 @@ module Bridgetown
                                   )
                                 end
                               end
-        @next_page = @page != @total_pages ? @page + 1 : nil
+        @next_page = @page == @total_pages ? nil : @page + 1
         @next_page_path = if @page != @total_pages
                             Utils.format_page_number(
                               paginated_page_url, @next_page, @total_pages

data/lib/bridgetown-paginate/utils.rb

@@ -36,9 +36,8 @@ module Bridgetown
       #         If the input already has a dot in position zero, it will be
       #         returned unchanged.
       #
-      # path - a String path
-      #
-      # Returns the path with a leading slash
+      # @param path [String]
+      # @return [String] the path with a leading slash
       def self.ensure_leading_dot(path)
         path[0..0] == "." ? path : ".#{path}"
       end
@@ -47,29 +46,26 @@ module Bridgetown
       #         If the input already has a forward slash in position zero, it will be
       #         returned unchanged.
       #
-      # path - a String path
-      #
-      # Returns the path with a leading slash
+      # @param path [String]
+      # @return [String] the path with a leading slash
       def self.ensure_leading_slash(path)
         path[0..0] == "/" ? path : "/#{path}"
       end
 
-      # Static: Return a String version of the input without a leading slash.
-      #
-      # path - a String path
+      # Static: Return a String version of the input with only one leading slash.
       #
-      # Returns the input without the leading slash
-      def self.remove_leading_slash(path)
-        path[0..0] == "/" ? path[1..-1] : path
+      # @param path [String]
+      # @return [String] the input without the leading slash
+      def self.remove_double_slash(path)
+        path[0..1] == "//" ? path[1..-1] : path
       end
 
       # Static: Return a String version of the input which has a trailing slash.
       #         If the input already has a forward slash at the end, it will be
       #         returned unchanged.
       #
-      # path - a String path
-      #
-      # Returns the path with a trailing slash
+      # @param path [String]
+      # @return [String] the path with a trailing slash
       def self.ensure_trailing_slash(path)
         path[-1] == "/" ? path : "#{path}/"
       end
@@ -78,14 +74,10 @@ module Bridgetown
       # Sorting routine used for ordering posts by custom fields.
       # Handles Strings separately as we want a case-insenstive sorting
       #
-      # rubocop:disable Naming/MethodParameterName, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop:disable Naming/MethodParameterName, Metrics/CyclomaticComplexity
       def self.sort_values(a, b)
-        if a.nil? && !b.nil?
-          return -1
-        elsif !a.nil? && b.nil?
-          return 1
-        end
-
+        return -1 if a.nil? && !b.nil?
+        return 1 if !a.nil? && b.nil?
         return a.downcase <=> b.downcase if a.is_a?(String)
 
         if a.respond_to?("to_datetime") && b.respond_to?("to_datetime")
@@ -95,7 +87,7 @@ module Bridgetown
         # By default use the built in sorting for the data type
         a <=> b
       end
-      # rubocop:enable Naming/MethodParameterName, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop:enable Naming/MethodParameterName, Metrics/CyclomaticComplexity
 
       # Retrieves the given sort field from the given post
       # the sort_field variable can be a hierarchical value on the form

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-paginate
 version: !ruby/object:Gem::Version
-  version: 0.21.2
+  version: 1.0.0.alpha2
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 1.0.0.alpha2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 1.0.0.alpha2
 description: 
 email: maintainers@bridgetownrb.com
 executables: []
@@ -42,7 +42,7 @@ files:
 - lib/bridgetown-paginate/pagination_page.rb
 - lib/bridgetown-paginate/paginator.rb
 - lib/bridgetown-paginate/utils.rb
-homepage: https://github.com/bridgetownrb/bridgetown/tree/master/bridgetown-paginate
+homepage: https://github.com/bridgetownrb/bridgetown/tree/main/bridgetown-paginate
 licenses:
 - MIT
 metadata: {}
@@ -57,9 +57,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key: