jekyll-open-sdg-plugins 0.0.16 → 1.0.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42c845017d3ecf63b717366da8ec9dac5225d045284ffa9036fab16ca3958849
-  data.tar.gz: 4f18d1a914218befe081ff043614daf4cca6132dcaabfc472b76f6c881c0ec64
+  metadata.gz: ad4f6ae4555c57263d1c047cf54ac804eb19683e5058afbb5a0b5b3aa9aced2f
+  data.tar.gz: 78d24d62d762145f03bbbdfed1f3025143c9877031dae119f9f87da623bda420
 SHA512:
-  metadata.gz: 5588f0573e669d34ed24dbbfab8d48138040d0780809ca061a9483f85020dea4a7a038dbd6b191e5cfaa37181c00b6cd0cb77dfc1e913f7a85260fd08f0bdf18
-  data.tar.gz: 242f366324fc26a9674e8aa3cea28e98e4e28386c991058696201d209ecb327b46746fe5ba7976689044b08a8a0b1ee959350a5567bad67bd66cd3aa1a1fe41a
+  metadata.gz: 482823ea2ba440a3a105905d0ae173b4f5fee0c36bdf939e23615a63cec0d8c31cfa6f267bfd280ded1954d8a5e62cad007605ef07bc86bffa37ff6dd2267101
+  data.tar.gz: 1cf3d356d08972d88966dace5dad7286a4684d0209b38ae8be0fd5b885877f7aa1c19cb4504b8dde50ee98901df6b22d127149c6abb8bcb7f7c96f803bbdd3f5

data/README.md

@@ -71,3 +71,83 @@ remote_translations:
 ```
 
 For those interested in switching to this convenience feature, note that this makes the "jekyll_get_json" and "remotedatabaseurl" settings obsolete; so they can be removed.
+
+## 7. Provide standard variables on all pages, for use in templates
+
+This feature provides access to Hashes for goals, targets, and indicators. Each
+contains the following keys:
+* number (eg, "1" for a goal, "1.1" for a target, "1.1.1" for an indicator)
+* slug (eg, "1" for a goal, "1-1", for a target, "1-1-1" for an indicator)
+* name (the fully-translated name of the goal/target/indicator
+* sort (a string suitable for use in sorting the goals/targets/indicators)
+* global (an equivalent Hash containing specifically "global" versions)
+
+Additionally, indicators contain:
+* url (the URL of that indicator's page)
+* goal_number (the number of that indicator's goal)
+* target_number (the number of that indicator's target)
+* [all the indicator's metadata fields]
+
+Additionally, targets contain:
+* goal_number (the number of that target's goal)
+
+Additionally, goals contain:
+* url (the URL of that goal's page)
+* icon (the URL of that goal's icon)
+* short (the short version of the goal name, translated)
+
+The following variables can be used on ALL pages:
+
+* goals : Array of goals
+* targets : Array of targets
+* indicators : Array of indicators
+* baseurl: A page-specific version of site.baseurl, taking language into account
+* language: The language code for the current page
+* language_public: The "public" language code, which may be different from the
+  language code.
+* t: A hash of all the compiled translations in the current language
+
+The following variables can be used on all indicator pages:
+
+* goal : the current goal
+* target : the current target
+* indicator : the current indicator
+
+The following variables can be used on all goal pages:
+
+* goal : the current goal
+
+Examples of usage:
+
+Printing titles for all available indicators in Goal 2:
+```
+{% assign indicators = page.indicators | where: "goal_number", "2" %}
+{% for indicator in indicators %}
+  {{ indicator.name }}
+{% endfor %}
+```
+
+Printing the short name for the current goal, on a goal page:
+```
+{{ page.goal.short }}
+```
+
+Printing the name of all targets in a particular, on that goal page:
+```
+{% assign targets = page.targets | where: "goal_number", page.goal.number %}
+{% for target in targets %}
+  {{ target.name }}
+{% endfor %}
+
+## 8. Lookup goals/targets/indicators by ID
+
+The hashes detailed above in #7 can also be looked up by id, with the `sdg_lookup` filter.
+
+Examples of usage:
+
+Looking up target 7.1 and printing its name
+
+```
+{% assign target = '7.1' | sdg_lookup %}
+{{ target.name }}
+```

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

@@ -5,7 +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
 end

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

@@ -53,9 +53,11 @@ module JekyllOpenSdgPlugins
 
       self.process(@name)
       self.data = {}
-      self.data['sdg_goal'] = goal.to_s
+      self.data['goal_number'] = goal.to_s
       self.data['language'] = language
       self.data['layout'] = layout
+      # Backwards compatibility:
+      self.data['sdg_goal'] = self.data['goal_number']
     end
   end
 end

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

@@ -47,9 +47,11 @@ module JekyllOpenSdgPlugins
 
       self.process(@name)
       self.data = {}
-      self.data['indicator'] = inid.gsub('-', '.')
+      self.data['indicator_number'] = inid.gsub('-', '.')
       self.data['layout'] = layout
       self.data['language'] = language
+      # Backwards compatibility:
+      self.data['indicator'] = self.data['indicator_number']
     end
   end
 end

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

@@ -0,0 +1,342 @@
+require "jekyll"
+require_relative "helpers"
+
+module JekyllOpenSdgPlugins
+  class SDGVariables < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    # Get a goal number from an indicator number.
+    def get_goal_number(indicator_number)
+      parts = indicator_number.split('.')
+      parts[0]
+    end
+
+    # Get a target number from an indicator number.
+    def get_target_number(indicator_number)
+      parts = indicator_number.split('.')
+      parts[0] + '.' + parts[1]
+    end
+
+    # Make any goal/target/indicator number suitable for use in sorting.
+    def get_sort_order(number)
+      if number.is_a? Numeric
+        number = number.to_s
+      end
+      sort_order = ''
+      parts = number.split('.')
+      parts.each do |part|
+        if part.length == 1
+          part = '0' + part
+        end
+        sort_order += part
+      end
+      sort_order
+    end
+
+    # Compute a URL for an item, given it's number.
+    def get_url(baseurl, language, default_language, number)
+      number = number.gsub('.', '-')
+      url = baseurl
+      if language != default_language
+        url += '/' + language
+      end
+      url + '/' + number
+    end
+
+    # Compute a URL for tha goal image, given it's number.
+    def get_goal_image(goal_image_base, language, number)
+      goal_image_base + '/' + language + '/' + number + '.png'
+    end
+
+    # This creates variables for use in Liquid templates under "page".
+    # We'll create lists of goals, targets, and indicators. These will be put
+    # on the page object. Eg: page.goals. In order to generate these lists
+    # we will make use of the metadata. Each item in the list will be a hash
+    # containing these keys:
+    # - name (translated)
+    # - number (the "id" or number, eg: 1, 1.2, 1.2.1, etc.)
+    # - slug (version of 'number' but with dashes instead of dots)
+    # - sort (for the purposes of sorting the items, if needed)
+    # - global (a Hash containing any equivalent global metadata)
+    # The goal hashes contain additional keys:
+    # - short (the translated short version of the name)
+    # - icon (path to the translated icon)
+    # - url (path to the goal page)
+    # The target hashes contain additional keys:
+    # - goal_number (the goal number for this target)
+    # The indicator hashes contain additional keys:
+    # - url (path to the indicator page)
+    # - goal_number (the goal number for this indicator)
+    # - target_number (the target number for this indicator)
+    # - [all metadata fields from the indicator]
+    # The lists are:
+    # - goals
+    # - targets
+    # - indicators
+    # Additionally, on indicator pages themselves, there are variables for
+    # the current goal/target/indicator:
+    # - goal
+    # - target
+    # - indicator
+    # Similarly, on goal pages themselves, there are variables for the current
+    # goal:
+    # - goal
+    def generate(site)
+
+      # Some general variables needed below.
+      translations = site.data['translations']
+      default_language = site.config['languages'][0]
+      baseurl = site.config['baseurl']
+      if baseurl == ''
+        baseurl = '/'
+      end
+      goal_image_base = site.config['goal_image_base']
+
+      # These keys are flagged as "protected" here so that we can make sure that
+      # country-specific metadata doesn't use any of these fields.
+      protected_keys = ['goals', 'goal', 'targets', 'target', 'indicators',
+        'indicator', 'language', 'name', 'number', 'sort', 'global', 'url',
+        'goal_number', 'target_number'
+      ]
+
+      # Figure out from our translations the global indicator numbers.
+      global_inids = translations[default_language]['global_indicators'].keys
+      global_inids = global_inids.select { |x| x.end_with? '-title' }
+      global_inids = global_inids.map { |x| x.gsub('-title', '').gsub('-', '.') }
+
+      # For available indicators, we simply map the "indicators" collection.
+      available_inids = site.collections['indicators'].docs.select { |x| x.data['language'] == default_language }
+      available_inids = available_inids.map { |x| x.data['indicator'] }
+      available_indicators = {}
+      available_targets = {}
+      available_goals = {}
+
+      # Some throwaway variables to keep track of what has been added.
+      already_added = {}
+
+      # Set up some empty hashes, per language.
+      site.config['languages'].each do |language|
+        available_goals[language] = []
+        available_targets[language] = []
+        available_indicators[language] = []
+        already_added[language] = []
+      end
+
+      # Populate the hashes.
+      available_inids.each do |indicator_number|
+        goal_number = get_goal_number(indicator_number)
+        target_number = get_target_number(indicator_number)
+        is_global_indicator = global_inids.index(indicator_number) != nil
+        # To get the name of global stuff, we can use predicable translation
+        # keys from the SDG Translations project. Eg: global_goals.1-title
+        goal_translation_key = 'global_goals.' + goal_number
+        target_translation_key = 'global_targets.' + target_number.gsub('.', '-')
+        indicator_translation_key = 'global_indicators.' + indicator_number.gsub('.', '-')
+
+        site.config['languages'].each do |language|
+          global_goal = {
+            'name' => opensdg_translate_key(goal_translation_key + '-title', translations, language),
+            # TODO: More global metadata about goals?
+          }
+          global_target = {
+            'name' => opensdg_translate_key(target_translation_key + '-title', translations, language),
+            # TODO: More global metadata about targets?
+          }
+          global_indicator = {}
+          if is_global_indicator
+            global_indicator = {
+              'name' => opensdg_translate_key(indicator_translation_key + '-title', translations, language),
+              # TODO: More global metadata about indicators?
+            }
+          end
+
+          # We have to get the metadata for the indicator/language.
+          meta = {}
+          # Currently the meta keys are dash-delimited. This is a little
+          # arbitrary (it's because they came from filenames) and could maybe
+          # be changed eventually to dot-delimited for consistency.
+          meta_key = indicator_number.gsub('.', '-')
+          # The location of the metadata is different depending on whether we are
+          # using "translated_builds" or not.
+          if site.config['translated_builds']
+            meta = site.data[language]['meta'][meta_key]
+          else
+            meta = site.data['meta'][meta_key]
+          end
+
+          # Set the goal for this language, once only.
+          if already_added[language].index(goal_number) == nil
+            already_added[language].push(goal_number)
+            available_goal = {
+              'number' => goal_number,
+              'slug' => goal_number.gsub('.', '-'),
+              'name' => opensdg_translate_key(goal_translation_key + '-title', translations, language),
+              'short' => opensdg_translate_key(goal_translation_key + '-short', translations, language),
+              'url' => get_url(baseurl, language, default_language, goal_number),
+              'icon' => get_goal_image(goal_image_base, language, goal_number),
+              'sort' => get_sort_order(goal_number),
+              'global' => global_goal,
+            }
+            available_goals[language].push(available_goal)
+          end
+          # Set the target for this language, once only.
+          if already_added[language].index(target_number) == nil
+            already_added[language].push(target_number)
+            available_target = {
+              'number' => target_number,
+              'slug' => target_number.gsub('.', '-'),
+              'name' => opensdg_translate_key(target_translation_key + '-title', translations, language),
+              'sort' => get_sort_order(target_number),
+              'goal_number' => goal_number,
+              'global' => global_target,
+            }
+            available_targets[language].push(available_target)
+          end
+          # Set the indicator for this language. Unfortunately we are currently
+          # using two possible fields for the indicator name:
+          # - indicator_name
+          # - indicator_name_national
+          # TODO: Eventually standardize around 'indicator_name' and drop support
+          # for 'indicator_name_national'.
+          indicator_name = ''
+          if meta.has_key? 'indicator_name_national'
+            indicator_name = meta['indicator_name_national']
+          else
+            indicator_name = meta['indicator_name']
+          end
+          available_indicator = {
+            'number' => indicator_number,
+            'slug' => indicator_number.gsub('.', '-'),
+            'name' => opensdg_translate_key(indicator_name, translations, language),
+            'url' => get_url(baseurl, language, default_language, indicator_number),
+            'sort' => get_sort_order(indicator_number),
+            'goal_number' => goal_number,
+            'target_number' => target_number,
+            'global' => global_indicator,
+          }
+          # Translate and add any metadata.
+          meta.each do |key, value|
+            if !protected_keys.include? key
+              available_indicator[key] = opensdg_translate_key(value, translations, language)
+            end
+          end
+          available_indicators[language].push(available_indicator)
+        end
+      end
+
+      # Sort all the items.
+      site.config['languages'].each do |lang|
+        available_goals[lang] = available_goals[lang].sort_by { |x| x['sort'] }
+        available_targets[lang] = available_targets[lang].sort_by { |x| x['sort'] }
+        available_indicators[lang] = available_indicators[lang].sort_by { |x| x['sort'] }
+      end
+
+      # Next set the stuff on each doc in certain collections, according
+      # to the doc's language. We'll be putting the global stuff on every
+      # page, goal, and indicator across the site. This may be a bit memory-
+      # intensive during the Jekyll build, but it is nice to have it available
+      # for consistency.
+      collections = ['pages', 'goals', 'indicators']
+      collections.each do |collection|
+        site.collections[collection].docs.each do |doc|
+          # Ensure it has a language.
+          if !doc.data.has_key? 'language'
+            doc.data['language'] = default_language
+          end
+          language = doc.data['language']
+          # Set these on the page object.
+          doc.data['goals'] = available_goals[language]
+          doc.data['targets'] = available_targets[language]
+          doc.data['indicators'] = available_indicators[language]
+          doc.data['t'] = site.data['translations'][language]
+          # Also figure out the language-specific baseurl and the "public"
+          # language code, in case it is different from the actual language.
+          language_public = language
+          if site.config['languages_public']
+            if site.config['languages_public'][language]
+              language_public = site.config['languages_public'][language]
+            end
+          end
+          baseurl = site.config['baseurl']
+          if baseurl == ''
+            baseurl = '/'
+          end
+          if default_language != language
+            baseurl += language_public + '/'
+          end
+          doc.data['baseurl'] = baseurl
+          doc.data['language_public'] = language_public
+
+          if collection == 'indicators'
+            # For indicators we also set the current indicator/target/goal.
+            if doc.data.has_key? 'indicator_number'
+              indicator_number = doc.data['indicator_number']
+            elsif doc.data.has_key? 'indicator'
+              # Backwards compatibility.
+              indicator_number = doc.data['indicator']
+            else
+              raise "Error: An indicator does not have 'indicator_number' property."
+            end
+            goal_number = get_goal_number(indicator_number)
+            target_number = get_target_number(indicator_number)
+            doc.data['goal'] = available_goals[language].find {|x| x['number'] == goal_number}
+            doc.data['target'] = available_targets[language].find {|x| x['number'] == target_number}
+            doc.data['indicator'] = available_indicators[language].find {|x| x['number'] == indicator_number}
+          elsif collection == 'goals'
+            # For goals we also set the current goal.
+            if doc.data.has_key? 'goal_number'
+              goal_number = doc.data['goal_number']
+            elsif doc.data.has_key? 'sdg_goal'
+              # Backwards compatibility.
+              goal_number = doc.data['sdg_goal']
+            else
+              raise "Error: A goal does not have 'goal_number' property."
+            end
+            doc.data['goal'] = available_goals[language].find {|x| x['number'] == goal_number}
+          end
+        end
+      end
+
+      # Finally let's set all these on the site object so that they can be
+      # easily looked up later.
+      lookup = {}
+      available_goals.each do |language, items|
+        lookup[language] = {}
+        items.each do |item|
+          number = item['number']
+          lookup[language][number] = item
+        end
+      end
+      available_targets.each do |language, items|
+        items.each do |item|
+          number = item['number']
+          lookup[language][number] = item
+        end
+      end
+      available_indicators.each do |language, items|
+        items.each do |item|
+          number = item['number']
+          lookup[language][number] = item
+        end
+      end
+      site.data['sdg_lookup'] = lookup
+    end
+  end
+end
+
+module Jekyll
+  module SDGLookup
+    # This provides a "sdg_lookup" filter that takes an id and returns a hash
+    # representation of a goal, target, or indicator.
+    def sdg_lookup(number)
+      number = number.gsub('-', '.')
+      data = @context.registers[:site].data
+      page = @context.environments.first['page']
+      language = page['language']
+      return data['sdg_lookup'][language][number]
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::SDGLookup)

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "0.0.16".freeze
+  VERSION = "1.0.0-rc1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 1.0.0.pre.rc1
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-16 00:00:00.000000000 Z
+date: 2019-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -55,9 +55,9 @@ 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
 - lib/jekyll-open-sdg-plugins/translate_key.rb
 - lib/jekyll-open-sdg-plugins/version.rb
 homepage: https://github.com/open-sdg/jekyll-open-sdg-plugins
@@ -75,12 +75,12 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.1
 signing_key: 
 specification_version: 4
 summary: Jekyll plugins for use with the Open SDG platform

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

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