cloudcannon-jekyll 0.0.8 → 0.3.1

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 = "0.0.8"
+  VERSION = "0.3.1"
 end

data/script/ci-smoke-test

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+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.2.1 bundle update && $(dirname "$0")/test

data/script/cibuild

@@ -2,6 +2,5 @@
 
 set -ex
 
-bundle exec rspec "$@"
-bundle exec rubocop -S
+$(dirname "$0")/test
 bundle exec gem build cloudcannon-jekyll.gemspec

data/script/release

@@ -33,5 +33,7 @@ git fetch -t origin
 
 # Push tag and upload new gem
 
-gem push cloudcannon-jekyll-*.gem && git tag "$tag" &&
-	git push origin master && git push origin "$tag"
+git tag "$tag" &&
+	git push origin master &&
+	git push origin "$tag" &&
+	gem push cloudcannon-jekyll-*.gem

data/script/test

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcannon-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.3.1
 platform: ruby
 authors:
 - CloudCannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -64,28 +78,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.71'
+        version: '0.80'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.71'
+        version: '0.80'
 - !ruby/object:Gem::Dependency
   name: rubocop-jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.11'
 description: Creates CloudCannon editor details for Jekyll
 email:
 - support@cloudcannon.com
@@ -93,7 +107,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/stale.yml"
 - ".gitignore"
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -104,14 +120,21 @@ files:
 - Rakefile
 - cloudcannon-jekyll.gemspec
 - lib/cloudcannon-jekyll.rb
+- lib/cloudcannon-jekyll/_cloudcannon/config-2.x.json
+- lib/cloudcannon-jekyll/_cloudcannon/config-3.0-4.x.json
+- lib/cloudcannon-jekyll/_cloudcannon/config.json
 - lib/cloudcannon-jekyll/_cloudcannon/details-2.x.json
-- lib/cloudcannon-jekyll/_cloudcannon/details-3.0.x.json
+- lib/cloudcannon-jekyll/_cloudcannon/details-3.0-4.x.json
 - lib/cloudcannon-jekyll/_cloudcannon/details.json
 - lib/cloudcannon-jekyll/configuration.rb
 - lib/cloudcannon-jekyll/generator.rb
+- lib/cloudcannon-jekyll/jsonify-filter.rb
 - lib/cloudcannon-jekyll/page-without-a-file.rb
-- lib/cloudcannon-jekyll/safe-jsonify-filter.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
 - script/release
 - script/test
@@ -134,8 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: CloudCannon Jekyll integration

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

@@ -1,24 +0,0 @@
-{
-	"time": {{ site.time | jsonify }},
-	"cloudcannon": {
-		"name": "cloudcannon-jekyll",
-		"version": {{ gem_version | jsonify }}
-	},
-	"generator": {
-		"name": "jekyll",
-		"version": {{ jekyll.version | jsonify }},
-		"environment": {{ jekyll.env | jsonify }},
-		"metadata": {
-			"markdown": {{ site.markdown | cc_safe_jsonify }},
-			"kramdown": {{ site.kramdown | cc_safe_jsonify }},
-			"commonmark": {{ site.commonmark | cc_safe_jsonify }}
-		}
-	},{% if site.cloudcannon.data %}
-	"data": {{ site.data | cc_safe_jsonify }},{% endif %}
-	"collections": {
-		{% for collection in site.collections %}"{{ collection.label | xml_escape }}": {{ collection.docs | cc_safe_jsonify }}{% unless forloop.last %},{% endunless %}
-		{% endfor %}
-	},
-	"pages": {{ site.pages | cc_safe_jsonify }},
-	"static": {{ site.static_files | cc_static_files_jsonify }}
-}

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

@@ -1,170 +0,0 @@
-# frozen_string_literal: true
-
-require "jekyll"
-
-module CloudCannonJekyll
-  module SafeJsonifyFilter
-    @simple_types = [
-      String,
-      Numeric,
-      Integer,
-      Float,
-      Date,
-      Time,
-      NilClass,
-      Object.const_defined?("Fixnum") ? Fixnum : nil,
-    ].compact.freeze
-
-    @document_types = [
-      Jekyll::Document,
-      Jekyll::Page,
-      Jekyll::VERSION.start_with?("2.") ? Jekyll::Post : nil,
-    ].compact.freeze
-
-    def self.document_type?(input)
-      @document_types.include?(input.class)
-    end
-
-    def self.simple_type?(input)
-      @simple_types.include?(input.class) || [true, false].include?(input)
-    end
-
-    def self.static_file_to_json(input, depth)
-      out = [
-        "\"extname\": #{SafeJsonifyFilter.to_json(input.extname, depth + 1)}",
-        "\"path\": #{SafeJsonifyFilter.to_json(input.relative_path, depth + 1)}",
-      ]
-
-      # modified_time isn't defined in Jekyll 2.4.0
-      if input.respond_to? :modified_time
-        out.push("\"modified_time\": #{SafeJsonifyFilter.to_json(input.modified_time, depth + 1)}")
-      end
-
-      "{#{out.join(",")}}"
-    end
-
-    def self.document_data_to_json(data, out, prevent, depth)
-      prevent += %w(content output next previous excerpt)
-
-      data.map do |key, value|
-        unless prevent.include? key
-          out.push("\"#{key}\": #{SafeJsonifyFilter.to_json(value, depth + 1)}")
-          prevent.push(key)
-        end
-      end
-
-      "{#{out.join(",")}}"
-    end
-
-    def self.legacy_post_to_json(input, depth)
-      prevent = %w(dir name path url date id categories tags)
-
-      out = [
-        "\"dir\": #{SafeJsonifyFilter.to_json(input.dir, depth + 1)}",
-        "\"name\": #{SafeJsonifyFilter.to_json(input.name, depth + 1)}",
-        "\"path\": #{SafeJsonifyFilter.to_json(input.path, depth + 1)}",
-        "\"url\": #{SafeJsonifyFilter.to_json(input.url, depth + 1)}",
-        "\"date\": #{SafeJsonifyFilter.to_json(input.date, depth + 1)}",
-        "\"id\": #{SafeJsonifyFilter.to_json(input.id, depth + 1)}",
-        "\"categories\": #{SafeJsonifyFilter.to_json(input.categories, depth + 1)}",
-        "\"tags\": #{SafeJsonifyFilter.to_json(input.tags, depth + 1)}",
-      ]
-
-      SafeJsonifyFilter.document_data_to_json(input.data, out, prevent, depth)
-    end
-
-    def self.page_to_json(input, depth)
-      prevent = %w(dir name path url)
-
-      out = [
-        "\"dir\": #{SafeJsonifyFilter.to_json(input.dir, depth + 1)}",
-        "\"name\": #{SafeJsonifyFilter.to_json(input.name, depth + 1)}",
-        "\"path\": #{SafeJsonifyFilter.to_json(input.path, depth + 1)}",
-        "\"url\": #{SafeJsonifyFilter.to_json(input.url, depth + 1)}",
-      ]
-
-      # Merge Jekyll Defaults into data for pages (missing at v3.8.5)
-      defaults = input.site.frontmatter_defaults.all(input.relative_path, :pages).tap do |h|
-        h.delete("date")
-      end
-
-      data = Jekyll::Utils.deep_merge_hashes(defaults, input.data)
-      SafeJsonifyFilter.document_data_to_json(data, out, prevent, depth)
-    end
-
-    def self.document_to_json(input, depth)
-      prevent = %w(dir id relative_path url collection)
-
-      out = [
-        "\"path\": #{SafeJsonifyFilter.to_json(input.relative_path, depth + 1)}",
-        "\"relative_path\": #{SafeJsonifyFilter.to_json(input.relative_path, depth + 1)}",
-        "\"url\": #{SafeJsonifyFilter.to_json(input.url, depth + 1)}",
-      ]
-
-      unless input.collection.nil?
-        out.push("\"collection\": #{SafeJsonifyFilter.to_json(input.collection.label, depth + 1)}")
-      end
-
-      # id isn't defined in Jekyll 2.4.0
-      out.push("\"id\": #{SafeJsonifyFilter.to_json(input.id, depth + 1)}") if input.respond_to? :id
-
-      SafeJsonifyFilter.document_data_to_json(input.data, out, prevent, depth)
-    end
-
-    def self.array_to_json(input, depth)
-      array = input.map do |value|
-        SafeJsonifyFilter.to_json(value, depth + 1)
-      end
-
-      "[#{array.join(",")}]"
-    end
-
-    def self.hash_to_json(input, depth)
-      hash = input.map do |key, value|
-        "\"#{key}\": #{SafeJsonifyFilter.to_json(value, depth + 1)}"
-      end
-
-      "{#{hash.join(",")}}"
-    end
-
-    def self.to_json(input, depth)
-      if depth > 8 || (depth > 2 && SafeJsonifyFilter.document_type?(input))
-        '"MAXIMUM_DEPTH"'
-      elsif SafeJsonifyFilter.simple_type?(input)
-        input.to_json
-      elsif input.is_a?(Jekyll::StaticFile)
-        SafeJsonifyFilter.static_file_to_json(input, depth)
-      elsif input.is_a?(Jekyll::Page)
-        SafeJsonifyFilter.page_to_json(input, depth)
-      elsif Jekyll::VERSION.start_with?("2.") && input.is_a?(Jekyll::Post)
-        SafeJsonifyFilter.legacy_post_to_json(input, depth)
-      elsif input.is_a?(Jekyll::Document)
-        SafeJsonifyFilter.document_to_json(input, depth)
-      elsif input.is_a?(Array)
-        SafeJsonifyFilter.array_to_json(input, depth)
-      elsif input.is_a?(Hash)
-        SafeJsonifyFilter.hash_to_json(input, depth)
-      else
-        "\"UNSUPPORTED:#{input.class}\""
-      end
-    end
-
-    def cc_static_files_jsonify(input)
-      out = []
-      input.each do |page|
-        next if page.extname != ".html" &&
-          page.extname != ".htm" &&
-          page.path != "/robots.txt" &&
-          page.path != "/sitemap.xml"
-
-        out.push(SafeJsonifyFilter.to_json(page, 1))
-      end
-
-      "[#{out.join(",")}]"
-    end
-
-    def cc_safe_jsonify(input)
-      SafeJsonifyFilter.to_json(input, 0)
-    end
-  end
-end