jekyll-open-sdg-plugins 1.5.0.pre.beta1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06e9d51fe6fddfeab87a899fb547b6b1762d0832d59de269f12d5bddd6aeedc4
-  data.tar.gz: 8f1728d821fffbb4cc51382cbc705e1e1e565c8b34cba3fbfdbe7bedd0ae4c3d
+  metadata.gz: ea24daaae4b8498fa13522aa018ddbd941fd634de1a4560f44545f658fb01503
+  data.tar.gz: 590a264c698030df46d090f1c279550eb814e8b41e86036711f6ba5722bf91da
 SHA512:
-  metadata.gz: 68c29fd1482b09b1b22875375277ea93e748d6f8bfa9a89e986cea37790782761ad5f790d1e49d12335578a048140e76e9979b6cd16c1a1cd7fcbca0356670a7
-  data.tar.gz: 8af06e8364fd7ce44039fab11617ba98ff6e8f6eb63ea5e9b4839fcb1bd36e81746d2ec333422159f10931737bda790719895e1f6e66a28fec5212b6116622fc
+  metadata.gz: cfc5cfc56bb2ad2cef06b4bd71db36b34815327a89759727bea1fed0e2f442dcf82368f378e41b9b1c00164f62b649cf559451a9023cc65bbd8027eba85fd00b
+  data.tar.gz: 0baaae1c694dc51dd7f769364369e71b02e9c26717828d245d5934532d546c7751fc892c9194da8dff488958b0d759b6d5b622a395c6229ae5c58865eb531410

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

@@ -0,0 +1,61 @@
+require "jekyll"
+require_relative "helpers"
+
+module JekyllOpenSdgPlugins
+  class BackwardsCompatibility < Jekyll::Generator
+    safe true
+    priority :low
+
+    def add_translation_keys(statuses, site)
+      statuses.each do |status|
+        status_var = 'value'
+        unless status.has_key?(status_var)
+          status_var = 'status'
+        end
+        status_in_site_config = site.config['reporting_status']['status_types'].detect {|s| s['value'] == status[status_var] }
+        if status_in_site_config.nil?
+          opensdg_notice('Unexpected reporting status type: ' + status[status_var] + '. Expected reporting status types:')
+          puts site.config['reporting_status']['status_types'].map { |s| s['value'] }
+        end
+        status['translation_key'] = status_in_site_config['label']
+      end
+    end
+
+    # This file is used to avoid any backwards compatibility issues
+    # as the Open SDG API changes over time.
+    def generate(site)
+
+      # Handle legacy treatment of reporting status types.
+      unless (site.config.has_key?('reporting_status') &&
+             site.config['reporting_status'].has_key?('status_types') &&
+             site.config['reporting_status']['status_types'].count > 0)
+        reporting_status = site.data['schema'].detect {|f| f['name'] == 'reporting_status' }
+        reporting_status_types = reporting_status['field']['options']
+        site.config['reporting_status']['status_types'] = reporting_status_types.map do |status_type|
+          {
+            'value' => status_type['value'],
+            'label' => status_type['translation_key'],
+          }
+        end
+      end
+
+      # Also fill in the "reporting" data with things needed by older templates.
+      add_translation_keys(site.data['reporting']['statuses'], site)
+      add_translation_keys(site.data['reporting']['overall']['statuses'], site)
+
+      if site.data['reporting'].has_key?('extra_fields')
+        site.data['reporting']['extra_fields'].each do |key, extra_field|
+          extra_field.each do |extra_field_value|
+            add_translation_keys(extra_field_value['statuses'], site)
+          end
+        end
+      end
+
+      if site.data['reporting'].has_key?('goals')
+        site.data['reporting']['goals'].each do |goal|
+          add_translation_keys(goal['statuses'], site)
+        end
+      end
+    end
+  end
+end

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

@@ -14,33 +14,6 @@ module JekyllOpenSdgPlugins
       form_settings_meta = site.config['indicator_metadata_form']
       form_settings_data = site.config['indicator_data_form']
 
-      # Special treatment of repository_link settings: prefix them
-      # with the repository_url_data site config if needed.
-      repo_url = site.config['repository_url_data']
-      if repo_url && repo_url != '' && repo_url.start_with?('http')
-        if form_settings_config != nil && form_settings_config && form_settings_config['enabled']
-          if form_settings_config['repository_link'] && form_settings_config['repository_link'] != ''
-            unless form_settings_config['repository_link'].start_with?('http')
-              form_settings_config['repository_link'] = repo_url + form_settings_config['repository_link']
-            end
-          end
-        end
-        if form_settings_meta != nil && form_settings_meta && form_settings_meta['enabled']
-          if form_settings_meta['repository_link'] && form_settings_meta['repository_link'] != ''
-            unless form_settings_meta['repository_link'].start_with?('http')
-              form_settings_meta['repository_link'] = repo_url + form_settings_meta['repository_link']
-            end
-          end
-        end
-        if form_settings_data != nil && form_settings_data && form_settings_data['enabled']
-          if form_settings_data['repository_link'] && form_settings_data['repository_link'] != ''
-            unless form_settings_data['repository_link'].start_with?('http')
-              form_settings_data['repository_link'] = repo_url + form_settings_data['repository_link']
-            end
-          end
-        end
-      end
-
       translations = site.data['translations']
       # If site.create_indicators is set, create indicators per the metadata.
       if (language_config and indicator_config and indicator_config.key?('layout') and indicator_config['layout'] != '')

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

@@ -81,15 +81,6 @@ module JekyllOpenSdgPlugins
         # Make sure the form settings are set.
         config_page = pages.find { |page| page['layout'] == 'config-builder' }
         if config_page != nil && form_settings && form_settings['enabled']
-          # Special treatment of repository_link.
-          if form_settings['repository_link'] && form_settings['repository_link'] != ''
-            unless form_settings['repository_link'].start_with?('http')
-              repo_url = site.config['repository_url_site']
-              if repo_url && repo_url != '' && repo_url.start_with?('http')
-                form_settings['repository_link'] = repo_url + form_settings['repository_link']
-              end
-            end
-          end
           config_page['form_settings'] = form_settings
         end
 

data/lib/jekyll-open-sdg-plugins/schema-indicator-config.json

@@ -613,11 +613,23 @@
                 ]
             }
         },
+        "progress_status": {
+            "type": "string",
+            "title": "Progress status",
+            "enum": ["not_available", "challenges_remain", "approaching_target", "target_achieved"],
+            "description": "The progress status of the indicator.",
+            "links": [
+                {
+                    "rel": "More information on the progress status setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#progress-status"
+                }
+            ]
+        },
         "reporting_status": {
             "type": "string",
             "title": "Reporting status",
             "enum": ["complete", "inprogress", "notstarted", "notapplicable"],
-            "description": "The status of the indicator.",
+            "description": "The reporting status of the indicator.",
             "links": [
                 {
                     "rel": "More information on the reporting status setting",

data/lib/jekyll-open-sdg-plugins/schema-site-config.json

@@ -175,7 +175,8 @@
                         "",
                         "goal",
                         "goal-by-target",
-                        "goal-by-target-vertical"
+                        "goal-by-target-vertical",
+                        "goal-with-progress"
                     ],
                     "options": {
                         "enum_titles": [
@@ -328,7 +329,6 @@
         },
         "data_edit_url": {
             "type": "string",
-            "minLength": 1,
             "title": "Data edit URL",
             "description": "This setting controls the URL of the 'Edit Data' buttons that appear on the staging site's indicator pages.",
             "links": [
@@ -470,6 +470,24 @@
                 }
             ]
         },
+        "favicons": {
+            "type": "string",
+            "title": "Favicons",
+            "description": "The type of favicons to use.",
+            "enum": ["legacy", "favicon.io"],
+            "options": {
+                "enum_titles": [
+                    "Legacy",
+                    "Favicon.io (recommended)"
+                ]
+            },
+            "links": [
+                {
+                    "rel": "More information on the favicons setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#favicons"
+                }
+            ]
+        },
         "footer_language_toggle": {
             "type": "string",
             "title": "Footer language toggle",
@@ -1129,7 +1147,6 @@
         },
         "metadata_edit_url": {
             "type": "string",
-            "minLength": 1,
             "title": "Metadata edit URL",
             "description": "This setting controls the URL of the 'Edit Metadata' buttons that appear on the staging site's indicator pages.",
             "links": [
@@ -1206,6 +1223,58 @@
                 }
             ]
         },
+        "progress_status": {
+            "options": {"collapsed": true},
+            "type": "object",
+            "title": "Progress status",
+            "description": "This setting is used in the 'goal-with-progress' layout. It controls the behavior of progress status functionality.",
+            "properties": {
+                "status_heading": {
+                    "title": "Status heading",
+                    "type": "string",
+                    "description": "A heading to display before the progress status on indicator pages."
+                },
+                "status_types": {
+                    "options": {"collapsed": true},
+                    "type": "array",
+                    "title": "Status types",
+                    "description": "Controls the behavior and labels for the different progress status types.",
+                    "items": {
+                        "type": "object",
+                        "title": "Status type",
+                        "properties": {
+                            "value": {
+                                "type": "string",
+                                "minLength": 1,
+                                "title": "Value",
+                                "description": "The value of the status type, as it is set in the indicator configuration (eg, 'targetachieved')."
+                            },
+                            "label": {
+                                "type": "string",
+                                "title": "Label",
+                                "description": "The human-readable label for the status type. Can be a translation key (eg, 'status.target_achieved')."
+                            },
+                            "image": {
+                                "type": "string",
+                                "title": "Image",
+                                "description": "The internal path to the image to use (if any) for this progress status."
+                            },
+                            "alt": {
+                                "type": "string",
+                                "title": "Alt",
+                                "description": "An alt tag for the image above."
+                            }
+                        }
+                    }
+                }
+            },
+            "links": [
+                {
+                    "rel": "More information on the progress status setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#progress_status"
+                }
+            ]
+        },
         "remote_data_prefix": {
             "type": "string",
             "minLength": 1,
@@ -1232,6 +1301,36 @@
                             "type": "boolean",
                             "description": "Whether or not to display disaggregation status tabs. If you enable this setting, you should also use 'expected_disaggregations' in your indicator configuration, in order to provide the disaggregation status report with useful metrics.",
                             "format": "checkbox"
+                        },
+                        "status_types": {
+                            "options": {"collapsed": true},
+                            "type": "array",
+                            "title": "Status types",
+                            "description": "Controls the behavior and labels for the different reporting status types.",
+                            "items": {
+                                "type": "object",
+                                "title": "Status type",
+                                "properties": {
+                                    "value": {
+                                        "type": "string",
+                                        "minLength": 1,
+                                        "title": "Value",
+                                        "description": "The value of the status type, as it is set in the indicator configuration (eg, 'complete')."
+                                    },
+                                    "label": {
+                                        "type": "string",
+                                        "minLength": 1,
+                                        "title": "Label",
+                                        "description": "The human-readable label for the status type. Can be a translation key (eg, 'status.reported_online')."
+                                    },
+                                    "hide_on_goal_pages": {
+                                        "type": "boolean",
+                                        "title": "Hide on goal pages",
+                                        "description": "Whether to hide this status type on goal pages. Useful for the most commonly-occuring type.",
+                                        "format": "checkbox"
+                                    }
+                                }
+                            }
                         }
                     }
                 }

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

@@ -40,6 +40,27 @@ module JekyllOpenSdgPlugins
             site.config[setting.downcase] = ENV[setting]
           end
       end
+
+      # Hardcode some variables.
+      site.config['disaggregation_status'] = {}
+      site.config['disaggregation_status']['status_types'] = [
+        {
+          'value' => 'complete',
+          'label' => 'status.disaggregation_status_complete',
+        },
+        {
+          'value' => 'inprogress',
+          'label' => 'status.disaggregation_status_inprogress',
+        },
+        {
+          'value' => 'notstarted',
+          'label' => 'status.disaggregation_status_notstarted',
+        },
+        {
+          'value' => 'notapplicable',
+          'label' => 'status.disaggregation_status_notapplicable',
+        },
+      ]
     end
 
     # Copy properties from a hash onto another hash.

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "1.5.0-beta1".freeze
+  VERSION = "1.6.0".freeze
 end

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

@@ -12,6 +12,7 @@ require_relative "jekyll-open-sdg-plugins/sdg_variables"
 require_relative "jekyll-open-sdg-plugins/search_index"
 require_relative "jekyll-open-sdg-plugins/validate_indicator_config"
 require_relative "jekyll-open-sdg-plugins/metadata_schema_to_config"
+require_relative "jekyll-open-sdg-plugins/backwards_compatibility"
 
 module JekyllOpenSdgPlugins
 end

data/tests/_config.yml

@@ -154,4 +154,15 @@ indicator_config_form:
 indicator_metadata_form:
   repository_link: https://github.com/open-sdg/open-sdg-data-starter/tree/develop/meta
   scopes:
-    - national
+    - national
+
+reporting_status:
+  status_types:
+    - value: complete
+      label: Complete
+    - value: notstarted
+      label: Not started
+    - value: inprogress
+      label: In progress
+    - value: notapplicable
+      label: Not applicable

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 1.5.0.pre.beta1
+  version: 1.6.0
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -67,6 +67,7 @@ files:
 - README.md
 - jekyll-open-sdg-plugins.gemspec
 - lib/jekyll-open-sdg-plugins.rb
+- lib/jekyll-open-sdg-plugins/backwards_compatibility.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
@@ -101,9 +102,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: