jekyll_include_plugin 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53b0e6e7b0dbd571c517660e123f56720943bd007d46d3c3103d3b101db3e357
+  data.tar.gz: fe4f1a211570c08cffb2facfc05b4af31e12c4fccb45930f55f26bd86abb85d5
+SHA512:
+  metadata.gz: da56e27aa2e81e3970ce743fb47c7d8d1a3560b0a4b26910c741bdbeee2db9faaccb48cea2573c123057c87a584ebff58c7450729831607bf00f1b10611074b9
+  data.tar.gz: 4240470f917c00c2c54be13356a9b01429ae655241f075de2e99bccf7b471ea670c00f5541bef273f90418ade94c05e38c526238e91d18f5740f69acd9a1999e

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.5
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    jekyll_include_plugin (1.0.0)
+      jekyll (~> 3.9.1)
+      liquid (~> 4.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    em-websocket (0.5.2)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.15.3)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.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.5.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.3.6)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rouge (3.26.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll_include_plugin!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Flant
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# Jekyll Include Plugin
+
+Include local/remote file contents (or part of it) into your pages.
+Allows multilang comments in the included files, which language will be used depends on `{{ page.lang }}`.
+
+## Usage
+
+Basic usage as follows:
+
+```jinja
+jekyllroot/pages/foo.md:
+-----------------------
+lang: en
+-----------------------
+{% include_file "this_dir_is_inside_jekyll_root_dir/foo/Dockerfile" snippet="system_deps" syntax="Dockerfile" %}
+```
+
+```Dockerfile
+this_dir_is_inside_jekyll_root_dir/foo/Dockerfile:
+--------------------------------------------------------
+FROM ruby
+
+# [<snippet install_system_deps>]
+# [<en>] Install system dependencies
+# [<en>] (multiline possible too)
+# [<ru>] Установка системных зависимостей
+RUN apt update && apt install curl -y
+# [<endsnippet install_system_deps>]
+```
+
+Result:
+```Dockerfile
+# Install system dependencies
+# (multiline possible too)
+RUN apt update && apt install curl -y
+```
+
+Include whole file:
+```jinja
+{% include_file "Dockerfile" %}
+```
+
+Include remote file:
+```jinja
+{% include_file "https://raw.githubusercontent.com/werf/werf-guides/master/examples/rails/010_build/Dockerfile" %}
+```
+
+Dynamic parameters:
+```jinja
+{% include_file "{{ $templatingAllowedHere }}" snippet="{{ $hereToo }}" %}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll_include_plugin'
+```
+
+And this into your Jekyll config:
+```yaml
+plugins:
+  - jekyll_include_plugin
+```
+
+Then execute:
+```bash
+bundle install
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+# require "rubocop/rake_task"
+
+# RuboCop::RakeTask.new
+
+task default: %i[spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "jekyll_include_plugin"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll_include_plugin.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("lib", __dir__))
+require_relative "lib/jekyll_include_plugin/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll_include_plugin"
+  spec.version       = JekyllIncludePlugin::VERSION
+  spec.authors       = ["Ilya Lesikov"]
+  spec.email         = ["ilya@lesikov.com"]
+
+  spec.summary       = "Include files or file samples into Markdown"
+  # spec.description   = "TODO: Write a longer description or delete this line."
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.3"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "liquid", "~> 4.0.3"
+  spec.add_runtime_dependency "jekyll", "~> 3.9.1"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  # spec.add_development_dependency "rubocop", "~> 1.7"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/jekyll_include_plugin.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "jekyll_include_plugin/version"
+require_relative "jekyll_include_plugin/utils"
+require_relative "jekyll_include_plugin/jekyll_include_plugin"
+
+Liquid::Template.register_tag("include_file", JekyllIncludePlugin::IncludeFileTag)

data/lib/jekyll_include_plugin/jekyll_include_plugin.rb

@@ -0,0 +1,101 @@
+# TODO: don't read the whole file into the memory from the beginning, instead process file with the parser line by line
+require "open-uri"
+require "liquid"
+
+module JekyllIncludePlugin
+  class IncludeFileTag < Liquid::Tag
+    include Utils
+    include TextUtils
+
+    def initialize(tag_name, raw_markup, tokens)
+      super
+      @raw_markup = raw_markup
+      @params = {}
+    end
+
+    def render(context)
+      parse_params(context)
+
+      file_contents = get_raw_file_contents(context)
+
+      if @params["snippet"]
+        file_contents = pick_snippet(file_contents, @params["snippet"])
+      else
+        file_contents = remove_all_snippets(file_contents)
+      end
+
+      file_contents = remove_excessive_newlines(file_contents)
+      file_contents = remove_excessive_indentation(file_contents)
+      file_contents = render_comments(file_contents, context.registers[:page]["lang"])
+      file_contents = wrap_in_codeblock(file_contents, @params["syntax"]) if @params["syntax"]
+
+      return file_contents
+    end
+
+    private
+
+    def parse_params(context)
+      rendered_markup = Liquid::Template
+        .parse(@raw_markup)
+        .render(context)
+        .gsub(%r!\\\{\\\{|\\\{\\%!, '\{\{' => "{{", '\{\%' => "{%")
+        .strip
+      debug("Rendered params: #{rendered_markup}")
+
+      markup = %r!^"?(?<path>[^\s\"]+)"?(?<params>(\s+\w+="[^\"]+")*)?$!.match(rendered_markup)
+      debug("Matched params: #{markup.inspect}")
+      abort("Can't parse include_file tag params: #{@raw_markup}") unless markup
+
+      if markup[:params]
+        @params = Hash[ *markup[:params].scan(%r!(?<param>[^\s="]+)(?:="(?<value>[^"]+)")?\s?!).flatten ]
+      end
+
+      if %r!^https?://\S+$!.match?(markup[:path])
+        @params["abs_file_url"] = markup[:path]
+      else
+        @params["rel_file_path"] = markup[:path]
+      end
+
+      validate_param_by_regex("snippet", "^[-_.a-zA-Z0-9]+$")
+      validate_param_by_regex("syntax", "^[-_.a-zA-Z0-9]+$")
+
+      debug("Params set: #{@params.inspect}")
+    end
+
+    def validate_param_by_regex(param_name, param_regex)
+      if @params[param_name] && ! %r!#{param_regex}!.match?(@params[param_name])
+        abort("Parameter '#{param_name}' with value '#{@params[param_name]}' is not valid, must match regex: #{param_regex}")
+      end
+    end
+
+    def get_raw_file_contents(context)
+      if @params["abs_file_url"]
+        return get_remote_file_contents()
+      elsif @params["rel_file_path"]
+        return get_local_file_contents(context)
+      end
+      raise "Neither abs_file_url nor rel_file_path have been found"
+    end
+
+    def get_local_file_contents(context)
+      base_source_dir = File.expand_path(context.registers[:site].config["source"]).freeze
+      abs_file_path = File.join(base_source_dir, @params["rel_file_path"])
+
+      begin
+        debug("Getting contents of specified local file: #{abs_file_path}")
+        return File.read(abs_file_path, **context.registers[:site].file_read_opts)
+      rescue SystemCallError, IOError => e
+        abort("Can't get the contents of specified local file '#{abs_file_path}': #{e.message}")
+      end
+    end
+
+    def get_remote_file_contents()
+      begin
+        debug("Getting contents of specified remote file: #{@params["abs_file_url"]}")
+        return 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
+    end
+  end
+end

data/lib/jekyll_include_plugin/utils.rb

@@ -0,0 +1,116 @@
+module JekyllIncludePlugin
+  module Utils
+    def debug(msg)
+      Jekyll.logger.debug("[jekyll_include_plugin] DEBUG:", msg)
+    end
+
+    def info(msg)
+      Jekyll.logger.info("[jekyll_include_plugin] INFO:", msg)
+    end
+
+    def abort(msg)
+      Jekyll.logger.abort_with("[jekyll_include_plugin] FATAL:", msg)
+    end
+  end
+
+  module TextUtils
+    include Utils
+
+    def pick_snippet(text, snippet_name)
+      snippet_content = ""
+      snippet_start_found = false
+      snippet_end_found = false
+      text.each_line do |line|
+        if %r!\[<snippet\s+#{snippet_name}>\]!.match?(line)
+          if snippet_start_found
+            abort("Snippet '#{snippet_name}' occured twice. Each snippet should have a unique name, same name not allowed.")
+          end
+          snippet_start_found = true
+          debug("Snippet '#{snippet_name}' start matched by line: #{line}")
+        elsif %r!\[<endsnippet\s+#{snippet_name}>\]!.match?(line)
+          snippet_end_found = true
+          debug("Snippet '#{snippet_name}' end matched by line: #{line}")
+          break
+        elsif %r!\[<(end)?snippet\s+[^>]+>\]!.match?(line)
+          debug("Skipping line with non-relevant (end)snippet: #{line}")
+          next
+        elsif snippet_start_found
+          snippet_content += line
+        end
+      end
+      abort("Snippet '#{snippet_name}' has not been found.") unless snippet_start_found
+      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
+    end
+
+    def remove_all_snippets(text)
+      result_text = ""
+      text.each_line do |line|
+        if %r!\[<(end)?snippet\s+[^>]+>\]!.match?(line)
+          debug("Skipping line with non-relevant (end)snippet: #{line}")
+          next
+        else
+          result_text += line
+        end
+      end
+
+      return result_text
+    end
+
+    def render_comments(text, lang)
+      rendered_file_contents = ""
+      text.each_line do |line|
+        if %r!\[<#{lang}>\]!.match?(line)
+          debug("Matched doc line: #{line}")
+          rendered_file_contents += line.sub(/\[<#{lang}>\]\s*/, "")
+        elsif %r!\[<\w+>\]!.match?(line)
+          debug("Found non-matching doc line, skipping: #{line}")
+          next
+        else
+          rendered_file_contents += line
+        end
+      end
+
+      return rendered_file_contents
+    end
+
+    def remove_excessive_newlines(text)
+      return text.sub(/^(\s*\R)*/, "").rstrip()
+    end
+
+    def remove_excessive_indentation(text)
+      unindented_text = ""
+
+      lowest_indent = nil
+      text.each_line do |line|
+        if %r!^\s*$!.match?(line)
+          next
+        else
+          cur_indent = %r!^\s*!.match(line)[0].length
+          lowest_indent = cur_indent if lowest_indent.nil? || lowest_indent > cur_indent
+        end
+      end
+      return text if lowest_indent.nil?
+
+      text.each_line do |line|
+        if blank_line?(line)
+          unindented_text += line
+        else
+          unindented_text += line[lowest_indent..-1]
+        end
+      end
+
+      return unindented_text
+    end
+
+    def wrap_in_codeblock(text, syntax)
+      return "```#{syntax}\n#{text}\n```"
+    end
+
+    def blank_line?(line)
+      return %r!^\s*$!.match?(line)
+    end
+  end
+end

data/lib/jekyll_include_plugin/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_include_plugin
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ilya Lesikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- ilya@lesikov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll_include_plugin.gemspec
+- lib/jekyll_include_plugin.rb
+- lib/jekyll_include_plugin/jekyll_include_plugin.rb
+- lib/jekyll_include_plugin/utils.rb
+- lib/jekyll_include_plugin/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Include files or file samples into Markdown
+test_files: []