jekyll-open-sdg-plugins 1.6.0.pre.beta2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52a8d0408e6505550935776bf49788453668637ce89c4db8758cf6f57c9d69fc
-  data.tar.gz: c0261b9b2ed6edce2e2a370276e13cf847ae454183fd76cde0e235c8553230a2
+  metadata.gz: 3a89cf02d816079a37d7a46f926a77b8e084ea6521b9a8dbe2a6616b8fbddb0f
+  data.tar.gz: 62d0c38503090c81c54e7d15bc32dbf50f87b9257f659829bf98b2c6a4658e67
 SHA512:
-  metadata.gz: 85f51fe446c94c698d382aa052ea0b88324970ca5c68b7834bdb87e0d8339358277bf8d233407c29bb54f53207e7ce8a5b93417f5dad493ae56688a080ef671f
-  data.tar.gz: ef0faec2ceb0fd920251d635c544361867188366067eab0fae789aa07c1a1a36bfa7c0a1c1427c43438036a5cc4d74360a8fc270202be21e75b65feaacb023ae
+  metadata.gz: a289cf63df4aae969859ef27dfcb357a56286c1fcbb81598332ff9ad20eea765f62b87e7e03eb60682852b8fca3055a8dc18956a45112843c4bd1dc1a12ef323
+  data.tar.gz: 32c575404cddbc955955ce28845853424580f639c8d8cfa003e83f43e9d6a42d048219273e6f367234391f5e23e14a75d575d9e21bf4e7f941a34ea87f9573f8

data/.editorconfig

@@ -1,16 +1,16 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.{md,rb,gemspec},Makefile]
-charset = utf-8
-
-[Makefile]
-indent_style = tab
-
-[*.md]
-trim_trailing_whitespace = false
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{md,rb,gemspec},Makefile]
+charset = utf-8
+
+[Makefile]
+indent_style = tab
+
+[*.md]
+trim_trailing_whitespace = false

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

@@ -1,17 +1,17 @@
-name: Test PRs
-
-on: [pull_request]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-    - name: Run all tests
-      run: make test
+name: Test PRs
+
+on: [pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Run all tests
+      run: make test

data/.gitignore

@@ -1,6 +1,6 @@
-_site
-.sass-cache
-.jekyll-metadata
-*.gem
-open-sdg/
-open-sdg-site-starter/
+_site
+.sass-cache
+.jekyll-metadata
+*.gem
+open-sdg/
+open-sdg-site-starter/

data/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Brock Fanning <brockfanning@gmail.com> (https://github.com/open-sdg/open-sdg
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2019 Brock Fanning <brockfanning@gmail.com> (https://github.com/open-sdg/open-sdg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -1,33 +1,33 @@
-.PHONY: clean build serve serve.detached
-all: test
-
-clean:
-	# Stop the detached Jekyll web server.
-	-pkill -f -9 jekyll
-	# Delete the builds.
-	rm -fr open-sdg-site-starter
-	rm -fr open-sdg
-
-install: clean
-	git clone https://github.com/open-sdg/open-sdg-site-starter.git
-	git clone https://github.com/open-sdg/open-sdg.git
-	# Copy all the theme files into the site starter.
-	cp -r open-sdg/_includes/* open-sdg-site-starter/_includes/
-	cp -r open-sdg/_layouts/* open-sdg-site-starter/_layouts/
-	cp -r open-sdg/_sass/* open-sdg-site-starter/_sass/
-	cp -r open-sdg/assets/* open-sdg-site-starter/assets/
-	# Copy the required files into the site starter.
-	cp tests/_config.yml open-sdg-site-starter/
-	cp tests/Gemfile open-sdg-site-starter/
-	# Create a symlink to our plugin files.
-	ln -s ../lib/jekyll-open-sdg-plugins open-sdg-site-starter/_plugins
-	# Install Ruby dependencies.
-	cd open-sdg-site-starter && bundle install
-
-build:
-	cd open-sdg-site-starter && bundle exec jekyll build
-
-serve:
-	cd open-sdg-site-starter && bundle exec jekyll serve
-
-test: install build
+.PHONY: clean build serve serve.detached
+all: test
+
+clean:
+	# Stop the detached Jekyll web server.
+	-pkill -f -9 jekyll
+	# Delete the builds.
+	rm -fr open-sdg-site-starter
+	rm -fr open-sdg
+
+install: clean
+	git clone https://github.com/open-sdg/open-sdg-site-starter.git
+	git clone https://github.com/open-sdg/open-sdg.git
+	# Copy all the theme files into the site starter.
+	cp -r open-sdg/_includes/* open-sdg-site-starter/_includes/
+	cp -r open-sdg/_layouts/* open-sdg-site-starter/_layouts/
+	cp -r open-sdg/_sass/* open-sdg-site-starter/_sass/
+	cp -r open-sdg/assets/* open-sdg-site-starter/assets/
+	# Copy the required files into the site starter.
+	cp tests/_config.yml open-sdg-site-starter/
+	cp tests/Gemfile open-sdg-site-starter/
+	# Create a symlink to our plugin files.
+	ln -s ../lib/jekyll-open-sdg-plugins open-sdg-site-starter/_plugins
+	# Install Ruby dependencies.
+	cd open-sdg-site-starter && bundle install
+
+build:
+	cd open-sdg-site-starter && bundle exec jekyll build
+
+serve:
+	cd open-sdg-site-starter && bundle exec jekyll serve
+
+test: install build

data/README.md

@@ -1,7 +1,7 @@
-# jekyll-open-sdg-plugins
-
-> 💎 Jekyll plugins for use with the Open SDG platform
-
-This plugin provides required Jekyll functionality for the [Open SDG](https://github.com/open-sdg/open-sdg) platform.
-
-The details on this functionality can be found throughout the [Open SDG documentation](https://open-sdg.readthedocs.io/en/latest/).
+# jekyll-open-sdg-plugins
+
+> 💎 Jekyll plugins for use with the Open SDG platform
+
+This plugin provides required Jekyll functionality for the [Open SDG](https://github.com/open-sdg/open-sdg) platform.
+
+The details on this functionality can be found throughout the [Open SDG documentation](https://open-sdg.readthedocs.io/en/latest/).

data/jekyll-open-sdg-plugins.gemspec

@@ -1,18 +1,18 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "jekyll-open-sdg-plugins/version"
-Gem::Specification.new do |spec|
-  spec.name          = "jekyll-open-sdg-plugins"
-  spec.summary       = "Jekyll plugins for use with the Open SDG platform"
-  spec.description   = "Jekyll plugins for use with the Open SDG platform"
-  spec.version       = JekyllOpenSdgPlugins::VERSION
-  spec.authors       = ["Brock Fanning"]
-  spec.email         = ["brockfanning@gmail.com"]
-  spec.homepage      = "https://github.com/open-sdg/jekyll-open-sdg-plugins"
-  spec.licenses      = ["MIT"]
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!)  }
-  spec.require_paths = ["lib"]
-  spec.add_dependency "jekyll", "~> 3.0"
-  spec.add_dependency "deep_merge", "~> 1.2"
-  spec.add_dependency "json_schemer", "~> 0.2"
-end
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-open-sdg-plugins/version"
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-open-sdg-plugins"
+  spec.summary       = "Jekyll plugins for use with the Open SDG platform"
+  spec.description   = "Jekyll plugins for use with the Open SDG platform"
+  spec.version       = JekyllOpenSdgPlugins::VERSION
+  spec.authors       = ["Brock Fanning"]
+  spec.email         = ["brockfanning@gmail.com"]
+  spec.homepage      = "https://github.com/open-sdg/jekyll-open-sdg-plugins"
+  spec.licenses      = ["MIT"]
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!)  }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "jekyll", "~> 3.0"
+  spec.add_dependency "deep_merge", "~> 1.2"
+  spec.add_dependency "json_schemer", "~> 0.2"
+end

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

@@ -1,61 +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']
-        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
+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_goals.rb

@@ -1,85 +1,85 @@
-require "jekyll"
-require_relative "helpers"
-
-module JekyllOpenSdgPlugins
-  class CreateGoals < Jekyll::Generator
-    safe true
-    priority :normal
-
-    def generate(site)
-      # If site.create_goals is set, create goals per the metadata.
-      if site.config['languages'] and site.config['create_goals'] and site.config['create_goals'].key?('layout') and site.config['create_goals']['layout'] != ''
-        # Compile the list of goals.
-        goals = {}
-        # Are we using translated builds?
-        metadata = {}
-        if opensdg_translated_builds(site)
-          # If we are using translated builds, the 'meta' data is underneath
-          # language codes. We just use the first language.
-          default_language = site.config['languages'][0]
-          metadata = site.data[default_language]['meta']
-        else
-          # Otherwise the 'meta' data is not underneath any language code.
-          metadata = site.data['meta']
-        end
-        metadata.each do |inid, indicator|
-          if indicator.has_key?('standalone') and indicator['standalone']
-            next
-          end
-          goal = inid.split('-')[0]
-          goals[goal] = true
-        end
-        # Decide what layout to use for the goal pages.
-        layout = site.config['create_goals']['layout']
-        # See if we need to "map" any language codes.
-        languages_public = Hash.new
-        if site.config['languages_public']
-          languages_public = opensdg_languages_public(site)
-        end
-        # Loop through the languages.
-        site.config['languages'].each_with_index do |language, index|
-          # Get the "public language" (for URLs) which may be different.
-          language_public = language
-          if languages_public[language]
-            language_public = languages_public[language]
-          end
-          # Loop through the goals.
-          goal_index = 0
-          goals.keys.sort.each do |goal|
-            # Add the language subfolder for all except the default (first) language.
-            dir = index == 0 ? goal.to_s : File.join(language_public, goal.to_s)
-            # Create the goal page.
-            site.collections['goals'].docs << GoalPage.new(site, site.source, dir, goal, language, layout, goal_index)
-            goal_index += 1
-          end
-        end
-      end
-    end
-  end
-
-  # A Page subclass used in the `CreateGoals` class.
-  class GoalPage < Jekyll::Page
-    def initialize(site, base, dir, goal, language, layout, goal_index)
-      @site = site
-      @base = base
-      @dir  = dir
-      @name = 'index.html'
-
-      goal_content = ''
-      if site.config['create_goals'].has_key?('goals')
-        if !site.config['create_goals']['goals'][goal_index].nil?
-          goal_content = site.config['create_goals']['goals'][goal_index]['content']
-        end
-      end
-      @content = goal_content
-
-      self.process(@name)
-      self.data = {}
-      self.data['goal_number'] = goal.to_s
-      self.data['language'] = language
-      self.data['layout'] = layout
-      # Backwards compatibility:
-      self.data['sdg_goal'] = self.data['goal_number']
-    end
-  end
-end
+require "jekyll"
+require_relative "helpers"
+
+module JekyllOpenSdgPlugins
+  class CreateGoals < Jekyll::Generator
+    safe true
+    priority :normal
+
+    def generate(site)
+      # If site.create_goals is set, create goals per the metadata.
+      if site.config['languages'] and site.config['create_goals'] and site.config['create_goals'].key?('layout') and site.config['create_goals']['layout'] != ''
+        # Compile the list of goals.
+        goals = {}
+        # Are we using translated builds?
+        metadata = {}
+        if opensdg_translated_builds(site)
+          # If we are using translated builds, the 'meta' data is underneath
+          # language codes. We just use the first language.
+          default_language = site.config['languages'][0]
+          metadata = site.data[default_language]['meta']
+        else
+          # Otherwise the 'meta' data is not underneath any language code.
+          metadata = site.data['meta']
+        end
+        metadata.each do |inid, indicator|
+          if indicator.has_key?('standalone') and indicator['standalone']
+            next
+          end
+          goal = inid.split('-')[0]
+          goals[goal] = true
+        end
+        # Decide what layout to use for the goal pages.
+        layout = site.config['create_goals']['layout']
+        # See if we need to "map" any language codes.
+        languages_public = Hash.new
+        if site.config['languages_public']
+          languages_public = opensdg_languages_public(site)
+        end
+        # Loop through the languages.
+        site.config['languages'].each_with_index do |language, index|
+          # Get the "public language" (for URLs) which may be different.
+          language_public = language
+          if languages_public[language]
+            language_public = languages_public[language]
+          end
+          # Loop through the goals.
+          goal_index = 0
+          goals.keys.sort.each do |goal|
+            # Add the language subfolder for all except the default (first) language.
+            dir = index == 0 ? goal.to_s : File.join(language_public, goal.to_s)
+            # Create the goal page.
+            site.collections['goals'].docs << GoalPage.new(site, site.source, dir, goal, language, layout, goal_index)
+            goal_index += 1
+          end
+        end
+      end
+    end
+  end
+
+  # A Page subclass used in the `CreateGoals` class.
+  class GoalPage < Jekyll::Page
+    def initialize(site, base, dir, goal, language, layout, goal_index)
+      @site = site
+      @base = base
+      @dir  = dir
+      @name = 'index.html'
+
+      goal_content = ''
+      if site.config['create_goals'].has_key?('goals')
+        if !site.config['create_goals']['goals'][goal_index].nil?
+          goal_content = site.config['create_goals']['goals'][goal_index]['content']
+        end
+      end
+      @content = goal_content
+
+      self.process(@name)
+      self.data = {}
+      self.data['goal_number'] = goal.to_s
+      self.data['language'] = language
+      self.data['layout'] = layout
+      # Backwards compatibility:
+      self.data['sdg_goal'] = self.data['goal_number']
+    end
+  end
+end