jekyll-algolia 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fa7433c628b7f2f1f4e343be4030d2852579797
-  data.tar.gz: e15c05d2729c840cc1d84e0823dae386ef58ea4d
+  metadata.gz: df27608a53e92a6a6045233960ebed4d0428d724
+  data.tar.gz: 7aa5442e7b35440a88c70a71336f7055bd7739a3
 SHA512:
-  metadata.gz: d32bc900f03aa56a30865366b3c6496e24ac2c8d579fcdfa03f543ff529809ba75bbdcad0212b9d2b9bf25bcf4a7c7b2b8c38daac2e89d94c13e05eeeec596cc
-  data.tar.gz: 27f778ae3a134833e842a82cb2781771edea33d0968f89e6af9439a3228a2318a114d5e1ac7626ca5670164b20d0d511628bb212a260bdc8988f00b241c816c7
+  metadata.gz: cac19bf56a3777f5c6754e9b4309b22fe751c7076d54de4a91bd67e067c8a84f566542ad6b93b086a650cd844fa684f5fe9101605045428ded68c64a56370a80
+  data.tar.gz: 90b7b874c0a82d2b9e2d6015795c18ef9656ea41ab9f13b8c43de7309407bc023e9ee4a167343f4ea0f735303c192d38a444e2e6f32bb2e3ed77abda96451923

data/README.md

@@ -65,7 +65,7 @@ Once your application ID is setup, you can run the indexing by running the
 following command:
 
 ```shell
-ALGOLIA_API_KEY='{your_admin_api_key}' bundle exec jekyll algolia
+ALGOLIA_API_KEY='your_admin_api_key' bundle exec jekyll algolia
 ```
 
 Note that `ALGOLIA_API_KEY` should be set to your admin API key.

data/lib/errors/missing_api_key.txt

@@ -5,7 +5,7 @@ W:
 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:   $ 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 versionning system.

data/lib/errors/missing_index_name.txt

@@ -5,7 +5,7 @@ W:
 W:Please, define it in your Jekyll _config.yml file like this:
 W:
 W:  algolia:
-W:   index_name: {your_index_name}
+W:   index_name: your_index_name
 W:
 W:Alternatively, you can also define it as an ENV variable, like this:
 W:

data/lib/errors/settings_manually_edited.txt

@@ -13,5 +13,5 @@ W:algolia:
 W:  settings:
 {settings}
 I:
-I:If you'd like to revert to the default settings, the easiest way delete the indices and run `jekyll algolia` again.
+I:If you'd like to revert to the default settings, the easiest way is to delete the {index_name} index from your dashboard and run `jekyll algolia` again.
 I:

data/lib/errors/unknown_application_id.txt

@@ -12,5 +12,5 @@ I:
 I:Then, define it in your Jekyll _config.yml file like this:
 I:
 I:  algolia:
-I:    application_id: {your_application_id}
+I:    application_id: your_application_id
 I:

data/lib/jekyll-algolia.rb

@@ -15,6 +15,7 @@ module Jekyll
     require 'jekyll/algolia/indexer'
     require 'jekyll/algolia/logger'
     require 'jekyll/algolia/progress_bar'
+    require 'jekyll/algolia/shrinker'
     require 'jekyll/algolia/utils'
     require 'jekyll/algolia/version'
 

data/lib/jekyll/algolia/extractor.rb

@@ -57,7 +57,8 @@ module Jekyll
         AlgoliaHTMLExtractor.run(
           content,
           options: {
-            css_selector: Configurator.algolia('nodes_to_index')
+            css_selector: Configurator.algolia('nodes_to_index'),
+            tags_to_exclude: 'script,style,iframe'
           }
         )
       end

data/lib/jekyll/algolia/indexer.rb

@@ -114,7 +114,7 @@ module Jekyll
         list.sort
       end
 
-      # Public: Get an array of all the object ids, stored in the dedicated
+      # Public: Get an array of all the object ids, stored in a dedicated
       # index
       #
       # Note: This will be very fast. Each record contain 100 object id, so it
@@ -142,9 +142,13 @@ module Jekyll
       def self.remote_object_ids
         Logger.log('I:Getting list of existing records')
 
+        # Main index empty, the list is empty no matter what (we don't use the
+        # dedicated index in that case)
+        return [] if record_count(index).zero?
+
         # Fast version, using the dedicated index
-        has_dedicated_index = index_exist?(index_object_ids)
-        return remote_object_ids_from_dedicated_index if has_dedicated_index
+        has_object_id_index = index_exist?(index_object_ids)
+        return remote_object_ids_from_dedicated_index if has_object_id_index
 
         # Slow version, browsing the full index
         remote_object_ids_from_main_index
@@ -175,10 +179,10 @@ module Jekyll
 
         # What changes should we do to the indexes?
         has_records_to_update = !ids_to_delete.empty? || !ids_to_add.empty?
-        has_dedicated_index = index_exist?(index_object_ids)
+        has_object_id_index = index_exist?(index_object_ids)
 
         # Stop if nothing to change
-        if !has_records_to_update && has_dedicated_index
+        if !has_records_to_update && has_object_id_index
           Logger.log('I:Content is already up to date.')
           return
         end
@@ -212,9 +216,9 @@ module Jekyll
 
         # We update the dedicated index everytime we update records, but we also
         # create it if it does not exist
-        should_update_dedicated_index = has_records_to_update ||
-                                        !has_dedicated_index
-        if should_update_dedicated_index
+        should_update_object_id_index = has_records_to_update ||
+                                        !has_object_id_index
+        if should_update_object_id_index
           operations << { action: 'clear', indexName: index_object_ids.name }
           local_ids.each_slice(100).each do |ids|
             operations << {
@@ -356,7 +360,8 @@ module Jekyll
         end
         Logger.known_message(
           'settings_manually_edited',
-          settings: yaml_lines.join("\n")
+          settings: yaml_lines.join("\n"),
+          index_name: Configurator.index_name
         )
       end
 

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

@@ -130,6 +130,15 @@ module Jekyll
         # Applying the user hook on the whole list of records
         records = Hooks.apply_all(records, self)
 
+        # Shrinking records to make them fit under 10Kb
+        # We take into account the objectID that will be added in the form of:
+        # "objectID": "16cd998991cc40d92402b0b4e6c55e8a"
+        object_id_attribute_length = 46
+        max_file_size = 10_000 - object_id_attribute_length
+        records.map! do |record|
+          Shrinker.fit_to_size(record, max_file_size)
+        end
+
         # Adding a unique objectID to each record
         records.map! do |record|
           Extractor.add_unique_object_id(record)

data/lib/jekyll/algolia/shrinker.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'json'
+module Jekyll
+  module Algolia
+    # Module to shrink a record so it fits in the plan quotas
+    module Shrinker
+      include Jekyll::Algolia
+
+      # Public: Get the byte size of the object once converted to JSON
+      # - record: The record to estimate
+      def self.size(record)
+        record.to_json.length
+      end
+
+      # Public: Attempt to reduce the size of the record by reducing the size of
+      # the less needed attributes
+      #
+      # - raw_record: The record to attempt to reduce
+      # - max_size: The max size to achieve in bytes
+      #
+      # The excerpts are the attributes most subject to being reduced. We'll go
+      # as far as removing them if there is no other choice.
+      def self.fit_to_size(raw_record, max_size)
+        return raw_record if size(raw_record) <= max_size
+
+        # No excerpt, we can't shrink it
+        return raw_record unless raw_record.key?(:excerpt_html)
+
+        record = raw_record.clone
+
+        # We replace the HTML excerpt with the textual one
+        record[:excerpt_html] = record[:excerpt_text]
+        return record if size(record) <= max_size
+
+        # We halve the excerpts
+        excerpt_words = record[:excerpt_text].split(/\s+/)
+        shortened_excerpt = excerpt_words[0...excerpt_words.size / 2].join(' ')
+        record[:excerpt_text] = shortened_excerpt
+        record[:excerpt_html] = shortened_excerpt
+        return record if size(record) <= max_size
+
+        # We remove the excerpts completely
+        record[:excerpt_text] = nil
+        record[:excerpt_html] = nil
+
+        record
+      end
+    end
+  end
+end

data/lib/jekyll/algolia/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Algolia
-    VERSION = '1.3.4'
+    VERSION = '1.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-algolia
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Tim Carry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algolia_html_extractor
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.2
+        version: 2.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.2
+        version: 2.6.1
 - !ruby/object:Gem::Dependency
   name: algoliasearch
   requirement: !ruby/object:Gem::Requirement
@@ -308,6 +308,7 @@ files:
 - lib/jekyll/algolia/overwrites/jekyll-document.rb
 - lib/jekyll/algolia/overwrites/jekyll-tags-link.rb
 - lib/jekyll/algolia/progress_bar.rb
+- lib/jekyll/algolia/shrinker.rb
 - lib/jekyll/algolia/utils.rb
 - lib/jekyll/algolia/version.rb
 - lib/jekyll/commands/algolia.rb