algoliasearch-jekyll 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc842f3c5823b8a809ffcd12e6d520f15eeefc60
-  data.tar.gz: 3fbfef0340971043048d1e0d71b439a50727e451
+  metadata.gz: 0c1ea0f7d0eecf20f9cb33f30116df426637a9f4
+  data.tar.gz: 8ec5644ebbd8c08fcead43c3c6cf64c0bbe82db6
 SHA512:
-  metadata.gz: 8b80bcd9875ac15f96fa76a1f2cb676c6b4a38d98be4c30936710f5ffb9e6c9d843ecf9f2af6ee1b2af56cc77afa3c54b9eb8ce0f814ec1392f0df89de5067ae
-  data.tar.gz: 70dc1b288661933a38f5b4845d073985d74f5e7f6dc947799af2c85f2afbdebbad6c9fa732b0c3f5a7538f6f596c8338368aba55982384cd83a78eec8fcb8385
+  metadata.gz: 0dd5939456e660845ec71719c47ea296088284907b8d58b3d7ac08e5b070ac6dc688edcd18030e0bb87efe2b62a655c71ffb393f81e674936235cf16a9a46ccb
+  data.tar.gz: d19157c6ba465da2dea75f62e4744d3b55fb170043c7aedd0098f7b37bba2d53bb00b4fc2ade9458a1c716340e103768a16381a44052245400089787a3781853

data/CONTRIBUTING.md

@@ -25,8 +25,11 @@ You can then launch:
 - `./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)
+- `./scripts/watch_v3` to start a test watcher (for TDD) for Jekyll v3
+
+The watched test will both launch Guard (with `guard-rspec`), but each will use
+its own `Guardfile` version, launching the correct `appraisal` before the
+`rspec` command.
 
 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
@@ -35,8 +38,7 @@ I suggest updating the website `Gemfile` to point to the correct local directory
 gem "algoliasearch-jekyll", :path => "/path/to/local/gem/folder"
 ```
 You should also run `rake gemspec` from the `algoliasearch-jekyll` repository if
-you added new files or dependencies.
-
+you added/deleted any file or dependency.
 
 If you plan on submitting a PR, I suggest you install the git hooks. This will
 run pre-commit and pre-push checks. Those checks will also be run by TravisCI,

data/Gemfile

@@ -3,7 +3,6 @@ source 'http://rubygems.org'
 gem 'algoliasearch', '~> 1.4'
 gem 'appraisal', '~> 2.1.0'
 gem 'awesome_print', '~> 1.6'
-gem 'jekyll', '~> 2.5'
 gem 'json', '~> 1.8'
 gem 'nokogiri', '~> 1.6'
 gem 'verbal_expressions', '~> 0.1.5'

data/{Guardfile → Guardfile_jekyllv2}

@@ -1,4 +1,4 @@
-guard :rspec, cmd: 'bundle exec rspec --color --format documentation' 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' }

data/Guardfile_jekyllv3

@@ -0,0 +1,7 @@
+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
+
+notification :off

data/README.md

@@ -64,6 +64,11 @@ You write api key will be read from the `ALGOLIA_API_KEY` environment variable.
 You can define it on the same line as your command, allowing you to type
 `ALGOLIA_API_KEY='your_write_api_key' jekyll algolia push`.
 
+Note that your API key should have write access to both the `index_name` and
+`_tmp` suffixed version of it (eg. `your_index_name` and `your_index_name_tmp`)
+in the previous example). This is due to the way we do atomic pushes by pushing
+to a temporary index and then renaming it.
+
 ### ⚠ Other, unsecure, method ⚠
 
 You can also store your write api key in a file named `_algolia_api_key`, in

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.6.1 ruby lib
+# stub: algoliasearch-jekyll 0.7.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-jekyll"
-  s.version = "0.6.1"
+  s.version = "0.7.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 = "2016-01-13"
+  s.date = "2016-03-08"
   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 = [
@@ -26,7 +26,8 @@ Gem::Specification.new do |s|
     "Appraisals",
     "CONTRIBUTING.md",
     "Gemfile",
-    "Guardfile",
+    "Guardfile_jekyllv2",
+    "Guardfile_jekyllv3",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
@@ -46,6 +47,7 @@ Gem::Specification.new do |s|
     "scripts/coverage",
     "scripts/git_hooks/pre-commit",
     "scripts/git_hooks/pre-push",
+    "scripts/lint",
     "scripts/release",
     "scripts/test",
     "scripts/test_ci",
@@ -108,7 +110,6 @@ Gem::Specification.new do |s|
       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<jekyll>, ["~> 2.5"])
       s.add_runtime_dependency(%q<json>, ["~> 1.8"])
       s.add_runtime_dependency(%q<nokogiri>, ["~> 1.6"])
       s.add_runtime_dependency(%q<verbal_expressions>, ["~> 0.1.5"])
@@ -124,7 +125,6 @@ Gem::Specification.new do |s|
       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<jekyll>, ["~> 2.5"])
       s.add_dependency(%q<json>, ["~> 1.8"])
       s.add_dependency(%q<nokogiri>, ["~> 1.6"])
       s.add_dependency(%q<verbal_expressions>, ["~> 0.1.5"])
@@ -141,7 +141,6 @@ Gem::Specification.new do |s|
     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<jekyll>, ["~> 2.5"])
     s.add_dependency(%q<json>, ["~> 1.8"])
     s.add_dependency(%q<nokogiri>, ["~> 1.6"])
     s.add_dependency(%q<verbal_expressions>, ["~> 0.1.5"])

data/gemfiles/jekyll_v2.gemfile

@@ -5,10 +5,10 @@ source "http://rubygems.org"
 gem "algoliasearch", "~> 1.4"
 gem "appraisal", "~> 2.1.0"
 gem "awesome_print", "~> 1.6"
-gem "jekyll", "~> 2.5"
 gem "json", "~> 1.8"
 gem "nokogiri", "~> 1.6"
 gem "verbal_expressions", "~> 0.1.5"
+gem "jekyll", "~> 2.5"
 
 group :development do
   gem "coveralls", "~> 0.8"

data/gemfiles/jekyll_v3.gemfile

@@ -5,10 +5,10 @@ source "http://rubygems.org"
 gem "algoliasearch", "~> 1.4"
 gem "appraisal", "~> 2.1.0"
 gem "awesome_print", "~> 1.6"
-gem "jekyll", "~> 3.0"
 gem "json", "~> 1.8"
 gem "nokogiri", "~> 1.6"
 gem "verbal_expressions", "~> 0.1.5"
+gem "jekyll", "~> 3.0"
 gem "jekyll-paginate", "~> 1.1.0"
 
 group :development do

data/lib/error_handler.rb

@@ -50,7 +50,7 @@ class AlgoliaSearchErrorHandler
   end
 
   def parse_algolia_error(error)
-    error.gsub!("\n", '')
+    error.delete!("\n")
 
     tester = error_tester
     matches = tester.match(error)

data/lib/record_extractor.rb

@@ -107,7 +107,7 @@ class AlgoliaSearchRecordExtractor
   # If the node itself is a heading, we include it
   def node_hierarchy(node, state = { level: 7 })
     tag_name = node.name
-    level = tag_name.gsub('h', '').to_i
+    level = tag_name.delete('h').to_i
 
     if node_heading?(node) && level < state[:level]
       state[tag_name.to_sym] = node_text(node)
@@ -173,9 +173,9 @@ class AlgoliaSearchRecordExtractor
   def weight_tag_name(item)
     tag_name = item[:tag_name]
     # No a heading, no weight
-    return 0 unless  %w(h1 h2 h3 h4 h5 h6).include?(tag_name)
+    return 0 unless %w(h1 h2 h3 h4 h5 h6).include?(tag_name)
     # h1: 100, h2: 90, ..., h6: 50
-    100 - (tag_name.gsub('h', '').to_i - 1) * 10
+    100 - (tag_name.delete('h').to_i - 1) * 10
   end
 
   # Returns an object of all weights
@@ -190,7 +190,7 @@ class AlgoliaSearchRecordExtractor
   def extract
     items = []
     html_nodes.each_with_index do |node, index|
-      next unless node.text.size > 0
+      next if node.text.empty?
 
       item = metadata.clone
       item.merge!(node_hierarchy(node))

data/lib/version.rb

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

data/scripts/git_hooks/pre-commit

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

data/scripts/lint

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+rubocop -F './lib/' './spec'

data/scripts/release

@@ -2,7 +2,13 @@
 
 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

data/scripts/watch

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

data/scripts/watch_v2

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

data/scripts/watch_v3

@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
 cd "$(dirname "$BASH_SOURCE")"/..
+guard --guardfile ./Guardfile_jekyllv3
 
-appraisal jekyll-v3 guard 

data/spec/push_spec.rb

@@ -318,7 +318,7 @@ describe(AlgoliaSearchJekyllPush) do
 
       # Then
       expect(Algolia).to have_received(:move_index)
-                         .with('INDEXNAME_tmp', 'INDEXNAME')
+        .with('INDEXNAME_tmp', 'INDEXNAME')
     end
 
     it 'should display the number of elements indexed' do

data/spec/record_extractor_spec.rb

@@ -44,7 +44,7 @@ describe(AlgoliaSearchRecordExtractor) do
     it 'gets posted_at timestamp based on the configured timezone' do
       # Given
       site = get_site(timezone: 'America/New_York')
-      post_file =  extractor.new(site.file_by_name('test-post.md'))
+      post_file = extractor.new(site.file_by_name('test-post.md'))
       actual = post_file.metadata
 
       # Then

data/spec/spec_helper.rb

@@ -31,7 +31,7 @@ def get_site(config = {}, options = {})
   config = Jekyll.configuration(config)
 
   site = AlgoliaSearchJekyllPush.init_options({}, options, config)
-  .jekyll_new(config)
+                                .jekyll_new(config)
 
   def site.file_by_name(file_name)
     each_site_file do |file|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Tim Carry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algoliasearch
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: jekyll
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -236,7 +222,8 @@ files:
 - Appraisals
 - CONTRIBUTING.md
 - Gemfile
-- Guardfile
+- Guardfile_jekyllv2
+- Guardfile_jekyllv3
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -256,6 +243,7 @@ files:
 - scripts/coverage
 - scripts/git_hooks/pre-commit
 - scripts/git_hooks/pre-push
+- scripts/lint
 - scripts/release
 - scripts/test
 - scripts/test_ci