jekyll-liquid-debug 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1109cf5a8b8b59ad63c3b67306271b5869d00bbd42ce493cd5e1acf8b80129ee
+  data.tar.gz: 0ea7545d75b22f72836a2f30ad7c860ab2523caea96cec7c423223165fead59f
+SHA512:
+  metadata.gz: b88284680b4f74b5385d431464cd7fca10a988fdf5c5365f1a68d6d41f6ce240075cf97f782b014e0714f89c68e100cc9710178d1ef248df0f8f0576c33f439f
+  data.tar.gz: 7afff85a938255f81e48a3c26d9a046a88ca5de74eb1f2bce1fd83fa04f3e9b6f686fa8ee3935354381b845f16d51ba26d26e3ffba5313c95db852d900dfdd2f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Xiang Zhong
+
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll-liquid-debug"
+
+# 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/jekyll-liquid-debug

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "jekyll-liquid-debug"
+
+JekyllLiquidDebug.run

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/data/jekyll-markdown.md

@@ -0,0 +1,331 @@
+---
+sort: 1
+images:
+  - title: image-title
+    link: https://image-link.com
+    image: https://image-image.com
+---
+
+# Markdown
+
+This file is intentionally created for `liquid template` debugging.
+
+
+
+# Line consecutive
+
+line consecutive 1/3. There should be whitespace between paragraphs.
+line consecutive 2/3. There should be whitespace between paragraphs.
+line consecutive 3/3. There should be whitespace between paragraphs.
+
+
+
+# Line horizontal
+
+horizontal line -- 1/3
+
+----------------------
+
+horizontal line -- 2/3
+
+----------------------
+
+horizontal line -- 3/3
+
+----------------------
+
+# Paragraph
+
+paragraph 1/3. There should be whitespace between paragraphs.
+
+paragraph 2/3. There should be whitespace between paragraphs.
+
+paragraph 3/3. There should be whitespace between paragraphs.
+
+
+
+# Text
+
+text decoration 1/3. Text can be `code`, **bold**, _italic_, or ~~strikethrough~~. [Links](https://github.com)
+
+text decoration 2/3. Text can be `code`, **bold**, _italic_, or ~~strikethrough~~. [Links](https://github.com)
+
+text decoration 3/3. Text can be `code`, **bold**, _italic_, or ~~strikethrough~~. [Links](https://github.com)
+
+
+
+# Blockquote
+
+> blockquote 1/3 should be a lighter gray with a gray border along the left side.
+> consecutive top
+> 
+> another line
+
+> blockquote 2/3 should be a lighter gray with a gray border along the left side.
+> consecutive top
+> 
+> another line
+
+> blockquote 3/3 should be a lighter gray with a gray border along the left side.
+> consecutive top
+> 
+> another line
+
+
+
+# Headers
+
+# Header 1 -- 1/3
+
+head-1-content -- 1/3
+
+# Header 1 -- 2/3
+
+head-1-content -- 2/3
+
+# Header 1 -- 3/3
+
+head-1-content -- 3/3
+
+
+
+## Header 2 -- 1/3
+
+head-2-content -- 1/3
+
+## Header 2 -- 2/3
+
+head-2-content -- 2/3
+
+## Header 2 -- 3/3
+
+head-2-content -- 3/3
+
+
+
+### Header 3 -- 1/3
+
+head-3-content -- 1/3
+
+### Header 3 -- 2/3
+
+head-3-content -- 2/3
+
+### Header 3 -- 3/3
+
+head-3-content -- 3/3
+
+
+
+#### Header 4 -- 1/3
+
+head-4-content -- 1/3
+
+#### Header 4 -- 2/3
+
+head-4-content -- 2/3
+
+#### Header 4 -- 3/3
+
+head-4-content -- 3/3
+
+
+
+##### Header 5 -- 1/3
+
+head-5-content -- 1/3
+
+##### Header 5 -- 2/3
+
+head-5-content -- 2/3
+
+##### Header 5 -- 3/3
+
+head-5-content -- 3/3
+
+
+
+###### Header 6 -- 1/3
+
+head-6-content -- 1/3
+
+###### Header 6 -- 2/3
+
+head-6-content -- 2/3
+
+###### Header 6 -- 3/3
+
+head-6-content -- 3/3
+
+
+
+# Code block without header
+
+```
+code block without header  1/3
+```
+
+```
+code block without header  2/3
+```
+
+```
+code block without header  3/3
+```
+
+
+
+# Code block with header
+
+```header
+code block with header  1/3
+```
+
+```header
+code block with header  2/3
+```
+
+```header
+code block with header  3/3
+```
+
+
+
+# List Unordered
+
+* This is an unordered list  1/6
+* This is an unordered list  2/6
+* This is an unordered list  3/6
+
+* This is an unordered list  4/6
+
+* This is an unordered list  5/6
+
+* This is an unordered list  6/6
+
+
+
+# List Ordered
+
+1. This is an ordered list  1/6
+2. This is an ordered list  2/6
+3. This is an ordered list  3/6
+
+4. This is an ordered list  4/6
+
+5. This is an ordered list  5/6
+
+6. This is an ordered list  6/6
+
+
+
+# List checking
+
+- [x] checked list
+
+- [ ] unchecked list
+
+- [x] checked list
+
+1. [ ] unchecked list
+
+2. [x] checked list
+
+3. [ ] unchecked list
+
+
+
+# List nested
+
+* unordered list
+  * unordered list
+    * unordered list
+    * unordered list
+  1. ordered list
+     1. ordered list
+     2. ordered list
+  2. ordered list
+
+* unordered list
+  * unordered list
+    * unordered list
+    * unordered list
+  1. ordered list
+     1. ordered list
+     2. ordered list
+  2. ordered list
+
+* unordered list
+  * unordered list
+    * unordered list
+    * unordered list
+  1. ordered list
+     1. ordered list
+     2. ordered list
+  2. ordered list
+
+
+
+# Description table
+
+<dl>
+    <dt>Song</dt>
+    <dd>Hello</dd>
+    <dt>Planet</dt>
+    <dd>Earth</dd>
+</dl>
+
+
+<dl>
+    <dt>Song</dt>
+    <dd>Hello</dd>
+    <dt>Planet</dt>
+    <dd>Earth</dd>
+</dl>
+
+
+<dl>
+    <dt>Song</dt>
+    <dd>Hello</dd>
+    <dt>Planet</dt>
+    <dd>Earth</dd>
+</dl>
+
+
+
+# Table
+
+|  What  |  Header  |   Note   |
+|--------|----------|----------|
+| entry  | content  |   1/3    |
+
+
+|  What  |  Header  |   Note   |
+|--------|----------|----------|
+| entry  | content  |   2/3    |
+
+
+|  What  |  Header  |   Note   |
+|--------|----------|----------|
+| entry  | content  |   3/3    |
+
+
+
+# Mixing
+
+`code in line`, **`bold code`**, ~~`stroke through code`~~, ~~_italic stroke through_~~
+
+`code in line`, **`bold code`**, ~~`stroke through code`~~, ~~_italic stroke through_~~
+
+`code in line`, **`bold code`**, ~~`stroke through code`~~, ~~_italic stroke through_~~
+
+
+
+# Image here-rendering
+
+![Octocat](https://github.githubassets.com/images/icons/emoji/octocat.png)
+
+![Octocat](https://github.githubassets.com/images/icons/emoji/octocat.png)
+
+![Octocat](https://github.githubassets.com/images/icons/emoji/octocat.png)
+

data/jekyll-liquid-debug.gemspec

@@ -0,0 +1,17 @@
+require_relative "lib/jekyll-liquid-debug/version"
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = ">= 2.5.0"
+  s.name          = "jekyll-liquid-debug"
+  s.version       = VERSION
+  s.authors       = ["Xiang Zhong"]
+  s.email         = ["zhongxiang117@gmail.com"]
+  s.summary       = "Light Weight Jekyll Liquid Template Debug Package"
+  s.license       = "MIT"
+  s.homepage      = "https://github.com/zhongxiang117/jekyll-liquid-debug"
+  s.files         = Dir["bin/*","data/*","lib/**/*", "jekyll-liquid-debug.gemspec", "LICENSE"]
+  s.require_paths = ["lib"]
+
+  s.add_dependency("liquid", "~> 4.0.0")
+  s.add_dependency("kramdown", "~> 2.3.0")
+end

data/lib/jekyll-liquid-debug.rb

@@ -0,0 +1,116 @@
+require "liquid"
+require "kramdown"
+require "optparse"
+require_relative "jekyll-liquid-debug/version"
+
+class JekyllLiquidDebug
+  class Parser
+    def self.parse(options)
+      # Hash to contain all settings
+      # it is needed to set default values, to help use Struct make Hash dottable.
+      # because Struct does not have method to check whether key exists
+      args = {file:false, html:false, kmd:false, outhtml:false, outmd:false}
+      OptionParser.new do |opt|
+        opt.banner = "Usage: jekyll-liquid-debug [options]"
+        opt.separator ""
+        opt.separator "Input files:"
+
+        opt.on("-f", "--file [FILE]", String, "input liquid template") do |v|
+          args[:file] = Parser.func_set_file(v)
+        end
+
+        opt.on("-t", "--html [FILE]", String, "input html template") do |v|
+          args[:html] = Parser.func_set_file(v)
+        end
+
+        opt.on("-k", "--md [FILE]", String, "input raw markdown file, precedent for option `-t'") do |v|
+          args[:kmd] = Parser.func_set_file(v)
+        end
+
+        opt.on("--out-html", TrueClass, "output html file, overwrite may happen") do |v|
+          args[:outhtml] = true
+        end
+
+        opt.on("--out-md", TrueClass, "output markdown file, overwrite may happen") do |v|
+          args[:outmd] = true
+        end
+
+        opt.separator ""
+        opt.separator "Common options:"
+        opt.on_tail("-h", "--help", "Show help message") do
+          puts opt
+          exit
+        end
+        opt.on_tail("-v", "--version", "Show version") do
+          puts "Version #{VERSION}"
+          exit
+        end
+        opt.on_tail("--feature", "Show development feature") do
+          FEATURE.each { |x| puts x }
+          exit
+        end
+      end.parse!(options)
+
+      return args
+    end
+
+    def self.func_set_file(file)
+      if File.file?(file)
+        return file
+      else
+        puts "Fatal: < #{file} > is not a file"
+        exit
+      end
+    end
+  end
+
+
+  def self.run
+    args = Parser.parse(ARGV)
+    # make Hash dottable
+    args = Struct.new(*args.keys).new(*args.values)
+
+    if args.kmd
+      puts "Note: using input markdown file < #{args.kmd} >"
+      # read input markdown
+      fmd = File.open(args.kmd).read
+      # html conversion
+      content = Kramdown::Document.new(fmd).to_html
+      fbase = File.basename(args.kmd,".*")
+    elsif args.html
+      puts "Note: using input html file < #{args.html} >"
+      fmd = false
+      content = File.open(args.html).read
+      fbase = File.basename(args.html,".*")
+    else
+      puts "Note: using default markdown file < jekyll-markdown.md >"
+      fmd = File.open(File.expand_path("../../data/jekyll-markdown.md",__FILE__)).read
+      content = Kramdown::Document.new(fmd).to_html
+      fbase = 'jekyll-markdown'
+    end
+
+    # output html
+    if args.outhtml
+      name = fbase + ".html"
+      puts "Note: writing < html > to file < #{name} >"
+      File.new(name,'w').write(content)
+    end
+
+    # output markdown
+    if args.outmd
+      if args.html
+        name = "jekyll-markdown.md"
+        FileUtils.cp(File.expand_path("../../data/jekyll-markdown.md",__FILE__), '.')
+      else
+        name = fbase + ".md"
+        File.new(name,'w').write(fmd)
+      end
+      puts "Note: writing < markdown > to file < #{name} >"
+    end
+
+    if args.file
+      liquid = File.open(args.file).read
+      puts Liquid::Template.parse(liquid).render("content" => content)
+    end
+  end
+end

data/lib/jekyll-liquid-debug/version.rb

@@ -0,0 +1,8 @@
+VERSION = '0.2.2'
+
+FEATURE = [
+  '* Version 0.1.0: Ruby-liquid Debug',
+  '* Version 0.2.0: Add Kramdown conversion',
+  '* Version 0.2.1: Change args type from Struct to Hash',
+  '* Version 0.2.2: Optimize the combination of options',
+]

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-liquid-debug
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Xiang Zhong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-30 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description: 
+email:
+- zhongxiang117@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- bin/console
+- bin/jekyll-liquid-debug
+- bin/setup
+- data/jekyll-markdown.md
+- jekyll-liquid-debug.gemspec
+- lib/jekyll-liquid-debug.rb
+- lib/jekyll-liquid-debug/version.rb
+homepage: https://github.com/zhongxiang117/jekyll-liquid-debug
+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.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Light Weight Jekyll Liquid Template Debug Package
+test_files: []