test(integration): Add custom site for testing plugin integration

Author: pixelastic

.gitignore

@@ -5,6 +5,7 @@ coverage/
 docs-dev/
 gemfiles/*.lock
 spec/site/_site
+spec/integration/site/_site
 
 
 .DS_Store

scripts/test_integration_prepare

@@ -15,7 +15,7 @@ if [[ -z "$ALGOLIA_INDEX_NAME" ]]; then
 fi  
 
 
-cd ./spec/site
+cd ./spec/integration/site
 bundle install --quiet
 
 bundle exec jekyll build --trace

spec/integration/main_spec.rb

@@ -2,30 +2,31 @@
 
 require_relative './spec_helper'
 
+# rubocop:disable Metrics/BlockLength
 describe('pushed index') do
   before(:all) do
     @index = Algolia::Index.new(ENV['ALGOLIA_INDEX_NAME'])
   end
 
   describe('built website') do
+    # Files excluded from indexing should still be written on disk
     it { should have_file('404.html') }
     it { should have_file('index.html') }
   end
 
-  describe 'nbHits' do
-    subject { @index.search('', distinct: distinct)['nbHits'] }
-
-    context 'by default' do
-      let(:distinct) { nil }
-      it { should eq 35 }
+  # Custom hooks are executed, even if github-pages is added as a gem
+  describe 'hooks' do
+    describe 'exclude a file through should_be_excluded?' do
+      subject { @index.search('iamexcludedthroughhooks')['hits'].length }
+      it { should eq 0 }
     end
-    context 'with distinct:true' do
-      let(:distinct) { true }
-      it { should eq 35 }
+    describe 'update all records through before_indexing_each' do
+      subject { @index.search('')['hits'][0]['added_through_each'] }
+      it { should eq true }
     end
-    context 'with distinct:false' do
-      let(:distinct) { false }
-      it { should eq 72 }
+    describe 'add a new record through before_indexing_all' do
+      subject { @index.search('iamaddedthroughhooks')['hits'].length }
+      it { should eq 1 }
     end
   end
 
@@ -51,4 +52,22 @@
       it { should eq 'Math symbols' }
     end
   end
+
+  describe 'nbHits' do
+    subject { @index.search('', distinct: distinct)['nbHits'] }
+
+    context 'by default' do
+      let(:distinct) { nil }
+      it { should eq 5 }
+    end
+    context 'with distinct:true' do
+      let(:distinct) { true }
+      it { should eq 5 }
+    end
+    context 'with distinct:false' do
+      let(:distinct) { false }
+      it { should eq 9 }
+    end
+  end
 end
+# rubocop:enable Metrics/BlockLength

spec/integration/site/404.md

@@ -0,0 +1,9 @@
+---
+title: 404 Not Found
+---
+
+This is a classical error page, as suggested by
+[GitHub pages](https://help.github.com/articles/creating-a-custom-404-page-for-your-github-pages-site/).
+
+It should not be indexed.
+

spec/integration/site/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jekyll', '~> 3.7.3'
+
+gem 'minima', '~> 2.0'
+
+group :jekyll_plugins do
+  gem 'github-pages', '~> 183'
+  gem 'jekyll-algolia', path: '../../../'
+  gem 'jekyll-feed', '~> 0.6'
+  gem 'jekyll-paginate', '~> 1.1'
+  gem 'jekyll-tagging', '~> 1.1'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]

spec/integration/site/_config.yml

@@ -0,0 +1,24 @@
+collections:
+  my-collection:
+    output: true
+timezone: Europe/Paris
+remote_theme: "mmistakes/minimal-mistakes"
+
+algolia:
+  application_id: APPID
+  index_name:     INDEXNAME
+  files_to_exclude:
+    - index.html
+    - excluded.html
+    - excluded_dir/*.html
+  settings:
+    attributesToSnippet: ['content:10']
+    separatorsToIndex: '∀λ→'
+
+# jekyll-paginate lets you define the path to the pagination pages
+paginate: 5
+paginate_path: "/blog/pages/:num"
+
+# jekyll-tagging lets you define where to save the tag files
+tag_page_layout: tag
+tag_page_dir: tags

spec/integration/site/_my-collection/sample-item.md

@@ -0,0 +1,5 @@
+---
+title: Sample item
+---
+
+This is a sample item

spec/integration/site/_plugins/hooks.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Algolia
+    # Custom user hooks
+    module Hooks
+      def self.should_be_excluded?(filepath)
+        filepath == 'excluded-from-hook.html'
+      end
+
+      def self.before_indexing_each(record, _node, _context)
+        record[:added_through_each] = true
+        record
+      end
+
+      def self.before_indexing_all(records, _context)
+        records << {
+          content: 'Added through hooks [iamaddedthroughhooks]'
+        }
+        records
+      end
+    end
+  end
+end

spec/integration/site/_posts/2015-07-02-test-post.md

@@ -0,0 +1,35 @@
+---
+title: "Test post"
+tags:
+  - tag
+  - another tag
+categories:
+  - foo
+  - bar
+custom: Foo
+---
+
+Introduction text that also includes [some link](https://www.algolia.com). To
+add a bit of fancy, we will also __bold__ and _italicize_ some text.
+
+# Main title
+
+We like writing stuff and then indexing it in a very fast engine. Here is why
+a fast engine is good for you:
+
+* fast
+* fast
+* fast
+* and fast
+
+## Built with hands
+
+All this text was typed with my own hands, on my own keyboard. I also did use
+a Chair© and a Table™.
+
+## Features
+
+The whole plugin is composed of parts of `code`, and sometime even
+<code>&lt;code&gt;</code>.
+
+Code is __✔ checked__ and errors are __✘ deleted__.

spec/integration/site/excluded-from-hook.html

@@ -0,0 +1,7 @@
+---
+title: Excluded file
+---
+
+<p>This should not be indexed because it is specifically excluded with a user hook</p>
+
+<p>iamexcludedhroughhooks</p>