cloudcannon-jekyll 2.0.2 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ba3dd6e0f966b1e258e25c63e10ca6b38d6b1fa5eef20867e35f4e1d3679584
-  data.tar.gz: 6cc8bc3ecc01cabcbce3e9f9691a9acf296a8e703651f1c9e6defd59c9467660
+  metadata.gz: 00114b22694d4a9d0f1de2f1e44a8e893c0184d5d0a9ec2e644d8115d30c3a83
+  data.tar.gz: 58acfeb5af57f993c0d8340722b9b45fe650062c7189c7b82f7b11841070b07b
 SHA512:
-  metadata.gz: 0df6f5ab7cef31e3481b85a0485bddebbd088a7211dc5a82bd7487964c5650963ed583feaf8674603c8831fef5f00b5e4376dc6d5377bf05da6c9c0653a0046e
-  data.tar.gz: 80ad95aa7b61d49a41f908f834d616b493d027d5f9c2feaf38205db236895a19be9d320c8736f7a8d2ec01909e357d012615d2b09d6f565c5772607ed2c13638
+  metadata.gz: 6fb1598701caa1dd4b0fc667ec2c5c5bfb6674806126a78b4905b1c680bdad689e11ce5e82880dc06246d50e73037a5d0de125d5e70bfba2d0d0bbde0d4536df
+  data.tar.gz: 63efb6ab686f4b62f9eae28d5fb2c146228dd6a147ad00030975407e7500de38af808fdeef79dccab4cbfbe823c5261fc5c472d1a543a09f15376dc7d5efd848

data/HISTORY.md

@@ -1,3 +1,24 @@
+# 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
+
 # 2.0.2
 
 * Add `_enabled_editors` 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,17 +19,10 @@
 	{% 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 }},
-	{% 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 %}
+	"data": {{ data | cc_jsonify }},
 	{% if config.baseurl %}
 		"base-url": {{ config.baseurl | cc_jsonify }},
 	{% endif %}
@@ -39,6 +32,9 @@
 	{% if config._enabled_editors %}
 		"_enabled_editors": {{ config._enabled_editors | cc_jsonify }},
 	{% endif %}
+	{% if config._instance_values %}
+		"_instance_values": {{ config._instance_values | cc_jsonify }},
+	{% endif %}
 	{% if config._options %}
 		"_options": {{ config._options | cc_jsonify }},
 	{% endif %}
@@ -58,11 +54,10 @@
 		},
 	{% 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._array_structures %}

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

@@ -19,16 +19,10 @@
 	{% 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 }},
-	{% 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 %}
+	"data": {{ data | cc_jsonify }},
 	{% if config.baseurl %}
 		"base-url": {{ config.baseurl | cc_jsonify }},
 	{% endif %}
@@ -38,6 +32,9 @@
 	{% if config._enabled_editors %}
 		"_enabled_editors": {{ config._enabled_editors | cc_jsonify }},
 	{% endif %}
+	{% if config._instance_values %}
+		"_instance_values": {{ config._instance_values | cc_jsonify }},
+	{% endif %}
 	{% if config._options %}
 		"_options": {{ config._options | cc_jsonify }},
 	{% endif %}
@@ -57,11 +54,10 @@
 		},
 	{% 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._array_structures %}

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,29 +20,12 @@
 	{%- 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 }},
-	{% 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 %}
+	"data": {{ data | cc_jsonify }},
 	{% if config.baseurl -%}
 		"base-url": {{ config.baseurl | cc_jsonify }},
 	{%- endif %}
@@ -51,6 +35,9 @@
 	{% if config._enabled_editors -%}
 		"_enabled_editors": {{ config._enabled_editors | cc_jsonify }},
 	{%- endif %}
+	{% if config._instance_values -%}
+		"_instance_values": {{ config._instance_values | cc_jsonify }},
+	{%- endif %}
 	{% if config._options -%}
 		"_options": {{ config._options | cc_jsonify }},
 	{%- endif %}
@@ -70,11 +57,10 @@
 		},
 	{%- 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._array_structures -%}

data/lib/cloudcannon-jekyll/generator.rb

@@ -13,40 +13,115 @@ 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
-
-      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
+
+      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
+
+    # 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
+
+      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 generate_data
+      cc_data = @site.config.dig("cloudcannon", "data")
+      data = if cc_data == true
+               @site.data&.dup
+             elsif cc_data&.is_a?(Hash)
+               @site.data&.select { |key, _| cc_data.key?(key) }
+             end
+
+      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
 
-      cc_collections
+      html_pages + static_pages
     end
 
     def collections_dir
@@ -59,13 +134,27 @@ module CloudCannonJekyll
       @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
 
@@ -92,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
@@ -112,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"])
@@ -137,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

@@ -150,7 +150,7 @@ module CloudCannonJekyll
                    baseurl show_dir_listing permalink paginate_path timezone quiet verbose defaults
                    liquid kramdown title url description uploads_dir _comments _options _editor
                    _explore _source_editor _array_structures maruku redcloth rdiscount redcarpet
-                   gems plugins cloudcannon _collection_groups _enabled_editors)
+                   gems plugins cloudcannon _collection_groups _enabled_editors _instance_values)
 
       out = input.map do |key, value|
         next unless value.is_a?(Array) || value.is_a?(Hash)

data/lib/cloudcannon-jekyll/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.3.1
 platform: ruby
 authors:
 - CloudCannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll