jekyll-open-sdg-plugins 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a65d32d0ddf87249e3ee4ffd1e8a1c50823f75d3e7824727c8d464dd54a44666
-  data.tar.gz: ba85f18877187d68931a506b031596bf730b9a7035a03a191a736391df7c2ab3
+  metadata.gz: 87648f4556fee686eb7926015147d736d8d52081bbc8427c90b35c9bdced87b3
+  data.tar.gz: 228cc5b9614fb508ff1ebc85de543495ff1f0358bc12aad046946162ab3b4c7c
 SHA512:
-  metadata.gz: 6d94b90b6db52c3ef3548e959f4fc3694720b332e20336990b66ed5c6db9907774df90b7c68abef2f67c5b0ca77c8f40fe2b4f52fbc9f8708707f3a154ee1048
-  data.tar.gz: ec2060be58e31e4bb57b3d17a3c5a361ccc8110f87e30e8b9be34d349c6fb157d751636f41b5d30849768c152d333c75a5f8747cd55bf155532014525b6a5152
+  metadata.gz: 3a65a769b229b002fb44d389ca2ce043e9a2356b21129ff95b9f4df217c53b0256da30403fd0586cd77ed492cc131b38eb81ab5a08744513b4dcdda4b2d1e2bb
+  data.tar.gz: 8b43c92ef8aa602960da11a0a977fa6bb75bb014574f276a3c6495f2d47767dfb6740c8b19e99f812eecf5ea82b40644dd83ea22f8e0da265f2bc626a276cdf5

data/README.md

@@ -1,3 +1,41 @@
 # jekyll-open-sdg-plugins
 
 > 💎 Jekyll plugins for use with the Open SDG platform
+
+This plugin provides some Jekyll functionality for the [Open SDG](https://github.com/open-sdg/open-sdg) platform.
+
+The functionality provided consists of:
+
+## 1. A "t" Liquid filter for translating strings.
+
+Usage example:
+
+```
+{{ my_variable | t }}
+```
+
+## 2. Fill in missing fields to allow partially translated metadata.
+
+This allows metadata to be translated, field-by-field as needed, in subfolders in the data repository.
+
+## 3. Automatically create goal pages based on data.
+
+This creates goal pages automatically based on the data, so that the site repository does not need to maintain a `_goals` folder. It depends on a `_config.yml` setting.
+
+Usage example (in `_config.yml`):
+```
+create_goals:
+  # This determines which layout is used to render the pages.
+  layout: goal
+```
+
+## 4. Automatically create indicator pages based on data.
+
+This creates indicator pages automatically based on the data, so that the site repository does not need to maintain a `_indicators` folder. It depends on a `_config.yml` setting.
+
+Usage example (in `_config.yml`):
+```
+create_indicators:
+  # This determines which layout is used to render the pages.
+  layout: indicator
+```

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

@@ -0,0 +1,51 @@
+require "jekyll"
+
+module JekyllOpenSdgPlugins
+  class CreateGoals < Jekyll::Generator
+    safe true
+    priority :low
+
+    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 = {}
+        site.data['meta'].each do |inid, meta|
+          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
+        # Loop through the languages.
+        site.config['languages'].each_with_index do |language, index|
+          # 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, 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['sdg_goal'] = goal.to_s
+      self.data['language'] = language
+      self.data['layout'] = layout
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require "jekyll"
+
+module JekyllOpenSdgPlugins
+  class CreateIndicators < Jekyll::Generator
+    safe true
+    priority :low
+
+    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
+        # Loop through the languages.
+        site.config['languages'].each_with_index do |language, index|
+          # Loop through the indicators (using metadata as a list).
+          site.data['meta'].each do |inid, meta|
+            # Add the language subfolder for all except the default (first) language.
+            dir = index == 0 ? inid : File.join(language, 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'] = inid.gsub('-', '.')
+      self.data['layout'] = layout
+      self.data['language'] = language
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "0.0.6".freeze
+  VERSION = "0.0.7".freeze
 end

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

@@ -1,6 +1,8 @@
 require_relative "jekyll-open-sdg-plugins/version"
 require_relative "jekyll-open-sdg-plugins/multilingual_metadata"
 require_relative "jekyll-open-sdg-plugins/translate_key"
+require_relative "jekyll-open-sdg-plugins/create_indicators"
+require_relative "jekyll-open-sdg-plugins/create_goals"
 
 module JekyllOpenSdgPlugins
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2019-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -37,6 +37,8 @@ files:
 - README.md
 - jekyll-open-sdg-plugins.gemspec
 - lib/jekyll-open-sdg-plugins.rb
+- lib/jekyll-open-sdg-plugins/create_goals.rb
+- lib/jekyll-open-sdg-plugins/create_indicators.rb
 - lib/jekyll-open-sdg-plugins/multilingual_metadata.rb
 - lib/jekyll-open-sdg-plugins/translate_key.rb
 - lib/jekyll-open-sdg-plugins/version.rb