algoliasearch-jekyll 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf63cc151be2bbb9c5dea8881f110703cc5ab95f
-  data.tar.gz: 9cdd47f72d3446b48df5492b1a68f405e7607ffb
+  metadata.gz: be7a946ef88f83e9dd443b3bb1cf0192b9809366
+  data.tar.gz: 613b7ae7df5b1ea5d23393225c9bf9953cddcfd7
 SHA512:
-  metadata.gz: 01fc966406a3e1f7866e7dd045182cd0c343b44f0f64201026b13401fb0544a992f3202c9504481f44eca7ce4f20b517f9afc4e34c5e6662f2f8561ffa98765f
-  data.tar.gz: b92a131ce8b29c1b691669f01881d9853446cdc103dffa88fc6c777eb568a363b951d5b4cafc4b49187df0a8c24a9a3f6ec2d7f6a6b7faf8929ff2f1133bbf04
+  metadata.gz: 94285229cd205e237c10562c8c15060f69d7986d2074e6267192099aba31d033d31459f36a35f1b699d6b2c6504f7be74474af5ed387106975d9ad17fa6d1a9e
+  data.tar.gz: 4aefd0b4d45a2d28b4e7ed4b8f56af28c2296cc3ce423894b854b4f97a1ef05e05db11f951c6e23384eac8e149693d60936ae244fa7bc4f42717a024e4a53e77

data/README.md

@@ -1,9 +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)
+[![Gem Version][1]](http://badge.fury.io/rb/algoliasearch-jekyll)
+[![Build Status][2]](https://travis-ci.org/algolia/algoliasearch-jekyll)
+[![Coverage Status][3]](https://coveralls.io/github/algolia/algoliasearch-jekyll?branch=master)
+[![Code Climate][4]](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`.
@@ -28,10 +28,10 @@ minimum content to get your started.
 ```ruby
 source 'https://rubygems.org'
 
-gem 'jekyll', '>=2.5.3'
+gem 'jekyll', '~> 2.5.3'
 
 group :jekyll_plugins do
-  gem 'algoliasearch-jekyll'
+  gem 'algoliasearch-jekyll', '~> 0.4.3'
 end
 ```
 
@@ -59,13 +59,13 @@ algolia:
   index_name:     'your_index_name'
 ```
 
-You admin api key will be read from the `ALGOLIA_API_KEY` environment variable.
+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_admin_api_key' jekyll algolia push`.
+`ALGOLIA_API_KEY='your_write_api_key' jekyll algolia push`.
 
 ### ⚠ Other, unsecure, method ⚠
 
-You can also store your admin api key in a file named `_algolia_api_key`, in
+You can also store your write api key in a file named `_algolia_api_key`, in
 your source directory. If you do this we __very, very, very strongly__ encourage
 you to make sure the file is not tracked in your versioning system.
 
@@ -100,8 +100,10 @@ algolia:
 
 #### `settings`
 
-Here you can pass any custom settings you would like to push to your Algolia
-index.
+Here you can pass any specific [index settings][5] to your Algolia index. All
+the settings supported by the API can be passed here.
+
+##### Examples 
 
 If you want to activate `distinct` and some snippets for example, you would do:
 
@@ -113,6 +115,28 @@ algolia:
     attributesToSnippet: ['text:20']
 ```
 
+If you want to search in other fields than the default ones, you'll have to edit
+the `attributesToIndex` (default is `%w(title h1 h2 h3 h4 h5 h6 unordered(text)
+unordered(tags))`
+
+```yml
+algolia:
+  settings:
+    attributesToIndex:
+      - title
+      - h1
+      - h2
+      - h3
+      - h4
+      - h5
+      - h6
+      - unordered(text)
+      - unordered(tags)
+      - your_custom_attribute_1
+      - your_custom_attribute_2
+      - ...
+```
+
 ### Hooks
 
 The `AlgoliaSearchRecordExtractor` contains two methods (`custom_hook_each` and
@@ -169,20 +193,86 @@ push` command:
 
 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.
+[Bundler][6] to easily add the gem as a dependency to Jekyll.
 
 ## Searching
 
 This plugin will only index your data in your Algolia index. Adding search
-capabilities is quite easy. You can follow [our tutorials][1] or use our forked
-version of the popular [Hyde theme][2].
+capabilities is quite easy. You can follow [our tutorials][7] or use our forked
+version of the popular [Hyde theme][8].
 
 ## GitHub Pages
 
-Unfortunatly, GitHub does not allow custom plugins to be run on GitHub Pages.
-This mean that you will have to manually run `jekyll algolia push` before
-pushing your content to GitHub.
+GitHub does not allow custom plugins to be run on GitHub Pages. This means that
+you'll either have to run `jekyll algolia push` manually, or configure TravisCI
+to do it for you.
+
+[Travis CI][9] is an hosted continuous integration
+service, and it's free for open-source projects. Properly configured, it can
+automatically reindex your data whenever you push to `gh-pages`.
+
+For it to work, you'll have 3 steps to perform.
+
+### 1. Create a `.travis.yml` file
+
+Create a file named `.travis.yml` at the root of your project, with the
+following content:
+
+```yml
+language: ruby
+cache: bundler
+branches:
+  only:
+    - gh-pages
+script: 
+  - bundle exec jekyll algolia push
+rvm:
+ - 2.2
+```
+
+This file will be read by Travis and instruct it to fetch all dependencies
+defined in the `Gemfile`, then run `jekyll algolia push`. This will only be
+triggered when data is pushed to the `gh-pages` branch.
+
+### 2. Update your `_config.yml` file to exclude `vendor`
+
+Travis will download all you `Gemfile` dependencies into a directory named
+`vendor`. You have to tell Jekyll to ignore this directory, otherwise Jekyll
+will try to parse it (and fail).
+
+Doing so is easy, just add the following line to your `_config.yml` file:
+
+```yml
+exclude: [vendor]
+```
+
+### 3. Configure Travis
+
+In order for Travis to be able to push data to your index on your behalf, you
+have to give it your write API Key. This is achieved by defining an
+`ALGOLIA_API_KEY` [environment variable][10] in Travis settings.
+
+You should also uncheck the "Build pull requests" option, otherwise any pull
+request targeting `gh-pages` will trigger the reindexing.
+
+![Travis Configuration][11]
+
+### Done
+
+Commit all the changes to the files, and then push to `gh-pages`. Travis will
+catch the event and trigger your indexing for you. You can follow the Travis job
+execution directly on [their website][12].
 
 
-[1]: https://www.algolia.com/doc/javascript
-[2]: https://github.com/algolia/hyde
+[1]: https://badge.fury.io/rb/algoliasearch-jekyll.svg
+[2]: https://travis-ci.org/algolia/algoliasearch-jekyll.svg?branch=master
+[3]: https://coveralls.io/repos/algolia/algoliasearch-jekyll/badge.svg?branch=master&service=github
+[4]: https://codeclimate.com/github/algolia/algoliasearch-jekyll/badges/gpa.svg
+[5]: https://www.algolia.com/doc/ruby#indexing-parameters
+[6]: http://bundler.io/
+[7]: https://www.algolia.com/doc/javascript
+[8]: https://github.com/algolia/hyde
+[9]: https://travis-ci.org/
+[10]: http://docs.travis-ci.com/user/environment-variables/
+[11]: /docs/travis-settings.png
+[12]: https://travis-ci.org

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.4.3 ruby lib
+# stub: algoliasearch-jekyll 0.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-jekyll"
-  s.version = "0.4.3"
+  s.version = "0.5.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-29"
+  s.date = "2015-11-03"
   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 = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "algoliasearch-jekyll.gemspec",
+    "docs/travis-settings.png",
     "lib/algoliasearch-jekyll.rb",
     "lib/credential_checker.rb",
     "lib/push.rb",

data/lib/record_extractor.rb

@@ -135,10 +135,9 @@ class AlgoliaSearchRecordExtractor
     node.css_path.gsub('html > body > ', '')
   end
 
-  # Returns a custom numeric value representing how relevant to its hierarchy
-  # this record is. This value can be used in the custom ranking to display more
-  # relevant records first.
-  def weight(data)
+  # The more words are in common between this node and its parent heading, the
+  # higher the score
+  def weight_heading_relevance(data)
     # Get list of unique words in headings
     title_words = %i(title h1 h2 h3 h4 h5 h6)
                   .select { |title| data.key?(title) }
@@ -152,13 +151,30 @@ class AlgoliaSearchRecordExtractor
     (title_words & text_words).size
   end
 
+  # Returns a weight based on the tag_name
+  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)
+    # h1: 100, h2: 90, ..., h6: 50
+    100 - (tag_name.gsub('h', '').to_i - 1) * 10
+  end
+
+  # Returns an object of all weights
+  def weight(item, index)
+    {
+      tag_name: weight_tag_name(item),
+      heading_relevance: weight_heading_relevance(item),
+      position: index
+    }
+  end
+
   def extract
     items = []
     html_nodes.each_with_index do |node, index|
       next unless node.text.size > 0
 
       item = metadata.clone
-      item[:objectID] = "#{item[:slug]}_#{index}"
       item.merge!(node_hierarchy(node))
       item[:tag_name] = node.name
       item[:raw_html] = node_raw_html(node)
@@ -166,7 +182,7 @@ class AlgoliaSearchRecordExtractor
       item[:unique_hierarchy] = unique_hierarchy(item)
       item[:css_selector] = node_css_selector(node)
       item[:css_selector_parent] = node_css_selector(node_heading_parent(node))
-      item[:weight] = weight(item)
+      item[:weight] = weight(item, index)
 
       # We pass item through the user defined custom hook
       item = custom_hook_each(item, node)

data/spec/record_extractor_spec.rb

@@ -316,7 +316,7 @@ describe(AlgoliaSearchRecordExtractor) do
     end
   end
 
-  describe 'weight' do
+  describe 'weight_heading_relevance' do
     it 'gets the number of words in text also in the title' do
       # Given
       data = {
@@ -325,7 +325,7 @@ describe(AlgoliaSearchRecordExtractor) do
       }
 
       # When
-      actual = page_file.weight(data)
+      actual = page_file.weight_heading_relevance(data)
 
       # Then
       expect(actual).to eq 2
@@ -341,7 +341,7 @@ describe(AlgoliaSearchRecordExtractor) do
       }
 
       # When
-      actual = page_file.weight(data)
+      actual = page_file.weight_heading_relevance(data)
 
       # Then
       expect(actual).to eq 3
@@ -357,7 +357,7 @@ describe(AlgoliaSearchRecordExtractor) do
       }
 
       # When
-      actual = page_file.weight(data)
+      actual = page_file.weight_heading_relevance(data)
 
       # Then
       expect(actual).to eq 2
@@ -372,7 +372,7 @@ describe(AlgoliaSearchRecordExtractor) do
       }
 
       # When
-      actual = page_file.weight(data)
+      actual = page_file.weight_heading_relevance(data)
 
       # Then
       expect(actual).to eq 2
@@ -386,7 +386,7 @@ describe(AlgoliaSearchRecordExtractor) do
       }
 
       # When
-      actual = page_file.weight(data)
+      actual = page_file.weight_heading_relevance(data)
 
       # Then
       expect(actual).to eq 1
@@ -407,13 +407,71 @@ describe(AlgoliaSearchRecordExtractor) do
       }
 
       # When
-      actual = page_file.weight(data)
+      actual = page_file.weight_heading_relevance(data)
 
       # Then
       expect(actual).to eq 2
     end
   end
 
+  describe 'weight_tag_name' do
+    it 'gives a score of 0 to non-headings' do
+      # Given
+      data = {
+        tag_name: 'p'
+      }
+
+      # When
+      actual = page_file.weight_tag_name(data)
+
+      # Then
+      expect(actual).to eq 0
+    end
+    it 'gives a score of 100 to h1' do
+      # Given
+      data = {
+        tag_name: 'h1'
+      }
+
+      # When
+      actual = page_file.weight_tag_name(data)
+
+      # Then
+      expect(actual).to eq 100
+    end
+    it 'gives a score of 40 to h6' do
+      # Given
+      data = {
+        tag_name: 'h6'
+      }
+
+      # When
+      actual = page_file.weight_tag_name(data)
+
+      # Then
+      expect(actual).to eq 50
+    end
+  end
+
+  describe 'weight' do
+    it 'returns an object with all weights' do
+      # Given
+      item = {
+        tag_name: 'p'
+      }
+      allow(page_file).to receive(:weight_tag_name) { 10 }
+      allow(page_file).to receive(:weight_heading_relevance) { 20 }
+
+      # When
+      actual = page_file.weight(item, 42)
+
+      # Then
+      expect(actual).to include(tag_name: 10)
+      expect(actual).to include(heading_relevance: 20)
+      expect(actual).to include(position: 42)
+    end
+  end
+
   describe 'custom_hook_each' do
     it 'let the user call a custom hook to modify a record' do
       # Given

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Tim Carry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-29 00:00:00.000000000 Z
+date: 2015-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algoliasearch
@@ -211,6 +211,7 @@ files:
 - README.md
 - Rakefile
 - algoliasearch-jekyll.gemspec
+- docs/travis-settings.png
 - lib/algoliasearch-jekyll.rb
 - lib/credential_checker.rb
 - lib/push.rb