jekyll-open-sdg-plugins 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9b70242f00e6228710b67c6261811d51e3c0edba1c6f33161772d40773dcc7d
-  data.tar.gz: f4d8497479c9f63841f8a9d256422a2e22bce3fee2697550d180aa915cbbda9e
+  metadata.gz: dc7af2adda55aeb703e6ee1f419e9a21aa294df764c23f1a4700185827ed546b
+  data.tar.gz: 1447e290b59a47ed87ed0bd8d838535e44c9236a4ab799b237e6ee2dc76b1afb
 SHA512:
-  metadata.gz: f979af1073ddf69197f32468b4ed9a9dbf1edf2e8df74f866e6484f6365cbd0da5ed592936556bd63233b96d8edd0a152a6e1b0d6223cd1380ffed0c62a16a93
-  data.tar.gz: 7bf6a399bc7e04e65924754a9fe4622a003ec33ec218aa7f16cea093f42550534cc2ad543464d410d5f07d16f69113f394f5cf2928aef8d2448e95659f6a73d4
+  metadata.gz: 695adba003d784151e497271c83a4c356f7782f9e3b920ed024655aa786e50fd63a1fcf2602decb10f97254044ba7ed3ff20ba7c064f344996e9777246dc3a4f
+  data.tar.gz: d73f0c4f344a7150202863622e171061e0d56db6b2faa310316f1d5d40975e9972d86c698e93b8fcedac5f0c5313d38daee4a74ab979a13b014f737e95d145d6

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

@@ -0,0 +1,64 @@
+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']
+        unless site.config.has_key?('reporting_status')
+          site.config['reporting_status'] = {}
+        end
+        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,14 +175,16 @@
                         "",
                         "goal",
                         "goal-by-target",
-                        "goal-by-target-vertical"
+                        "goal-by-target-vertical",
+                        "goal-with-progress"
                     ],
                     "options": {
                         "enum_titles": [
                             "Do not automatically create goals",
                             "goal",
                             "goal-by-target",
-                            "goal-by-target-vertical"
+                            "goal-by-target-vertical",
+                            "goal-with-progress"
                         ]
                     },
                     "description": "The layout to use for the goal pages."
@@ -328,7 +330,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": [
@@ -1147,7 +1148,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": [
@@ -1224,6 +1224,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,
@@ -1250,6 +1302,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"
+                                    }
+                                }
+                            }
                         }
                     }
                 }
@@ -1341,17 +1423,6 @@
                 }
             ]
         },
-        "sharethis_property": {
-            "type": "string",
-            "title": "ShareThis property",
-            "description": "This setting creates a ShareThis widget along the left side of every page. It should be the property id for your ShareThis account.",
-            "links": [
-                {
-                    "rel": "More information on the sharethis setting",
-                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#sharethis_property"
-                }
-            ]
-        },
         "site_config_form": {
             "options": {"collapsed": true},
             "type": "object",

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".freeze
+  VERSION = "1.6.1".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
+  version: 1.6.1
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-11-19 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