jekyll-algolia 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d547736b3282c2c6785883b020f3dc257eccab5
-  data.tar.gz: c6d8d3425babfbeb511edd10e010202796781a69
+  metadata.gz: bf886389ae5ad938db693d1bc2ed35e2b89015d3
+  data.tar.gz: 252509afafa7dd89faea1ed3dc7aa9590da1a9be
 SHA512:
-  metadata.gz: b3742dc353e318baa82f2fc34aefa9ee3ac1edcca07e7e17cb7b0595dd88a7e28e802b951e5194650a55c9a2a6cd4e5e6f192d1f93a16aa30b1236420784b6be
-  data.tar.gz: 72ecdb419401a45183b0f6cd8541d20f3931604387f1d102370c49bb55d90dec157015d5d2aea0afe48edeaf39516377a910b43b0940696c3fa54c293bd6cb72
+  metadata.gz: 3a4472b586bbd24f67ee82c4e1bdb8505789d50296b5604b4be388fa25df123545c5e949b8e7caada3276e28a4f1a9f0270a0ae5013f08d1c47d17df0238fc27
+  data.tar.gz: 78946a3ec46e391260479c1e2a24b131c3627d86f4b643f8e884b8cb183376317e95827600036b402c703ad2f796023d7f939777961ed809e70f40581b5f3221

data/lib/jekyll-algolia.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require 'jekyll/commands/algolia'
-require 'jekyll/algolia/overwrites'
+require 'jekyll/algolia/overwrites/jekyll-algolia-site'
+require 'jekyll/algolia/overwrites/jekyll-document'
+require 'jekyll/algolia/overwrites/jekyll-tags-link'
 require 'date'
 
 module Jekyll
@@ -34,6 +36,9 @@ module Jekyll
 
       Configurator.warn_of_deprecated_options
 
+      # Register our own tags to overwrite the default tags
+      Liquid::Template.register_tag('link', JekyllAlgoliaLink)
+
       if Configurator.dry_run?
         Logger.log('W:==== THIS IS A DRY RUN ====')
         Logger.log('W:  - No records will be pushed to your index')
@@ -62,136 +67,5 @@ module Jekyll
     def self.site
       @site
     end
-
-    # 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 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
-
-      # 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 = []
-        progress_bar = ProgressBar.create(
-          total: indexable_item_count,
-          format: 'Extracting records (%j%%) |%B|'
-        )
-        each_site_file do |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)
-
-          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
-        records = Hooks.apply_all(records, self)
-
-        # Adding a unique objectID to each record
-        records.map! do |record|
-          Extractor.add_unique_object_id(record)
-        end
-
-        Logger.verbose("I:Found #{files.length} files")
-
-        Indexer.run(records)
-      end
-    end
   end
 end

data/lib/jekyll/algolia/overwrites/jekyll-algolia-site.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Algolia
+    # 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 expose a way to reset the collection, as it will be needed in the
+      # tests
+      attr_writer :collections
+
+      attr_reader :original_site_files
+
+      # 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
+
+      # 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
+        @original_site_files = {
+          pages: @pages,
+          collections: @collections,
+          static_files: @static_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 = []
+        progress_bar = ProgressBar.create(
+          total: indexable_item_count,
+          format: 'Extracting records (%j%%) |%B|'
+        )
+        each_site_file do |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)
+
+          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
+        records = Hooks.apply_all(records, self)
+
+        # Adding a unique objectID to each record
+        records.map! do |record|
+          Extractor.add_unique_object_id(record)
+        end
+
+        Logger.verbose("I:Found #{files.length} files")
+
+        Indexer.run(records)
+      end
+    end
+  end
+end

data/lib/jekyll/algolia/overwrites/jekyll-tags-link.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# The default `link` tag allow to link to a specific page, using its relative
+# path. Because we might not be indexing the destination of the link, we might
+# not have the representation of the page in our data. If that happens, the
+# `link` tag fails.
+#
+# To fix that we'll overwrite the default `link` tag to loop over a backup copy
+# of the original files (before we clean it for indexing)
+#
+# https://github.com/algolia/jekyll-algolia/issues/62
+class JekyllAlgoliaLink < Jekyll::Tags::Link
+  def render(context)
+    original_files = context.registers[:site].original_site_files
+
+    original_files[:pages].each do |page|
+      return page.url if page.relative_path == @relative_path
+    end
+
+    original_files[:collections].each_value do |collection|
+      collection.docs.each do |item|
+        return item.url if item.relative_path == @relative_path
+      end
+    end
+
+    original_files[:static_files].each do |asset|
+      return asset.url if asset.relative_path == @relative_path
+      return asset.url if asset.relative_path == "/#{@relative_path}"
+    end
+
+    '/'
+  end
+end

data/lib/jekyll/algolia/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Algolia
-    VERSION = '1.3.1'
+    VERSION = '1.3.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-algolia
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Tim Carry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algolia_html_extractor
@@ -303,7 +303,9 @@ files:
 - lib/jekyll/algolia/hooks.rb
 - lib/jekyll/algolia/indexer.rb
 - lib/jekyll/algolia/logger.rb
-- lib/jekyll/algolia/overwrites.rb
+- lib/jekyll/algolia/overwrites/jekyll-algolia-site.rb
+- lib/jekyll/algolia/overwrites/jekyll-document.rb
+- lib/jekyll/algolia/overwrites/jekyll-tags-link.rb
 - lib/jekyll/algolia/progress_bar.rb
 - lib/jekyll/algolia/utils.rb
 - lib/jekyll/algolia/version.rb