jekyll-open-sdg-plugins 1.0.0.rc11 → 1.0.0.rc12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3668b012dcfdd9957e10f37855cc46b01ca36fa7da976f45797c15272ebb4086
-  data.tar.gz: 3a87d3869abbe9286df6cf1656c1b0d7f2ab7d6aac033c959216a151fc741e9f
+  metadata.gz: f3ddcd012812807b48b5b94dbbedfe47d4c3187f60383439fa0eb26c1f28e90f
+  data.tar.gz: 64a473bdd4e7f3c64f2d9cf2e1c1e1b7659b2273f96b4089e0f4c74f0a8a09fb
 SHA512:
-  metadata.gz: a589b05b8c085a70ece51a29ba5435b00757ccd91b87f75b3e56c6f3fd9b22f3c3cb868a6a13b73472fee32f2ed6a4e0943ecdc5579eaf7396070db058964616
-  data.tar.gz: a330617aee360e7ad4ccbd0795bfcca9b5ae1943f79eca35814b34e963e2614ed74cb1d5bbf461377a4651a60f6d159ed6121e513c9df4bdfbd229cbf87bc581
+  metadata.gz: 3bc05be3e1b50b49560c235df08893590ba67ace6b59056c77d049f7bb650ce955cc1ec1257145a7a02835f5245f4d8e84816eda4cf616e31a9549dac519b96f
+  data.tar.gz: 994312f102ed250a8978d812aacc7d598767d062b5c9b065c420012311199345514cd0765b4af19bdd483bd684d9f83b405c3427c14ce54e9fcc93c7112650cb

data/lib/jekyll-open-sdg-plugins.rb

@@ -5,6 +5,7 @@ require_relative "jekyll-open-sdg-plugins/create_indicators"
 require_relative "jekyll-open-sdg-plugins/create_goals"
 require_relative "jekyll-open-sdg-plugins/create_pages"
 require_relative "jekyll-open-sdg-plugins/sdg_variables"
+require_relative "jekyll-open-sdg-plugins/search_index"
 
 module JekyllOpenSdgPlugins
 end

data/lib/jekyll-open-sdg-plugins/search_index.rb

@@ -0,0 +1,75 @@
+require "jekyll"
+require_relative "helpers"
+
+module JekyllOpenSdgPlugins
+  class SearchIndex < Jekyll::Generator
+    safe true
+    priority :lowest
+    # NOTE: This must be executed **after** the sdg_variables.rb file, since it
+    # relies heavily on the variables created there.
+
+    def generate(site)
+
+      # Generate a hash of items to include in the search index.
+      search_items = {}
+
+      site.collections.keys.each do |collection|
+        site.collections[collection].docs.each do |doc|
+          # We segregate the search items by language.
+          language = doc.data['language']
+          if !search_items.has_key? language
+            search_items[language] = {}
+          end
+          # We'll be adding properties to this basic hash.
+          item = {
+            # The 'type' can be used on the front-end to describe a search result.
+            # It is assumed that all the collection names are translated in the
+            # "general" translation group. Eg: general.indicators, general.goals
+            'type' => opensdg_translate_key('general.' + collection, site.data['translations'], language)
+          }
+          if collection == 'indicators'
+            # For indicators, we assign the following properties for each item.
+            # The URL of the page.
+            item['url'] = doc.data['indicator']['url']
+            # For the title, use the indicator name.
+            item['title'] = doc.data['indicator']['name']
+            # For the content, use the 'page_content' field.
+            item['content'] = doc.data['indicator']['page_content']
+            # For the hidden field, use the ID number.
+            item['hidden'] = doc.data['indicator']['number']
+            # Also index any additional metadata fields.
+            if site.config['search_index_extra_fields']
+              site.config['search_index_extra_fields'].each do |field|
+                if doc.data['indicator'].has_key? field
+                  item['hidden'] += ' ' + doc.data['indicator'][field]
+                end
+              end
+            end
+          elsif collection == 'goals'
+            # For goals, we assign the following properties for each item.
+            # The URL of the page.
+            item['url'] = doc.data['goal']['url']
+            # For the title we use the goal name.
+            item['title'] = doc.data['goal']['name']
+            # For the content, currently nothing here.
+            item['content'] = ''
+            # For the hidden field, use the ID number.
+            item['hidden'] = doc.data['goal']['number']
+          else
+            # Otherwise assume it is a normal Jekyll document.
+            item['url'] = doc.url
+            item['title'] = doc.data['title']
+            item['content'] = doc.content
+            item['hidden'] = ''
+          end
+
+          # Save this item in the language-specific search index.
+          search_items[language][item['url']] = item
+        end
+      end
+
+      # Stow the data for later use in Jekyll templates.
+      site.data['search_items'] = search_items
+    end
+  end
+end

data/lib/jekyll-open-sdg-plugins/version.rb

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "1.0.0.rc11".freeze
+  VERSION = "1.0.0.rc12".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc11
+  version: 1.0.0.rc12
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -57,6 +57,7 @@ files:
 - lib/jekyll-open-sdg-plugins/fetch_remote_data.rb
 - lib/jekyll-open-sdg-plugins/helpers.rb
 - lib/jekyll-open-sdg-plugins/sdg_variables.rb
+- lib/jekyll-open-sdg-plugins/search_index.rb
 - lib/jekyll-open-sdg-plugins/translate_key.rb
 - lib/jekyll-open-sdg-plugins/version.rb
 homepage: https://github.com/open-sdg/jekyll-open-sdg-plugins