jekyll_flexible_include 2.0.22 → 2.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a510c3980d0d804087271c3508dc35e7986783db434d4ee8c15dd0e0ccb6bd0
-  data.tar.gz: e8e0f13c44c64bd4098372a9d7a8651341e9879e4dc9e602f23d99ec0020419b
+  metadata.gz: e55df13c1d72abd77ed8e3c3c38b9b90948421f88b42a069a067df044aae6fe7
+  data.tar.gz: 366f8ca463a84047d0e8ccfc6c4a861ee1516318ce6f5eb715d6feb4e0267947
 SHA512:
-  metadata.gz: 8f7e88a3d0537fd18e41f921f577fa016a2cd2fecf49609c32ccc1fd9be4f78296b760f8316f4ae3836f2edb6813183a26cedfabb69b244b8c26eed610a6aef2
-  data.tar.gz: c774673d92470e3355f3c22fe69c31186a9c57b5919f0f070706fb5a10ea6b5506f9ed39be6cc10fa85e9f74abac4eda869facda90676005618e99e2b8802f0b
+  metadata.gz: b4dd897174369c3e5bf440d97eb95c0870b6566f10de91a9028c37ad8a5a3c7a9c62f675e2431d00a540511465dd4d849d2dd4a87952cff61a08d44b0886c57d
+  data.tar.gz: 22591d355535172b074c52f7522ebbbbda39a1c94d6e0107c1bd08b7fe85d051cc04cf3160092fb82e5e90cb020bfd225cb4963006b979c8ae9571598b7386c4

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 2.0.24 / 2024-00-20
+
+* Made compatible with `jekyll_plugin_support` v1.0.2
+
+
+## 2.0.23 / 2024-07-22
+
+* Made compatible with `jekyll_plugin_support` v1.0.0
+
+
 ## 2.0.22 / 2024-02-27
 
 * Improved error reporting

data/jekyll_flexible_include_plugin.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.version = JekyllFlexibleIncludePluginVersion::VERSION
 
   spec.add_dependency 'jekyll_from_to_until'
-  spec.add_dependency 'jekyll_plugin_support', '>= 0.8.4'
+  spec.add_dependency 'jekyll_plugin_support', '>= 1.0.3'
   spec.add_dependency 'jekyll-sass-converter', '= 2.2.0'
   spec.add_dependency 'rugged'
 end

data/lib/flexible_include/version.rb

@@ -1,3 +1,3 @@
 module JekyllFlexibleIncludePluginVersion
-  VERSION = '2.0.22'.freeze
+  VERSION = '2.0.24'.freeze
 end

data/lib/flexible_include.rb

@@ -12,6 +12,8 @@ class String
 end
 
 module FlexibleInclude
+  include FlexiblePrivateMethods
+
   FlexibleIncludeError = JekyllSupport.define_error
 
   PLUGIN_NAME = 'flexible_include'.freeze
@@ -23,39 +25,42 @@ module FlexibleInclude
       include FlexibleClassMethods
     end
 
+    def html_message(error)
+      <<~END_MSG
+        <div class='#{error.class.name.snakecase}'>
+          #{self.class} raised in #{calling_file} while processing line #{line_number} (after front matter) of #{path}
+          #{message}
+        </div>
+      END_MSG
+    end
+
     def render_impl
       setup
-      @path = JekyllPluginHelper.expand_env @filename, @logger
+      @path = ::JekyllSupport::JekyllPluginHelper.expand_env @filename, @logger
       handle_path_types
       render_completion
     rescue Errno::EACCES => e
       e.shorten_backtrace
-      msg = format_error_message e.message
-      @logger.error msg
-
-      if @die_on_file_error
-        e2 = Errno::EACCES.new msg
-        e2.set_backtrace e.backtrace
-        raise e2
-      end
+      @logger.error { "#{e.class.name}: #{e.message}" }
+      exit! 1 if @die_on_file_error
 
-      "<div class='custom_error'>#{e.class} raised in #{self.class};\n#{msg}</div>"
+      html_message
     rescue Errno::ENOENT => e
       e.shorten_backtrace
-      msg = format_error_message e.message
-      @logger.error msg
+      @logger.error { "#{e.class.name}: #{e.message}" }
+      exit! 1 if @die_on_path_denied
 
-      if @die_on_path_denied
-        e2 = Errno::ENOENT.new msg
-        e2.set_backtrace e.backtrace
-        raise e2
-      end
-
-      "<div class='custom_error'>#{e.class} raised in #{self.class};\n#{msg}</div>"
+      html_message
     rescue FlexibleIncludeError => e
-      e.shorten_backtrace
-      @logger.error e.message
-      raise e
+      @logger.error { e.logger_message }
+      exit! if @die_on_other_error
+
+      html_message
+      # rescue StandardError => e
+      #   @logger.error { e.full_message }
+      #   exit! 4
+
+      #   html_message
     end
 
     private
@@ -89,7 +94,7 @@ module FlexibleInclude
                         "of #{@page['name']} denied by DISABLE_FLEXIBLE_INCLUDE value.")
         end
 
-        @filename = JekyllPluginHelper.remove_quotes(@helper.argv.first) if @helper.argv.first
+        @filename = ::JekyllSupport::JekyllPluginHelper.remove_quotes(@helper.argv.first) if @helper.argv.first
         @filename = @filename.delete_prefix '!'
         @contents = run(@filename)
       else # Relative path
@@ -99,6 +104,6 @@ module FlexibleInclude
       end
     end
 
-    JekyllPluginHelper.register(self, 'flexible_include')
+    ::JekyllSupport::JekyllPluginHelper.register(self, 'flexible_include')
   end
 end

data/lib/flexible_include_class.rb

@@ -14,8 +14,8 @@ module FlexibleInclude
     end
 
     def normalize_path(path)
-      JekyllPluginHelper.expand_env(path, die_if_undefined: true)
-                        .gsub('~', Dir.home)
+      ::JekyllSupport::JekyllPluginHelper.expand_env(path, die_if_undefined: true)
+                                         .gsub('~', Dir.home)
     end
 
     def number_content(content)

data/lib/flexible_include_private_methods.rb

@@ -1,12 +1,14 @@
 require 'pathname'
 require 'English'
+require 'facets/string/camelcase'
+require 'facets/string/snakecase'
 require 'jekyll_from_to_until'
 
 module FlexibleInclude
   module FlexiblePrivateMethods
     def denied(msg)
       msg_no_html = remove_html_tags(msg)
-      @logger.error("#{@page['path']} - #{msg_no_html}")
+      @logger.error { "#{@page['path']} - #{msg_no_html}" }
       raise FlexibleIncludeError, "#{@page['path']} - #{msg_no_html}".red, [] if @die_on_path_denied
 
       "<p class='flexible_error'>#{msg}</p>"
@@ -19,9 +21,8 @@ module FlexibleInclude
     end
 
     def maybe_raise_error(msg, throw_error: true)
-      fmsg = format_error_message msg
-      @logger.error fmsg
-      return "<span class='flexible_error'>#{fmsg}</span>" unless throw_error
+      @logger.error { msg }
+      return "<span class='flexible_error'>#{msg}</span>" unless throw_error
 
       raise FlexibleIncludeError, msg, []
     end
@@ -61,16 +62,28 @@ module FlexibleInclude
     end
 
     def render_completion
-      unless @path.start_with? '!'
-        maybe_raise_error("#{@path} does not exist",  throw_error: @die_on_file_error) unless File.exist? @path
-        maybe_raise_error("#{@path} is not readable", throw_error: @die_on_file_error) unless Pathname.new(@path).readable?
+      unless @path.start_with?('!')
+        unless File.exist?(@path) && Dir.exist?(File.dirname(@path))
+          return maybe_raise_error(
+            "#{@path} does not exist, referenced on line #{@line_number} (after front matter) of #{@page['path']}",
+            throw_error: @die_on_file_error
+          )
+        end
+
+        unless Pathname.new(@path).readable?
+          return maybe_raise_error(
+            "#{@path} is not readable, referenced on line #{@line_number} (after front matter) of #{@page['path']}",
+            throw_error: @die_on_file_error
+          )
+        end
 
         @contents = File.read @path
         unless @contents.instance_of? String
-          maybe_raise_error("contents has type a #{@contents.class}, not a String",
+          maybe_raise_error("contents has type #{@contents.class}, not a String",
                             throw_error: @die_on_file_error)
         end
       end
+
       @contents = FromToUntil.from(@contents, @from) if @from
       @contents = FromToUntil.to(@contents, @to) if @to
       @contents = FromToUntil.until(@contents, @until) if @until
@@ -96,8 +109,11 @@ module FlexibleInclude
       @logger.debug { "Executing #{cmd}" }
       %x[#{cmd}].chomp
     rescue FlexibleIncludeError => e
-      raise e
-    rescue StandardError => e
+      @logger.error { e.logger_message }
+      exit! 1 if @die_on_any_flexible_include_error
+
+      e.html_message
+    rescue StandardError => e # Assumes the wasa the result of running a command; this might not be a valid assumption. Awaiting a bug report.
       @do_not_escape = true
       e = e.exception "'#{e.message}' while executing '#{cmd}'"
       maybe_reraise_error(e, throw_error: @die_on_run_error)
@@ -113,6 +129,7 @@ module FlexibleInclude
         @die_on_other_error = config['die_on_other_error'] == true
         @die_on_path_denied = config['die_on_path_denied'] == true
         @die_on_run_error   = config['die_on_run_error'] == true
+        @die_on_any_flexible_include_error = @die_on_file_error || @die_on_other_error || @die_on_path_denied || @die_on_run_error
       end
 
       parse_args

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_flexible_include
 version: !ruby/object:Gem::Version
-  version: 2.0.22
+  version: 2.0.24
 platform: ruby
 authors:
 - Mike Slinn
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2024-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll_from_to_until
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: jekyll-sass-converter
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Jekyll plugin supports various ways to include content into the generated