jekyll-open-sdg-plugins 1.0.0 → 1.2.0.pre.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c89259377d08cd8db1d38b04ab5de4d4de27ba7227a2c4746138105671e8e37e
-  data.tar.gz: daec6e7ec6aac4c856091e49abce887f024d579e9215e71412515d25c079ca31
+  metadata.gz: 0a13b75f8a6bee0ac35a81bd34f1f5777adbef3892b90642d6b5d3f7a02a2cd5
+  data.tar.gz: cd76e70a5722c7b988bd88b0e33278d0221591e17424169e38aad82186075b11
 SHA512:
-  metadata.gz: 63721d734766ad0ed35c5a24331ea40adb1d46d3d9fea3aedf910efdd6029814df6d872e4cb73d178c630e65eb5790a7639ff21752345cd16ad103e7dd14474e
-  data.tar.gz: cdd6d7dd52fc95cd927102db532cb1a9b4e506bb88b1272dfbdc11585125af1ff63ffc82990accb575bc863006f65f98c7f90eb190d4fdd4b5abd898d7b944cf
+  metadata.gz: 8a81989072531a863547ba9ce95f213ffa13231f3f2c3cac1a70c2f0a779f2c23c8ef7de7eb507a81a808d076e0e2b7d59108c9d24617c3968d68f88c5d12a3f
+  data.tar.gz: e7d5024aea9d3de0c5a1edabb4d8fb5809ff608b74f1ac9d9af2f17458b1a484e8be391edb3566dd97a03c479ae4e6ca4de7595c6326094d3e95e4191de999c6

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

@@ -0,0 +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

data/.gitignore

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

data/Makefile

@@ -0,0 +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

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,17 +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"
-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.rb

@@ -1,13 +1,16 @@
-require_relative "jekyll-open-sdg-plugins/version"
-require_relative "jekyll-open-sdg-plugins/fetch_remote_data"
-require_relative "jekyll-open-sdg-plugins/translate_key"
-require_relative "jekyll-open-sdg-plugins/translate_date"
-require_relative "jekyll-open-sdg-plugins/translate_metadata_field"
-require_relative "jekyll-open-sdg-plugins/create_indicators"
-require_relative "jekyll-open-sdg-plugins/create_goals"
-require_relative "jekyll-open-sdg-plugins/create_pages"
-require_relative "jekyll-open-sdg-plugins/sdg_variables"
-require_relative "jekyll-open-sdg-plugins/search_index"
-
-module JekyllOpenSdgPlugins
-end
+require_relative "jekyll-open-sdg-plugins/version"
+require_relative "jekyll-open-sdg-plugins/site_configuration"
+require_relative "jekyll-open-sdg-plugins/validate_site_config"
+require_relative "jekyll-open-sdg-plugins/fetch_remote_data"
+require_relative "jekyll-open-sdg-plugins/translate_key"
+require_relative "jekyll-open-sdg-plugins/translate_date"
+require_relative "jekyll-open-sdg-plugins/translate_metadata_field"
+require_relative "jekyll-open-sdg-plugins/create_indicators"
+require_relative "jekyll-open-sdg-plugins/create_goals"
+require_relative "jekyll-open-sdg-plugins/create_pages"
+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"
+
+module JekyllOpenSdgPlugins
+end

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

@@ -1,75 +1,72 @@
-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']
-        # 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|
-          goal = inid.split('-')[0].to_i
-          goals[goal] = true
-        end
-        # Decide what layout to use for the goal pages.
-        layout = 'goal'
-        if site.config['create_goals'].key?('layout')
-          layout = site.config['create_goals']['layout']
-        end
-        # See if we need to "map" any language codes.
-        languages_public = Hash.new
-        if site.config['languages_public']
-          languages_public = site.config['languages_public']
-        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.
-          goals.sort.each do |goal, value|
-            # 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)
-          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)
-      @site = site
-      @base = base
-      @dir  = dir
-      @name = 'index.html'
-
-      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|
+          goal = inid.split('-')[0].to_i
+          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.
+          goals.sort.each do |goal, value|
+            # 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)
+          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)
+      @site = site
+      @base = base
+      @dir  = dir
+      @name = 'index.html'
+
+      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

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

@@ -1,67 +1,117 @@
-require "jekyll"
-require_relative "helpers"
-
-module JekyllOpenSdgPlugins
-  class CreateIndicators < Jekyll::Generator
-    safe true
-    priority :normal
-
-    def generate(site)
-      # If site.create_indicators is set, create indicators per the metadata.
-      if site.config['languages'] and site.config['create_indicators']
-        # Decide what layout to use for the indicator pages.
-        layout = 'indicator'
-        if site.config['create_indicators'].key?('layout')
-          layout = site.config['create_indicators']['layout']
-        end
-        # See if we need to "map" any language codes.
-        languages_public = Hash.new
-        if site.config['languages_public']
-          languages_public = site.config['languages_public']
-        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
-          metadata = {}
-          if opensdg_translated_builds(site)
-            # If we are using translated builds, the metadata is underneath a
-            # language code.
-            metadata = site.data[language]['meta']
-          else
-            # Otherwise the 'meta' data is not underneath any language code.
-            metadata = site.data['meta']
-          end
-          # Loop through the indicators (using metadata as a list).
-          metadata.each do |inid, meta|
-            # Add the language subfolder for all except the default (first) language.
-            dir = index == 0 ? inid : File.join(language_public, inid)
-            # Create the indicator page.
-            site.collections['indicators'].docs << IndicatorPage.new(site, site.source, dir, inid, language, layout)
-          end
-        end
-      end
-    end
-  end
-
-  # A Page subclass used in the `CreateIndicators` class.
-  class IndicatorPage < Jekyll::Page
-    def initialize(site, base, dir, inid, language, layout)
-      @site = site
-      @base = base
-      @dir  = dir
-      @name = 'index.html'
-
-      self.process(@name)
-      self.data = {}
-      self.data['indicator_number'] = inid.gsub('-', '.')
-      self.data['layout'] = layout
-      self.data['language'] = language
-      # Backwards compatibility:
-      self.data['indicator'] = self.data['indicator_number']
-    end
-  end
-end
+require "jekyll"
+require_relative "helpers"
+
+module JekyllOpenSdgPlugins
+  class CreateIndicators < Jekyll::Generator
+    safe true
+    priority :normal
+
+    def generate(site)
+      # If site.create_indicators is set, create indicators per the metadata.
+      if site.config['languages'] and site.config['create_indicators'] and site.config['create_indicators'].key?('layout') and site.config['create_indicators']['layout'] != ''
+        # Decide what layout to use for the indicator pages.
+        layout = site.config['create_indicators']['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
+          metadata = {}
+          if opensdg_translated_builds(site)
+            # If we are using translated builds, the metadata is underneath a
+            # language code.
+            metadata = site.data[language]['meta']
+          else
+            # Otherwise the 'meta' data is not underneath any language code.
+            metadata = site.data['meta']
+          end
+          # Loop through the indicators (using metadata as a list).
+          metadata.each do |inid, meta|
+            # Add the language subfolder for all except the default (first) language.
+            dir = index == 0 ? inid : File.join(language_public, inid)
+            # Create the indicator page.
+            site.collections['indicators'].docs << IndicatorPage.new(site, site.source, dir, inid, language, layout)
+          end
+        end
+        # Create the indicator configuration pages.
+        if site.config['create_config_forms'] && site.config['create_config_forms'].key?('layout') && site.config['create_config_forms']['layout'] != ''
+          metadata = {}
+          layout = site.config['create_config_forms']['layout']
+          if opensdg_translated_builds(site)
+            if site.data.has_key?('untranslated')
+              metadata = site.data['untranslated']['meta']
+            else
+              default_language = site.config['languages'][0]
+              metadata = site.data[default_language]['meta']
+            end
+          else
+            metadata = site.data['meta']
+          end
+          # Loop through the indicators (using metadata as a list).
+          if !metadata.empty?
+            # 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
+              metadata.each do |inid, meta|
+                dir = File.join('config', inid)
+                if index != 0
+                  dir = File.join(language_public, 'config', inid)
+                end
+                site.collections['pages'].docs << IndicatorConfigPage.new(site, site.source, dir, inid, language, meta, layout)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  # A Page subclass used in the `CreateIndicators` class.
+  class IndicatorPage < Jekyll::Page
+    def initialize(site, base, dir, inid, language, layout)
+      @site = site
+      @base = base
+      @dir  = dir
+      @name = 'index.html'
+
+      self.process(@name)
+      self.data = {}
+      self.data['indicator_number'] = inid.gsub('-', '.')
+      self.data['layout'] = layout
+      self.data['language'] = language
+      # Backwards compatibility:
+      self.data['indicator'] = self.data['indicator_number']
+    end
+  end
+
+  # A Page subclass used in the `CreateIndicators` class.
+  class IndicatorConfigPage < Jekyll::Page
+    def initialize(site, base, dir, inid, language, meta, layout)
+      @site = site
+      @base = base
+      @dir  = dir
+      @name = 'index.html'
+
+      self.process(@name)
+      self.data = {}
+      self.data['language'] = language
+      self.data['indicator_number'] = inid.gsub('-', '.')
+      self.data['config_type'] = 'indicator'
+      self.data['layout'] = layout
+      self.data['meta'] = meta
+      self.data['title'] = 'Open SDG indicator configuration: ' + self.data['indicator_number']
+      self.data['config_filename'] = inid + '.yml'
+    end
+  end
+end