cloudcannon-jekyll 1.0.3 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c8ffa6f24f23d77d8891582ae787a2a26b90d94bdfe8e6f31aaa7b9068fd10e
-  data.tar.gz: b755136ed83f7f0facd35518fed62ea442a05b60b09241aeb385e7bdf1a665fe
+  metadata.gz: ced0f81dcb95e29ce12684d892c70e0b55cfe2b6f6b0c4558350ff67fab44274
+  data.tar.gz: fc357e889e99d0f76b64b45da546ec276413c644ca3653bb3a7f246eff01b668
 SHA512:
-  metadata.gz: 9cf5db9ce6a3ba4c20a9a44d6c3a3ef86cc848d1020d375f7e080aa157674ed87d8c457c2319fada463f444846c85313b3185b2a2c87ec42b216e9f7b0674eae
-  data.tar.gz: 150d2008c0792bd230d33a5aa9b8e1b518b18f8ae93c87f1490ff8704d1c3b0dd22c414ae03199f7b3e1d5ccfdee22dd852970eb5f6905f038da8b8ecf86614b
+  metadata.gz: 459133474faa360db525f125120e3b5fe9a94387ce81ed3cea4b1fba714a80c98959a31b34b5f93f28ce1677da7afc3f4bfe7ed59681abd6ba924361af13867c
+  data.tar.gz: d742c5b8251541ec83383a510a0ab93d3f30d88dea601e2ccbacb2136908c162d5cdf166f23e749106f014eaa47e7eaa52db84f43e82ee48d82c87836a4e2853

data/.gitignore

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

data/.rubocop.yml

@@ -4,7 +4,7 @@ inherit_gem:
   rubocop-jekyll: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.4
   Include:
     - lib/**/*.rb
 
@@ -20,8 +20,23 @@ AllCops:
     - script/**/*
     - vendor/**/*
     - gemfiles/**/*
-    - lib/cloudcannon-jekyll/safe-jsonify-filter.rb # TODO remove this and fix warnings
 
 Naming/MemoizedInstanceVariableName:
   Exclude:
     - lib/cloudcannon-jekyll/page-without-a-file.rb
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/cloudcannon-jekyll/jsonify-filter.rb # TODO remove this and fix warnings
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - lib/cloudcannon-jekyll/jsonify-filter.rb # TODO remove this and fix warnings
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/cloudcannon-jekyll/jsonify-filter.rb # TODO remove this and fix warnings
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/cloudcannon-jekyll/jsonify-filter.rb # TODO remove this and fix warnings

data/.travis.yml

@@ -16,4 +16,4 @@ env:
     - JEKYLL_VERSION="2.4.0"
     - JEKYLL_VERSION="3.0.0"
     - JEKYLL_VERSION="3.8.5"
-    - JEKYLL_VERSION="4.0.0"
+    - JEKYLL_VERSION="4.1.1"

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/HISTORY.md

@@ -1,3 +1,32 @@
+# 1.3.1
+
+* Fix source being output as full path on disk
+* Read content for output config file directly from site config
+
+# 1.3.0
+
+* Add defaults and input-options keys to config output
+
+# 1.2.3
+
+* Add more ignore keys for legacy select data filter
+
+# 1.2.2
+
+* Reduce methods added from other plugins clashing
+
+# 1.2.1
+
+* Fix invalid output when unsupported class found
+
+# 1.2.0
+
+* Add output config file
+
+# 1.1.0
+
+* Add support for including only specified `data` keys
+
 # 1.0.3
 
 * Fix invalid JSON issue for sites built with Jekyll 2 and no collections

data/cloudcannon-jekyll.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "cloudcannon-jekyll/version"
@@ -23,8 +23,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "jekyll", ">= 2.4.0", "< 5"
 
+  spec.add_development_dependency "json_schemer", "~> 0.2.13"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9"
-  spec.add_development_dependency "rubocop", "~> 0.71"
-  spec.add_development_dependency "rubocop-jekyll", "~> 0.10"
+  spec.add_development_dependency "rubocop", "~> 0.80"
+  spec.add_development_dependency "rubocop-jekyll", "~> 0.11"
 end

data/lib/cloudcannon-jekyll.rb

@@ -5,10 +5,10 @@ require "jekyll"
 require_relative "cloudcannon-jekyll/page-without-a-file"
 require_relative "cloudcannon-jekyll/generator"
 require_relative "cloudcannon-jekyll/configuration"
-require_relative "cloudcannon-jekyll/safe-jsonify-filter"
+require_relative "cloudcannon-jekyll/jsonify-filter"
 require_relative "cloudcannon-jekyll/version"
 
-Liquid::Template.register_filter(CloudCannonJekyll::SafeJsonifyFilter)
+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"

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

@@ -0,0 +1,30 @@
+{
+	{% 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._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 %}
+	{% if config._editor %}"editor": {
+		"default-path": {{ config._editor.default_path | cc_jsonify }}
+	},{% endif %}
+	{% if config._source_editor %}"source-editor": {
+		"tab-size": {{ config._source_editor.tab_size | cc_jsonify }},
+		"show-gutter": {{ config._source_editor.show_gutter | cc_jsonify }},
+		"theme": {{ config._source_editor.theme | cc_jsonify }}
+	},{% endif %}
+	{% if config._explore %}"explore": {{ config._explore | cc_jsonify }},{% endif %}
+	"paths": {
+		"uploads": {{ config.uploads_dir | cc_jsonify }},
+		"plugins": {{ config.plugins_dir | cc_jsonify }},
+		"data": {{ config.data_dir | cc_jsonify }},
+		"collections": {{ config.collections_dir | cc_jsonify }},
+		"includes": {{ config.includes_dir | cc_jsonify }},
+		"layouts": {{ config.layouts_dir | cc_jsonify }}
+	},
+	{% if config._array_structures %}"array-structures": {{ config._array_structures | cc_jsonify }},{% 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

@@ -0,0 +1,30 @@
+{
+	{% 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._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 %}
+	{% if config._editor %}"editor": {
+		"default-path": {{ config._editor.default_path | cc_jsonify }}
+	},{% endif %}
+	{% if config._source_editor %}"source-editor": {
+		"tab-size": {{ config._source_editor.tab_size | cc_jsonify }},
+		"show-gutter": {{ config._source_editor.show_gutter | cc_jsonify }},
+		"theme": {{ config._source_editor.theme | cc_jsonify }}
+	},{% endif %}
+	{% if config._explore %}"explore": {{ config._explore | cc_jsonify }},{% endif %}
+	"paths": {
+		"uploads": {{ config.uploads_dir | cc_jsonify }},
+		"plugins": {{ config.plugins_dir | cc_jsonify }},
+		"data": {{ config.data_dir | cc_jsonify }},
+		"collections": {{ config.collections_dir | cc_jsonify }},
+		"includes": {{ config.includes_dir | cc_jsonify }},
+		"layouts": {{ config.layouts_dir | cc_jsonify }}
+	},
+	{% if config._array_structures %}"array-structures": {{ config._array_structures | cc_jsonify }},{% 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

@@ -0,0 +1,53 @@
+{
+	{% 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 -%}
+		"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 %}
+	{% if config._editor -%}
+		"editor": {
+			"default-path": {{ config._editor.default_path | cc_jsonify }}
+		},
+	{%- endif %}
+	{% if config._source_editor -%}
+		"source-editor": {
+			"tab-size": {{ config._source_editor.tab_size | cc_jsonify }},
+			"show-gutter": {{ config._source_editor.show_gutter | cc_jsonify }},
+			"theme": {{ config._source_editor.theme | cc_jsonify }}
+		},
+	{%- endif %}
+	{% if config._explore -%}
+		"explore": {{ config._explore | cc_jsonify }},
+	{%- endif %}
+	"paths": {
+		"uploads": {{ config.uploads_dir | cc_jsonify }},
+		"plugins": {{ config.plugins_dir | cc_jsonify }},
+		"data": {{ config.data_dir | cc_jsonify }},
+		"collections": {{ config.collections_dir | cc_jsonify }},
+		"includes": {{ config.includes_dir | cc_jsonify }},
+		"layouts": {{ config.layouts_dir | cc_jsonify }}
+	},
+	{% if config._array_structures -%}
+		"array-structures": {{ config._array_structures | cc_jsonify }},
+	{%- 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/details-2.x.json

@@ -1,25 +1,27 @@
 {
-	"time": {{ site.time | jsonify }},
+	"time": {{ site.time | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
-		"version": {{ gem_version | jsonify }}
+		"version": {{ gem_version | cc_jsonify }}
 	},
 	"generator": {
 		"name": "jekyll",
-		"version": {{ jekyll.version | jsonify }},
-		"environment": {{ jekyll.env | jsonify }},
+		"version": {{ jekyll.version | cc_jsonify }},
+		"environment": {{ jekyll.env | cc_jsonify }},
 		"metadata": {
-			"markdown": {{ site.markdown | cc_safe_jsonify }},
-			"kramdown": {{ site.kramdown | cc_safe_jsonify }},
-			"commonmark": {{ site.commonmark | cc_safe_jsonify }}
+			"markdown": {{ site.markdown | cc_jsonify }},
+			"kramdown": {{ site.kramdown | cc_jsonify }},
+			"commonmark": {{ site.commonmark | cc_jsonify }}
 		}
-	},{% if site.cloudcannon.data %}
-	"data": {{ site.data | cc_safe_jsonify }},{% endif %}
+	},{% if site.cloudcannon.data.first %}{% assign data_seen = false %}
+	"data": {
+		{% for data in site.data %}{% assign key = data[0] %}{% if site.cloudcannon.data[key] %}{% if data_seen %},{% endif %}{{ data[0] | cc_jsonify }}: {{ data[1] | cc_jsonify }}{% assign data_seen = true %}{% endif %}{% endfor %}},
+	{% elsif site.cloudcannon.data %}"data": {{ site.data | cc_jsonify }},{% endif %}
 	"collections": {
-		"posts": {{ site.posts | reverse | cc_safe_jsonify }}{% if site.collections.size > 0 %},{% endif %}
-		{% for collection in site.collections %}"{{ collection[0] | xml_escape }}": {{ collection[1].docs | cc_safe_jsonify }}{% unless forloop.last %},{% endunless %}
+		"posts": {{ site.posts | reverse | cc_jsonify }}{% if site.collections.size > 0 %},{% endif %}
+		{% for collection in site.collections %}"{{ collection[0] | xml_escape }}": {{ collection[1].docs | cc_jsonify }}{% unless forloop.last %},{% endunless %}
 		{% endfor %}
 	},
-	"pages": {{ site.pages | cc_safe_jsonify }},
+	"pages": {{ site.pages | cc_jsonify }},
 	"static": {{ site.static_files | cc_static_files_jsonify }}
 }

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

@@ -0,0 +1,26 @@
+{
+	"time": {{ site.time | cc_jsonify }},
+	"cloudcannon": {
+		"name": "cloudcannon-jekyll",
+		"version": {{ gem_version | cc_jsonify }}
+	},
+	"generator": {
+		"name": "jekyll",
+		"version": {{ jekyll.version | cc_jsonify }},
+		"environment": {{ jekyll.env | cc_jsonify }},
+		"metadata": {
+			"markdown": {{ site.markdown | cc_jsonify }},
+			"kramdown": {{ site.kramdown | cc_jsonify }},
+			"commonmark": {{ site.commonmark | cc_jsonify }}
+		}
+	},{% if site.cloudcannon.data.first %}{% assign data_seen = false %}
+	"data": {
+		{% for data in site.data %}{% assign key = data[0] %}{% if site.cloudcannon.data[key] %}{% if data_seen %},{% endif %}{{ data[0] | cc_jsonify }}: {{ data[1] | cc_jsonify }}{% assign data_seen = true %}{% endif %}{% endfor %}},
+	{% elsif site.cloudcannon.data %}"data": {{ site.data | cc_jsonify }},{% endif %}
+	"collections": {
+		{% for collection in site.collections %}"{{ collection.label | xml_escape }}": {{ collection.docs | cc_jsonify }}{% unless forloop.last %},{% endunless %}
+		{% endfor %}
+	},
+	"pages": {{ site.pages | cc_jsonify }},
+	"static": {{ site.static_files | cc_static_files_jsonify }}
+}

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

@@ -1,28 +1,40 @@
 {
-	"time": {{ site.time | jsonify }},
+	"time": {{ site.time | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
-		"version": {{ gem_version | jsonify }}
+		"version": {{ gem_version | cc_jsonify }}
 	},
 	"generator": {
 		"name": "jekyll",
-		"version": {{ jekyll.version | jsonify }},
-		"environment": {{ jekyll.env | jsonify }},
+		"version": {{ jekyll.version | cc_jsonify }},
+		"environment": {{ jekyll.env | cc_jsonify }},
 		"metadata": {
-			"markdown": {{ site.markdown | cc_safe_jsonify }},
-			"kramdown": {{ site.kramdown | cc_safe_jsonify }},
-			"commonmark": {{ site.commonmark | cc_safe_jsonify }}
+			"markdown": {{ site.markdown | cc_jsonify }},
+			"kramdown": {{ site.kramdown | cc_jsonify }},
+			"commonmark": {{ site.commonmark | cc_jsonify }}
 		}
 	},
-	{%- if site.cloudcannon.data %}
-		"data": {{ site.data | cc_safe_jsonify }},
-	{% endif %}
+	{% if site.cloudcannon.data.first -%}
+		"data": {
+			{%- assign data_seen = false %}
+			{%- for data in site.data %}
+				{%- assign key = data[0] %}
+				{%- if site.cloudcannon.data[key] %}
+					{%- if data_seen %},{% endif -%}
+					{{ data[0] | cc_jsonify }}: {{ data[1] | cc_jsonify }}
+					{%- assign data_seen = true %}
+				{%- endif %}
+			{%- endfor -%}
+		},
+	{% elsif site.cloudcannon.data -%}
+		"data": {{ site.data | cc_jsonify }},
+	{%- endif %}
 	"collections": {
-		{% for collection in site.collections -%}
-			"{{ collection.label | xml_escape }}": {{ collection.docs | cc_safe_jsonify }}
+		{%- for collection in site.collections -%}
+			"{{ collection.label | xml_escape }}": {{ collection.docs | cc_jsonify }}
 			{%- unless forloop.last %},{% endunless %}
-		{%- endfor %}
+		{%- endfor -%}
 	},
-	"pages": {{ site.pages | cc_safe_jsonify }},
+	"pages": {{ site.pages | cc_jsonify }},
 	"static": {{ site.static_files | cc_static_files_jsonify }}
 }

data/lib/cloudcannon-jekyll/generator.rb

@@ -9,33 +9,53 @@ module CloudCannonJekyll
 
     def generate(site)
       @site = site
-      FileUtils.mkdir_p(File.dirname(destination_path))
-      File.open(destination_path, "w") { |f| f.write(file_content) }
+
+      payload = @site.site_payload.merge({
+        "gem_version" => CloudCannonJekyll::VERSION,
+        "pwd"         => Dir.pwd,
+        "config"      => @site.config,
+      })
+
+      generate_file("details", payload)
+      generate_file("config", payload)
+
       @site.keep_files ||= []
-      @site.keep_files << "_cloudcannon/details.json"
+      @site.keep_files << path("details")
+      @site.keep_files << path("config")
+    end
+
+    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)) }
     end
 
-    def source_path
-      path = "_cloudcannon/details.json"
-      path = "_cloudcannon/details-2.x.json" if Jekyll::VERSION.start_with? "2."
-      path = "_cloudcannon/details-3.0.x.json" if Jekyll::VERSION.match? %r!3\.[0-4]\.!
+    def version_path_suffix
+      return "-2.x" if Jekyll::VERSION.start_with? "2."
+      return "-3.0-4.x" if Jekyll::VERSION.match? %r!3\.[0-4]\.!
 
-      File.expand_path(path, File.dirname(__FILE__))
+      ""
     end
 
-    def destination_path
-      Jekyll.sanitized_path(@site.dest, "_cloudcannon/details.json")
+    def path(filename, suffix = "")
+      "_cloudcannon/#{filename}#{suffix}.json"
     end
 
-    def file_content
-      json = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", "_cloudcannon/details.json")
-      json.content = File.read(source_path)
+    def source_path(filename)
+      File.expand_path(path(filename, version_path_suffix), File.dirname(__FILE__))
+    end
+
+    def destination_path(filename)
+      Jekyll.sanitized_path(@site.dest, path(filename))
+    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"] = "/_cloudcannon/details.json"
-
-      json.render({}, @site.site_payload.merge("gem_version" => CloudCannonJekyll::VERSION))
+      json.data["permalink"] = "/#{path(filename)}"
+      json.render({}, data)
       json.output
     end
   end

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

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+module CloudCannonJekyll
+  module JsonifyFilter
+    CC_JSONIFY_KEY_SWAPS = {
+      "collections" => {
+        "_sort_key"      => "_sort-key",
+        "_subtext_key"   => "_subtext-key",
+        "_image_key"     => "_image-key",
+        "_image_size"    => "_image-size",
+        "_singular_name" => "_singular-name",
+        "_singular_key"  => "_singular-key",
+        "_disable_add"   => "_disable-add",
+        "_icon"          => "_icon",
+        "_add_options"   => "_add-options",
+      },
+    }.freeze
+
+    @simple_types = [
+      String,
+      Numeric,
+      Integer,
+      Float,
+      Date,
+      Time,
+      NilClass,
+    ].freeze
+
+    @document_types = [
+      Jekyll::Document,
+      Jekyll::Page,
+      Jekyll::VERSION.start_with?("2.") ? Jekyll::Post : nil,
+    ].compact.freeze
+
+    def self.document_type?(input)
+      @document_types.include?(input.class)
+    end
+
+    def self.simple_type?(input)
+      @simple_types.include?(input.class) || [true, false].include?(input)
+    end
+
+    def self.static_file_to_json(input, depth)
+      out = [
+        "\"extname\": #{JsonifyFilter.to_json(input.extname, depth + 1)}",
+        "\"path\": #{JsonifyFilter.to_json(input.relative_path, depth + 1)}",
+      ]
+
+      # 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)}")
+      end
+
+      "{#{out.join(",")}}"
+    end
+
+    def self.document_data_to_json(data, out, prevent, depth)
+      prevent += %w(content output next previous excerpt)
+
+      data.each do |key, value|
+        next if prevent.include? key
+
+        prevent.push key
+        out.push("#{key.to_json}: #{JsonifyFilter.to_json(value, depth + 1)}")
+      end
+
+      "{#{out.join(",")}}"
+    end
+
+    def self.legacy_post_to_json(input, 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)}",
+      ]
+
+      JsonifyFilter.document_data_to_json(input.data, out, prevent, depth)
+    end
+
+    def self.page_to_json(input, 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)}",
+      ]
+
+      # 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")
+      end
+
+      data = Jekyll::Utils.deep_merge_hashes(defaults, input.data)
+      JsonifyFilter.document_data_to_json(data, out, prevent, depth)
+    end
+
+    def self.document_to_json(input, depth)
+      prevent = %w(dir id relative_path url collection)
+
+      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)}",
+      ]
+
+      unless input.collection.nil?
+        out.push("\"collection\": #{JsonifyFilter.to_json(input.collection.label, depth + 1)}")
+      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
+
+      JsonifyFilter.document_data_to_json(input.data, out, prevent, depth)
+    end
+
+    def self.array_to_json(input, depth, key_swaps = {})
+      array = input.map do |value|
+        JsonifyFilter.to_json(value, depth + 1, 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)}"
+      end
+
+      "{#{hash.join(",")}}"
+    end
+
+    def self.config_to_select_data_json(input, depth)
+      prevent = %w(source destination collections_dir cache_dir plugins_dir layouts_dir data_dir
+                   includes_dir collections safe include exclude keep_files encoding markdown_ext
+                   strict_front_matter show_drafts limit_posts future unpublished whitelist
+                   plugins markdown highlighter lsi excerpt_separator incremental detach port host
+                   baseurl show_dir_listing permalink paginate_path timezone quiet verbose defaults
+                   liquid kramdown title url description uploads_dir _comments _options _editor
+                   _explore _source_editor _array_structures maruku redcloth rdiscount redcarpet
+                   gems plugins)
+
+      out = input.map do |key, value|
+        next unless value.is_a?(Array) || value.is_a?(Hash)
+        next if prevent.include? key
+
+        prevent.push key
+        "#{key.to_json}: #{JsonifyFilter.to_json(value, depth + 1)}"
+      end
+
+      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))
+        '"MAXIMUM_DEPTH"'
+      elsif JsonifyFilter.simple_type?(input)
+        input.to_json
+      elsif input.is_a?(Jekyll::StaticFile)
+        JsonifyFilter.static_file_to_json(input, depth)
+      elsif input.is_a?(Jekyll::Page)
+        JsonifyFilter.page_to_json(input, depth)
+      elsif Jekyll::VERSION.start_with?("2.") && input.is_a?(Jekyll::Post)
+        JsonifyFilter.legacy_post_to_json(input, depth)
+      elsif input.is_a?(Jekyll::Document)
+        JsonifyFilter.document_to_json(input, depth)
+      elsif input.is_a?(Array)
+        JsonifyFilter.array_to_json(input, depth, key_swaps)
+      elsif input.is_a?(Hash)
+        JsonifyFilter.hash_to_json(input, 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))
+      end
+
+      "[#{out.join(",")}]"
+    end
+
+    def cc_select_data_jsonify(input)
+      if input.key? "_select_data"
+        JsonifyFilter.to_json(input["_select_data"], 0)
+      else
+        JsonifyFilter.config_to_select_data_json(input, 0)
+      end
+    end
+
+    def cc_jsonify(input, key_swaps_key = nil)
+      if CC_JSONIFY_KEY_SWAPS.key? key_swaps_key
+        JsonifyFilter.to_json(input, 0, CC_JSONIFY_KEY_SWAPS[key_swaps_key])
+      else
+        JsonifyFilter.to_json(input, 0)
+      end
+    end
+  end
+end

data/lib/cloudcannon-jekyll/version.rb

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

data/script/ci-smoke-test

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+set -ex
+
+# Checks to see the build is likely to fail on Travis.
+# Duplicated the versions from .travis.yml
+
+JEKYLL_VERSION=2.4.0 bundle update && $(dirname "$0")/test &&
+JEKYLL_VERSION=3.0.0 bundle update && $(dirname "$0")/test &&
+JEKYLL_VERSION=3.8.5 bundle update && $(dirname "$0")/test &&
+JEKYLL_VERSION=4.1.1 bundle update && $(dirname "$0")/test

data/script/cibuild

@@ -2,6 +2,5 @@
 
 set -ex
 
-bundle exec rspec "$@"
-bundle exec rubocop -S
+$(dirname "$0")/test
 bundle exec gem build cloudcannon-jekyll.gemspec

data/script/test

@@ -3,3 +3,4 @@
 set -ex
 
 bundle exec rspec "$@"
+bundle exec rubocop -S

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.3.1
 platform: ruby
 authors:
 - CloudCannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-19 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.13
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -64,28 +78,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.71'
+        version: '0.80'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.71'
+        version: '0.80'
 - !ruby/object:Gem::Dependency
   name: rubocop-jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.11'
 description: Creates CloudCannon editor details for Jekyll
 email:
 - support@cloudcannon.com
@@ -104,14 +118,18 @@ files:
 - Rakefile
 - cloudcannon-jekyll.gemspec
 - lib/cloudcannon-jekyll.rb
+- lib/cloudcannon-jekyll/_cloudcannon/config-2.x.json
+- lib/cloudcannon-jekyll/_cloudcannon/config-3.0-4.x.json
+- lib/cloudcannon-jekyll/_cloudcannon/config.json
 - lib/cloudcannon-jekyll/_cloudcannon/details-2.x.json
-- lib/cloudcannon-jekyll/_cloudcannon/details-3.0.x.json
+- lib/cloudcannon-jekyll/_cloudcannon/details-3.0-4.x.json
 - lib/cloudcannon-jekyll/_cloudcannon/details.json
 - lib/cloudcannon-jekyll/configuration.rb
 - lib/cloudcannon-jekyll/generator.rb
+- lib/cloudcannon-jekyll/jsonify-filter.rb
 - lib/cloudcannon-jekyll/page-without-a-file.rb
-- lib/cloudcannon-jekyll/safe-jsonify-filter.rb
 - lib/cloudcannon-jekyll/version.rb
+- script/ci-smoke-test
 - script/cibuild
 - script/release
 - script/test
@@ -134,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: CloudCannon Jekyll integration

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

@@ -1,24 +0,0 @@
-{
-	"time": {{ site.time | jsonify }},
-	"cloudcannon": {
-		"name": "cloudcannon-jekyll",
-		"version": {{ gem_version | jsonify }}
-	},
-	"generator": {
-		"name": "jekyll",
-		"version": {{ jekyll.version | jsonify }},
-		"environment": {{ jekyll.env | jsonify }},
-		"metadata": {
-			"markdown": {{ site.markdown | cc_safe_jsonify }},
-			"kramdown": {{ site.kramdown | cc_safe_jsonify }},
-			"commonmark": {{ site.commonmark | cc_safe_jsonify }}
-		}
-	},{% if site.cloudcannon.data %}
-	"data": {{ site.data | cc_safe_jsonify }},{% endif %}
-	"collections": {
-		{% for collection in site.collections %}"{{ collection.label | xml_escape }}": {{ collection.docs | cc_safe_jsonify }}{% unless forloop.last %},{% endunless %}
-		{% endfor %}
-	},
-	"pages": {{ site.pages | cc_safe_jsonify }},
-	"static": {{ site.static_files | cc_static_files_jsonify }}
-}

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

@@ -1,169 +0,0 @@
-# frozen_string_literal: true
-
-require "jekyll"
-
-module CloudCannonJekyll
-  module SafeJsonifyFilter
-    @simple_types = [
-      String,
-      Numeric,
-      Integer,
-      Float,
-      Date,
-      Time,
-      NilClass,
-    ].freeze
-
-    @document_types = [
-      Jekyll::Document,
-      Jekyll::Page,
-      Jekyll::VERSION.start_with?("2.") ? Jekyll::Post : nil,
-    ].compact.freeze
-
-    def self.document_type?(input)
-      @document_types.include?(input.class)
-    end
-
-    def self.simple_type?(input)
-      @simple_types.include?(input.class) || [true, false].include?(input)
-    end
-
-    def self.static_file_to_json(input, depth)
-      out = [
-        "\"extname\": #{SafeJsonifyFilter.to_json(input.extname, depth + 1)}",
-        "\"path\": #{SafeJsonifyFilter.to_json(input.relative_path, depth + 1)}",
-      ]
-
-      # modified_time isn't defined in Jekyll 2.4.0
-      if input.respond_to? :modified_time
-        out.push("\"modified_time\": #{SafeJsonifyFilter.to_json(input.modified_time, depth + 1)}")
-      end
-
-      "{#{out.join(",")}}"
-    end
-
-    def self.document_data_to_json(data, out, prevent, depth)
-      prevent += %w(content output next previous excerpt)
-
-      data.map do |key, value|
-        unless prevent.include? key
-          out.push("\"#{key}\": #{SafeJsonifyFilter.to_json(value, depth + 1)}")
-          prevent.push(key)
-        end
-      end
-
-      "{#{out.join(",")}}"
-    end
-
-    def self.legacy_post_to_json(input, depth)
-      prevent = %w(dir name path url date id categories tags)
-
-      out = [
-        "\"dir\": #{SafeJsonifyFilter.to_json(input.dir, depth + 1)}",
-        "\"name\": #{SafeJsonifyFilter.to_json(input.name, depth + 1)}",
-        "\"path\": #{SafeJsonifyFilter.to_json(input.path, depth + 1)}",
-        "\"url\": #{SafeJsonifyFilter.to_json(input.url, depth + 1)}",
-        "\"date\": #{SafeJsonifyFilter.to_json(input.date, depth + 1)}",
-        "\"id\": #{SafeJsonifyFilter.to_json(input.id, depth + 1)}",
-        "\"categories\": #{SafeJsonifyFilter.to_json(input.categories, depth + 1)}",
-        "\"tags\": #{SafeJsonifyFilter.to_json(input.tags, depth + 1)}",
-      ]
-
-      SafeJsonifyFilter.document_data_to_json(input.data, out, prevent, depth)
-    end
-
-    def self.page_to_json(input, depth)
-      prevent = %w(dir name path url)
-
-      out = [
-        "\"dir\": #{SafeJsonifyFilter.to_json(input.dir, depth + 1)}",
-        "\"name\": #{SafeJsonifyFilter.to_json(input.name, depth + 1)}",
-        "\"path\": #{SafeJsonifyFilter.to_json(input.path, depth + 1)}",
-        "\"url\": #{SafeJsonifyFilter.to_json(input.url, depth + 1)}",
-      ]
-
-      # 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")
-      end
-
-      data = Jekyll::Utils.deep_merge_hashes(defaults, input.data)
-      SafeJsonifyFilter.document_data_to_json(data, out, prevent, depth)
-    end
-
-    def self.document_to_json(input, depth)
-      prevent = %w(dir id relative_path url collection)
-
-      out = [
-        "\"path\": #{SafeJsonifyFilter.to_json(input.relative_path, depth + 1)}",
-        "\"relative_path\": #{SafeJsonifyFilter.to_json(input.relative_path, depth + 1)}",
-        "\"url\": #{SafeJsonifyFilter.to_json(input.url, depth + 1)}",
-      ]
-
-      unless input.collection.nil?
-        out.push("\"collection\": #{SafeJsonifyFilter.to_json(input.collection.label, depth + 1)}")
-      end
-
-      # id isn't defined in Jekyll 2.4.0
-      out.push("\"id\": #{SafeJsonifyFilter.to_json(input.id, depth + 1)}") if input.respond_to? :id
-
-      SafeJsonifyFilter.document_data_to_json(input.data, out, prevent, depth)
-    end
-
-    def self.array_to_json(input, depth)
-      array = input.map do |value|
-        SafeJsonifyFilter.to_json(value, depth + 1)
-      end
-
-      "[#{array.join(",")}]"
-    end
-
-    def self.hash_to_json(input, depth)
-      hash = input.map do |key, value|
-        "\"#{key}\": #{SafeJsonifyFilter.to_json(value, depth + 1)}"
-      end
-
-      "{#{hash.join(",")}}"
-    end
-
-    def self.to_json(input, depth)
-      if depth > 8 || (depth > 2 && SafeJsonifyFilter.document_type?(input))
-        '"MAXIMUM_DEPTH"'
-      elsif SafeJsonifyFilter.simple_type?(input)
-        input.to_json
-      elsif input.is_a?(Jekyll::StaticFile)
-        SafeJsonifyFilter.static_file_to_json(input, depth)
-      elsif input.is_a?(Jekyll::Page)
-        SafeJsonifyFilter.page_to_json(input, depth)
-      elsif Jekyll::VERSION.start_with?("2.") && input.is_a?(Jekyll::Post)
-        SafeJsonifyFilter.legacy_post_to_json(input, depth)
-      elsif input.is_a?(Jekyll::Document)
-        SafeJsonifyFilter.document_to_json(input, depth)
-      elsif input.is_a?(Array)
-        SafeJsonifyFilter.array_to_json(input, depth)
-      elsif input.is_a?(Hash)
-        SafeJsonifyFilter.hash_to_json(input, depth)
-      else
-        "\"UNSUPPORTED:#{input.class}\""
-      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(SafeJsonifyFilter.to_json(page, 1))
-      end
-
-      "[#{out.join(",")}]"
-    end
-
-    def cc_safe_jsonify(input)
-      SafeJsonifyFilter.to_json(input, 0)
-    end
-  end
-end