cloudcannon-jekyll 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92b0e675c47140f4aef7c11b38d2f3fb9e650dfe68639f0a0f7a66c0fd312ad1
-  data.tar.gz: 4bead9682c10702bfb3271e6dd103df94a35106f70136fb5b3c37a11b833c9f8
+  metadata.gz: 33d4053706ea20c8d2e3985de49e437dcee1c275ecd4ccdf78dc7c7d1a94cf83
+  data.tar.gz: 4fe382c19ba59e3242f6cfa9b5b7e46de152c2091036602a622618fce3f2e8ba
 SHA512:
-  metadata.gz: 9639f12433c8ccd842eea34ae0569d0ec6a0dcf062ba37e2f9fc313cb15de81720db9a91ceea91bfabc39eed094dd333cebd3fb271af11ee7a105b11f2e9470a
-  data.tar.gz: c8f6b1b80ad75c5ea2f76d638cc4843fa020449d30c1d35a3b863f6d99f9cc9cb5d8842fc7b38a968a43998506e305f60d4701352fa838e112e62dbd97ed8417
+  metadata.gz: f3d509ec5cfdedc0dce34b639152efd81a81c2d798f403dbf656ab17cc16af127a45609d4cf482b830e02fbdbe4b77c7c6bc7a8a8a3a584b501273b3f40d4fdb
+  data.tar.gz: f1c56c046ff5dcf46048184cf7de498aff85706804afbf168613cfac4d0e6a448ebecc29e6575114ee58098c7df7e3a83ba19bb07f9d68902aa0cbd60db120e0

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/.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,6 +1,13 @@
-# 1.4.3
-
-* Fix off-by-one depth for nested documents from last change
+# 1.5.0
+
+* 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
 
 # 1.4.2
 

data/lib/cloudcannon-jekyll.rb

@@ -10,7 +10,7 @@ require_relative "cloudcannon-jekyll/version"
 
 Liquid::Template.register_filter(CloudCannonJekyll::JsonifyFilter)
 
-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

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

@@ -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 %}"collections": {{ 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 %}

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

@@ -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 %}"collections": {{ 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 %}

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

@@ -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 %}

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

@@ -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

@@ -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

@@ -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

@@ -17,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,6 +2,7 @@
 
 require "jekyll"
 require "fileutils"
+require_relative "reader"
 
 module CloudCannonJekyll
   # Generates JSON files containing build config and build output details
@@ -10,25 +11,111 @@ module CloudCannonJekyll
 
     def generate(site)
       @site = site
+      @reader = Reader.new(@site)
+
+      collections_config = @site.config["collections"].dup || {}
 
       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
 
-      generate_file("details", payload)
-      generate_file("config", payload)
+    def collections_dir
+      return "" if Jekyll::VERSION.start_with? "2."
 
-      @site.keep_files ||= []
-      @site.keep_files << path("details")
-      @site.keep_files << path("config")
+      @site.config["collections_dir"] || ""
+    end
+
+    def data_dir
+      @site.config["data_dir"] || "_data"
+    end
+
+    def add_category_folder_config(collections_config, posts_config = {})
+      posts = @site.posts || @site.collections["posts"]
+      seen = {}
+
+      posts.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
+
+    # 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)) }
+      @site.keep_files ||= []
+      @site.keep_files << path(filename)
     end
 
     def version_path_suffix

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

@@ -6,7 +6,6 @@ module CloudCannonJekyll
   # Filter for converting Jekyll objects into JSON
   module JsonifyFilter
     STATIC_EXTENSIONS = [".html", ".htm"].freeze
-    STATIC_PATHS = ["/robots.txt", "/sitemap.xml"].freeze
 
     CC_JSONIFY_KEY_SWAPS = {
       "collections" => {
@@ -46,17 +45,14 @@ module CloudCannonJekyll
     end
 
     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, max_depth)}",
-        "\"path\": #{JsonifyFilter.to_json(input.relative_path, depth, max_depth)}",
+        "\"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
-        file_json = JsonifyFilter.to_json(input.modified_time, depth, max_depth)
-        out.push("\"modified_time\": #{file_json}")
-      end
-
       "{#{out.join(",")}}"
     end
 
@@ -77,7 +73,6 @@ module CloudCannonJekyll
       prevent = %w(dir name path url date id categories tags)
 
       out = [
-        "\"dir\": #{JsonifyFilter.to_json(input.dir, depth, max_depth)}",
         "\"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)}",
@@ -95,7 +90,6 @@ module CloudCannonJekyll
       prevent = %w(dir name path url)
 
       out = [
-        "\"dir\": #{JsonifyFilter.to_json(input.dir, depth, max_depth)}",
         "\"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)}",
@@ -114,11 +108,9 @@ module CloudCannonJekyll
 
     def self.document_to_json(input, depth, max_depth)
       prevent = %w(dir id relative_path url collection)
-      path_json = JsonifyFilter.to_json(input.relative_path, depth, max_depth)
 
       out = [
-        "\"path\": #{path_json}",
-        "\"relative_path\": #{path_json}",
+        "\"path\": #{JsonifyFilter.to_json(input.relative_path, depth, max_depth)}",
         "\"url\": #{JsonifyFilter.to_json(input.url, depth, max_depth)}",
       ]
 
@@ -128,11 +120,6 @@ module CloudCannonJekyll
         out.push("\"collection\": #{collection_json}")
       end
 
-      # id isn't defined in Jekyll 2.4.0
-      if input.respond_to? :id
-        out.push("\"id\": #{JsonifyFilter.to_json(input.id, depth, max_depth)}")
-      end
-
       out += JsonifyFilter.document_data_to_a(input.data, prevent, depth, max_depth)
       "{#{out.join(",")}}"
     end
@@ -180,7 +167,7 @@ module CloudCannonJekyll
     def self.to_json(input, depth, max_depth = 9, key_swaps = {})
       depth += 1
 
-      if depth > max_depth || (depth > 3 && JsonifyFilter.document_type?(input))
+      if depth > max_depth || (depth > 2 && JsonifyFilter.document_type?(input))
         '"MAXIMUM_DEPTH"'
       elsif JsonifyFilter.simple_type?(input)
         input.to_json
@@ -203,9 +190,7 @@ module CloudCannonJekyll
 
     def cc_static_files_jsonify(input)
       out = input.map do |page|
-        next unless STATIC_EXTENSIONS.include?(page.extname) || STATIC_PATHS.include?(page.path)
-
-        JsonifyFilter.to_json(page, 1)
+        JsonifyFilter.to_json(page, 1) if STATIC_EXTENSIONS.include?(page.extname)
       end
 
       out.compact!

data/lib/cloudcannon-jekyll/reader.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+if !Jekyll::VERSION.start_with? "2."
+  require_relative "readers/data-reader"
+else
+  require_relative "readers/old-data-reader"
+end
+
+module CloudCannonJekyll
+  # Wraps read functions into one class
+  class Reader
+    attr_reader :site
+
+    def initialize(site)
+      @site = site
+    end
+
+    def read_data(dir = "_data")
+      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 = "")
+      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 = "")
+      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,18 @@
+# frozen_string_literal: true
+
+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

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+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

data/lib/cloudcannon-jekyll/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - CloudCannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-02 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -107,6 +107,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rspec"
@@ -129,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