cloudcannon-jekyll 1.3.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ced0f81dcb95e29ce12684d892c70e0b55cfe2b6f6b0c4558350ff67fab44274
-  data.tar.gz: fc357e889e99d0f76b64b45da546ec276413c644ca3653bb3a7f246eff01b668
+  metadata.gz: db495486f69fc156d24ba59209fb5f1627e6692e500d7175daf0f393634339b4
+  data.tar.gz: 3baa3ab9dec30d4d2f834c14b6088780f22365a3bece79cf2a70428a225ed67e
 SHA512:
-  metadata.gz: 459133474faa360db525f125120e3b5fe9a94387ce81ed3cea4b1fba714a80c98959a31b34b5f93f28ce1677da7afc3f4bfe7ed59681abd6ba924361af13867c
-  data.tar.gz: d742c5b8251541ec83383a510a0ab93d3f30d88dea601e2ccbacb2136908c162d5cdf166f23e749106f014eaa47e7eaa52db84f43e82ee48d82c87836a4e2853
+  metadata.gz: 5716ed9e99d8e57681880932c10c2f18eb0cfab47b82bb269ba544e67b4819fee5fe4a20deb03371c160d920b38acdd4356afe79ad5fe76b67c89b2059fd4bb4
+  data.tar.gz: cb4af8135d9426e12bf16532835ec31c01081f22ba5cfa9fecd80a7e8643136c5c2d0242cd99eb573f7c55079466ae9c032a93a1be32827cc7e6b0802af8f941

data/.reek.yml

@@ -0,0 +1,6 @@
+detectors:
+  LongParameterList:
+    max_params: 4 # Matches the Rubocop setting
+
+exclude_paths:
+  - spec

data/HISTORY.md

@@ -1,3 +1,25 @@
+# 1.4.2
+
+* Added max depth parameter for jsonify filter and increase it for array structures in config output
+
+# 1.4.1
+
+* Added JSON handling for integers in hash keys
+
+# 1.4.0
+
+* Fix typo for collections key in older Jekyll versions
+* Change date format to ISO8601
+* Validate against new version of config schema
+
+# 1.3.3
+
+* Add gem information and time to output config file
+
+# 1.3.2
+
+* Fix missing in-place compact
+
 # 1.3.1
 
 * Fix source being output as full path on disk

data/lib/cloudcannon-jekyll.rb

@@ -10,9 +10,9 @@ require_relative "cloudcannon-jekyll/version"
 
 Liquid::Template.register_filter(CloudCannonJekyll::JsonifyFilter)
 
-# Hooks didn't exist in Jekyll 2 so we monkey patch to get an :after_reset hook
 if Jekyll::VERSION.start_with? "2"
   module Jekyll
+    # Hooks didn't exist in Jekyll 2 so we monkey patch to get an :after_reset hook
     class Site
       alias_method :jekyll_reset, :reset
 

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

@@ -1,9 +1,14 @@
 {
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
+	"cloudcannon": {
+		"name": "cloudcannon-jekyll",
+		"version": {{ gem_version | cc_jsonify }}
+	},
 	{% if config.timezone %}"timezone": {{ config.timezone | cc_jsonify }},{% endif %}
 	"include": {{ config.include | cc_jsonify }},
 	"exclude": {{ config.exclude | cc_jsonify }},
 	{% if config.baseurl %}"base-url": {{ config.baseurl | cc_jsonify }},{% endif %}
-	{% if config.collections %}"comments": {{ config.collections | cc_jsonify: 'collections' }},{% endif %}
+	{% if config.collections %}"collections": {{ config.collections | cc_jsonify: 'collections' }},{% endif %}
 	{% if config._comments %}"comments": {{ config._comments | cc_jsonify }},{% endif %}
 	{% if config._options %}"input-options": {{ config._options | cc_jsonify }},{% endif %}
 	{% if config.defaults %}"defaults": {{ config.defaults | cc_jsonify }},{% endif %}
@@ -24,7 +29,7 @@
 		"includes": {{ config.includes_dir | cc_jsonify }},
 		"layouts": {{ config.layouts_dir | cc_jsonify }}
 	},
-	{% if config._array_structures %}"array-structures": {{ config._array_structures | cc_jsonify }},{% endif %}
+	{% if config._array_structures %}"array-structures": {{ config._array_structures | cc_jsonify: nil, 20 }},{% endif %}
 	{% assign select_data = config | cc_select_data_jsonify %}{% if select_data %}"select-data": {{ select_data }},{% endif %}
 	"source": {{ config.source | replace: pwd, "" | cc_jsonify }}
 }

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

@@ -1,9 +1,14 @@
 {
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
+	"cloudcannon": {
+		"name": "cloudcannon-jekyll",
+		"version": {{ gem_version | cc_jsonify }}
+	},
 	{% if config.timezone %}"timezone": {{ config.timezone | cc_jsonify }},{% endif %}
 	"include": {{ config.include | cc_jsonify }},
 	"exclude": {{ config.exclude | cc_jsonify }},
 	{% if config.baseurl %}"base-url": {{ config.baseurl | cc_jsonify }},{% endif %}
-	{% if config.collections %}"comments": {{ config.collections | cc_jsonify: 'collections' }},{% endif %}
+	{% if config.collections %}"collections": {{ config.collections | cc_jsonify: 'collections' }},{% endif %}
 	{% if config._comments %}"comments": {{ config._comments | cc_jsonify }},{% endif %}
 	{% if config._options %}"input-options": {{ config._options | cc_jsonify }},{% endif %}
 	{% if config.defaults %}"defaults": {{ config.defaults | cc_jsonify }},{% endif %}
@@ -24,7 +29,7 @@
 		"includes": {{ config.includes_dir | cc_jsonify }},
 		"layouts": {{ config.layouts_dir | cc_jsonify }}
 	},
-	{% if config._array_structures %}"array-structures": {{ config._array_structures | cc_jsonify }},{% endif %}
+	{% if config._array_structures %}"array-structures": {{ config._array_structures | cc_jsonify: nil, 20 }},{% endif %}
 	{% assign select_data = config | cc_select_data_jsonify %}{% if select_data %}"select-data": {{ select_data }},{% endif %}
 	"source": {{ config.source | replace: pwd, "" | cc_jsonify }}
 }

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

@@ -1,4 +1,9 @@
 {
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
+	"cloudcannon": {
+		"name": "cloudcannon-jekyll",
+		"version": {{ gem_version | cc_jsonify }}
+	},
 	{% if config.timezone -%}
 		"timezone": {{ config.timezone | cc_jsonify }},
 	{%- endif %}
@@ -43,7 +48,7 @@
 		"layouts": {{ config.layouts_dir | cc_jsonify }}
 	},
 	{% if config._array_structures -%}
-		"array-structures": {{ config._array_structures | cc_jsonify }},
+		"array-structures": {{ config._array_structures | cc_jsonify: nil, 20 }},
 	{%- endif %}
 	{% assign select_data = config | cc_select_data_jsonify -%}
 	{% if select_data -%}

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

