jekyll_flexible_include 2.0.20 → 2.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b56edb0277c359b7c88c2c8e21508b1e913d9cd5568e39f9d7a38647138a212
-  data.tar.gz: adc693f3e6a51b3ea3d979054a7f7d5892346712657a23610a3a13a19d202d31
+  metadata.gz: 000dda7b37378861311b6663e9e1e246da0479ddde8a115674a1001833655b0a
+  data.tar.gz: ea530cdba36b41a67e5d60eb6ba15b51ff051e5b13a109cda8f81d362bfc08b0
 SHA512:
-  metadata.gz: 172df14e25777d093e2153a5ac867ef279c899b0563b8dae512c2975d7fc5a4048c62816113a2433c9de7a88f378c0fdb0c822a0d79d8a49f8d08e90d6718bf7
-  data.tar.gz: e8af3c65e3c25cd18275727c893ac5ffc2786e3238342e907757e4ab3165e9f4c5d533946b46e85f3605d8aaa3cd872a947fe1b0a2be4eee396007c276cc2774
+  metadata.gz: 815da6cd2afecfbab624e4392d7127cbc7e238f203c44c7d24b5c98258cf39013ce90026cab5942f061dc894049f899c271b4252bcace82198a2f0abdf7d55cf
+  data.tar.gz: 07e0cf4ae181bd334aa9fc79a7cb396cad3cf9a2750ba6ca3d37d17782518cd01a1671beac0b83db2ee914b619f41e869ecf0595b6de2fb364fa2c9d380a5508

data/.rubocop.yml

@@ -8,11 +8,11 @@ require:
 AllCops:
   Exclude:
     - demo/_site/**/*
+    - binstub/**/*
     - exe/**/*
     - vendor/**/*
     - Gemfile*
   NewCops: enable
-  TargetRubyVersion: 2.6
 
 Gemspec/DeprecatedAttributeAssignment:
   Enabled: false
@@ -20,6 +20,9 @@ Gemspec/DeprecatedAttributeAssignment:
 Gemspec/RequireMFA:
   Enabled: false
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Layout/InitialIndentation:
   Exclude:
     - README.md
@@ -39,7 +42,7 @@ Lint/RedundantCopDisableDirective:
     - jekyll_flexible_include_plugin.gemspec
 
 Metrics/AbcSize:
-  Max: 45
+  Max: 50
 
 Metrics/BlockLength:
   Exclude:
@@ -53,11 +56,14 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 20
 
+Metrics/ModuleLength:
+  Max: 150
+
 Metrics/MethodLength:
-  Max: 40
+  Max: 50
 
 Metrics/PerceivedComplexity:
-  Max: 15
+  Max: 25
 
 Naming/FileName:
   Exclude:
@@ -88,8 +94,7 @@ Style/RegexpLiteral:
   Enabled: false
 
 Style/StringConcatenation:
-  Exclude:
-    - spec/**/*
+  Enabled: false
 
 Style/StringLiterals:
   Enabled: false

data/CHANGELOG.md

@@ -1,38 +1,62 @@
+# Change Log
+
+## 2.0.21 / 2023-11-16
+
+* Restructured code
+* `die_on_file_error` and `die_on_path_denied` work again.
+* Specifying the file name without using a name/value parameter works again.
+
+
 ## 2.0.20 / 2023-05-30
-  * Updated dependencies
+
+* Updated dependencies
+
 
 ## 2.0.19 / 2023-04-05
-  * Added attribution support
+
+* Added attribution support
+
 
 ## 2.0.18 / 2023-03-24
-  * The following are now parsed property:
-    `die_on_file_error`, `die_on_path_denied`, `die_on_run_error`, `die_on_path_denied`, and `die_on_other_error`.
+
+* The following are now parsed property:
+  `die_on_file_error`, `die_on_path_denied`, `die_on_run_error`, `die_on_path_denied`, and `die_on_other_error`.
+
 
 ## 2.0.17 / 2023-03-22
-  * Added `repo` and `git_ref` parameters, so files can be retrieved from git repositories at a given commit or tag.
+
+* Added `repo` and `git_ref` parameters, so files can be retrieved from git repositories at a given commit or tag.
+
 
 ## 2.0.16 / 2023-02-19
-  * Replaced hard-coded CSS in `denied` method with `flexible_error` class in
-    `demo/assets/css/style.css`.
-  * Added `-e` and `-x` options to `demo/_bin/debug`.
-  * Added configuration section `flexible_include` with supported parameters
-    `die_on_file_error`, `die_on_path_denied`, `die_on_run_error`,
-    `die_on_path_denied` and `die_on_other_error`.
-  * Fixed `undefined method 'path'` that occurred when `FLEXIBLE_INCLUDE_PATHS` was specified.
+
+* Replaced hard-coded CSS in `denied` method with `flexible_error` class in
+  `demo/assets/css/style.css`.
+* Added `-e` and `-x` options to `demo/_bin/debug`.
+* Added configuration section `flexible_include` with supported parameters
+  `die_on_file_error`, `die_on_path_denied`, `die_on_run_error`,
+  `die_on_path_denied` and `die_on_other_error`.
+* Fixed `undefined method 'path'` that occurred when `FLEXIBLE_INCLUDE_PATHS` was specified.
+
 
 ## 2.0.15 / 2023-02-18
-  * Replaced dependency `key-value-parser` with `jekyll_plugin_support`.
-  * Added `demo` website.
-  * Improved the documentation.
-  * Updated Rubocop configuration.
-  * Added `strip` option.
+
+* Replaced dependency `key-value-parser` with `jekyll_plugin_support`.
+* Added `demo` website.
+* Improved the documentation.
+* Updated Rubocop configuration.
+* Added `strip` option.
+
 
 ## 2.0.14 / 2022-09-27
