jekyll-algolia 1.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 908e1efd4a59058e6114367dbac92298c5048fef
-  data.tar.gz: 2af6dc2c224934a0611a5552a9bc1f24166567ac
+  metadata.gz: eb9ad0518a59d9f4f5f1144dd0df8fe2353fa88c
+  data.tar.gz: 2f250877aec7171e74d72bbb18853920d9c02887
 SHA512:
-  metadata.gz: c59408616011d5e7588cdab5206d018d57cdc6f068dbf5cad43681b9e2f6f4aa2a0a8ce51495a867768ca004c63aa89639d6f11b0a3d081cc7d27c63d0a4c584
-  data.tar.gz: 2d540913e362d63fc91b4e20a95ee95754fe3746c66f35267d1944846837e825eb573fd138a7425beb4f4299d5c71eb64f3cd23931c5c46b94d8e833abc85914
+  metadata.gz: 2458c1300860126ad1f915cb591df1b6d764fb35808578810777f4814eb1cfe711cea28eba30d3b3334307970fa85259940fd3cc822cce024636b399bad446e4
+  data.tar.gz: 2352c7b494c6ef70e8fa90e25c55a2ec55962abe81c7d6e690ba430a1bdfe4e1f032ea9b3a43a9bfd8eb0a90b1f60ff29b37bcd2badea3b2b13672b1067c60ca

data/README.md

@@ -96,7 +96,7 @@ plugins.
 [6]: https://img.shields.io/badge/dynamic/json.svg?label=build%3Adevelop&query=value&uri=https%3A%2F%2Fimg.shields.io%2Ftravis%2Falgolia%2Fjekyll-algolia.json%3Fbranch%3Ddevelop
 [7]: https://img.shields.io/badge/dynamic/json.svg?label=coverage%3Adevelop&colorB=&prefix=&suffix=%25&query=$.coverage_change&uri=https%3A%2F%2Fcoveralls.io%2Fgithub%2Falgolia%2Fjekyll-algolia.json%3Fbranch%3Ddevelop
 [8]: #more-about-the-community-plan
-[9]: https://www.algolia.com/licensing
+[9]: https://www.algolia.com/api-keys
 [10]: https://www.algolia.com/users/sign_up/hacker
 [11]: https://community.algolia.com/instantsearch.js/
 [12]: https://www.algolia.com/press#resources

data/lib/errors/invalid_credentials.txt

@@ -1,10 +1,9 @@
-E: [✗ Error] Invalid credentials
+E:[✗ Error] Invalid credentials
 E:
-E: The jekyll-algolia plugin could not connect to your application ID using the 
-E: API key your provided.
+E:The jekyll-algolia plugin could not connect to your application ID using the API key your provided.
 W:
-W: Make sure your API key has access to your {application_id} application.
+W:Make sure your API key has access to your {application_id} application.
 I:
-I: You can find your API key in your Algolia dashboard here:
-I:    https://www.algolia.com/licensing
+I:You can find your API key in your Algolia dashboard here:
+I:   https://www.algolia.com/licensing
 I:

data/lib/errors/invalid_index_name.txt

@@ -1,11 +1,9 @@
-E: [✗ Error] Invalid index name
+E:[✗ Error] Invalid index name
 E:
-E: The jekyll-algolia plugin could push records to your index as its name
-E: contains invalid characters.
+E:The jekyll-algolia plugin could push records to your index as its name contains invalid characters.
 W:
-W: Some special characters are not allowed in the naming of indices and your
-W: index {index_name} contains some of them.
+W:Some special characters are not allowed in the naming of indices and your index {index_name} contains some of them.
 I:
-I: Please, check our FAQ for more details:
-I:   https://www.algolia.com/doc/faq/index-configuration/what-can-i-name-my-indices/
+I:Please, check our FAQ for more details:
+I:  https://www.algolia.com/doc/faq/index-configuration/what-can-i-name-my-indices/
 I:

data/lib/errors/missing_api_key.txt

@@ -1,17 +1,15 @@
-E: [✗ Error] Missing API key
+E:[✗ Error] Missing API key
 E:
-E: The jekyll-algolia plugin could not find your API key.
+E:The jekyll-algolia plugin could not find your API key.
 W:
-W: Please, define your API key either by:
+W:Please, define your API key either by:
 W:
-W: 1/ Defining an ENV variable when calling `jekyll algolia`
-W:    $ ALGOLIA_API_KEY='{your_api_key}' jekyll algolia
+W:1/ Defining an ENV variable when calling `jekyll algolia`
+W:   $ ALGOLIA_API_KEY='{your_api_key}' jekyll algolia
 W:
-W: 2/ Save your API key in a named `_algolia_api_key` in your source directory.
-W:    If you do this, we strongly recommend you to NOT track this file in your
-W:    versionning system.
-I:
-I: You can find your API key in your Algolia dashboard here:
-I:    https://www.algolia.com/licensing
+W:2/ Save your API key in a named `_algolia_api_key` in your source directory.
+W:   If you do this, we strongly recommend you to NOT track this file in your versionning system.
 I:
+I:You can find your API key in your Algolia dashboard here:
+I:   https://www.algolia.com/api-keys
 I:

data/lib/errors/missing_application_id.txt

@@ -1,12 +1,11 @@
-E: [✗ Error] No application ID defined
+E:[✗ Error] No application ID defined
 E:
-E: The jekyll-algolia plugin could not find your Algolia application ID.
+E:The jekyll-algolia plugin could not find your Algolia application ID.
 W:
-W: Please, define it in your Jekyll _config.yml file like this:
+W:Please, define it in your Jekyll _config.yml file like this:
 W:
-W:   algolia:
-W:    application_id: {your_application_id}
+W:  algolia:
+W:    application_id: {your_application_id}
 I:
-I: You can find your application ID along with all your credentials in your 
-I: Algolia dashboard here:
-I:    https://www.algolia.com/licensing
+I:You can find your application ID along with all your credentials in your Algolia dashboard here:
+I:   https://www.algolia.com/api-keys

data/lib/errors/missing_index_name.txt

@@ -1,19 +1,18 @@
-E: [✗ Error] No index name defined
+E:[✗ Error] No index name defined
 E:
-E: The jekyll-algolia plugin could not find the name of the Algolia index you 
-E: want to push your records to.
+E:The jekyll-algolia plugin could not find the name of the Algolia index you want to push your records to.
 W:
-W: Please, define it in your Jekyll _config.yml file like this:
+W:Please, define it in your Jekyll _config.yml file like this:
 W:
-W:   algolia:
-W:    index_name: {your_index_name}
+W:  algolia:
+W:   index_name: {your_index_name}
 W:
-W: Alternatively, you can also define it as an ENV variable, like this:
+W:Alternatively, you can also define it as an ENV variable, like this:
 W:
-W:   $ ALGOLIA_INDEX_NAME='{your_index_name}' jekyll algolia 
+W:  $ ALGOLIA_INDEX_NAME='{your_index_name}' jekyll algolia 
 W:
-I: You can see all your indices from your Algolia dashboard here:
-I:   https://www.algolia.com/explorer
+I:You can see all your indices from your Algolia dashboard here:
+I:  https://www.algolia.com/explorer
 I:
-I: Note that you don't have to create an index before pushing records.
-I: It will be created automatically if it does not exist yet.
+I:Note that you don't have to create an index before pushing records.
+I:It will be created automatically if it does not exist yet.

data/lib/errors/no_records_found.txt

@@ -1,20 +1,14 @@
-E: [✗ Error] No records found
+E:[✗ Error] No records found
 E:
-E: The jekyll-algolia plugin could find any records to index
+E:The jekyll-algolia plugin could find any records to index
 W:
-W: The plugin tried to extract records from the pages, posts and collections of
-W: your site but could not find anything to index.
+W:The plugin tried to extract records from the pages, posts and collections of your site but could not find anything to index.
 I:
