jekyll_include_plugin 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54bfb570062a4da31cc5867a42c04e27dbc9805fa5264e8c58e981767f0a278a
-  data.tar.gz: '09e7d4a74aed13c6b35989488f17f6585738a44040bdd67249d8adc63d692312'
+  metadata.gz: 1ab41eee4ee062ebf7ff40d8af0a74b1f8c62290917d9a8f7cefff42da0448eb
+  data.tar.gz: 33baf168b4e8135a1764c87331440fe0b99708ed03ae0c785b05f83a460e7dbc
 SHA512:
-  metadata.gz: 6af90891514917916f37065d5478949692627bad43ab9155f2ff49dc564b9ff8feb3c9bf16de62732faa038292e553d84dfa9d39e87dbe8b19c65df414cefbbb
-  data.tar.gz: 21f27c73ba69245773207cf8ed917fb97b13b0fc34e57be8564ffa928ca3fc720525dfcabe73eb6c3587e4d77bf8b18a849130c51b0dead09356debc740d1c0e
+  metadata.gz: 273307ca8e1c63524efaed172e0175fb92296184940d8456cf143303363662652eb11648d352c93c0a7e667ac3f51f366ebb001829347bef1b22a9de8c8b38e1
+  data.tar.gz: b1ed24b4640b5897660f76d340b9067b9a936bf209c32037b647c7c5f378ea0a7effec85c7bc2272c001238c6bc3ee35d0c4da9e0018ecc7e43194fbb369e397

data/.github/workflows/main.yml

@@ -1,16 +1,19 @@
 name: Ruby
 
-on: [push,pull_request]
+on: [push, pull_request]
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6.10, 2.7.6, 3.0.4, 3.1.2, 3.2.0, 3.4.2]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.5
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll_include_plugin (1.1.0)
+    jekyll_include_plugin (1.2.0)
       jekyll (>= 3.5, < 5.0)
       liquid (~> 4.0)
 
@@ -59,7 +59,8 @@ GEM
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.5)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rouge (3.26.0)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -79,6 +80,7 @@ GEM
       ffi (~> 1.9)
     sassc (2.4.0-x64-mingw32)
       ffi (~> 1.9)
+    strscan (3.1.0)
     terminal-table (2.0.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     unicode-display_width (1.7.0)
@@ -93,4 +95,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.2.20
+   2.6.6

data/README.md

@@ -60,6 +60,19 @@ Dynamic parameters:
 {% include_file "{{ $templatingAllowedHere }}/Dockerfile" snippet="{{ $hereToo }}" %}
 ```
 
+## Plugin options in `_config.yml`
+
+Default options:
+```yml
+jekyll_include_plugin:
+  snippet_prefix: '...'
+```
+
+### `snippet_prefix`
+Type: `string` Default: `...`
+
+Prepends the prefix at the end of included snippet to differentiate whole file includes vs partial file includes (snippet)  
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/jekyll_include_plugin/jekyll_include_plugin.rb

@@ -10,16 +10,18 @@ module JekyllIncludePlugin
     def initialize(tag_name, raw_markup, tokens)
       super
       @raw_markup = raw_markup
+      @config = {}
       @params = {}
     end
 
     def render(context)
+      read_config(context)
       parse_params(context)
 
       file_contents = get_raw_file_contents(context)
 
       if @params["snippet"]
-        file_contents = pick_snippet(file_contents, @params["snippet"])
+        file_contents = pick_snippet(file_contents, @config['snippet_prefix'], @params["snippet"])
       else
         file_contents = remove_all_snippets(file_contents)
       end
@@ -34,6 +36,13 @@ module JekyllIncludePlugin
 
     private
 
+    def read_config(context)
+      site = context.registers[:site]
+      plugin_config = site.config["jekyll_include_plugin"] || {}
+
+      @config["snippet_prefix"] = plugin_config['snippet_prefix'] || '...'
+    end
+
     def parse_params(context)
       rendered_markup = Liquid::Template
         .parse(@raw_markup)
@@ -92,7 +101,7 @@ module JekyllIncludePlugin
     def get_remote_file_contents()
       begin
         debug("Getting contents of specified remote file: #{@params["abs_file_url"]}")
-        return open(@params["abs_file_url"]).read
+        return URI.open(@params["abs_file_url"]).read
       rescue OpenURI::HTTPError => e
         abort("Can't get the contents of specified remote file '#{@params["abs_file_url"]}': #{e.message}")
       end

data/lib/jekyll_include_plugin/utils.rb

@@ -16,7 +16,7 @@ module JekyllIncludePlugin
   module TextUtils
     include Utils
 
-    def pick_snippet(text, snippet_name)
+    def pick_snippet(text, snippet_prefix, snippet_name)
       snippet_content = ""
       snippet_start_found = false
       snippet_end_found = false
@@ -42,8 +42,10 @@ module JekyllIncludePlugin
       abort("End of the snippet '#{snippet_name}' has not been found.") unless snippet_end_found
       abort("Snippet '#{snippet_name}' appears to be empty. Fix and retry.") if snippet_content.empty?
 
+      return snippet_content if snippet_prefix.empty?
+
       first_line_indent = %r!^\s*!.match(snippet_content)[0]
-      return "#{first_line_indent}...\n#{snippet_content}"
+      return "#{first_line_indent}#{snippet_prefix}\n#{snippet_content}"
     end
 
     def remove_all_snippets(text)

data/lib/jekyll_include_plugin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllIncludePlugin
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_include_plugin
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ilya Lesikov
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2025-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -72,7 +71,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
 email:
 - ilya@lesikov.com
 executables: []
@@ -101,7 +99,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/flant/jekyll_include_plugin
   source_code_uri: https://github.com/flant/jekyll_include_plugin
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Plugin for including contents of local/remote plain text files (or parts
   of them) into your pages. Allows for multilang comments in the included files.