jekyll-open-sdg-plugins 2.1.0.pre.beta1 → 2.2.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b54675415b0bc48b5f88576abdf876b6914ac17ab88c5b510d1aadefe706f22
-  data.tar.gz: 37e98d01d30cda580a96562b1364c5f8788c34372497622ec3ad785568bd0a01
+  metadata.gz: 82e500677f2b7d28cf2f0ad5bd9559d0dd4ab91c873b4b2619d54ab83383cb2c
+  data.tar.gz: 136c1ab6c3b3c53592dbf5e411a72578ac504e014f83a3d56965c7e24dd72d5f
 SHA512:
-  metadata.gz: 8f024b94736c76f6c9aab3629abc27af6d12539f0610b0722af3fe8a8c43a41a9dc038ed9a9972621aedfcb562507a2c2e4b627d6545ba062cdb41f15780a144
-  data.tar.gz: 45ef81eac3af62ca2b61517489109e8c4ff925ac3c5bb24e600e47dd2858f43e329703004cc0e2662f5fc314c90a1531868e2c3ff7d534a1f3ccb181c63dac01
+  metadata.gz: 55fa1efb7c666a0fa4aa52fafa36d51f635a0fcfddd7171546170fbbf41c05ddb688585cabd84993d095f0891ed0e4d6250f5bbd5ea1004948f753183be961b0
+  data.tar.gz: c490a887fe8a56151831476563639e84a40216fca4be75485a49ff734041beaedfde287844faffcc80b38c73abd2bedac555c655359b39a82bc70df9094a0e1c

data/.github/workflows/test-pull-requests.yml

@@ -10,8 +10,8 @@ jobs:
     steps:
     - uses: actions/checkout@v1
     - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: '2.6'
     - name: Run all tests
       run: make test

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

@@ -63,7 +63,12 @@ module JekyllOpenSdgPlugins
       @dir  = dir
       @name = 'index.html'
 
+      goal_heading = ''
       goal_content = ''
+      goal_content_heading = ''
+      if site.config['create_goals'].has_key?('goal_content_heading')
+        goal_content_heading = site.config['create_goals']['goal_content_heading']
+      end
       if site.config['create_goals'].has_key?('goals')
         # Try to find goal content by match the goal ID with a "goal" property on each item
         # in the create_goals.goals site config. Otherwise fallback to the order they appear
@@ -72,9 +77,21 @@ module JekyllOpenSdgPlugins
         goal_by_index = site.config['create_goals']['goals'][goal_index]
         if !goal_by_goal.nil?
           goal_content = goal_by_goal['content']
+          if goal_by_goal.has_key?('content_heading') && goal_by_goal['content_heading'] != ''
+            goal_content_heading = goal_by_goal['content_heading']
+          end
+          if goal_by_goal.has_key?('heading')
+            goal_heading = goal_by_goal['heading']
+          end
         elsif !goal_by_index.nil?
           if !goal_by_index.has_key?('goal') || goal_by_index['goal'].to_s == goal.to_s
             goal_content = goal_by_index['content']
+            if goal_by_index.has_key?('content_heading') && goal_by_index['content_heading'] != ''
+              goal_content_heading = goal_by_index['content_heading']
+            end
+            if goal_by_index.has_key?('heading')
+              goal_heading = goal_by_index['heading']
+            end
           end
         end
       end
@@ -85,6 +102,8 @@ module JekyllOpenSdgPlugins
       self.data['goal_number'] = goal.to_s
       self.data['language'] = language
       self.data['layout'] = layout
+      self.data['goal_content_heading'] = goal_content_heading
+      self.data['goal_heading'] = goal_heading
     end
   end
 end

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

@@ -55,7 +55,7 @@ module JekyllOpenSdgPlugins
         # Clone pages so that we don't edit the original.
         pages = pages.clone
 
-        # Automate the frontpage and indicators.json if not already there.
+        # Automate some required pages if not already there.
         frontpage = pages.find { |page| page['folder'] == '/' && page['filename'] == nil }
         if frontpage == nil || frontpage['layout'] == 'frontpage-alt'
           pages.push({
@@ -71,6 +71,20 @@ module JekyllOpenSdgPlugins
             'filename' => 'indicators.json'
           })
         end
+        if site.config.has_key?('progressive_web_app')
+          if site.config['progressive_web_app'].is_a?(Hash)
+            if site.config['progressive_web_app']['enabled']
+              offline = pages.find { |page| page['layout'] == 'offline' }
+              if offline == nil
+                pages.push({
+                  'folder' => '/',
+                  'layout' => 'offline',
+                  'filename' => 'offline.html'
+                })
+              end
+            end
+          end
+        end
 
         # Hardcode the site configuration page if it's not already there.
         form_settings = site.config['site_config_form']
@@ -114,6 +128,22 @@ module JekyllOpenSdgPlugins
           end
         end
       end
+
+      if site.config.has_key?('progressive_web_app') and site.config['progressive_web_app']['enabled']
+        language = site.config['languages'][0]
+        manifest_page = {
+          'filename' => 'manifest.json',
+          'folder' => '/',
+          'layout' => 'manifest',
+        }
+        service_worker_page = {
+          'filename' => 'service-worker.js',
+          'folder' => '/',
+          'layout' => 'service-worker',
+        }
+        site.collections['pages'].docs << OpenSdgPage.new(site, site.source, '/', manifest_page, language)
+        site.collections['pages'].docs << OpenSdgPage.new(site, site.source, '/', service_worker_page, language)
+      end
     end
   end
 

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

@@ -0,0 +1,35 @@
+require "jekyll"
+
+module JekyllOpenSdgPlugins
+  class MetaTags < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    def clean_path(path)
+      path.delete_prefix('/').delete_suffix('/')
+    end
+
+    def find_metatags_by_path(path, config)
+      config.select { |tag| clean_path(tag['path']) == path }
+    end
+
+    def generate(site)
+
+      # Some general variables needed below.
+      languages = site.config['languages']
+      default_language = languages[0]
+
+      if site.config.has_key?('meta_tags')
+        site.collections.keys.each do |collection|
+          if collection == 'pages'
+            site.collections[collection].docs.each do |doc|
+              cleaned_path = clean_path(doc.data['url_by_language'][default_language])
+              meta_tags = find_metatags_by_path(cleaned_path, site.config['meta_tags'])
+              doc.data['meta_tags'] = meta_tags
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,138 @@
+require "jekyll"
+require_relative "helpers"
+
+module JekyllOpenSdgPlugins
+  class Routes < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    def generate(site)
+
+      routes = {}
+      baseurl = ''
+      if site.config.has_key?('baseurl')
+        baseurl = site.config['baseurl']
+      end
+      unless baseurl.end_with?('/')
+        baseurl = baseurl + '/'
+      end
+
+      routes['pages'] = []
+      site.collections['pages'].docs.each do |doc|
+        route = baseurl + doc.url
+        route = route.gsub('//', '/')
+
+        unless route.end_with?('/') or route.end_with?('.html') or route.end_with?('.json')
+          route = route + '/'
+        end
+
+        unless doc.data['layout'] == 'config-builder' or doc.data['layout'] == 'data-editor'
+          routes['pages'].append(route)
+        end
+      end
+
+      routes['config'] = []
+      site.collections['pages'].docs.each do |doc|
+        route = baseurl + doc.url
+        route = route.gsub('//', '/')
+
+        unless route.end_with?('/') or route.end_with?('.html') or route.end_with?('.json')
+          route = route + '/'
+        end
+
+        if doc.data['layout'] == 'config-builder' or doc.data['layout'] == 'data-editor'
+          routes['config'].append(route)
+        end
+      end
+
+      routes['indicators'] = []
+      site.collections['indicators'].docs.each do |doc|
+        route = baseurl + doc.url
+        route = route.gsub('//', '/')
+
+        unless route.end_with?('/') or route.end_with?('.html') or route.end_with?('.json')
+          route = route + '/'
+        end
+        routes['indicators'].append(route)
+      end
+
+      routes['goals'] = []
+      site.collections['goals'].docs.each do |doc|
+        route = baseurl + doc.url
+        route = route.gsub('//', '/')
+
+        unless route.end_with?('/') or route.end_with?('.html') or route.end_with?('.json')
+          route = route + '/'
+        end
+        routes['goals'].append(route)
+      end
+
+      routes['posts'] = []
+      site.collections['posts'].docs.each do |doc|
+        route = baseurl + doc.url
+        route = route.gsub('//', '/')
+
+        unless route.end_with?('/') or route.end_with?('.html') or route.end_with?('.json')
+          route = route + '/'
+        end
+        routes['posts'].append(route)
+      end
+
+      routes['images'] = []
+      if site.config.has_key?('logos') and site.config['logos'].length > 0
+        site.config['logos'].each do |logo|
+          route = baseurl + logo['src']
+          routes['images'].append(route)
+        end
+      end
+
+      goal_image_base = 'https://open-sdg.org/sdg-translations/assets/img/goals'
+      if site.config.has_key?('goal_image_base')
+        goal_image_base = site.config['goal_image_base']
+      end
+      goal_image_extension = 'png'
+      if site.config.has_key?('goal_image_extension') && site.config['goal_image_extension'] != ''
+        goal_image_extension = site.config['goal_image_extension']
+      end
+      goal_image_base_contrast = goal_image_base.gsub('img/goals', 'img/high-contrast/goals')
+
+      site.collections['goals'].docs.each do |doc|
+        goal_number = doc.data['goal']['number']
+        language = doc.data['language']
+        if goal_number.is_a? Numeric
+          goal_number = goal_number.to_s
+        end
+        route = goal_image_base + '/' + language + '/' + goal_number + '.' + goal_image_extension
+        routes['images'].append(route)
+        unless goal_image_extension == 'svg'
+          route = goal_image_base_contrast + '/' + language + '/' + goal_number + '.' + goal_image_extension
+          routes['images'].append(route)
+        end
+      end
+
+      data_prefix = site.config['remote_data_prefix']
+      unless data_prefix.start_with?('http')
+        data_prefix = baseurl
+      end
+      unless data_prefix.end_with?('/')
+        data_prefix = data_prefix + '/'
+      end
+
+      routes['json'] = []
+      routes['csv'] = []
+      routes['zip'] = []
+      site.config['languages'].each do |language|
+        site.collections['indicators'].docs.each do |doc|
+          route = data_prefix + language + '/comb/' + doc.data['indicator']['slug'] + '.json'
+          routes['json'].append(route)
+          route = data_prefix + language + '/data/' + doc.data['indicator']['slug'] + '.csv'
+          routes['csv'].append(route)
+        end
+        route = data_prefix + language + '/zip/' + site.data[language]['zip']['filename']
+        routes['zip'].append(route)
+      end
+
+      site.data['routes'] = routes
+    end
+  end
+end

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

