feat(custom_ranking): Renaming the weight key to custom_ranking

This makes understanding its usage easier

README.md

@@ -89,7 +89,7 @@ Here is one of the records extracted:
     :lvl5 => nil,
     :lvl6 => nil
   },
-  :weight => {
+  :custom_ranking => {
     :heading => 70,
     :position => 3
   }
@@ -118,7 +118,7 @@ Anchors are searched in `name` and `id` attributes of headings.
 paragraph. The `lvlX` syntax is used to be compatible with the records
 [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

lib/algolia_html_extractor.rb

@@ -67,7 +67,7 @@ def self.run(input, options: {})
         hierarchy: current_hierarchy.clone,
         anchor: current_anchor,
         node: node,
-        weight: {
+        custom_ranking: {
           position: current_position,
           heading: heading_weight(current_lvl)
         }

spec/algolia_html_extractor_spec.rb

@@ -60,9 +60,9 @@
       actual = AlgoliaHTMLExtractor.run(input)
 
       # Then
-      expect(actual[0][:weight][:position]).to eq 0
-      expect(actual[1][:weight][:position]).to eq 1
-      expect(actual[2][:weight][:position]).to eq 2
+      expect(actual[0][:custom_ranking][:position]).to eq 0
+      expect(actual[1][:custom_ranking][:position]).to eq 1
+      expect(actual[2][:custom_ranking][:position]).to eq 2
     end
   end
 
@@ -428,7 +428,7 @@
       actual = AlgoliaHTMLExtractor.run(input)
 
       # Then
-      expect(actual[0][:weight][:heading]).to eq 100
+      expect(actual[0][:custom_ranking][:heading]).to eq 100
     end
 
     it 'should have decreasing value under small headers' do
@@ -444,12 +444,12 @@
       actual = AlgoliaHTMLExtractor.run(input)
 
       # Then
-      expect(actual[0][:weight][:heading]).to eq 90
-      expect(actual[1][:weight][:heading]).to eq 80
-      expect(actual[2][:weight][:heading]).to eq 70
-      expect(actual[3][:weight][:heading]).to eq 60
-      expect(actual[4][:weight][:heading]).to eq 50
-      expect(actual[5][:weight][:heading]).to eq 40
+      expect(actual[0][:custom_ranking][:heading]).to eq 90
+      expect(actual[1][:custom_ranking][:heading]).to eq 80
+      expect(actual[2][:custom_ranking][:heading]).to eq 70
+      expect(actual[3][:custom_ranking][:heading]).to eq 60
+      expect(actual[4][:custom_ranking][:heading]).to eq 50
+      expect(actual[5][:custom_ranking][:heading]).to eq 40
     end
   end
 end