cloudcannon-jekyll 2.2.0 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34076270fab6ebafaa9530d0898bc08274f902cc86e6fb2e13890d4a69440854
-  data.tar.gz: 4036d2f037e7c36e31c112fcf4b296bd4afbb44f8d643aba36909108893b3b86
+  metadata.gz: c62beece4089cf5687f4c84d38495a602f62800a19bd5e195eb0272f79724965
+  data.tar.gz: 34024730134cd587c13ba63e259454c9d1aedb3fd0479f8ef32a2401ddab0753
 SHA512:
-  metadata.gz: 5ebaeaf4c7678a09859d0a845b1e4280c88ca1606099cf3e19ab7cc5a4d5a0ee2d2b18b5e827204d528915ed6d5281b089d9aa2baec4e0537d8efe5e0c263223
-  data.tar.gz: 63e881e3242696fa1faad9ae166a0e121ab58a5895782c2eb2d3c474401da7993c7a40cf138cb22195bfcdf8c092a3ba446f1de4f0fd1eb5b50ca0469b8e72c0
+  metadata.gz: '09a307c7f7d9deba9f4fe4407ae982b16c6a260bda34bbe140547cfe978a5268c0016210f995a8a6cf69c0b0815b3e883b369265586af64dfc07b41daa78e0ef'
+  data.tar.gz: 798272f7382f5da33c7bb6c03e30733a506346bc162eb042c1ef09fc1b62ae405d8660bb10771a07377cefeda9995852295dbd0cc37066f2c83944ae4b0777f8

data/HISTORY.md

@@ -1,3 +1,28 @@
+# 2.3.3
+
+* Add _structures
+
+# 2.3.2
+
+* Add _inputs to templates
+
+# 2.3.1
+
+* Fix issue where pages config overwrites default
+* Fix issue when a site has no pages
+
+# 2.3.0
+
+* Fix output for drafts collection config
+* Update schema version
+* fix parsing for category folders
+* Add logging
+
+# 2.2.0
+
+* Move data logic out of template
+* Auto-populate categories and tags in data
+
 # 2.1.0
 
 * Add `_instance_values` to global scope

data/README.md

@@ -26,6 +26,13 @@ plugins:
 4. Build new gem with `gem build cloudcannon-jekyll.gemspec`
 5. Push new version to rubygems.org with `gem push cloudcannon-jekyll-{{ VERSION HERE }}.gem`
 
+OR:
+
+1. Increase version in lib/cloudcannon-jekyll/version.rb
+2. Update HISTORY.md
+3. Run `./scripts/release`
+3. Create a release in GitHub
+
 
 ## Testing
 

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

@@ -19,13 +19,9 @@
 	{% endif %}
 	"collections-config": {{ collections_config | cc_jsonify }},
 	"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 %}
+		{% for collection in collections %}"{{ collection[0] | xml_escape }}": {{ collection[1] | cc_jsonify }}{% unless forloop.last %},{% endunless %}
 		{% endfor %}
 	},
-	"pages": {{ site.html_pages | cc_jsonify }},
-	"static-pages": {{ site.static_files | cc_static_files_jsonify }},
 	"data": {{ data | cc_jsonify }},
 	{% if config.baseurl %}
 		"base-url": {{ config.baseurl | cc_jsonify }},
@@ -42,6 +38,9 @@
 	{% if config._options %}
 		"_options": {{ config._options | cc_jsonify }},
 	{% endif %}
+	{% if config._inputs %}
+		"_inputs": {{ config._inputs | cc_jsonify }},
+	{% endif %}
 	{% if config._collection_groups %}
 		"_collection_groups": {{ config._collection_groups | cc_jsonify }},
 	{% endif %}
@@ -58,13 +57,15 @@
 		},
 	{% endif %}
 	"paths": {
+		"static": "",
 		"uploads": {{ config.uploads_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._structures %}
+		"_structures": {{ config._structures | cc_jsonify: 50 }},
+	{% endif %}
 	{% if config._array_structures %}
 		"_array_structures": {{ config._array_structures | cc_jsonify: 50 }},
 	{% endif %}

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

@@ -19,12 +19,9 @@
 	{% endif %}
 	"collections-config": {{ collections_config | cc_jsonify }},
 	"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 %}
+		{% for collection in collections %}"{{ collection[0] | xml_escape }}": {{ collection[1] | cc_jsonify }}{% unless forloop.last %},{% endunless %}
 		{% endfor %}
 	},
-	"pages": {{ site.html_pages | cc_jsonify }},
-	"static-pages": {{ site.static_files | cc_static_files_jsonify }},
 	"data": {{ data | cc_jsonify }},
 	{% if config.baseurl %}
 		"base-url": {{ config.baseurl | cc_jsonify }},
@@ -41,6 +38,9 @@
 	{% if config._options %}
 		"_options": {{ config._options | cc_jsonify }},
 	{% endif %}
+	{% if config._inputs %}
+		"_inputs": {{ config._inputs | cc_jsonify }},
+	{% endif %}
 	{% if config._collection_groups %}
 		"_collection_groups": {{ config._collection_groups | cc_jsonify }},
 	{% endif %}
@@ -57,13 +57,15 @@
 		},
 	{% endif %}
 	"paths": {
+		"static": "",
 		"uploads": {{ config.uploads_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._structures %}
+		"_structures": {{ config._structures | cc_jsonify: 50 }},
+	{% endif %}
 	{% if config._array_structures %}
 		"_array_structures": {{ config._array_structures | cc_jsonify: 50 }},
 	{% endif %}

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

@@ -1,5 +1,6 @@
 {
 	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
+	"version": {{ version | cc_jsonify }},
 	"cloudcannon": {
 		"name": "cloudcannon-jekyll",
 		"version": {{ gem_version | cc_jsonify }}
@@ -19,14 +20,11 @@
 	{%- endif %}
 	"collections-config": {{ collections_config | cc_jsonify }},
 	"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 collections -%}
+			"{{ collection[0] | xml_escape }}": {{ collection[1] | cc_jsonify }}
 			{%- unless forloop.last %},{% endunless %}
 		{%- endfor -%}
 	},
-	"pages": {{ site.html_pages | cc_jsonify }},
-	"static-pages": {{ site.static_files | cc_static_files_jsonify }},
 	"data": {{ data | cc_jsonify }},
 	{% if config.baseurl -%}
 		"base-url": {{ config.baseurl | cc_jsonify }},
@@ -43,6 +41,9 @@
 	{% if config._options -%}
 		"_options": {{ config._options | cc_jsonify }},
 	{%- endif %}
+	{% if config._inputs -%}
+		"_inputs": {{ config._inputs | cc_jsonify }},
+	{%- endif %}
 	{% if config._collection_groups -%}
 		"_collection_groups": {{ config._collection_groups | cc_jsonify }},
 	{%- endif %}
@@ -59,13 +60,15 @@
 		},
 	{%- endif %}
 	"paths": {
+		"static": "",
 		"uploads": {{ config.uploads_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._structures -%}
+		"_structures": {{ config._structures | cc_jsonify: 50 }},
+	{%- endif %}
 	{% if config._array_structures -%}
 		"_array_structures": {{ config._array_structures | cc_jsonify: 50 }},
 	{%- endif %}

data/lib/cloudcannon-jekyll/generator.rb

@@ -13,51 +13,87 @@ module CloudCannonJekyll
       1
     end
 
+    # rubocop:disable Metrics/MethodLength
     def generate(site)
+      log "⭐️ Starting #{"cloudcannon-jekyll".blue}"
+
       @site = site
       @reader = Reader.new(@site)
 
-      collections_config = process_collections_config
-      data = process_data
-
-      payload = @site.site_payload.merge({
-        "gem_version" => CloudCannonJekyll::VERSION,
-      })
-
+      migrate_legacy_config
+      pages = generate_pages
+      collections_config = generate_collections_config(pages)
       drafts = add_blogging_config(collections_config)
       add_collection_paths(collections_config)
+
+      collections = generate_collections(collections_config, pages, drafts)
+      remove_empty_collection_config(collections_config, collections)
+
       add_data_config(collections_config)
-      add_legacy_explore_groups
+      data = generate_data
 
-      generate_file("info", payload.merge({
+      generate_file("info", @site.site_payload.merge({
         "pwd"                => Dir.pwd,
+        "version"            => "0.0.2",
+        "gem_version"        => CloudCannonJekyll::VERSION,
         "config"             => @site.config,
         "collections_config" => collections_config,
-        "drafts"             => drafts,
+        "collections"        => collections,
         "data"               => data,
       }))
     end
+    # rubocop:enable Metrics/MethodLength
 
-    def process_collections_config
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def generate_collections_config(pages)
       collections = @site.config["collections"]&.dup || {}
-      cc_collections = @site.config.dig("cloudcannon", "collections")&.dup || {}
+      collections_config = @site.config.dig("cloudcannon", "collections")&.dup || {}
 
       collections.each_key do |key|
         # Workaround for empty collection configurations
         defaults = collections[key] || { "output" => false }
-        cc_collections[key] = (cc_collections[key] || {}).merge(defaults)
+        collections_config[key] = (collections_config[key] || {}).merge(defaults)
       end
 
-      cc_collections
+      unless pages.empty? || collections.key?("pages")
+        pages_defaults = {
+          "output" => true,
+          "filter" => "strict",
+          "path"   => "",
+        }
+
+        collections_config["pages"] = pages_defaults.merge(collections_config["pages"] || {})
+      end
+
+      collections_config
     end
 
-    def collections_dir
-      return "" if Jekyll::VERSION.start_with? "2."
+    # rubocop:disable Metrics/PerceivedComplexity
+    def generate_collections(collections_config, pages, drafts)
+      split_posts = group_by_category_folder(all_posts, "posts")
+      split_drafts = group_by_category_folder(drafts, "drafts")
+
+      collections = {}
+      collections_config.each_key do |key|
+        collections[key] = if key == "posts" || key.end_with?("/posts")
+                             split_posts[key]
+                           elsif key == "drafts" || key.end_with?("/drafts")
+                             split_drafts[key]
+                           else
+                             @site.collections[key]&.docs
+                           end
+
+        collections[key] ||= []
+      end
 
-      @site.config["collections_dir"] || ""
+      has_collection_pages = collections.key?("pages") && !collections["pages"].empty?
+      collections["pages"] = pages unless pages.empty? || has_collection_pages
+      collections
     end
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity
 
-    def process_data
+    def generate_data
       cc_data = @site.config.dig("cloudcannon", "data")
       data = if cc_data == true
                @site.data&.dup
@@ -68,20 +104,57 @@ module CloudCannonJekyll
       data ||= {}
       data["categories"] ||= @site.categories.keys
       data["tags"] ||= @site.tags.keys
+
+      data.each_key do |key|
+        log "💾 Processed #{key.bold} data set"
+      end
+
       data
     end
 
+    def generate_pages
+      html_pages = @site.pages.select do |page|
+        page.html? || page.url.end_with?("/")
+      end
+
+      static_pages = @site.static_files.select do |static_page|
+        JsonifyFilter::STATIC_EXTENSIONS.include?(static_page.extname)
+      end
+
+      html_pages + static_pages
+    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 = {})
+    def all_posts
       posts = @site.posts || @site.collections["posts"]
-      docs = posts.class.method_defined?(:docs) ? posts.docs : posts
+      posts.class.method_defined?(:docs) ? posts.docs : posts
+    end
+
+    def group_by_category_folder(collection, key)
+      split_path = "/_#{key}/"
+      collection.group_by do |doc|
+        parts = doc.relative_path.split(split_path)
+        if parts.length > 1
+          "#{parts.first}/#{key}".sub(%r!^\/+!, "")
+        else
+          key
+        end
+      end
+    end
+
+    def add_category_folder_config(collections_config, posts_config = {})
       seen = {}
 
-      docs.map do |post|
+      all_posts.map do |post|
         parts = post.relative_path.split("/_posts/")
         path = parts.first
 
@@ -108,7 +181,23 @@ module CloudCannonJekyll
         path
       end
     end
-    # rubocop:enable Metrics/AbcSize
+
+    def remove_empty_collection_config(collections_config, collections)
+      cc_collections = @site.config.dig("cloudcannon", "collections") || {}
+
+      collections_config.each_key do |key|
+        if collections[key].empty? && !cc_collections.key?(key)
+          log "📂 #{"Ignored".yellow} #{key.bold} collection"
+          collections_config.delete(key)
+        else
+          log "📁 Processed #{key.bold} collection with #{collections[key]&.length || 0} files"
+        end
+      end
+    end
+
+    def migrate_legacy_config
+      add_legacy_explore_groups
+    end
 
     # Support for the deprecated _explore configuration
     def add_legacy_explore_groups
@@ -128,8 +217,8 @@ module CloudCannonJekyll
       collections_config["posts"] = { "output" => true } if Jekyll::VERSION.start_with? "2."
       drafts = @reader.read_drafts(collections_dir)
 
-      if drafts.any? || (collections_config.key?("posts") && !collections_config.key?("drafts"))
-        collections_config["drafts"] = {}
+      if drafts.any? && !collections_config.key?("drafts")
+        collections_config["drafts"] = { "output" => !!@site.show_drafts }
       end
 
       folders = add_category_folder_config(collections_config, collections_config["posts"])
@@ -153,6 +242,11 @@ module CloudCannonJekyll
       File.open(dest, "w") { |file| file.write(file_content(filename, data)) }
       @site.keep_files ||= []
       @site.keep_files << path(filename)
+      log "🏁 Generated #{path(filename).bold} #{"successfully".green}"
+    end
+
+    def log(str)
+      Jekyll.logger.info("CloudCannon:", str)
     end
 
     def version_path_suffix

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

@@ -50,7 +50,7 @@ module CloudCannonJekyll
         next if prevent.include?(key) || key.nil?
 
         prevent.push key
-        next_max_depth = key == "_array_structures" ? 20 : max_depth
+        next_max_depth = %w(_array_structures _structures).include?(key) ? 20 : max_depth
         "#{key.to_json}: #{JsonifyFilter.to_json(value, depth, next_max_depth)}"
       end
 
@@ -134,7 +134,7 @@ module CloudCannonJekyll
 
     def self.hash_to_json(input, depth, max_depth)
       out = input.map do |key, value|
-        next_max_depth = key == "_array_structures" ? 20 : max_depth
+        next_max_depth = %w(_array_structures _structures).include?(key) ? 20 : max_depth
         string_key = key.to_s.to_json
         "#{string_key}: #{JsonifyFilter.to_json(value, depth, next_max_depth)}"
       end

data/lib/cloudcannon-jekyll/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.3
 platform: ruby
 authors:
 - CloudCannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll