cloudcannon-jekyll 1.5.0 → 1.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33d4053706ea20c8d2e3985de49e437dcee1c275ecd4ccdf78dc7c7d1a94cf83
-  data.tar.gz: 4fe382c19ba59e3242f6cfa9b5b7e46de152c2091036602a622618fce3f2e8ba
+  metadata.gz: bb81e7f467450a9da1c39bd68adbc69514aa0f33c982b1b70c540f05fe7dda70
+  data.tar.gz: eddc9663476a26ca3d0a503760b07760803ddcb852d7da7ae80c47be0d10ca8e
 SHA512:
-  metadata.gz: f3d509ec5cfdedc0dce34b639152efd81a81c2d798f403dbf656ab17cc16af127a45609d4cf482b830e02fbdbe4b77c7c6bc7a8a8a3a584b501273b3f40d4fdb
-  data.tar.gz: f1c56c046ff5dcf46048184cf7de498aff85706804afbf168613cfac4d0e6a448ebecc29e6575114ee58098c7df7e3a83ba19bb07f9d68902aa0cbd60db120e0
+  metadata.gz: ec82c0e7f08018be8b5007911d1286301bdf6300f468e0c86afe3e622823bd0f3611348f8f69e6ab7124d260e89edcce5f44e107ccdbb51d956cc01a959b8db1
+  data.tar.gz: 7196b603e2a82dd61021a927903d3ff2a21506f107e15adf3e16c2986f0a997f42d644d43bb9cf2b357aa653cb02677b1d93ccda2998a5e1a9be4a8761c3570f

data/HISTORY.md

@@ -1,3 +1,29 @@
+# 1.5.6
+
+* Force generator to run after other lowest priority plugins
+
+# 1.5.5
+
+* Re-add id field for documents
+* Fix for potential nil reference
+
+# 1.5.4
+
+* Rework fallback for older versions of Jekyll when reading data, posts and drafts again
+
+# 1.5.3
+
+* Rework fallback for older versions of Jekyll when reading data, posts and drafts
+* Fix deprecation warning for `posts.map`
+
+# 1.5.2
+
+* Fix for empty collection configurations
+
+# 1.5.1
+
+* Add empty paths.pages
+
 # 1.5.0
 
 * Added drafts to collections in details
@@ -9,6 +35,10 @@
 * Add `url` to static-pages
 * Normalise `_path` in static-pages
 
+# 1.4.3
+
+* Fix off-by-one depth for nested documents from last change
+
 # 1.4.2
 
 * Added max depth parameter for jsonify filter and increase it for array structures in config output

data/lib/cloudcannon-jekyll/_cloudcannon/config-2.x.json

@@ -25,6 +25,7 @@
 		"uploads": {{ config.uploads_dir | cc_jsonify }},
 		"plugins": {{ config.plugins_dir | cc_jsonify }},
 		"data": {{ config.data_dir | cc_jsonify }},
+		"pages": "",
 		"collections": {{ config.collections_dir | cc_jsonify }},
 		"includes": {{ config.includes_dir | cc_jsonify }},
 		"layouts": {{ config.layouts_dir | cc_jsonify }}

data/lib/cloudcannon-jekyll/_cloudcannon/config-3.0-4.x.json

@@ -25,6 +25,7 @@
 		"uploads": {{ config.uploads_dir | cc_jsonify }},
 		"plugins": {{ config.plugins_dir | cc_jsonify }},
 		"data": {{ config.data_dir | cc_jsonify }},
+		"pages": "",
 		"collections": {{ config.collections_dir | cc_jsonify }},
 		"includes": {{ config.includes_dir | cc_jsonify }},
 		"layouts": {{ config.layouts_dir | cc_jsonify }}

data/lib/cloudcannon-jekyll/_cloudcannon/config.json

@@ -41,6 +41,7 @@
 		"uploads": {{ config.uploads_dir | cc_jsonify }},
 		"plugins": {{ config.plugins_dir | cc_jsonify }},
 		"data": {{ config.data_dir | cc_jsonify }},
+		"pages": "",
 		"collections": {{ config.collections_dir | cc_jsonify }},
 		"includes": {{ config.includes_dir | cc_jsonify }},
 		"layouts": {{ config.layouts_dir | cc_jsonify }}

data/lib/cloudcannon-jekyll/generator.rb

@@ -7,13 +7,22 @@ require_relative "reader"
 module CloudCannonJekyll
   # Generates JSON files containing build config and build output details
   class Generator < Jekyll::Generator
+    # Override the Jekyll::Plugin spaceship to push our plugin to the very end
     priority :lowest
+    def self.<=>(*)
+      1
+    end
 
     def generate(site)
       @site = site
       @reader = Reader.new(@site)
 
-      collections_config = @site.config["collections"].dup || {}
+      collections_config = @site.config["collections"]&.dup || {}
+
+      # Workaround for empty collection configurations
+      collections_config.each_key do |key|
+        collections_config[key] ||= { "output" => false }
+      end
 
       payload = @site.site_payload.merge({
         "gem_version" => CloudCannonJekyll::VERSION,
@@ -44,11 +53,13 @@ module CloudCannonJekyll
       @site.config["data_dir"] || "_data"
     end
 
+    # rubocop:disable Metrics/AbcSize
     def add_category_folder_config(collections_config, posts_config = {})
       posts = @site.posts || @site.collections["posts"]
+      docs = posts.class.method_defined?(:docs) ? posts.docs : posts
       seen = {}
 
-      posts.map do |post|
+      docs.map do |post|
         parts = post.relative_path.split("/_posts/")
         path = parts.first
 
@@ -75,6 +86,7 @@ module CloudCannonJekyll
         path
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     # Add data to collections config if raw data files exist
     def add_data_config(collections_config)
@@ -88,7 +100,7 @@ module CloudCannonJekyll
       drafts = @reader.read_drafts(collections_dir)
 
       if collections_config.key?("posts")
-        collections_config["drafts"] = collections_config["posts"].dup
+        collections_config["drafts"] = collections_config["posts"]&.dup || {}
       elsif drafts.any?
         collections_config["drafts"] = {}
       end

data/lib/cloudcannon-jekyll/jsonify-filter.rb

@@ -107,7 +107,7 @@ module CloudCannonJekyll
     end
 
     def self.document_to_json(input, depth, max_depth)
-      prevent = %w(dir id relative_path url collection)
+      prevent = %w(dir relative_path url collection)
 
       out = [
         "\"path\": #{JsonifyFilter.to_json(input.relative_path, depth, max_depth)}",
@@ -120,6 +120,10 @@ module CloudCannonJekyll
         out.push("\"collection\": #{collection_json}")
       end
 
+      if input.respond_to? :id
+        out.push("\"id\": #{JsonifyFilter.to_json(input.id, depth, max_depth)}")
+      end
+
       out += JsonifyFilter.document_data_to_a(input.data, prevent, depth, max_depth)
       "{#{out.join(",")}}"
     end
@@ -167,7 +171,7 @@ module CloudCannonJekyll
     def self.to_json(input, depth, max_depth = 9, key_swaps = {})
       depth += 1
 
-      if depth > max_depth || (depth > 2 && JsonifyFilter.document_type?(input))
+      if depth > max_depth || (depth > 3 && JsonifyFilter.document_type?(input))
         '"MAXIMUM_DEPTH"'
       elsif JsonifyFilter.simple_type?(input)
         input.to_json

data/lib/cloudcannon-jekyll/reader.rb

@@ -1,12 +1,8 @@
 # frozen_string_literal: true
 
 require "jekyll"
-
-if !Jekyll::VERSION.start_with? "2."
-  require_relative "readers/data-reader"
-else
-  require_relative "readers/old-data-reader"
-end
+require_relative "readers/old-data-reader"
+require_relative "readers/data-reader"
 
 module CloudCannonJekyll
   # Wraps read functions into one class
@@ -18,6 +14,7 @@ module CloudCannonJekyll
     end
 
     def read_data(dir = "_data")
+      # DataReader doesn't exist in old versions of Jekyll
       if Jekyll::VERSION.start_with? "2."
         CloudCannonJekyll::OldDataReader.new(@site).read(dir)
       else
@@ -26,6 +23,7 @@ module CloudCannonJekyll
     end
 
     def read_drafts(dir = "")
+      # PostReader doesn't exist in old versions of Jekyll
       if Jekyll::VERSION.start_with? "2."
         @site.read_content(dir, "_drafts", Jekyll::Draft)
       else
@@ -34,6 +32,7 @@ module CloudCannonJekyll
     end
 
     def read_posts(dir = "")
+      # PostReader doesn't exist in old versions of Jekyll
       if Jekyll::VERSION.start_with? "2."
         @site.read_content(dir, "_posts", Jekyll::Post)
       else

data/lib/cloudcannon-jekyll/readers/data-reader.rb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
-require "jekyll"
+unless Jekyll::VERSION.start_with? "2."
+  require "jekyll"
 
-module CloudCannonJekyll
-  # Reads data files and creates a collections-style hash representation
-  class DataReader < Jekyll::DataReader
-    # Determines how to read a data file.
-    # This is overridden return a hash instead of reading the file.
-    #
-    # Returns a hash with the path to the data file.
-    def read_data_file(path)
-      {
-        "path" => path,
-      }
+  module CloudCannonJekyll
+    # Reads data files and creates a collections-style hash representation
+    class DataReader < Jekyll::DataReader
+      # Determines how to read a data file.
+      # This is overridden return a hash instead of reading the file.
+      #
+      # Returns a hash with the path to the data file.
+      def read_data_file(path)
+        {
+          "path" => path,
+        }
+      end
     end
   end
 end

data/lib/cloudcannon-jekyll/readers/old-data-reader.rb

@@ -1,55 +1,57 @@
 # frozen_string_literal: true
 
-require "jekyll"
-
-module CloudCannonJekyll
-  # Reads data files and creates a collections-style hash representation
-  # Aims to replicate the data reading logic in Jekyll 2.5
-  class OldDataReader
-    attr_reader :site
-
-    def initialize(site)
-      @site = site
-      @safe = site.safe
-      @content = {}
-    end
+if Jekyll::VERSION.start_with? "2."
+  require "jekyll"
+
+  module CloudCannonJekyll
+    # Reads data files and creates a collections-style hash representation
+    # Aims to replicate the data reading logic in Jekyll 2.5
+    class OldDataReader
+      attr_reader :site
+
+      def initialize(site)
+        @site = site
+        @safe = site.safe
+        @content = {}
+      end
 
-    def read(dir)
-      base = Jekyll.sanitized_path(@site.source, dir)
-      read_data_to(base, @content)
-      @content
-    end
+      def read(dir)
+        base = Jekyll.sanitized_path(@site.source, dir)
+        read_data_to(base, @content)
+        @content
+      end
 
-    def read_data_to(dir, data)
-      return unless File.directory?(dir) && (!@safe || !File.symlink?(dir))
+      def read_data_to(dir, data)
+        return unless File.directory?(dir) && (!@safe || !File.symlink?(dir))
 
-      entries = Dir.chdir(dir) do
-        Dir["*.{yaml,yml,json,csv}"] + Dir["*"].select { |fn| File.directory?(fn) }
-      end
+        entries = Dir.chdir(dir) do
+          Dir["*.{yaml,yml,json,csv}"] + Dir["*"].select { |fn| File.directory?(fn) }
+        end
 
-      entries.each do |entry|
-        path = Jekyll.sanitized_path(dir, entry)
-        next if File.symlink?(path) && @safe
+        entries.each do |entry|
+          path = Jekyll.sanitized_path(dir, entry)
+          next if File.symlink?(path) && @safe
 
-        key = sanitize_filename(File.basename(entry, ".*"))
-        if File.directory?(path)
-          read_data_to(path, data[key] = {})
-        else
-          data[key] = read_data_file(path)
+          key = sanitize_filename(File.basename(entry, ".*"))
+          if File.directory?(path)
+            read_data_to(path, data[key] = {})
+          else
+            data[key] = read_data_file(path)
+          end
         end
       end
-    end
 
-    def read_data_file(path)
-      {
-        "path" => path,
-      }
-    end
+      def read_data_file(path)
+        {
+          "path" => path,
+        }
+      end
 
-    def sanitize_filename(name)
-      name.gsub!(%r![^\w\s_-]+!, "")
-      name.gsub!(%r!(^|\b\s)\s+($|\s?\b)!, '\\1\\2')
-      name.gsub(%r!\s+!, "_")
+      def sanitize_filename(name)
+        name.gsub!(%r![^\w\s_-]+!, "")
+        name.gsub!(%r!(^|\b\s)\s+($|\s?\b)!, '\\1\\2')
+        name.gsub(%r!\s+!, "_")
+      end
     end
   end
 end

data/lib/cloudcannon-jekyll/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CloudCannonJekyll
-  VERSION = "1.5.0"
+  VERSION = "1.5.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.6
 platform: ruby
 authors:
 - CloudCannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll