jekyll-open-sdg-plugins 2.2.0 → 2.3.0.pre.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42253f06ce97a31363e04e179de524b96fc15e4fa72a278baa66ec50d1a62402
-  data.tar.gz: 991ab6a8dc272ce288e5f887e565ec0cd57a11a70816a8c5a79b277589f0f7fc
+  metadata.gz: 4944fa0ac86eba4e83bf4f3968446d4750af37f341e4f286dfe115faae4119da
+  data.tar.gz: 064bdf7b8c764545426078ea071dadc7ee6a0312a90c67f463e66140fd95f37a
 SHA512:
-  metadata.gz: a50172e38b2341293300c7c0a8d861e1b37ba54d9787cb405df81d2a6923e7191941cc14591066fc7fb1c1a635d24092e8db21301c3a8c4f363c79e330a709d0
-  data.tar.gz: 3c1678ff870ef6d9d84ff0ed84a63650a881344650a94ed84fdf066025b16cbf6b4001e0adf0a8fe8b6c742d0afeee0f123db6af571f14db4386b88e14740b00
+  metadata.gz: ec3a89e0a127bf08518ac704c4824b35c0b9a02eaa31c44f7bfa65b00362efd6a3a6ce5a87b3ea8578b5ba56c004ca7f323248e42aacf3d8e09a992e739aca7a
+  data.tar.gz: 5e5bf4015c3ba53b6d395dd5c3bfd0381813cec35b1a7c2c5d16141ce23e4df79441ac90a8a5d0466fbeb587d7fead29b500406623788b80384001c0812224de

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

@@ -6,12 +6,16 @@ jobs:
   test:
 
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7', '3.2' ]
 
+    name: Ruby ${{ matrix.ruby }} test
     steps:
     - uses: actions/checkout@v1
     - name: Set up Ruby 2.6
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '2.6'
+        ruby-version: ${{ matrix.ruby }}
     - name: Run all tests
       run: make test

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

@@ -13,6 +13,10 @@ module JekyllOpenSdgPlugins
       form_settings_config = site.config['indicator_config_form']
       form_settings_meta = site.config['indicator_metadata_form']
       form_settings_data = site.config['indicator_data_form']
+      config_builder_layout = 'config-builder'
+      #if site.config['use_new_config_forms']
+      #  config_builder_layout = 'config-builder-2'
+      #end
 
       translations = site.data['translations']
       # If site.create_indicators is set, create indicators per the metadata.
@@ -44,6 +48,11 @@ module JekyllOpenSdgPlugins
 
             # Create the indicator page.
             site.collections['indicators'].docs << IndicatorPage.new(site, site.source, dir, inid, language, layout)
+            # Also create the iframe version.
+            iframe_layout = 'indicator-iframe'
+            iframe_permalink = permalink + '-iframe'
+            iframe_dir = index == 0 ? iframe_permalink : File.join(language_public, iframe_permalink)
+            site.collections['pages'].docs << IndicatorPage.new(site, site.source, iframe_dir, inid, language, iframe_layout)
           end
         end
         # Create the indicator settings configuration/metadata/data pages.
@@ -105,7 +114,7 @@ module JekyllOpenSdgPlugins
                   dir = File.join(dir_base, 'config')
                   title = opensdg_translate_key('indicator.edit_configuration', translations, language)
                   config_type = 'indicator'
-                  site.collections['pages'].docs << IndicatorConfigPage.new(site, site.source, dir, inid, language, meta, title, config_type, form_settings_config)
+                  site.collections['pages'].docs << IndicatorConfigPage.new(site, site.source, dir, inid, language, meta, title, config_type, form_settings_config, config_builder_layout)
                 end
 
                 if do_indicator_meta_forms
@@ -116,7 +125,7 @@ module JekyllOpenSdgPlugins
                   dir = File.join(dir_base, 'metadata')
                   title = opensdg_translate_key('indicator.edit_metadata', translations, language)
                   config_type = 'metadata'
-                  site.collections['pages'].docs << IndicatorConfigPage.new(site, site.source, dir, inid, language, metadata_to_use, title, config_type, form_settings_meta)
+                  site.collections['pages'].docs << IndicatorConfigPage.new(site, site.source, dir, inid, language, metadata_to_use, title, config_type, form_settings_meta, config_builder_layout)
                 end
 
                 if do_indicator_data_forms
@@ -150,7 +159,7 @@ module JekyllOpenSdgPlugins
 
   # A Page subclass used in the `CreateIndicators` class for the indicator config forms.
   class IndicatorConfigPage < Jekyll::Page
-    def initialize(site, base, dir, inid, language, meta, title, config_type, form_settings)
+    def initialize(site, base, dir, inid, language, meta, title, config_type, form_settings, layout)
       @site = site
       @base = base
       @dir  = dir
@@ -161,7 +170,7 @@ module JekyllOpenSdgPlugins
       self.data['language'] = language
       self.data['indicator_number'] = inid
       self.data['config_type'] = config_type
-      self.data['layout'] = 'config-builder'
+      self.data['layout'] = layout
       self.data['meta'] = meta
       self.data['title'] = title + ': ' + inid.gsub('-', '.')
       self.data['config_filename'] = inid + '.yml'

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

@@ -89,11 +89,15 @@ module JekyllOpenSdgPlugins
         # Hardcode the site configuration page if it's not already there.
         form_settings = site.config['site_config_form']
         config_page = pages.find { |page| page['layout'] == 'config-builder' }
+        config_builder_layout = 'config-builder'
+        if site.config['use_new_config_forms']
+          config_builder_layout = 'config-builder-2'
+        end
         if config_page == nil
           if form_settings && form_settings['enabled']
             pages.push({
               'folder' => '/config',
-              'layout' => 'config-builder',
+              'layout' => config_builder_layout,
               'title' => 'Open SDG site configuration',
               'config_type' => 'site',
               'config_filename' => 'site_config.yml',
@@ -101,7 +105,7 @@ module JekyllOpenSdgPlugins
           end
         end
         # Make sure the form settings are set.
-        config_page = pages.find { |page| page['layout'] == 'config-builder' }
+        config_page = pages.find { |page| page['layout'] == config_builder_layout }
         if config_page != nil && form_settings && form_settings['enabled']
           config_page['form_settings'] = form_settings
         end

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

@@ -39,7 +39,7 @@ module JekyllOpenSdgPlugins
         endpoint = is_remote ? path + '/' + value : File.join(path, fix_path(value))
 
         begin
-          json_file = is_remote ? open(endpoint) : File.open(endpoint)
+          json_file = is_remote ? URI.open(endpoint) : File.open(endpoint)
           build[key] = JSON.load(json_file)
         rescue StandardError => e
           # For backwards compatibility, forego the exception in some cases.

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

@@ -10,7 +10,7 @@ module JekyllOpenSdgPlugins
 
       routes = {}
       baseurl = ''
-      if site.config.has_key?('baseurl')
+      if site.config.has_key?('baseurl') and site.config['baseurl'].is_a?(String)
         baseurl = site.config['baseurl']
       end
       unless baseurl.end_with?('/')
@@ -26,7 +26,7 @@ module JekyllOpenSdgPlugins
           route = route + '/'
         end
 
-        unless doc.data['layout'] == 'config-builder' or doc.data['layout'] == 'data-editor'
+        unless doc.data['layout'] == 'config-builder' or doc.data['layout'] == 'data-editor' or doc.data['layout'] == 'config-builder-2'
           routes['pages'].append(route)
         end
       end
@@ -40,7 +40,7 @@ module JekyllOpenSdgPlugins
           route = route + '/'
         end
 
-        if doc.data['layout'] == 'config-builder' or doc.data['layout'] == 'data-editor'
+        if doc.data['layout'] == 'config-builder' or doc.data['layout'] == 'data-editor' or doc.data['layout'] == 'config-builder-2'
           routes['config'].append(route)
         end
       end

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

@@ -310,6 +310,8 @@
                                         "title": "Position",
                                         "description": "Placement of the label along the line.",
                                         "enum": [
+                                            "start",
+                                            "end",
                                             "top",
                                             "bottom",
                                             "left",
@@ -326,7 +328,14 @@
                                     "fontColor": {
                                         "type": "string",
                                         "format": "color",
-                                        "title": "Label color",
+                                        "title": "Label color (do not use)",
+                                        "description": "[DEPRECATED: USE 'Label color (use this)' INSTEAD]",
+                                        "default": "#000000"
+                                    },
+                                    "color": {
+                                        "type": "string",
+                                        "format": "color",
+                                        "title": "Label color (use this)",
                                         "description": "Color for the label text.",
                                         "default": "#000000"
                                     },
@@ -360,7 +369,14 @@
                                                 "type": "string",
                                                 "format": "color",
                                                 "default": "#ffffff",
-                                                "title": "High-contrast label color",
+                                                "title": "High-contrast label color (do not use)",
+                                                "description": "[DEPRECATED: USE 'High-contrast label color (use this)' INSTEAD]"
+                                            },
+                                            "color": {
+                                                "type": "string",
+                                                "format": "color",
+                                                "default": "#ffffff",
+                                                "title": "High-contrast label color (use this)",
                                                 "description": "Color for the label text in high-contrast mode."
                                             },
                                             "backgroundColor": {

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

@@ -1203,6 +1203,36 @@
                 }
             ]
         },
+        "observation_attributes": {
+            "options": {"collapsed": true},
+            "type": "array",
+            "title": "Observation attributes",
+            "description": "This setting can be used to specify data columns to be considered 'observation attributes' and displayed along with individual data-points.",
+            "items": {
+                "type": "object",
+                "title": "Observation attribute",
+                "properties": {
+                    "field": {
+                        "type": "string",
+                        "minLength": 1,
+                        "title": "Field",
+                        "description": "Column name in the data."
+                    },
+                    "label": {
+                        "type": "string",
+                        "minLength": 1,
+                        "title": "Label",
+                        "description": "Optional label when displayed in footnotes."
+                    }
+                }
+            },
+            "links": [
+                {
+                    "rel": "More information on the observation attributes setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#observation_attributes"
+                }
+            ]
+        },
         "progress_status": {
             "options": {"collapsed": true},
             "type": "object",
@@ -1335,6 +1365,11 @@
                 { "$ref": "#/definitions/title_and_description" },
                 {
                     "properties": {
+                        "disaggregation_indicator_count_label": {
+                            "title": "Disaggregation indicator count label",
+                            "type": "string",
+                            "description": "An alternative label to use for the indicator count on the disaggregation tab, to be display after a number."
+                        },
                         "disaggregation_tabs": {
                             "title": "Disaggregation tabs",
                             "type": "boolean",
@@ -1486,6 +1521,18 @@
                 }
             ]
         },
+        "use_new_config_forms": {
+            "title": "Use new config forms",
+            "type": "boolean",
+            "description": "This setting can be set to `true` to try the new site configuration forms. This is experimental and will eventually be the default.",
+            "format": "checkbox",
+            "links": [
+                {
+                    "rel": "More information on the use_new_config_forms setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#use_new_config_forms"
+                }
+            ]
+        },
         "validate_indicator_config": {
             "title": "Validate indicator config",
             "type": "boolean",

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

@@ -541,7 +541,7 @@ module JekyllOpenSdgPlugins
           end
           doc.data['logo'] = logo
 
-          if collection == 'indicators'
+          if collection == 'indicators' || doc.data['layout'] == 'indicator-iframe'
             # For indicators we also set the current indicator/target/goal.
             if doc.data.has_key? 'indicator_number'
               indicator_number = doc.data['indicator_number']

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

@@ -36,7 +36,7 @@ module JekyllOpenSdgPlugins
       site.collections.keys.each do |collection|
         site.collections[collection].docs.each do |doc|
           # Do not index configuration forms.
-          if doc.data.has_key?('layout') && doc.data['layout'] == 'config-builder'
+          if doc.data.has_key?('layout') && (doc.data['layout'] == 'config-builder' or doc.data['layout'] == 'config-builder-2')
             next
           end
           # We segregate the search items by language.

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "2.2.0".freeze
+  VERSION = "2.3.0-beta3".freeze
 end

data/tests/Gemfile

@@ -1,7 +1,9 @@
 source "https://rubygems.org"
 
-gem "jekyll", "3.8.4"
-gem "html-proofer"
+gem "jekyll", "3.9.3"
+gem "html-proofer", "3.19.4"
 gem "jekyll-remote-theme"
 gem "deep_merge"
 gem "json_schemer"
+gem "kramdown-parser-gfm"
+gem "webrick"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0.pre.beta3
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2024-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -104,11 +104,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Jekyll plugins for use with the Open SDG platform