cloudcannon-jekyll 1.5.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1622ca2b9f7eef0279882f94f4364c67ffdd9c403dbfc345bc882268ecd0f998
-  data.tar.gz: e3dab9c9f8fb8090c16c4c3c963566143bfe9a7d4fc18f674c1b33691c377575
+  metadata.gz: 10ce07fce474de172ceafec1ecbe0a0d4e6d012d2357befc0cef41e2418a992e
+  data.tar.gz: 418f38e206327042999eca17c901477e7fd864bce425a5410a6b49cc503760f3
 SHA512:
-  metadata.gz: 748183e00870b67a650ce2cd0386519faffc651750504804bd66d0dd133576a714221d64405d7afc9729558ec6eb8719e3105ee349b4155c53c87af3fffc3351
-  data.tar.gz: e3d770a079ae5a349b7ceec3c1dc4db930bd294a3856c991520bdfe8624a901d00749f37b4fb825dbdfa1e56f67934179c8b0f0ac585968ec9cc30483e50d96b
+  metadata.gz: db5ebdba978110b1b312dafb9b1e3f9928edd4259b9095af266a2be1964bdf3028a0fe303080353b8a5a18685ae52705dd630cf16285e1be9f7c129c328fc525
+  data.tar.gz: 76f36521f6b0888b90be9e0a071bd5c3258e97ec2623d996ebf3a5cdc7f0f3f771e35bf6b0f258f4e5654538e7dcc17524f32fd37223414b0cb5ffbf8f24700d

data/.gitignore

@@ -1,7 +1,7 @@
 Gemfile.lock
 spec/dest/
-spec/fixtures/.jekyll-cache/
-spec/fixtures/.jekyll-metadata
+spec/fixtures/**/.jekyll-cache/
+spec/fixtures/**/.jekyll-metadata
 spec/fixtures/_site/
 gemfiles/.bundle/
 gemfiles/*.gemfile.lock

data/HISTORY.md

@@ -1,3 +1,25 @@
+# 1.6.0
+
+* Add `collections_dir` to details collection item paths
+
+# 1.5.7
+
+* Fix pages collection clash with built-in pages
+* Fixed posts collection config data overwriting drafts data
+
+# 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

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

@@ -23,6 +23,6 @@
 		{% for collection in site.collections %}"{{ collection[0] | xml_escape }}": {{ collection[1].docs | cc_jsonify }}{% unless forloop.last %},{% endunless %}
 		{% endfor %}
 	},
-	"pages": {{ site.pages | cc_jsonify }},
+	"pages": {{ site.html_pages | cc_jsonify }},
 	"static-pages": {{ site.static_files | cc_static_files_jsonify }}
 }

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

@@ -22,6 +22,6 @@
 		{% for collection in site.collections %}"{{ collection.label | xml_escape }}": {{ collection.docs | cc_jsonify }}{% unless forloop.last %},{% endunless %}
 		{% endfor %}
 	},
-	"pages": {{ site.pages | cc_jsonify }},
+	"pages": {{ site.html_pages | cc_jsonify }},
 	"static-pages": {{ site.static_files | cc_static_files_jsonify }}
 }

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

@@ -36,6 +36,6 @@
 			{%- unless forloop.last %},{% endunless %}
 		{%- endfor -%}
 	},
-	"pages": {{ site.pages | cc_jsonify }},
+	"pages": {{ site.html_pages | cc_jsonify }},
 	"static-pages": {{ site.static_files | cc_static_files_jsonify }}
 }

data/lib/cloudcannon-jekyll/generator.rb

@@ -7,13 +7,17 @@ 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|
@@ -95,9 +99,7 @@ module CloudCannonJekyll
       collections_config["posts"] = { "output" => true } if Jekyll::VERSION.start_with? "2."
       drafts = @reader.read_drafts(collections_dir)
 
-      if collections_config.key?("posts")
-        collections_config["drafts"] = collections_config["posts"].dup
-      elsif drafts.any?
+      if (collections_config.key?("posts") && !collections_config.key?("drafts")) || drafts.any?
         collections_config["drafts"] = {}
       end
 

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

@@ -106,20 +106,32 @@ module CloudCannonJekyll
       "{#{out.join(",")}}"
     end
 
+    def self.document_path(input)
+      collections_dir = input.site.config["collections_dir"] || ""
+      if input.collection && !collections_dir.empty?
+        "#{collections_dir}/#{input.relative_path}"
+      else
+        input.relative_path
+      end
+    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)}",
+        "\"path\": #{JsonifyFilter.to_json(JsonifyFilter.document_path(input), depth, max_depth)}",
         "\"url\": #{JsonifyFilter.to_json(input.url, depth, max_depth)}",
       ]
 
-      collection = input.collection
-      unless collection.nil?
-        collection_json = JsonifyFilter.to_json(collection.label, depth, max_depth)
+      unless input.collection.nil?
+        collection_json = JsonifyFilter.to_json(input.collection.label, depth, max_depth)
         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

data/lib/cloudcannon-jekyll/reader.rb

@@ -1,12 +1,8 @@
 # frozen_string_literal: true
 
 require "jekyll"
-
-begin
-  require_relative "readers/data-reader"
-rescue NameError
-  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,21 +14,30 @@ module CloudCannonJekyll
     end
 
     def read_data(dir = "_data")
-      CloudCannonJekyll::DataReader.new(@site).read(dir)
-    rescue NameError # DataReader doesn't exist in old versions of Jekyll
-      CloudCannonJekyll::OldDataReader.new(@site).read(dir)
+      # DataReader doesn't exist in old versions of Jekyll
+      if Jekyll::VERSION.start_with? "2."
+        CloudCannonJekyll::OldDataReader.new(@site).read(dir)
+      else
+        CloudCannonJekyll::DataReader.new(@site).read(dir)
+      end
     end
 
     def read_drafts(dir = "")
-      Jekyll::PostReader.new(@site).read_drafts(dir)
-    rescue NameError # PostReader doesn't exist in old versions of Jekyll
-      @site.read_content(dir, "_drafts", Jekyll::Draft)
+      # PostReader doesn't exist in old versions of Jekyll
+      if Jekyll::VERSION.start_with? "2."
+        @site.read_content(dir, "_drafts", Jekyll::Draft)
+      else
+        Jekyll::PostReader.new(@site).read_drafts(dir)
+      end
     end
 
     def read_posts(dir = "")
-      Jekyll::PostReader.new(@site).read_posts(dir)
-    rescue NameError # PostReader doesn't exist in old versions of Jekyll
-      @site.read_content(dir, "_posts", Jekyll::Post)
+      # PostReader doesn't exist in old versions of Jekyll
+      if Jekyll::VERSION.start_with? "2."
+        @site.read_content(dir, "_posts", Jekyll::Post)
+      else
+        Jekyll::PostReader.new(@site).read_posts(dir)
+      end
     end
   end
 end

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.3"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.6.0
 platform: ruby
 authors:
 - CloudCannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll