cloudcannon-jekyll 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820899b808d590cf65c42865d41fedce52857e4d2b5e3937152954abdb610a6d
-  data.tar.gz: 1be3d23935705c3d4a1f645fe7956caf5a241f4febb28bd6dfe27815c899fd2d
+  metadata.gz: 9af7a56d0f7ae1c2fbf46678eef968a8ea4d906a88394b2704093b8d6a375017
+  data.tar.gz: ed492b3cc15a707238dc083be5063c20f7e9c6664fb545f8e4fc7bed54c90b05
 SHA512:
-  metadata.gz: ad2f91e08bff7a4e359436acfe5c77112e3f4730df9fbe956ad9aaa19771151b90eb4857fb3b87149ec8fa277060405e458120b3f3043bbca2523cbaf417c7e1
-  data.tar.gz: a4f2a57a65d13ca88afd8d09b4bed5fb9125719adce949f4de25435d036f7cf8920cfd6017c83814d8d83537b0e9678db16a5605d07d51d68b6d5516b40a07a9
+  metadata.gz: a38d6d1a314062fe832fed516f188da8d0a299f0e8a41e3701b1cf1166d50b88a5ef34a1828eec093993803be5c8ac21937da77b876d6f0840610e28ac7593fd
+  data.tar.gz: b49cec3b53386c5422cffc485d610d386c0cb692078890abf1b030f764afc55b3329d5ebe53c28815a73d5b2e55bcb7127d02945cb16d230e03ef7cdefc5e031

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/HISTORY.md

@@ -1,3 +1,10 @@
+# 0.1.0
+
+* Add output config file
+* Add support for including only specified `data` keys
+* Fix invalid JSON issue for sites built with Jekyll 2 and no collections
+* Change module load style for easier dropping into _plugins
+
 # 0.0.8
 
 * Removed unsupported Jekyll test targets

data/cloudcannon-jekyll.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
 
   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"
+  spec.add_development_dependency "json_schemer", "~> 0.2.13"
 end

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

@@ -0,0 +1,43 @@
+{
+	{% if site.timezone %}"timezone": {{ site.timezone | jsonify }},{% endif %}
+	"include": {{ site.include | jsonify }},
+	"exclude": {{ site.exclude | jsonify }},
+	{% if site.baseurl %}"base-url": {{ site.baseurl | jsonify }},{% endif %}
+	"collections": {
+		{% for collection in site.collections %}
+		"{{ collection[0] | xml_escape }}": {
+			"output": {{ collection[1].output | jsonify }},
+			"_sort-key": {{ collection[1]._sort_key | jsonify }},
+			"_subtext-key": {{ collection[1]._subtext_key | jsonify }},
+			"_image-key": {{ collection[1]._image_key | jsonify }},
+			"_image-size": {{ collection[1]._image_size | jsonify }},
+			"_singular-name": {{ collection[1]._singular_name | jsonify }},
+			"_singular-key": {{ collection[1]._singular_key | jsonify }},
+			"_disable-add": {{ collection[1]._disable_add | jsonify }},
+			"_icon": {{ collection[1]._icon | jsonify }},
+			"_add-options": {{ collection[1]._add_options | cc_safe_jsonify }}
+		}{% unless forloop.last %},{% endunless %}
+		{% endfor %}
+	},
+	{% if site._comments %}"comments": {{ site._comments | cc_safe_jsonify }},{% endif %}
+	{% if site._editor %}"editor": {
+		"default-path": {{ site._editor.default_path | jsonify }}
+	},{% endif %}
+	{% if site._source_editor %}"source-editor": {
+		"tab-size": {{ site._source_editor.tab_size | jsonify }},
+		"show-gutter": {{ site._source_editor.show_gutter | jsonify }},
+		"theme": {{ site._source_editor.theme | jsonify }}
+	},{% endif %}
+	{% if site._explore %}"explore": {{ site._explore | cc_safe_jsonify }},{% endif %}
+	"paths": {
+		"uploads": {{ site.uploads_dir | jsonify }},
+		"plugins": {{ site.plugins_dir | jsonify }},
+		"data": {{ site.data_dir | jsonify }},
+		"collections": {{ site.collections_dir | jsonify }},
+		"includes": {{ site.includes_dir | jsonify }},
+		"layouts": {{ site.layouts_dir | jsonify }}
+	},
+	{% if site._array_structures %}"array-structures": {{ site._array_structures | cc_safe_jsonify }},{% endif %}
+	{% assign select_data = site | cc_site_select_data_jsonify %}{% if select_data %}"select-data": {{ select_data }},{% endif %}
+	"source": {{ site.source | jsonify }}
+}

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

@@ -0,0 +1,43 @@
+{
+	{% if site.timezone %}"timezone": {{ site.timezone | jsonify }},{% endif %}
+	"include": {{ site.include | jsonify }},
+	"exclude": {{ site.exclude | jsonify }},
+	{% if site.baseurl %}"base-url": {{ site.baseurl | jsonify }},{% endif %}
+	"collections": {
+		{% for collection in site.collections %}
+		"{{ collection.label | xml_escape }}": {
+			"output": {{ collection.output | jsonify }},
+			"_sort-key": {{ collection._sort_key | jsonify }},
+			"_subtext-key": {{ collection._subtext_key | jsonify }},
+			"_image-key": {{ collection._image_key | jsonify }},
+			"_image-size": {{ collection._image_size | jsonify }},
+			"_singular-name": {{ collection._singular_name | jsonify }},
+			"_singular-key": {{ collection._singular_key | jsonify }},
+			"_disable-add": {{ collection._disable_add | jsonify }},
+			"_icon": {{ collection._icon | jsonify }},
+			"_add-options": {{ collection._add_options | cc_safe_jsonify }}
+		}{% unless forloop.last %},{% endunless %}
+		{% endfor %}
+	},
+	{% if site._comments %}"comments": {{ site._comments | cc_safe_jsonify }},{% endif %}
+	{% if site._editor %}"editor": {
+		"default-path": {{ site._editor.default_path | jsonify }}
+	},{% endif %}
+	{% if site._source_editor %}"source-editor": {
+		"tab-size": {{ site._source_editor.tab_size | jsonify }},
+		"show-gutter": {{ site._source_editor.show_gutter | jsonify }},
+		"theme": {{ site._source_editor.theme | jsonify }}
+	},{% endif %}
+	{% if site._explore %}"explore": {{ site._explore | cc_safe_jsonify }},{% endif %}
+	"paths": {
+		"uploads": {{ site.uploads_dir | jsonify }},
+		"plugins": {{ site.plugins_dir | jsonify }},
+		"data": {{ site.data_dir | jsonify }},
+		"collections": {{ site.collections_dir | jsonify }},
+		"includes": {{ site.includes_dir | jsonify }},
+		"layouts": {{ site.layouts_dir | jsonify }}
+	},
+	{% if site._array_structures %}"array-structures": {{ site._array_structures | cc_safe_jsonify }},{% endif %}
+	{% assign select_data = site | cc_site_select_data_jsonify %}{% if select_data %}"select-data": {{ select_data }},{% endif %}
+	"source": {{ site.source | jsonify }}
+}

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

@@ -0,0 +1,61 @@
+{
+	{% if site.timezone -%}
+		"timezone": {{ site.timezone | jsonify }},
+	{%- endif %}
+	"include": {{ site.include | jsonify }},
+	"exclude": {{ site.exclude | jsonify }},
+	{% if site.baseurl -%}
+		"base-url": {{ site.baseurl | jsonify }},
+	{%- endif %}
+	"collections": {
+		{%- for collection in site.collections -%}
+			"{{ collection.label | xml_escape }}": {
+				"output": {{ collection.output | jsonify }},
+				"_sort-key": {{ collection._sort_key | jsonify }},
+				"_subtext-key": {{ collection._subtext_key | jsonify }},
+				"_image-key": {{ collection._image_key | jsonify }},
+				"_image-size": {{ collection._image_size | jsonify }},
+				"_singular-name": {{ collection._singular_name | jsonify }},
+				"_singular-key": {{ collection._singular_key | jsonify }},
+				"_disable-add": {{ collection._disable_add | jsonify }},
+				"_icon": {{ collection._icon | jsonify }},
+				"_add-options": {{ collection._add_options | cc_safe_jsonify }}
+			}
+			{%- unless forloop.last %},{% endunless %}
+		{%- endfor -%}
+	},
+	{% if site._comments -%}
+		"comments": {{ site._comments | cc_safe_jsonify }},
+	{%- endif %}
+	{% if site._editor -%}
+		"editor": {
+			"default-path": {{ site._editor.default_path | jsonify }}
+		},
+	{%- endif %}
+	{% if site._source_editor -%}
+		"source-editor": {
+			"tab-size": {{ site._source_editor.tab_size | jsonify }},
+			"show-gutter": {{ site._source_editor.show_gutter | jsonify }},
+			"theme": {{ site._source_editor.theme | jsonify }}
+		},
+	{%- endif %}
+	{% if site._explore -%}
+		"explore": {{ site._explore | cc_safe_jsonify }},
+	{%- endif %}
+	"paths": {
+		"uploads": {{ site.uploads_dir | jsonify }},
+		"plugins": {{ site.plugins_dir | jsonify }},
+		"data": {{ site.data_dir | jsonify }},
+		"collections": {{ site.collections_dir | jsonify }},
+		"includes": {{ site.includes_dir | jsonify }},
+		"layouts": {{ site.layouts_dir | jsonify }}
+	},
+	{% if site._array_structures -%}
+		"array-structures": {{ site._array_structures | cc_safe_jsonify }},
+	{%- endif %}
+	{% assign select_data = site | cc_site_select_data_jsonify -%}
+	{% if select_data -%}
+		"select-data": {{ select_data }},
+	{%- endif %}
+	"source": {{ site.source | jsonify }}
+}

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

@@ -13,8 +13,10 @@
 			"kramdown": {{ site.kramdown | cc_safe_jsonify }},
 			"commonmark": {{ site.commonmark | cc_safe_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_safe_jsonify }}: {{ data[1] | cc_safe_jsonify }}{% assign data_seen = true %}{% endif %}{% endfor %}},
+	{% elsif site.cloudcannon.data %}"data": {{ site.data | cc_safe_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 %}

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

@@ -13,8 +13,10 @@
 			"kramdown": {{ site.kramdown | cc_safe_jsonify }},
 			"commonmark": {{ site.commonmark | cc_safe_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_safe_jsonify }}: {{ data[1] | cc_safe_jsonify }}{% assign data_seen = true %}{% endif %}{% endfor %}},
+	{% elsif 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 %}

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

@@ -14,14 +14,26 @@
 			"commonmark": {{ site.commonmark | cc_safe_jsonify }}
 		}
 	},
-	{%- if site.cloudcannon.data %}
+	{% 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_safe_jsonify }}: {{ data[1] | cc_safe_jsonify }}
+					{%- assign data_seen = true %}
+				{%- endif %}
+			{%- endfor -%}
+		},
+	{% elsif site.cloudcannon.data -%}
 		"data": {{ site.data | cc_safe_jsonify }},
-	{% endif %}
+	{%- endif %}
 	"collections": {
-		{% for collection in site.collections -%}
+		{%- for collection in site.collections -%}
 			"{{ collection.label | xml_escape }}": {{ collection.docs | cc_safe_jsonify }}
 			{%- unless forloop.last %},{% endunless %}
-		{%- endfor %}
+		{%- endfor -%}
 	},
 	"pages": {{ site.pages | cc_safe_jsonify }},
 	"static": {{ site.static_files | cc_static_files_jsonify }}

data/lib/cloudcannon-jekyll/generator.rb

@@ -9,33 +9,49 @@ module CloudCannonJekyll
 
     def generate(site)
       @site = site
