jekyll_flexible_include 2.0.23 → 2.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2bbd3d775f087cefca7f18e68966dc58afb1b19099154b7e56dce5fba9b6f25
-  data.tar.gz: '065912548161e1cce5d139566f370cabe68ad0521e87e7dd50f424e3a8e958f0'
+  metadata.gz: c1c41e1810d12f5452b662944c1903eff7b04d944497ce8565e9bd0f7cf42902
+  data.tar.gz: b5b8592e381e6e5b494018e340cc5e59c8f4422195e719c5c60e9e7252ca37f3
 SHA512:
-  metadata.gz: 6c965faec3f89eb9d005dc2ad7fea3847f77d716039b9f903f8f84ea20e49ba991f016664013826d0fb4e044203a7ae82338aca7b1b7a699a8d1e59ae18f4f62
-  data.tar.gz: b4fb7d8c8b0afddef8f0c5d359b5bbe7077ae4418b38641e6f52dd537005a75c7a47a2eb371ea3de24cc4269295e423f8ff8a3b1c719e2f8b8c862f9ed4f8b20
+  metadata.gz: 7b49278506aa5230d915bd2bd919c94e5fa111cf1c5414ae0b1cf4d961e12a510b4b22904b50e9bb21b596784cea498a0f982a90c4a443db9fa0b5817cb00fae
+  data.tar.gz: 3bd38e8915a07260bd17d8eab24c35671b1c7067e9d556cb1b76b9fd75c6c11e471e434f1177cd5dd4b40553bc0fd6addfe19de28ce4cd69d179b599b658d4c2

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 2.0.25 / 2024-12-11
+
+* Fixed `from` / `to` / `until` issue
+
+
+## 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

data/README.md

@@ -185,6 +185,8 @@ and a red error message will be logged on the console that says something like:
 
 ## Installation
 
+### Gem
+
 1. Add the following to `Gemfile`, inside the `jekyll_plugins` group:
 
    ```ruby
@@ -213,6 +215,36 @@ and a red error message will be logged on the console that says something like:
    $ bundle
    ```
 
+### CSS and Assets
+
+Copy assets and CSS from the demo/ directory of the jekyll_pre GitHub project.
+
+- Copy `demo/assets/images/clippy.svg` to a directory of the same name in your Jekyll project.
+- Copy `demo/assets/css/jekyll_plugin_support.css` to your Jekyll project assets directory.
+- Copy `demo/assets/css/shared_include_pre.css` to your Jekyll project assets directory.
+- Copy `demo/assets/css/jekyll_flexible_include.css` to your Jekyll project assets directory.
+- Incorporate the CSS stylesheets into the appropriate layout in your Jekyll project:
+
+```html
+{% assign nowMillis = site.time | date: '%s' %}
+<link rel="stylesheet" href="{{ '/assets/css/jekyll_plugin_support.css?v=' | append: nowMillis }}" type="text/css">
+<link rel="stylesheet" href="{{ '/assets/css/shared_include_pre.css?v=' | append: nowMillis }}" type="text/css">
+<link rel="stylesheet" href="{{ '/assets/css/jekyll_flexible_include.css?v=' | append: nowMillis }}" type="text/css">
+```
+
+
+### JavaScript
+
+Copy `demo/assets/js/clipboard.min.js` from the `jekyll_flexible_include_plugin` GitHub project
+to your Jekyll project’s JavaScript directory.
+
+Modify the Jekyll layout or selected pages to load the JavaScript.
+You can load it from your project, as shown below, or from a CDN.
+
+```html
+<script defer src="/assets/js/clipboard.min.js"></script>
+```
+
 
 ## Examples
 

data/jekyll_flexible_include_plugin.gemspec

@@ -35,8 +35,8 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
   spec.version = JekyllFlexibleIncludePluginVersion::VERSION
 
-  spec.add_dependency 'jekyll_from_to_until'
-  spec.add_dependency 'jekyll_plugin_support', '>= 1.0.0'
+  spec.add_dependency 'jekyll_from_to_until', '>= 1.0.5'
+  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.23'.freeze
+  VERSION = '2.0.25'.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,6 +25,15 @@ 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 = ::JekyllSupport::JekyllPluginHelper.expand_env @filename, @logger
@@ -30,32 +41,26 @@ module FlexibleInclude
       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

data/lib/flexible_include_private_methods.rb

@@ -1,12 +1,16 @@
 require 'pathname'
 require 'English'
+require 'facets/string/camelcase'
+require 'facets/string/snakecase'
 require 'jekyll_from_to_until'
 
 module FlexibleInclude
   module FlexiblePrivateMethods
+    include FromToUntil
+
     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 +23,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 +64,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 +111,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 +131,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.23
+  version: 2.0.25
 platform: ruby
 authors:
 - Mike Slinn
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-26 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll_from_to_until
@@ -18,28 +18,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: jekyll_plugin_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        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.16
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Jekyll plugin supports various ways to include content into the generated