bridgetown-paginate 0.17.0 → 0.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e1361d6ef9ab7a62d2bd9e120ea5a8575df45e672653c0ef0d0ef08886b1e1c
-  data.tar.gz: 6dc5d22a0b3ae30a961d152d9874893309270ace5cda0bec22cffe01ce414389
+  metadata.gz: 634a074156ee472cd73b4649d7543306574ac5abe84f22b196212fbdb5600338
+  data.tar.gz: 915d9ddf67cf8f66ba9c10b1fd613a18652af6c134e00d3fd330cc84fbba09ee
 SHA512:
-  metadata.gz: d8afb3866ea19f069eff38325eb9418d3d3dbab85752973d5eaf8126f1c39d964520ee986bad141e40382ea62935f1438cc62be91e409ae514e572dcdca74811
-  data.tar.gz: 59a35d4fef872ed87299e58f2e25f32dfd40559e636632f15c9c9184e3c757222eaf0e6f327d1d1e96a4b629077f3ca4dd662efd4bd888020a004e7d7b7871bf
+  metadata.gz: 3666647fb444338b9cc1687494e05785c73110a821f4b90e26ccb4937b788aec416cd787e6b8f4c013369e25711848ce250f2da8e5fcdf7c90261859ab4b460e
+  data.tar.gz: '03795927374dcd4297c29c0cfe6e564ff07f6c686635c273590cb11a96f99887009f25df4bf448b704519f410a2ea60e81c5878d5e8cf732502461b46e985577'

data/.rubocop.yml

@@ -12,13 +12,6 @@ Bridgetown/NoPutsAllowed:
 Layout/CommentIndentation:
   Exclude:
     - lib/bridgetown-paginate/defaults.rb
-Metrics/AbcSize:
-  Exclude:
-    - lib/bridgetown-paginate/pagination_generator.rb
-    - lib/bridgetown-paginate/pagination_indexer.rb
-    - lib/bridgetown-paginate/pagination_model.rb
-    - lib/bridgetown-paginate/pagination_page.rb
-    - lib/bridgetown-paginate/paginator.rb
 Metrics/BlockNesting:
   Exclude:
     - lib/bridgetown-paginate/pagination_model.rb

data/lib/bridgetown-paginate/pagination_generator.rb

@@ -27,7 +27,7 @@ module Bridgetown
       # site - The Site.
       #
       # Returns nothing.
-      def generate(site)
+      def generate(site) # rubocop:todo Metrics/AbcSize
         # Retrieve and merge the pagination configuration from the site yml file
         default_config = Bridgetown::Utils.deep_merge_hashes(
           DEFAULT,

data/lib/bridgetown-paginate/pagination_indexer.rb

@@ -17,7 +17,7 @@ module Bridgetown
       # Create a hash index for all documents based on a key in the
       # document.data table
       #
-      def self.index_documents_by(all_documents, index_key)
+      def self.index_documents_by(all_documents, index_key) # rubocop:todo Metrics/AbcSize
         return nil if all_documents.nil?
         return all_documents if index_key.nil?
 

data/lib/bridgetown-paginate/pagination_model.rb

@@ -30,7 +30,7 @@ module Bridgetown
       end
 
       # rubocop:disable Metrics/BlockLength
-      def run(default_config, templates, site_title)
+      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  enabled: true' to the front-matter of a page.", "warn"
@@ -142,7 +142,7 @@ module Bridgetown
       end
 
       # rubocop:disable Layout/LineLength
-      def _debug_print_config_info(config, page_path)
+      def _debug_print_config_info(config, page_path) # rubocop:todo Metrics/AbcSize
         r = 20
         f = "Pagination: ".rjust(20)
         # Debug print the config
@@ -185,6 +185,7 @@ module Bridgetown
       # template - The index.html Page that requires pagination.
       # config - The configuration settings that should be used
       #
+      # rubocop:todo Metrics/AbcSize
       def paginate(template, config, site_title, documents_payload)
         # By default paginate on all posts in the site
         using_posts = documents_payload[:posts]
@@ -311,7 +312,7 @@ module Bridgetown
 
         # Now for each pagination page create it and configure the ranges for
         # the collection
-        # The .pager member is a built in thing in Bridgetown and references the
+        # The .paginator member is a built in thing in Bridgetown and references the
         # paginator implementation
         # rubocop:disable Metrics/BlockLength
         (1..total_pages).each do |cur_page_nr|
@@ -338,9 +339,10 @@ module Bridgetown
                                  end
           paginated_page_url = File.join(first_index_page_url, paginated_page_url)
 
-          # 3. Create the pager logic for this page, pass in the prev and next
-          # page numbers, assign pager to in-memory page
-          newpage.pager = Paginator.new(
+          # 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(
             config["per_page"],
             first_index_page_url,
             paginated_page_url,
@@ -353,17 +355,17 @@ module Bridgetown
 
           # Create the url for the new page, make sure we prepend any permalinks
           # that are defined in the template page before
-          if newpage.pager.page_path.end_with? "/"
-            newpage.set_url(File.join(newpage.pager.page_path, index_page_with_ext))
-          elsif newpage.pager.page_path.end_with? index_page_ext.to_s
+          if newpage.paginator.page_path.end_with? "/"
+            newpage.set_url(File.join(newpage.paginator.page_path, index_page_with_ext))
+          elsif newpage.paginator.page_path.end_with? index_page_ext.to_s
             # Support for direct .html files
-            newpage.set_url(newpage.pager.page_path)
+            newpage.set_url(newpage.paginator.page_path)
           else
             # Support for extensionless permalinks
-            newpage.set_url(newpage.pager.page_path + index_page_ext.to_s)
+            newpage.set_url(newpage.paginator.page_path + index_page_ext.to_s)
           end
 
-          newpage.data["permalink"] = newpage.pager.page_path if template.data["permalink"]
+          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"]
@@ -416,7 +418,7 @@ module Bridgetown
           if trail_before.positive? || trail_after.positive?
             newpages.select do |npage|
               # Selecting the beginning of the trail
-              idx_start = [npage.pager.page - trail_before - 1, 0].max
+              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
 
@@ -433,11 +435,11 @@ module Bridgetown
 
               # Convert the newpages array into a two dimensional array that has
               # [index, page_url] as items
-              npage.pager.page_trail = newpages[idx_start...idx_end] \
+              npage.paginator.page_trail = newpages[idx_start...idx_end] \
                 .each_with_index.map do |ipage, idx|
                 PageTrail.new(
                   idx_start + idx + 1,
-                  ipage.pager.page_path,
+                  ipage.paginator.page_path,
                   ipage.data["title"]
                 )
               end
@@ -445,6 +447,7 @@ module Bridgetown
           end
         end
       end
+      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/bridgetown-paginate/pagination_page.rb

@@ -11,6 +11,7 @@ module Bridgetown
     # not read from disk
     #
     class PaginationPage < Bridgetown::Page
+      # rubocop:todo Metrics/AbcSize
       def initialize(page_to_copy, cur_page_nr, total_pages, index_pageandext, template_ext)
         @site = page_to_copy.site
         @base = ""
@@ -44,6 +45,7 @@ module Bridgetown
 
         Bridgetown::Hooks.trigger :pages, :post_init, self
       end
+      # rubocop:enable Metrics/AbcSize
 
       # rubocop:disable Naming/AccessorMethodName
       def set_url(url_value)

data/lib/bridgetown-paginate/paginator.rb

@@ -13,7 +13,7 @@ module Bridgetown
 
       # Initialize a new Paginator.
       #
-      def initialize(
+      def initialize( # rubocop:todo Metrics/AbcSize
         config_per_page,
         first_index_page_url,
         paginated_page_url,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-paginate
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.3
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-11-01 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.17.0
+        version: 0.18.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.3
 description: 
 email: maintainers@bridgetownrb.com
 executables: []
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A Bridgetown plugin to add pagination support for posts and collection indices.