cloudcannon-jekyll 0.2.1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ae3c8abe082ec3f37215dec374610ec9afdbcfdf657088948285375e847410f
-  data.tar.gz: 44974881ddba3a62062337da11a56d1fbdd406fa04cead477b216866d88bf5cc
+  metadata.gz: 29ba7626e36d9eda34cdc67fe54a1961c7fc8ea6af3b61d2bfe8e9f7074483c8
+  data.tar.gz: 82ea5cfc99366153d6464125652c200ccf0971fca780cf9d5cfbbe5bb70fd9c2
 SHA512:
-  metadata.gz: 8d894aea066bba58238ac0a2dbcc277eee56c84d3aeddea107089db51717266f313001d187ac6f5bf077f3f46c044b5842e3e02afa96a0d38fcc8f967889a1c2
-  data.tar.gz: f51833d3e91c35ca0e2fa0020b4844a0727c969bf026d01f83922c384ec5b4a0bc68afa11032434a8947281664daf0f5b89f44066d4fb0b76969e8a056486923
+  metadata.gz: 958d22f6c30642a9ef324aba1938768a8b7337b948f33780f2545a310c12e9535328a52367fa888d267a18b6572d07ef1d7387fdab9956211830c448946b52c2
+  data.tar.gz: 6c2dee57baf7d6fac11898094e3292c89559ac4d5077b898efdc65c1901df351101d37ef240de02eebd2db2dc2adfc9bd288ca232d7f9b3bd4f9ba8aeb36b177

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

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

data/.rubocop.yml

@@ -28,15 +28,12 @@ Naming/MemoizedInstanceVariableName:
 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/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/HISTORY.md

@@ -1,3 +1,41 @@
+# 0.3.4
+
+* 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

data/lib/cloudcannon-jekyll.rb

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

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

@@ -1,5 +1,5 @@
 {
-	"time": {{ site.time | cc_jsonify }},
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
 		"version": {{ gem_version | cc_jsonify }}
@@ -8,7 +8,7 @@
 	"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 %}
+	"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 %}
@@ -25,11 +25,12 @@
 		"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 }},{% endif %}
+	{% if config._array_structures %}"array-structures": {{ config._array_structures | cc_jsonify: nil, 20 }},{% endif %}
 	{% assign select_data = config | cc_select_data_jsonify %}{% if select_data %}"select-data": {{ select_data }},{% endif %}
 	"source": {{ config.source | replace: pwd, "" | cc_jsonify }}
 }

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

@@ -1,5 +1,5 @@
 {
-	"time": {{ site.time | cc_jsonify }},
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
 		"version": {{ gem_version | cc_jsonify }}
@@ -8,7 +8,7 @@
 	"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 %}
+	"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 %}
@@ -25,11 +25,12 @@
 		"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 }},{% endif %}
+	{% if config._array_structures %}"array-structures": {{ config._array_structures | cc_jsonify: nil, 20 }},{% endif %}
 	{% assign select_data = config | cc_select_data_jsonify %}{% if select_data %}"select-data": {{ select_data }},{% endif %}
 	"source": {{ config.source | replace: pwd, "" | cc_jsonify }}
 }

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

@@ -1,5 +1,5 @@
 {
-	"time": {{ site.time | cc_jsonify }},
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
 		"version": {{ gem_version | cc_jsonify }}
@@ -12,9 +12,7 @@
 	{% if config.baseurl -%}
 		"base-url": {{ config.baseurl | cc_jsonify }},
 	{%- endif %}
-	{% if config.collections -%}
-		"collections": {{ config.collections | cc_jsonify: 'collections' }},
-	{%- endif %}
+	"collections": {{ collections | cc_jsonify: 'collections' }},
 	{% if config._comments -%}
 		"comments": {{ config._comments | cc_jsonify }},
 	{%- endif %}
@@ -43,12 +41,13 @@
 		"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 }},
+		"array-structures": {{ config._array_structures | cc_jsonify: nil, 20 }},
 	{%- endif %}
 	{% assign select_data = config | cc_select_data_jsonify -%}
 	{% if select_data -%}

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

@@ -1,5 +1,5 @@
 {
-	"time": {{ site.time | cc_jsonify }},
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
 		"version": {{ gem_version | cc_jsonify }}
@@ -18,10 +18,11 @@
 		{% 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 }},
 		"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_jsonify }},
-	"static": {{ site.static_files | cc_static_files_jsonify }}
+	"static-pages": {{ site.static_files | cc_static_files_jsonify }}
 }

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

@@ -1,5 +1,5 @@
 {
-	"time": {{ site.time | cc_jsonify }},
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
 		"version": {{ gem_version | cc_jsonify }}
@@ -18,9 +18,10 @@
 		{% 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": {{ site.static_files | cc_static_files_jsonify }}
+	"static-pages": {{ site.static_files | cc_static_files_jsonify }}
 }

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

@@ -1,5 +1,5 @@
 {
-	"time": {{ site.time | cc_jsonify }},
+	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
 		"version": {{ gem_version | cc_jsonify }}
@@ -30,11 +30,12 @@
 		"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": {{ site.static_files | cc_static_files_jsonify }}
+	"static-pages": {{ site.static_files | cc_static_files_jsonify }}
 }

data/lib/cloudcannon-jekyll/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module CloudCannonJekyll
+  # Processes Jekyll configuration to enable the plugin is run and fix common issues
   class Configuration
     def self.processed?(site)
       site.instance_variable_get(:@_cloudcannon_jekyll_processed) == true
@@ -16,7 +17,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,32 +2,128 @@
 
 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)
-      generate_file("config", payload)
+      generate_file("details", payload.merge({
+        "drafts" => drafts,
+      }))
+    end
 
-      @site.keep_files ||= []
-      @site.keep_files << path("details")
-      @site.keep_files << path("config")
+    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") { |f| f.write(file_content(filename, data)) }
+      File.open(dest, "w") { |file| file.write(file_content(filename, data)) }
+      @site.keep_files ||= []
+      @site.keep_files << path(filename)
     end
 
     def version_path_suffix
@@ -50,13 +146,13 @@ module CloudCannonJekyll
     end
 
     def file_content(filename, data)
-      json = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", path(filename))
-      json.content = File.read(source_path(filename))
-      json.data["layout"] = nil
-      json.data["sitemap"] = false
-      json.data["permalink"] = "/#{path(filename)}"
-      json.render({}, data)
-      json.output
+      page = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", path(filename))
+      page.content = File.read(source_path(filename))
+      page.data["layout"] = nil
+      page.data["sitemap"] = false
+      page.data["permalink"] = "/#{path(filename)}"
+      page.render({}, data)
+      page.output
     end
   end
 end

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

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

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

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

data/lib/cloudcannon-jekyll/reader.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "readers/old-data-reader"
+require_relative "readers/data-reader"
+
+module CloudCannonJekyll
+  # Wraps read functions into one class
+  class Reader
+    attr_reader :site
+
+    def initialize(site)
+      @site = site
+    end
+
+    def read_data(dir = "_data")
+      # DataReader doesn't exist in old versions of Jekyll
+      if Jekyll::VERSION.start_with? "2."
+        CloudCannonJekyll::OldDataReader.new(@site).read(dir)
+      else
+        CloudCannonJekyll::DataReader.new(@site).read(dir)
+      end
+    end
+
+    def read_drafts(dir = "")
+      # PostReader doesn't exist in old versions of Jekyll
+      if Jekyll::VERSION.start_with? "2."
+        @site.read_content(dir, "_drafts", Jekyll::Draft)
+      else
+        Jekyll::PostReader.new(@site).read_drafts(dir)
+      end
+    end
+
+    def read_posts(dir = "")
+      # PostReader doesn't exist in old versions of Jekyll
+      if Jekyll::VERSION.start_with? "2."
+        @site.read_content(dir, "_posts", Jekyll::Post)
+      else
+        Jekyll::PostReader.new(@site).read_posts(dir)
+      end
+    end
+  end
+end

data/lib/cloudcannon-jekyll/readers/data-reader.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+unless Jekyll::VERSION.start_with? "2."
+  require "jekyll"
+
+  module CloudCannonJekyll
+    # Reads data files and creates a collections-style hash representation
+    class DataReader < Jekyll::DataReader
+      # Determines how to read a data file.
+      # This is overridden return a hash instead of reading the file.
+      #
+      # Returns a hash with the path to the data file.
+      def read_data_file(path)
+        {
+          "path" => path,
+        }
+      end
+    end
+  end
+end

data/lib/cloudcannon-jekyll/readers/old-data-reader.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+if Jekyll::VERSION.start_with? "2."
+  require "jekyll"
+
+  module CloudCannonJekyll
+    # Reads data files and creates a collections-style hash representation
+    # Aims to replicate the data reading logic in Jekyll 2.5
+    class OldDataReader
+      attr_reader :site
+
+      def initialize(site)
+        @site = site
+        @safe = site.safe
+        @content = {}
+      end
+
+      def read(dir)
+        base = Jekyll.sanitized_path(@site.source, dir)
+        read_data_to(base, @content)
+        @content
+      end
+
+      def read_data_to(dir, data)
+        return unless File.directory?(dir) && (!@safe || !File.symlink?(dir))
+
+        entries = Dir.chdir(dir) do
+          Dir["*.{yaml,yml,json,csv}"] + Dir["*"].select { |fn| File.directory?(fn) }
+        end
+
+        entries.each do |entry|
+          path = Jekyll.sanitized_path(dir, entry)
+          next if File.symlink?(path) && @safe
+
+          key = sanitize_filename(File.basename(entry, ".*"))
+          if File.directory?(path)
+            read_data_to(path, data[key] = {})
+          else
+            data[key] = read_data_file(path)
+          end
+        end
+      end
+
+      def read_data_file(path)
+        {
+          "path" => path,
+        }
+      end
+
+      def sanitize_filename(name)
+        name.gsub!(%r![^\w\s_-]+!, "")
+        name.gsub!(%r!(^|\b\s)\s+($|\s?\b)!, '\\1\\2')
+        name.gsub(%r!\s+!, "_")
+      end
+    end
+  end
+end

data/lib/cloudcannon-jekyll/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.4
 platform: ruby
 authors:
 - CloudCannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -107,7 +107,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/stale.yml"
 - ".gitignore"
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -128,6 +130,9 @@ files:
 - lib/cloudcannon-jekyll/generator.rb
 - lib/cloudcannon-jekyll/jsonify-filter.rb
 - lib/cloudcannon-jekyll/page-without-a-file.rb
+- lib/cloudcannon-jekyll/reader.rb
+- lib/cloudcannon-jekyll/readers/data-reader.rb
+- lib/cloudcannon-jekyll/readers/old-data-reader.rb
 - lib/cloudcannon-jekyll/version.rb
 - script/ci-smoke-test
 - script/cibuild