middleman-search 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dc491d945d930fbca061b6e1c93fa4d2f5b2d1e
-  data.tar.gz: 63d5f6e7adbe105b1a865f631c8b365151381951
+  metadata.gz: 1c257c2eca0252afe25ef8697e0b9a910c6d163f
+  data.tar.gz: 54436641815b65a80602fd0d6f21e13e9f4b375f
 SHA512:
-  metadata.gz: ba2d93142dda2dbae2736566e81e5d97e77a05c1fa5ac9acec09a8bf7f37764f2d1e720af4084d0aa980cab197049a32e4ae36c2c8ce83d38c7f23e0f42e2e37
-  data.tar.gz: a16b4903505af7c62a79d0936cf09296e211fba49dc6e4557465deb275b8e5f91dac8b306e3555ce3f03e184260d54a1b8cb487e3ead12f841981e09038836a4
+  metadata.gz: 29d4d336d5dab3f1289ff8d4183bbda35496a95cb8e55202108e93fdc059f44ae7bd11855cb139f95b0d21e019ddb459b67f1f04e242d787a3feb28e45f34ee8
+  data.tar.gz: 0980e91aca3b874aabfdb34fc200cce59c3504f211c84088d0c564a3a269a91eafa634d80febaff5898190180127cfc1346265ac2a383c2bc3fb88bba18e9487

data/README.md

@@ -94,7 +94,7 @@ This will register the `tildes` function in the lunr pipeline and add it when bu
 
 Note that if you add a function to the pipeline, it will also be loaded when de-serialising the index, and lunr will fail with an `Cannot load un-registered function: tildes` error if it has not been re-registered. You can either register them manually, or simply include the following in a `.js.erb` file to be executed __before__ loading the index:
 ```erb
-<%= lunr_js_pipeline %>
+<%= search_lunr_js_pipeline %>
 ```
 
 
@@ -112,6 +112,33 @@ You should also `require` the `lunr.min.js` file in your main sprockets javascri
 //= require lunr.min
 ```
 
+### Asset pipeline
+
+The Middleman pipeline does not include `json` files by default, but you can easily modify this by adding `.json` to the `exts` option of the corresponding extensions, such as `gzip` and `asset_hash`:
+
+```ruby
+activate :asset_hash do |asset_hash|
+  asset_hash.exts << '.json'
+end
+```
+
+Note that if you run the index json file through the asset hash extension, you will need to retrieve the actual destination URL when loading the file in the browser for searching, using the `search_index_path` view helper:
+
+```javascript
+var lunrIndex = null;
+var lunrData  = null;
+
+// Download index data
+$.ajax({
+  url: "<%= search_index_path %>",
+  cache: true,
+  method: 'GET',
+  success: function(data) {
+    lunrData = data;
+    lunrIndex = lunr.Index.load(lunrData.index);
+  }
+});
+```
 
 ## Acknowledgments
 

data/lib/middleman-search/extension.rb

@@ -15,12 +15,16 @@ module Middleman
     end
 
     helpers do
-      def lunr_js_pipeline
+      def search_lunr_js_pipeline
         # Thanks http://stackoverflow.com/a/20187415/12791
         extensions[:search].options[:pipeline].map do |name, function|
           "lunr.Pipeline.registerFunction(#{function}, '#{name}');"
         end.join("\n")
       end
+
+      def search_index_path
+        "/" + sitemap.find_resource_by_path(extensions[:search].options[:index_path]).destination_path
+      end
     end
   end
 end

data/lib/middleman-search/version.rb

@@ -1,3 +1,3 @@
 module MiddlemanSearch
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-search
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Matías García Isaía
@@ -9,76 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   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.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: LunrJS-based search for Middleman