jekyll-open-sdg-plugins 1.1.0 → 1.2.0.pre.beta1

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

@@ -347,9 +347,9 @@ module JekyllOpenSdgPlugins
           doc.data['t'] = site.data['translations'][language]
 
           # Set the remote_data_prefix for this page.
-          if site.config.has_key? 'remote_data_prefix'
+          if site.config.has_key? 'remote_data_prefix' && opensdg_is_path_remote(site.config['remote_data_prefix'])
             doc.data['remote_data_prefix'] = site.config['remote_data_prefix']
-          elsif site.config.has_key? 'local_data_folder'
+          else
             doc.data['remote_data_prefix'] = normalize_baseurl(baseurl)
           end
           if opensdg_translated_builds(site)

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

@@ -9,14 +9,18 @@ module JekyllOpenSdgPlugins
     # relies heavily on the variables created there.
 
     # Helper function to prepare content for the search index.
-    def prepare_content(site, content)
+    def prepare_content(site, content, language)
 
       # Handle nil content.
       if !content
         content = ''
       end
 
-      # First compile any Markdown.
+      # Strip whitespace.
+      content = content.strip
+      # Translate if needed.
+      content = opensdg_translate_key(content, site.data['translations'], language)
+      # Next compile any Markdown.
       converter = site.find_converter_instance(::Jekyll::Converters::Markdown)
       content = converter.convert(content)
       # Now strip any HTML.
@@ -31,6 +35,10 @@ module JekyllOpenSdgPlugins
 
       site.collections.keys.each do |collection|
         site.collections[collection].docs.each do |doc|
+          # Do not index configuration forms.
+          if doc.data.has_key?('layout') && doc.data['layout'] == 'config-builder'
+            next
+          end
           # We segregate the search items by language.
           language = doc.data['language']
           if !search_items.has_key? language
@@ -48,16 +56,17 @@ module JekyllOpenSdgPlugins
             # The URL of the page.
             item['url'] = doc.data['indicator']['url']
             # For the title, use the indicator name.
-            item['title'] = doc.data['indicator']['name']
+            indicator_label = opensdg_translate_key('general.indicator', site.data['translations'], language)
+            item['title'] = indicator_label + ' ' + doc.data['indicator']['number'] + ' - ' + doc.data['indicator']['name']
             # For the content, use the 'page_content' field.
-            item['content'] = prepare_content(site, doc.data['indicator']['page_content'])
+            item['content'] = prepare_content(site, doc.data['indicator']['page_content'], language)
             # For the id field, use the ID number.
             item['id'] = 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[field] = prepare_content(site, doc.data['indicator'][field])
+                  item[field] = prepare_content(site, doc.data['indicator'][field], language)
                 end
               end
             end
@@ -66,7 +75,8 @@ module JekyllOpenSdgPlugins
             # 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']
+            goal_label = opensdg_translate_key('general.goal', site.data['translations'], language)
+            item['title'] = goal_label + ' ' + doc.data['goal']['number'] + ' - ' + doc.data['goal']['name']
             # For the content, currently nothing here.
             item['content'] = ''
             # For the id field, use the ID number.
@@ -74,8 +84,8 @@ module JekyllOpenSdgPlugins
           else
             # Otherwise assume it is a normal Jekyll document.
             item['url'] = File.join(doc.data['baseurl'], doc.url)
-            item['title'] = doc.data['title']
-            item['content'] = prepare_content(site, doc.content)
+            item['title'] = prepare_content(site, doc.data['title'], language)
+            item['content'] = prepare_content(site, doc.content, language)
             item['id'] = ''
           end
 

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

