bridgetown-paginate 0.21.1 → 1.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73658b671ce99dcb98aaac7ed5cae7b2d00be40cba39cdfb5c2736a802028c05
-  data.tar.gz: 49a274756b395c33b7645420de58d1bf9ae2192021937b8b47253d295d231d09
+  metadata.gz: 1503605e813afc4d2b3fa331033a8a2f6a41066a88cf83432eb065e93c5fbdb0
+  data.tar.gz: e8078cbed32a2d3b6af6044dae34944d4019935865edda9d222fb03779296c79
 SHA512:
-  metadata.gz: 0cc12d7f28da3ebe4fd35564d747e5d0c23ab85e5694bfd62e813448207824cf37de3a9c2180ea5430975e3df7ff2de94b65b9d36246fb070ae63c82fa5ef1db
-  data.tar.gz: 83e2e18c1b007f730fc8e8e984ed9b831f84866a413672c6c2986be4cd34af754acb32d2cbda78188aee29ceafd42a283f14c7c6cc5b82cf763b167b6dd36378
+  metadata.gz: 3e5fd22e0b2f291ea3be6921134fce48d384b39163b08dfc5f8b63ddc8ba0ca531e44db48b7919bce5c2db2c7799240f5dd19eea309e7962cb83d106be0d9282
+  data.tar.gz: 5fefc5e0d4384942edaabac5b26fa97abd260e47b42abc61c0ec6686f92624dceb802e0833058a4208e4470d3383a8ab5914d6c3e5a9018fa0c8f77c238762ca

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,7 +32,6 @@ module Bridgetown
           DEFAULT,
           site.config["pagination"] || {}
         )
-        default_config["collection"] = "posts" unless site.uses_resource?
 
         # If disabled then simply quit
         unless default_config["enabled"]
@@ -44,7 +43,7 @@ module Bridgetown
         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,7 +95,7 @@ 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
 

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
@@ -50,13 +50,18 @@ 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
 
@@ -340,13 +345,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,

data/lib/bridgetown-paginate/pagination_page.rb

@@ -17,9 +17,8 @@ module Bridgetown
         @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/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.
+      # Static: Return a String version of the input with only one leading slash.
       #
-      # path - a String path
-      #
-      # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-paginate
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 1.0.0.alpha1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-19 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.1
+        version: 1.0.0.alpha1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 1.0.0.alpha1
 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: