jekyll-open-sdg-plugins 1.0.0.rc10 → 1.0.0.rc11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15ab6b5be8eeff35429449800edc336a66e125dd0e4ea8818890998a278cee4d
-  data.tar.gz: 6d728c433f257d54d37a5b714bfec1a08446b4843bfe31e856145e4b21f1cb03
+  metadata.gz: 3668b012dcfdd9957e10f37855cc46b01ca36fa7da976f45797c15272ebb4086
+  data.tar.gz: 3a87d3869abbe9286df6cf1656c1b0d7f2ab7d6aac033c959216a151fc741e9f
 SHA512:
-  metadata.gz: 640399d80ef3c0354592fa9c5071df0978a3faf297303a2bc99f61f18a21079558c31560d331340a4f277de3dc7eef9dbaaa03724813f082672eccbe3b069417
-  data.tar.gz: ff0c4a04cf8566480df015b6dc9355c8bab6dda18cf3f572b7ad961e43e32918206fae058ab5120758737274a76c997349373a0a5c49bb2739986de93b48d2bf
+  metadata.gz: a589b05b8c085a70ece51a29ba5435b00757ccd91b87f75b3e56c6f3fd9b22f3c3cb868a6a13b73472fee32f2ed6a4e0943ecdc5579eaf7396070db058964616
+  data.tar.gz: a330617aee360e7ad4ccbd0795bfcca9b5ae1943f79eca35814b34e963e2614ed74cb1d5bbf461377a4651a60f6d159ed6121e513c9df4bdfbd229cbf87bc581

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

@@ -9,111 +9,130 @@ module JekyllOpenSdgPlugins
     safe true
     priority :highest
 
-    def download_build(prefix)
+    # Fix a Unix path in case we are on Windows.
+    def fix_path(path)
+      path_parts = path.split('/')
+      return path_parts.join(File::SEPARATOR)
+    end
 
-      endpoints = {
+    # Our hardcoded list of pieces of the build that we expect.
+    def get_endpoints()
+      return {
         'meta' => 'meta/all.json',
         'headlines' => 'headline/all.json',
         'schema' => 'meta/schema.json',
         'reporting' => 'stats/reporting.json',
         'translations' => 'translations/translations.json'
       }
+    end
+
+    # Is this path a remote path?
+    def is_path_remote(path)
+      return path.start_with?('http')
+    end
+
+    # Get a build from a local folder on disk or a remote URL on the Internet.
+    def fetch_build(path)
+
+      is_remote = is_path_remote(path)
       build = {}
-      endpoints.each do |key, value|
-        endpoint = prefix + '/' + value
+      get_endpoints().each do |key, value|
+        endpoint = is_remote ? path + '/' + value : File.join(path, fix_path(value))
+
         begin
-          source = JSON.load(open(endpoint))
-          build[key] = source
+          json_file = is_remote ? open(endpoint) : File.open(endpoint)
+          build[key] = JSON.load(json_file)
         rescue StandardError => e
           # For backwards compatibility, we allow 'translations' to be missing.
           if key != 'translations'
             puts e.message
-            abort 'Unable to fetch remote data from: ' + endpoint
+            abort 'Unable to read data from: ' + endpoint
           end
         end
       end
-      build
+
+      return build
+    end
+
+    # Predict (before data has been fetched) whether the site is using
+    # translated builds or not.
+    def site_uses_translated_builds(path)
+
+      is_remote = is_path_remote(path)
+      endpoints = get_endpoints()
+      # For a quick test, we just use 'meta'.
+      meta = endpoints['meta']
+      endpoint = is_remote ? path + '/' + meta : File.join(path, fix_path(meta))
+
+      begin
+        json_file = is_remote ? open(endpoint) : File.open(endpoint)
+      rescue StandardError => e
+        # If we didn't find an untranslated 'meta', we assume translated builds.
+        return true
+      end
+
+      # Other wise assume untranslated builds.
+      return false
     end
 
     def generate(site)
 
-      if site.config['remote_data_prefix']
-        prefix = site.config['remote_data_prefix']
+      # For below, make sure there is at least an empty hash at
+      # site.data.translations.
+      if !site.data.has_key?('translations')
+        site.data['translations'] = {}
+      end
 
-        # For below, make sure there is at least an empty hash at
-        # site.data.translations.
-        if !site.data.has_key?('translations')
-          site.data['translations'] = {}
-        end
+      remote = site.config['remote_data_prefix']
+      local = site.config['local_data_folder']
 
-        # How do we tell, before data has been fetched, whether the site is
-        # using translated builds? Quick and dirty way - attempt a download
-        # of the non-tranlsated build. If it fails, assume translated builds.
-        translated_builds = false
-        begin
-          JSON.load(open(prefix + '/meta/all.json'))
-        rescue StandardError => e
-          translated_builds = true
-        end
+      if !remote && !local
+        abort 'Site config must include either "remote_data_prefix" or "local_data_folder".'
+      end
 
-        if translated_builds
-          # For translated builds, we download a build for each language, and
-          # place them in "subfolders" (so to speak) of site.data.
-          site.config['languages'].each do |language|
-            data_target = site.data[language]
-            data_source = download_build(prefix + '/' + language)
-            if data_target
-              data_target.deep_merge(data_source)
-            else
-              site.data[language] = data_source
-            end
-            # Additionally, we move the language-specific translations to the
-            # site.data.translations location, where all translations are kept.
-            translation_target = site.data['translations'][language]
-            translation_source = site.data[language]['translations']
-            if translation_target
-              translation_target.deep_merge(translation_source)
-            else
-              site.data['translations'][language] = translation_source
-            end
+      build_location = remote ? remote : File.join(Dir.pwd, local)
+      translated_builds = site_uses_translated_builds(build_location)
+
+      if translated_builds
+        # For translated builds, we get a build for each language, and
+        # place them in "subfolders" (so to speak) of site.data.
+        site.config['languages'].each do |language|
+          data_target = site.data[language]
+          translated_build = remote ? build_location + '/' + language : File.join(build_location, language)
+          data_source = fetch_build(translated_build)
+          if data_target
+            data_target.deep_merge(data_source)
+          else
+            site.data[language] = data_source
           end
-        else
-          # For untranslated builds, we download one build only, and place it
-          # in the "root" (so to speak) of site.data. Nothing else is needed.
-          target = site.data
-          source = download_build(prefix)
-          target.deep_merge(source)
         end
-      else
-        # If remote data is not configured, check to see if Jekyll's data folder
-        # already contains the data.
-        data_is_local = false
-        # Data will either be directly in site.data, or in a folder per language,
-        # depending on whether we are using translated builds.
-        if site.data.has_key? 'meta'
-          # We could be more thorough and check all the endpoints, but for now
-          # just assume that if 'meta' is there, all the endpoints are.
-          data_is_local = true
-        else
-          data_for_all_languages = true
-          site.config['languages'].each do |language|
-            if !site.data.has_key? language || !site.data[language].has_key? 'meta'
-              data_for_all_languages = false
-            end
+        # We move the language-specific translations to the
+        # site.data.translations location, where all translations are kept.
+        site.config['languages'].each do |language|
+          translation_target = site.data['translations'][language]
+          translation_source = site.data[language]['translations']
+          if translation_target
+            translation_target.deep_merge(translation_source)
+          else
+            site.data['translations'][language] = translation_source
           end
-          if data_for_all_languages
-            data_is_local = true
-          end
-        end
-        # Finally give an error is there is no local data.
-        if !data_is_local
-          abort 'The "remote_data_prefix" configuration setting is missing and there is no local data.'
         end
+        # And there are some parts of the build that don't need to be translated
+        # and should be moved to the top level.
+        first_language = site.config['languages'][0]
+        site.data['reporting'] = site.data[first_language]['reporting']
+        site.data['schema'] = site.data[first_language]['schema']
+      else
+        # For untranslated builds, we download one build only, and place it
+        # in the "root" (so to speak) of site.data. Nothing else is needed.
+        target = site.data
+        source = fetch_build(build_location)
+        target.deep_merge(source)
       end
 
       # Finally support the deprecated 'remote_translations' option.
       # This is deprecated because translations should now be in the
-      # data repository, where they will be fetched in download_build().
+      # data repository, where they will be fetched in fetch_build().
       if site.config['remote_translations']
         key = 'translations'
         target = site.data[key]
@@ -133,4 +152,14 @@ module JekyllOpenSdgPlugins
       end
     end
   end
+
+  # This makes sure that the contents of the "local_data_folder" get copied
+  # into the Jekyll build, so that they can be served from the website.
+  Jekyll::Hooks.register :site, :post_write do |site|
+    if site.config['local_data_folder']
+      source = File.join(Dir.pwd, site.config['local_data_folder'], '.')
+      destination = site.config['destination']
+      FileUtils.cp_r(source, destination)
+    end
+  end
 end

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

@@ -318,7 +318,11 @@ module JekyllOpenSdgPlugins
           doc.data['t'] = site.data['translations'][language]
 
           # Set the remote_data_prefix for this indicator.
-          doc.data['remote_data_prefix'] = site.config['remote_data_prefix']
+          if site.config.has_key? 'remote_data_prefix'
+            doc.data['remote_data_prefix'] = site.config['remote_data_prefix']
+          elsif site.config.has_key? 'local_data_folder'
+            doc.data['remote_data_prefix'] = doc.data['baseurl']
+          end
           if opensdg_translated_builds(site)
             doc.data['remote_data_prefix'] += '/' + language
           end

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "1.0.0.rc10".freeze
+  VERSION = "1.0.0.rc11".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc10
+  version: 1.0.0.rc11
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll