cloudcannon-jekyll 2.3.4 → 3.0.0

data/lib/cloudcannon-jekyll/generators/paths.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+
+module CloudCannonJekyll
+  # Helper functions for generating paths
+  module Paths
+    def self.collections_dir(site)
+      return '' if Jekyll::VERSION.start_with? '2.'
+
+      site.config['collections_dir']&.sub(%r{^/+}, '') || ''
+    end
+
+    def self.data_dir(site)
+      site.config['data_dir']&.sub(%r{^/+}, '') || '_data'
+    end
+  end
+end

data/lib/cloudcannon-jekyll/logger.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+
+module CloudCannonJekyll
+  # Logging helpers
+  class Logger
+    def self.info(str)
+      Jekyll.logger.info('CloudCannon:', str)
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-unless Jekyll::VERSION.start_with? "2."
-  require "jekyll"
+unless Jekyll::VERSION.start_with? '2.'
+  require 'jekyll'
 
   module CloudCannonJekyll
     # Reads data files and creates a collections-style hash representation
@@ -12,7 +12,7 @@ unless Jekyll::VERSION.start_with? "2."
       # Returns a hash with the path to the data file.
       def read_data_file(path)
         {
-          "path" => path,
+          'path' => path
         }
       end
     end

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

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-if Jekyll::VERSION.start_with? "2."
-  require "jekyll"
+if Jekyll::VERSION.start_with? '2.'
+  require 'jekyll'
+  require 'fileutils'
 
   module CloudCannonJekyll
     # Reads data files and creates a collections-style hash representation
@@ -25,14 +26,16 @@ if Jekyll::VERSION.start_with? "2."
         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) }
+          Dir['*.{yaml,yml,json,csv}'] + Dir['*'].select do |fn|
+            File.directory?(fn)
+          end
         end
 
         entries.each do |entry|
           path = Jekyll.sanitized_path(dir, entry)
           next if File.symlink?(path) && @safe
 
-          key = sanitize_filename(File.basename(entry, ".*"))
+          key = sanitize_filename(File.basename(entry, '.*'))
           if File.directory?(path)
             read_data_to(path, data[key] = {})
           else
@@ -43,14 +46,14 @@ if Jekyll::VERSION.start_with? "2."
 
       def read_data_file(path)
         {
-          "path" => 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+!, "_")
+        name.gsub!(/[^\w\s_-]+/, '')
+        name.gsub!(/(^|\b\s)\s+($|\s?\b)/, '\\1\\2')
+        name.gsub(/\s+/, '_')
       end
     end
   end

data/lib/cloudcannon-jekyll/{reader.rb → readers/reader.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "jekyll"
-require_relative "readers/old-data-reader"
-require_relative "readers/data-reader"
+require 'jekyll'
+require_relative 'old-data-reader'
+require_relative 'data-reader'
 
 module CloudCannonJekyll
   # Wraps read functions into one class
@@ -13,28 +13,28 @@ module CloudCannonJekyll
       @site = site
     end
 
-    def read_data(dir = "_data")
+    def read_data(dir = '_data')
       # DataReader doesn't exist in old versions of Jekyll
-      if Jekyll::VERSION.start_with? "2."
+      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 = "")
+    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)
+      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 = "")
+    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)
+      if Jekyll::VERSION.start_with? '2.'
+        @site.read_content(dir, '_posts', Jekyll::Post)
       else
         Jekyll::PostReader.new(@site).read_posts(dir)
       end

data/lib/cloudcannon-jekyll/{configuration.rb → setup.rb}

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require 'jekyll'
+
 module CloudCannonJekyll
-  # Processes Jekyll configuration to enable the plugin is run and fix common issues
-  class Configuration
+  # Processes Jekyll configuration to enable the plugin and fix common issues
+  class Setup
     def self.processed?(site)
       site.instance_variable_get(:@_cloudcannon_jekyll_processed) == true
     end
@@ -17,10 +19,11 @@ 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"
+      config[key].push('cloudcannon-jekyll') unless config[key].include? 'cloudcannon-jekyll'
+
       config
     end
 

data/lib/cloudcannon-jekyll/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CloudCannonJekyll
-  VERSION = "2.3.4"
+  VERSION = '3.0.0'
 end

data/lib/cloudcannon-jekyll.rb

@@ -1,29 +1,24 @@
 # frozen_string_literal: true
 
-require "jekyll"
+require 'jekyll'
+require_relative 'cloudcannon-jekyll/generator'
+require_relative 'cloudcannon-jekyll/setup'
+require_relative 'cloudcannon-jekyll/version'
 
-require_relative "cloudcannon-jekyll/page-without-a-file"
-require_relative "cloudcannon-jekyll/generator"
-require_relative "cloudcannon-jekyll/configuration"
-require_relative "cloudcannon-jekyll/jsonify-filter"
-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
-      alias_method :jekyll_reset, :reset
+      alias jekyll_reset reset
 
       def reset
         jekyll_reset
-        CloudCannonJekyll::Configuration.set(self)
+        CloudCannonJekyll::Setup.set(self)
       end
     end
   end
 else
   Jekyll::Hooks.register :site, :after_reset do |site|
-    CloudCannonJekyll::Configuration.set(site)
+    CloudCannonJekyll::Setup.set(site)
   end
 end

data/script/lint

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -ex
+
+bundle exec rubocop -S

data/script/test

@@ -3,4 +3,3 @@
 set -ex
 
 bundle exec rspec "$@"
-bundle exec rubocop -S

data/script/{ci-smoke-test → test-all-versions}

@@ -2,10 +2,8 @@
 
 set -ex
 
-# Checks to see the build is likely to fail on Travis.
-# Duplicated the versions from .travis.yml
-
 JEKYLL_VERSION=2.4.0 bundle update && $(dirname "$0")/test &&
 JEKYLL_VERSION=3.0.0 bundle update && $(dirname "$0")/test &&
 JEKYLL_VERSION=3.8.5 bundle update && $(dirname "$0")/test &&
-JEKYLL_VERSION=4.2.0 bundle update && $(dirname "$0")/test
+JEKYLL_VERSION=4.2.1 bundle update && $(dirname "$0")/test
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 3.0.0
 platform: ruby
 authors:
 - CloudCannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2021-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.4.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,23 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.4.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: json_schemer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.13
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.13
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.80'
-- !ruby/object:Gem::Dependency
-  name: rubocop-jekyll
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
 description: Creates CloudCannon editor details for Jekyll
 email:
 - support@cloudcannon.com
@@ -112,7 +78,6 @@ files:
 - ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - HISTORY.md
 - LICENSE.txt
@@ -120,21 +85,22 @@ files:
 - Rakefile
 - cloudcannon-jekyll.gemspec
 - lib/cloudcannon-jekyll.rb
-- lib/cloudcannon-jekyll/_cloudcannon/info-2.x.json
-- lib/cloudcannon-jekyll/_cloudcannon/info-3.0-4.x.json
-- lib/cloudcannon-jekyll/_cloudcannon/info.json
-- lib/cloudcannon-jekyll/configuration.rb
+- lib/cloudcannon-jekyll/config.rb
 - 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/generators/collections.rb
+- lib/cloudcannon-jekyll/generators/data.rb
+- lib/cloudcannon-jekyll/generators/info.rb
+- lib/cloudcannon-jekyll/generators/paths.rb
+- lib/cloudcannon-jekyll/logger.rb
 - lib/cloudcannon-jekyll/readers/data-reader.rb
 - lib/cloudcannon-jekyll/readers/old-data-reader.rb
+- lib/cloudcannon-jekyll/readers/reader.rb
+- lib/cloudcannon-jekyll/setup.rb
 - lib/cloudcannon-jekyll/version.rb
-- script/ci-smoke-test
-- script/cibuild
+- script/lint
 - script/release
 - script/test
+- script/test-all-versions
 homepage: https://github.com/cloudcannon/cloudcannon-jekyll
 licenses:
 - MIT

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.6
-
-before_install:
-  - gem update --system
-  - gem install bundler
-
-script: script/cibuild
-
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-  matrix:
-    - JEKYLL_VERSION="2.4.0"
-    - JEKYLL_VERSION="3.0.0"
-    - JEKYLL_VERSION="3.8.5"
-    - JEKYLL_VERSION="4.2.0"

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

@@ -1,83 +0,0 @@
-{
-	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
-	"cloudcannon": {
-		"name": "cloudcannon-jekyll",
-		"version": {{ gem_version | cc_jsonify }}
-	},
-	"generator": {
-		"name": "jekyll",
-		"version": {{ jekyll.version | cc_jsonify }},
-		"environment": {{ jekyll.env | cc_jsonify }},
-		"metadata": {
-			"markdown": {{ site.markdown | cc_jsonify }},
-			"kramdown": {{ site.kramdown | cc_jsonify }},
-			"commonmark": {{ site.commonmark | cc_jsonify }}
-		}
-	},
-	{% if config.timezone %}
-		"timezone": {{ config.timezone | cc_jsonify }},
-	{% endif %}
-	"collections-config": {{ collections_config | cc_jsonify }},
-	"collections": {
-		{% for collection in collections %}"{{ collection[0] | xml_escape }}": {{ collection[1] | cc_jsonify }}{% unless forloop.last %},{% endunless %}
-		{% endfor %}
-	},
-	"data": {{ data | cc_jsonify }},
-	{% if config.baseurl %}
-		"base-url": {{ config.baseurl | cc_jsonify }},
-	{% endif %}
-	{% if config._comments %}
-		"_comments": {{ config._comments | cc_jsonify }},
-	{% endif %}
-	{% 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 %}
-	{% if config._inputs %}
-		"_inputs": {{ config._inputs | cc_jsonify }},
-	{% endif %}
-	{% if config._editables %}
-		"_editables": {{ config._editables | cc_jsonify }},
-	{% endif %}
-	{% if config._collection_groups %}
-		"_collection_groups": {{ config._collection_groups | cc_jsonify }},
-	{% endif %}
-	{% if config._editor %}
-		"_editor": {
-			"default_path": {{ config._editor.default_path | cc_jsonify }}
-		},
-	{% endif %}
-	{% if config._source_editor %}
-		"_source_editor": {
-			"tab_size": {{ config._source_editor.tab_size | cc_jsonify }},
-			"show_gutter": {{ config._source_editor.show_gutter | cc_jsonify }},
-			"theme": {{ config._source_editor.theme | cc_jsonify }}
-		},
-	{% endif %}
-	"paths": {
-		"static": "",
-		"uploads": {{ config.uploads_dir | cc_jsonify }},
-		"data": {{ config.data_dir | cc_jsonify }},
-		"collections": {{ config.collections_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 %}
-	{% assign select_data = config | cc_select_data_jsonify %}
-	{% if select_data %}
-		"_select_data": {{ select_data }},
-	{% endif %}
-	{% if config.defaults %}
-		"defaults": {{ config.defaults | cc_jsonify }},
-	{% endif %}
-	"source": {{ config.source | replace: pwd, "" | cc_jsonify }}
-}

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

@@ -1,83 +0,0 @@
-{
-	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
-	"cloudcannon": {
-		"name": "cloudcannon-jekyll",
-		"version": {{ gem_version | cc_jsonify }}
-	},
-	"generator": {
-		"name": "jekyll",
-		"version": {{ jekyll.version | cc_jsonify }},
-		"environment": {{ jekyll.env | cc_jsonify }},
-		"metadata": {
-			"markdown": {{ site.markdown | cc_jsonify }},
-			"kramdown": {{ site.kramdown | cc_jsonify }},
-			"commonmark": {{ site.commonmark | cc_jsonify }}
-		}
-	},
-	{% if config.timezone %}
-		"timezone": {{ config.timezone | cc_jsonify }},
-	{% endif %}
-	"collections-config": {{ collections_config | cc_jsonify }},
-	"collections": {
-		{% for collection in collections %}"{{ collection[0] | xml_escape }}": {{ collection[1] | cc_jsonify }}{% unless forloop.last %},{% endunless %}
-		{% endfor %}
-	},
-	"data": {{ data | cc_jsonify }},
-	{% if config.baseurl %}
-		"base-url": {{ config.baseurl | cc_jsonify }},
-	{% endif %}
-	{% if config._comments %}
-		"_comments": {{ config._comments | cc_jsonify }},
-	{% endif %}
-	{% 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 %}
-	{% if config._inputs %}
-		"_inputs": {{ config._inputs | cc_jsonify }},
-	{% endif %}
-	{% if config._editables %}
-		"_editables": {{ config._editables | cc_jsonify }},
-	{% endif %}
-	{% if config._collection_groups %}
-		"_collection_groups": {{ config._collection_groups | cc_jsonify }},
-	{% endif %}
-	{% if config._editor %}
-		"_editor": {
-			"default_path": {{ config._editor.default_path | cc_jsonify }}
-		},
-	{% endif %}
-	{% if config._source_editor %}
-		"_source_editor": {
-			"tab_size": {{ config._source_editor.tab_size | cc_jsonify }},
-			"show_gutter": {{ config._source_editor.show_gutter | cc_jsonify }},
-			"theme": {{ config._source_editor.theme | cc_jsonify }}
-		},
-	{% endif %}
-	"paths": {
-		"static": "",
-		"uploads": {{ config.uploads_dir | cc_jsonify }},
-		"data": {{ config.data_dir | cc_jsonify }},
-		"collections": {{ config.collections_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 %}
-	{% assign select_data = config | cc_select_data_jsonify %}
-	{% if select_data %}
-		"_select_data": {{ select_data }},
-	{% endif %}
-	{% if config.defaults %}
-		"defaults": {{ config.defaults | cc_jsonify }},
-	{% endif %}
-	"source": {{ config.source | replace: pwd, "" | cc_jsonify }}
-}

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

@@ -1,86 +0,0 @@
-{
-	"time": {{ site.time | date_to_xmlschema | cc_jsonify }},
-	"version": {{ version | cc_jsonify }},
-	"cloudcannon": {
-		"name": "cloudcannon-jekyll",
-		"version": {{ gem_version | cc_jsonify }}
-	},
-	"generator": {
-		"name": "jekyll",
-		"version": {{ jekyll.version | cc_jsonify }},
-		"environment": {{ jekyll.env | cc_jsonify }},
-		"metadata": {
-			"markdown": {{ site.markdown | cc_jsonify }},
-			"kramdown": {{ site.kramdown | cc_jsonify }},
-			"commonmark": {{ site.commonmark | cc_jsonify }}
-		}
-	},
-	{% if config.timezone -%}
-		"timezone": {{ config.timezone | cc_jsonify }},
-	{%- endif %}
-	"collections-config": {{ collections_config | cc_jsonify }},
-	"collections": {
-		{%- for collection in collections -%}
-			"{{ collection[0] | xml_escape }}": {{ collection[1] | cc_jsonify }}
-			{%- unless forloop.last %},{% endunless %}
-		{%- endfor -%}
-	},
-	"data": {{ data | cc_jsonify }},
-	{% if config.baseurl -%}
-		"base-url": {{ config.baseurl | cc_jsonify }},
-	{%- endif %}
-	{% if config._comments -%}
-		"_comments": {{ config._comments | cc_jsonify }},
-	{%- endif %}
-	{% 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 %}
-	{% if config._inputs -%}
-		"_inputs": {{ config._inputs | cc_jsonify }},
-	{%- endif %}
-	{% if config._editables -%}
-		"_editables": {{ config._editables | cc_jsonify }},
-	{%- endif %}
-	{% if config._collection_groups -%}
-		"_collection_groups": {{ config._collection_groups | cc_jsonify }},
-	{%- endif %}
-	{% if config._editor -%}
-		"_editor": {
-			"default_path": {{ config._editor.default_path | cc_jsonify }}
-		},
-	{%- endif %}
-	{% if config._source_editor -%}
-		"_source_editor": {
-			"tab_size": {{ config._source_editor.tab_size | cc_jsonify }},
-			"show_gutter": {{ config._source_editor.show_gutter | cc_jsonify }},
-			"theme": {{ config._source_editor.theme | cc_jsonify }}
-		},
-	{%- endif %}
-	"paths": {
-		"static": "",
-		"uploads": {{ config.uploads_dir | cc_jsonify }},
-		"data": {{ config.data_dir | cc_jsonify }},
-		"collections": {{ config.collections_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 %}
-	{% assign select_data = config | cc_select_data_jsonify -%}
-	{% if select_data -%}
-		"_select_data": {{ select_data }},
-	{%- endif %}
-	{% if config.defaults -%}
-		"defaults": {{ config.defaults | cc_jsonify }},
-	{%- endif %}
-	"source": {{ config.source | replace: pwd, "" | cc_jsonify }}
-}