cloudcannon-jekyll 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4dd4e81ac500818217dfbceb63a6a8ed6ecef91583c1e84d08c43fcbeac9294
-  data.tar.gz: c6da0f3528124a84695ea6410f9199dcd3617a9711a4a0859be83f43107ef11b
+  metadata.gz: 8fb6d69020a149aa142d3e07d56e684c228a66f6b85af4f90ea3b2ec781960a7
+  data.tar.gz: 8ab26b830892091e808583431104d5196b606aae6e5f03eb65a85025a4dc93ae
 SHA512:
-  metadata.gz: f76962928b6592d53881f14e407a1cd492790e9b170e515307a6d2b9c001953b5866a89481ab9f1a1b1642ecad3cbb4ae02919c1f8e412fc00a2af060bf7cc91
-  data.tar.gz: 666d55022ea8f7255448db6a97e083e7332d06ec25dae0a07cef221322e4b2745a45f5c77979a636e5d0e4c0fff778f52eb22982662917fba8a2c68bec46a905
+  metadata.gz: 9569e09b712f5ce8902da2b09ec22ceb7472690a497a03a22187801dc4574425722b5370b49177c4313d466dac8edb57a7624f1e7ca8d5273fc48aee9cd37261
+  data.tar.gz: 59cd301082e6169baf3a96df82f0fe7cfc9857475dbc50925e64ad6e5d4ca93aef28961e1bef0766946cf3e1db4cb71c1fee35dc6bcca5de4240498b56736a1f

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,5 +1,32 @@
+# 0.4.0
+
+* Add `collections_dir` to details collection item paths
+* Fix pages collection clash with built-in pages
+* Fixed posts collection config data overwriting drafts data
+* Force generator to run after other lowest priority plugins
+
+# 0.3.4
+
+* Re-add id field for documents
+* Fix for potential nil reference
+
+# 0.3.3
+
+* Rework fallback for older versions of Jekyll when reading data, posts and drafts again
+
+# 0.3.2
+
+* Rework fallback for older versions of Jekyll when reading data, posts and drafts
+* Fix deprecation warning for `posts.map`
+
+# 0.3.1
+
+* Fix for empty collection configurations
+* Added max depth parameter for jsonify filter and increase it for array structures in config output
+
 # 0.3.0
 
+* Add empty paths.pages
 * Added drafts to collections in details
 * Added drafts and data to collections in config
 * Added category folder drafts and posts to collections in config
@@ -8,7 +35,6 @@
 * Renamed static to static-pages in details and removed `robots.txt` and `sitemap.xml` exceptions
 * Add `url` to static-pages
 * Normalise `_path` in static-pages
-* Added max depth parameter for jsonify filter and increase it for array structures in config output
 
 # 0.2.2
 

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,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)
@@ -87,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

@@ -107,20 +107,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
@@ -168,7 +180,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 = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - CloudCannon
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -142,7 +142,7 @@ homepage: https://github.com/cloudcannon/cloudcannon-jekyll
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: CloudCannon Jekyll integration
 test_files: []