algolia_html_extractor 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3efc015000ed0122ea70417eb8a48a0f6c0ccde6
-  data.tar.gz: 6923bced71dfc762f8cf734efa96229ed55c46a4
+  metadata.gz: 2935d48da689f8b8064f82fe45d08294973b537b
+  data.tar.gz: e4eaf98057448f77c4ffa4472e479d8f331ccf48
 SHA512:
-  metadata.gz: d352d4b97686377e1869a48b6aa2f97900ae0e958eed630ef4cf103ffce63fac468e44a84e21bfcfb5beb89355a7d14a4974030ba75399778101a75e01d5955d
-  data.tar.gz: 3d7316d8e791a8d9fff538726e2b92de9e6a811190fd68fda3840e79e53f8db5bb4ed6b9752c772ee0a32431fb207cb27b57bfd6f6b1b603772f7cb62b6fdf52
+  metadata.gz: 2b97bd8f04d84d81bf5adbc4063163c43e3b5c53f2cfa8297b3fac07d0b3542ea3ca135068dbf9e63b3444b5604a2cd34645f79328491b14c7445eeafc897ab8
+  data.tar.gz: 1c7e7f1edfb75945ef179dffb5138f3fdb408273653e2c2612fcd7ff73c5d86eebf68aa1911bc65d4974ab867667b36a9d9e26a672ff50d94981e5eae6f88fbc

data/README.md

@@ -1,10 +1,11 @@
 # algolia_html_extractor
 
-[![Gem Version][1]](http://badge.fury.io/rb/algolia_html_extractor)
-[![Build Status][2]](https://travis-ci.org/algolia/html-extractor)
-[![Coverage Status][3]](https://coveralls.io/github/algolia/html-extractor?branch=master)
-[![Code Climate][4]](https://codeclimate.com/github/algolia/html-extractor)
-![Ruby >= 2.3.0][5]
+[![gem version][1]](https://rubygems.org/gems/algolia_html_extractor)
+![ruby][2]
+[![build master][3]](https://travis-ci.org/algolia/html-extractor)
+[![coverage master][4]](https://coveralls.io/github/algolia/html-extractor?branch=master)
+[![build develop][5]](https://travis-ci.org/algolia/html-extractor)
+[![coverage develop][6]](https://coveralls.io/github/algolia/html-extractor?branch=develop)
 
 This gem can convert HTML content into JSON records ready to be pushed to
 Algolia.
@@ -88,7 +89,7 @@ Here is one of the records extracted:
     :lvl5 => nil,
     :lvl6 => nil
   },
-  :weight => {
+  :custom_ranking => {
     :heading => 70,
     :position => 3
   }
@@ -99,13 +100,13 @@ Each record has a `objectID` that uniquely identify it (computed by a hash of al
 the other values).
 
 It also contains the HTML tag name in `tag_name` (by default `<p>`
-paragraphs are extracted, but see the [settings][6] on how to change it).
+paragraphs are extracted, but see the [settings][7] on how to change it).
 
 `html` contains the whole `outerContent` of the element, including the wrapping
 tags and inner children. The `text` attribute contains the textual content,
 stripping out all HTML.
 
-`node` contains the [Nokogiri node][7] instance. The lib uses it internally to
+`node` contains the [Nokogiri node][8] instance. The lib uses it internally to
 extract all the relevant information but is also exposed if you want to process
 the node further.
 
@@ -115,9 +116,9 @@ Anchors are searched in `name` and `id` attributes of headings.
 
 `hierarchy` then contains a snapshot of the current heading hierarchy of the
 paragraph. The `lvlX` syntax is used to be compatible with the records
-[DocSearch][8] is using.
+[DocSearch][9] is using.
 
-The `weight` attribute is used to provide an easy way to rank two records
+The `custom_ranking` attribute is used to provide an easy way to rank two records
 relative to each other.
 
 - `heading` gives the depth level in the hierarchy where the record is. Records
@@ -148,7 +149,7 @@ and generic bug reports.
 ## Bug Reports and feature requests
 
 For any bug or ideas of new features, please start by checking in the
-[issues][9] tab if
+[issues][10] tab if
 it hasn't been discussed already. If not, feel free to open a new issue.
 
 ## Pull Requests
@@ -217,11 +218,12 @@ convention. That's also why this gem directly starts at v2.0.
 
 
 [1]: https://badge.fury.io/rb/algolia_html_extractor.svg
-[2]: https://travis-ci.org/algolia/html-extractor.svg?branch=master
-[3]: https://coveralls.io/repos/algolia/html-extractor/badge.svg?branch=master&service=github
-[4]: https://codeclimate.com/github/algolia/html-extractor/badges/gpa.svg
-[5]: https://img.shields.io/badge/ruby-%3E%3D%202.3.0-green.svg
-[6]: #Settings
-[7]: http://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node
-[8]: https://community.algolia.com/docsearch/
-[9]: https://github.com/pixelastic/html-hierarchy-extractor/issues
+[2]: https://img.shields.io/badge/ruby-%3E%3D%202.3.0-green.svg
+[3]: https://img.shields.io/badge/dynamic/json.svg?label=build%3Amaster&query=value&uri=https%3A%2F%2Fimg.shields.io%2Ftravis%2Falgolia%2Fhtml-extractor.json%3Fbranch%3Dmaster
+[4]: https://img.shields.io/badge/dynamic/json.svg?label=coverage%3Amaster&colorB=&prefix=&suffix=%25&query=$.covered_percent&uri=https%3A%2F%2Fcoveralls.io%2Fgithub%2Falgolia%2Fhtml-extractor.json%3Fbranch%3Dmaster
+[5]: https://img.shields.io/badge/dynamic/json.svg?label=build%3Adevelop&query=value&uri=https%3A%2F%2Fimg.shields.io%2Ftravis%2Falgolia%2Fhtml-extractor.json%3Fbranch%3Ddevelop
+[6]: https://img.shields.io/badge/dynamic/json.svg?label=coverage%3Adevelop&colorB=&prefix=&suffix=%25&query=$.covered_percent&uri=https%3A%2F%2Fcoveralls.io%2Fgithub%2Falgolia%2Fhtml-extractor.json%3Fbranch%3Ddevelop
+[7]: #Settings
+[8]: http://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node
+[9]: https://community.algolia.com/docsearch/
+[10]: https://github.com/pixelastic/html-hierarchy-extractor/issues

data/lib/algolia_html_extractor.rb

@@ -67,7 +67,7 @@ module AlgoliaHTMLExtractor
         hierarchy: current_hierarchy.clone,
         anchor: current_anchor,
         node: node,
-        weight: {
+        custom_ranking: {
           position: current_position,
           heading: heading_weight(current_lvl)
         }

data/lib/version.rb

@@ -1,6 +1,6 @@
 # Expose gem version
 # rubocop:disable Style/SingleLineMethods
 class AlgoliaHTMLExtractorVersion
-  def self.to_s; '2.2.2' end
+  def self.to_s; '2.3.0' end
 end
 # rubocop:enable Style/SingleLineMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia_html_extractor
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Tim Carry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print