-      FileUtils.mkdir_p(File.dirname(destination_path))
-      File.open(destination_path, "w") { |f| f.write(file_content) }
+
+      details_data = { "gem_version" => CloudCannonJekyll::VERSION }
+
+      generate_file("details", @site.site_payload.merge(details_data))
+      generate_file("config", @site.site_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" unless (%r!3\.[0-4]\.! =~ Jekyll::VERSION).nil?
+    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/safe-jsonify-filter.rb

@@ -46,12 +46,11 @@ module CloudCannonJekyll
     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
+      data.each { |key, value|
+        next if prevent.include? key
+        prevent.push key
+        out.push("#{key.to_json}: #{SafeJsonifyFilter.to_json(value, depth + 1)}")
+      }
 
       "{#{out.join(",")}}"
     end
@@ -121,12 +120,45 @@ module CloudCannonJekyll
 
     def self.hash_to_json(input, depth)
       hash = input.map do |key, value|
-        "\"#{key}\": #{SafeJsonifyFilter.to_json(value, depth + 1)}"
+        "#{key.to_json}: #{SafeJsonifyFilter.to_json(value, depth + 1)}"
       end
 
       "{#{hash.join(",")}}"
     end
 
+    def self.site_drop_legacy_select_data_to_json(input, depth)
+      prevent = %w(config time related_posts destination cache_dir safe
+        keep_files encoding markdown_ext strict_front_matter show_drafts
+        limit_posts future unpublished whitelist maruku markdown highlighter
+        lsi excerpt_separator incremental detach port host show_dir_listing
+        permalink paginate_path quiet verbose defaults liquid kramdown title
+        url description categories data tags static_files html_pages pages
+        documents posts related_posts time source timezone include exclude
+        baseurl collections _comments _editor _source_editor _explore
+        uploads_dir plugins_dir data_dir collections_dir includes_dir
+        layouts_dir _array_structures cloudcannon rdiscount redcarpet redcloth)
+
+      if Jekyll::VERSION.start_with?("2.")
+        prevent = prevent.concat input["collections"].keys
+        prevent.push "gems"
+      elsif Jekyll::VERSION.match?(%r!3\.[0-4]\.!)
+        prevent = prevent.concat input["collections"].map { |c| c["label"] }
+        prevent = prevent.concat %w(plugins gems)
+      else
+        prevent.push "plugins"
+      end
+
+      out = input.map { |key, value|
+        next unless value.is_a?(Array) || value.is_a?(Hash)
+        next if prevent.include? key
+        prevent.push key
+
+        "#{key.to_json}: #{SafeJsonifyFilter.to_json(value, depth + 1)}"
+      }.compact
+
+      "{#{out.join(",")}}" if out.any?
+    end
+
     def self.to_json(input, depth)
       if depth > 8 || (depth > 2 && SafeJsonifyFilter.document_type?(input))
         '"MAXIMUM_DEPTH"'
@@ -145,7 +177,7 @@ module CloudCannonJekyll
       elsif input.is_a?(Hash)
         SafeJsonifyFilter.hash_to_json(input, depth)
       else
-        "\"UNSUPPORTED:#{input.class}\""
+        "\"UNSUPPORTED:#{input.class.to_json}\""
       end
     end
 
@@ -163,6 +195,14 @@ module CloudCannonJekyll
       "[#{out.join(",")}]"
     end
 
+    def cc_site_select_data_jsonify(input)
+      if input.key? "_select_data"
+        SafeJsonifyFilter.to_json(input["_select_data"], 0)
+      else
+        SafeJsonifyFilter.site_drop_legacy_select_data_to_json(input, 0)
+      end
+    end
+
     def cc_safe_jsonify(input)
       SafeJsonifyFilter.to_json(input, 0)
     end

data/lib/cloudcannon-jekyll/version.rb

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

data/script/release

@@ -33,5 +33,7 @@ git fetch -t origin
 
 # Push tag and upload new gem
 
-gem push cloudcannon-jekyll-*.gem && git tag "$tag" &&
-	git push origin master && git push origin "$tag"
+git tag "$tag" &&
+	git push origin master &&
+	git push origin "$tag" &&
+	gem push cloudcannon-jekyll-*.gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - CloudCannon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -64,28 +64,42 @@ 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'
+- !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
 description: Creates CloudCannon editor details for Jekyll
 email:
 - support@cloudcannon.com
@@ -104,8 +118,11 @@ 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
@@ -119,7 +136,7 @@ homepage: https://github.com/cloudcannon/cloudcannon-jekyll
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,9 +151,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: CloudCannon Jekyll integration
 test_files: []