algoliasearch-jekyll 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be7a946ef88f83e9dd443b3bb1cf0192b9809366
-  data.tar.gz: 613b7ae7df5b1ea5d23393225c9bf9953cddcfd7
+  metadata.gz: 988cac4f048353fd0b0b65f9598025a6a485a10e
+  data.tar.gz: 3294a5aa8c00fbd16ba894d37164046ef785b594
 SHA512:
-  metadata.gz: 94285229cd205e237c10562c8c15060f69d7986d2074e6267192099aba31d033d31459f36a35f1b699d6b2c6504f7be74474af5ed387106975d9ad17fa6d1a9e
-  data.tar.gz: 4aefd0b4d45a2d28b4e7ed4b8f56af28c2296cc3ce423894b854b4f97a1ef05e05db11f951c6e23384eac8e149693d60936ae244fa7bc4f42717a024e4a53e77
+  metadata.gz: abf5b3df4f3eaa6dba8773179887b0e261a0bd3ee2eed293861efc3d005ccc88566fedbef124e4b859000dab67439021d1b73a075dc505cc2e4c689e11ee59a7
+  data.tar.gz: d7f1b31dfcb09e4510f4c36d68f65989e62b5c45f51a301ee18745196bc83fc2802db287e8b434d66f4c7d5b8cade3ac266715027f30553d4865347f50b9a8a0

data/CONTRIBUTING.md

@@ -0,0 +1,54 @@
+Hi collaborator!
+
+If you have a fix or a new feature, please start by checking in the
+[issues](https://github.com/algolia/algoliasearch-jekyll/issues) if it is
+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`
+- 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`
+- 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).
+
+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
+
+```ruby
+gem "algoliasearch-jekyll", :path => "/path/to/local/gem/folder"
+```
+
+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,
+but running them locally gives faster feedback.
+
+# Tagging and releasing
+
+This part is for main contributors:
+
+```
+# Bump the version manually
+vim ./lib/version.rb
+
+# Commit it
+git add ./lib/version.rb
+git commit -m 'chore(bump): Version bump to X.Y.Z'
+
+# Tag and release
+rake release
+
+# Install the gem locally
+rake install
+```
+
+
+

data/algoliasearch-jekyll.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: algoliasearch-jekyll 0.5.0 ruby lib
+# stub: algoliasearch-jekyll 0.5.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-jekyll"
-  s.version = "0.5.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
     ".rspec",
     ".rubocop.yml",
     ".travis.yml",
+    "CONTRIBUTING.md",
     "Gemfile",
     "Guardfile",
     "LICENSE.txt",

data/lib/push.rb

@@ -110,7 +110,11 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
           unordered(tags)
         ),
         attributesToRetrieve: nil,
-        customRanking: ['desc(posted_at)', 'desc(weight)'],
+        customRanking: [
+          'desc(posted_at)',
+          'desc(weight.tag_name)',
+          'asc(weight.position)'
+        ],
         highlightPreTag: '<span class="algolia__result-highlight">',
         highlightPostTag: '</span>'
       }

data/lib/version.rb

@@ -1,8 +1,8 @@
 # Expose gem version
 class AlgoliaSearchJekyllVersion
   MAJOR = 0
-  MINOR = 4
-  PATCH = 3
+  MINOR = 5
+  PATCH = 1
   BUILD = nil
 
   def self.to_s

data/spec/push_spec.rb

@@ -107,7 +107,11 @@ describe(AlgoliaSearchJekyllPush) do
       expected = {
         attributeForDistinct: 'url',
         distinct: true,
-        customRanking: ['desc(posted_at)', 'desc(weight)']
+        customRanking: [
+          'desc(posted_at)',
+          'desc(weight.tag_name)',
+          'asc(weight.position)'
+        ]
       }
       expect(index).to receive(:set_settings).with(hash_including(expected))
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Tim Carry
@@ -205,6 +205,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE.txt