jekyll-open-sdg-plugins 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87648f4556fee686eb7926015147d736d8d52081bbc8427c90b35c9bdced87b3
-  data.tar.gz: 228cc5b9614fb508ff1ebc85de543495ff1f0358bc12aad046946162ab3b4c7c
+  metadata.gz: 484259f4b5f990b178a77150a142b26d9cd9b2cd9e69e0f18b3b42b9d2e76ac2
+  data.tar.gz: 4721d1f5fb4c309d9383f060a5b1c663fd0812972cb5fc5f321dfa6514ea80cd
 SHA512:
-  metadata.gz: 3a65a769b229b002fb44d389ca2ce043e9a2356b21129ff95b9f4df217c53b0256da30403fd0586cd77ed492cc131b38eb81ab5a08744513b4dcdda4b2d1e2bb
-  data.tar.gz: 8b43c92ef8aa602960da11a0a977fa6bb75bb014574f276a3c6495f2d47767dfb6740c8b19e99f812eecf5ea82b40644dd83ea22f8e0da265f2bc626a276cdf5
+  metadata.gz: 76176dafc41bb541052d31f7379eb4064339c6c745a8b937b72dd90ab5f9a34cf8e8782e9e8dcffc918cdd0fd283ede45fcaf2d0ae9f13b152618dcf1158d7d0
+  data.tar.gz: 76166c2cb90fea4000065805853be8077dacb3dca414315aec90d20f09c963106a14b18782e94cc00dc7d8f8ae97cf21ef41a93fb6fd6fb932781ef5ce8e873f

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

@@ -3,6 +3,8 @@ require_relative "jekyll-open-sdg-plugins/multilingual_metadata"
 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"
 
 module JekyllOpenSdgPlugins
 end

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

@@ -0,0 +1,87 @@
+require "jekyll"
+
+module JekyllOpenSdgPlugins
+  class CreatePages < Jekyll::Generator
+    safe true
+    priority :low
+
+    def generate(site)
+      # If site.create_pages is set, create the 4 required pages. These include:
+      # - the home page: /
+      # - the indicators json page: /indicators.json
+      # - the search results page: /search
+      # - the reporting status page: /reporting-status
+      #
+      # These can be overridden though, with a create_pages.pages setting in
+      # _config.yml, like so:
+      #
+      # create_pages:
+      #   pages:
+      #     - folder: ''
+      #       layout: frontpage
+      #     - filename: my-json-file.json
+      #       folder: my-subfolder
+      #       layout: indicator-json
+      #
+      # Note the optional "filename" setting for when the page needs a specific
+      # filename (as opposed to being "index.html" inside a named folder).
+      #
+      # To use the default 4 pages, simply put:
+      #
+      # create_pages: true
+      if site.config['languages'] and site.config['create_pages']
+        default_pages = [
+          {
+            'folder' => '/',
+            'layout' => 'frontpage'
+          },
+          {
+            'folder' => '/reporting-status',
+            'layout' => 'reportingstatus'
+          },
+          {
+            'filename' => 'indicators.json',
+            'folder' => '/',
+            'layout' => 'indicator-json',
+          },
+          {
+            'folder' => '/search',
+            'layout' => 'search'
+          }
+        ]
+        pages = default_pages
+        if site.config['create_pages'].is_a?(Hash) and site.config['create_pages'].key?('pages')
+          pages = site.config['create_pages']['pages']
+        end
+
+        # Loop through the languages.
+        site.config['languages'].each_with_index do |language, index|
+          # Loop through the pages.
+          pages.each do |page|
+            # Add the language subfolder for all except the default (first) language.
+            dir = index == 0 ? page['folder'] : File.join(language, page['folder'])
+            # Create the page.
+            site.pages << OpenSdgPage.new(site, site.source, dir, page, language)
+          end
+        end
+      end
+    end
+  end
+
+  # A Page subclass used in the `CreatePages` class.
+  class OpenSdgPage < Jekyll::Page
+    def initialize(site, base, dir, page, language)
+      @site = site
+      @base = base
+
+      index_files = (!page.key?('filename') or page['filename'] == 'index.html')
+      @dir = index_files ? File.join(dir, '/') : dir
+      @name = index_files ? 'index.html' : page['filename']
+
+      self.process(@name)
+      self.data = {}
+      self.data['layout'] = page['layout']
+      self.data['language'] = language
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+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" or "title" in translated metadata
+    # 2. If the default language, "indicator_name" or "title" in non-translated metadata
+    # 3. if global, translated global indicator name
+    # 4. "indicator_name" or "title" in non-translated metadata
+    # 5. 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]
+      metadata_fields = ['indicator_name', 'title']
+
+      name = false
+
+      # First choice, is there a subfolder translation of any metadata fields?
+      if meta and meta.has_key? language
+        metadata_fields.each do |field|
+          if !name and meta[language].has_key? field
+            name = meta[language][field]
+          end
+        end
+      end
+
+      # Next choice, are any of the metadata fields a translation key?
+      if !name
+        metadata_fields.each do |field|
+          if !name and meta and meta.has_key? field
+            untranslated = meta[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
+      end
+
+      # Next, if this is the default language, use the non-translated fields
+      # if available.
+      if !name
+        if language == languages[0]
+          metadata_fields.each do |field|
+            if !name and meta and meta.has_key? field
+              name = meta[field]
+            end
+          end
+        end
+      end
+
+      # Next, is this a global indicator with a translation? For this we actually
+      # need the inid dot-delimited.
+      if !name
+        inid_dots = inid.gsub('-', '.')
+        if translations.has_key? language
+          if translations[language].has_key? 'global_indicators'
+            if translations[language]['global_indicators'].has_key? inid_dots
+              name = translations[language]['global_indicators'][inid_dots]['title']
+            end
+          end
+        end
+      end
+
+      # Next just return any untranslated metadata field.
+      if !name
+        metadata_fields.each do |field|
+          if !name and meta and meta.has_key? field
+            name = meta[field]
+          end
+        end
+      end
+
+      # 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/helpers.rb

@@ -0,0 +1,52 @@
+# Simple collection of helper functions for use in these plugins.
+
+# 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

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

@@ -1,4 +1,5 @@
 require "jekyll"
+require_relative "helpers"
 
 module Jekyll
   module TranslateKey
@@ -7,54 +8,11 @@ module Jekyll
     # key.
     def t(key)
 
-      # 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
-
       # Determine the language of the current page.
       translations = @context.registers[:site].data['translations']
       language = @context.environments.first["page"]['language']
 
-      # 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
+      return opensdg_translate_key(key, translations, language)
     end
   end
 end

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "0.0.7".freeze
+  VERSION = "0.0.9".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-17 00:00:00.000000000 Z
+date: 2019-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -39,6 +39,9 @@ files:
 - lib/jekyll-open-sdg-plugins.rb
 - lib/jekyll-open-sdg-plugins/create_goals.rb
 - lib/jekyll-open-sdg-plugins/create_indicators.rb
+- lib/jekyll-open-sdg-plugins/create_pages.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/translate_key.rb
 - lib/jekyll-open-sdg-plugins/version.rb