algoliasearch-jekyll 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cde772c27a05882aba2a47f5c0fa626440ad7755
-  data.tar.gz: d0c6dafb3d6b3ade9a35057f6c91b9c6b3c3bfdc
+  metadata.gz: 098e21fa10bcd28c1713731c361914e37a7287d5
+  data.tar.gz: 754759e48284cf27db5b8f01ef2ce3a5d0377a60
 SHA512:
-  metadata.gz: ad814fa1f1eee3d87a6407740d9aad6501874a86b395bda116c0ddeb82d35dae9ed17c87bbb59d98c11fc32c5c75a52a187838b8a8bf7714ec158c0b9a8137a0
-  data.tar.gz: 43d778da3ad04dec941d1f46e7a1943aeb8e60e771171243f9f502994d52a18325d26a85497f5919ccf2437c57e1c0b5fd1400ddaab0e7b8bf883650628f9b2a
+  metadata.gz: 146538e8edb1c89aab54a66f73acc3574118156953df6ae5238738bf9663cc6ef9ab57dea63d2e8823f3d01112793bbea0245d79fd8dc595d0bf83132036dd62
+  data.tar.gz: 12b8d1c7138319af9cae98188f8789ffab6a888859561179bda157acd36bbae72f58358a9eeeeec7aa9e2eec90166422a74de602b16b5cd87f37311d8b11b332

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+before_script: bundle update
+rvm:
+ - 2.2
+ - 2.1
+ - 2.0
+notifications:
+  email:
+    on_success: never
+    on_failure: never

data/Gemfile

@@ -6,8 +6,11 @@ gem 'json', '~> 1.8'
 gem 'nokogiri', '~> 1.6'
 
 group :development do
+  gem 'coveralls', '~> 0.8'
+  gem 'flay', '~> 2.6'
+  gem 'flog', '~> 4.3'
   gem 'guard-rspec', '~> 4.6'
-  gem 'jekyll', '~> 2.5'
+  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/README.md

