cloudcannon-jekyll 0.3.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29ba7626e36d9eda34cdc67fe54a1961c7fc8ea6af3b61d2bfe8e9f7074483c8
-  data.tar.gz: 82ea5cfc99366153d6464125652c200ccf0971fca780cf9d5cfbbe5bb70fd9c2
+  metadata.gz: acbff58768a2a1c6d143ed8c0fe84cc1e3a6dc147e449fa91b69d24ea85655b8
+  data.tar.gz: 778145a334b54d304ff601c3547c397a6955b9edf7fa73e393565aa7a0a1d46b
 SHA512:
-  metadata.gz: 958d22f6c30642a9ef324aba1938768a8b7337b948f33780f2545a310c12e9535328a52367fa888d267a18b6572d07ef1d7387fdab9956211830c448946b52c2
-  data.tar.gz: 6c2dee57baf7d6fac11898094e3292c89559ac4d5077b898efdc65c1901df351101d37ef240de02eebd2db2dc2adfc9bd288ca232d7f9b3bd4f9ba8aeb36b177
+  metadata.gz: dfd7cd98ba79c5b49e312f75f3ade2a844565f78e8a45d75e52d1776bbbf1c34b13aa9bac5de6a2b20314d2538fe80a261e2154dab4eeaf27187f639984e7700
+  data.tar.gz: cf9f07c980a416af440a2ba1b7f6ae20a420b8fe758752d736ad88878bf516bd8adb3bf7141725abfd100ff2c08cfc030db2f3d2753e3fff5416f9a8c7b95cd0

data/.gitignore

@@ -1,7 +1,6 @@
 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.4
+  TargetRubyVersion: 2.6
   Include:
     - lib/**/*.rb
 
@@ -20,30 +20,8 @@ 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.3.8
+  - 2.6
 
 before_install:
   - gem update --system
@@ -15,4 +15,5 @@ env:
   matrix:
     - JEKYLL_VERSION="2.4.0"
     - JEKYLL_VERSION="3.0.0"
-    - JEKYLL_VERSION="3.2.1"
+    - JEKYLL_VERSION="3.8.5"
+    - JEKYLL_VERSION="4.0.0"

data/Gemfile

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

data/HISTORY.md

@@ -1,74 +1,7 @@
-# 0.3.4
+# 1.0.0
 
-* Re-add id field for documents
-* Fix for potential nil reference
-
-# 0.3.3
-
-* Rework fallback for older versions of Jekyll when reading data, posts and drafts again
-
-# 0.3.2
-
-* Rework fallback for older versions of Jekyll when reading data, posts and drafts
-* Fix deprecation warning for `posts.map`
-
-# 0.3.1
-
-* Fix for empty collection configurations
-* Added max depth parameter for jsonify filter and increase it for array structures in config output
-
-# 0.3.0
-
-* Add empty paths.pages
-* Added drafts to collections in details
-* Added drafts and data to collections in config
-* Added category folder drafts and posts to collections in config
-* 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
-
-# 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
-
-# 0.0.7
-
-* Fix invalid JSON issue for sites built with Jekyll 2 and no collections
-
-# 0.0.6
-
-* Fixed unsupported Fixnum for Ruby 2.3
-* Fixed reference to unsupported String::match? for Ruby 2.3
+* Initial release
+* Dropped support for ruby 2.3
 
 # 0.0.5
 

data/cloudcannon-jekyll.gemspec

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
+# coding: utf-8
 
-lib = File.expand_path("lib", __dir__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "cloudcannon-jekyll/version"
@@ -19,11 +19,10 @@ Gem::Specification.new do |spec|
   all_files          = `git ls-files -z`.split("\x0")
   spec.files         = all_files.reject { |f| f.match(%r!^(test|spec|features)/!) }
 
-  spec.add_dependency "jekyll", ">= 2.4.0", "< 4"
+  spec.add_dependency "jekyll", ">= 2.4.0", "< 5"
 
-  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.80"
-  spec.add_development_dependency "rubocop-jekyll", "~> 0.11"
+  spec.add_development_dependency "rubocop", "~> 0.71"
+  spec.add_development_dependency "rubocop-jekyll", "~> 0.10"
 end

data/lib/cloudcannon-jekyll.rb

@@ -2,17 +2,19 @@
 
 require "jekyll"
 
-require_relative "cloudcannon-jekyll/page-without-a-file"
-require_relative "cloudcannon-jekyll/generator"
-require_relative "cloudcannon-jekyll/configuration"
-require_relative "cloudcannon-jekyll/jsonify-filter"
-require_relative "cloudcannon-jekyll/version"
+module CloudCannonJekyll
+  autoload :PageWithoutAFile,  "cloudcannon-jekyll/page-without-a-file"
+  autoload :Generator,         "cloudcannon-jekyll/generator"
+  autoload :Configuration,     "cloudcannon-jekyll/configuration"
+  autoload :SafeJsonifyFilter, "cloudcannon-jekyll/safe-jsonify-filter"
+  autoload :VERSION,           "cloudcannon-jekyll/version"
+end
 
-Liquid::Template.register_filter(CloudCannonJekyll::JsonifyFilter)
+Liquid::Template.register_filter(CloudCannonJekyll::SafeJsonifyFilter)
 
-if Jekyll::VERSION.start_with? "2."
+# 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/details-2.x.json

@@ -1,28 +1,25 @@
 {
-	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
+	"time": {{ site.time | jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
-		"version": {{ gem_version | cc_jsonify }}
+		"version": {{ gem_version | jsonify }}
 	},
 	"generator": {
 		"name": "jekyll",
-		"version": {{ jekyll.version | cc_jsonify }},
-		"environment": {{ jekyll.env | cc_jsonify }},
+		"version": {{ jekyll.version | jsonify }},
+		"environment": {{ jekyll.env | jsonify }},
 		"metadata": {
-			"markdown": {{ site.markdown | cc_jsonify }},
-			"kramdown": {{ site.kramdown | cc_jsonify }},
-			"commonmark": {{ site.commonmark | cc_jsonify }}
+			"markdown": {{ site.markdown | cc_safe_jsonify }},
+			"kramdown": {{ site.kramdown | cc_safe_jsonify }},
+			"commonmark": {{ site.commonmark | cc_safe_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 %}
+	},{% if site.cloudcannon.data %}
+	"data": {{ site.data | cc_safe_jsonify }},{% endif %}
 	"collections": {
-		"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 %}
+		"posts": {{ site.posts | reverse | cc_safe_jsonify }},
+		{% for collection in site.collections %}"{{ collection[0] | xml_escape }}": {{ collection[1].docs | cc_safe_jsonify }}{% unless forloop.last %},{% endunless %}
 		{% endfor %}
 	},
-	"pages": {{ site.pages | cc_jsonify }},
-	"static-pages": {{ site.static_files | cc_static_files_jsonify }}
+	"pages": {{ site.pages | cc_safe_jsonify }},
+	"static": {{ site.static_files | cc_static_files_jsonify }}
 }

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

@@ -0,0 +1,24 @@
+{
+	"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/_cloudcannon/details.json

@@ -1,41 +1,28 @@
 {
-	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
+	"time": {{ site.time | jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
-		"version": {{ gem_version | cc_jsonify }}
+		"version": {{ gem_version | jsonify }}
 	},
 	"generator": {
 		"name": "jekyll",
-		"version": {{ jekyll.version | cc_jsonify }},
-		"environment": {{ jekyll.env | cc_jsonify }},
+		"version": {{ jekyll.version | jsonify }},
+		"environment": {{ jekyll.env | jsonify }},
 		"metadata": {
-			"markdown": {{ site.markdown | cc_jsonify }},
-			"kramdown": {{ site.kramdown | cc_jsonify }},
-			"commonmark": {{ site.commonmark | cc_jsonify }}
+			"markdown": {{ site.markdown | cc_safe_jsonify }},
+			"kramdown": {{ site.kramdown | cc_safe_jsonify }},
+			"commonmark": {{ site.commonmark | cc_safe_jsonify }}
 		}
 	},
-	{% 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 %}
+	{%- if site.cloudcannon.data %}
+		"data": {{ site.data | cc_safe_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 }}
+		{% for collection in site.collections -%}
+			"{{ collection.label | xml_escape }}": {{ collection.docs | cc_safe_jsonify }}
 			{%- unless forloop.last %},{% endunless %}
-		{%- endfor -%}
+		{%- endfor %}
 	},
-	"pages": {{ site.pages | cc_jsonify }},
-	"static-pages": {{ site.static_files | cc_static_files_jsonify }}
+	"pages": {{ site.pages | cc_safe_jsonify }},
+	"static": {{ site.static_files | cc_static_files_jsonify }}
 }

data/lib/cloudcannon-jekyll/configuration.rb

@@ -1,7 +1,6 @@
 # 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
@@ -17,7 +16,7 @@ module CloudCannonJekyll
       config = config.fix_common_issues if config.respond_to? :fix_common_issues
       config = config.add_default_excludes if config.respond_to? :add_default_excludes
 
-      key = Jekyll::VERSION.start_with?("2.") ? "gems" : "plugins"
+      key = Jekyll::VERSION.start_with?("2") ? "gems" : "plugins"
 
       config[key] = Array(config[key])
       config[key].push("cloudcannon-jekyll") unless config[key].include? "cloudcannon-jekyll"

data/lib/cloudcannon-jekyll/generator.rb

@@ -2,157 +2,41 @@
 
 require "jekyll"
 require "fileutils"
-require_relative "reader"
 
 module CloudCannonJekyll
-  # Generates JSON files containing build config and build output details
   class Generator < Jekyll::Generator
     priority :lowest
 
     def generate(site)
       @site = site
-      @reader = Reader.new(@site)
-
-      collections_config = @site.config["collections"]&.dup || {}
-
-      # Workaround for empty collection configurations
-      collections_config.each_key do |key|
-        collections_config[key] ||= { "output" => false }
-      end
-
-      payload = @site.site_payload.merge({
-        "gem_version" => CloudCannonJekyll::VERSION,
-      })
-
-      drafts = add_blogging_config(collections_config)
-      add_collection_paths(collections_config)
-      add_data_config(collections_config)
-
-      generate_file("config", payload.merge({
-        "pwd"         => Dir.pwd,
-        "config"      => @site.config,
-        "collections" => collections_config,
-      }))
-
-      generate_file("details", payload.merge({
-        "drafts" => drafts,
-      }))
-    end
-
-    def collections_dir
-      return "" if Jekyll::VERSION.start_with? "2."
-
-      @site.config["collections_dir"] || ""
-    end
-
-    def data_dir
-      @site.config["data_dir"] || "_data"
-    end
-
-    # rubocop:disable Metrics/AbcSize
-    def add_category_folder_config(collections_config, posts_config = {})
-      posts = @site.posts || @site.collections["posts"]
-      docs = posts.class.method_defined?(:docs) ? posts.docs : posts
-      seen = {}
-
-      docs.map do |post|
-        parts = post.relative_path.split("/_posts/")
-        path = parts.first
-
-        # Ignore unless it's an unseen category folder post
-        next if parts.length < 2 || path.empty? || seen[path]
-
-        # Could check this to ensure raw files exist since posts can be generated without files
-        # next if @reader.read_posts(parts[0]).empty?
-
-        seen[path] = true
-        folder = path.sub(%r!^\/+!, "")
-        collections_path = "#{collections_dir}/#{folder}".gsub(%r!\/+!, "/").sub(%r!^\/+!, "")
-
-        collections_config["#{folder}/posts"] = posts_config.merge({
-          "_path" => "#{collections_path}/_posts",
-        })
-
-        # Adding the category draft config like this isn't ideal, since you could have drafts
-        #  without posts, but it's a decent trade off vs looking for _drafts folders
-        collections_config["#{folder}/drafts"] = posts_config.merge({
-          "_path" => "#{collections_path}/_drafts",
-        })
-
-        path
-      end
-    end
-    # rubocop:enable Metrics/AbcSize
-
-    # Add data to collections config if raw data files exist
-    def add_data_config(collections_config)
-      data_files = @reader.read_data(data_dir)
-      collections_config["data"] = { "_path" => data_dir } if data_files&.keys&.any?
-    end
-
-    # Add posts/drafts to collections config
-    def add_blogging_config(collections_config)
-      collections_config["posts"] = { "output" => true } if Jekyll::VERSION.start_with? "2."
-      drafts = @reader.read_drafts(collections_dir)
-
-      if collections_config.key?("posts")
-        collections_config["drafts"] = collections_config["posts"]&.dup || {}
-      elsif drafts.any?
-        collections_config["drafts"] = {}
-      end
-
-      folders = add_category_folder_config(collections_config, collections_config["posts"])
-      folders.compact.each do |folder|
-        drafts += @reader.read_drafts(folder)
-      end
-
-      drafts
-    end
-
-    # Add _path to each collection config
-    def add_collection_paths(collections_config)
-      collections_config.each do |key, collection|
-        next if collection.key?("_path")
-
-        collection["_path"] = File.join(collections_dir, "_#{key}").sub(%r!^\/+!, "")
-      end
-    end
-
-    def generate_file(filename, data)
-      dest = destination_path(filename)
-      FileUtils.mkdir_p(File.dirname(dest))
-      File.open(dest, "w") { |file| file.write(file_content(filename, data)) }
+      FileUtils.mkdir_p(File.dirname(destination_path))
+      File.open(destination_path, "w") { |f| f.write(file_content) }
       @site.keep_files ||= []
-      @site.keep_files << path(filename)
+      @site.keep_files << "_cloudcannon/details.json"
     end
 
-    def version_path_suffix
-      return "-2.x" if Jekyll::VERSION.start_with? "2."
-      return "-3.0-4.x" if %r!3\.[0-4]\.! =~ Jekyll::VERSION
+    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]\.!
 
-      ""
+      File.expand_path(path, File.dirname(__FILE__))
     end
 
-    def path(filename, suffix = "")
-      "_cloudcannon/#{filename}#{suffix}.json"
+    def destination_path
+      Jekyll.sanitized_path(@site.dest, "_cloudcannon/details.json")
     end
 
-    def source_path(filename)
-      File.expand_path(path(filename, version_path_suffix), File.dirname(__FILE__))
-    end
+    def file_content
+      json = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", "_cloudcannon/details.json")
+      json.content = File.read(source_path)
 
-    def destination_path(filename)
-      Jekyll.sanitized_path(@site.dest, path(filename))
-    end
+      json.data["layout"] = nil
+      json.data["sitemap"] = false
+      json.data["permalink"] = "/_cloudcannon/details.json"
 
-    def file_content(filename, data)
-      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
+      json.render({}, @site.site_payload.merge("gem_version" => CloudCannonJekyll::VERSION))
+      json.output
     end
   end
 end