jekyll-open-sdg-plugins 1.0.0.rc3 → 1.0.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e906019810630c3739bf804892b5dfcee29161b4ff5a21cc030aedf1e0897118
-  data.tar.gz: e1d7a573e7a3d621ea6407fde873be79b363efc38f21222fbd2e8ba9a34a5e05
+  metadata.gz: 8f50ca10fd9350b8b2e3010b8c17e971f38a4e49fc9866c6218f4f1486374a3f
+  data.tar.gz: 956ad212e0d4288410d4c121ad41d761a50e4e7ad4242db30f956db7310514de
 SHA512:
-  metadata.gz: 71b97782ea83f10d1452635692bc70428c1e61e6f8d6573898a20c6a8c6da315436c829497c8993ac75c9de2c6cabc7ad1380115a51e70f7bdd3be9605db1de3
-  data.tar.gz: 01a33c0033be841a0c181713c25da5fc16e59c453e57965b21114b13a536d1f3f54289a1878ffef832c9a875190f871fc7b4fb26326d0c20db4f5bb2bdc66110
+  metadata.gz: 559450040341021d19676dc1a57fed8cfadc42662ddeea40e7dd684e2dc57dd28735a62c27ea6aa594f3d030254cbd4fde9077cd8e632537e9feb7da51b0d754
+  data.tar.gz: 0af25756fd6504bb2d658fd62788386a57f5b7bea83435a276a0c4472c54f745070eea22f03e2ef8a1e5284e6052131f8173bc5e4b1faa2b54a2c26c168b85f9

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

@@ -5,6 +5,7 @@ require_relative "jekyll-open-sdg-plugins/translate_key"
 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/get_indicator_name"
 require_relative "jekyll-open-sdg-plugins/sdg_variables"
 
 module JekyllOpenSdgPlugins

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

@@ -0,0 +1,143 @@
+require "jekyll"
+require_relative "helpers"
+
+module Jekyll
+  module IndicatorName
+
+    # Takes an indicator ID (dot-delimited or dash-delimited) and returns the
+    # translated indicator name (according to the current language). This lookup
+    # is as forgiving as possible, to make sure that something is always there.
+    #
+    # The order of preference in the lookup is:
+    #
+    # 1. "indicator_name_national" in translated metadata - subfolder approach
+    # 2. "indicator_name_national" in translated metadata - translation key approach
+    # 3. If the default language, "indicator_name_national" in non-translated metadata
+    # 4. If a global indicator, translated global indicator name
+    # 5. "indicator_name" in translated metadata - subfolder approach
+    # 6. "indicator_name" in translated metadata - translation key approach
+    # 7. "indicator_name" in non-translated metadata
+    # 8. Finally, fall back to the indicator ID
+
+    def get_indicator_name(inid)
+
+      # Safety code - abort now if id is nil.
+      if inid.nil?
+        return ""
+      end
+
+      # Also make sure it is a string, and otherwise just return it.
+      if not inid.is_a? String
+        return inid
+      end
+
+      # More safety code - abort now if inid is empty.
+      if inid.empty?
+        return ""
+      end
+
+      # Normalize around dash-delimited inids.
+      inid = inid.gsub('.', '-')
+
+      # Some variables to help our lookups later.
+      page = @context.environments.first['page']
+      language = page['language']
+      languages = @context.registers[:site].config['languages']
+      data = @context.registers[:site].data
+      translations = data['translations']
+      meta = data['meta'][inid]
+
+      # The metadata fields that we'll seek, first "override" then "default".
+      override_field = 'indicator_name_national'
+      default_field = 'indicator_name'
+
+      name = false
+
+      # 1. Is there a subfolder translation of the override field?
+      if meta and meta.has_key? language
+        if !name and meta[language].has_key? override_field
+          name = meta[language][override_field]
+        end
+      end
+
+      # 2. Is the override field actually a "translation key"?
+      if !name
+        if meta and meta.has_key? override_field
+          untranslated = meta[override_field]
+          translated = opensdg_translate_key(untranslated, translations, language)
+          if untranslated != translated
+            # If the opensdg_translate_key() function returned something else,
+            # that means it was an actual "translation key".
+            name = translated
+          end
+        end
+      end
+
+      # 3. If this is the default language, use the non-translated override
+      # field, if available.
+      if !name
+        if language == languages[0]
+          if meta and meta.has_key? override_field
+            name = meta[override_field]
+          end
+        end
+      end
+
+      # 4. Is this a global indicator with a translation?
+      if !name
+        title_key = inid + '-title'
+        # For backwards compatibility, look for both dot and dash-delimited keys.
+        title_key_dots = inid.gsub('-', '.') + '-title'
+        if translations.has_key? language
+          if translations[language].has_key? 'global_indicators'
+            if translations[language]['global_indicators'].has_key? title_key
+              name = translations[language]['global_indicators'][title_key]
+            elsif translations[language]['global_indicators'].has_key? title_key_dots
+              name = translations[language]['global_indicators'][title_key_dots]
+            end
+          end
+        end
+      end
+
+      # 5. Is there a subfolder translation of the default field?
+      if !name
+        if meta and meta.has_key? language
+          if !name and meta[language].has_key? default_field
+            name = meta[language][default_field]
+          end
+        end
+      end
+
+      # 6. Is the default field actually a "translation key"?
+      if !name
+        if meta and meta.has_key? default_field
+          untranslated = meta[default_field]
+          translated = opensdg_translate_key(untranslated, translations, language)
+          if untranslated != translated
+            # If the opensdg_translate_key() function returned something else,
+            # that means it was an actual "translation key".
+            name = translated
+          end
+        end
+      end
+
+      # 7. Use the non-translated default field, if available.
+      if !name
+        if meta and meta.has_key? default_field
+          name = meta[default_field]
+        end
+      end
+
+      # 8. Still here? Just return the inid.
+      if !name
+        name = inid
+      end
+
+      # Finally return the name with key translation for good measure.
+      return opensdg_translate_key(name, translations, language)
+
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::IndicatorName)

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "1.0.0.rc3".freeze
+  VERSION = "1.0.0.rc4".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0.rc4
 platform: ruby
 authors:
 - Brock Fanning
@@ -55,6 +55,7 @@ files:
 - lib/jekyll-open-sdg-plugins/create_indicators.rb
 - lib/jekyll-open-sdg-plugins/create_pages.rb
 - lib/jekyll-open-sdg-plugins/fetch_remote_data.rb
+- lib/jekyll-open-sdg-plugins/get_indicator_name.rb
 - lib/jekyll-open-sdg-plugins/helpers.rb
 - lib/jekyll-open-sdg-plugins/multilingual_metadata.rb
 - lib/jekyll-open-sdg-plugins/sdg_variables.rb