@@ -690,6 +690,41 @@
                 }
             ]
         },
+        "proxy": {
+            "title": "Proxy indicator",
+            "type": "string",
+            "description": "Whether the indicator is a 'proxy' (meaning that it is somehow different than the globally-defined SDG indicator).",
+            "enum": ["", "proxy", "both"],
+            "options": {
+                "enum_titles": [
+                    "Not a proxy indicator (default)",
+                    "Proxy indicator",
+                    "Both (contains both a proxy series and a non-proxy series)"
+                ]
+            },
+            "links": [
+                {
+                    "rel": "More information the proxy setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#proxy"
+                }
+            ]
+        },
+        "proxy_series": {
+            "options": {"collapsed": true},
+            "type": "array",
+            "title": "Proxy indicator - per series",
+            "description": "A list of each series within this indicator that should be considered a proxy (meaning that it is different somehow from the globally-defined series). Only needed if you chose 'Mixed series' above.",
+            "items": {
+                "type": "string",
+                "title": "Series"
+            },
+            "links": [
+                {
+                    "rel": "More information on the proxy_series setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#proxy_series"
+                }
+            ]
+        },
         "publications": {
             "options": {"collapsed": true},
             "type": "array",

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

@@ -145,12 +145,22 @@
                         "type": "object",
                         "title": "Goal",
                         "properties": {
+                            "heading": {
+                                "type": "string",
+                                "title": "Page heading",
+                                "description": "Optional heading to display in the goal banner (as an H1) for this goal. If left blank, the goal name will be used."
+                            },
                             "content": {
                                 "type": "string",
                                 "title": "Content",
                                 "format": "markdown",
                                 "description": "Markdown content or a translation key for this goal."
                             },
+                            "content_heading": {
+                                "type": "string",
+                                "title": "Content heading",
+                                "description": "Optional heading to display above the content (as an H2) for this goal. If left blank, the site-wide 'Goal content heading' (above) will be used."
+                            },
                             "goal": {
                                 "type": "string",
                                 "title": "Goal",
@@ -406,6 +416,17 @@
                 }
             ]
         },
+        "empty_metadata_placeholder_sources": {
+            "type": "string",
+            "title": "Empty metadata placeholder (sources)",
+            "description": "This setting controls the text that will display for any sources field which has no content. Note that this is not used if 'hide_empty_metadata' is true.",
+            "links": [
+                {
+                    "rel": "More information on the empty metadata placeholder (sources) setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#empty_metadata_placeholder_sources"
+                }
+            ]
+        },
         "environment": {
             "type": "string",
             "minLength": 1,
@@ -1126,6 +1147,42 @@
                 }
             ]
         },
+        "meta_tags": {
+            "options": {"collapsed": true},
+            "type": "array",
+            "title": "Meta tags",
+            "description": "This setting can be used to add custom meta tags at any paths.",
+            "items": {
+                "type": "object",
+                "title": "Meta tag",
+                "properties": {
+                    "path": {
+                        "type": "string",
+                        "minLength": 1,
+                        "title": "Path",
+                        "description": "The path within the platform at which to place this tag."
+                    },
+                    "name": {
+                        "type": "string",
+                        "minLength": 1,
+                        "title": "Name",
+                        "description": "The 'name' attribute for the meta tag."
+                    },
+                    "src": {
+                        "type": "string",
+                        "minLength": 1,
+                        "title": "Content",
+                        "description": "The 'content' attribute for the meta tag. Translation keys can be used."
+                    }
+                }
+            },
+            "links": [
+                {
+                    "rel": "More information on the Meta Tags setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#meta_tags"
+                }
+            ]
+        },
         "news": {
             "options": {"collapsed": true},
             "type": "object",
@@ -1203,6 +1260,60 @@
                 }
             ]
         },
