algoliasearch-jekyll 0.2.3 → 0.3.0

data/lib/record_extractor.rb

@@ -6,6 +6,7 @@ require 'json'
 class AlgoliaSearchRecordExtractor
   def initialize(file)
     @file = file
+    @config = file.site.config
     default_config = {
       'record_css_selector' => 'p'
     }

data/scripts/check_flay

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+MAX_SCORE = 45
+
+flay_lines = `flay -s ./lib/`.split("\n")
+
+errors = []
+flay_lines.each_with_index do |line, index|
+  # Skip header
+  next if index < 2
+
+  pattern = /^ *(.*): (.*)/
+  matches = line.match(pattern)
+  next if matches.nil?
+  score = matches[1].to_f
+
+  next if score < MAX_SCORE
+  errors << {
+    score: score,
+    file: matches[2]
+  }
+end
+
+exit 0 if errors.size == 0
+
+puts 'Flay test failed:'
+errors.sort_by { |a| a[:score] }.each do |error|
+  puts "#{error[:score]} / #{MAX_SCORE} in #{error[:file]}"
+end
+exit 1

data/scripts/check_flog

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+MAX_SCORE = 45
+
+flog_lines = `flog ./lib/`.split("\n")
+
+errors = []
+flog_lines.each_with_index do |line, index|
+  # Skip header
+  next if index < 3
+
+  pattern = /^ *(.*): (.*) (.*):[0-9]*/
+  matches = line.match(pattern)
+  next if matches.nil?
+  score = matches[1].to_f
+
+  next if score < MAX_SCORE
+  errors << {
+    score: score,
+    method: matches[2],
+    file: matches[3]
+  }
+end
+
+exit 0 if errors.size == 0
+
+puts 'Flog test failed:'
+errors.sort_by { |a| a[:score] }.each do |error|
+  puts "#{error[:score]} / #{MAX_SCORE}: #{error[:method]} in #{error[:file]}"
+end
+exit 1

data/scripts/git_hooks/pre-commit

@@ -7,4 +7,5 @@ if grep --color -r 'spec' -E -e '^( |\t)*(fit|fdescribe|xit|xdescribe)'; then
 fi
 
 # Match style guide
-rubocop './lib/' './spec'
+rubocop -F './lib/' './spec' || exit 1
+

data/scripts/git_hooks/pre-push

@@ -1,3 +1,8 @@
 #!/usr/bin/env bash
+rake spec || exit 1
 
-bundle exec rspec --format documentation
+# No over-complex methods
+./scripts/check_flog || exit 1
+
+# No duplication
+./scripts/check_flay

data/spec/credential_checker_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe(AlgoliaSearchCredentialChecker) do
+  let(:config) do
+    {
+      'source' => File.expand_path('./spec/fixtures'),
+      'markdown_ext' => 'md,mkd',
+      'algolia' => {
+        'application_id' => 'APPID',
+        'index_name' => 'INDEXNAME'
+      }
+    }
+  end
+  let(:checker) { AlgoliaSearchCredentialChecker.new(config) }
+
+  describe 'api_key' do
+    it 'returns nil if no key found' do
+      # Given
+
+      # When
+      actual = checker.api_key
+
+      # Then
+      expect(actual).to be_nil
+    end
+
+    it 'reads from ENV var if set' do
+      # Given
+      stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
+
+      # When
+      actual = checker.api_key
+
+      # Then
+      expect(actual).to eq 'APIKEY_FROM_ENV'
+    end
+
+    it 'reads from _algolia_api_key in source if set' do
+      # Given
+      checker.config['source'] = File.join(config['source'], 'api_key_dir')
+
+      # When
+      actual = checker.api_key
+
+      # Then
+      expect(actual).to eq 'APIKEY_FROM_FILE'
+    end
+
+    it 'reads from ENV before from file' do
+      # Given
+      checker.config['source'] = File.join(config['source'], 'api_key_dir')
+      stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
+
+      # When
+      actual = checker.api_key
+
+      # Then
+      expect(actual).to eq 'APIKEY_FROM_ENV'
+    end
+  end
+
+  describe 'assert_valid' do
+    it 'should display error if no api key' do
+      # Given
+      allow(checker).to receive(:api_key) { nil }
+
+      # Then
+      expect(Jekyll.logger).to receive(:error).with(/api key/i)
+      expect(Jekyll.logger).to receive(:warn).at_least(:once)
+      expect(-> { checker.assert_valid }).to raise_error SystemExit
+    end
+
+    it 'should display error if no application id' do
+      # Given
+      checker.config['algolia'] = {
+        'application_id' => nil,
+        'index_name' => 'INDEX_NAME'
+      }
+      stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
+
+      # Then
+      expect(Jekyll.logger).to receive(:error).with(/application id/i)
+      expect(Jekyll.logger).to receive(:warn).at_least(:once)
+      expect(-> { checker.assert_valid }).to raise_error SystemExit
+    end
+
+    it 'should display error if no index name' do
+      # Given
+      checker.config['algolia'] = {
+        'application_id' => 'APPLICATION_ID',
+        'index_name' => nil
+      }
+      stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
+
+      # Then
+      expect(Jekyll.logger).to receive(:error).with(/index name/i)
+      expect(Jekyll.logger).to receive(:warn).at_least(:once)
+      expect(-> { checker.assert_valid }).to raise_error SystemExit
+    end
+
+    it 'should init the Algolia client' do
+      # Given
+      stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
+      allow(Algolia).to receive(:init)
+
+      # When
+      checker.assert_valid
+
+      # Then
+      expect(Algolia).to have_received(:init).with(
+        application_id: 'APPID',
+        api_key: 'APIKEY_FROM_ENV'
+      )
+    end
+  end
+end

data/spec/fixtures/_config.yml

@@ -1,7 +1,12 @@
-algolia:
-  application_id: 'APPID'
-  index_name:     'INDEXNAME'
-
 collections:
   my-collection:
     output: true
+markdown_ext: 'md,mkd'
+paginate: 1
+timezone: Europe/Paris
+
+algolia:
+  application_id: APPID
+  index_name:     INDEXNAME
+  excluded_files:
+    - excluded.html

data/spec/fixtures/_layouts/default.html

@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<html lang="en-us">
+  <body>
+    {{ content }}
+  </body>
+</html>

data/spec/fixtures/_posts/2015-07-03-test-post-again.md

@@ -0,0 +1,7 @@
+---
+title: "Test post again"
+---
+
+The goal of this post is simply to trigger pagination, and see that we do not
+index the pagination results.
+

data/spec/fixtures/_site/2015/07/02/test-post.html

@@ -0,0 +1,26 @@
+<p>Introduction text that also includes <a href="https://www.algolia.com">some link</a>. To
+add a bit of fancy, we will also <strong>bold</strong> and <em>italicize</em> some text.</p>
+
+<h1 id="main-title">Main title</h1>
+
+<p>We like writing stuff and then indexing it in a very fast engine. Here is why
+a fast engine is good for you:</p>
+
+<ul>
+  <li>fast</li>
+  <li>fast</li>
+  <li>fast</li>
+  <li>and fast</li>
+</ul>
+
+<h2 id="built-with-hands">Built with hands</h2>
+
+<p>All this text was typed with my own hands, on my own keyboard. I also did use
+a Chair© and a Table™.</p>
+
+<h2 id="features">Features</h2>
+
+<p>The whole plugin is composed of parts of <code>code</code>, and sometime even
+<code>&lt;code&gt;</code>.</p>
+
+<p>Code is <strong>✔ checked</strong> and errors are <strong>✘ deleted</strong>.</p>

data/spec/fixtures/_site/2015/07/03/test-post-again.html

@@ -0,0 +1,3 @@
+<p>The goal of this post is simply to trigger pagination, and see that we do not
+index the pagination results.</p>
+

data/spec/fixtures/_site/about.html

@@ -0,0 +1,31 @@
+<h1 id="heading-1">Heading 1</h1>
+
+<p>Text 1</p>
+
+<h2 id="heading-2">Heading 2</h2>
+
+<p>Text 2</p>
+
+<h3 id="heading-3">Heading 3</h3>
+
+<p>Text 3</p>
+
+<ul>
+  <li>item 1</li>
+  <li>item 2</li>
+  <li>item 3</li>
+</ul>
+
+<h3 id="another-heading-3">Another Heading 3</h3>
+
+<p id="text4">Another text 4</p>
+
+<h2 id="heading2b">Another Heading 2</h2>
+
+<p>Another <code>&lt;text&gt;</code> 5</p>
+
+<h3 id="last-heading-3">Last Heading 3</h3>
+
+<div>Just a div</div>
+
+<div><p>Last text 6 </p></div>