-  * Added `key-value-parser` as a dependency.
+
+* Added `key-value-parser` as a dependency.
+
 
 ## 2.0.13 / 2022-04-24
-  * Added `highlight` regex option, for highlighting.
-  * Added `number` option, for numbered lines.
+
+* Added `highlight` regex option, for highlighting.
+* Added `number` option, for numbered lines.
 
 ## 2.0.12 / 2022-04-22
   * Exits with an error message if an environment variable included in the value

data/README.md

@@ -1,6 +1,4 @@
-Jekyll `flexible_include` Plugin
-[![Gem Version](https://badge.fury.io/rb/jekyll_flexible_include.svg)](https://badge.fury.io/rb/jekyll_flexible_include)
-===========
+# Jekyll `flexible_include` Plugin [![Gem Version](https://badge.fury.io/rb/jekyll_flexible_include.svg)](https://badge.fury.io/rb/jekyll_flexible_include)
 
 `Flexible_include` is a Jekyll plugin that includes the contents of a file
 or the result of a process into a generated page.
@@ -18,7 +16,7 @@ More information is available on my website about [my Jekyll plugins](https://ww
 This plugin supports 4 types of includes:
 
 
-### Include Types
+## Include Types
 
 1. Absolute filenames (recognized by filename paths that start with `/`).
 
@@ -30,18 +28,20 @@ This plugin supports 4 types of includes:
 
 
 In addition, filenames that require environment expansion because they contain a
-<code>$</code> character are expanded according to the environment variables
-defined when <code>jekyll build</code> executes.
+`$` character are expanded according to the environment variables
+defined when `jekyll build` executes.
 
 
 A file from a git repository can also be included.
 Files can be retrieved from at a given commit or tag.
 Two new options are provided for this purpose:
-  - `repo` - directory where git repo resides; environment variables are expanded; defaults to current directory.
-  - `git_ref` - Git ref of commit or tag to be examined for the file; defaults to `HEAD`.
 
+- `repo` - directory where git repo resides; environment variables are expanded; defaults to current directory.
+- `git_ref` - Git ref of commit or tag to be examined for the file; defaults to `HEAD`.
+
+
+## Configuration
 
-### Configuration
 Configuration parameters can be added to a section in `_config.yml` called `flexible_include`, like this:
 
 ```yaml
@@ -55,17 +55,21 @@ flexible_include:
 The default values for all of these parameters is `false`,
 except for `die_on_other_error`, which defaults to `true`.
 
- - If `die_on_file_error` is enabled, then an attempt to include a file that fails will cause Jekyll to die with an error message.
+- If `die_on_file_error` is enabled, then an attempt to include a file that fails
+  will cause Jekyll to die with an error message.
 
- - If `die_on_path_denied` is enabled (see [Restricting Directory Access](#restricting-directory-access)), then an attempt to include a file that should be blocked will cause Jekyll to die with an error message.
+- If `die_on_path_denied` is enabled (see [Restricting Directory Access](#restricting-directory-access)),
+  then an attempt to include a file that should be blocked will cause Jekyll to die with an error message.
 
- - If `die_on_run_error` is enabled, then an attempt to run a process that fails will cause Jekyll to die with an error message.
+- If `die_on_run_error` is enabled, then an attempt to run a process that fails will cause Jekyll to die with an error message.
 
- - If `die_on_other_error` is enabled, then any other exception will cause Jekyll to die with an error message.
+- If `die_on_other_error` is enabled, then any other exception will cause Jekyll to die with an error message.
 
 
-### Syntax
+## Syntax
+
 The following are all equivalent, however, the first two are recommended:
+
 ```html
 {% flexible_include file="path" [ OPTIONS ] %}
 {% flexible_include file='path' [ OPTIONS ] %}
@@ -78,55 +82,69 @@ Note that the [square brackets] merely indicate optional parameters
 and are not intended to be written literally.
 
 
-### Options
-  * `attribution` see [`jekyll_plugin_support`](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution)
-  * `do_not_escape` keyword option caused the content to be included without HTML escaping it.
-    By default, the included file will escape characters <code>&lt;</code>,
-    <code>{</code> and <code>}</code> unless the <code>do_not_escape</code> keyword option is specified.
+## Options
+
+- `attribution` see [`jekyll_plugin_support`](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution)
+
+- `do_not_escape` keyword option caused the content to be included without HTML escaping it.
+  By default, the included file will escape characters `&lt;`,
+  `{` and `}` unless the `do_not_escape` keyword option is specified.
+
+- `from='regex'` specifies that the beginning of the output should discarded until the matching string or regex is encountered.
 
-  * `highlight='regex pattern here'` wraps content matching the regex pattern within a
-    `<span class='bg_yellow'></span>` tag.
-    Note that the pattern can simply consist of the exact text that you want to highlight.
+- `highlight='regex pattern here'` wraps content matching the regex pattern within a
+  `<span class='bg_yellow'></span>` tag.
+  Note that the pattern can simply consist of the exact text that you want to highlight.
 
-  * `pre` is a keyword option that causes the included file to be wrapped inside a
-    &lt;pre>&lt;/pre> tag; no label is generated.
-    The &lt;pre>&lt;/pre> tag has an `data-lt-active="false"` attribute, so
-    [LanguageTool](https://forum.languagetool.org/t/avoid-spell-check-on-certain-html-inputs-manually/3944)
-    will not attempt to check the spelling or grammar of the contents.
+- `pre` is a keyword option that causes the included file to be wrapped inside a
+  &lt;pre>&lt;/pre> tag; no label is generated.
+  The &lt;pre>&lt;/pre> tag has an `data-lt-active="false"` attribute, so
+  [LanguageTool](https://forum.languagetool.org/t/avoid-spell-check-on-certain-html-inputs-manually/3944)
+  will not attempt to check the spelling or grammar of the contents.
+
+- `to='regex'` specifies that the output should discarded after the matching string or regex is encountered
+  (includes the matched line).
+
+- `until='regex'` specifies that the output should discarded after the matching string or regex is encountered
+  (excludes the matched line).
 
 The following options imply `pre`:
-  * `dark` keyword option applies the `dark` class to the generated &lt;pre>&lt;/pre> tag.
-    You can define the `dark` and `darkLabel` classes as desired.
-    [This CSS is a good starting point.](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#pre_css)
 
-  * `download` keyword option uses the name of the file as a label,
-    and displays it above the &lt;pre>&lt;/pre> tag.
-    Clicking the label causes the file to be downloaded.
+- `dark` keyword option applies the `dark` class to the generated &lt;pre>&lt;/pre> tag.
+  You can define the `dark` and `darkLabel` classes as desired.
+  [This CSS is a good starting point.](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#pre_css)
+
+- `download` keyword option uses the name of the file as a label,
+  and displays it above the &lt;pre>&lt;/pre> tag.
+  Clicking the label causes the file to be downloaded.
 
-  * `copyButton` keyword option draws an icon at the top right of the &lt;pre>&lt;/pre>
-    tag that causes the included contents to be copied to the clipboard.
+- `copyButton` keyword option draws an icon at the top right of the &lt;pre>&lt;/pre>
+  tag that causes the included contents to be copied to the clipboard.
 
-  * `label` keyword option specifies that an automatically generated label be placed above the contents.
-    There is no need to specify this option if `download` or `copy_button` options are provided.
+- `label` keyword option specifies that an automatically generated label be placed above the contents.
+  There is no need to specify this option if `download` or `copy_button` options are provided.
 
-  * `label="blah blah"` specifies a label for the contents; this value overrides the default label.
-    The value can be enclosed in single or double quotes.
+- `label="blah blah"` specifies a label for the contents; this value overrides the default label.
+  The value can be enclosed in single or double quotes.
 
 
-### Restricting Directory Access
-By default, `flexible_include` can read from all directories according to the permissions of the user account that launched the `jekyll` process.
+## Restricting Directory Access
+
+By default, `flexible_include` can read from all directories according to the permissions of the
+user account that launched the `jekyll` process.
 For security-conscience environments, the accessible paths can be restricted.
 
-Defining an environment variable called `FLEXIBLE_INCLUDE_PATHS` prior to launching Jekyll will restrict the paths that `flexible_include` will be able to read from.
+Defining an environment variable called `FLEXIBLE_INCLUDE_PATHS` prior to launching Jekyll will
+restrict the paths that `flexible_include` will be able to read from.
 This environment variable consists of a colon-delimited set of
 [file and directory glob patterns](https://docs.ruby-lang.org/en/2.7.0/Dir.html#method-c-glob).
 For example, the following restricts access to only the files within:
 
- 1. The `~/my_dir` directory tree of the account of the user that launched Jekyll.
+1. The `~/my_dir` directory tree of the account of the user that launched Jekyll.
 
- 2. The directory tree rooted at `/var/files`.
+2. The directory tree rooted at `/var/files`.
 
- 3. The directory tree rooted at the expanded value of the `$work` environment variable.
+3. The directory tree rooted at the expanded value of the `$work` environment variable.
 
 ```shell
 export FLEXIBLE_INCLUDE_PATHS='~/.*:$sites/.*:$work/.*'
@@ -139,17 +157,21 @@ To just match visible files:
 export FLEXIBLE_INCLUDE_PATHS='~/my_dir/**/*:/var/files/**/*:$work/**/*'
 ```
 
-#### Note
+
+### Note
+
 The specified directories are traversed when the plugin starts,
 and the filenames are stored in memory.
 Directories with lots of files might take a noticable amount of
 time to enumerate the files.
 
 
-### Restricting Arbitrary Processes
+## Restricting Arbitrary Processes
+
 By default, `flexible_include` can execute any command.
 You can disable that by setting the environment variable `DISABLE_FLEXIBLE_INCLUDE`
 to any non-empty value.
+
 ```shell
 export DISABLE_FLEXIBLE_INCLUDE=true
 ```
@@ -162,7 +184,9 @@ and a red error message will be logged on the console that says something like:
 
 
 ## Installation
+
 1. Add the following to `Gemfile`, inside the `jekyll_plugins` group:
+
    ```ruby
    group :jekyll_plugins do
      gem 'jekyll_flexible_include', '~> 2.0.15'
@@ -172,6 +196,7 @@ and a red error message will be logged on the console that says something like:
 2. Add the following to `_config.yml`.
    This is necessary because the name of the plugin
    does not match the name of the entry point file:
+
    ```yaml
    plugins:
      - flexible_include
@@ -180,27 +205,20 @@ and a red error message will be logged on the console that says something like:
 3. Copy `demo/assets/images/clippy.svg` to a directory that resolves to
    `assets/images/` in your Jekyll website.
 
-4. Copy the CSS from `demo/assets/css/styles.css` between the comments to your Jekyll project's CSS file:
-   ```css
-   blah blah blah
-
-   /* START OF CSS TO COPY */
-   Copy this stuff
-   /* END OF CSS TO COPY */
+4. Copy the CSS from `demo/assets/css/jekyll_flexible_include.css` to your Jekyll project's CSS file.
 
-   blah blah blah
-   ```
+5. Install the `jekyll_flexible_include` Ruby gem and mark it as a dependency of your project:
 
-5. Install the `jekyll_flexible_include` Ruby gem as usual:
    ```shell
-   $ bundle install
+   $ bundle
    ```
 
 
 ## Examples
 
 1. Include files, escaping any HTML markup, so it appears as written; all four types of includes are shown.
-   ```
+
+   ```html
    {% flexible_include '../../folder/outside/jekyll/site/foo.html' %}
    {% flexible_include 'folder/within/jekyll/site/bar.js' %}
    {% flexible_include '/etc/passwd' %}
@@ -210,16 +228,20 @@ and a red error message will be logged on the console that says something like:
    ```
 
 2. Include a JSON file (without escaping characters).
-   ```
+
+   ```html
    {% flexible_include do_not_escape file='~/folder/under/home/directory/foo.html' %}
    ```
 
+
 ## Additional Information
+
 More information is available on
 [Mike Slinn&rsquo;s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
 
 
 ## GitHub Pages
+
 GitHub Pages only allows [these plugins](https://pages.github.com/versions/).
 That means `flexible_include` will not work on GitHub Pages.
 Following is a workaround.
@@ -237,10 +259,12 @@ Following is a workaround.
 
 6. Tell GitHub that you want the `generated_site` repository to hold your GitHub pages.
 
-7. A moment later, your website will now be visible as GitHub Pages, with the included content, just as you saw it locally.
+7. A moment later, your website will now be visible as GitHub Pages, with the included content,
+  just as you saw it locally.
 
 
 ## Known Issues
+
 If the plugin does not work:
 
 1. Ensure `_config.yml` doesn't have `safe: true` set.
@@ -252,17 +276,22 @@ If the plugin does not work:
 
 
 ## Development
+
 After checking out the repo, run `bin/setup` to install dependencies as binstubs in the `exe` directory.
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+
 ### Build and Install Locally
+
 To build and install this gem onto your local machine, run:
+
 ```shell
-$ rake install
+$ bundle exec rake install
 ```
 
 Examine the newly built gem:
+
 ```shell
 $ gem info jekyll_flexible_include
 
@@ -280,11 +309,13 @@ jekyll_flexible_include (2.0.4)
 
 
 ## Demo Website
+
 A test/demo website is provided in the `demo` directory.
 You can run it under a debugger, or let it run free.
 
 The `demo/_bin/debug` script can set various parameters for the demo.
 View the help information with the `-h` option:
+
 ```shell
 $ demo/_bin/debug -h
 
@@ -309,45 +340,45 @@ Options:
 
 
 ### Debugging the Demo
+
 To run under a debugger, for example Visual Studio Code:
- 1. Set breakpoints.
 
- 2. Initiate a debug session from the command line:
-    ```shell
-    $ demo/bin/debug
-    ```
+1. Set breakpoints.
+2. Initiate a debug session from the command line:
 
-  3. Once the `Fast Debugger` signon appears, launch the Visual Studio Code launch configuration called `Attach rdebug-ide`.
+   ```shell
+   $ demo/bin/debug
+   ```
 
-  4. View the generated website at [`http://localhost:4444`](http://localhost:4444).
+3. Once the `Fast Debugger` signon appears, launch the Visual Studio Code launch configuration called `Attach rdbg`.
+4. View the generated website at [`http://localhost:4444`](http://localhost:4444).
 
 
 ### Build and Push to RubyGems
+
 To release a new version,
 
   1. Update the version number in `version.rb`.
-
   2. Add a comment to the top of `CHANGELOG.md`.
-
   3. Commit all changes to git; if you don't the next step will fail.
-
   4. Run the following:
+
      ```shell
      $ bundle exec rake release
      ```
+
      The above creates a git tag for the version, commits the created tag,
      and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
 
 
 ## Contributing
-1. Fork the project
 
+1. Fork the project
 2. Create a descriptively named feature branch
-
 3. Add your feature
-
 4. Submit a pull request
 
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/jekyll_flexible_include_plugin.gemspec

@@ -35,6 +35,7 @@ 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_plugin_support', '>= 0.7.0'
+  spec.add_dependency 'jekyll_from_to_until'
+  spec.add_dependency 'jekyll_plugin_support', '>= 0.7.3'
   spec.add_dependency 'rugged'
 end

data/lib/flexible_include/version.rb

@@ -1,3 +1,3 @@
 module JekyllFlexibleIncludePluginVersion
-  VERSION = '2.0.20'.freeze
+  VERSION = '2.0.21'.freeze
 end

data/lib/flexible_include.rb

@@ -2,248 +2,103 @@ require 'benchmark'
 require 'jekyll_plugin_support'
 require 'securerandom'
 require_relative 'flexible_include/version'
+require_relative 'flexible_include_class'
+require_relative 'flexible_include_private_methods'
 
-module JekyllFlexibleIncludeName
-  PLUGIN_NAME = 'flexible_include'.freeze
-end
-
-module FlexibleClassMethods
-  def access_allowed(path)
-    return true unless @read_regexes
-
-    @read_regexes.find { |regex| regex.match(normalize_path(path)) }
-  end
-
-  def self.escape_html(string)
-    string.gsub("&", "&")
-          .gsub("{", "{")
-          .gsub("}", "}")
-          .gsub("<", "&lt;")
-  end
-
-  def normalize_path(path)
-    JekyllPluginHelper.expand_env(path, die_if_undefined: true)
-                      .gsub('~', Dir.home)
-  end
-
-  def number_content(content)
-    lines = content.split("\n")
-    digits = lines.length.to_s.length
-    i = 0
-    numbered_content = lines.map do |line|
-      i += 1
-      number = i.to_s.rjust(digits, ' ')
-      "<span class='unselectable numbered_line'> #{number}: </span>#{line}"
-    end
-    result = numbered_content.join "\n"
-    result += "\n" unless result.end_with? "\n"
-    result
-  end
-
-  # If FLEXIBLE_INCLUDE_PATHS='~/lib/.*:.*:$WORK/.*'
-  # Then @read_regexes will be set to regexes of ['/home/my_user_id/lib/.*', '/pwd/.*', '/work/envar/path/.*']
-  def security_check
-    @execution_denied = ENV.fetch('DISABLE_FLEXIBLE_INCLUDE', nil)
-
-    return if @read_regexes
-
-    flexible_include_paths = ENV.fetch('FLEXIBLE_INCLUDE_PATHS', nil)
-    read_paths = normalize_path(flexible_include_paths) if flexible_include_paths
-    return unless read_paths
-
-    @read_regexes = read_paths.split(':').map do |path|
-      abs_path = path.start_with?('/') ? path : (Pathname.new(Dir.pwd) + path).to_s
-      Regexp.new(abs_path)
-    end
+class String
+  def squish
+    strip.gsub(/\s+/, ' ')
   end
 end
 
-FlexibleIncludeError = Class.new(Liquid::Error)
-
-class FlexibleInclude < JekyllSupport::JekyllTag # rubocop: disable Metrics/ClassLength
-  include JekyllFlexibleIncludePluginVersion
-
-  def render_impl # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    setup
-    path = JekyllPluginHelper.expand_env(@filename)
-    case path
-    when /\A\// # Absolute path
-      return denied("Access to <code>#{path}</code> denied by <code>FLEXIBLE_INCLUDE_PATHS</code> value.") unless self.class.access_allowed(path)
-
-      @logger.debug { "Absolute path=#{path}, @filename=#{@filename}" }
-    when /\A~/ # Relative path to user's home directory
-      return denied("Access to <code>#{path}</code> denied by <code>FLEXIBLE_INCLUDE_PATHS</code> value.") unless self.class.access_allowed(path)
-
-      @logger.debug { "User home start @filename=#{@filename}, path=#{path}" }
-      @filename = @filename.delete_prefix '~/'
-      path = File.join(Dir.home, @filename)
-      @logger.debug { "User home end @filename=#{@filename}, path=#{path}" }
-    when /\A!/ # Run command and return response
-      return denied('Arbitrary command execution denied by DISABLE_FLEXIBLE_INCLUDE value.') if @execution_denied
-
-      @filename = JekyllPluginHelper.remove_quotes(@helper.argv.first) if @helper.argv.first
-      @filename = @filename.delete_prefix '!'
-      contents = run(@filename)
-    else # Relative path
-      source = File.expand_path(@site.config['source']) # website root directory
-      path = File.join(source, @filename) # Fully qualified path of include file from relative path
-      @relative = true
-      @logger.debug { "Relative end @filename=#{@filename}, path=#{path}" }
-    end
-    render_completion(path, contents)
-  rescue Errno::EACCES => e
-    msg = format_error_message e.message
-    @logger.error msg
-    raise FlexibleIncludeError, msg, [] if @die_on_file_error
-
-    "<span class='flexible_error'>FlexibleIncludeError: #{msg}</span>"
-  rescue Errno::ENOENT => e
-    msg = format_error_message e.message
-    @logger.error msg
-    raise FlexibleIncludeError, msg, [] if @die_on_path_denied
-
-    "<span class='flexible_error'>FlexibleIncludeError: #{msg}</span>"
-  rescue FlexibleIncludeError => e
-    @logger.error e.message
-    raise e
-  rescue StandardError => e
-    msg = format_error_message e.message
-    @logger.error msg
-    raise FlexibleIncludeError, msg, [] if @die_on_other_error
-
-    "<span class='flexible_error'>FlexibleIncludeError: #{msg}</span>"
-  end
-
-  private
-
-  class << self
-    include FlexibleClassMethods
-  end
-
-  def denied(msg)
-    msg_no_html = remove_html_tags(msg)
-    @logger.error("#{@page['path']} - #{msg_no_html}")
-    raise FlexibleIncludeError, "#{@page['path']} - #{msg_no_html.red}", [] if @die_on_path_denied
+module FlexibleInclude
+  FlexibleIncludeError = JekyllSupport.define_error
 
-    "<p class='flexible_error'>#{msg}</p>"
-  end
-
-  def format_error_message(message)
-    "#{message} on line #{@line_number} (after front matter) of #{@page['path']}}"
-  end
-
-  def highlight(content, pattern)
-    content.gsub(Regexp.new(pattern), "<span class='bg_yellow'>\\0</span>")
-  end
-
-  def parse_args
-    @copy_button = @helper.parameter_specified? 'copyButton'
-    @dark = ' dark' if @helper.parameter_specified? 'dark'
-    @do_not_escape = @helper.parameter_specified? 'do_not_escape'
-    @download = @helper.parameter_specified? 'download'
-    @highlight_pattern = @helper.parameter_specified? 'highlight'
-    @label = @helper.parameter_specified? 'label'
-    @label_specified = @label
-    @number_lines = @helper.parameter_specified? 'number'
-    @strip = @helper.parameter_specified? 'strip'
-
-    # Download, dark, label or number implies pre
-    @pre = @helper.parameter_specified?('pre') || @copy_button || @dark || @download || @label_specified || @number_lines
-
-    @filename = @helper.parameter_specified? 'file'
-    @filename ||= @helper.params.first # Do this after all options have been checked for
-    @label ||= @filename
-
-    # If a label was specified, use it, otherwise concatenate any dangling parameters and use that as the label
-    @label ||= @helper.params[1..].join(' ')
-
-    @logger.debug("@filename=#{@filename}")
-  end
-
-  # Not used, delete
-  def realpath_prefixed_with?(path, dir)
-    File.exist?(path) && File.realpath(path).start_with?(dir)
-  rescue StandardError => _e
-    raise FlexibleIncludeError, remove_html_tags(e.message).red, [] if @die_on_file_error
-  end
-
-  def remove_html_tags(string)
-    string.gsub(/<[^>]*>/, '')
-  end
-
-  def render_completion(path, contents)
-    contents ||= File.read(path)
-    contents.strip! if @strip
-    contents2 = @do_not_escape ? contents : FlexibleClassMethods.escape_html(contents)
-    contents2 = highlight(contents2, @highlight_pattern) if @highlight_pattern
-    contents2 = FlexibleInclude.number_content(contents2) if @number_lines
-    result = @pre ? wrap_in_pre(path, contents2) : contents2
-    <<~END_OUTPUT
-      #{result}
-      #{@helper.attribute if @helper.attribution}
-    END_OUTPUT
-  end
+  PLUGIN_NAME = 'flexible_include'.freeze
 
-  def run(cmd)
-    if cmd.empty?
-      msg = format_error_message 'FlexibleIncludeError: Empty command string'
-      @do_not_escape = true
-      return "<span class='flexible_error'>#{msg}</span>" unless @die_on_other_error
+  class FlexibleInclude < JekyllSupport::JekyllTag
+    include JekyllFlexibleIncludePluginVersion
 
-      raise FlexibleIncludeError, msg, []
+    class << self
+      include FlexibleClassMethods
     end
 
-    @logger.debug { "Executing #{cmd}" }
-    %x[#{cmd}].chomp
-  rescue FlexibleIncludeError => e
-    raise e
-  rescue StandardError => e
-    msg = format_error_message "#{e.class}: #{e.message.strip}"
-    @logger.error msg
-    @do_not_escape = true
-    return "<span class='flexible_error'>#{msg}</span>" unless @die_on_run_error
-
-    e.set_backtrace []
-    raise e
-  end
-
-  def setup
-    @helper.gem_file __FILE__ # Enables attribution
-    self.class.security_check
-
-    config = @config[JekyllFlexibleIncludeName::PLUGIN_NAME]
-    if config
-      @die_on_file_error  = config['die_on_file_error'] == true
-      @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
+    def render_impl
+      setup
+      @path = JekyllPluginHelper.expand_env @filename
+      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
+
+      "<div class='custom_error'>#{e.class} raised in #{self.class};\n#{msg}</div>"
+    rescue Errno::ENOENT => e
+      e.shorten_backtrace
+      msg = format_error_message e.message
+      @logger.error msg
+
+      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>"
+    rescue FlexibleIncludeError => e
+      e.shorten_backtrace
+      @logger.error e.message
+      raise e
     end
 
-    parse_args
-  end
+    private
+
+    include FlexiblePrivateMethods
+
+    # @return content if @path does not reference a file
+    def handle_path_types
+      case @path
+      when /\A\// # Absolute path
+        unless self.class.access_allowed(@path)
+          return denied("Access to <code>#{@path}</code> from line #{@line_number} (after front matter) " \
+                        "of #{@page['name']} denied by <code>FLEXIBLE_INCLUDE_PATHS</code> value.")
+        end
+
+        @logger.debug { "Absolute @path=#{@path}, @filename=#{@filename}" }
+      when /\A~/ # Relative path to user's home directory
+        unless self.class.access_allowed(@path)
+          return denied("Access to <code>#{@path}</code> from line #{@line_number} (after front matter) " \
+                        "of #{@page['name']} denied by <code>FLEXIBLE_INCLUDE_PATHS</code> value.")
+        end
+
+        @logger.debug { "User home start @filename=#{@filename}, @path=#{@path}" }
+        @filename = @filename.delete_prefix '~/'
+        @filename = File.join(Dir.home, @filename)
+        @path = @filename
+        @logger.debug { "User home end @filename=#{@filename}, @path=#{@path}" }
+      when /\A!/ # Run command and return response
+        if @execution_denied
+          return denied("Arbitrary command execution from line #{@line_number} (after front matter) " \
+                        "of #{@page['name']} denied by DISABLE_FLEXIBLE_INCLUDE value.")
+        end
+
+        @filename = JekyllPluginHelper.remove_quotes(@helper.argv.first) if @helper.argv.first
+        @filename = @filename.delete_prefix '!'
+        @contents = run(@filename)
+      else # Relative path
+        @path = @filename
+        @relative = true
+        @logger.debug { "Relative end @filename=#{@filename}, @path=#{@path}" }
+      end
+    end
 
-  PREFIX = "<button class='copyBtn' data-clipboard-target=".freeze
-  SUFFIX = "title='Copy to clipboard'><img src='/assets/images/clippy.svg' alt='Copy to clipboard' style='width: 13px'></button>".freeze
-
-  def wrap_in_pre(path, content)
-    basename = File.basename(path)
-    label_or_href = if @download
-                      label = @label_specified ? @label : basename
-                      <<~END_HREF
-                        <a href='data:text/plain;charset=UTF-8,#{basename}' download='#{basename}'
-                          title='Click on the file name to download the file'>#{label}</a>
-                      END_HREF
-                    else
-                      @label_specified ? @label : basename
-                    end
-    pre_id = "id#{SecureRandom.hex 6}"
-    copy_button = @copy_button ? "#{PREFIX}'##{pre_id}'#{SUFFIX}" : ''
-    dark_label = ' darkLabel' if @dark
-    <<~END_PRE
-      <div class="codeLabel#{dark_label}">#{label_or_href}</div>
-      <pre data-lt-active="false" class="pre_tag maxOneScreenHigh copyContainer#{@dark}" id="#{pre_id}">#{copy_button}#{content}</pre>
-    END_PRE
+    JekyllPluginHelper.register(self, 'flexible_include')
   end
-
-  JekyllPluginHelper.register(self, 'flexible_include')
 end

data/lib/flexible_include_class.rb

@@ -0,0 +1,52 @@
+module FlexibleInclude
+  module FlexibleClassMethods
+    def access_allowed(path)
+      return true unless @read_regexes
+
+      @read_regexes.find { |regex| regex.match(normalize_path(path)) }
+    end
+
+    def self.escape_html(string)
+      string.gsub("&", "&")
+            .gsub("{", "{")
+            .gsub("}", "}")
+            .gsub("<", "&lt;")
+    end
+
+    def normalize_path(path)
+      JekyllPluginHelper.expand_env(path, die_if_undefined: true)
+                        .gsub('~', Dir.home)
+    end
+
+    def number_content(content)
+      lines = content.split("\n")
+      digits = lines.length.to_s.length
+      i = 0
+      numbered_content = lines.map do |line|
+        i += 1
+        number = i.to_s.rjust(digits, ' ')
+        "<span class='unselectable numbered_line'> #{number}: </span>#{line}"
+      end
+      result = numbered_content.join "\n"
+      result += "\n" unless result.end_with? "\n"
+      result
+    end
+
+    # If FLEXIBLE_INCLUDE_PATHS='~/lib/.*:.*:$WORK/.*'
+    # Then @read_regexes will be set to regexes of ['/home/my_user_id/lib/.*', '/pwd/.*', '/work/envar/path/.*']
+    def security_check
+      @execution_denied = ENV.fetch('DISABLE_FLEXIBLE_INCLUDE', nil)
+
+      return if @read_regexes
+
+      flexible_include_paths = ENV.fetch('FLEXIBLE_INCLUDE_PATHS', nil)
+      read_paths = normalize_path(flexible_include_paths) if flexible_include_paths
+      return unless read_paths
+
+      @read_regexes = read_paths.split(':').map do |path|
+        abs_path = path.start_with?('/') ? path : (Pathname.new(Dir.pwd) + path).to_s
+        Regexp.new(abs_path)
+      end
+    end
+  end
+end

data/lib/flexible_include_private_methods.rb

@@ -0,0 +1,142 @@
+require 'pathname'
+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}")
+      raise FlexibleIncludeError, "#{@page['path']} - #{msg_no_html}".red, [] if @die_on_path_denied
+
+      "<p class='flexible_error'>#{msg}</p>"
+    end
+
+    def highlight(content, pattern)
+      raise FlexibleIncludeError, "content is a #{content.class}, not a String" unless content.instance_of? String
+
+      content.gsub(Regexp.new(pattern), "<span class='bg_yellow'>\\0</span>")
+    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
+
+      raise FlexibleIncludeError, msg, []
+    end
+
+    def parse_args
+      @copy_button = @helper.parameter_specified? 'copyButton'
+      @dark = ' dark' if @helper.parameter_specified? 'dark'
+      @do_not_escape = @helper.parameter_specified? 'do_not_escape'
+      @download = @helper.parameter_specified? 'download'
+      @from = @helper.parameter_specified? 'from'
+      @highlight_pattern = @helper.parameter_specified? 'highlight'
+      @label = @helper.parameter_specified? 'label'
+      @label_specified = @label
+      @number_lines = @helper.parameter_specified? 'number'
+      @strip = @helper.parameter_specified? 'strip'
+      @to = @helper.parameter_specified? 'to'
+      @until = @helper.parameter_specified? 'until'
+
+      # Download, dark, label or number implies pre
+      @pre = @helper.parameter_specified?('pre') || @copy_button || @dark || @download || @label_specified || @number_lines
+
+      @filename = @helper.parameter_specified? 'file'
+
+      unless @filename # Do this after all other options have been checked for
+        @filename = @helper.params.first.first
+        @helper.delete_parameter @helper.params.first
+      end
+      raise StandardError, "@filename (#{@filename}) is not a string", [] unless @filename.instance_of? String
+
+      @label ||= @filename
+
+      @logger.debug("@filename=#{@filename}")
+    end
+
+    def remove_html_tags(string)
+      string.gsub(/<[^>]*>/, '')
+    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?
+
+        @contents = File.read @path
+        unless @contents.instance_of? String
+          maybe_raise_error("contents has type a #{@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
+      contents2 = @do_not_escape ? @contents : FlexibleClassMethods.escape_html(@contents)
+      contents2.strip! if @strip
+      maybe_raise_error("contents2 is a #{contents2.class}, not a String", throw_error: @die_on_file_error) unless contents2.instance_of? String
+
+      contents2 = highlight(contents2, @highlight_pattern) if @highlight_pattern
+      contents2 = FlexibleInclude.number_content(contents2) if @number_lines
+      result = @pre ? wrap_in_pre(@path, contents2) : contents2
+      <<~END_OUTPUT
+        #{result}
+        #{@helper.attribute if @helper.attribution}
+      END_OUTPUT
+    end
+
+    def run(cmd)
+      if cmd.empty?
+        @do_not_escape = true
+        return maybe_raise_error('FlexibleIncludeError: Empty command string', throw_error: @die_on_other_error)
+      end
+
+      @logger.debug { "Executing #{cmd}" }
+      %x[#{cmd}].chomp
+    rescue FlexibleIncludeError => e
+      raise e
+    rescue StandardError => e
+      @do_not_escape = true
+      maybe_reraise_error(e, throw_error: @die_on_run_error)
+    end
+
+    def setup
+      @helper.gem_file __FILE__ # Enables attribution
+      self.class.security_check
+
+      config = @config[PLUGIN_NAME]
+      if config
+        @die_on_file_error  = config['die_on_file_error'] == true
+        @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
+      end
+
+      parse_args
+    end
+
+    PREFIX = "<button class='copyBtn' data-clipboard-target=".freeze
+    SUFFIX = "title='Copy to clipboard'><img src='/assets/images/clippy.svg' alt='Copy to clipboard' style='width: 13px'></button>".freeze
+
+    def wrap_in_pre(path, content)
+      basename = File.basename(path)
+      label_or_href = if @download
+                        label = @label_specified ? @label : basename
+                        <<~END_HREF
+                          <a href='data:text/plain;charset=UTF-8,#{basename}' download='#{basename}'
+                            title='Click on the file name to download the file'>#{label}</a>
+                        END_HREF
+                      else
+                        @label_specified ? @label : basename
+                      end
+      pre_id = "id#{SecureRandom.hex 6}"
+      copy_button = @copy_button ? "#{PREFIX}'##{pre_id}'#{SUFFIX}" : ''
+      dark_label = ' darkLabel' if @dark
+      <<~END_PRE
+        <div class="codeLabel#{dark_label}">#{label_or_href}</div>
+        <pre data-lt-active="false" class="pre_tag maxOneScreenHigh copyContainer#{@dark}" id="#{pre_id}">#{copy_button}#{content}</pre>
+      END_PRE
+    end
+  end
+end

data/lib/{git_util.rb → git_file_reader.rb}

@@ -1,5 +1,6 @@
 require 'rugged'
 
+# TODO: Not used yet. Either implement git-related functionality or delete this file and its tests
 class GitFileReader
   def initialize(repo_dir = '.')
     @repo = Rugged::Repository.new repo_dir
@@ -32,10 +33,3 @@ class GitFileReader
     object.data # String
   end
 end
-
-if $PROGRAM_NAME == __FILE__
-  puts GitFileReader.new('.').blob_at('HEAD~2', 'README.md').content
-  # puts GitFileReader.new('.').commit_for_ref('HEAD^').contents('README.md')
-  # puts GitFileReader.new('.').commit_for_ref('HEAD').contents('README.md')
-  # puts GitFileReader.new('.').commit_for_ref('refs/heads/master').contents('README.md')
-end

data/spec/flexible_include_spec.rb

@@ -1,3 +1,4 @@
+require 'jekyll_plugin_support'
 require_relative '../lib/flexible_include'
 
 RSpec.describe(FlexibleInclude) do
@@ -10,7 +11,7 @@ RSpec.describe(FlexibleInclude) do
 
     expect(described_class.access_allowed('~/.mem_settings.yaml')).to be_truthy
 
-    home_file = JekyllTagHelper.expand_env('$HOME/.mem_settings.yaml')
+    home_file = JekyllPluginHelper.expand_env('$HOME/.mem_settings.yaml')
     expect(described_class.access_allowed(home_file)).to be_truthy
 
     expect(described_class.access_allowed('/asdf')).to be_falsey

data/spec/git_file_reader_spec.rb

@@ -0,0 +1,27 @@
+require 'jekyll_plugin_support'
+require_relative '../lib/git_file_reader'
+
+RSpec.describe(GitFileReader) do
+  it 'reads a file at a tag' do
+    content = described_class.new('.').blob_at('v2.0.20', 'README.md').content
+    expect(content).to include('Added `highlight` regex option')
+
+    content = described_class.new('.').blob_at('v2.0.19', 'README.md').content
+    expect(content).not_to include('Added `highlight` regex option')
+  end
+
+  it 'reads a file at HEAD^' do
+    content = described_class.new('.').blob_at('HEAD^', 'README.md').content
+    expect(content).to be_truthy
+  end
+
+  it 'reads a file at HEAD' do
+    content = described_class.new('.').blob_at('HEAD', 'README.md').content
+    expect(content).to be_truthy
+  end
+
+  it 'reads a file at refs/heads/master' do
+    content = described_class.new('.').blob_at('refs/heads/master', 'README.md').content
+    expect(content).to be_truthy
+  end
+end

data/spec/spec_helper.rb

@@ -5,9 +5,8 @@ require_relative '../lib/flexible_include'
 Jekyll.logger.log_level = :info
 
 RSpec.configure do |config|
-  config.filter_run :focus
-  config.order = 'random'
-  config.run_all_when_everything_filtered = true
+  # config.order = 'random'
+  config.filter_run_when_matching focus: true
 
   # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
   config.example_status_persistence_file_path = 'spec/status_persistence.txt'

data/spec/status_persistence.txt

@@ -0,0 +1,7 @@
+example_id                           | status | run_time        |
+------------------------------------ | ------ | --------------- |
+./spec/flexible_include_spec.rb[1:1] | passed | 0.00164 seconds |
+./spec/git_file_reader_spec.rb[1:1]  | failed | 0.04395 seconds |
+./spec/git_file_reader_spec.rb[1:2]  | passed | 0.0411 seconds  |
+./spec/git_file_reader_spec.rb[1:3]  | passed | 0.03189 seconds |
+./spec/git_file_reader_spec.rb[1:4]  | passed | 0.02975 seconds |

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_flexible_include
 version: !ruby/object:Gem::Version
-  version: 2.0.20
+  version: 2.0.21
 platform: ruby
 authors:
 - Mike Slinn
@@ -10,22 +10,36 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-25 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll_from_to_until
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jekyll_plugin_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.3
 - !ruby/object:Gem::Dependency
   name: rugged
   requirement: !ruby/object:Gem::Requirement
@@ -59,9 +73,13 @@ files:
 - jekyll_flexible_include_plugin.gemspec
 - lib/flexible_include.rb
 - lib/flexible_include/version.rb
-- lib/git_util.rb
+- lib/flexible_include_class.rb
+- lib/flexible_include_private_methods.rb
+- lib/git_file_reader.rb
 - spec/flexible_include_spec.rb
+- spec/git_file_reader_spec.rb
 - spec/spec_helper.rb
+- spec/status_persistence.txt
 homepage: https://www.mslinn.com/jekyll_plugins/jekyll_flexible_include.html
 licenses:
 - MIT
@@ -89,12 +107,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Jekyll plugin supports various ways to include content into the generated
   site.
 test_files:
 - spec/flexible_include_spec.rb
+- spec/git_file_reader_spec.rb
 - spec/spec_helper.rb
+- spec/status_persistence.txt
 ...