-I: Make sure you did not exclude too many files from indexing using the
-I: `files_to_exclude` option. You are currently excluding the following files:
-I:     {files_to_exclude}
+I:Make sure you did not exclude too many files from indexing using the `files_to_exclude` option. You are currently excluding the following files:
+I:    {files_to_exclude}
 I:
-I: Also double check that your current value for `nodes_to_index` can actually
-I: match something in the pages. You are current indexing the following nodes:
-I:     {nodes_to_index}
+I:Also double check that your current value for `nodes_to_index` can actually match something in the pages. You are current indexing the following nodes:
+I:    {nodes_to_index}
 I:
-I: Note that all the markup that is defined in the layouts won't be available 
-I: during extraction. Only the page content can be accessed. So if you defined
-I: a layout markup that is used only for one page, you should move it to the 
-I: page instead.
+I:Note that all the markup that is defined in the layouts won't be available during extraction. Only the page content can be accessed. So if you defined a layout markup that is used only for one page, you should move it to the page instead.
 I:

data/lib/errors/record_too_big.txt

@@ -1,27 +1,22 @@
-E: [✗ Error] Record is too big
+E:[✗ Error] Record is too big
 E:
-E: The jekyll-algolia plugin could not push one of your records as it exceeds 
-E: the {size_limit} size limit.
+E:The jekyll-algolia plugin could not push one of your records as it exceeds the {size_limit} size limit.
 W:
-W: The plugin will create one record for each element matching your
-W: `nodes_to_index` value (currently set to "{nodes_to_index}"). Each record
-W: should not weight more than {size_limit}. 
-W: One of your records weights {size} and has been rejected.
+W:The plugin will create one record for each element matching your `nodes_to_index` value (currently set to "{nodes_to_index}"). 
+W:Each record should not weight more than {size_limit}.
+W:One of your records weights {size} and has been rejected.
 W:
-W: objectID: {object_id}
-W: title:    {object_title}
-W: url:      {object_url}
+W:objectID: {object_id}
+W:title:    {object_title}
+W:url:      {object_url}
 W:
-W: Most probable keys causing the issue:
-W:    {probable_wrong_keys}
+W:Most probable keys causing the issue:
+W:   {probable_wrong_keys}
 W:
-W: Complete log of the record has been extracted to:
-W:    {record_log_path}
-W: 
-I: This issue can be caused by malformed HTML preventing the parser to correctly
-I: grab the content of the nodes. Double check that the page actually renders 
-I: correctly with a regular `jekyll build`.
+W:Complete log of the record has been extracted to:
+W:   {record_log_path}
+W:
+I:This issue can be caused by malformed HTML preventing the parser to correctly grab the content of the nodes. Double check that the page actually renders correctly with a regular `jekyll build`.
 I:
-I: If you're having trouble solving this issue, feel free to file a bug on
-I: GitHub, ideally with a link to a repository where we can reproduce the issue.
-I:    https://github.com/algolia/jekyll-algolia/issues
+I:If you're having trouble solving this issue, feel free to file a bug on GitHub, ideally with a link to a repository where we can reproduce the issue.
+I:  https://github.com/algolia/jekyll-algolia/issues

data/lib/errors/settings_manually_edited.txt

@@ -0,0 +1,17 @@
+I:
+W:[jekyll-algolia] Configuration mismatch:
+W:It seems that your index settings have been edited from outside of the jekyll-algolia plugin.
+I:
+I:This can happen if you manually edited them from the Algolia dashboard, for example. Don't worry, they will still be honored (for now).
+I:
+I:Still, we strongly encourage you to save any custom config inside the algolia.settings key of your _config.yml instead. Any value set there will always take precedence over anything you manually set in your dashboard.
+I:This is the best way to be sure your settings won't be lost in the future.
+I:
+W:To keep your current custom config, here is what you should add to your _config.yml file:
+W:
+W:algolia:
+W:  settings:
+{settings}
+I:
+I:If you'd like to revert your index to its default settings, the best way is to delete the index and run `jekyll algolia` again.
+I:

data/lib/errors/unknown_application_id.txt

@@ -1,20 +1,16 @@
-E: [✗ Error] Unreachable server
+E:[✗ Error] Unreachable server
 E:
-E: The jekyll-algolia plugin could not contact the server hosting your 
-E: application.
+E:The jekyll-algolia plugin could not contact the server hosting your application.
 W:
-W: Make sure you correctly typed your application ID. As we are using the
-W: application ID as part of the server url, any typo in the application ID will
-W: prevent us from reaching your server.
+W:Make sure you correctly typed your application ID. As we are using the application ID as part of the server url, any typo in the application ID will prevent us from reaching your server.
 W:
-I: Here is the application ID you defined: {application_id}
+I:Here is the application ID you defined: {application_id}
 I:
-I: Make sure it's the same as the one displayed in your dashboard:
-I:    https://www.algolia.com/licensing
+I:Make sure it's the same as the one displayed in your dashboard:
+I:   https://www.algolia.com/api-keys
 I:
-I: Then, define it in your Jekyll _config.yml file like this:
-I:
-I:   algolia:
-I:    application_id: {your_application_id}
+I:Then, define it in your Jekyll _config.yml file like this:
 I:
+I:  algolia:
+I:    application_id: {your_application_id}
 I:

data/lib/errors/unknown_settings.txt

@@ -1,15 +1,12 @@
-E: [✗ Error] Unknown setting
+E:[✗ Error] Unknown setting
 E:
-E: The jekyll-algolia plugin could not correctly configure your index as some of
-E: the settings passed are not recognized.
+E:The jekyll-algolia plugin could not correctly configure your index as some of the settings passed are not recognized.
 W:
-W: It seems that one of the custom index settings you defined was not recognized
-W: by the API and was rejected:
-W:   {setting_name}: {setting_value}
+W:It seems that one of the custom index settings you defined was not recognized by the API and was rejected:
+W:  {setting_name}: {setting_value}
 I:
-I: Make sure the setting name and value are correct. You can find a list of all
-I: the available settings with their documentation in our API reference:
-I:   https://www.algolia.com/doc/api-reference/api-parameters/
-I: Or specifically for this setting:
-I:  https://www.algolia.com/doc/api-reference/api-parameters/{setting_name}/
+I:Make sure the setting name and value are correct. You can find a list of all the available settings with their documentation in our API reference:
+I:  https://www.algolia.com/doc/api-reference/api-parameters/
+I:Or specifically for this setting:
+I:  https://www.algolia.com/doc/api-reference/api-parameters/{setting_name}/
 I:

data/lib/jekyll-algolia.rb

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 
 require 'jekyll/commands/algolia'
+require 'jekyll/algolia/overwrites'
 require 'date'
 
 module Jekyll
   # Requirable file, loading all dependencies.
   # Methods here are called by the main `jekyll algolia` command
   module Algolia
-    require 'jekyll/algolia/version'
-    require 'jekyll/algolia/utils'
-    require 'jekyll/algolia/hooks'
     require 'jekyll/algolia/configurator'
-    require 'jekyll/algolia/logger'
     require 'jekyll/algolia/error_handler'
-    require 'jekyll/algolia/file_browser'
     require 'jekyll/algolia/extractor'
+    require 'jekyll/algolia/file_browser'
+    require 'jekyll/algolia/hooks'
     require 'jekyll/algolia/indexer'
+    require 'jekyll/algolia/logger'
+    require 'jekyll/algolia/progress_bar'
+    require 'jekyll/algolia/utils'
+    require 'jekyll/algolia/version'
 
     # Public: Init the Algolia module
     #
@@ -25,7 +27,6 @@ module Jekyll
     # The gist of the plugin works by instanciating a Jekyll site,
     # monkey-patching its `write` method and building it.
     def self.init(config = {})
-      @start_time = Time.now
       config = Configurator.init(config).config
       @site = Jekyll::Algolia::Site.new(config)
 
@@ -62,43 +63,121 @@ module Jekyll
       @site
     end
 
-    # Public: Get access to the time at which the command was run
-    #
-    # Jekyll will always set the updated time of pages to the time of the build
-    # run. The plugin needs those values to stay at nil if they did not change,
-    # so we'll keep track of the time at build time and revert any page build at
-    # that time to nil.
-    def self.start_time
-      @start_time
-    end
-
-    # A Jekyll::Site subclass that overrides #write from the parent class to
+    # A Jekyll::Site subclass that overrides process from the parent class to
     # create JSON records out of rendered documents and push those records to
     # Algolia instead of writing files to disk.
     class Site < Jekyll::Site
-      # We make the cleanup method a noop, otherwise it will remove excluded
-      # files from destination
-      def cleanup; end
+      # We expose a way to reset the collection, as it will be needed in the
+      # tests
+      attr_writer :collections
+
+      # Public: Overwriting the parent method
+      #
+      # This will prepare the website, gathering all files, excluding the one we
+      # don't need to index, then render them (converting to HTML), the finally
+      # calling `push` to push to Algolia
+      def process
+        # Default Jekyll preflight
+        reset
+        read
+        generate
+
+        # Removing all files that won't be indexed, so we don't waste time
+        # rendering them
+        keep_only_indexable_files
+
+        # Starting the rendering progress bar
+        init_rendering_progress_bar
+
+        # Converting them to HTML
+        render
+
+        # Pushing them Algolia
+        push
+      end
+
+      # Public: Return the number of pages/documents to index
+      def indexable_item_count
+        count = @pages.length
+        @collections.each_value { |collection| count += collection.docs.length }
+        count
+      end
+
+      # Public: Init the rendering progress bar, incrementing it for each
+      # rendered item
+      #
+      # This uses Jekyll post_render hooks, listening to both pages and
+      # documents
+      def init_rendering_progress_bar
+        progress_bar = ProgressBar.create(
+          total: indexable_item_count,
+          format: 'Rendering to HTML (%j%%) |%B|'
+        )
+        Jekyll::Hooks.register :pages, :post_render do |_|
+          progress_bar.increment
+        end
+
+        Jekyll::Hooks.register :documents, :post_render do |_|
+          progress_bar.increment
+        end
+      end
 
-      def write
+      # Public: Filtering a list of items to only keep the one that are
+      # indexable.
+      #
+      # items - List of Pages/Documents
+      #
+      # Note: It also sets the layout to nil, to further speed up the rendering
+      def indexable_list(items)
+        new_list = []
+        items.each do |item|
+          next unless FileBrowser.indexable?(item)
+
+          item.data = {} if item.data.nil?
+          item.data['layout'] = nil
+          new_list << item
+        end
+        new_list
+      end
+
+      # Public: Removing non-indexable Pages, Posts and Documents from the
+      # internals
+      def keep_only_indexable_files
+        @pages = indexable_list(@pages)
+
+        # Applying to each collections
+        @collections.each_value do |collection|
+          collection.docs = indexable_list(collection.docs)
+        end
+
+        # Remove all static files
+        @static_files = []
+      end
+
+      # Public: Extract records from every file and index them
+      def push
         records = []
         files = []
-        Logger.log('I:Extracting records...')
+        progress_bar = ProgressBar.create(
+          total: indexable_item_count,
+          format: 'Extracting records (%j%%) |%B|'
+        )
         each_site_file do |file|
-          path = FileBrowser.relative_path(file)
+          # Even if we cleared the list of documents/pages beforehand, some
+          # files might still sneak up to this point (like static files added to
+          # a collection directory), so we check again if they can really be
+          # indexed.
+          next unless FileBrowser.indexable?(file)
 
-          # Skip files that should not be indexed
-          is_indexable = FileBrowser.indexable?(file)
-          unless is_indexable
-            Logger.verbose("W:Skipping #{path}")
-            next
-          end
+          path = FileBrowser.relative_path(file.path)
 
           Logger.verbose("I:Extracting records from #{path}")
           file_records = Extractor.run(file)
 
           files << file
           records += file_records
+
+          progress_bar.increment
         end
 
         # Applying the user hook on the whole list of records