jekyll-open-sdg-plugins 1.0.0.rc22 → 1.2.0.pre.beta2

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

@@ -1,111 +1,111 @@
-require "jekyll"
-require_relative "helpers"
-
-module Jekyll
-  module TranslateMetadataField
-    # Takes a metadata field (machine name) and returns a translated string
-    # according to the language of the current page, suitable for displaying to
-    # the public. It gets this string by looking in the site's "schema" for a
-    # "translation_key" property, and running that through the
-    # opensdg_translate_key() helper function.
-    #
-    # Temporary backwards compatibility: If the check fails, it falls back to
-    # checking for a translation in the 'metadata_fields' translation group.
-    #
-    # More backwards compatibility: If all of the above fails, it falls back to
-    # using whatever is in a "label" property in the schema.
-    #
-    # Parameters
-    # ----------
-    # field_name : string
-    #   The machine name of a metadata field.
-    def translate_metadata_field(field_name)
-
-      # Determine the language of the current page.
-      t = @context.registers[:site].data['translations']
-      lang = @context.environments.first['page']['language']
-      # Get the schema.
-      schema = @context.registers[:site].data['schema']
-
-      # Find the field.
-      field = schema.select {|x| x['name'] == field_name }
-      if field
-        field = field.first()
-      end
-
-      to_translate = ''
-      # First choice - use the 'translation_key' property from the schema.
-      if field && field['field'].has_key?('translation_key')
-        to_translate = field['field']['translation_key']
-      # Next choice - try the 'metadata_fields' translation group.
-      elsif t[lang].has_key?('metadata_fields') && t[lang]['metadata_fields'].has_key?(field_name)
-        to_translate = 'metadata_fields.' + field_name
-      # Next choice - use the 'label' from the schema.
-      elsif field && field['field'].has_key?('label')
-        to_translate = field['field']['label']
-      # Last choice - just use the field name.
-      else
-        to_translate = field_name
-      end
-
-      return opensdg_translate_key(to_translate, t, lang)
-    end
-  end
-
-  module TranslateMetadataFieldOption
-    # Takes a metadata field (machine name) and option (value) and returns a
-    # translated string according to the language of the current page, suitable
-    # for displaying to the public.
-    #
-    # By contrast to TranslateMetadataField above, this is for translating the
-    # options of multiple-choice schema fields. But similar to
-    # TranslateMetadataField, this looks for a "translation_key" property on
-    # the option in the schema.
-    #
-    # Temporary backwards compatibility: If the check fails, it falls back to
-    # whatever is in a "name" property in the schema.
-    #
-    # Parameters
-    # ----------
-    # field_name : string
-    #   The machine name of a metadata field.
-    # value : string
-    #   The 'value' of the option to use.
-    def translate_metadata_field_option(field_name, value)
-
-      # Determine the language of the current page.
-      t = @context.registers[:site].data['translations']
-      lang = @context.environments.first['page']['language']
-      # Get the schema.
-      schema = @context.registers[:site].data['schema']
-
-      # Find the field.
-      field = schema.select {|x| x['name'] == field_name}
-      if field
-        field = field.first()
-      end
-
-      # Fall back to the value itself.
-      to_translate = value
-
-      # Look for the 'translation_key' property from the schema.
-      if field && field['field'].has_key?('options')
-        option = field['field']['options'].select {|x| x['value'] == value}
-        if option
-          option = option.first()
-          if option.has_key?('translation_key')
-            to_translate = option['translation_key']
-          else
-            to_translate = option['name']
-          end
-        end
-      end
-
-      return opensdg_translate_key(to_translate, t, lang)
-
-    end
-  end
-end
-
-Liquid::Template.register_filter(Jekyll::TranslateMetadataField)
-Liquid::Template.register_filter(Jekyll::TranslateMetadataFieldOption)
+require "jekyll"
+require_relative "helpers"
+
+module Jekyll
+  module TranslateMetadataField
+    # Takes a metadata field (machine name) and returns a translated string
+    # according to the language of the current page, suitable for displaying to
+    # the public. It gets this string by looking in the site's "schema" for a
+    # "translation_key" property, and running that through the
+    # opensdg_translate_key() helper function.
+    #
+    # Temporary backwards compatibility: If the check fails, it falls back to
+    # checking for a translation in the 'metadata_fields' translation group.
+    #
+    # More backwards compatibility: If all of the above fails, it falls back to
+    # using whatever is in a "label" property in the schema.
+    #
+    # Parameters
+    # ----------
+    # field_name : string
+    #   The machine name of a metadata field.
+    def translate_metadata_field(field_name)
+
+      # Determine the language of the current page.
+      t = @context.registers[:site].data['translations']
+      lang = @context.environments.first['page']['language']
+      # Get the schema.
+      schema = @context.registers[:site].data['schema']
+
+      # Find the field.
+      field = schema.select {|x| x['name'] == field_name }
+      if field
+        field = field.first()
+      end
+
+      to_translate = ''
+      # First choice - use the 'translation_key' property from the schema.
+      if field && field['field'].has_key?('translation_key')
+        to_translate = field['field']['translation_key']
+      # Next choice - try the 'metadata_fields' translation group.
+      elsif t[lang].has_key?('metadata_fields') && t[lang]['metadata_fields'].has_key?(field_name)
+        to_translate = 'metadata_fields.' + field_name
+      # Next choice - use the 'label' from the schema.
+      elsif field && field['field'].has_key?('label')
+        to_translate = field['field']['label']
+      # Last choice - just use the field name.
+      else
+        to_translate = field_name
+      end
+
+      return opensdg_translate_key(to_translate, t, lang)
+    end
+  end
+
+  module TranslateMetadataFieldOption
+    # Takes a metadata field (machine name) and option (value) and returns a
+    # translated string according to the language of the current page, suitable
+    # for displaying to the public.
+    #
+    # By contrast to TranslateMetadataField above, this is for translating the
+    # options of multiple-choice schema fields. But similar to
+    # TranslateMetadataField, this looks for a "translation_key" property on
+    # the option in the schema.
+    #
+    # Temporary backwards compatibility: If the check fails, it falls back to
+    # whatever is in a "name" property in the schema.
+    #
+    # Parameters
+    # ----------
+    # field_name : string
+    #   The machine name of a metadata field.
+    # value : string
+    #   The 'value' of the option to use.
+    def translate_metadata_field_option(field_name, value)
+
+      # Determine the language of the current page.
+      t = @context.registers[:site].data['translations']
+      lang = @context.environments.first['page']['language']
+      # Get the schema.
+      schema = @context.registers[:site].data['schema']
+
+      # Find the field.
+      field = schema.select {|x| x['name'] == field_name}
+      if field
+        field = field.first()
+      end
+
+      # Fall back to the value itself.
+      to_translate = value
+
+      # Look for the 'translation_key' property from the schema.
+      if field && field['field'].has_key?('options')
+        option = field['field']['options'].select {|x| x['value'] == value}
+        if option
+          option = option.first()
+          if option.has_key?('translation_key')
+            to_translate = option['translation_key']
+          else
+            to_translate = option['name']
+          end
+        end
+      end
+
+      return opensdg_translate_key(to_translate, t, lang)
+
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::TranslateMetadataField)
+Liquid::Template.register_filter(Jekyll::TranslateMetadataFieldOption)

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.0.0.rc22".freeze
-end
+module JekyllOpenSdgPlugins
+  VERSION = "1.2.0-beta2".freeze
+end

data/tests/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "jekyll", "3.8.4"
+gem "html-proofer"
+gem "jekyll-remote-theme"
+gem "deep_merge"
+gem "json_schemer"

data/tests/_config.yml

@@ -0,0 +1,147 @@
+# 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
+metadata_edit_url: http://prose.io/#open-sdg/open-sdg-data-starter/edit/develop/meta/[id].md
+languages:
+  - en
+
+title: Indicators For The Sustainable Development Goals
+url: ""
+data_dir: data
+environment: staging
+
+create_indicators:
+  layout: indicator
+create_goals:
+  layout: goal-by-target-vertical
+create_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
+
+analytics:
+  ga_prod: ''
+
+# Replace the email addresses below.
+email_contacts:
+  questions: test@example.com
+  suggestions: test@example.com
+  functional: test@example.com
+
+# International Support
+# Eg name: Australia and adjective: Australian
+country:
+  name: Australia
+  adjective: Australian
+
+# Optionally set a title/body for the frontpage banner. The defaults below point to a standard
+# translation, but feel free to change it as needed.
+frontpage_introduction_banner:
+  title: frontpage.intro_title
+  description: frontpage.intro_body
+
+frontpage_goals_grid:
+  title: Our data for Sustainable Development Goal indicators
+  description: Click on each goal for our Sustainable Development Goal global indicator data.
+
+frontpage_cards:
+  - title: frontpage.download_all
+    include: components/download-all-data.html
+  - title: Lorem ipsum
+    content: |
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi mollis
+      cursus est sed dapibus.
+    button_label: Read more
+    button_link: https://example.com
+  - title: Nam vestibulum
+    content: |
+      Nam vestibulum, purus quis porttitor imperdiet, nisl sem mollis nisl, a
+      interdum risus enim vitae tortor. Donec feugiat accumsan rutrum.
+    button_label: Read more
+    button_link: https://example.com
+
+# Pages
+collections:
+  pages:
+    output: true
+    permalink: /:path/
+  posts:
+    output: true
+    permalink: /news/:year/:month/:day/:title.html
+  indicators:
+    output: true
+  goals:
+    output: true
+
+# Menu
+menu:
+  # Use these to customise the main navigation.
+  - path: /goals
+    # The "translation_key" refers to the key in the SDG Translations repository.
+    translation_key: general.goals
+  - path: /reporting-status
+    translation_key: menu.reporting_status
+  - path: /about
+    translation_key: menu.about
+  - path: /guidance
+    translation_key: menu.guidance
+  - path: /faq
+    translation_key: menu.faq
+  - path: /news
+    translation_key: menu.updates
+
+footer_menu:
+  - path: mailto:my-email-address@example.com
+    translation_key: menu.contact_us
+  - path: https://twitter.com/MyTwitterAccount
+    translation_key: general.twitter
+  - path: https://facebook.com/MyFacebookAccount
+    translation_key: general.facebook
+  - path: /about/cookies-and-privacy/
+    translation_key: menu.cookies
+
+# Configure the text (or "translation key") to be used on the
+# non-global metadata tab.
+non_global_metadata: indicator.national_metadata
+
+# Set a base for all goal image URLs. Note that the full goal image path will be
+# the base below, completed with: /[language]/[number].png (eg, /fr/6.png).
+goal_image_base: https://open-sdg.org/sdg-translations/assets/img/goals
+
+# Exclude some files/folders.
+exclude:
+  - vendor
+  - scripts
+  - remotedata
+  - Gemfile
+  - Gemfile.lock
+  - README
+  - README.md
+  - LICENSE
+
+# Optionally uncomment and update the settings below to control the mapping functionality.
+# These are only a few of the possible settings. For more details, see:
+# https://open-sdg.readthedocs.io/en/latest/maps/
+#map_options:
+#  minZoom: 5
+#  tileURL: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'
+#  tileOptions:
+#    attribution: 'My map attribution'
+#map_layers:
+#  - min_zoom: 5
+#    max_zoom: 10
+#    subfolder: my-geojson-subfolder
+#    label: My map layer label (can be a translation key)