jekyll_flexible_include 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5c1b70f6c4d2af7c842a903f5fed045b3a94f4e774d202ce4c46f1b95c0bc36
-  data.tar.gz: 06d010e24a73c1de5ab88aa32482af9b34aedecdb5965884fb41eada3304417b
+  metadata.gz: 45d4ee5a84b021c967aaafa2e1894537041e4770c0604a76f02d8d9e03fc3c9e
+  data.tar.gz: 9f6337ca74f362b8a3870eb347f988ebc21ceaf73e3073c4bdd42c0bd2818cde
 SHA512:
-  metadata.gz: 00cb719cdc78b8b2ef6540e3591cf69b49ad02b2088627f6cc9997f612211a3de6ce359264c7dedf5be31ba6903cf6ae08308a5331078f46a665f160d540dc0e
-  data.tar.gz: 4de33e76a9cf52af682f1f01cc4b362ee6175ecf2484962ef6acb797b8367322a81da9f0a6e9ed332aa18aef0d604c97ba71c91ac60277c1e54c351171ae11c9
+  metadata.gz: 5dbdeef00337d13e4a2db94c80e25a324e2bf731886ead64678b3e579a2fb2b568fa9b3c2e68cafa00e21a2bc72fe47d2463e0f046df58f96285f76de0cc78e0
+  data.tar.gz: dae0c2b23c91458111599ee0db43dad4dc863dc14f6d52ba48e919bff0132d3b3eae160f748fffa7aabe5f82a82f0702113fad71bc6c7a2c16d2ad5f0f8a8180

data/.vscode/launch.json

@@ -0,0 +1,75 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "cwd": "${workspaceRoot}",
+      "name": "Attach rdebug-ide",
+      "request": "attach",
+      "remoteHost": "localhost",
+      "remotePort": "1234",
+      "remoteWorkspaceRoot": "/",
+      "restart": true,
+      "showDebuggerOutput": true,
+      "type": "Ruby",
+    },
+    {
+      "cwd": "${workspaceRoot}",
+      "debuggerPort": "1234",
+      "name": "Debug Jekyll",
+      "program": "/usr/local/bin/jekyll",
+                   "args": [
+                     "serve",
+                     "--livereload_port", "35721",
+                     "--force_polling",
+                     "--host", "0.0.0.0",
+                     "--port", "4001",
+                     "--future",
+                     "--incremental",
+                     "--livereload",
+                     "--drafts",
+                     "--unpublished"
+                   ],
+      "request": "launch",
+      "restart": true,
+      "showDebuggerOutput": true,
+      "stopOnEntry": true,
+      "type": "Ruby",
+    },
+    {
+      "name": "Debug Local Ruby",
+      "type": "Ruby",
+      "request": "launch",
+      "program": "${workspaceRoot}/main.rb"
+    },
+    {
+      "args": [
+        "-I",
+        "${workspaceRoot}",
+        "${file}"
+      ],
+      "cwd": "${workspaceRoot}",
+      "name": "RSpec - active spec file only",
+      "program": "/home/mslinn/.gems/bin/rspec",
+      "showDebuggerOutput": false,
+      "request": "launch",
+      "type": "Ruby",
+      "useBundler": true,
+    },
+    {
+      "args": [
+        "-I",
+        "${workspaceRoot}"
+      ],
+      "cwd": "${workspaceRoot}",
+      "name": "RSpec - all",
+      "program": "/home/mslinn/.gems/bin/rspec",
+      "request": "launch",
+      "showDebuggerOutput": false,
+      "type": "Ruby",
+      "useBundler": true,
+    }
+  ]
+}

data/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "ruby.rubocop.configFilePath": ".rubocop.yml",
+  "ruby.rubocop.useBundler": true
+}

data/CHANGELOG.md

@@ -1,10 +1,14 @@
-# HEAD
+## 2.0.2 / 2022-03-11
+  * This version should actually work, crossing fingers
 
+## 2.0.1 / 2022-03-11
+  * Struggling with poorly documented gem naming conventions, this release is broken, do not use
 ## 2.0.0 / 2022-03-11
-  * Made into a Ruby gem and published on RubyGems.org
+  * Made into a Ruby gem and published on RubyGems.org as [jekyll_flexible_include](https://rubygems.org/gems/jekyll_flexible_include).
   * `bin/attach` script added for debugging
   * Rubocop standards added
   * Proper versioning and CHANGELOG.md added
+  * This release is broken, do not use
 
 ## 1.1.1 / 2021-05-01
   * Handles spaces in filenames properly.

data/Gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in jekyll_flexible_include_plugin.gemspec
+# Specify your gem's dependencies in jekyll_flexible_include.gemspec
 gemspec
 
 gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -1,25 +1,73 @@
 PATH
   remote: .
   specs:
-    jekyll_flexible_include (2.0.0)
+    jekyll_flexible_include (2.0.2)
+      jekyll (>= 3.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     coderay (1.1.3)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.9)
+    debase (0.2.4.1)
+      debase-ruby_core_source (>= 0.10.2)
+    debase-ruby_core_source (0.10.14)
     diff-lcs (1.5.0)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.15.5)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.8.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.9.1)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (>= 1.17, < 3)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.3.1)
+      rexml
+    liquid (4.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.3.6)
     method_source (1.0.0)
     parallel (1.21.0)
     parser (3.1.1.0)
       ast (~> 2.4.1)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (4.0.6)
     rainbow (3.1.1)
     rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.2.1)
     rexml (3.2.5)
+    rouge (3.28.0)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -50,7 +98,17 @@ GEM
     rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-debug-ide (0.7.3)
+      rake (>= 0.8.1)
     ruby-progressbar (1.11.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
     unicode-display_width (2.1.0)
 
 PLATFORMS
@@ -58,12 +116,16 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  debase
+  jekyll
   jekyll_flexible_include!
   pry
   rake (~> 13.0)
   rspec
   rubocop
   rubocop-jekyll
+  rubocop-rake
+  ruby-debug-ide
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -1,4 +1,6 @@
-# Jekyll `flexible_include` Plugin
+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. `Flexible_include` is useful because Jekyll's built-in `include` tag only supports the including of files residing within the `_includes/` subfolder of a Jekyll project, and because `flexible_include` offers additional ways of including content.
 
@@ -68,6 +70,14 @@ Following is a workaround.
 ## Known Issues
 If the plugin does not work:
 1. Ensure `_config.yml` doesn't have `safe: true`. That prevents all plugins from working.
+2. If you have version older than v2.x.x, delete the file `_plugins/flexible_include.rb` or you will have version conflicts.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 
 ## Contributing

data/{jekyll_flexible_include_plugin.gemspec → jekyll_flexible_include.gemspec}

@@ -1,25 +1,20 @@
 # frozen_string_literal: true
 
-require_relative "lib/flexible_include/version"
+require_relative "lib/jekyll_flexible_include/version"
 
 Gem::Specification.new do |spec|
-  spec.name = "jekyll_flexible_include"
+  spec.name = 'jekyll_flexible_include'
   spec.version = JekyllFlexibleIncludePlugin::VERSION
-  spec.authors = ["Mike Slinn"]
-  spec.email = ["mslinn@mslinn.com"]
+  spec.authors = ['Mike Slinn']
+  spec.email = 'mslinn@mslinn.com'
 
-  spec.summary = "Jekyll plugin supports various ways to include content into the generated site."
+  spec.summary = "This Jekyll plugin supports various ways to include content into the generated site."
   spec.description = <<~END_OF_DESC
     Jekyll's built-in include tag only supports including files within the _includes folder.
-    This plugin supports 4 types of includes:
-
-     - Absolute filenames (recognized by filename paths that start with /).
-
-     - Filenames relative to the top-level directory of the Jekyll web site (relative paths do not start with . or /).
-
-     - Filenames relative to the user home directory (recognized by filename paths starting with ~/).
-
-     - Executable filenames on the PATH (recognized by filename paths that begin with !).
+    This plugin supports 4 types of includes: absolute filenames,
+    filenames relative to the top-level directory of the Jekyll web site,
+    filenames relative to the user home directory,
+    and executable filenames on the PATH.
   END_OF_DESC
   spec.homepage = "https://github.com/mslinn/jekyll_flexible_include_plugin"
   spec.license = "MIT"
@@ -42,10 +37,18 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.post_install_message = "Thanks for installing jekyll_flexible_include!"
+
+  spec.add_runtime_dependency 'jekyll', '>= 3.5.0'
+
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'debase'
+  spec.add_development_dependency 'jekyll'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-jekyll'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'ruby-debug-ide'
 end

data/lib/{flexible_include → jekyll_flexible_include}/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllFlexibleIncludePlugin
-  VERSION = "2.0.0"
+  VERSION = "2.0.2"
 end

data/lib/{flexible_include.rb → jekyll_flexible_include.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "flexible_include/version"
+require_relative "jekyll_flexible_include/version"
 
 module Jekyll
   module Tags
@@ -63,22 +63,6 @@ module Jekyll
         params
       end
 
-      def validate_file_name(file)
-        # TODO allow filenames relative to home directory
-        if file.match VALID_FILENAME_CHARS
-          raise ArgumentError, <<~MSG
-            Invalid syntax for the flexible_ include tag. The included file contains invalid characters or sequences:
-
-              #{file}
-
-            Valid syntax:
-
-              #{syntax_example}
-
-          MSG
-        end
-      end
-
       def validate_params
         unless @params.match FULL_VALID_SYNTAX
           raise ArgumentError, <<~MSG
@@ -94,6 +78,11 @@ module Jekyll
         end
       end
 
+      # See https://gist.github.com/steakknife/4606598
+      def expand_env_vars(str)
+        str.gsub(/\$([a-zA-Z_]+[a-zA-Z0-9_]*)|\$\{(.+)\}/) { ENV[Regexp.last_match(1) || egexp.last_match(2)] }
+      end
+
       # Grab file read opts in the context
       def file_read_opts(context)
         context.registers[:site].file_read_opts
@@ -112,25 +101,26 @@ module Jekyll
 
       def render(context) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
         file = render_variable(context) || @file
-        # strip leading and trailing quotes
-        file = file.gsub!(/\A'|'\Z/, '')
-        # validate_file_name(file)  # TODO uncomment and fix validate_file_name
+        # strip leading and trailing quotes, and expand environment variables
+        file = expand_env_vars(file.gsub(/\A'|'\Z/, ''))
         path = file
-        if /^\//.match(file)  # Is the file absolute?
+        case file
+        when %r{\A/} # Is the file absolute?
           # puts "********** render path=#{path}, file=#{file} *************"
-        elsif /~/.match(file)  # Is the file relative to user's home directory?
+        when /\A~/ # Is the file relative to user's home directory?
           # puts "********** render original file=#{file}, path=#{path} *************"
           file.slice! "~/"
           path = File.join(ENV['HOME'], file)
           # puts "********** render path=#{path}, file=#{file} *************"
-        elsif /\!/.match(file)  # Is the file on the PATH?
+        when /\A!/ # Is the file on the PATH?
           # puts "********** render original file=#{file}, path=#{path} *************"
           file.slice! "!"
           path = File.which(file)
+          Jekyll.logger.error "Flexible_include error: #{file} was not found on the PATH, output was not included" unless path
           # puts "********** render path=#{path}, file=#{file} *************"
-        else  # The file is relative
-          source = File.expand_path(context.registers[:site].config['source']).freeze # website root directory
-          path = File.join(source, file)  # Fully qualified path of include file
+        else # The file is relative
+          source = File.expand_path(context.registers[:site].config['source']) # website root directory
+          path = File.join(source, file) # Fully qualified path of include file
           # puts "********** render file=#{file}, path=#{path}, source=#{source} *************"
         end
         return unless path

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_flexible_include
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Mike Slinn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: debase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -94,35 +136,59 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Jekyll's built-in include tag only supports including files within the _includes folder.
-  This plugin supports 4 types of includes:
-
-   - Absolute filenames (recognized by filename paths that start with /).
-
-   - Filenames relative to the top-level directory of the Jekyll web site (relative paths do not start with . or /).
-
-   - Filenames relative to the user home directory (recognized by filename paths starting with ~/).
-
-   - Executable filenames on the PATH (recognized by filename paths that begin with !).
-email:
-- mslinn@mslinn.com
+  This plugin supports 4 types of includes: absolute filenames,
+  filenames relative to the top-level directory of the Jekyll web site,
+  filenames relative to the user home directory,
+  and executable filenames on the PATH.
+email: mslinn@mslinn.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".rubocop.yml"
+- ".vscode/launch.json"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- jekyll_flexible_include_plugin.gemspec
-- lib/flexible_include.rb
-- lib/flexible_include/version.rb
-- sig/jekyll_flexible_include_plugin.rbs
+- jekyll_flexible_include.gemspec
+- lib/jekyll_flexible_include.rb
+- lib/jekyll_flexible_include/version.rb
+- sig/jekyll_flexible_include.rbs
 homepage: https://github.com/mslinn/jekyll_flexible_include_plugin
 licenses:
 - MIT
@@ -131,7 +197,7 @@ metadata:
   homepage_uri: https://github.com/mslinn/jekyll_flexible_include_plugin
   source_code_uri: https://github.com/mslinn/jekyll_flexible_include_plugin
   changelog_uri: https://github.com/mslinn/jekyll_flexible_include_plugin/CHANGELOG.md
-post_install_message: 
+post_install_message: Thanks for installing jekyll_flexible_include!
 rdoc_options: []
 require_paths:
 - lib
@@ -149,6 +215,6 @@ requirements: []
 rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
-summary: Jekyll plugin supports various ways to include content into the generated
+summary: This Jekyll plugin supports various ways to include content into the generated
   site.
 test_files: []