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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3ddcd012812807b48b5b94dbbedfe47d4c3187f60383439fa0eb26c1f28e90f
-  data.tar.gz: 64a473bdd4e7f3c64f2d9cf2e1c1e1b7659b2273f96b4089e0f4c74f0a8a09fb
+  metadata.gz: ec6a82fc746845dce8607f5828fc220a00cf4ba028d46abba039e73b76b28bb0
+  data.tar.gz: 4568e2076c2204fd8e0198e705a73a900b22e390faa18a215315ddceeee9a566
 SHA512:
-  metadata.gz: 3bc05be3e1b50b49560c235df08893590ba67ace6b59056c77d049f7bb650ce955cc1ec1257145a7a02835f5245f4d8e84816eda4cf616e31a9549dac519b96f
-  data.tar.gz: 994312f102ed250a8978d812aacc7d598767d062b5c9b065c420012311199345514cd0765b4af19bdd483bd684d9f83b405c3427c14ce54e9fcc93c7112650cb
+  metadata.gz: f42b5609bdc5adfdb846ec7be9e263ad1d7225ca17ccdb52699e13809a633c6025afb7cf1c0fd99d5c455107f9c65ff14fe3835639942b5a954e3490951c774d
+  data.tar.gz: 5906c9596f21a0e3c2613f80b730b00c3637cd54af49ad862a43aeb67b04ace9efee0f901a7b8cddba9616820ef7ea3145622a23ebbb07f42d788a871cc74546

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

@@ -1,6 +1,7 @@
 require_relative "jekyll-open-sdg-plugins/version"
 require_relative "jekyll-open-sdg-plugins/fetch_remote_data"
 require_relative "jekyll-open-sdg-plugins/translate_key"
+require_relative "jekyll-open-sdg-plugins/translate_metadata_field"
 require_relative "jekyll-open-sdg-plugins/create_indicators"
 require_relative "jekyll-open-sdg-plugins/create_goals"
 require_relative "jekyll-open-sdg-plugins/create_pages"

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

@@ -4,7 +4,7 @@ require_relative "helpers"
 module JekyllOpenSdgPlugins
   class CreateGoals < Jekyll::Generator
     safe true
-    priority :low
+    priority :normal
 
     def generate(site)
       # If site.create_goals is set, create goals per the metadata.

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

@@ -4,7 +4,7 @@ require_relative "helpers"
 module JekyllOpenSdgPlugins
   class CreateIndicators < Jekyll::Generator
     safe true
-    priority :low
+    priority :normal
 
     def generate(site)
       # If site.create_indicators is set, create indicators per the metadata.

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

@@ -3,7 +3,7 @@ require "jekyll"
 module JekyllOpenSdgPlugins
   class CreatePages < Jekyll::Generator
     safe true
-    priority :low
+    priority :normal
 
     def generate(site)
       # If site.create_pages is set, create the 4 required pages. These include:

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

@@ -4,7 +4,7 @@ require_relative "helpers"
 module JekyllOpenSdgPlugins
   class SDGVariables < Jekyll::Generator
     safe true
-    priority :lowest
+    priority :low
 
     # Get a goal number from an indicator number.
     def get_goal_number(indicator_number)
@@ -388,6 +388,7 @@ module JekyllOpenSdgPlugins
         end
       end
       site.data['sdg_lookup'] = lookup
+
     end
   end
 end

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

@@ -70,6 +70,7 @@ module JekyllOpenSdgPlugins
 
       # Stow the data for later use in Jekyll templates.
       site.data['search_items'] = search_items
+
     end
   end
 end

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

@@ -0,0 +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)

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "1.0.0.rc12".freeze
+  VERSION = "1.0.0.rc13".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.rc12
+  version: 1.0.0.rc13
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2020-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -59,6 +59,7 @@ files:
 - 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/translate_metadata_field.rb
 - lib/jekyll-open-sdg-plugins/version.rb
 homepage: https://github.com/open-sdg/jekyll-open-sdg-plugins
 licenses: