middleman-search 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ff1f3b4297260b66d44ad76238814ad83ff6de0
-  data.tar.gz: 4f904d1c14504ab484f218a9c3cc0a0eaf8f1623
+  metadata.gz: babd4c65f48bfaea3d9e56804730085f3da0d61d
+  data.tar.gz: dde7fcfe03b538ecf9ff05d2aba74afd26346f9b
 SHA512:
-  metadata.gz: 7c5b09f58427c7afd0e35ac3390bc0dc68d23d3b009346cdca6a37b98ef75e4c19d00c74b3e754e9b2f969141e97716b617a57080aca1d2e94b05bbe74132309
-  data.tar.gz: 59713cd375a9e56b813d7b6be60a0efeefedf1bc2ee93ec4db5f6d08b889362a54063955d688fbfed935640af1c57baf7d3bfc42bd1e4e26c11e8c8017901f21
+  metadata.gz: c852610b5e5e3a81842b26426196fe3c83918442d4044ff8adef2033273e1619476c8e3291a3a06299a3ef4222e625a9650a6a2ab8332f5a62e3b1a235b0010a
+  data.tar.gz: 0d085e9ae20acb842672f77fa8beb3ac3d7ecb840a8726ec1ec0f451b67ccb0f34127bed4089b4dabd6ecde5df87a342aab32f34d6f3f9045f2987079197379e

data/README.md

@@ -18,29 +18,51 @@ Or install it yourself as:
 
 ## Usage
 
-> **Notice**: this gem is a work in progress. While it already _works_, it still has lots of configurations hardcoded. You should monkey-patch the gem if its configuration doesn't suit you, or - even better - refactor it and send a pull request :)
-
 You need to activate the module in your `config.rb`, telling the extension how to index your resources:
 
 ```ruby
 activate :search do
   search.resources = ['blog/', 'index.html', 'contactus/index.html']
+  search.index_path = 'search/lunr-index.json' # defaults to `search.json`
   search.fields = {
-    title: {boost: 100, store: true, required: true},
-    body:  {boost: 50},
-    url:   {index: false, store: true}
+    title:   {boost: 100, store: true, required: true},
+    content: {boost: 50},
+    url:     {index: false, store: true}
   }
 end
 ```
 