@@ -0,0 +1,52 @@
+require "jekyll"
+require_relative "helpers"
+require "json"
+require "json_schemer"
+
+module JekyllOpenSdgPlugins
+  class ValidateIndicatorConfig < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    def generate(site)
+
+      schema_path = File.join(File.dirname(__FILE__), 'schema-indicator-config.json')
+      json_from_file = File.read(schema_path)
+      schema = JSON.parse(json_from_file)
+      schemer = JSONSchemer.schema(schema)
+
+      # Perform validation if the "validate_indicator_config" flag is true.
+      if site.config.has_key?('validate_indicator_config') && site.config['validate_indicator_config']
+        # We don't care too much what language we use, just get the first one.
+        language = 'en'
+        if site.config.has_key?('languages')
+          language = site.config['languages'][0]
+        end
+        metadata = {}
+        if opensdg_translated_builds(site)
+          metadata = site.data[language]['meta']
+        else
+          metadata = site.data['meta']
+        end
+        # Loop through the indicators (using metadata as a list).
+        validation_failed = false
+        metadata.each do |inid, meta|
+          unless schemer.valid?(meta)
+            validation_failed = true
+            opensdg_notice('Indicator ' + inid + ' configuration invalid:')
+            errors = schemer.validate(meta).to_a
+            errors.each { |error| opensdg_validation_error(error) }
+          end
+        end
+        if validation_failed
+          opensdg_notice "Some indicator configuration was not valid. See feedback above."
+          raise "Invalid indicator configuration"
+        end
+      end
+
+      # Regardless place the schema in site data so it can be used in Jekyll templates.
+      site.data['schema-indicator-config'] = schema
+
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require "jekyll"
+require_relative "helpers"
+require "json"
+require "json_schemer"
+
+module JekyllOpenSdgPlugins
+  class ValidateSiteConfig < Jekyll::Generator
+    safe true
+    priority :highest
+
+    def generate(site)
+
+      schema_path = File.join(File.dirname(__FILE__), 'schema-site-config.json')
+      json_from_file = File.read(schema_path)
+      schema = JSON.parse(json_from_file)
+      schemer = JSONSchemer.schema(schema)
+
+      # Perform validation if the "validate_site_config" flag is true.
+      if site.config.has_key?('validate_site_config') && site.config['validate_site_config']
+        unless schemer.valid?(site.config)
+          opensdg_notice('Site configuration invalid:')
+          errors = schemer.validate(site.config).to_a
+          errors.each { |error| opensdg_validation_error(error) }
+          opensdg_notice "The site configuration is not valid. See feedback above."
+          raise "Invalid site configuration"
+        end
+      end
+
+      # Regardless place the schema in site data so it can be used in Jekyll templates.
+      site.data['schema-site-config'] = schema
+
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "1.1.0".freeze
+  VERSION = "1.2.0-beta1".freeze
 end

data/tests/Gemfile

@@ -4,3 +4,4 @@ gem "jekyll", "3.8.4"
 gem "html-proofer"
 gem "jekyll-remote-theme"
 gem "deep_merge"
+gem "json_schemer"

data/tests/_config.yml

@@ -1,5 +1,8 @@
 # Jekyll configuration for Open SDG platform
 
+validate_site_config: true
+validate_indicator_config: true
+
 baseurl: "/open-sdg-site-starter"
 remote_data_prefix: "https://open-sdg.org/open-sdg-data-starter"
 data_edit_url: http://prose.io/#open-sdg/open-sdg-data-starter/edit/develop/data/indicator_[id].csv
@@ -17,18 +20,17 @@ create_indicators:
 create_goals:
   layout: goal-by-target-vertical
 create_pages:
-  pages:
-    - folder: /
-      layout: frontpage-alt
-    - folder: /goals
-      layout: goals
-    - folder: /reporting-status
-      layout: reportingstatus
-    - filename: indicators.json
-      folder: /
-      layout: indicator-json
-    - folder: /search
-      layout: search
+  - folder: /
+    layout: frontpage-alt
+  - folder: /goals
+    layout: goals
+  - folder: /reporting-status
+    layout: reportingstatus
+  - filename: indicators.json
+    folder: /
+    layout: indicator-json
+  - folder: /search
+    layout: search
 
 analytics:
   ga_prod: ''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0.pre.beta1
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-13 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: Jekyll plugins for use with the Open SDG platform
 email:
 - brockfanning@gmail.com
@@ -58,12 +72,16 @@ files:
 - lib/jekyll-open-sdg-plugins/create_pages.rb
 - lib/jekyll-open-sdg-plugins/fetch_remote_data.rb
 - lib/jekyll-open-sdg-plugins/helpers.rb
+- lib/jekyll-open-sdg-plugins/schema-indicator-config.json
+- lib/jekyll-open-sdg-plugins/schema-site-config.json
 - lib/jekyll-open-sdg-plugins/sdg_variables.rb
 - lib/jekyll-open-sdg-plugins/search_index.rb
 - lib/jekyll-open-sdg-plugins/site_configuration.rb
 - lib/jekyll-open-sdg-plugins/translate_date.rb
 - lib/jekyll-open-sdg-plugins/translate_key.rb
 - lib/jekyll-open-sdg-plugins/translate_metadata_field.rb
+- lib/jekyll-open-sdg-plugins/validate_indicator_config.rb
+- lib/jekyll-open-sdg-plugins/validate_site_config.rb
 - lib/jekyll-open-sdg-plugins/version.rb
 - tests/Gemfile
 - tests/_config.yml
@@ -82,9 +100,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key: