jekyll-open-sdg-plugins 1.6.1 → 1.7.0.pre.beta1

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

@@ -1,132 +1,132 @@
-# Simple collection of helper functions for use in these plugins.
-
-require "jekyll"
-
-# Takes a translation key and returns a translated string according to the
-# language of the current page. Or if none is found, returns the original
-# key.
-def opensdg_translate_key(key, translations, language)
-
-  # Safety code - abort now if key is nil.
-  if key.nil?
-    return ""
-  end
-
-  # Also make sure it is a string, and other just return it.
-  if not key.is_a? String
-    return key
-  end
-
-  # More safety code - abort now if key is empty.
-  if key.empty?
-    return ""
-  end
-
-  # Keep track of the last thing we drilled to.
-  drilled = translations[language]
-
-  # Keep track of how many levels we have drilled.
-  levels_drilled = 0
-  levels = key.split('.')
-
-  # Loop through each level.
-  levels.each do |level|
-
-    # If we have drilled down to a scalar value too soon, abort.
-    break if drilled.class != Hash
-
-    if drilled.has_key? level
-      # If we find something, continue drilling.
-      drilled = drilled[level]
-      levels_drilled += 1
-    end
-
-  end
-
-  # If we didn't drill the right number of levels, return the
-  # original string.
-  if levels.length != levels_drilled
-    return key
-  end
-
-  # Otherwise we must have drilled all they way.
-  return drilled
-end
-
-# Takes a site object and decides whether it is using translated builds.
-def opensdg_translated_builds(site)
-  # Assume the site is using translated builds.
-  translated_builds = true
-  site.config['languages'].each do |language|
-    # If any languages don't have a key in site.data, the site is not using
-    # translated builds.
-    if !site.data.has_key? language
-      translated_builds = false
-    end
-  end
-  return translated_builds
-end
-
-# Print a notice during compilation.
-def opensdg_notice(message)
-  Jekyll.logger.warn message.yellow
-end
-
-# Get the public language codes for a site, keyed by the actual language codes.
-def opensdg_languages_public(site)
-  languages_public = site.config['languages_public']
-
-  # The current structure of the setting is an array of hashes, each containing
-  # keys for "language" and "language_public".
-  if languages_public.is_a?(Array)
-    converted_languages_public = Hash.new
-    languages_public.each do |language_public|
-      language_code = language_public['language']
-      language_code_public = language_public['language_public']
-      converted_languages_public[language_code] = language_code_public
-    end
-    return converted_languages_public
-  end
-
-  # Fallback to exactly what was retrieved from site.confg['languages_public'],
-  # since the deprecated structure is exactly what this function wants.
-  return languages_public
-end
-
-# Print notices about a validation error.
-def opensdg_validation_error(error)
-  if error['type'] == 'required'
-    missing = []
-    error['schema']['required'].each do |required_property|
-      unless error['data'].has_key?(required_property)
-        message = 'Missing configuration setting: ' + required_property
-        if error['schema'].has_key?('title')
-          message += ' (' + error['schema']['title'] + ')'
-        end
-        opensdg_notice(message)
-      end
-    end
-  else
-    message = 'Validation error of type: ' + error['type']
-    if error['schema'] && error['schema'].has_key?('title')
-      message += ' (' + error['schema']['title'] + ')'
-    end
-    opensdg_notice(message)
-    if error['schema']
-      opensdg_notice('Expected schema:')
-      puts error['schema'].inspect
-    end
-    if error['data']
-      opensdg_notice('Actual data:')
-      puts error['data'].inspect
-    end
-  end
-end
-
-# Is this path a remote path?
-def opensdg_is_path_remote(path)
-  if path.nil?
-    return false
-  end
-  return path.start_with?('http')
-end
+# Simple collection of helper functions for use in these plugins.
+
+require "jekyll"
+
+# Takes a translation key and returns a translated string according to the
+# language of the current page. Or if none is found, returns the original
+# key.
+def opensdg_translate_key(key, translations, language)
+
+  # Safety code - abort now if key is nil.
+  if key.nil?
+    return ""
+  end
+
+  # Also make sure it is a string, and other just return it.
+  if not key.is_a? String
+    return key
+  end
+
+  # More safety code - abort now if key is empty.
+  if key.empty?
+    return ""
+  end
+
+  # Keep track of the last thing we drilled to.
+  drilled = translations[language]
+
+  # Keep track of how many levels we have drilled.
+  levels_drilled = 0
+  levels = key.split('.')
+
+  # Loop through each level.
+  levels.each do |level|
+
+    # If we have drilled down to a scalar value too soon, abort.
+    break if drilled.class != Hash
+
+    if drilled.has_key? level
+      # If we find something, continue drilling.
+      drilled = drilled[level]
+      levels_drilled += 1
+    end
+
+  end
+
+  # If we didn't drill the right number of levels, return the
+  # original string.
+  if levels.length != levels_drilled
+    return key
+  end
+
+  # Otherwise we must have drilled all they way.
+  return drilled
+end
+
+# Takes a site object and decides whether it is using translated builds.
+def opensdg_translated_builds(site)
+  # Assume the site is using translated builds.
+  translated_builds = true
+  site.config['languages'].each do |language|
+    # If any languages don't have a key in site.data, the site is not using
+    # translated builds.
+    if !site.data.has_key? language
+      translated_builds = false
+    end
+  end
+  return translated_builds
+end
+
+# Print a notice during compilation.
+def opensdg_notice(message)
+  Jekyll.logger.warn message.yellow
+end
+
+# Get the public language codes for a site, keyed by the actual language codes.
+def opensdg_languages_public(site)
+  languages_public = site.config['languages_public']
+
+  # The current structure of the setting is an array of hashes, each containing
+  # keys for "language" and "language_public".
+  if languages_public.is_a?(Array)
+    converted_languages_public = Hash.new
+    languages_public.each do |language_public|
+      language_code = language_public['language']
+      language_code_public = language_public['language_public']
+      converted_languages_public[language_code] = language_code_public
+    end
+    return converted_languages_public
+  end
+
+  # Fallback to exactly what was retrieved from site.confg['languages_public'],
+  # since the deprecated structure is exactly what this function wants.
+  return languages_public
+end
+
+# Print notices about a validation error.
+def opensdg_validation_error(error)
+  if error['type'] == 'required'
+    missing = []
+    error['schema']['required'].each do |required_property|
+      unless error['data'].has_key?(required_property)
+        message = 'Missing configuration setting: ' + required_property
+        if error['schema'].has_key?('title')
+          message += ' (' + error['schema']['title'] + ')'
+        end
+        opensdg_notice(message)
+      end
+    end
+  else
+    message = 'Validation error of type: ' + error['type']
+    if error['schema'] && error['schema'].has_key?('title')
+      message += ' (' + error['schema']['title'] + ')'
+    end
+    opensdg_notice(message)
+    if error['schema']
+      opensdg_notice('Expected schema:')
+      puts error['schema'].inspect
+    end
+    if error['data']
+      opensdg_notice('Actual data:')
+      puts error['data'].inspect
+    end
+  end
+end
+
+# Is this path a remote path?
+def opensdg_is_path_remote(path)
+  if path.nil?
+    return false
+  end
+  return path.start_with?('http')
+end

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

@@ -1,72 +1,72 @@
-require "jekyll"
-require_relative "helpers"
-
-module JekyllOpenSdgPlugins
-  class MetadataSchemaToConfig < Jekyll::Generator
-    safe true
-    priority :lowest
-
-    def generate(site)
-
-      # Convert the metadata schema from the internal format into JSONSchema so
-      # it can be used to create config forms.
-
-      language_config = site.config['languages']
-      form_settings = site.config['indicator_metadata_form']
-      t = site.data['translations']
-      lang = language_config[0]
-
-      if form_settings && form_settings['enabled']
-        scopes = ['national', 'global']
-        if form_settings && form_settings.has_key?('scopes')
-          if form_settings['scopes'].kind_of?(Array) && form_settings['scopes'].length() > 0
-            scopes = form_settings['scopes']
-          end
-        end
-        exclude_fields = []
-        if form_settings && form_settings.has_key?('exclude_fields')
-          if form_settings['exclude_fields'].kind_of?(Array) && form_settings['exclude_fields'].length() > 0
-            exclude_fields = form_settings['exclude_fields']
-          end
-        end
-        if form_settings && form_settings.has_key?('language') && form_settings['language'] != ''
-          lang = form_settings['language']
-        end
-
-        schema = {
-          "type" => "object",
-          "title" => opensdg_translate_key('indicator.edit_metadata', t, lang),
-          "properties" => {},
-        }
-
-        site.data['schema'].each do |field|
-          field_name = field['name']
-          field_scope = field['field']['scope']
-          next unless scopes.include?(field_scope)
-          next if exclude_fields.include?(field_name)
-
-          to_translate = field_name
-          if field['field'].has_key?('translation_key')
-            to_translate = field['field']['translation_key']
-          elsif t[lang].has_key?('metadata_fields') && t[lang]['metadata_fields'].has_key?(field_name)
-            to_translate = 'metadata_fields.' + field_name
-          elsif field['field'].has_key?('label')
-            to_translate = field['field']['label']
-          end
-          field_label = opensdg_translate_key(to_translate, t, lang)
-
-          schema['properties'][field_name] = {
-            "type" => "string",
-            "format" => "markdown",
-            "title" => field_label,
-            "description" => 'Scope: ' + field_scope + ', Field: ' + field_name,
-          }
-          schema['additionalProperties'] = true
-        end
-
-        # Regardless place the schema in site data so it can be used in Jekyll templates.
-        site.data['schema-indicator-metadata'] = schema
-      end
-    end
-  end
-end
+require "jekyll"
+require_relative "helpers"
+
+module JekyllOpenSdgPlugins
+  class MetadataSchemaToConfig < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    def generate(site)
+
+      # Convert the metadata schema from the internal format into JSONSchema so
+      # it can be used to create config forms.
+
+      language_config = site.config['languages']
+      form_settings = site.config['indicator_metadata_form']
+      t = site.data['translations']
+      lang = language_config[0]
+
+      if form_settings && form_settings['enabled']
+        scopes = ['national', 'global']
+        if form_settings && form_settings.has_key?('scopes')
+          if form_settings['scopes'].kind_of?(Array) && form_settings['scopes'].length() > 0
+            scopes = form_settings['scopes']
+          end
+        end
+        exclude_fields = []
+        if form_settings && form_settings.has_key?('exclude_fields')
+          if form_settings['exclude_fields'].kind_of?(Array) && form_settings['exclude_fields'].length() > 0
+            exclude_fields = form_settings['exclude_fields']
+          end
+        end
+        if form_settings && form_settings.has_key?('language') && form_settings['language'] != ''
+          lang = form_settings['language']
+        end
+
+        schema = {
+          "type" => "object",
+          "title" => opensdg_translate_key('indicator.edit_metadata', t, lang),
+          "properties" => {},
+        }
+
+        site.data['schema'].each do |field|
+          field_name = field['name']
+          field_scope = field['field']['scope']
+          next unless scopes.include?(field_scope)
+          next if exclude_fields.include?(field_name)
+
+          to_translate = field_name
+          if field['field'].has_key?('translation_key')
+            to_translate = field['field']['translation_key']
+          elsif t[lang].has_key?('metadata_fields') && t[lang]['metadata_fields'].has_key?(field_name)
+            to_translate = 'metadata_fields.' + field_name
+          elsif field['field'].has_key?('label')
+            to_translate = field['field']['label']
+          end
+          field_label = opensdg_translate_key(to_translate, t, lang)
+
+          schema['properties'][field_name] = {
+            "type" => "string",
+            "format" => "markdown",
+            "title" => field_label,
+            "description" => 'Scope: ' + field_scope + ', Field: ' + field_name,
+          }
+          schema['additionalProperties'] = true
+        end
+
+        # Regardless place the schema in site data so it can be used in Jekyll templates.
+        site.data['schema-indicator-metadata'] = schema
+      end
+    end
+  end
+end