algoliasearch-jekyll 0.9.1 → 1.0.0.beta.pre.1

data/lib/utils.rb

@@ -0,0 +1,13 @@
+# Generic util helpers
+class AlgoliaSearchUtils
+  # Check the current Jekyll version
+  def self.restrict_jekyll_version(more_than: nil, less_than: nil)
+    jekyll_version = Gem::Version.new(Jekyll::VERSION)
+    minimum_version = Gem::Version.new(more_than)
+    maximum_version = Gem::Version.new(less_than)
+
+    return false if !more_than.nil? && jekyll_version < minimum_version
+    return false if !less_than.nil? && jekyll_version > maximum_version
+    true
+  end
+end

data/lib/version.rb

@@ -1,6 +1,6 @@
 # Expose gem version
 class AlgoliaSearchJekyllVersion
   def self.to_s
-    '0.9.1'
+    '1.0.0.beta-1'
   end
 end

data/scripts/release

@@ -1,14 +1,15 @@
 #!/usr/bin/env bash
 
-git checkout master || exit 1
-git pull || exit 1
-bundle install && appraisal install
-
-git rebase develop || exit 1
-bundle install && appraisal install
-rake release || exit 1
-
-git checkout develop || exit 1
-bundle install && appraisal install
-git rebase master || exit 1
-bundle install && appraisal install
+# Stop if any command fails
+set -e
+
+git checkout master
+git pull
+
+git rebase develop
+bundle install
+appraisal install
+rake release
+
+git checkout develop
+git rebase master

data/scripts/test_v3

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 cd "$(dirname "$BASH_SOURCE")"/..
 
-echo "Testing under Jekyll 3.0"
+echo "Testing under Jekyll 3"
 COVERAGE=1 appraisal jekyll-v3 bundle exec rspec
 

data/scripts/watch

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+cd "$(dirname "$BASH_SOURCE")"/..
+
+guard --guardfile ./Guardfile_jekyllv2

data/spec/error_handler_spec.rb

@@ -121,6 +121,23 @@ describe(AlgoliaSearchErrorHandler) do
       expect(actual).to eq('check_key_acl_to_tmp_index')
     end
 
+    it 'should warn about big records' do
+      # Given
+      parsed = {
+        'http_error' => 400,
+        'json' => {
+          'message' => 'Record is too big size=220062 bytes'
+        }
+      }
+      allow(@error_handler).to receive(:parse_algolia_error).and_return(parsed)
+
+      # When
+      actual = @error_handler.readable_algolia_error('error')
+
+      # Then
+      expect(actual).to eq('record_too_big')
+    end
+
     it 'should return false if no nice message found' do
       # Given
       parsed = false

data/spec/fixtures/jekyll_version_2/404.html

