bridgetown-paginate 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ece4df58f98cea6fa950bb3c3ca63cb89c6dbbac4bf00a0b2e12eed31cf91b8e
-  data.tar.gz: b967004c16729ed3f95bd07902774e6435b4740d9e4444734dd356b61ae35d7e
+  metadata.gz: 0d6aa1e6cf2b4880395481df0e3925fbe91d7287d0e522d359ac4ffcc0081620
+  data.tar.gz: c00d22eb1292f72a25d1699cecf44d53d97c1668371316816eceb378f3c7e47d
 SHA512:
-  metadata.gz: 53e202734aaaa86f82443da095b490f9d2b92cd96778d6329c78537dbdace78b9b7b062257ee3db4dabe030fcd9d33ce97b3c950a8208b9d34d25c898b5526b7
-  data.tar.gz: 37abe6427f2ceeac8bbc2c3c38e372ad1de4cfad4b425709aa5420fd356a2f9fef9d84d79ac5ea9f2da6f888c000a03b5385f3818a9b6543bc5153aca6095ad2
+  metadata.gz: 9a589e35afb76a43eb0d0b32e498f0431c1ad2b4511c616f2128ae06c0df62c1db543cc4bbfcc712db72f143e553dd6a67d2f93841102d9e22e2b4468ddbf2e6
+  data.tar.gz: 73785fe0c2d0327519b170d71b54f77231fabb2e38a227f6f52bf0afcf542fdd82afb36ca22194eacea6dc115e26c64521ca843a8afd03b1649537d585caa805

data/lib/bridgetown-paginate/pagination_generator.rb

@@ -27,7 +27,8 @@ module Bridgetown
 
           # If disabled then simply quit
           unless default_config["enabled"]
-            Bridgetown.logger.info "Pagination:", "Disabled in site.config."
+            Bridgetown.logger.info "Pagination:", "disabled. Enable in site config" \
+              " with pagination:\\n  enabled: true"
             return
           end
 

data/lib/bridgetown-paginate/pagination_indexer.rb

@@ -16,6 +16,9 @@ module Bridgetown
           return nil if all_documents.nil?
           return all_documents if index_key.nil?
 
+          # Where queries are a key/value pair, so grab the first key element
+          index_key = index_key[0] if index_key.is_a?(Array)
+
           index = {}
           all_documents.each do |document|
             next if document.data.nil?
@@ -84,6 +87,9 @@ module Bridgetown
           # values that should be filtered on)
           config_value = config[config_key]
 
+          # Use the second key/value element if it's a "where query"
+          config_value = config_value[1] if config_key == "where_query"
+
           # If we're dealing with a delimitered string instead of an array then
           # let's be forgiving
           config_value = config_value.split(%r!;|,!) if config_value.is_a?(String)
@@ -91,6 +97,8 @@ module Bridgetown
           # Now for all filter values for the config key, let's remove all items
           # from the documents that aren't common for all collections that the
           # user wants to filter on
+          # TODO: right now this is an "AND" operation if multiple keys are present.
+          # Should offer the ability to do an OR operation instead.
           config_value.each do |key|
             key = key.to_s.downcase.strip
             documents = PaginationIndexer.intersect_arrays(documents, source_documents[key])

data/lib/bridgetown-paginate/pagination_model.rb

@@ -30,14 +30,14 @@ module Bridgetown
           @collection_by_name_lambda = collection_by_name_lambda
         end
 
+        # rubocop:disable Metrics/BlockLength
         def run(default_config, site_pages, site_title)
           # By default if pagination is enabled we attempt to find all index.html
           # pages in the site
           templates = discover_paginate_templates(site_pages)
           if templates.size.to_i <= 0
-            @logging_lambda.call "Is enabled, but I couldn't find any pagination page." \
-              " Skipping pagination. Pages must have 'pagination: enabled: true'" \
-              " in their front-matter for pagination to work.", "warn"
+            @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"
             return
           end
 
@@ -71,6 +71,21 @@ module Bridgetown
                 all_tags = PaginationIndexer.index_documents_by(all_posts, "tags")
                 all_locales = PaginationIndexer.index_documents_by(all_posts, "locale")
 
+                # Load in custom query index, if specified
+                all_where_matches = if template_config["where_query"]
+                                      PaginationIndexer.index_documents_by(
+                                        all_posts, template_config["where_query"]
+                                      )
+                                    end
+
+                documents_payload = {
+                  posts: all_posts,
+                  tags: all_tags,
+                  categories: all_categories,
+                  locales: all_locales,
+                  where_matches: all_where_matches,
+                }
+
                 # TODO: NOTE!!! This whole request for posts and indexing results
                 # could be cached to improve performance, leaving like this for
                 # now during testing
@@ -80,10 +95,7 @@ module Bridgetown
                   template,
                   template_config,
                   site_title,
-                  all_posts,
-                  all_tags,
-                  all_categories,
-                  all_locales
+                  documents_payload
                 )
               end
             end
@@ -92,6 +104,7 @@ module Bridgetown
           # Return the total number of templates found
           templates.size.to_i
         end
+        # rubocop:enable Metrics/BlockLength
 
         # Returns the combination of all documents in the collections that are
         # specified
@@ -175,17 +188,9 @@ module Bridgetown
         # template - The index.html Page that requires pagination.
         # config - The configuration settings that should be used
         #
-        def paginate(
-          template,
-          config,
-          site_title,
-          all_posts,
-          all_tags,
-          all_categories,
-          all_locales
-        )
+        def paginate(template, config, site_title, documents_payload)
           # By default paginate on all posts in the site
-          using_posts = all_posts
+          using_posts = documents_payload[:posts]
 
           # Now start filtering out any posts that the user doesn't want included
           # in the pagination
@@ -194,26 +199,43 @@ module Bridgetown
             config,
             "category",
             using_posts,
-            all_categories
+            documents_payload[:categories]
           )
           _debug_print_filtering_info("Category", before, using_posts.size.to_i)
+
           before = using_posts.size.to_i
           using_posts = PaginationIndexer.read_config_value_and_filter_documents(
             config,
             "tag",
             using_posts,
-            all_tags
+            documents_payload[:tags]
           )
           _debug_print_filtering_info("Tag", before, using_posts.size.to_i)
+
           before = using_posts.size.to_i
           using_posts = PaginationIndexer.read_config_value_and_filter_documents(
             config,
             "locale",
             using_posts,
-            all_locales
+            documents_payload[:locales]
           )
           _debug_print_filtering_info("Locale", before, using_posts.size.to_i)
 
+          if config["where_query"]
+            before = using_posts.size.to_i
+            using_posts = PaginationIndexer.read_config_value_and_filter_documents(
+              config,
+              "where_query",
+              using_posts,
+              documents_payload[:where_matches]
+            )
+            _debug_print_filtering_info(
+              "Where Query (#{config["where_query"]})",
+              before,
+              using_posts.size.to_i
+            )
+          end
+
           # Apply sorting to the posts if configured, any field for the post is
           # available for sorting
           if config["sort_field"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-paginate
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2020-04-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.8.1
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.0
 description: 
 email: maintainers@bridgetownrb.com
 executables: []