algoliasearch-jekyll 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e42531ea19baa4e742f31040364713c0aa846d68
-  data.tar.gz: 4afb02ff41d0b841005c85d7adaaa2a6e168d58e
+  metadata.gz: 5fc07f49e01332879569776774bc13b38b1fa601
+  data.tar.gz: 05bde1d8646bb06eb04049e5fb322d35c86744c2
 SHA512:
-  metadata.gz: f9e186d2ea14962ea6b23294dd6df6da375082d139838b48f6ac91a3e7acee11e4641d54f9d095661f3fea3577cac811408b2049a0778947cf7679081c6eae66
-  data.tar.gz: f310963a860ddb76e6f0cb166fab53ec10724e9a362c57cd9aed8b0a9e174650396caff04225eddae56fd0dda101caf95d339a3cff1b77479f90aa065d758c5d
+  metadata.gz: 27a25e5b66d6fbd44450897024bc837de069ae78d1142ad8d12e70def6334f593700299126875ae7bdea4dd8819d5dfee80c5832a7a31332b0d27fde5a611eb9
+  data.tar.gz: cf69b239d17b80fac3af079474b046b929bd5d7582b4e321ad2568b83184ea7f5b24971d62bc895f8206caaa6d2a54c292898e10ac84d8ae7b02763b337c223b

data/.travis.yml

@@ -1,6 +1,10 @@
 language: ruby
 cache: bundler
+gemfile:
+  - gemfiles/jekyll_v2.gemfile
+  - gemfiles/jekyll_v3.gemfile
 before_script: bundle update
+script: ./scripts/test_ci
 rvm:
  - 2.2
  - 2.1

data/Appraisals

@@ -0,0 +1,8 @@
+appraise 'jekyll-v2' do
+  gem 'jekyll', '~> 2.5'
+end
+
+appraise 'jekyll-v3' do
+  gem 'jekyll', '~> 3.0'
+  gem 'jekyll-paginate', '~> 1.1.0'
+end

data/CONTRIBUTING.md

@@ -7,18 +7,26 @@ already referenced. If not, feel free to open one.
 We use [pull requests](https://github.com/algolia/algoliasearch-jekyll/pulls)
 for collaboration. The workflow is as follow:
 
-- Create a local branch, starting from `master`
-- Submit the PR on `master`
+- Create a local branch, starting from `develop`
+- Submit the PR on `develop`
 - Wait for review
 - Do the changes requested (if any)
-- We may ask you to rebase the branch to latest master if it gets out of sync
-  with `master`
+- We may ask you to rebase the branch to latest `develop` if it gets out of sync
 - Receive the thanks of the Algolia team :)
 
 # Development workflow
 
-After the necessary `bundle install`, you can simply launch `guard` to start the
-test suite in watch mode (perfect for TDD).
+After the necessary `bundle install`, you'll also need to run `appraisal
+install`. This will configure the repository so that tests can be run both from
+Jekyll 2.5 and Jekyll 3.
+
+You can then launch:
+- `./scripts/test_v2` to launch tests on Jekyll v2
+- `./scripts/test_v3` to launch tests on Jekyll v3
+- `./scripts/test` to launch tests on both
+- `./scripts/watch` to start a test watcher (for TDD) for Jekyll v2
+- `./scripts/watch_v3` to start a test watcher (for TDD) for Jekyll v3 (you
+  cannot run both at the same time)
 
 If you want to test the plugin on an existing Jekyll website while developping,
 I suggest updating the website `Gemfile` to point to the correct local directory
@@ -42,7 +50,7 @@ This part is for main contributors:
 # Update master and release
 ./scripts/release
 
-# Install the gem locally
+# Install the gem locally (optional)
 rake install
 ```
 

data/Gemfile

@@ -1,6 +1,7 @@
 source 'http://rubygems.org'
 
 gem 'algoliasearch', '~> 1.4'
+gem 'appraisal', '~> 2.1.0'
 gem 'awesome_print', '~> 1.6'
 gem 'json', '~> 1.8'
 gem 'nokogiri', '~> 1.6'
@@ -10,7 +11,6 @@ group :development do
   gem 'flay', '~> 2.6'
   gem 'flog', '~> 4.3'
   gem 'guard-rspec', '~> 4.6'
-  gem 'jekyll', '~> 2.5' # Jekyll custom commands only available from 2.5
   gem 'jeweler', '~> 2.0'
   gem 'rspec', '~> 3.0'
   gem 'rubocop', '~> 0.31'

data/Guardfile

@@ -1,7 +1,17 @@
-guard :rspec, cmd: 'bundle exec rspec --color --format documentation' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { 'spec' }
+group :jekyll_v3 do
+  guard :rspec, cmd: 'appraisal jekyll-v3 bundle exec rspec --color --format documentation' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')  { 'spec' }
+  end
+end
+
+group :jekyll_v2 do
+  guard :rspec, cmd: 'appraisal jekyll-v2 bundle exec rspec --color --format documentation' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')  { 'spec' }
+  end
 end
 
 notification :off

data/README.md

@@ -31,7 +31,7 @@ source 'https://rubygems.org'
 gem 'jekyll', '~> 2.5.3'
 
 group :jekyll_plugins do
-  gem 'algoliasearch-jekyll', '~> 0.4.3'
+  gem 'algoliasearch-jekyll', '~> 0.5.3'
 end
 ```
 

data/algoliasearch-jekyll.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: algoliasearch-jekyll 0.5.3 ruby lib
+# stub: algoliasearch-jekyll 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-jekyll"
-  s.version = "0.5.3"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Tim Carry"]
-  s.date = "2015-11-03"
+  s.date = "2016-01-11"
   s.description = "Index all your pages and posts to an Algolia index with `jekyll algolia push`"
   s.email = "tim@pixelastic.com"
   s.extra_rdoc_files = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
     ".rspec",
     ".rubocop.yml",
     ".travis.yml",
+    "Appraisals",
     "CONTRIBUTING.md",
     "Gemfile",
     "Guardfile",
@@ -31,6 +32,8 @@ Gem::Specification.new do |s|
     "Rakefile",
     "algoliasearch-jekyll.gemspec",
     "docs/travis-settings.png",
+    "gemfiles/jekyll_v2.gemfile",
+    "gemfiles/jekyll_v3.gemfile",
     "lib/algoliasearch-jekyll.rb",
     "lib/credential_checker.rb",
     "lib/push.rb",
@@ -42,37 +45,47 @@ Gem::Specification.new do |s|
     "scripts/git_hooks/pre-commit",
     "scripts/git_hooks/pre-push",
     "scripts/release",
+    "scripts/test",
+    "scripts/test_ci",
+    "scripts/test_v2",
+    "scripts/test_v3",
+    "scripts/watch",
+    "scripts/watch_v2",
+    "scripts/watch_v3",
     "spec/credential_checker_spec.rb",
-    "spec/fixtures/_config.yml",
-    "spec/fixtures/_layouts/default.html",
-    "spec/fixtures/_my-collection/collection-item.html",
-    "spec/fixtures/_my-collection/collection-item.md",
-    "spec/fixtures/_posts/2015-07-02-test-post.md",
-    "spec/fixtures/_posts/2015-07-03-test-post-again.md",
-    "spec/fixtures/_site/2015/07/02/test-post.html",
-    "spec/fixtures/_site/2015/07/03/test-post-again.html",
-    "spec/fixtures/_site/about.html",
-    "spec/fixtures/_site/assets/ring.png",
-    "spec/fixtures/_site/authors.html",
-    "spec/fixtures/_site/excluded.html",
-    "spec/fixtures/_site/hierarchy.html",
-    "spec/fixtures/_site/index.html",
-    "spec/fixtures/_site/my-collection/collection-item.html",
-    "spec/fixtures/_site/page2/index.html",
-    "spec/fixtures/_site/weight.html",
-    "spec/fixtures/about.md",
-    "spec/fixtures/api_key_dir/_algolia_api_key",
-    "spec/fixtures/assets/ring.png",
-    "spec/fixtures/authors.html",
-    "spec/fixtures/excluded.html",
-    "spec/fixtures/hierarchy.md",
-    "spec/fixtures/index.html",
-    "spec/fixtures/page2/index.html",
-    "spec/fixtures/weight.md",
+    "spec/fixtures/jekyll_version_2/_config.yml",
+    "spec/fixtures/jekyll_version_2/_layouts/default.html",
+    "spec/fixtures/jekyll_version_2/_my-collection/collection-item.html",
+    "spec/fixtures/jekyll_version_2/_my-collection/collection-item.md",
+    "spec/fixtures/jekyll_version_2/_posts/2015-07-02-test-post.md",
+    "spec/fixtures/jekyll_version_2/_posts/2015-07-03-test-post-again.md",
+    "spec/fixtures/jekyll_version_2/about.md",
+    "spec/fixtures/jekyll_version_2/api_key_dir/_algolia_api_key",
+    "spec/fixtures/jekyll_version_2/assets/ring.png",
+    "spec/fixtures/jekyll_version_2/authors.html",
+    "spec/fixtures/jekyll_version_2/excluded.html",
+    "spec/fixtures/jekyll_version_2/hierarchy.md",
+    "spec/fixtures/jekyll_version_2/index.html",
+    "spec/fixtures/jekyll_version_2/page2/index.html",
+    "spec/fixtures/jekyll_version_2/weight.md",
+    "spec/fixtures/jekyll_version_3/_config.yml",
+    "spec/fixtures/jekyll_version_3/_layouts/default.html",
+    "spec/fixtures/jekyll_version_3/_my-collection/collection-item.html",
+    "spec/fixtures/jekyll_version_3/_my-collection/collection-item.md",
+    "spec/fixtures/jekyll_version_3/_posts/2015-07-02-test-post.md",
+    "spec/fixtures/jekyll_version_3/_posts/2015-07-03-test-post-again.md",
+    "spec/fixtures/jekyll_version_3/about.md",
+    "spec/fixtures/jekyll_version_3/api_key_dir/_algolia_api_key",
+    "spec/fixtures/jekyll_version_3/assets/ring.png",
+    "spec/fixtures/jekyll_version_3/authors.html",
+    "spec/fixtures/jekyll_version_3/excluded.html",
+    "spec/fixtures/jekyll_version_3/hierarchy.md",
+    "spec/fixtures/jekyll_version_3/index.html",
+    "spec/fixtures/jekyll_version_3/page2/index.html",
+    "spec/fixtures/jekyll_version_3/weight.md",
     "spec/push_spec.rb",
     "spec/record_extractor_spec.rb",
     "spec/spec_helper.rb",
-    "spec/spec_helper_jekyll.rb",
     "spec/spec_helper_simplecov.rb",
     "txt/api_key_missing",
     "txt/application_id_missing",
@@ -88,6 +101,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<algoliasearch>, ["~> 1.4"])
+      s.add_runtime_dependency(%q<appraisal>, ["~> 2.1.0"])
       s.add_runtime_dependency(%q<awesome_print>, ["~> 1.6"])
       s.add_runtime_dependency(%q<json>, ["~> 1.8"])
       s.add_runtime_dependency(%q<nokogiri>, ["~> 1.6"])
@@ -95,13 +109,13 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<flay>, ["~> 2.6"])
       s.add_development_dependency(%q<flog>, ["~> 4.3"])
       s.add_development_dependency(%q<guard-rspec>, ["~> 4.6"])
-      s.add_development_dependency(%q<jekyll>, ["~> 2.5"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
       s.add_development_dependency(%q<rspec>, ["~> 3.0"])
       s.add_development_dependency(%q<rubocop>, ["~> 0.31"])
       s.add_development_dependency(%q<simplecov>, ["~> 0.10"])
     else
       s.add_dependency(%q<algoliasearch>, ["~> 1.4"])
+      s.add_dependency(%q<appraisal>, ["~> 2.1.0"])
       s.add_dependency(%q<awesome_print>, ["~> 1.6"])
       s.add_dependency(%q<json>, ["~> 1.8"])
       s.add_dependency(%q<nokogiri>, ["~> 1.6"])
@@ -109,7 +123,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<flay>, ["~> 2.6"])
       s.add_dependency(%q<flog>, ["~> 4.3"])
       s.add_dependency(%q<guard-rspec>, ["~> 4.6"])
-      s.add_dependency(%q<jekyll>, ["~> 2.5"])
       s.add_dependency(%q<jeweler>, ["~> 2.0"])
       s.add_dependency(%q<rspec>, ["~> 3.0"])
       s.add_dependency(%q<rubocop>, ["~> 0.31"])
@@ -117,6 +130,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<algoliasearch>, ["~> 1.4"])
+    s.add_dependency(%q<appraisal>, ["~> 2.1.0"])
     s.add_dependency(%q<awesome_print>, ["~> 1.6"])
     s.add_dependency(%q<json>, ["~> 1.8"])
     s.add_dependency(%q<nokogiri>, ["~> 1.6"])
@@ -124,7 +138,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<flay>, ["~> 2.6"])
     s.add_dependency(%q<flog>, ["~> 4.3"])
     s.add_dependency(%q<guard-rspec>, ["~> 4.6"])
-    s.add_dependency(%q<jekyll>, ["~> 2.5"])
     s.add_dependency(%q<jeweler>, ["~> 2.0"])
     s.add_dependency(%q<rspec>, ["~> 3.0"])
     s.add_dependency(%q<rubocop>, ["~> 0.31"])

data/gemfiles/jekyll_v2.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "algoliasearch", "~> 1.4"
+gem "appraisal", "~> 2.1.0"
+gem "awesome_print", "~> 1.6"
+gem "json", "~> 1.8"
+gem "nokogiri", "~> 1.6"
+gem "jekyll", "~> 2.5"
+
+group :development do
+  gem "coveralls", "~> 0.8"
+  gem "flay", "~> 2.6"
+  gem "flog", "~> 4.3"
+  gem "guard-rspec", "~> 4.6"
+  gem "jeweler", "~> 2.0"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 0.31"
+  gem "simplecov", "~> 0.10"
+end

data/gemfiles/jekyll_v3.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "algoliasearch", "~> 1.4"
+gem "appraisal", "~> 2.1.0"
+gem "awesome_print", "~> 1.6"
+gem "json", "~> 1.8"
+gem "nokogiri", "~> 1.6"
+gem "jekyll", "~> 3.0"
+gem "jekyll-paginate", "~> 1.1.0"
+
+group :development do
+  gem "coveralls", "~> 0.8"
+  gem "flay", "~> 2.6"
+  gem "flog", "~> 4.3"
+  gem "guard-rspec", "~> 4.6"
+  gem "jeweler", "~> 2.0"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 0.31"
+  gem "simplecov", "~> 0.10"
+end

data/lib/record_extractor.rb

@@ -4,6 +4,8 @@ require 'json'
 
 # Given an HTML file as input, will return an array of records to index
 class AlgoliaSearchRecordExtractor
+  attr_reader :file
+
   def initialize(file)
     @file = file
     @config = file.site.config
@@ -31,26 +33,42 @@ class AlgoliaSearchRecordExtractor
     metadata[:type] = @file.class.name.split('::')[1].downcase
     metadata[:url] = @file.url
 
-    if @file.respond_to? :slug
-      metadata[:slug] = @file.slug
-    else
-      basename = File.basename(@file.path)
-      extname = File.extname(basename)
-      metadata[:slug] = File.basename(basename, extname)
-    end
+    metadata[:slug] = slug
 
     metadata[:posted_at] = @file.date.to_time.to_i if @file.respond_to? :date
-    metadata[:tags] = tags if @file.respond_to? :tags
+    metadata[:tags] = tags
 
     metadata
   end
 
+  # Returns the slug of the document
+  def slug
+    # Jekyll v3 has it in data
+    return @file.data['slug'] if @file.data.key?('slug')
+    # Old Jekyll v2 has it at the root
+    return @file.slug if @file.respond_to? :slug
+    # Otherwise, we guess it from the filename
+    basename = File.basename(@file.path)
+    extname = File.extname(basename)
+    File.basename(basename, extname)
+  end
+
   # Extract a list of tags
   def tags
-    return nil unless @file.respond_to? :tags
-    # Some plugins will extend the tags from simple strings to full featured
-    # objects. We'll simply call .to_s to always have a string
-    @file.tags.map(&:to_s)
+    tags = nil
+
+    # Jekyll v3 has it in data, while v2 have it at the root
+    if @file.data.key?('tags')
+      tags = @file.data['tags']
+    elsif @file.respond_to? :tags
+      tags = @file.tags
+    end
+
+    return tags if tags.nil?
+
+    # Anyway, we force cast it to string as some plugins will extend the tags to
+    # full featured objects
+    tags.map(&:to_s)
   end
 
   # Get the list of all HTML nodes to index

data/lib/version.rb

@@ -1,6 +1,6 @@
 # Expose gem version
 class AlgoliaSearchJekyllVersion
   def self.to_s
-    '0.5.3'
+    '0.6.0'
   end
 end

data/scripts/git_hooks/pre-push

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-rake spec || exit 1
+./scripts/test || exit 1
 
 # No over-complex methods
 ./scripts/check_flog || exit 1

data/scripts/test

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+cd "$(dirname "$BASH_SOURCE")"
+
+./test_v2 && ./test_v3

data/scripts/test_ci

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+# This script will be started by Travis, in the correct context (matrix of Ruby
+# version + Gemfile version), so it only needs to load the tests, without
+# worrying about appraisal
+cd "$(dirname "$BASH_SOURCE")"/..
+
+bundle exec rspec

data/scripts/test_v2

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+cd "$(dirname "$BASH_SOURCE")"/..
+
+echo "Testing under Jekyll 2.5"
+appraisal jekyll-v2 bundle exec rspec

data/scripts/test_v3

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

data/scripts/watch

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