@@ -1,6 +1,9 @@
 # Algolia Jekyll Plugin 
 
 [![Gem Version](https://badge.fury.io/rb/algoliasearch-jekyll.svg)](http://badge.fury.io/rb/algoliasearch-jekyll)
+[![Build Status](https://travis-ci.org/algolia/algoliasearch-jekyll.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-jekyll)
+[![Coverage Status](https://coveralls.io/repos/algolia/algoliasearch-jekyll/badge.svg?branch=master&service=github)](https://coveralls.io/github/algolia/algoliasearch-jekyll?branch=master)
+[![Code Climate](https://codeclimate.com/github/algolia/algoliasearch-jekyll/badges/gpa.svg)](https://codeclimate.com/github/algolia/algoliasearch-jekyll)
 
 Jekyll plugin to automatically index your Jekyll posts and pages into an
 Algolia index by simply running `jekyll algolia push`.
@@ -131,6 +134,11 @@ class AlgoliaSearchRecordExtractor
 end
 ```
 
+## Dependencies
+
+The `algoliasearch-jekyll` plugin works form versions of Jekyll starting from
+2.5, with a version of Ruby of at least 2.0.
+
 ## Searching
 
 This plugin will only index your data in your Algolia index. Adding search

data/Rakefile

@@ -23,6 +23,7 @@ Jeweler::Tasks.new do |gem|
                     '`jekyll algolia push`'
   gem.email = 'tim@pixelastic.com'
   gem.authors = ['Tim Carry']
+
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
@@ -30,7 +31,7 @@ Jeweler::RubygemsDotOrgTasks.new
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  # spec.rspec_opts = '--color --format documentation'
+  spec.rspec_opts = '--color --format documentation'
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 task test: :spec

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.3.0

data/algoliasearch-jekyll.gemspec

@@ -0,0 +1,129 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: algoliasearch-jekyll 0.3.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "algoliasearch-jekyll"
+  s.version = "0.3.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-07-21"
+  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 = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".coveralls.yml",
+    ".rspec",
+    ".rubocop.yml",
+    ".travis.yml",
+    "Gemfile",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "algoliasearch-jekyll.gemspec",
+    "lib/algoliasearch-jekyll.rb",
+    "lib/credential_checker.rb",
+    "lib/push.rb",
+    "lib/record_extractor.rb",
+    "scripts/check_flay",
+    "scripts/check_flog",
+    "scripts/git_hooks/pre-commit",
+    "scripts/git_hooks/pre-push",
+    "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/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",
+    "txt/index_name_missing"
+  ]
+  s.homepage = "https://github.com/algolia/algoliasearch-jekyll"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.8"
+  s.summary = "AlgoliaSearch for Jekyll"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    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<awesome_print>, ["~> 1.6"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.8"])
+      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.6"])
+      s.add_development_dependency(%q<coveralls>, ["~> 0.8"])
+      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<awesome_print>, ["~> 1.6"])
+      s.add_dependency(%q<json>, ["~> 1.8"])
+      s.add_dependency(%q<nokogiri>, ["~> 1.6"])
+      s.add_dependency(%q<coveralls>, ["~> 0.8"])
+      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"])
+      s.add_dependency(%q<simplecov>, ["~> 0.10"])
+    end
+  else
+    s.add_dependency(%q<algoliasearch>, ["~> 1.4"])
+    s.add_dependency(%q<awesome_print>, ["~> 1.6"])
+    s.add_dependency(%q<json>, ["~> 1.8"])
+    s.add_dependency(%q<nokogiri>, ["~> 1.6"])
+    s.add_dependency(%q<coveralls>, ["~> 0.8"])
+    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"])
+    s.add_dependency(%q<simplecov>, ["~> 0.10"])
+  end
+end
+

data/lib/algoliasearch-jekyll.rb

@@ -20,8 +20,16 @@ class AlgoliaSearchJekyll < Jekyll::Command
           add_build_options(subcommand)
 
           subcommand.action do |args, options|
+            default_options = {
+              'dry_run' => false,
+              'verbose' => false
+            }
+            options = default_options.merge(options)
             @config = configuration_from_options(options)
-            AlgoliaSearchJekyllPush.init_options(args, options, @config).process
+
+            AlgoliaSearchJekyllPush.init_options(args, options, @config)
+                                   .jekyll_new(@config)
+                                   .process
           end
         end
       end
@@ -38,6 +46,10 @@ class AlgoliaSearchJekyll < Jekyll::Command
                      'Index posts in the _drafts folder'
       command.option 'unpublished', '--unpublished',
                      'Index posts that were marked as unpublished'
+      command.option 'dry_run', '--dry-run', '-n',
+                     'Do a dry run, do not push records'
+      command.option 'verbose', '--verbose',
+                     'Display more information on what is indexed'
     end
   end
 end

data/lib/credential_checker.rb

@@ -0,0 +1,74 @@
+require 'algoliasearch'
+require 'nokogiri'
+require 'json'
+
+# Given an HTML file as input, will return an array of records to index
+class AlgoliaSearchCredentialChecker
+  attr_accessor :config
+
+  def initialize(config)
+    @config = config
+  end
+
+  # Read the API key either from ENV or from an _algolia_api_key file in
+  # source folder
+  def api_key
+    # First read in ENV
+    return ENV['ALGOLIA_API_KEY'] if ENV['ALGOLIA_API_KEY']
+
+    # Otherwise from file in source directory
+    key_file = File.join(@config['source'], '_algolia_api_key')
+    if File.exist?(key_file) && File.size(key_file) > 0
+      return File.open(key_file).read.strip
+    end
+    nil
+  end
+
+  def display_error(file)
+    file = File.expand_path(File.join(File.dirname(__FILE__), '../txt', file))
+    content = File.open(file).readlines.map(&:chomp)
+    content.each_with_index do |line, index|
+      if index == 0
+        Jekyll.logger.error line
+        next
+      end
+      Jekyll.logger.warn line
+    end
+  end
+
+  # Check that the API key is available
+  def check_api_key
+    return if api_key
+    display_error('api_key_missing')
+    exit 1
+  end
+
+  # Check that the application id is defined
+  def check_application_id
+    return if @config['algolia'] && @config['algolia']['application_id']
+    display_error('application_id_missing')
+    exit 1
+  end
+
+  # Check that the index name is defined
+  def check_index_name
+    return if @config['algolia'] && @config['algolia']['index_name']
+    display_error('index_name_missing')
+    exit 1
+  end
+
+  # Check that all credentials are present
+  # Stop with a helpful message if not
+  def assert_valid
+    check_api_key
+    check_application_id
+    check_index_name
+
+    Algolia.init(
+      application_id: @config['algolia']['application_id'],
+      api_key: api_key
+    )
+
+    nil
+  end
+end

data/lib/push.rb

@@ -2,6 +2,7 @@ require 'algoliasearch'
 require 'nokogiri'
 require 'json'
 require_relative './record_extractor.rb'
+require_relative './credential_checker.rb'
 
 # `jekyll algolia push` command
 class AlgoliaSearchJekyllPush < Jekyll::Command
@@ -19,10 +20,9 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
       @args = args
       @options = options
       @config = config
+      @is_verbose = @config['verbose']
+      @is_dry_run = @config['dry_run']
 
-      # Allow for passing index name on the command line
-      index_name = args[0]
-      @config['algolia']['index_name'] = index_name if index_name
       self
     end
 
@@ -41,22 +41,39 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
       end
       return false unless allowed_extensions.include?(extname)
 
-      # Exclude files manually excluded from config
-      excluded_files = @config['algolia']['excluded_files']
-      return false if excluded_files && excluded_files.include?(basename)
+      return false if excluded_file?(file.path)
 
       true
     end
 
-    # Run the default `jekyll build` command but overwrite the actual "write
-    # files on disk" part to instead push data to Algolia
-    def process
-      site = Jekyll::Site.new(@config)
+    # Check if the file is in the list of excluded files
+    def excluded_file?(filepath)
+      excluded = [
+        %r{^page([0-9]*)/index\.html}
+      ]
+      if @config['algolia']
+        excluded += (@config['algolia']['excluded_files'] || [])
+      end
+
+      excluded.each do |pattern|
+        pattern = /#{Regexp.quote(pattern)}/ if pattern.is_a? String
+        return true if filepath =~ pattern
+      end
+      false
+    end
 
+    # Return a patched version of a Jekyll instance
+    def jekyll_new(config)
+      site = Jekyll::Site.new(config)
+
+      # Patched version of `write` that will push to Algolia instead of writing
+      # on disk
       def site.write
         items = []
+        is_verbose = config['verbose']
         each_site_file do |file|
           next unless AlgoliaSearchJekyllPush.indexable?(file)
+          Jekyll.logger.info "Extracting data from #{file.path}" if is_verbose
           new_items = AlgoliaSearchRecordExtractor.new(file).extract
           next if new_items.nil?
 
@@ -65,66 +82,7 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
         AlgoliaSearchJekyllPush.push(items)
       end
 
-      # This will call the build command by default, which will in turn call our
-      # custom .write method
-      site.process
-    end
-
-    # Read the API key either from ENV or from an _algolia_api_key file in
-    # source folder
-    def api_key
-      # First read in ENV
-      return ENV['ALGOLIA_API_KEY'] if ENV['ALGOLIA_API_KEY']
-
-      # Otherwise from file in source directory
-      key_file = File.join(@config['source'], '_algolia_api_key')
-      if File.exist?(key_file) && File.size(key_file) > 0
-        return File.open(key_file).read.strip
-      end
-      nil
-    end
-
-    # Check that all credentials are present, and stop with a helpfull message
-    # if not
-    def check_credentials
-      unless api_key
-        Jekyll.logger.error 'Algolia Error: No API key defined'
-        Jekyll.logger.warn '  You have two ways to configure your API key:'
-        Jekyll.logger.warn '    - The ALGOLIA_API_KEY environment variable'
-        Jekyll.logger.warn '    - A file named ./_algolia_api_key in your '\
-                           'source folder'
-        exit 1
-      end
-
-      unless @config['algolia'] && @config['algolia']['application_id']
-        Jekyll.logger.error 'Algolia Error: No application ID defined'
-        Jekyll.logger.warn '  Please set your application id in the '\
-                           '_config.yml file, like so:'
-        Jekyll.logger.warn ''
-        # The spaces are needed otherwise the text is centered
-        Jekyll.logger.warn '  algolia:         '
-        Jekyll.logger.warn '    application_id: \'{your_application_id}\''
-        Jekyll.logger.warn ''
-        Jekyll.logger.warn '  Your application ID can be found in your algolia'\
-                           ' dashboard'
-        Jekyll.logger.warn '    https://www.algolia.com/licensing'
-        exit 1
-      end
-
-      unless @config['algolia']['index_name']
-        Jekyll.logger.error 'Algolia Error: No index name defined'
-        Jekyll.logger.warn '  Please set your index name in the _config.yml'\
-                           ' file, like so:'
-        Jekyll.logger.warn ''
-        # The spaces are needed otherwise the text is centered
-        Jekyll.logger.warn '  algolia:         '
-        Jekyll.logger.warn '    index_name: \'{your_index_name}\''
-        Jekyll.logger.warn ''
-        Jekyll.logger.warn '  You can edit your indices in your dashboard'
-        Jekyll.logger.warn '    https://www.algolia.com/explorer'
-        exit 1
-      end
-      nil
+      site
     end
 
     # Get index settings
@@ -154,41 +112,46 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
       }
 
       # Merge default settings with user custom ones
-      (@config['algolia']['settings'] || []).each do |key, value|
-        settings[key.to_sym] = value
+      if @config['algolia']
+        (@config['algolia']['settings'] || []).each do |key, value|
+          settings[key.to_sym] = value
+        end
       end
 
       index.set_settings(settings)
     end
 
-    def push(items)
-      check_credentials
-      Algolia.init(
-        application_id: @config['algolia']['application_id'],
-        api_key: api_key
-      )
-
-      # Create a temporary index
-      index_name = @config['algolia']['index_name']
-      index_name_tmp = "#{index_name}_tmp"
-      index_tmp = Algolia::Index.new(index_name_tmp)
-      configure_index(index_tmp)
+    # Create an index to push our data
+    def create_index(index_name)
+      index = Algolia::Index.new(index_name)
+      configure_index(index) unless @is_dry_run
+      index
+    end
 
-      # Push to temporary index
+    # Push records to the index
+    def batch_add_items(items, index)
       items.each_slice(1000) do |batch|
         Jekyll.logger.info "Indexing #{batch.size} items"
         begin
-          index_tmp.add_objects!(batch)
+          index.add_objects!(batch) unless @is_dry_run
         rescue StandardError => error
           Jekyll.logger.error 'Algolia Error: HTTP Error'
           Jekyll.logger.warn error.message
           exit 1
-
         end
       end
+    end
+
+    def push(items)
+      AlgoliaSearchCredentialChecker.new(@config).assert_valid
 
-      # Move temporary index to real one
-      Algolia.move_index(index_name_tmp, index_name)
+      Jekyll.logger.info '=== DRY RUN ===' if @is_dry_run
+
+      # Add items to a temp index, then rename it
+      index_name = @config['algolia']['index_name']
+      index_name_tmp = "#{index_name}_tmp"
+      batch_add_items(items, create_index(index_name_tmp))
+      Algolia.move_index(index_name_tmp, index_name) unless @is_dry_run
 
       Jekyll.logger.info "Indexing of #{items.size} items " \
                          "in #{index_name} done."