@@ -1,5 +1,5 @@
 {
-	"time": {{ site.time | cc_jsonify }},
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
 		"version": {{ gem_version | cc_jsonify }}

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

@@ -1,5 +1,5 @@
 {
-	"time": {{ site.time | cc_jsonify }},
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
 		"version": {{ gem_version | cc_jsonify }}

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

@@ -1,5 +1,5 @@
 {
-	"time": {{ site.time | cc_jsonify }},
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
 		"version": {{ gem_version | cc_jsonify }}

data/lib/cloudcannon-jekyll/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module CloudCannonJekyll
+  # Processes Jekyll configuration to enable the plugin is run and fix common issues
   class Configuration
     def self.processed?(site)
       site.instance_variable_get(:@_cloudcannon_jekyll_processed) == true

data/lib/cloudcannon-jekyll/generator.rb

@@ -4,6 +4,7 @@ require "jekyll"
 require "fileutils"
 
 module CloudCannonJekyll
+  # Generates JSON files containing build config and build output details
   class Generator < Jekyll::Generator
     priority :lowest
 
@@ -27,7 +28,7 @@ module CloudCannonJekyll
     def generate_file(filename, data)
       dest = destination_path(filename)
       FileUtils.mkdir_p(File.dirname(dest))
-      File.open(dest, "w") { |f| f.write(file_content(filename, data)) }
+      File.open(dest, "w") { |file| file.write(file_content(filename, data)) }
     end
 
     def version_path_suffix
@@ -50,13 +51,13 @@ module CloudCannonJekyll
     end
 
     def file_content(filename, data)
-      json = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", path(filename))
-      json.content = File.read(source_path(filename))
-      json.data["layout"] = nil
-      json.data["sitemap"] = false
-      json.data["permalink"] = "/#{path(filename)}"
-      json.render({}, data)
-      json.output
+      page = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", path(filename))
+      page.content = File.read(source_path(filename))
+      page.data["layout"] = nil
+      page.data["sitemap"] = false
+      page.data["permalink"] = "/#{path(filename)}"
+      page.render({}, data)
+      page.output
     end
   end
 end

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

@@ -3,7 +3,11 @@
 require "jekyll"
 
 module CloudCannonJekyll
+  # Filter for converting Jekyll objects into JSON
   module JsonifyFilter
+    STATIC_EXTENSIONS = [".html", ".htm"].freeze
+    STATIC_PATHS = ["/robots.txt", "/sitemap.xml"].freeze
+
     CC_JSONIFY_KEY_SWAPS = {
       "collections" => {
         "_sort_key"      => "_sort-key",
@@ -13,7 +17,6 @@ module CloudCannonJekyll
         "_singular_name" => "_singular-name",
         "_singular_key"  => "_singular-key",
         "_disable_add"   => "_disable-add",
-        "_icon"          => "_icon",
         "_add_options"   => "_add-options",
       },
     }.freeze
@@ -42,102 +45,113 @@ module CloudCannonJekyll
       @simple_types.include?(input.class) || [true, false].include?(input)
     end
 
-    def self.static_file_to_json(input, depth)
+    def self.static_file_to_json(input, depth, max_depth)
       out = [
-        "\"extname\": #{JsonifyFilter.to_json(input.extname, depth + 1)}",
-        "\"path\": #{JsonifyFilter.to_json(input.relative_path, depth + 1)}",
+        "\"extname\": #{JsonifyFilter.to_json(input.extname, depth, max_depth)}",
+        "\"path\": #{JsonifyFilter.to_json(input.relative_path, depth, max_depth)}",
       ]
 
       # modified_time isn't defined in Jekyll 2.4.0
       if input.respond_to? :modified_time
-        out.push("\"modified_time\": #{JsonifyFilter.to_json(input.modified_time, depth + 1)}")
+        file_json = JsonifyFilter.to_json(input.modified_time, depth, max_depth)
+        out.push("\"modified_time\": #{file_json}")
       end
 
       "{#{out.join(",")}}"
     end
 
-    def self.document_data_to_json(data, out, prevent, depth)
+    def self.document_data_to_a(data, prevent, depth, max_depth)
       prevent += %w(content output next previous excerpt)
 
-      data.each do |key, value|
+      out = data.map do |key, value|
         next if prevent.include? key
 
         prevent.push key
-        out.push("#{key.to_json}: #{JsonifyFilter.to_json(value, depth + 1)}")
+        "#{key.to_json}: #{JsonifyFilter.to_json(value, depth, max_depth)}"
       end
 
-      "{#{out.join(",")}}"
+      out.compact
     end
 
-    def self.legacy_post_to_json(input, depth)
+    def self.legacy_post_to_json(input, depth, max_depth)
       prevent = %w(dir name path url date id categories tags)
 
       out = [
-        "\"dir\": #{JsonifyFilter.to_json(input.dir, depth + 1)}",
-        "\"name\": #{JsonifyFilter.to_json(input.name, depth + 1)}",
-        "\"path\": #{JsonifyFilter.to_json(input.path, depth + 1)}",
-        "\"url\": #{JsonifyFilter.to_json(input.url, depth + 1)}",
-        "\"date\": #{JsonifyFilter.to_json(input.date, depth + 1)}",
-        "\"id\": #{JsonifyFilter.to_json(input.id, depth + 1)}",
-        "\"categories\": #{JsonifyFilter.to_json(input.categories, depth + 1)}",
-        "\"tags\": #{JsonifyFilter.to_json(input.tags, depth + 1)}",
+        "\"dir\": #{JsonifyFilter.to_json(input.dir, depth, max_depth)}",
+        "\"name\": #{JsonifyFilter.to_json(input.name, depth, max_depth)}",
+        "\"path\": #{JsonifyFilter.to_json(input.path, depth, max_depth)}",
+        "\"url\": #{JsonifyFilter.to_json(input.url, depth, max_depth)}",
+        "\"date\": #{JsonifyFilter.to_json(input.date, depth, max_depth)}",
+        "\"id\": #{JsonifyFilter.to_json(input.id, depth, max_depth)}",
+        "\"categories\": #{JsonifyFilter.to_json(input.categories, depth, max_depth)}",
+        "\"tags\": #{JsonifyFilter.to_json(input.tags, depth, max_depth)}",
       ]
 
-      JsonifyFilter.document_data_to_json(input.data, out, prevent, depth)
+      out += JsonifyFilter.document_data_to_a(input.data, prevent, depth, max_depth)
+      "{#{out.join(",")}}"
     end
 
-    def self.page_to_json(input, depth)
+    def self.page_to_json(input, depth, max_depth)
       prevent = %w(dir name path url)
 
       out = [
-        "\"dir\": #{JsonifyFilter.to_json(input.dir, depth + 1)}",
-        "\"name\": #{JsonifyFilter.to_json(input.name, depth + 1)}",
-        "\"path\": #{JsonifyFilter.to_json(input.path, depth + 1)}",
-        "\"url\": #{JsonifyFilter.to_json(input.url, depth + 1)}",
+        "\"dir\": #{JsonifyFilter.to_json(input.dir, depth, max_depth)}",
+        "\"name\": #{JsonifyFilter.to_json(input.name, depth, max_depth)}",
+        "\"path\": #{JsonifyFilter.to_json(input.path, depth, max_depth)}",
+        "\"url\": #{JsonifyFilter.to_json(input.url, depth, max_depth)}",
       ]
 
       # Merge Jekyll Defaults into data for pages (missing at v3.8.5)
-      defaults = input.site.frontmatter_defaults.all(input.relative_path, :pages).tap do |h|
-        h.delete("date")
+      defaults = input.site.frontmatter_defaults.all(input.relative_path, :pages).tap do |default|
+        default.delete("date")
       end
 
       data = Jekyll::Utils.deep_merge_hashes(defaults, input.data)
-      JsonifyFilter.document_data_to_json(data, out, prevent, depth)
+
+      out += JsonifyFilter.document_data_to_a(data, prevent, depth, max_depth)
+      "{#{out.join(",")}}"
     end
 
-    def self.document_to_json(input, depth)
+    def self.document_to_json(input, depth, max_depth)
       prevent = %w(dir id relative_path url collection)
+      path_json = JsonifyFilter.to_json(input.relative_path, depth, max_depth)
 
       out = [
-        "\"path\": #{JsonifyFilter.to_json(input.relative_path, depth + 1)}",
-        "\"relative_path\": #{JsonifyFilter.to_json(input.relative_path, depth + 1)}",
-        "\"url\": #{JsonifyFilter.to_json(input.url, depth + 1)}",
+        "\"path\": #{path_json}",
+        "\"relative_path\": #{path_json}",
+        "\"url\": #{JsonifyFilter.to_json(input.url, depth, max_depth)}",
       ]
 
-      unless input.collection.nil?
-        out.push("\"collection\": #{JsonifyFilter.to_json(input.collection.label, depth + 1)}")
+      collection = input.collection
+      unless collection.nil?
+        collection_json = JsonifyFilter.to_json(collection.label, depth, max_depth)
+        out.push("\"collection\": #{collection_json}")
       end
 
       # id isn't defined in Jekyll 2.4.0
-      out.push("\"id\": #{JsonifyFilter.to_json(input.id, depth + 1)}") if input.respond_to? :id
+      if input.respond_to? :id
+        out.push("\"id\": #{JsonifyFilter.to_json(input.id, depth, max_depth)}")
+      end
 
-      JsonifyFilter.document_data_to_json(input.data, out, prevent, depth)
+      out += JsonifyFilter.document_data_to_a(input.data, prevent, depth, max_depth)
+      "{#{out.join(",")}}"
     end
 
-    def self.array_to_json(input, depth, key_swaps = {})
+    def self.array_to_json(input, depth, max_depth, key_swaps = {})
       array = input.map do |value|
-        JsonifyFilter.to_json(value, depth + 1, key_swaps)
+        JsonifyFilter.to_json(value, depth, max_depth, key_swaps)
       end
 
       "[#{array.join(",")}]"
     end
 
-    def self.hash_to_json(input, depth, key_swaps = {})
-      hash = input.map do |key, value|
-        "#{(key_swaps[key] || key).to_json}: #{JsonifyFilter.to_json(value, depth + 1, key_swaps)}"
+    def self.hash_to_json(input, depth, max_depth, key_swaps = {})
+      out = input.map do |key, value|
+        string_key = (key_swaps[key] || key).to_s.to_json
+        "#{string_key}: #{JsonifyFilter.to_json(value, depth, max_depth, key_swaps)}"
       end
 
-      "{#{hash.join(",")}}"
+      "{#{out.join(",")}}"
     end
 
     def self.config_to_select_data_json(input, depth)
@@ -155,47 +169,47 @@ module CloudCannonJekyll
         next if prevent.include? key
 
         prevent.push key
-        "#{key.to_json}: #{JsonifyFilter.to_json(value, depth + 1)}"
+        "#{key.to_s.to_json}: #{JsonifyFilter.to_json(value, depth)}"
       end
 
-      out.compact
+      out.compact!
 
       "{#{out.join(",")}}" if out.any?
     end
 
-    def self.to_json(input, depth, key_swaps = {})
-      if depth > 8 || (depth > 2 && JsonifyFilter.document_type?(input))
+    def self.to_json(input, depth, max_depth = 9, key_swaps = {})
+      depth += 1
+
+      if depth > max_depth || (depth > 2 && JsonifyFilter.document_type?(input))
         '"MAXIMUM_DEPTH"'
       elsif JsonifyFilter.simple_type?(input)
         input.to_json
       elsif input.is_a?(Jekyll::StaticFile)
-        JsonifyFilter.static_file_to_json(input, depth)
+        JsonifyFilter.static_file_to_json(input, depth, max_depth)
       elsif input.is_a?(Jekyll::Page)
-        JsonifyFilter.page_to_json(input, depth)
+        JsonifyFilter.page_to_json(input, depth, max_depth)
       elsif Jekyll::VERSION.start_with?("2.") && input.is_a?(Jekyll::Post)
-        JsonifyFilter.legacy_post_to_json(input, depth)
+        JsonifyFilter.legacy_post_to_json(input, depth, max_depth)
       elsif input.is_a?(Jekyll::Document)
-        JsonifyFilter.document_to_json(input, depth)
+        JsonifyFilter.document_to_json(input, depth, max_depth)
       elsif input.is_a?(Array)
-        JsonifyFilter.array_to_json(input, depth, key_swaps)
+        JsonifyFilter.array_to_json(input, depth, max_depth, key_swaps)
       elsif input.is_a?(Hash)
-        JsonifyFilter.hash_to_json(input, depth, key_swaps)
+        JsonifyFilter.hash_to_json(input, depth, max_depth, key_swaps)
       else
         input.class.to_s.prepend("UNSUPPORTED:").to_json
       end
     end
 
     def cc_static_files_jsonify(input)
-      out = []
-      input.each do |page|
-        next if page.extname != ".html" &&
-          page.extname != ".htm" &&
-          page.path != "/robots.txt" &&
-          page.path != "/sitemap.xml"
-
-        out.push(JsonifyFilter.to_json(page, 1))
+      out = input.map do |page|
+        next unless STATIC_EXTENSIONS.include?(page.extname) || STATIC_PATHS.include?(page.path)
+
+        JsonifyFilter.to_json(page, 1)
       end
 
+      out.compact!
+
       "[#{out.join(",")}]"
     end
 
@@ -207,11 +221,11 @@ module CloudCannonJekyll
       end
     end
 
-    def cc_jsonify(input, key_swaps_key = nil)
+    def cc_jsonify(input, key_swaps_key = nil, max_depth = 8)
       if CC_JSONIFY_KEY_SWAPS.key? key_swaps_key
-        JsonifyFilter.to_json(input, 0, CC_JSONIFY_KEY_SWAPS[key_swaps_key])
+        JsonifyFilter.to_json(input, 0, max_depth, CC_JSONIFY_KEY_SWAPS[key_swaps_key])
       else
-        JsonifyFilter.to_json(input, 0)
+        JsonifyFilter.to_json(input, 0, max_depth)
       end
     end
   end

data/lib/cloudcannon-jekyll/page-without-a-file.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module CloudCannonJekyll
+  # Utility class to help generate files with no source file
   class PageWithoutAFile < Jekyll::Page
     def read_yaml(*)
       @data ||= {}

data/lib/cloudcannon-jekyll/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.2
 platform: ruby
 authors:
 - CloudCannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -108,6 +108,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"