data/spec/fixtures/_site/authors.html

@@ -0,0 +1 @@
+<p>This is an HTML page</p>

data/spec/fixtures/_site/excluded.html

@@ -0,0 +1 @@
+<p>This should not be indexed</p>

data/spec/fixtures/_site/hierarchy.html

@@ -0,0 +1,31 @@
+<h1 id="h1">H1</h1>
+
+<p>TEXT1-H1</p>
+
+<h2 id="h2a">H2A</h2>
+
+<p>TEXT2-H2A-H1</p>
+
+<p>TEXT3-H2A-H1</p>
+
+<h2 id="h2b">H2B</h2>
+
+<p>TEXT4-H2B-H1</p>
+
+<h3 id="h3a">H3A</h3>
+
+<p>TEXT5-H3-H2B-H1</p>
+
+<div>
+  <h4>H4</h4>
+  <p>TEXT7-H4-H3-H2B-H1</p>
+</div>
+
+<h2 id="h2c">H2C</h2>
+
+<p>TEXT8-H2C-H1</p>
+
+<h3 id="h3b-code">H3B <code>&lt;code&gt;</code></h3>
+
+<p>TEXT9-H3B-H2C-H1</p>
+

data/spec/fixtures/_site/index.html

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en-us">
+  <body>
+    This default index page is used to display the paginated posts
+
+
+  <a href="/2015/07/03/test-post-again.html">
+    Test post again
+  </a>
+  <p>The goal of this post is simply to trigger pagination, and see that we do not
+index the pagination results.</p>
+
+
+
+
+  </body>
+</html>

data/spec/fixtures/_site/my-collection/collection-item.html

@@ -0,0 +1,2 @@
+<p>The grandest of omelettes. Those that feast on dragon eggs often find that there
+is very little they would not dare to do.</p>

data/spec/fixtures/_site/page2/index.html

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html lang="en-us">
+  <body>
+    This default index page is used to display the paginated posts
+
+
+  <a href="/2015/07/02/test-post.html">
+    Test post
+  </a>
+  <p>Introduction text that also includes <a href="https://www.algolia.com">some link</a>. To
+add a bit of fancy, we will also <strong>bold</strong> and <em>italicize</em> some text.</p>
+
+<h1 id="main-title">Main title</h1>
+
+<p>We like writing stuff and then indexing it in a very fast engine. Here is why
+a fast engine is good for you:</p>
+
+<ul>
+  <li>fast</li>
+  <li>fast</li>
+  <li>fast</li>
+  <li>and fast</li>
+</ul>
+
+<h2 id="built-with-hands">Built with hands</h2>
+
+<p>All this text was typed with my own hands, on my own keyboard. I also did use
+a Chair© and a Table™.</p>
+
+<h2 id="features">Features</h2>
+
+<p>The whole plugin is composed of parts of <code>code</code>, and sometime even
+<code>&lt;code&gt;</code>.</p>
+
+<p>Code is <strong>✔ checked</strong> and errors are <strong>✘ deleted</strong>.</p>
+
+
+
+  </body>
+</html>

data/spec/fixtures/_site/weight.html

@@ -0,0 +1,15 @@
+<h1 id="aaa-bbb-ccc-ddd">AAA BBB CCC DDD</h1>
+
+<p>aaa xxx aaa xxx aaa</p>
+
+<h2 id="aaa-bbb">AAA BBB</h2>
+
+<p>aaa bbb</p>
+
+<h2 id="ccc-ddd">CCC DDD</h2>
+
+<p>ccc ddd</p>
+
+<h3 id="ddd">DDD</h3>
+
+<p>aaa bbb ccc dddd</p>

data/spec/fixtures/index.html

@@ -0,0 +1,13 @@
+---
+layout: default
+title: Home
+---
+
+This default index page is used to display the paginated posts
+
+{% for post in paginator.posts %}
+  <a href="{{ site.baseurl }}{{ post.url }}">
+    {{ post.title }}
+  </a>
+  {{ post.content }}
+{% endfor %}