@@ -0,0 +1,8 @@
+---
+title: 404 Not Found
+---
+
+This is a 404.html error page. [GitHub pages](https://help.github.com/articles/creating-a-custom-404-page-for-your-github-pages-site/)
+suggested that it should be a `.md` file, but the Hyde theme uses a `.html`, so we handle it as well.
+
+It should not be indexed.

data/spec/fixtures/jekyll_version_2/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.
+

data/spec/fixtures/jekyll_version_2/_my-collection/collection-item.md

@@ -1,6 +1,9 @@
 ---
 title: Collection Item
 custom: Foo
+tags:
+  - tag
+  - another tag
 ---
 
 The grandest of omelettes. Those that feast on dragon eggs often find that there

data/spec/fixtures/jekyll_version_2/_posts/2015-07-02-test-post.md

@@ -1,6 +1,6 @@
 ---
 title: "Test post"
-tags: 
+tags:
   - tag
   - another tag
 custom: Foo

data/spec/fixtures/jekyll_version_2/about.md

@@ -1,6 +1,9 @@
 ---
 title: About page
 custom: Foo
+tags:
+  - tag
+  - another tag
 ---
 
 # Heading 1

data/spec/fixtures/jekyll_version_2/front_matter.md

@@ -0,0 +1,15 @@
+---
+title: Front-matter test
+author: John Doe
+custom: foo
+slug: front_matter_test
+date: foo
+tags: foo
+url: http://www.foo.com/
+type: foo
+---
+
+# Title
+
+Paragraph content
+

data/spec/fixtures/jekyll_version_2/index.html

@@ -3,7 +3,9 @@ layout: default
 title: Home
 ---
 
-This default index page is used to display the paginated posts
+This default index page is usually used to display the list of posts, or briefly explain the product.
+
+I feel that it should not be indexed.
 
 {% for post in paginator.posts %}
   <a href="{{ site.baseurl }}{{ post.url }}">

data/spec/fixtures/jekyll_version_2/only-divs.md

@@ -0,0 +1,15 @@
+---
+title: Only divs
+---
+
+<div>This is the first paragraph</div>
+
+<div>This is the second paragraph</div>
+
+<div>This is the third paragraph</div>
+
+<div>This is the fourth paragraph</div>
+
+<div>This is the fifth paragraph</div>
+
+<div>This is the last paragraph</div>

data/spec/fixtures/jekyll_version_2/only-paragraphs.md

@@ -0,0 +1,15 @@
+---
+title: Only paragraphs
+---
+
+This is the first paragraph
+
+This is the second paragraph
+
+This is the third paragraph
+
+This is the fourth paragraph
+
+This is the fifth paragraph
+
+This is the last paragraph

data/spec/fixtures/jekyll_version_3/404.html

@@ -0,0 +1,8 @@
+---
+title: 404 Not Found
+---
+
+This is a 404.html error page. [GitHub pages](https://help.github.com/articles/creating-a-custom-404-page-for-your-github-pages-site/)
+suggested that it should be a `.md` file, but the Hyde theme uses a `.html`, so we handle it as well.
+
+It should not be indexed.

data/spec/fixtures/jekyll_version_3/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.
+

data/spec/fixtures/jekyll_version_3/_config.yml

@@ -12,6 +12,6 @@ algolia:
     - excluded.html
 
 # Jekyll 3.0 extracted the secondary features into their own plugins
-plugins:
+gems: 
   - jekyll-paginate
 

data/spec/fixtures/jekyll_version_3/_my-collection/collection-item.md

@@ -1,6 +1,9 @@
 ---
 title: Collection Item
 custom: Foo
+tags:
+  - tag
+  - another tag
 ---
 
 The grandest of omelettes. Those that feast on dragon eggs often find that there

data/spec/fixtures/jekyll_version_3/_posts/2015-07-02-test-post.md

@@ -1,6 +1,6 @@
 ---
 title: "Test post"
-tags: 
+tags:
   - tag
   - another tag
 custom: Foo

data/spec/fixtures/jekyll_version_3/about.md

@@ -1,6 +1,9 @@
 ---
 title: About page
 custom: Foo
+tags:
+  - tag
+  - another tag
 ---
 
 # Heading 1

data/spec/fixtures/jekyll_version_3/front_matter.md

@@ -0,0 +1,15 @@
+---
+title: Front-matter test
+author: John Doe
+custom: foo
+slug: front_matter_test
+date: foo
+tags: foo
+url: http://www.foo.com/
+type: foo
+---
+
+# Title
+
+Paragraph content
+

data/spec/fixtures/jekyll_version_3/index.html

@@ -3,7 +3,9 @@ layout: default
 title: Home
 ---
 
-This default index page is used to display the paginated posts
+This default index page is usually used to display the list of posts, or briefly explain the product.
+
+I feel that it should not be indexed.
 
 {% for post in paginator.posts %}
   <a href="{{ site.baseurl }}{{ post.url }}">
@@ -11,3 +13,4 @@ This default index page is used to display the paginated posts
   </a>
   {{ post.content }}
 {% endfor %}
+

data/spec/fixtures/jekyll_version_3/only-divs.md

@@ -0,0 +1,15 @@
+---
+title: Only divs
+---
+
+<div>This is the first paragraph</div>
+
+<div>This is the second paragraph</div>
+
+<div>This is the third paragraph</div>
+
+<div>This is the fourth paragraph</div>
+
+<div>This is the fifth paragraph</div>
+
+<div>This is the last paragraph</div>

data/spec/fixtures/jekyll_version_3/only-paragraphs.md

@@ -0,0 +1,15 @@
+---
+title: Only paragraphs
+---
+
+This is the first paragraph
+
+This is the second paragraph
+
+This is the third paragraph
+
+This is the fourth paragraph
+
+This is the fifth paragraph
+
+This is the last paragraph

data/spec/push_spec.rb

@@ -11,6 +11,9 @@ describe(AlgoliaSearchJekyllPush) do
   let(:document_file) { site.file_by_name('collection-item.md') }
   let(:html_document_file) { site.file_by_name('collection-item.html') }
   let(:pagination_page) { site.file_by_name('page2/index.html') }
+  let(:err_404) { site.file_by_name('404.md') }
+  let(:err_404_html) { site.file_by_name('404.html') }
+  let(:homepage) { site.file_by_name('index.html') }
   let(:items) do
     [{
       name: 'foo',
@@ -21,6 +24,12 @@ describe(AlgoliaSearchJekyllPush) do
     }]
   end
 
+  before(:each) do
+    allow(Jekyll.logger).to receive(:info)
+    allow(Jekyll.logger).to receive(:warn)
+    allow(Jekyll.logger).to receive(:error)
+  end
+
   describe 'init_options' do
     it 'sets options and config' do
       # Given
@@ -37,6 +46,35 @@ describe(AlgoliaSearchJekyllPush) do
     end
   end
 
+  describe 'lazy_update?' do
+    it 'should return false by default' do
+      # Given
+      push.init_options(nil, {}, {})
+
+      # When
+      actual = push.lazy_update?
+
+      # Then
+      expect(actual).to eq false
+    end
+
+    it 'should return true if such an option is set in the config' do
+      # Given
+      config = {
+        'algolia' => {
+          'lazy_update' => true
+        }
+      }
+      push.init_options(nil, {}, config)
+
+      # When
+      actual = push.lazy_update?
+
+      # Then
+      expect(actual).to eq true
+    end
+  end
+
   describe 'indexable?' do
     it 'exclude StaticFiles' do
       expect(push.indexable?(static_file)).to eq false
@@ -65,6 +103,18 @@ describe(AlgoliaSearchJekyllPush) do
     it 'does not index pagination pages' do
       expect(push.indexable?(pagination_page)).to eq false
     end
+
+    it 'does not index 404 pages (in markdown)' do
+      expect(push.indexable?(err_404)).to eq false
+    end
+
+    it 'does not index 404 pages (in html)' do
+      expect(push.indexable?(err_404_html)).to eq false
+    end
+
+    it 'does not index homepage' do
+      expect(push.indexable?(homepage)).to eq false
+    end
   end
 
   describe 'excluded_files?' do
@@ -147,7 +197,6 @@ describe(AlgoliaSearchJekyllPush) do
         @error_handler_double = double('Error Handler double').as_null_object
         push.init_options(nil, {}, {})
         allow(@index_double).to receive(:set_settings).and_raise
-        allow(Jekyll.logger).to receive(:error)
       end
 
       it 'stops if API throw an error' do
@@ -269,6 +318,53 @@ describe(AlgoliaSearchJekyllPush) do
   end
 
   describe 'push' do
+    before(:each) do
+      allow_any_instance_of(AlgoliaSearchCredentialChecker)
+        .to receive(:assert_valid)
+    end
+
+    it 'should do a lazy update if such is configured' do
+      # Given
+      allow(push).to receive(:lazy_update?).and_return(true)
+      allow(push).to receive(:lazy_update)
+      push.init_options(nil, {}, {})
+      items = ['foo']
+
+      # When
+      push.push(items)
+
+      # Then
+      expect(push).to have_received(:lazy_update).with(items)
+    end
+
+    it 'should do a greedy update if such is configured' do
+      # Given
+      allow(push).to receive(:greedy_update?).and_return(true)
+      allow(push).to receive(:greedy_update)
+      push.init_options(nil, {}, {})
+      items = ['foo']
+
+      # When
+      push.push(items)
+
+      # Then
+      expect(push).to have_received(:greedy_update).with(items)
+    end
+  end
+
+  describe 'batch_add_items' do
+    it 'should display an error if `add_objects!` failed' do
+      # Given
+      index = double('Algolia Index').as_null_object
+      allow(index).to receive(:add_objects!).and_raise
+
+      # When / Then
+      expect(-> { push.batch_add_items(items, index) })
+        .to raise_error SystemExit
+    end
+  end
+
+  describe 'greedy_update' do
     let(:index_double) { double('Algolia Index').as_null_object }
     let(:config) do
       {
@@ -280,21 +376,19 @@ describe(AlgoliaSearchJekyllPush) do
 
     before(:each) do
       push.init_options(nil, {}, config)
-      # Mock all calls to not send anything
       allow_any_instance_of(AlgoliaSearchCredentialChecker)
         .to receive(:assert_valid)
       allow(Algolia).to receive(:set_extra_header)
       allow(Algolia).to receive(:init)
       allow(Algolia).to receive(:move_index)
       allow(Algolia::Index).to receive(:new).and_return(index_double)
-      allow(Jekyll.logger).to receive(:info)
     end
 
     it 'should create a temporary index' do
       # Given
 
       # When
-      push.push(items)
+      push.greedy_update(items)
 
       # Then
       expect(Algolia::Index).to have_received(:new).with('INDEXNAME_tmp')
@@ -330,12 +424,121 @@ describe(AlgoliaSearchJekyllPush) do
       # Then
       expect(Jekyll.logger).to have_received(:info).with(/of 2 items/i)
     end
+  end
+
+  describe 'lazy_update' do
+    let(:items) do
+      [
+        { objectID: 'foo' },
+        { objectID: 'baz' }
+      ]
+    end
+    let(:remote) { %w(foo bar) }
+    let(:local) { %w(foo baz) }
+    let(:index) { double.as_null_object }
 
-    it 'should display an error if `add_objects!` failed' do
-      allow(index_double).to receive(:add_objects!).and_raise
+    describe 'remote_ids' do
+      it 'should call browse on the index with the attributesToRetrieve ' do
+        # Given
+        index = double.as_null_object
+
+        # Then
+        push.remote_ids(index)
+
+        # Then
+        expect(index).to have_received(:browse)
+      end
+
+      it 'should return an array of all objectID returned by browse' do
+        # Given
+        index = double.as_null_object
+        hit1 = { 'objectID' => 'foo' }
+        hit2 = { 'objectID' => 'bar' }
+        allow(index).to receive(:browse).and_yield(hit1).and_yield(hit2)
+
+        # Then
+        actual = push.remote_ids(index)
+
+        # Then
+        expect(actual).to eq %w(foo bar)
+      end
+    end
+
+    describe 'delete_remote_not_in_local' do
+      it 'calls delete_objects! with the array of items to delete' do
+        # Given
+
+        # When
+        push.delete_remote_not_in_local(index, local, remote)
+
+        # Then
+        expect(index).to have_received(:delete_objects!).with(['bar'])
+      end
+
+      it 'displays the number of items deleted' do
+        # Given
+
+        # When
+        push.delete_remote_not_in_local(index, local, remote)
+
+        # Then
+        expect(Jekyll.logger).to have_received(:info).with('Deleting 1 items')
+      end
 
-      expect(Jekyll.logger).to receive(:error)
-      expect(-> { push.push(items) }).to raise_error SystemExit
+      it 'should do not do an API call if there is nothing to delete' do
+        # Given
+        input = %w(foo bar)
+
+        # When
+        push.delete_remote_not_in_local(index, input, input)
+
+        # Then
+        expect(index).not_to have_received(:delete_objects!)
+      end
+    end
+
+    describe 'add_local_not_in_remote' do
+      it 'should push all local items not yet in remote' do
+        # Given
+        allow(push).to receive(:batch_add_items)
+
+        # When
+        push.add_local_not_in_remote(index, items, local, remote)
+
+        # Then
+        expected = [{ objectID: 'baz' }]
+        expect(push).to have_received(:batch_add_items).with(expected, index)
+      end
+
+      it 'should warn about pushing 0 records' do
+        # Given
+        input = %w(foo bar)
+
+        # When
+        push.add_local_not_in_remote(index, items, input, input)
+
+        # Then
+        expect(Jekyll.logger)
+          .to have_received(:info).with('Adding 0 items')
+      end
+    end
+
+    it 'should delete items from remote and push new ones' do
+      # Given
+      allow(push).to receive(:create_index).and_return(index)
+      allow(push).to receive(:remote_ids).and_return(remote)
+      allow(push).to receive(:delete_remote_not_in_local)
+      allow(push).to receive(:add_local_not_in_remote)
+      push.init_options(nil, {}, {})
+
+      # When
+      push.lazy_update(items)
+
+      # Then
+      expect(push).to have_received(:delete_remote_not_in_local)
+        .with(index, local, remote)
+      expect(push).to have_received(:add_local_not_in_remote)
+        .with(index, items, local, remote)
     end
   end
 end