jekyll-algolia 1.4.7 → 1.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8fcc627a7b1dd5f0969aee5dd9b11520172b56b0
-  data.tar.gz: 2c0e87cf5c96179356da5d91c99b18a66d123c99
+SHA256:
+  metadata.gz: 057a2f81a44baa0f0408de91f01537b3e158841e4ae9b6106923d57a88f11159
+  data.tar.gz: d3e7d88edd82282fe99d506406d0884aafb48049066638e68cd3f8f3aa0e7cbf
 SHA512:
-  metadata.gz: '095ff54e1d9f31b5110d534bebbab7a8390dff9f8095ee95632e947d5adcd079fc33b9255ac1b6e900ec2183683f07ab27e3f30c7de7ae79903757e89ffdcdd3'
-  data.tar.gz: eb31b4f658e1097feb27a5d4762b0eab6087f11086c958c8acf727b6dfbb10e25ff6600c4e47c939aa17815b229feef230de636f999bd96aae2097d3ae86c996
+  metadata.gz: 8fb927d3c90919341f48d49b47aa5e72018c78f1c06241149f868d2c4395bf94ba5a7932ed5769a8873c6d9ac84872e31bf1cfda4a8bb9296765303025534b46
+  data.tar.gz: 2602e67b07d7582517a615b3410dde5ec375e0c1795015adc41f8059b3e6d4261918048056fa6330ac13df75c63d569aa06a5858e3d45cc596cc93348ecd3d36

data/CONTRIBUTING.md

@@ -38,6 +38,16 @@ group :jekyll_plugins do
 end
 ```
 
+## Running integration tests
+
+Integration tests will do a full jekyll run, and push data to an Algolia index,
+checking that records and settings are correctly saved. It is the slowest
+possible kind of tests, but also the one closest to a real implementation.
+
+Running those tests requires a real Algolia plan. You need to define
+`ALGOLIA_APPLICATION_ID`, `ALGOLIA_API_KEY` and `ALGOLIA_INDEX_NAME` (we suggest
+using `direnv` for that), and then run `./scripts/test_integration`.
+
 ## Linting
 
 Run `rake lint` to check the style of all ruby files. Run `rake

data/README.md

@@ -1,12 +1,11 @@
 # Jekyll Algolia Plugin
 
-[![gem version][1]](https://rubygems.org/gems/jekyll-algolia)
+[![gem version][1]][16]
 ![ruby][2]
 ![jekyll][3]
-[![build master][4]](https://travis-ci.org/algolia/jekyll-algolia)
-[![coverage master][5]](https://coveralls.io/github/algolia/jekyll-algolia?branch=master)
-[![build develop][6]](https://travis-ci.org/algolia/jekyll-algolia)
-[![coverage develop][7]](https://coveralls.io/github/algolia/jekyll-algolia?branch=develop)
+[![build master][4]][17]
+[![build develop][6]][17]
+[![coverage master][5]][18]
 
 Add fast and relevant search to your Jekyll site.
 
@@ -21,7 +20,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/getting-started.html)
+[https://community.algolia.com/jekyll-algolia/][20]
 
 ## Installation
 
@@ -42,12 +41,12 @@ Once this is done, download all dependencies with `bundle install`.
 
 ## Basic configuration
 
-You need to provide certain Algolia credentials for this plugin to *index* your
+You need to provide certain Algolia credentials for this plugin to _index_ your
 site.
 
-*If you don't yet have an Algolia account, we suggest that you open a free
+_If you don't yet have an Algolia account, we suggest that you open a free
 [Community plan here][8]. You can find more information about the Algolia plans
-[in our FAQ][10].*
+[in our FAQ][10]._
 
 Once signed in, you should get your application ID from [your dashboard][9] and
 define it inside your `_config.yml` file like this:
@@ -89,19 +88,42 @@ FAQ][10].
 Thanks to [Anatoliy Yastreb][14] for a [great tutorial][15] on creating Jekyll
 plugins.
 
-
 [1]: https://badge.fury.io/rb/jekyll-algolia.svg
+
 [2]: https://img.shields.io/badge/ruby-%3E%3D%202.3.0-green.svg
+
 [3]: https://img.shields.io/badge/jekyll-%3E%3D%203.6.0-green.svg
+
 [4]: https://img.shields.io/badge/dynamic/json.svg?label=build%3Amaster&query=value&uri=https%3A%2F%2Fimg.shields.io%2Ftravis%2Falgolia%2Fjekyll-algolia.json%3Fbranch%3Dmaster
-[5]: https://img.shields.io/badge/dynamic/json.svg?label=coverage%3Amaster&colorB=&prefix=&suffix=%25&query=$.coverage_change&uri=https%3A%2F%2Fcoveralls.io%2Fgithub%2Falgolia%2Fjekyll-algolia.json%3Fbranch%3Dmaster
+
+[5]: https://coveralls.io/repos/github/algolia/jekyll-algolia/badge.svg?branch=master
+
 [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
+
+[7]: https://coveralls.io/repos/github/algolia/jekyll-algolia/badge.svg?branch=develop
+
 [8]: #more-about-the-community-plan
+
 [9]: https://www.algolia.com/api-keys
+
 [10]: https://community.algolia.com/jekyll-algolia/faq.html#how-many-records-will-the-plugin-need
+
 [11]: https://www.algolia.com/users/sign_up/hacker
+
 [12]: https://community.algolia.com/instantsearch.js/
+
 [13]: https://www.algolia.com/press#resources
+
 [14]: https://github.com/ayastreb/
+
 [15]: https://ayastreb.me/writing-a-jekyll-plugin/
+
+[16]: https://rubygems.org/gems/jekyll-algolia
+
+[17]: https://travis-ci.org/algolia/jekyll-algolia
+
+[18]: https://coveralls.io/github/algolia/jekyll-algolia?branch=master
+
+[19]: https://coveralls.io/github/algolia/jekyll-algolia?branch=develop
+
+[20]: https://community.algolia.com/jekyll-algolia/getting-started.html

data/lib/errors/no_records_found.txt

@@ -1,6 +1,6 @@
 E:[✗ Error] No records found
 E:
-E:The jekyll-algolia plugin could find any records to index
+E:The jekyll-algolia plugin could not find any records to index.
 W:
 W:The plugin tried to extract records from the pages, posts and collections of your site but could not find anything to index.
 I:

data/lib/jekyll-algolia.rb

@@ -19,6 +19,8 @@ module Jekyll
     require 'jekyll/algolia/utils'
     require 'jekyll/algolia/version'
 
+    MissingCredentialsError = Class.new(StandardError)
+
     # Public: Init the Algolia module
     #
     # config - A hash of Jekyll config option (merge of _config.yml options and
@@ -33,7 +35,12 @@ module Jekyll
       config = Configurator.init(config).config
       @site = Jekyll::Algolia::Site.new(config)
 
-      exit 1 unless Configurator.assert_valid_credentials
+      unless Configurator.assert_valid_credentials
+        raise(
+          MissingCredentialsError,
+          "One or more credentials were not found for site at: #{@site.source}"
+        )
+      end
 
       Configurator.warn_of_deprecated_options
 

data/lib/jekyll/algolia/configurator.rb

@@ -209,6 +209,7 @@ module Jekyll
       def self.verbose?
         value = get('verbose')
         return true if value == true
+
         false
       end
 
@@ -218,6 +219,7 @@ module Jekyll
       def self.dry_run?
         value = get('dry_run')
         return true if value == true
+
         false
       end
 
@@ -228,6 +230,7 @@ module Jekyll
       def self.force_settings?
         value = get('force_settings')
         return true if value == true
+
         false
       end
 
@@ -238,6 +241,7 @@ module Jekyll
       def self.extensions_to_index
         extensions = algolia('extensions_to_index')
         return [] if extensions.nil?
+
         extensions = extensions.split(',') if extensions.is_a? String
         extensions
       end
@@ -246,7 +250,7 @@ module Jekyll
       # with the indexing
       # Note that if other jekyll plugins are defined as part of the
       # :jekyll_plugins group in the Gemfile, we might be able to override them
-      # using .load_overwrites in  .load_overwrites in jekyll-algolia.rb.
+      # using .load_overwrites in jekyll-algolia.rb.
       # If they are simply required in Gemfile, then we might need to revert
       # their values to nil values from here
       def self.disable_other_plugins(config)
@@ -260,6 +264,10 @@ module Jekyll
         config['pagination'] = {} unless config['pagination'].is_a?(Hash)
         config['pagination']['enabled'] = false
 
+        # Disable autopages for jekyll-paginate-v2
+        config['autopages'] = {} unless config['autopages'].is_a?(Hash)
+        config['autopages']['enabled'] = false
+
         # Disable tags from jekyll-tagging
         config['tag_page_dir'] = nil
         config['tag_page_layout'] = nil

data/lib/jekyll/algolia/error_handler.rb

@@ -57,6 +57,7 @@ module Jekyll
         known_errors.each do |potential_error|
           error_check = send("#{potential_error}?", error, context)
           next if error_check == false
+
           return {
             name: potential_error,
             details: error_check

data/lib/jekyll/algolia/file_browser.rb

@@ -90,7 +90,15 @@ module Jekyll
       # an HTML meta refresh. We need to exclude those files from indexing.
       # https://github.com/jekyll/jekyll-redirect-from
       def self.redirect?(file)
-        file.respond_to?(:name) && file.name == 'redirect.html'
+        # When using redirect_from, jekyll-redirect-from creates a page named
+        # `redirect.html`
+        return true if file.respond_to?(:name) && file.name == 'redirect.html'
+        # When using redirect_to, it sets the layout to `redirect`
+        if file.respond_to?(:data) && file.data['layout'] == 'redirect'
+          return true
+        end
+
+        false
       end
 
       # Public: Check if the file has one of the allowed extensions
@@ -305,6 +313,7 @@ module Jekyll
         selector = Configurator.algolia('nodes_to_index')
         first_node = Nokogiri::HTML(html).css(selector).first
         return nil if first_node.nil?
+
         first_node.to_s
       end
 

data/lib/jekyll/algolia/indexer.rb

@@ -328,6 +328,7 @@ module Jekyll
 
         Logger.log("I:Updating settings of index #{index.name}")
         return if Configurator.dry_run?
+
         set_settings(settings)
       end
 

data/lib/jekyll/algolia/logger.rb

@@ -49,6 +49,7 @@ module Jekyll
       # line - The line to display, following the same format as .log
       def self.verbose(line)
         return unless Configurator.verbose?
+
         log(line)
       end
 

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

@@ -54,11 +54,7 @@ module Jekyll
           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 |_|
+        Jekyll::Hooks.register [:pages, :documents], :post_render do
           progress_bar.increment
         end
       end

data/lib/jekyll/algolia/utils.rb

@@ -42,6 +42,7 @@ module Jekyll
       # html - String representation of the HTML node
       def self.html_to_text(html)
         return nil if html.nil?
+
         text = Nokogiri::HTML(html).text
         text.tr("\n", ' ').squeeze(' ').strip
       end
@@ -54,6 +55,7 @@ module Jekyll
         hash.each do |key, value|
           next if value.nil?
           next if value.is_a?(String) && value.empty?
+
           new_hash[key] = value
         end
         new_hash
@@ -84,6 +86,7 @@ module Jekyll
       # It is basically a wrapper around [].find, handling more edge-cases
       def self.find_by_key(items, key, value)
         return nil if items.nil?
+
         items.find do |item|
           item[key] == value
         end
@@ -140,6 +143,7 @@ module Jekyll
         end
 
         return nil if diff.empty?
+
         diff
       end
 

data/lib/jekyll/algolia/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Algolia
-    VERSION = '1.4.7'
+    VERSION = '1.4.8'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-algolia
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.4.8
 platform: ruby
 authors:
 - Tim Carry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-26 00:00:00.000000000 Z
+date: 2018-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algolia_html_extractor
@@ -334,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Index your Jekyll content into Algolia