middleman-search 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45b0b7ea39a4402d2b911c7d7b89506b32180ca3
-  data.tar.gz: 8108ba80710087dbb4a6988f82a0bd134e9f98e0
+  metadata.gz: 83d2b65441f0766102161c0489cedec031fb34fe
+  data.tar.gz: 612b8f30867b4695af0b39ead29304360bf1d644
 SHA512:
-  metadata.gz: 6eacff7d6a9016b9aec9ca43afc57f9e21db8f3e89c476beef83b47179007146ca28573a6a2fc9273bee9a73019303db031697d825953045649d409f96c7d77e
-  data.tar.gz: 8dba254174d7f2ec35cc21a5a8d97b40f17fec211aedf8565bc309c7ac65ef979de50048aefb7d3af1181095570314e3292a20c570d2d8a845794a8dae71e001
+  metadata.gz: 86b81ea83c06557e4f29e9a7823b88a96260a55dfbc36c268fb436ecd230df85adf7db9a74f2a7255a2ec1e5715ab5c38020e3933e227fc4e85a187c0ab0b12b
+  data.tar.gz: 8fab755798193a108e834998327d3350995b8f8027bb5476ffbfde35c3efbfa4eeab04e910185f740860dd06e6a551b3ac78bcbdebe488569ac391f4378aacb4

data/README.md

@@ -27,8 +27,14 @@ activate :search do
   search.fields = {
     title:   {boost: 100, store: true, required: true},
     content: {boost: 50},
-    url:     {index: false, store: true}
+    url:     {index: false, store: true},
+    author:  {boost: 30}
   }
+  search.before_index = Proc.new do |to_index, to_store, resource|
+    if author = resource.data.author
+      to_index[:author] = data.authors[author].name
+    end
+  end
 end
 ```
 
@@ -41,11 +47,13 @@ Where `resources` is a list of the beginning of the URL of the resources to inde
 
 Note that a special field `id` is included automatically, with an autogenerated identifier to be used as the `ref` for the document.
 
-All fields values are retrieved from the resource `data` (ie its frontmatter), or from a `data` hash inside its `options` in `resource.metadata`, except for:
+All fields values are retrieved from the resource `data` (ie its frontmatter), or from the `options` in the `resource.metadata` (i.e., any options specified in a `proxy` page), except for:
 - `url` which is the actual resource url
 - `content` the text extracted from the rendered resource, without including its layout
 
-You should also `require` the `lunr.min.js` file to your `all.js` file:
+The `before_index` option accepts a callback that will be executed for each resource, and will be executed with the document to be indexed and the map to be stored, in the `index` and `docs` objects of the output respectively (see below), as well as the resource being processed. You can use this callback to modify either of those, or `throw(:skip)` to skip the resource in question.
+
+You should also `require` the `lunr.min.js` file to your `all.js` file, to actually use the index for search in your website:
 
 ```javascript
 //= require lunr.min

data/lib/middleman-search/extension.rb

@@ -5,6 +5,7 @@ module Middleman
   class SearchExtension < Middleman::Extension
     option :resources, [], 'Paths of resources to index'
     option :fields, {}, 'Fields to index, with their options'
+    option :before_index, nil, 'Callback receiving (to_index, to_store, resource) to execute before indexing a document'
     option :index_path, 'search.json', 'Index file path'
 
     def manipulate_resource_list(resources)

data/lib/middleman-search/search-index-resource.rb

@@ -4,6 +4,7 @@ module Middleman
       def initialize(store, path, options)
         @resources_to_index = options[:resources]
         @fields = options[:fields]
+        @callback = options[:before_index]
         super(store, path)
       end
 
@@ -39,22 +40,28 @@ module Middleman
 
         # Iterate over all resources and build index
         @app.sitemap.resources.each_with_index do |resource, id|
-          catch(:required) do
-            next if resource.data['index'] == false
-            next unless @resources_to_index.any? {|whitelisted| resource.path.start_with? whitelisted }
+          begin
+            catch(:skip) do
+              next if resource.data['index'] == false
+              next unless @resources_to_index.any? {|whitelisted| resource.path.start_with? whitelisted }
 
-            to_index = Hash.new
-            to_store = Hash.new
+              to_index = Hash.new
+              to_store = Hash.new
 
-            @fields.each do |field, opts|
-              value = value_for(resource, field, opts)
-              throw(:required) if value.blank? && opts[:required]
-              to_index[field] = value unless opts[:index] == false
-              to_store[field] = value if opts[:store]
-            end
+              @fields.each do |field, opts|
+                value = value_for(resource, field, opts)
+                throw(:skip) if value.blank? && opts[:required]
+                to_index[field] = value unless opts[:index] == false
+                to_store[field] = value if opts[:store]
+              end
+
+              @callback.call(to_index, to_store, resource) if @callback
 
-            index.add(to_index.merge(id: id))
-            store[id] = to_store
+              index.add(to_index.merge(id: id))
+              store[id] = to_store
+            end
+          rescue => ex
+            logger.warn "Error processing resource for index: #{resource.path}\n#{ex}\n #{ex.backtrace.join("\n ")}"
           end
         end
 
@@ -73,7 +80,10 @@ module Middleman
       def value_for(resource, field, opts={})
         case field.to_s
         when 'content'
-          Nokogiri::HTML(resource.render(layout: false)).xpath("//text()").text
+          html = resource.render(layout: false) do
+            self.current_path = resource.path
+          end
+          Nokogiri::HTML(html).xpath("//text()").text
         when 'url'
           resource.url
         else

data/lib/middleman-search/version.rb

@@ -1,3 +1,3 @@
 module MiddlemanSearch
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-search
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Matías García Isaía
@@ -15,70 +15,70 @@ dependencies:
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: therubyracer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: LunrJS-based search for Middleman
@@ -89,8 +89,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,17 +111,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: LunrJS-based search for Middleman