+        "progressive_web_app": {
+            "options": {"collapsed": true},
+            "type": "object",
+            "title": "Progressive Web App",
+            "description": "Configuration for turning the platform into a progressive web app for offline usage.",
+            "properties": {
+                "enabled": {
+                    "type": "boolean",
+                    "title": "Enabled",
+                    "description": "If enabled, the platform will be a progressive web app for offline usage.",
+                    "format": "checkbox"
+                },
+                "name": {
+                    "type": "string",
+                    "title": "Name",
+                    "description": "The full name of the app (displays on splash screen)."
+                },
+                "short_name": {
+                    "type": "string",
+                    "title": "Short name",
+                    "description": "The short name of the app (displays under home screen icon)."
+                },
+                "precaching": {
+                    "type": "boolean",
+                    "title": "Precaching",
+                    "description": "If enabled, all indicator and goal pages will be precached when the app is installed.",
+                    "format": "checkbox"
+                }
+            },
+            "links": [
+                {
+                    "rel": "More information on the progressive_web_app setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#progressive_web_app"
+                }
+            ]
+        },
+        "proxy_indicators": {
+            "options": {"collapsed": true},
+            "type": "object",
+            "title": "Proxy indicators",
+            "description": "Configuration for the proxy indicator functionality.",
+            "properties": {
+                "label": {
+                    "type": "string",
+                    "title": "Label",
+                    "description": "The label to display when flagging a proxy indicator. Defaults to 'Proxy'."
+                },
+                "description": {
+                    "type": "string",
+                    "title": "Description",
+                    "description": "The description to display at the top of indicator pages, explaining what 'Proxy' means."
+                }
+            }
+        },
         "remote_data_prefix": {
             "type": "string",
             "minLength": 1,

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

@@ -130,6 +130,17 @@ module JekyllOpenSdgPlugins
       baseurl + number
     end
 
+    # Compute a sub-page URL for an item, given it's number.
+    def get_subpage_url(baseurl, language, number, languages, languages_public)
+      url = get_url(baseurl, language, number, languages, languages_public)
+      # Becuase Open SDG is a static site, subpages should end with
+      # a slash if they are not actual files (with file extensions).
+      unless url.split('/').last().include?('.')
+        url = url + '/'
+      end
+      url
+    end
+
     # Get a Hash of all the URLs based on one particular one.
     def get_all_urls(url, language, languages, languages_public, baseurl)
 
@@ -368,7 +379,7 @@ module JekyllOpenSdgPlugins
               '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, goal_number, languages, languages_public),
+              'url' => get_subpage_url(baseurl, language, goal_number, languages, languages_public),
               'icon' => get_goal_image(goal_image_base, language, goal_number, goal_image_extension),
               'sort' => get_sort_order(goal_number),
               'global' => global_goal,
@@ -421,7 +432,7 @@ module JekyllOpenSdgPlugins
             'number' => indicator_number,
             'slug' => indicator_number.gsub('.', '-'),
             'name' => opensdg_translate_key(indicator_name, translations, language),
-            'url' => get_url(baseurl, language, indicator_path, languages, languages_public),
+            'url' => get_subpage_url(baseurl, language, indicator_path, languages, languages_public),
             'sort' => indicator_sort,
             'goal_number' => goal_number,
             'target_number' => target_number,

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "2.1.0-beta1".freeze
+  VERSION = "2.2.0-beta1".freeze
 end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 2.1.0.pre.beta1
+  version: 2.2.0.pre.beta1
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -73,7 +73,9 @@ files:
 - lib/jekyll-open-sdg-plugins/create_pages.rb
 - lib/jekyll-open-sdg-plugins/fetch_remote_data.rb
 - lib/jekyll-open-sdg-plugins/helpers.rb
+- lib/jekyll-open-sdg-plugins/meta_tags.rb
 - lib/jekyll-open-sdg-plugins/metadata_schema_to_config.rb
+- lib/jekyll-open-sdg-plugins/routes.rb
 - lib/jekyll-open-sdg-plugins/schema-indicator-config.json
 - lib/jekyll-open-sdg-plugins/schema-site-config.json
 - lib/jekyll-open-sdg-plugins/sdg_variables.rb
@@ -106,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Jekyll plugins for use with the Open SDG platform