jekyll-open-sdg-plugins 1.0.0 → 1.1.0

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

@@ -1,92 +1,92 @@
-require "jekyll"
-require_relative "helpers"
-
-module JekyllOpenSdgPlugins
-  class SearchIndex < Jekyll::Generator
-    safe true
-    priority :lowest
-    # NOTE: This must be executed **after** the sdg_variables.rb file, since it
-    # relies heavily on the variables created there.
-
-    # Helper function to prepare content for the search index.
-    def prepare_content(site, content)
-
-      # Handle nil content.
-      if !content
-        content = ''
-      end
-
-      # First compile any Markdown.
-      converter = site.find_converter_instance(::Jekyll::Converters::Markdown)
-      content = converter.convert(content)
-      # Now strip any HTML.
-      content = content.gsub(/<\/?[^>]*>/, "")
-      return content
-    end
-
-    def generate(site)
-
-      # Generate a hash of items to include in the search index.
-      search_items = {}
-
-      site.collections.keys.each do |collection|
-        site.collections[collection].docs.each do |doc|
-          # We segregate the search items by language.
-          language = doc.data['language']
-          if !search_items.has_key? language
-            search_items[language] = {}
-          end
-          # We'll be adding properties to this basic hash.
-          item = {
-            # The 'type' can be used on the front-end to describe a search result.
-            # It is assumed that all the collection names are translated in the
-            # "general" translation group. Eg: general.indicators, general.goals
-            'type' => opensdg_translate_key('general.' + collection, site.data['translations'], language)
-          }
-          if collection == 'indicators'
-            # For indicators, we assign the following properties for each item.
-            # The URL of the page.
-            item['url'] = doc.data['indicator']['url']
-            # For the title, use the indicator name.
-            item['title'] = doc.data['indicator']['name']
-            # For the content, use the 'page_content' field.
-            item['content'] = prepare_content(site, doc.data['indicator']['page_content'])
-            # For the id field, use the ID number.
-            item['id'] = doc.data['indicator']['number']
-            # Also index any additional metadata fields.
-            if site.config['search_index_extra_fields']
-              site.config['search_index_extra_fields'].each do |field|
-                if doc.data['indicator'].has_key? field
-                  item[field] = prepare_content(site, doc.data['indicator'][field])
-                end
-              end
-            end
-          elsif collection == 'goals'
-            # For goals, we assign the following properties for each item.
-            # The URL of the page.
-            item['url'] = doc.data['goal']['url']
-            # For the title we use the goal name.
-            item['title'] = doc.data['goal']['name']
-            # For the content, currently nothing here.
-            item['content'] = ''
-            # For the id field, use the ID number.
-            item['id'] = doc.data['goal']['number']
-          else
-            # Otherwise assume it is a normal Jekyll document.
-            item['url'] = File.join(doc.data['baseurl'], doc.url)
-            item['title'] = doc.data['title']
-            item['content'] = prepare_content(site, doc.content)
-            item['id'] = ''
-          end
-
-          # Save this item in the language-specific search index.
-          search_items[language][item['url']] = item
-        end
-      end
-
-      # Stow the data for later use in Jekyll templates.
-      site.data['search_items'] = search_items
-
-    end
-  end
-end
+require "jekyll"
+require_relative "helpers"
+
+module JekyllOpenSdgPlugins
+  class SearchIndex < Jekyll::Generator
+    safe true
+    priority :lowest
+    # NOTE: This must be executed **after** the sdg_variables.rb file, since it
+    # relies heavily on the variables created there.
+
+    # Helper function to prepare content for the search index.
+    def prepare_content(site, content)
+
+      # Handle nil content.
+      if !content
+        content = ''
+      end
+
+      # First compile any Markdown.
+      converter = site.find_converter_instance(::Jekyll::Converters::Markdown)
+      content = converter.convert(content)
+      # Now strip any HTML.
+      content = content.gsub(/<\/?[^>]*>/, "")
+      return content
+    end
+
+    def generate(site)
+
+      # Generate a hash of items to include in the search index.
+      search_items = {}
+
+      site.collections.keys.each do |collection|
+        site.collections[collection].docs.each do |doc|
+          # We segregate the search items by language.
+          language = doc.data['language']
+          if !search_items.has_key? language
+            search_items[language] = {}
+          end
+          # We'll be adding properties to this basic hash.
+          item = {
+            # The 'type' can be used on the front-end to describe a search result.
+            # It is assumed that all the collection names are translated in the
+            # "general" translation group. Eg: general.indicators, general.goals
+            'type' => opensdg_translate_key('general.' + collection, site.data['translations'], language)
+          }
+          if collection == 'indicators'
+            # For indicators, we assign the following properties for each item.
+            # The URL of the page.
+            item['url'] = doc.data['indicator']['url']
+            # For the title, use the indicator name.
+            item['title'] = doc.data['indicator']['name']
+            # For the content, use the 'page_content' field.
+            item['content'] = prepare_content(site, doc.data['indicator']['page_content'])
+            # For the id field, use the ID number.
+            item['id'] = doc.data['indicator']['number']
+            # Also index any additional metadata fields.
+            if site.config['search_index_extra_fields']
+              site.config['search_index_extra_fields'].each do |field|
+                if doc.data['indicator'].has_key? field
+                  item[field] = prepare_content(site, doc.data['indicator'][field])
+                end
+              end
+            end
+          elsif collection == 'goals'
+            # For goals, we assign the following properties for each item.
+            # The URL of the page.
+            item['url'] = doc.data['goal']['url']
+            # For the title we use the goal name.
+            item['title'] = doc.data['goal']['name']
+            # For the content, currently nothing here.
+            item['content'] = ''
+            # For the id field, use the ID number.
+            item['id'] = doc.data['goal']['number']
+          else
+            # Otherwise assume it is a normal Jekyll document.
+            item['url'] = File.join(doc.data['baseurl'], doc.url)
+            item['title'] = doc.data['title']
+            item['content'] = prepare_content(site, doc.content)
+            item['id'] = ''
+          end
+
+          # Save this item in the language-specific search index.
+          search_items[language][item['url']] = item
+        end
+      end
+
+      # Stow the data for later use in Jekyll templates.
+      site.data['search_items'] = search_items
+
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require "jekyll"
+require_relative "helpers"
+
+module JekyllOpenSdgPlugins
+  class SiteConfiguration < Jekyll::Generator
+    safe true
+    priority :highest
+
+    # This looks for site configuration in the data directory, and if found, copies it to
+    # the "site" object, as if it had been in _config.yml. It looks in "site_config" for
+    # configuration to move. In addition, if jekyll.environment or site.environment is
+    # specifically "production", then it also moves data from "site_config_prod".
+    #
+    # This allows you to keep all OpenSDG-specific config out of _config.yml, and instead
+    # place it in site_config and/or site_config_prod in your data directory.
+    def generate(site)
+
+      if site.data.has_key?('site_config')
+        hash_to_hash(site.data['site_config'], site.config)
+      end
+
+      production = false
+      if Jekyll.env == 'production'
+        production = true
+      end
+      if site.config.has_key?('environment') && site.config['environment'] == 'production'
+        production = true
+      end
+
+      if production && site.data.has_key?('site_config_prod')
+        hash_to_hash(site.data['site_config_prod'], site.config)
+      end
+
+    end
+
+    # Copy properties from a hash onto another hash.
+    def hash_to_hash(hash_from, hash_to)
+      hash_from.each do |key, value|
+        hash_to[key] = value
+      end
+    end
+  end
+end

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

