middleman-search-gds 0.11.0a → 0.11.1

data/Jenkinsfile

@@ -0,0 +1,12 @@
+#!/usr/bin/env groovy
+
+library("govuk")
+
+node {
+  govuk.buildProject(
+    gemName: "middleman-search-gds",
+    overrideTestTask: {
+      // there are no tests in this repo, so the default `bundle exec rake` would fail
+    },
+  )
+}

data/README.md

@@ -49,9 +49,19 @@ 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` (i.e. 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
+Dynamic resources can be proxied as below:
+
+```ruby
+ProxyPages.resources.each do |resource|
+  proxy "/foo/#{resource.filename}.html", "templates/my_template.html", { title: resource.title }
+end
+```
+
+All fields values are retrieved from the resource `data` (i.e. its frontmatter), or from the `options` in the `resource.metadata` (i.e. any options specified in a `proxy` page - the third parameter in the example above). The exceptions are:
+
+- `url`, which is the actual resource url
+- `content`, which is by default the text extracted from the rendered resource (without its layout).
+  Indexing lots of content can cause performance issues, so you may want to override this field in the resource data (e.g. `content: ""`) if the page contents aren't relevant to the index.
 
 You can then query the index from Javascript via the `lunrIndex` object (see [Index file](#index-file) for more info):
 

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

@@ -128,17 +128,23 @@ module Middleman
       def value_for(resource, field, opts={})
         case field.to_s
         when 'content'
+          overridden_content = retrieve_custom_value(resource, field)
+          return overridden_content unless overridden_content.nil?
 
           html = resource.render( { :layout => false }, { :current_path => resource.path } )
           Nokogiri::HTML(html).xpath("//text()").text
         when 'url'
           resource.url
         else
-          value = resource.data.send(field) || resource.metadata.fetch(:options, {}).fetch(field, nil)
-          value ? Array(value).compact.join(" ") : nil
+          retrieve_custom_value(resource, field)
         end
       end
 
+      def retrieve_custom_value(resource, field)
+        value = resource.data.send(field) || resource.metadata.fetch(:options, {}).fetch(field, nil)
+        value ? Array(value).compact.join(" ") : nil
+      end
+
       private
 
       def minified_path(resource_name)

data/lib/middleman-search/version.rb

@@ -1,3 +1,3 @@
 module MiddlemanSearch
-  VERSION = "0.11.0a"
+  VERSION = "0.11.1"
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: middleman-search-gds
 version: !ruby/object:Gem::Version
-  version: 0.11.0a
+  version: 0.11.1
+  prerelease: 
 platform: ruby
 authors:
 - Government Digital Service
@@ -10,76 +11,86 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-29 00:00:00.000000000 Z
+date: 2020-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: execjs
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: LunrJS-based search for Middleman. This is an unofficial fork of the
@@ -92,9 +103,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - Gemfile
+- Jenkinsfile
 - LICENSE.txt
 - README.md
 - lib/middleman-search.rb
@@ -102,7 +114,7 @@ files:
 - lib/middleman-search/search-index-resource.rb
 - lib/middleman-search/version.rb
 - lib/middleman_extension.rb
-- middleman-search.gemspec
+- middleman-search-gds.gemspec
 - vendor/assets/javascripts/lunr.da.js
 - vendor/assets/javascripts/lunr.de.js
 - vendor/assets/javascripts/lunr.du.js
@@ -123,25 +135,26 @@ files:
 homepage: http://github.com/alphagov/middleman-search
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">"
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: LunrJS-based search for Middleman
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: f7a50a523cabca4a87a73bb6a1a87b765f1e0e3b
-  data.tar.gz: e62e0a792758b31fd98a00acf6bbe2091c6593be
-SHA512:
-  metadata.gz: a51080682bef38d99ea3a27958c34e30768454fc18e04432ca3ae26e6bf79325a7bcdc1b8b5ad6cd27787c183ef4499e3ad672ce2dc63ce2dae283cce18644f8
-  data.tar.gz: 6fa42ea890e06662dd5b876437a2b9b61cb8f6e57e0623fcedbd7870968130d8cc277baf4b815a751409b4dd9f0040cb1543c983fbd8a33aacad583107cc3aa5