jekyll_outline 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b279fb946cc9cd5d5fc092680a1f28c2af772dc2daa319a4d3c82f4946d5c731
-  data.tar.gz: 0e1f714175edd37e7b06f07f499891d365dbb2ed01d2fe90923a54d6cac613b2
+  metadata.gz: 296c5201e11daec7ec2e91ae703662ba44cfb7ca592da27adf61c23943a3c100
+  data.tar.gz: 246e14ecb99ecf5a7510e7bcbd40eb5cfa58eb8e3cd740f33a726bc7b42cda78
 SHA512:
-  metadata.gz: 4811c7012c0ab9fc504906886a29b4e27d83073f2a079d1cc7e1c9dcdec25acc14da1559e0b940556ba994e2edba45cfb510866c205829d92085a5fd936a02e2
-  data.tar.gz: b79734ebe03d8facc9034e6be26bacf038609f74b9cfca6611297f16f90891f8c12dc9a88c3b6e82d00d8656f4ba24dd33ec2d46ccefa5173fa05f750b061948
+  metadata.gz: a3667c2afb14fb58fb6192149d51265ea54cbb745968ce0a04ba208bbf7a1cf807994a2f2057d38a57759d5679a89ac2a69cd52f829b1e61034c7daea158d02f
+  data.tar.gz: 04e34bcdd95b84affb8b9a73e7a638c9013bc978ba393d11591772a132e4191237c168374fc6d203ce51525945a76350c2f79e6b31f140723f988296678c2585

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 1.2.4 / 2024-07-23
+
+* Updated dependencies to rely on current `jekyll_draft`.
+* Removes any leading whitespace in plugin content so the YAML is more likely to be well-formed.
+* Handles poorly formed whitespace gracefully.
+
+
 ## 1.2.3 / 2024-07-23
 
 * Made compatible with jekyll_plugin_support v1.0.0

data/jekyll_outline.gemspec

@@ -35,6 +35,6 @@ Gem::Specification.new do |spec|
   spec.version = JekyllOutlineVersion::VERSION
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_draft', '>= 1.1.2'
+  spec.add_dependency 'jekyll_draft', '>= 2.0.2'
   spec.add_dependency 'jekyll_plugin_support', '>= 1.0.0'
 end

data/lib/jekyll_outline/version.rb

@@ -1,3 +1,3 @@
 module JekyllOutlineVersion
-  VERSION = '1.2.3'.freeze
+  VERSION = '1.2.4'.freeze
 end

data/lib/jekyll_outline.rb

@@ -1,7 +1,2 @@
 require_relative 'outline_js'
 require_relative 'outline_tag'
-
-module Outline
-  include OutlineTag
-  include OutlineJsTag
-end

data/lib/outline_js.rb

@@ -1,10 +1,10 @@
 require 'jekyll_plugin_support'
 require_relative 'jekyll_outline/version'
 
-module OutlineJsTag
+module JekyllSupport
   PLUGIN_JS_NAME = 'outline_js'.freeze
 
-  class OutlineJsTag < JekyllSupport::JekyllTag
+  class OutlineJsTag < JekyllTag
     include JekyllOutlineVersion
 
     def render_impl
@@ -35,6 +35,6 @@ module OutlineJsTag
         .join("\n")
     end
 
-    ::JekyllSupport::JekyllPluginHelper.register(self, PLUGIN_JS_NAME)
+    JekyllPluginHelper.register(self, PLUGIN_JS_NAME)
   end
 end

data/lib/outline_tag.rb

@@ -33,8 +33,9 @@ require_relative 'jekyll_outline/version'
 #
 # Subclasses, such as jekyll_toc.rb, might generate other output.
 
-module OutlineTag
+module JekyllSupport
   PLUGIN_NAME = 'outline'.freeze
+  OutlineError = JekyllSupport.define_error
 
   # Interleaves with docs
   # Duck type compatible with Jekyll doc
@@ -52,7 +53,7 @@ module OutlineTag
     end
   end
 
-  class OutlineTag < JekyllSupport::JekyllBlock # rubocop:disable Metrics/ClassLength
+  class OutlineTag < JekyllBlock # rubocop:disable Metrics/ClassLength
     include JekyllOutlineVersion
 
     FIXNUM_MAX = (2**((0.size * 8) - 2)) - 1
@@ -64,7 +65,7 @@ module OutlineTag
       @fields  = @helper.parameter_specified?('fields')&.split || ['title']
       @sort_by = @helper.parameter_specified?('sort_by_title') ? 'title' : 'order'
       @collection_name = @helper.remaining_markup
-      abort 'OutlineTag: collection_name was not specified' unless @collection_name
+      raise OutlineError, 'collection_name was not specified' unless @collection_name
 
       @docs = obtain_docs(@collection_name)
       collection = headers + @docs
@@ -90,12 +91,19 @@ module OutlineTag
     end
 
     def make_headers(content)
-      yaml = YAML.safe_load(remove_leading_zeros(content))
+      content = remove_leading_zeros remove_leading_spaces content
+      yaml = YAML.safe_load content
       yaml.map { |entry| Header.new entry }
+    rescue NoMethodError => e
+      raise OutlineError, "Invalid YAML within {% outline %} tag;<br>\nNoMethodError #{e.message}"
+    rescue Psych::SyntaxError => e
+      raise OutlineError, "Invalid YAML within {% outline %} tag;<br>\nPsych::SyntaxError #{e.message}"
+    rescue StandardError => e
+      raise OutlineError, e.message
     end
 
     # @section_state can have values: :head, :in_body
-    # @param collection Array of Jekyll::Document and Outline::Header
+    # @param collection Array of Jekyll::Document and JekyllSupport::Header
     # @return Array of String
     def make_entries(collection)
       sorted = if @sort_by == 'order'
@@ -210,6 +218,14 @@ module OutlineTag
       array
     end
 
+    def remove_leading_spaces(multiline)
+      multiline
+        .strip
+        .split("\n")
+        .map { |x| x.gsub(/\A\s+/, '') }
+        .join("\n")
+    end
+
     def remove_leading_zeros(multiline)
       multiline
         .strip
@@ -218,6 +234,6 @@ module OutlineTag
         .join("\n")
     end
 
-    ::JekyllSupport::JekyllPluginHelper.register(self, PLUGIN_NAME)
+    JekyllPluginHelper.register(self, PLUGIN_NAME)
   end
 end

data/spec/outline_spec.rb

@@ -1,7 +1,7 @@
 require 'jekyll'
 require_relative '../lib/jekyll_outline'
 
-RSpec.describe(Outline) do
+RSpec.describe(OutlineTag) do
   include Jekyll
 
   it 'never works first time', skip: 'Just a placeholder' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_outline
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-26 00:00:00.000000000 Z
+date: 2024-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: jekyll_plugin_support
   requirement: !ruby/object:Gem::Requirement