@@ -1,72 +1,98 @@
-require "jekyll"
-require_relative "helpers"
-
-module Jekyll
-  module TranslateDate
-
-    # Takes a raw Jekyll date and returns a translated string according to the
-    # language of the current page and a date format given.
-    def t_date(date, format_type)
-
-      # Determine the language of the current page.
-      config = @context.registers[:site].config
-      translations = @context.registers[:site].data['translations']
-      language = @context.environments.first['page']['language']
-
-      # Try to find the specified date format in the site config. It needs to be
-      # something like this, assuming the "format_type" param is "standard":
-      # date_formats:
-      #   standard:
-      #     en: "%b %d, %Y"
-      #     es: "%d de %b de %Y"
-      #     etc...
-      date_format = '%b %d, %Y'
-      if config.has_key? 'date_formats'
-        if config['date_formats'].has_key? format_type
-          if config['date_formats'][format_type].has_key? language
-            date_format = config['date_formats'][format_type][language]
-          end
-        end
-      end
-
-      # Support timestamps.
-      if date.is_a? Integer
-        date = Time.at(date)
-      end
-
-      # Convert the date into English.
-      english = date.strftime(date_format)
-
-      # Now "tokenize" that date by spaces.
-      parts = english.split(' ')
-
-      translated_parts = []
-      parts.each do |part|
-        # Special case: see if we need to remove a comma from the end.
-        removed_comma = false
-        if part.end_with? ','
-          part = part.delete_suffix(',')
-          removed_comma = true
-        end
-        # Look for a translation in the "calendar" translation group.
-        key = 'calendar.' + part
-        translated_part = opensdg_translate_key(key, translations, language)
-        # If it changed from the key, that means it was a working key.
-        if key != translated_part
-          part = translated_part
-        end
-
-        # Add back the comma if needed.
-        if removed_comma
-          part = part + ','
-        end
-
-        translated_parts.push(part)
-      end
-
-      return translated_parts.join(' ')
-    end
-  end
-end
-
-Liquid::Template.register_filter(Jekyll::TranslateDate)
+require "jekyll"
+require_relative "helpers"
+
+module Jekyll
+  module TranslateDate
+
+    # Takes a raw Jekyll date and returns a translated string according to the
+    # language of the current page and a date format given.
+    def t_date(date, format_type)
+
+      # Determine the language of the current page.
+      config = @context.registers[:site].config
+      translations = @context.registers[:site].data['translations']
+      language = @context.environments.first['page']['language']
+
+      # Try to find the specified date format in the site config. It needs to be
+      # something like this, assuming the "format_type" param is "standard":
+      #
+      # date_formats:
+      #   - type: standard
+      #     language: en
+      #     format: "%b %d, %Y"
+      #   - type: standard
+      #     language: es
+      #     format: "%d de %b de %Y"
+      #
+      # However the following deprecated structure is also supported:
+      #
+      # date_formats:
+      #   standard:
+      #     en: "%b %d, %Y"
+      #     es: "%d de %b de %Y"
+      #     etc...
+      date_format = '%b %d, %Y'
+      if config.has_key?('date_formats')
+
+        # @deprecated start
+        # In a deprecated form of date_formats, it was a nested hash keyed first
+        # by the format type and then by the language.
+        if config['date_formats'].is_a?(Hash) && config['date_formats'].has_key?(format_type)
+          if config['date_formats'][format_type].has_key?(language)
+            date_format = config['date_formats'][format_type][language]
+          end
+        end
+        # @deprecated end
+
+        # In the current form of data_formats, it is an array of hashes, each
+        # containing "type", "language", and "format" keys.
+        if config['date_formats'].is_a?(Array)
+          date_format_config = config['date_formats'].find {|d| d['type'] == format_type && d['language'] == language }
+          if date_format_config
+            date_format = date_format_config['format']
+          end
+        end
+
+      end
+
+      # Support timestamps.
+      if date.is_a? Integer
+        date = Time.at(date)
+      end
+
+      # Convert the date into English.
+      english = date.strftime(date_format)
+
+      # Now "tokenize" that date by spaces.
+      parts = english.split(' ')
+
+      translated_parts = []
+      parts.each do |part|
+        # Special case: see if we need to remove a comma from the end.
+        removed_comma = false
+        if part.end_with? ','
+          part = part.delete_suffix(',')
+          removed_comma = true
+        end
+        # Look for a translation in the "calendar" translation group.
+        key = 'calendar.' + part
+        translated_part = opensdg_translate_key(key, translations, language)
+        # If it changed from the key, that means it was a working key.
+        if key != translated_part
+          part = translated_part
+        end
+
+        # Add back the comma if needed.
+        if removed_comma
+          part = part + ','
+        end
+
+        translated_parts.push(part)
+      end
+
+      return translated_parts.join(' ')
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::TranslateDate)

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

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

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

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