jekyll-open-sdg-plugins 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16c9b1c938fefd342ea55c8ca75b198541d3e5ef00cd785cfbe9251a3d653ced
-  data.tar.gz: 661807497228354b34eb7f368ad9df48a081a18493663c5621389e62fbf3bb19
+  metadata.gz: 2d65f23c1b0dbf8f069a1c0911afc238cf862bb34f0bf70c9aac5031456a1930
+  data.tar.gz: 74a2f4592b719e0bd93a0a63db99996e51b8b00c4e2b11758e3eac8bcbd0d045
 SHA512:
-  metadata.gz: ee54ba25f833387c4bd61b7c4fda2d24a4722ea3a43664a676e3708c1b81001610f1a8eda3cd0977ab94ce5cfdd407a53586910a6c6a7db7696ec8e04467da5b
-  data.tar.gz: e59c8876112b4356dc815b0c55195d785c9689ec67e5f2f42e51a6761dd4e40099af1511b2c09e90bdbea9511d1f25465d5de15f3ce62623c17eba67c8e343b9
+  metadata.gz: db9402cb822035b8783c2c234b0e0415e9da71c4008e88b6eddec20299327528179ea82b25c588f3f60c4d9069c0ac529878c9292332073417b866b2585bc549
+  data.tar.gz: 259cf3566b84dfe25917e187521dda050e24aaaeb1d3db932473e1d96086230c8d4b1e872cb26e0d5b7dcf1ae70ddb30b131c8b583523928e3e14d4b6ca4469d

data/README.md

@@ -39,3 +39,35 @@ create_indicators:
   # This determines which layout is used to render the pages.
   layout: indicator
 ```
+
+## 5. Automatically create 4 required pages.
+
+This automates the creation of 4 required pages that all implementations of Open SDG will need. These consist of:
+
+* the home page: /
+* the indicators json page: /indicators.json
+* the search results page: /search
+* the reporting status page: /reporting-status
+
+There are advanced options for overriding the location of these pages (see creae_pages.rb). But see the example below to use the defaults.
+
+Usage example (in `_config.yml`):
+```
+create_pages: true
+```
+
+## 6. Automatically fetch remote data and translations.
+
+This automates the fetching of the remote data (from the "data repository") and any remote translations.
+
+Note: This feature is disabled if "jekyll_get_json" is in the site config. This was the older (more verbose) way to do this.
+
+Usage example (in `_config.yml`):
+```
+remote_data_prefix: https://mygithuborg.github.io/my-data-repository
+remote_translations:
+  - https://open-sdg.github.io/sdg-translations/translations-0.6.0.json
+
+```
+
+For those interested in switching to this convenience feature, note that this makes the "jekyll_get_json" and "remotedatabaseurl" settings obsolete; so they can be removed.

data/jekyll-open-sdg-plugins.gemspec

@@ -13,4 +13,5 @@ Gem::Specification.new do |spec|
   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

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

@@ -1,4 +1,5 @@
 require_relative "jekyll-open-sdg-plugins/version"
+require_relative "jekyll-open-sdg-plugins/fetch_remote_data"
 require_relative "jekyll-open-sdg-plugins/multilingual_metadata"
 require_relative "jekyll-open-sdg-plugins/translate_key"
 require_relative "jekyll-open-sdg-plugins/create_indicators"

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

@@ -0,0 +1,65 @@
+require "jekyll"
+require 'json'
+require 'deep_merge'
+require 'open-uri'
+
+module JekyllOpenSdgPlugins
+  class FetchRemoteData < Jekyll::Generator
+    safe true
+    priority :highest
+
+    def generate(site)
+      # Backwards compatibility - only do this if 'jekyll_get_json' is absent.
+      # (This is the older style of remote data fetching.)
+      if !site.config['jekyll_get_json']
+        # First try to grab the remote data.
+        if site.config['remote_data_prefix']
+          prefix = site.config['remote_data_prefix']
+          # Set the required remotedatabaseurl config setting.
+          site.config['remotedatabaseurl'] = prefix
+          # Fetch remote data for each of our endpoints.
+          endpoints = {
+            'meta' => 'meta/all.json',
+            'headlines' => 'headline/all.json',
+            'schema' => 'meta/schema.json',
+            'reporting' => 'stats/reporting.json'
+          }
+          endpoints.each do |key, value|
+            target = site.data[key]
+            endpoint = prefix + '/' + value
+            begin
+              source = JSON.load(open(endpoint))
+              if target
+                target.deep_merge(source)
+              else
+                site.data[key] = source
+              end
+            rescue StandardError => e
+              puts e.message
+              abort 'Unable to fetch remote data from: ' + endpoint
+            end
+          end
+        end
+
+        # Next try to grab any remote translations.
+        if site.config['remote_translations']
+          key = 'translations'
+          target = site.data[key]
+          site.config['remote_translations'].each do |endpoint|
+            begin
+              source = JSON.load(open(endpoint))
+              if target
+                target.deep_merge(source)
+              else
+                site.data[key] = source
+              end
+            rescue StandardError => e
+              puts e.message
+              abort 'Unable to fetch remote translation from: ' + endpoint
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,8 +14,10 @@ module JekyllOpenSdgPlugins
           site.data['meta'].each do |indicator_id, meta|
             if meta[language]
               meta.each do |meta_key, meta_value|
-                if meta_key != language && !meta[language][meta_key]
-                  meta[language][meta_key] = meta_value
+                unless site.config['languages'].include? meta_key
+                  if !meta[language][meta_key]
+                    meta[language][meta_key] = meta_value
+                  end
                 end
               end
             end

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "0.0.12".freeze
+  VERSION = "0.0.13".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-19 00:00:00.000000000 Z
+date: 2019-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Jekyll plugins for use with the Open SDG platform
 email:
 - brockfanning@gmail.com
@@ -40,6 +54,7 @@ files:
 - lib/jekyll-open-sdg-plugins/create_goals.rb
 - lib/jekyll-open-sdg-plugins/create_indicators.rb
 - lib/jekyll-open-sdg-plugins/create_pages.rb
+- lib/jekyll-open-sdg-plugins/fetch_remote_data.rb
 - lib/jekyll-open-sdg-plugins/get_indicator_name.rb
 - lib/jekyll-open-sdg-plugins/helpers.rb
 - lib/jekyll-open-sdg-plugins/multilingual_metadata.rb