jekyll-algolia 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3612f58d87d7a769325fb89b2e76ea707278083a
-  data.tar.gz: 3a9e7d91f9183086831d2b276b7fd9e980fcd55a
+  metadata.gz: 2de0f9bc4ac08d49c4f78093c469d778b1d69001
+  data.tar.gz: dcce0aafc47b6661063e645f03bed64b3cc849d9
 SHA512:
-  metadata.gz: ac705f398e1afc3db83611145a1070f713fffa6b5b51c34ef1dd8d257aad4aa3004dd2bc012234cbe88012cbe3cb594a32ceec1e108803c2566d8341cef536ac
-  data.tar.gz: 3b2728420b29fbef3e8cbf258c355e84760f46657b7cdcf76d9c1f48eec48cd2192e373f23b9fcdd5206747e3262c5c9a5adbae9b8c58b80ee08efc2522317e4
+  metadata.gz: 8c898016647a648a10d3aeaa270aeca5257399a47a124e55902581ae935cedab196295204f6e4177d58b4a56b544fd54f9825b8dc7198995fa2dfa367de1c875
+  data.tar.gz: 486d9709cd1de0ed485d921e2c22640776c36fc7d45edabceff1f45e9f50f65879b7e0971daa9d038ffbe5d8e5143bb256cd00429203f0590c17a243eba25bca

data/README.md

@@ -19,7 +19,7 @@ This will push the content of your Jekyll website to your Algolia index.
 ## Documentation
 
 Full documentation can be found on
-[https://community.algolia.com/jekyll-algolia/](https://community.algolia.com/jekyll-algolia/)
+[https://community.algolia.com/jekyll-algolia/](https://community.algolia.com/jekyll-algolia/getting-started.html)
 
 ## Installation
 

data/lib/jekyll-algolia.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'jekyll/commands/algolia'
+require 'date'
 
 module Jekyll
   # Requirable file, loading all dependencies.
@@ -27,10 +28,17 @@ module Jekyll
     # monkey-patching its `write` method and building it.
     def self.init(config = {})
       @config = config
+      @start_time = Time.now
       @site = Jekyll::Algolia::Site.new(@config)
 
       exit 1 unless Configurator.assert_valid_credentials
 
+      if Configurator.dry_run?
+        Logger.log('W:==== THIS IS A DRY RUN ====')
+        Logger.log('W:  - No records will be pushed to your index')
+        Logger.log('W:  - No settings will be updated on your index')
+      end
+
       self
     end
 
@@ -43,6 +51,7 @@ module Jekyll
     # Note: The internal list of files to be processed will only be created when
     # calling .process
     def self.run
+      Logger.log('I:Processing site...')
       @site.process
     end
 
@@ -61,19 +70,23 @@ module Jekyll
       @site
     end
 
+    # Public: Get access to the time at which the command was run
+    #
+    # Jekyll will override some date with the current time, and we'll need to
+    # keep them as nil, so we have to compare to this date to assume it has been
+    # overwritten
+    def self.start_time
+      @start_time
+    end
+
     # A Jekyll::Site subclass that overrides #write 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
       def write
-        if Configurator.dry_run?
-          Logger.log('W:==== THIS IS A DRY RUN ====')
-          Logger.log('W:  - No records will be pushed to your index')
-          Logger.log('W:  - No settings will be updated on your index')
-        end
-
         records = []
         files = []
+        Logger.log('I:Extracting records...')
         each_site_file do |file|
           # Skip files that should not be indexed
           is_indexable = FileBrowser.indexable?(file)

data/lib/jekyll/algolia/file_browser.rb

@@ -43,7 +43,18 @@ module Jekyll
       # `jekyll-paginate` automatically creates pages to paginate through posts.
       # We don't want to index those
       def self.pagination_page?(file)
-        Utils.match?(file.path, %r{page([0-9]*)/index\.html$})
+        # paginate_path contains a special `:num` part that is the page number
+        # We convert that to a regexp
+        paginate_path = Configurator.get('paginate_path')
+        paginate_path_as_regexp = paginate_path.gsub(':num', '([0-9]*)')
+
+        regexp = %r{#{paginate_path_as_regexp}/index\.html$}
+
+        # Make sure all file paths start with a / for comparison
+        filepath = file.path
+        filepath = "/#{filepath}" unless filepath[0] == '/'
+
+        Utils.match?(filepath, regexp)
       end
 
       # Public: Check if the file has one of the allowed extensions
@@ -200,13 +211,25 @@ module Jekyll
       #
       # file - The Jekyll file
       #
-      # All collections have a date, either taken from the filename, or the
-      # `date` config set in the front-matter. Even if none is set, the current
-      # date is taken by default.
+      # All collections (including posts) will have a date taken either from the
+      # front-matter or the filename prefix. If none is set, Jekyll will use the
+      # current date.
+      #
+      # For pages, only dates defined in the front-matter will be used.
+      #
+      # Note that because the default date is the current one if none is
+      # defined, we have to make sure the date is actually nil when we index it.
+      # Otherwise the diff indexing mode will think that records have changed
+      # while they haven't.
       def self.date(file)
         date = file.data['date']
         return nil if date.nil?
 
+        # The date is *exactly* the time where the `jekyll algolia` was run.
+        # What a coincidence! It's a safe bet to assume that the original date
+        # was nil and has been overwritten by Jekyll
+        return nil if date.to_i == Jekyll::Algolia.start_time.to_i
+
         date.to_i
       end
 

data/lib/jekyll/algolia/indexer.rb

@@ -94,6 +94,9 @@ module Jekyll
       # processed, but makes debugging easier when comparing arrays is needed.
       def self.remote_object_ids(index)
         list = []
+        Logger.verbose(
+          "I:Inspecting existing records in index #{index.name}..."
+        )
         begin
           index.browse(attributesToRetrieve: 'objectID') do |hit|
             list << hit['objectID']
@@ -154,7 +157,7 @@ module Jekyll
           return
         end
 
-        Logger.log('I:Pushing records to Algolia...')
+        Logger.log("I:Updating records in index #{index.name}...")
 
         # Delete remote records that are no longer available locally
         delete_records_by_id(index, old_records_ids)

data/lib/jekyll/algolia/logger.rb

@@ -42,7 +42,7 @@ module Jekyll
       def self.known_message(message_id, metadata = {})
         file = File.expand_path(
           File.join(
-            __dir__, '../../..', 'errors', "#{message_id}.txt"
+            __dir__, '../..', 'errors', "#{message_id}.txt"
           )
         )
 

data/lib/jekyll/algolia/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Algolia
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-algolia
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tim Carry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algolia_html_extractor
@@ -256,16 +256,16 @@ extra_rdoc_files: []
 files:
 - CONTRIBUTING.md
 - README.md
-- errors/invalid_credentials.txt
-- errors/invalid_credentials_for_tmp_index.txt
-- errors/invalid_index_name.txt
-- errors/missing_api_key.txt
-- errors/missing_application_id.txt
-- errors/missing_index_name.txt
-- errors/no_records_found.txt
-- errors/record_too_big.txt
-- errors/unknown_application_id.txt
-- errors/unknown_settings.txt
+- lib/errors/invalid_credentials.txt
+- lib/errors/invalid_credentials_for_tmp_index.txt
+- lib/errors/invalid_index_name.txt
+- lib/errors/missing_api_key.txt
+- lib/errors/missing_application_id.txt
+- lib/errors/missing_index_name.txt
+- lib/errors/no_records_found.txt
+- lib/errors/record_too_big.txt
+- lib/errors/unknown_application_id.txt
+- lib/errors/unknown_settings.txt
 - lib/jekyll-algolia.rb
 - lib/jekyll/algolia/configurator.rb
 - lib/jekyll/algolia/error_handler.rb