cloudcannon-jekyll 2.3.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09003d2ad672bafc2165e8a667a19c2a730651ddba0fd201904a8575e4c5bba0'
-  data.tar.gz: 5988731017bdd55c1d2600409ee8e0380847552a79bdc6ef0ff445e810132715
+  metadata.gz: 37060b4654f27c7236d0952625b91b56b081c6be24c1a76c034036a80ba1735d
+  data.tar.gz: 055c7dbc77a247c254b05bcecedf5a45a9595c0b4ceae671676ec32fa1f771c3
 SHA512:
-  metadata.gz: beabc519bea263502f085226ffb98b27d6aa2cd882ca5efe710f63287afaaaeb80f47eea3f118447bbed3d1f89c51c17f6d77134adc5a3f7e11a983ce969e53e
-  data.tar.gz: d77019b69275bb04a010fa7ce8a0c3763e7a9e1ce449741f62a9e945a5454ffb03fb7395c463cc4434722653156f989a4be81bdac6781bc0efa495c7afc2a2be
+  metadata.gz: 4b9536ca8a4097fa234c35a30226a9c17bd9a020e5d883ef82f38883a9a93d6e8f6afbfe17197b949468baec9d6a077f3467ec9b3a23fdaf19740590ce28ba1b
+  data.tar.gz: 89bdca52d720c403ddcaf8dc3d20debc1e1da51664874585b132332b199ef444c20c5104686b7ab576b0b5a6ccfad4cabd91157bc38e08a78ca5300e313ea211

data/.gitignore

@@ -2,7 +2,6 @@ Gemfile.lock
 spec/dest/
 spec/fixtures/**/.jekyll-cache/
 spec/fixtures/**/.jekyll-metadata
-spec/fixtures/_site/
 gemfiles/.bundle/
 gemfiles/*.gemfile.lock
 cloudcannon-jekyll-*.gem

data/.rubocop.yml

@@ -1,18 +1,14 @@
-require: rubocop-jekyll
-
-inherit_gem:
-  rubocop-jekyll: .rubocop.yml
-
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.4
   Include:
     - lib/**/*.rb
-
+    - spec/*.rb
   Exclude:
     - .gitignore
+    - .reek.yml
     - .rspec
     - .rubocop.yml
-    - .travis.yml
     - Gemfile.lock
     - HISTORY.md
     - LICENSE.txt
@@ -20,20 +16,28 @@ AllCops:
     - script/**/*
     - vendor/**/*
     - gemfiles/**/*
-
-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
-
+  Enabled: false
 Metrics/PerceivedComplexity:
-  Exclude:
-    - lib/cloudcannon-jekyll/jsonify-filter.rb # TODO remove this and fix warnings
-
+  Enabled: false
 Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Layout/LineLength:
+  Max: 100
+Naming/FileName:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Metrics/BlockLength:
   Exclude:
-    - lib/cloudcannon-jekyll/jsonify-filter.rb # TODO remove this and fix warnings
+    - !ruby/regexp /^spec/
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/HISTORY.md

@@ -1,3 +1,11 @@
+# 3.0.0
+
+* Add `collections_config_override`
+* Ensure `paths.data` doesnt start with slash
+* Support external configuration files
+* Remove template rendering step and write output directly
+* Update output to support schema version `0.0.3`
+
 # 2.3.4
 
 * Add `_editables`

data/README.md

@@ -1,47 +1,184 @@
-# CloudCannon Jekyll plugin
+# CloudCannon Jekyll
 
-A Jekyll plugin to create CloudCannon editor details.
+A Jekyll plugin that creates [CloudCannon](https://cloudcannon.com/) build information.
 
-[![Build Status](https://travis-ci.com/CloudCannon/cloudcannon-jekyll.svg?branch=main)](https://travis-ci.com/CloudCannon/cloudcannon-jekyll) [![Gem Version](https://badge.fury.io/rb/cloudcannon-jekyll.svg)](https://badge.fury.io/rb/cloudcannon-jekyll)
+This plugin runs during your Jekyll build, discovering your pages, collections, and data files to
+create a JSON file used to automatically integrate the site with CloudCannon.
 
-## Usage
+[<img src="https://img.shields.io/gem/v/cloudcannon-jekyll?logo=rubygems" alt="version badge">](https://rubygems.org/gems/cloudcannon-jekyll)
+[<img src="https://img.shields.io/gem/dt/cloudcannon-jekyll" alt="downloads badge">](https://rubygems.org/gems/cloudcannon-jekyll)
 
-1. Add `gem 'cloudcannon-jekyll'` to your site's `Gemfile`
-2. Run `bundle install`
-3. Add the following to your site's `_config.yml`:
+***
+
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Development](#plugin-options)
+- [License](#license)
+
+***
+
+## Installation
+
+**You don't have to install anything** when building on CloudCannon. This plugin is automatically
+installed before your site is built. This gives you the latest support, new features, and fixes
+as they are released.
+
+Although **not recommended**, you can install the plugin manually.
+
+<details>
+<summary>Manual installation steps</summary>
+
+<blockquote>
+
+When installing manually, you'll have to upgrade when new versions are released.
+You could also follow these steps to debug an integration issue locally. This assumes you are using [Bundler](https://bundler.io/) to manage dependencies.
+
+CloudCannon won't automatically install this plugin before builds if `cloudcannon-jekyll` is already installed.
+
+```sh
+$ bundle add cloudcannon-jekyll --group jekyll_plugins
+```
+
+Add the following to your `_config.yml` if you're listing plugins here as well:
 
 ```yaml
 plugins:
   - cloudcannon-jekyll
 ```
 
-💡 If you are using a Jekyll version less than 3.5.0, use the gems key instead of plugins.
+💡 For Jekyll versions less than `v3.5.0`, use `gems` instead of `plugins`.
+
+</blockquote>
+</details>
+
+
+## Configuration
 
+This plugin uses an optional configuration file as a base to generate `_cloudcannon/info.json`
+(used to integrate your site with CloudCannon).
 
-## Releasing new version
+Add your global CloudCannon configuration to this file, alongside any optional configuration for
+this plugin.
 
-1. Increase version in lib/cloudcannon-jekyll/version.rb
-2. Update HISTORY.md
-3. Create a release and tag in GitHub
-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`
+Configuration files should be in the same directory you run `bundle exec jekyll build`. The first
+supported file found in this order is used:
 
-OR:
+- `cloudcannon.config.json`
+- `cloudcannon.config.yaml`
+- `cloudcannon.config.yml`
 
-1. Increase version in lib/cloudcannon-jekyll/version.rb
-2. Update HISTORY.md
-3. Run `./scripts/release`
-3. Create a release in GitHub
+Alternatively, use the `CLOUDCANNON_CONFIG_PATH` environment variable to use a specific config file
+in a custom location:
 
+```sh
+$ CLOUDCANNON_CONFIG_PATH=src/cloudcannon.config.yml bundle exec jekyll build
+```
 
-## Testing
+Example content for `cloudcannon.config.yml`:
 
+```yaml
+# Global CloudCannon configuration
+_inputs:
+  title:
+    type: text
+    comment: The title of your page.
+_select_data:
+  colors:
+    - Red
+    - Green
+    - Blue
+
+# Base path to your site source files, same as source for Jekyll
+source: src
+
+# The subpath your built output files are mounted at, same as baseurl for Jekyll
+base_url: /documentation
+
+# Populates collections for navigation and metadata in the editor
+collections_config:
+  people:
+    # Base path for files in this collection, relative to source
+    path: content/people
+
+    # Whether this collection produces output files or not
+    output: true
+
+    # Collection-level configuration
+    name: Personnel
+    _enabled_editors:
+      - data
+  posts:
+    path: _posts
+    output: true
+  pages:
+    name: Main pages
+
+# Generates the data for select and multiselect inputs matching these names
+data_config:
+  # Populates data with authors from an data file with the matching name
+  authors: true
+  offices: true
+
+paths:
+  # The default location for newly uploaded files, relative to source
+  uploads: assets/uploads
+
+  # The path to the root collections folder, relative to source
+  collections: items
+
+  # The path to site data files, relative to source
+  data: _data
+
+  # The path to site layout files, relative to source
+  layouts: _layouts
+
+  # The path to site include files, relative to source
+  includes: _partials
 ```
-bundle exec rspec
+
+See the [CloudCannon documentation](https://cloudcannon.com/documentation/) for more information
+on the available features you can configure.
+
+Configuration is set in `cloudcannon.config.*`, but the plugin also automatically
+reads and processes the following from Jekyll if unset:
+
+- `collections_config` from `collections` in `_config.yml`
+- `paths.collections` from `collections_dir` in `_config.yml`
+- `paths.layouts` from `layouts_dir` in `_config.yml`
+- `paths.data` from `data_dir` in `_config.yml`
+- `paths.includes` from `includes_dir` in `_config.yml`
+- `base_url` from `baseurl` in `_config.yml`
+- `source` from the `--source` CLI option or `source` in `_config.yml`
+
+## Development
+
+### Releasing new versions
+
+1. Increase the version in `lib/cloudcannon-jekyll/version.rb`
+2. Update `HISTORY.md`
+3. Run `./script/release`
+3. [Create a release on GitHub](https://github.com/CloudCannon/cloudcannon-jekyll/releases/new)
+
+### Testing
+
+Running tests for currently installed Jekyll version:
+
+```sh
+$ ./script/test
 ```
 
-To test a specific Jekyll version:
+Running tests for all specified Jekyll versions:
 
+```sh
+$ ./script/test-all-versions
 ```
-JEKYLL_VERSION="2.4.0" bundle update && bundle exec rspec
+
+Running tests for a specific Jekyll version:
+
+```sh
+$ JEKYLL_VERSION="2.4.0" bundle update && ./script/test
 ```
+
+## License
+
+MIT

data/cloudcannon-jekyll.gemspec

@@ -1,31 +1,29 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("lib", __dir__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require "cloudcannon-jekyll/version"
+require 'cloudcannon-jekyll/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cloudcannon-jekyll"
-  spec.summary       = "CloudCannon Jekyll integration"
-  spec.description   = "Creates CloudCannon editor details for Jekyll"
+  spec.name          = 'cloudcannon-jekyll'
+  spec.summary       = 'CloudCannon Jekyll integration'
+  spec.description   = 'Creates CloudCannon editor details for Jekyll'
   spec.version       = CloudCannonJekyll::VERSION
-  spec.authors       = ["CloudCannon"]
-  spec.email         = ["support@cloudcannon.com"]
-  spec.homepage      = "https://github.com/cloudcannon/cloudcannon-jekyll"
-  spec.licenses      = ["MIT"]
-  spec.require_paths = ["lib"]
+  spec.authors       = ['CloudCannon']
+  spec.email         = ['support@cloudcannon.com']
+  spec.homepage      = 'https://github.com/cloudcannon/cloudcannon-jekyll'
+  spec.licenses      = ['MIT']
+  spec.require_paths = ['lib']
 
   all_files          = `git ls-files -z`.split("\x0")
-  spec.files         = all_files.reject { |f| f.match(%r!^(test|spec|features)/!) }
+  spec.files         = all_files.reject { |f| f.match(%r{^(test|spec|features)/}) }
 
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = '>= 2.4.0'
 
-  spec.add_dependency "jekyll", ">= 2.4.0", "< 5"
+  spec.add_dependency 'jekyll', '>= 2.4.0'
 
-  spec.add_development_dependency "json_schemer", "~> 0.2.13"
-  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 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 0.80'
 end

data/lib/cloudcannon-jekyll/config.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'fileutils'
+require_relative 'logger'
+
+module CloudCannonJekyll
+  MAPPINGS = {
+    '_sort_key' => 'sort_key',
+    '_subtext_key' => 'subtext_key',
+    '_image_key' => 'image_key',
+    '_image_size' => 'image_size',
+    '_singular_name' => 'singular_name',
+    '_singular_key' => 'singular_key',
+    '_disable_add' => 'disable_add',
+    '_icon' => 'icon',
+    '_add_options' => 'add_options'
+  }.freeze
+
+  # Processes Jekyll configuration to enable the plugin and fix common issues
+  class Config
+    def self.rename_legacy_collection_config_keys(collection_config)
+      collection_config&.keys&.each do |k|
+        collection_config[MAPPINGS[k]] = collection_config.delete(k) if MAPPINGS[k]
+      end
+    end
+
+    def initialize(site)
+      @site_config = site.config
+    end
+
+    def read
+      config_defaults(custom_config || config || legacy_config)
+    end
+
+    def custom_config
+      custom_path = ENV['CLOUDCANNON_CONFIG_PATH']
+      return unless custom_path
+
+      loaded = config_file(custom_path)
+      Logger.info("⚙️ No config file found at #{custom_path.bold}") unless loaded
+      loaded
+    end
+
+    def config
+      loaded = config_file('cloudcannon.config.json') ||
+               config_file('cloudcannon.config.yaml') ||
+               config_file('cloudcannon.config.yml')
+
+      unless loaded
+        Logger.info("⚙️ No config file found at #{'cloudcannon.config.(json|yaml|yml)'.bold}")
+      end
+
+      loaded
+    end
+
+    def config_file(path)
+      loaded = YAML.safe_load(File.read(path)) # Also works for JSON
+      Logger.info "⚙️ Using config file at #{path.bold}"
+      loaded
+    rescue Errno::ENOENT
+      nil
+    end
+
+    def config_defaults(config)
+      defaults = {
+        'source' => @site_config['source'].gsub(Dir.pwd, ''),
+        'timezone' => @site_config['timezone'],
+        'base_url' => @site_config['baseurl']
+      }
+
+      defaults.merge(config)
+    end
+
+    def legacy_config
+      Logger.info('⚙️ Falling back to site config'.yellow)
+
+      {
+        'data_config' => @site_config.dig('cloudcannon', 'data'),
+        'collections_config' => legacy_collections_config,
+        'collection_groups' => @site_config['_collection_groups'] || legacy_collection_groups,
+        'editor' => @site_config['_editor'],
+        'source_editor' => @site_config['_source_editor'],
+        'paths' => {
+          'uploads' => @site_config['uploads_dir']
+        },
+        '_select_data' => @site_config['_select_data'] || legacy_select_data,
+        '_inputs' => @site_config['_inputs'],
+        '_editables' => @site_config['_editables'],
+        '_structures' => @site_config['_structures'],
+
+        # Deprecated keys
+        '_array_structures' => @site_config['_array_structures'],
+        '_comments' => @site_config['_comments'],
+        '_enabled_editors' => @site_config['_enabled_editors'],
+        '_instance_values' => @site_config['_instance_values'],
+        '_options' => @site_config['_options']
+      }
+    end
+
+    def legacy_collections_config
+      collections_config = @site_config.dig('cloudcannon', 'collections')
+
+      return unless collections_config
+
+      collections_config.each do |_, collection_config|
+        Config.rename_legacy_collection_config_keys(collection_config)
+      end
+
+      collections_config
+    end
+
+    def legacy_collection_groups
+      @site_config.dig('_explore', 'groups')
+    end
+
+    def legacy_select_data
+      cloudcannon_keys = %w[_comments _options _editor _explore cloudcannon _collection_groups
+                            _enabled_editors _instance_values _source_editor _array_structures
+                            uploads_dir _editables _inputs _structures editor source_editor
+                            collection_groups]
+
+      jekyll_keys = %w[source destination collections_dir cache_dir plugins_dir layouts_dir
+                       data_dir includes_dir collections safe include exclude keep_files encoding
+                       markdown_ext strict_front_matter show_drafts limit_posts future unpublished
+                       whitelist plugins markdown highlighter lsi excerpt_separator incremental
+                       detach port host baseurl show_dir_listing permalink paginate_path timezone
+                       quiet verbose defaults liquid kramdown title url description maruku
+                       redcloth rdiscount redcarpet gems plugins]
+
+      keys = cloudcannon_keys + jekyll_keys
+
+      select_data = @site_config.keys.each_with_object({}) do |key, memo|
+        value = @site_config[key]
+
+        next unless value.is_a?(Array) || value.is_a?(Hash)
+        next if key.nil? || keys.include?(key)
+
+        memo[key] = value
+      end
+
+      compacted = select_data.compact
+      compacted.empty? ? nil : compacted
+    end
+  end
+end