cloudcannon-jekyll 0.1.0 → 0.3.2

data/lib/cloudcannon-jekyll/page-without-a-file.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module CloudCannonJekyll
+  # Utility class to help generate files with no source file
   class PageWithoutAFile < Jekyll::Page
     def read_yaml(*)
       @data ||= {}

data/lib/cloudcannon-jekyll/reader.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+begin
+  require_relative "readers/data-reader"
+rescue NameError
+  require_relative "readers/old-data-reader"
+end
+
+module CloudCannonJekyll
+  # Wraps read functions into one class
+  class Reader
+    attr_reader :site
+
+    def initialize(site)
+      @site = site
+    end
+
+    def read_data(dir = "_data")
+      CloudCannonJekyll::DataReader.new(@site).read(dir)
+    rescue NameError # DataReader doesn't exist in old versions of Jekyll
+      CloudCannonJekyll::OldDataReader.new(@site).read(dir)
+    end
+
+    def read_drafts(dir = "")
+      Jekyll::PostReader.new(@site).read_drafts(dir)
+    rescue NameError # PostReader doesn't exist in old versions of Jekyll
+      @site.read_content(dir, "_drafts", Jekyll::Draft)
+    end
+
+    def read_posts(dir = "")
+      Jekyll::PostReader.new(@site).read_posts(dir)
+    rescue NameError # PostReader doesn't exist in old versions of Jekyll
+      @site.read_content(dir, "_posts", Jekyll::Post)
+    end
+  end
+end

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.1.0"
+  VERSION = "0.3.2"
 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/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.1.0
+  version: 0.3.2
 platform: ruby
 authors:
 - CloudCannon
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2020-12-07 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
@@ -86,20 +100,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-- !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
 description: Creates CloudCannon editor details for Jekyll
 email:
 - support@cloudcannon.com
@@ -107,7 +107,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/stale.yml"
 - ".gitignore"
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -126,9 +128,13 @@ files:
 - 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
@@ -136,7 +142,7 @@ homepage: https://github.com/cloudcannon/cloudcannon-jekyll
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -151,9 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: CloudCannon Jekyll integration
 test_files: []

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

@@ -1,210 +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.each { |key, value|
-        next if prevent.include? key
-        prevent.push key
-        out.push("#{key.to_json}: #{SafeJsonifyFilter.to_json(value, depth + 1)}")
-      }
-
-      "{#{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.to_json}: #{SafeJsonifyFilter.to_json(value, depth + 1)}"
-      end
-
-      "{#{hash.join(",")}}"
-    end
-
-    def self.site_drop_legacy_select_data_to_json(input, depth)
-      prevent = %w(config time related_posts destination cache_dir safe
-        keep_files encoding markdown_ext strict_front_matter show_drafts
-        limit_posts future unpublished whitelist maruku markdown highlighter
-        lsi excerpt_separator incremental detach port host show_dir_listing
-        permalink paginate_path quiet verbose defaults liquid kramdown title
-        url description categories data tags static_files html_pages pages
-        documents posts related_posts time source timezone include exclude
-        baseurl collections _comments _editor _source_editor _explore
-        uploads_dir plugins_dir data_dir collections_dir includes_dir
-        layouts_dir _array_structures cloudcannon rdiscount redcarpet redcloth)
-
-      if Jekyll::VERSION.start_with?("2.")
-        prevent = prevent.concat input["collections"].keys
-        prevent.push "gems"
-      elsif Jekyll::VERSION.match?(%r!3\.[0-4]\.!)
-        prevent = prevent.concat input["collections"].map { |c| c["label"] }
-        prevent = prevent.concat %w(plugins gems)
-      else
-        prevent.push "plugins"
-      end
-
-      out = input.map { |key, value|
-        next unless value.is_a?(Array) || value.is_a?(Hash)
-        next if prevent.include? key
-        prevent.push key
-
-        "#{key.to_json}: #{SafeJsonifyFilter.to_json(value, depth + 1)}"
-      }.compact
-
-      "{#{out.join(",")}}" if out.any?
-    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.to_json}\""
-      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_site_select_data_jsonify(input)
-      if input.key? "_select_data"
-        SafeJsonifyFilter.to_json(input["_select_data"], 0)
-      else
-        SafeJsonifyFilter.site_drop_legacy_select_data_to_json(input, 0)
-      end
-    end
-
-    def cc_safe_jsonify(input)
-      SafeJsonifyFilter.to_json(input, 0)
-    end
-  end
-end