middleman-search-gds 0.11.0a → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f7a50a523cabca4a87a73bb6a1a87b765f1e0e3b
-  data.tar.gz: e62e0a792758b31fd98a00acf6bbe2091c6593be
+SHA256:
+  metadata.gz: da8fdabed383e3f9b0113de262a53ec7c570e9852d7dd766d6f16ffca553974f
+  data.tar.gz: c3f9e64751b03205d21ed946c3df60203fb2a03f0f4ce895ea9b221932ff2161
 SHA512:
-  metadata.gz: a51080682bef38d99ea3a27958c34e30768454fc18e04432ca3ae26e6bf79325a7bcdc1b8b5ad6cd27787c183ef4499e3ad672ce2dc63ce2dae283cce18644f8
-  data.tar.gz: 6fa42ea890e06662dd5b876437a2b9b61cb8f6e57e0623fcedbd7870968130d8cc277baf4b815a751409b4dd9f0040cb1543c983fbd8a33aacad583107cc3aa5
+  metadata.gz: 93fbc2ae89a34470cfd9e29dca9d1279637b6a6b900642d8cf44c9b7e024df1bee4802b8307334340ce734eceb79882e0c32b27f8d7815c00122c8988a2d6209
+  data.tar.gz: d531d18d40a6b4d985fd4fe0aaf0135545c8476e72fdf1bb039a294cf3c69e920547a5f8a0398521d4a0840e3524683091421e2a4374332438213d6c0b205a87

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.11.2
+
+* No longer calls `File::exists?`, which was deleted from the standard library in [Ruby 3.2](https://www.ruby-lang.org/en/news/2022/12/25/ruby-3-2-0-released/).

data/README.md

@@ -16,6 +16,12 @@ Or install it yourself as:
 
     $ gem install middleman-search
 
+## Deployment
+
+New releases of this gem do not get deployed automatically.
+
+To release it you will need to follow the process to [publish to rubygems.org](https://guides.rubygems.org/publishing/#publishing-to-rubygemsorg), using the alphagov credentials - contact someone in GOV.UK senior tech for access.
+
 ## Usage
 
 You need to activate the module in your `config.rb`, telling the extension how to index your resources:
@@ -49,9 +55,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)
@@ -150,7 +156,7 @@ module Middleman
       def lunr_resource(resource_name)
         @lunr_dirs.flat_map do |dir|
           [File.join(dir, minified_path(resource_name)), File.join(dir, resource_name)]
-        end.detect { |file| File.exists? file } or raise "Couldn't find #{resource_name} nor #{minified_path(resource_name)} in #{@lunr_dirs.map {|dir| File.absolute_path dir }.join File::PATH_SEPARATOR}"
+        end.detect { |file| File.exist? file } or raise "Couldn't find #{resource_name} nor #{minified_path(resource_name)} in #{@lunr_dirs.map {|dir| File.absolute_path dir }.join File::PATH_SEPARATOR}"
       end
     end
   end

data/lib/middleman-search/version.rb

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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: middleman-search-gds
 version: !ruby/object:Gem::Version
-  version: 0.11.0a
+  version: 0.11.2
 platform: ruby
 authors:
 - Government Digital Service
 - Matías García Isaía
 - Santiago Palladino
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-29 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -94,6 +94,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -102,7 +103,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
@@ -124,7 +125,7 @@ homepage: http://github.com/alphagov/middleman-search
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,13 +136,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.4.7
+signing_key:
 specification_version: 4
 summary: LunrJS-based search for Middleman
 test_files: []