cloudcannon-jekyll 0.0.8 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820899b808d590cf65c42865d41fedce52857e4d2b5e3937152954abdb610a6d
-  data.tar.gz: 1be3d23935705c3d4a1f645fe7956caf5a241f4febb28bd6dfe27815c899fd2d
+  metadata.gz: 83d8c10e1f93435eb7f8cf67d63b3cf94c35ca24a4f6b02de64c11925f829213
+  data.tar.gz: 178b75ec1c4984773ef897967e7973997811806237deefeca61dc906ab7a1bc2
 SHA512:
-  metadata.gz: ad2f91e08bff7a4e359436acfe5c77112e3f4730df9fbe956ad9aaa19771151b90eb4857fb3b87149ec8fa277060405e458120b3f3043bbca2523cbaf417c7e1
-  data.tar.gz: a4f2a57a65d13ca88afd8d09b4bed5fb9125719adce949f4de25435d036f7cf8920cfd6017c83814d8d83537b0e9678db16a5605d07d51d68b6d5516b40a07a9
+  metadata.gz: d38402f61598857b9b6dba32c67d1ca44dd575dd93591a4944af0bd52bc5fb322cb5b2c9013c534a6031bed72d17583288f699bfb92c1853182b1bf4152c48be
+  data.tar.gz: 6a79c497b8718283e72d65a8b415d77808470777df547701a30f1f564fb5d5b73e20e5ba7be17868b542ab79cc16791f3cfd556e6fa20d5dde75031d52b62e66

data/.github/workflows/stale.yml

@@ -0,0 +1,19 @@
+name: Mark stale issues
+
+on:
+  schedule:
+  - cron: "30 1 * * *"
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/stale@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days'
+        stale-issue-label: 'no-issue-activity'
+        days-before-stale: 30
+        days-before-close: 5

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/.reek.yml

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

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,30 @@ 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
+    - lib/cloudcannon-jekyll/readers/old-data-reader.rb # TODO remove this and fix warnings
+
+Metrics/PerceivedComplexity:
+  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
+
+# This is excluded since the ruby target is 2.3.8 which doesn't support String.match?(Regexp)
+Performance/RegexpMatch:
+  Exclude:
+    - lib/cloudcannon-jekyll/generator.rb
+
+# This is excluded since Jekyll used this and we need to check for it
+Lint/UnifiedInteger:
+  Exclude:
+    - lib/cloudcannon-jekyll/jsonify-filter.rb

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.6
+  - 2.3.8
 
 before_install:
   - gem update --system
@@ -15,3 +15,4 @@ env:
   matrix:
     - JEKYLL_VERSION="2.4.0"
     - JEKYLL_VERSION="3.0.0"
+    - JEKYLL_VERSION="3.2.1"

data/Gemfile

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

data/HISTORY.md

@@ -1,3 +1,48 @@
+# 0.3.1
+
+* Fix for empty collection configurations
+
+# 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
+* Added `_path` field to each collection definition in config
+* Removed some unused fields
+* 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
+
+* Added JSON handling for integers in hash keys
+* Fix typo for collections key in older Jekyll versions
+* Change date format to ISO8601
+* Validate against new version of config schema
+
+# 0.2.1
+
+* Add gem information and time to output config file
+* Fix missing in-place compact
+* Fix source being output as full path on disk
+* Read content for output config file directly from site config
+
+# 0.2.0
+
+* Add defaults and input-options keys to config output
+* Add more ignore keys for legacy select data filter
+* Reduce methods added from other plugins clashing
+* Fix invalid output when unsupported class found
+
+# 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

@@ -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"
@@ -21,8 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "jekyll", ">= 2.4.0", "< 4"
 
+  spec.add_development_dependency "json_schemer", "~> 0.2.4"
   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,14 +5,14 @@ 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"
+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

@@ -0,0 +1,36 @@
+{
+	"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 %}
+	"collections": {{ collections | cc_jsonify: 'collections' }},
+	{% 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 }},
+		"pages": "",
+		"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: 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

@@ -0,0 +1,36 @@
+{
+	"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 %}
+	"collections": {{ collections | cc_jsonify: 'collections' }},
+	{% 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 }},
+		"pages": "",
+		"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: 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

@@ -0,0 +1,57 @@
+{
+	"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 %}
+	"collections": {{ collections | cc_jsonify: 'collections' }},
+	{% 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 }},
+		"pages": "",
+		"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: 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/details-2.x.json

@@ -1,25 +1,28 @@
 {
-	"time": {{ site.time | jsonify }},
+	"time": {{ site.time | date_to_xmlschema | 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 %}
+		"drafts": {{ drafts | cc_jsonify }},
+		"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 }},
-	"static": {{ site.static_files | cc_static_files_jsonify }}
+	"pages": {{ site.pages | cc_jsonify }},
+	"static-pages": {{ site.static_files | cc_static_files_jsonify }}
 }

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

@@ -0,0 +1,27 @@
+{
+	"time": {{ site.time | date_to_xmlschema | 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": {
+		"drafts": {{ drafts | cc_jsonify }}{% if site.collections.size > 0 %},{% endif %}
+		{% for collection in site.collections %}"{{ collection.label | xml_escape }}": {{ collection.docs | cc_jsonify }}{% unless forloop.last %},{% endunless %}
+		{% endfor %}
+	},
+	"pages": {{ site.pages | cc_jsonify }},
+	"static-pages": {{ site.static_files | cc_static_files_jsonify }}
+}

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

@@ -1,28 +1,41 @@
 {
-	"time": {{ site.time | jsonify }},
+	"time": {{ site.time | date_to_xmlschema | 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 }}
+		"drafts": {{ drafts | cc_jsonify }}{% if site.collections.size > 0 %},{% endif %}
+		{%- 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 }},
-	"static": {{ site.static_files | cc_static_files_jsonify }}
+	"pages": {{ site.pages | cc_jsonify }},
+	"static-pages": {{ site.static_files | cc_static_files_jsonify }}
 }