-`resources` is a list of the beginning of the URL of the resources to index (tested with `String#start_with?`). `fields` is a hash with one entry for each field to be indexed, and a hash of options associated.
+Where `resources` is a list of the beginning of the URL of the resources to index (tested with `String#start_with?`), `index_path` is the relative path of the generated index file in your site, and `fields` is a hash with one entry for each field to be indexed, with a hash of options associated:
+
+- `boost` Specifies lunr relevance boost when searching this field
+- `store` Whether to store this field in the document map (see below), defaults to false
+- `index` Whether to index this field, defaults to true
+- `required` The resource will not be indexed if a field marked as required has an empty or null value
+
+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:
+- `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:
+
+```javascript
+//= require lunr.min
+```
+
+## Index file
+
+The generated index file contains a JSON object with two properties:
+- `index` contains the serialised lunr.js index, which you can load via `lunr.Index.load(lunrData.index)`
+- `docs` is a map from the autogenerated document ids to an object that contains the attributes configured for storage
 
-For each field, you can specify it's relevance `boost`, and whether to `index` that field's content or not.
+You will typically load the `index` into a lunr index instance, and then use the `docs` map to look up the returned value and present it to the user.
 
 ## Acknowledgments
 
 A big thank you to:
-- @Octo-Labs's @jagthedrummer for his [`middleman-alias`](https://github.com/Octo-Labs/middleman-alias) extension, in which we based for developing this one.
-- @jnovos and @256dpi, for their [`middleman-lunrjs`](https://github.com/jnovos/middleman-lunrjs) and [`middleman-lunr`](https://github.com/256dpi/middleman-lunr) extensions, which served as inspirations for making this one.
-- @olivernn and all [`lunr.js`](http://lunrjs.com/) [contributors](https://github.com/olivernn/lunr.js/graphs/contributors)
+- [Octo-Labs](https://github.com/Octo-Labs)'s [jagthedrummer](https://github.com/jagthedrummer) for his [`middleman-alias`](https://github.com/Octo-Labs/middleman-alias) extension, in which we based for developing this one.
+- [jnovos](https://github.com/jnovos) and [256dpi](https://github.com/256dpi), for their [`middleman-lunrjs`](https://github.com/jnovos/middleman-lunrjs) and [`middleman-lunr`](https://github.com/256dpi/middleman-lunr) extensions, which served as inspirations for making this one.
+- [olivernn](https://github.com/olivernn) and all [`lunr.js`](http://lunrjs.com/) [contributors](https://github.com/olivernn/lunr.js/graphs/contributors)
 - [The Middleman](https://middlemanapp.com/) [team](https://github.com/orgs/middleman/people) and [contributors](https://github.com/middleman/middleman/graphs/contributors)

data/lib/middleman-search/extension.rb

@@ -5,10 +5,10 @@ module Middleman
   class SearchExtension < Middleman::Extension
     option :resources, [], 'Paths of resources to index'
     option :fields, {}, 'Fields to index, with their options'
+    option :index_path, 'search.json', 'Index file path'
 
     def manipulate_resource_list(resources)
-      index_file_path = 'index.json'
-      resources.push Middleman::Sitemap::SearchIndexResource.new(@app.sitemap, index_file_path, @options)
+      resources.push Middleman::Sitemap::SearchIndexResource.new(@app.sitemap, @options[:index_path], @options)
       resources
     end
   end

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

@@ -16,15 +16,13 @@ module Middleman
       end
 
       def render
-        # FIXME: add lunr.min.js as a resource
-        lunr_source = File.expand_path('../../../vendor/lunr.min.js', __FILE__)
+        # Build js context
+        context = V8::Context.new
+        context.load(File.expand_path('../../../vendor/assets/javascripts/lunr.min.js', __FILE__))
+        context.eval('lunr.Index.prototype.indexJson = function () {return JSON.stringify(this);}')
 
-        cxt = V8::Context.new
-        cxt.load(lunr_source)
-        # add new method to lunr index
-        cxt.eval('lunr.Index.prototype.indexJson = function () {return JSON.stringify(this);}')
-        #Get the lunjs object
-        val = cxt.eval('lunr')
+        # Build lunr based on config
+        lunr = context.eval('lunr')
         lunr_conf = proc do |this|
           this.ref('id')
           @fields.each do |field, opts|
@@ -33,29 +31,35 @@ module Middleman
           end
         end
 
-        idx = val.call(lunr_conf)
-        map = Hash.new
+        # Get lunr index
+        index = lunr.call(lunr_conf)
 
-        @app.sitemap.resources.each_with_index do |resource, index|
-          next if resource.data['index'] == false
-          next unless @resources_to_index.any? {|whitelisted| resource.path.start_with? whitelisted }
+        # Ref to resource map
+        store = Hash.new
 
-          # FIXME: Use config to determine required fields
-          title = resource.data.title || resource.metadata[:options][:title] rescue nil
-          next if title.blank?
+        # 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 }
 
-          content = resource.render(layout: false)
-          text = Nokogiri::HTML(content).xpath("//text()").text
-          url = resource.url
-          description = resource.data.description || resource.metadata[:options][:description] rescue nil
-          tags = Array(resource.data.tags || []).join(", ")
+            to_index = Hash.new
+            to_store = Hash.new
 
-          # FIXME: Use config to determine what fields are indexed and stored
-          idx.add({title: title, body: text, description: description, tags: tags, id: index})
-          map[index] = { title: title, url: url }
+            @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
+
+            index.add(to_index.merge(id: id))
+            store[id] = to_store
+          end
         end
 
-        "{\"index\": #{idx.indexJson()}, \"map\": #{map.to_json}}"
+        # Generate JSON output
+        "{\"index\": #{index.indexJson()}, \"docs\": #{store.to_json}}"
       end
 
       def binary?
@@ -65,6 +69,18 @@ module Middleman
       def ignored?
         false
       end
+
+      def value_for(resource, field, opts={})
+        case field.to_s
+        when 'content'
+          Nokogiri::HTML(resource.render(layout: false)).xpath("//text()").text
+        when 'url'
+          resource.url
+        else
+          value = resource.data.send(field) || resource.metadata.fetch(:options, {}).fetch(:data, {}).fetch(field, nil)
+          value ? Array(value).compact.join(" ") : nil
+        end
+      end
     end
   end
 end

data/lib/middleman-search/version.rb

@@ -1,3 +1,3 @@
 module MiddlemanSearch
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-search
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Matías García Isaía
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-17 00:00:00.000000000 Z
+date: 2015-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -100,7 +100,7 @@ files:
 - lib/middleman-search/version.rb
 - lib/middleman_extension.rb
 - middleman-search.gemspec
-- vendor/lunr.min.js
+- vendor/assets/javascripts/lunr.min.js
 homepage: http://github.com/manastech/middleman-search
 licenses:
 - MIT