algoliasearch-jekyll 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 098e21fa10bcd28c1713731c361914e37a7287d5
-  data.tar.gz: 754759e48284cf27db5b8f01ef2ce3a5d0377a60
+  metadata.gz: 01338e91416f0b4f645c7e45859916acbc9aaf95
+  data.tar.gz: 44fcc786e516d984eb6855ae49d38c55a870cd04
 SHA512:
-  metadata.gz: 146538e8edb1c89aab54a66f73acc3574118156953df6ae5238738bf9663cc6ef9ab57dea63d2e8823f3d01112793bbea0245d79fd8dc595d0bf83132036dd62
-  data.tar.gz: 12b8d1c7138319af9cae98188f8789ffab6a888859561179bda157acd36bbae72f58358a9eeeeec7aa9e2eec90166422a74de602b16b5cd87f37311d8b11b332
+  metadata.gz: cc60ade6df6d584e3df15c680e0dd6c01b65b4c9425139f698abecaef37d1bf0e3cc1d877669344b91495f1162e9fcddf01b23cf53b653dd57c569cac36503dd
+  data.tar.gz: 29789884292d9814e43efa8d7b7201ff07e5b3994143279d1a53e2fbbf4eb9485707872aa5102b09bc9b4e1e84ceaafdae0871d45c0fbf8b736a27804b489a56

data/README.md

@@ -134,10 +134,42 @@ class AlgoliaSearchRecordExtractor
 end
 ```
 
+The `AlgoliaSearchJekyllPush` class also lets user define the
+`custom_hook_excluded_file?` method. This method is called on every file that
+the plugin thinks it should parse and index. If it returns `true`, the file is
+not indexed. You can add here your custom logic to exclude some files.
+
+```ruby
+class AlgoliaSearchJekyllPush < Jekyll::Command
+  class << self
+    # Hook to exclude some files from indexing
+    def custom_hook_excluded_file?(file)
+      return true if filepath =~ %r{^/excluded_dir/}
+      false
+    end
+  end
+end
+```
+
+## Command line
+
+Here is the list of command line options you can pass to the `jekyll algolia
+push` command:
+
+| Flag                     | Description                                                           | 
+| ----                     | -----                                                                 | 
+| `--config ./_config.yml` | You can here specify the config file to use. Default is `_config.yml` | 
+| `--future`               | With this flag, the command will also index posts with a future date  | 
+| `--limit_posts 10`       | Limits the number of posts to parse and index                         | 
+| `--drafts`               | Index drafts in the `_drafts` folder as well                          | 
+| `--dry-run` or `-n`      | Do a dry run, do not actually push anything to your index             | 
+| `--verbose`              | Display more information about what is going to be indexed            | 
+
 ## Dependencies
 
-The `algoliasearch-jekyll` plugin works form versions of Jekyll starting from
-2.5, with a version of Ruby of at least 2.0.
+The `algoliasearch-jekyll` plugin works for versions of Jekyll starting from
+2.5, with a version of Ruby of at least 2.0. You also need
+[Bundler](http://bundler.io/) to easily add the gem as a dependency to Jekyll.
 
 ## Searching
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

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.3.0 ruby lib
+# stub: algoliasearch-jekyll 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-jekyll"
-  s.version = "0.3.0"
+  s.version = "0.4.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.date = "2015-07-28"
   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 = [
@@ -63,6 +63,7 @@ Gem::Specification.new do |s|
     "spec/fixtures/excluded.html",
     "spec/fixtures/hierarchy.md",
     "spec/fixtures/index.html",
+    "spec/fixtures/page2/index.html",
     "spec/fixtures/weight.md",
     "spec/push_spec.rb",
     "spec/record_extractor_spec.rb",

data/lib/push.rb

@@ -41,13 +41,13 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
       end
       return false unless allowed_extensions.include?(extname)
 
-      return false if excluded_file?(file.path)
+      return false if excluded_file?(file)
 
       true
     end
 
     # Check if the file is in the list of excluded files
-    def excluded_file?(filepath)
+    def excluded_file?(file)
       excluded = [
         %r{^page([0-9]*)/index\.html}
       ]
@@ -55,10 +55,21 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
         excluded += (@config['algolia']['excluded_files'] || [])
       end
 
+      # Exclude files explicitly excluded in _config
       excluded.each do |pattern|
         pattern = /#{Regexp.quote(pattern)}/ if pattern.is_a? String
-        return true if filepath =~ pattern
+        return true if file.path =~ pattern
       end
+
+      # Call user custom exclude hook on remaining files
+      return true if custom_hook_excluded_file?(file)
+
+      false
+    end
+
+    # User custom method to exclude some files when algolia.excluded_files is
+    # not enough
+    def custom_hook_excluded_file?(_file)
       false
     end
 
@@ -76,6 +87,7 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
           Jekyll.logger.info "Extracting data from #{file.path}" if is_verbose
           new_items = AlgoliaSearchRecordExtractor.new(file).extract
           next if new_items.nil?
+          ap new_items if is_verbose
 
           items += new_items
         end
@@ -89,23 +101,14 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
     def configure_index(index)
       settings = {
         distinct: true,
-        attributeForDistinct: 'title',
+        attributeForDistinct: 'url',
         attributesForFaceting: %w(tags type title),
         attributesToIndex: %w(
           title h1 h2 h3 h4 h5 h6
           unordered(text)
           unordered(tags)
         ),
-        attributesToRetrieve: %w(
-          title h1 h2 h3 h4 h5 h6
-          url
-          tag_name
-          raw_html
-          text
-          posted_at
-          css_selector
-          css_selector_parent
-        ),
+        attributesToRetrieve: nil,
         customRanking: ['desc(posted_at)', 'desc(weight)'],
         highlightPreTag: '<span class="algolia__result-highlight">',
         highlightPostTag: '</span>'

data/scripts/git_hooks/pre-commit

@@ -1,5 +1,10 @@
 #!/usr/bin/env bash
 
+# Succeed fast if we did not change any ruby file
+if ! git status --short | grep -q '\.rb$'; then
+  exit 0
+fi
+
 # Do not commit any focused or excluded tests
 if grep --color -r 'spec' -E -e '^( |\t)*(fit|fdescribe|xit|xdescribe)'; then
   echo '✘ You have focused and/or skipped tests'

data/scripts/git_hooks/pre-push

@@ -1,4 +1,10 @@
 #!/usr/bin/env bash
+
+# Succeed fast if we did not change any ruby file
+if ! git status --short | grep -q '\.rb$'; then
+  exit 0
+fi
+
 rake spec || exit 1
 
 # No over-complex methods

data/spec/fixtures/page2/index.html

@@ -0,0 +1,6 @@
+---
+layout: default
+---
+
+This pagination page should not be indexed.
+

data/spec/push_spec.rb

@@ -72,12 +72,28 @@ describe(AlgoliaSearchJekyllPush) do
       push.init_options(nil, {}, site.config)
     end
 
+    it 'should not exclude normal pages' do
+      expect(push.excluded_file?(html_page_file)).to eq false
+    end
+
     it 'should alway exclude pagination pages' do
-      expect(push.excluded_file?('page3/index.html')).to eq true
+      expect(push.excluded_file?(pagination_page)).to eq true
     end
 
     it 'should exclude user specified strings' do
-      expect(push.excluded_file?('excluded.html')).to eq true
+      expect(push.excluded_file?(excluded_page_file)).to eq true
+    end
+  end
+
+  describe 'custom_hook_excluded_file?' do
+    it 'let the user call a custom hook to exclude some files' do
+      # Given
+      def push.custom_hook_excluded_file?(_file)
+        true
+      end
+
+      # Then
+      expect(push.excluded_file?(html_page_file)).to eq true
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tim Carry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algoliasearch
@@ -245,6 +245,7 @@ files:
 - spec/fixtures/excluded.html
 - spec/fixtures/hierarchy.md
 - spec/fixtures/index.html
+- spec/fixtures/page2/index.html
 - spec/fixtures/weight.md
 - spec/push_spec.rb
 - spec/record_extractor_spec.rb