md2starter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6283930429a2e7bb005c3661db87f3366b7698f9519ce5489c0ba20088306118
+  data.tar.gz: 6d14a75e7ce890f428840b26db1f01429bfc32e0812d49de5415bc7efad0dda0
+SHA512:
+  metadata.gz: cc9056b8b44529d196912ca81a76abf82458a15df7fcb90f3bd576ea71705a7f870e55d1c8dbfaa42409e9af0246b197e3139c4c58ee96c8444bc10d56fdb868
+  data.tar.gz: 0b848d9e1a16f7452c20db33a7b5b5cbd0d244c37111da6a45a6910c7a55223f750ee2c7e194deafe73c489247ff03399dec8fbf7966d89232fdb355fa1e0628

data/README.md

@@ -0,0 +1,45 @@
+# MD2Starter
+
+MD2Starter is a CLI tool to convert from Markdown into [Re:VIEW Starter](https://kauplan.org/reviewstarter/).
+This command uses Redcarpet gem to parse markdown.
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install md2starter
+
+## Usage
+
+You may convert files using the included executables `md2starter`.
+
+    $ md2starter -h
+    Usage: md2starter INPUT_FILENAME_OR_DIRECTORY [OUTPUT_FILENAME_OR_DIRECTORY] [options]
+            --trace                      Show a full traceback on error
+        -d, --delete                     Delete markdown files
+        -m, --math                       Math markdown enable
+        -h, --help                       Show this message
+        -v, --version                    Print version
+
+See [USAGE.md](./USAGE.md) for more information on Markdown and Starter format notation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## History
+
+### v1.0.0
+- Initial release
+
+## Author
+
+[Atelier Mirai](https://atelier-mirai.net)
+
+## Thanks
+
+This Gem is based on [html2slim](https://github.com/slim-template/html2slim) and [md2review](https://github.com/takahashim/md2review). We thank the authors.
+
+## OFFICIAL REPOSITORY
+
+[https://github.com/Atelier-Mirai/md2starter](https://github.com/Atelier-Mirai/md2starter)

data/bin/md2starter

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.prepend File.dirname(__FILE__) + "/../lib"
+require "md2starter/command"
+
+cmd = MD2Starter::Command.new(ARGV)
+cmd.run

data/lib/md2starter/command.rb

@@ -0,0 +1,104 @@
+require 'optparse'
+require 'md2starter'
+include MD2Starter
+
+module MD2Starter
+  class Command
+    def initialize(args)
+      @args    = args
+      @options = {}
+    end
+
+    def run
+      @opts = OptionParser.new(&method(:set_opts))
+      @opts.parse!(@args)
+      process!
+      exit 0
+    rescue Exception => ex
+      raise ex if @options[:trace] || SystemExit === ex
+      $stderr.print "#{ex.class}: " if ex.class != RuntimeError
+      $stderr.puts ex.message
+      $stderr.puts '  Use --trace for backtrace.'
+      exit 1
+    end
+
+    protected
+
+    def set_opts(opts)
+      opts.banner = "Usage: md2starter INPUT_FILENAME_OR_DIRECTORY [OUTPUT_FILENAME_OR_DIRECTORY] [options]"
+
+      opts.on('--trace', :NONE, 'Show a full traceback on error') do
+        @options[:trace] = true
+      end
+
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+
+      opts.on_tail('-v', '--version', 'Print version') do
+        puts "md2starter #{MD2Starter::VERSION}"
+        exit
+      end
+
+      opts.on('-d', '--delete', "Delete markdown files") do
+        @options[:delete] = true
+      end
+
+      opts.on('-m', '--math', "Math markdown enable") do
+        @options[:math] = true
+      end
+    end
+
+    def process!
+      args = @args.dup
+
+      @options[:input]  = file        = args.shift
+      @options[:input]  = file        = "-" unless file
+      @options[:output] = destination = args.shift
+
+      if file == "-"
+        puts @opts.to_s
+        exit
+      end
+
+      if File.directory?(@options[:input])
+        Dir["#{@options[:input]}/**/*.md"].each { |file| _process(file, destination) }
+      else
+        _process(file, destination)
+      end
+    end
+
+    private
+
+    def input_is_dir?
+      File.directory? @options[:input]
+    end
+
+    def _process(file, destination = nil)
+      require 'fileutils'
+      starter_file = file.sub(/\.md/, '.re')
+
+      if input_is_dir? && destination
+        FileUtils.mkdir_p(File.dirname(starter_file).sub(@options[:input].chomp('/'), destination))
+        starter_file.sub!(@options[:input].chomp('/'), destination)
+      else
+        starter_file = destination || starter_file
+      end
+
+      fail(ArgumentError, "Source and destination files can't be the same.") if @options[:input] != '-' && file == starter_file
+
+      in_file = if @options[:input] == "-"
+        $stdin
+      else
+        File.open(file, 'r')
+      end
+
+      @options[:output] = starter_file && starter_file != '-' ? File.open(starter_file, 'w') : $stdout
+      @options[:output].puts MD2Starter.convert!(in_file, @options)
+      @options[:output].close
+
+      File.delete(file) if @options[:delete]
+    end
+  end
+end

data/lib/md2starter/markdown.rb

@@ -0,0 +1,16 @@
+require "redcarpet"
+require "redcarpet/render/review"
+
+module MD2Starter
+  class Markdown
+    def initialize(render_options, parser_options)
+      ## Redcarpet only
+      render    = Redcarpet::Render::ReVIEW.new(render_options)
+      @markdown = Redcarpet::Markdown.new(render, parser_options)
+    end
+
+    def render(text)
+      @markdown.render(text)
+    end
+  end
+end

data/lib/md2starter/version.rb

@@ -0,0 +1,3 @@
+module MD2Starter
+  VERSION = "1.0.0"
+end

data/lib/md2starter.rb

@@ -0,0 +1,25 @@
+require_relative "md2starter/version"
+require_relative "md2starter/markdown"
+
+module MD2Starter
+  class << self
+    def convert!(input, options)
+      render_extensions = {}
+      render_extensions[:link_in_footnote] = false
+      render_extensions[:table_caption] = true
+      render_extensions[:math] = options[:math] ? true : false
+
+      parse_extensions = {}
+      parse_extensions[:tables] = true
+      parse_extensions[:strikethrough] = true
+      parse_extensions[:fenced_code_blocks] = true
+      parse_extensions[:footnotes] = true
+      parse_extensions[:no_intra_emphasis] = true
+      parse_extensions[:autolink] = true
+
+      md          = MD2Starter::Markdown.new(render_extensions, parse_extensions)
+      md_doc      = open(input).read
+      starter_doc = md.render(md_doc)
+    end
+  end
+end

data/lib/redcarpet/render/review.rb

@@ -0,0 +1,423 @@
+# frozen_string_literal: false
+
+require 'digest/md5'
+require 'uri'
+
+module Redcarpet
+  module Render
+    class ReVIEW < Base
+
+      # initialize
+      ########################################################################
+      def initialize(render_extensions={})
+        super()
+        @math = render_extensions[:math]
+        @links = {}
+        @math_inline_buf = []
+        @math_block_buf = []
+        @ruby_buf = []
+      end
+
+      # preprocess
+      ########################################################################
+      def preprocess(text)
+        b_counter = -1
+        while %r|\$\$(.+?)\$\$| =~ text
+          text.sub!(%r|\$\$(.+?)\$\$|) do
+            b_counter += 1
+            @math_block_buf[b_counter] = $1
+            "〓MATHBLOCK:#{b_counter}:〓"
+          end
+        end
+
+        if @math
+          i_counter = -1
+          while %r|\$(.+?)\$| =~ text
+            text.sub!(%r|\$(.+?)\$|) do
+              i_counter += 1
+              @math_inline_buf[i_counter] = $1
+              "〓MATHINLINE:#{i_counter}:〓"
+            end
+          end
+        end
+
+        # るび
+        r_counter = -1
+        while %r|\{(.+?\|.+?)\}| =~ text
+          text.sub!(%r|\{(.+?\|.+?)\}|) do
+            r_counter += 1
+            @ruby_buf[r_counter] = $1
+            "〓RUBY:#{r_counter}:〓"
+          end
+        end
+
+        text
+      end
+
+      # normal text
+      ########################################################################
+      def normal_text(text)
+        text
+      end
+
+      # escape
+      ########################################################################
+      def escape_inline(text)
+        ## }  -> \}
+        ## \} -> \\\}
+        ## .}  -> .\}
+        text.gsub(/(.)?}/) do
+          if $1 == '\\'
+            replaced = '\\\\\\}'
+          elsif $1
+            replaced = $1 + '\\}'
+          else
+            replaced = '\\}'
+          end
+          replaced
+        end
+      end
+
+      def escape_href(text)
+        text.to_s.gsub(/,/){ '\\,' }
+      end
+      alias_method :escape_comma, :escape_href
+
+      # block code
+      ########################################################################
+      def block_code(code, language)
+        code_text = normal_text(code).chomp
+        lang      = ""
+        caption   = ""
+
+        if language
+          # lang, caption = "java: main.java".split(":").map(&:strip)
+          lang, caption = language.split(":").map(&:strip)
+
+          # if language =~ /caption=\"(.*)\"/
+          #   caption = "["+$1+"]"
+          # else
+            # caption = "[][#{language}]"
+          # end
+        end
+
+        if lang == "math"
+          "//texequation[][#{caption}]{\n#{code.chomp}\n//}\n\n"
+        elsif lang == "output"
+          "//output[][#{caption}]{\n#{code_text}\n//}\n\n"
+        elsif lang == "terminal"
+          "//terminal[][#{caption}]{\n#{code_text}\n//}\n\n"
+        elsif lang == "note"
+          "//note[][#{caption}]{\n#{code_text}\n//}\n\n"
+        elsif lang == "memo"
+          "//memo[#{caption}]{\n#{code_text}\n//}\n\n"
+        elsif lang == "tip"
+          "//tip[#{caption}]{\n#{code_text}\n//}\n\n"
+        elsif lang == "info"
+          "//info[#{caption}]{\n#{code_text}\n//}\n\n"
+        elsif lang == "warning"
+          "//warning[#{caption}]{\n#{code_text}\n//}\n\n"
+        elsif lang == "important"
+          "//important[#{caption}]{\n#{code_text}\n//}\n\n"
+        elsif lang == "caution"
+          "//caution[#{caption}]{\n#{code_text}\n//}\n\n"
+        elsif lang == "notice"
+          "//notice[#{caption}]{\n#{code_text}\n//}\n\n"
+        elsif lang == "column"
+          "===[column] #{caption}\n#{code_text}\n\n===[/column]\n\n"
+        elsif lang == "flushright"
+          "//flushright{\n#{code_text}\n//}\n\n"
+        elsif lang == "centering"
+          "//centering{\n#{code_text}\n//}\n\n"
+        elsif lang == "abstract"
+          if caption.nil? || caption == "toc=on"
+            "//abstract{\n#{code_text}\n//}\n\n//makechaptitlepage[toc=on]\n\n"
+          else
+            "//abstract{\n#{code_text}\n//}\n\n"
+          end
+        elsif lang == "chapterauthor"
+          if caption.nil? || caption.empty?
+            "//chapterauthor[#{code_text}]\n\n"
+          else
+            "//chapterauthor[#{caption}]\n\n"
+          end
+        elsif lang == "include"
+          filename = File&.basename(caption.to_s)
+          "//list[][#{filename}][file=source/#{caption},1]{\n//}\n\n"
+        elsif lang == "image" || lang == "sideimage"
+          if !code_text.empty?
+            link = caption + '&content=' + code_text
+          else
+            link = caption
+          end
+          title = ""
+          alt_text = ""
+          image(link, title, alt_text) + "\n\n"
+        else
+          "//list[][#{caption}][1]{\n#{code_text}\n//}\n\n"
+        end
+      end
+
+      # codespan
+      ########################################################################
+      def codespan(code)
+        "@<code>{#{escape_inline(code)}}"
+      end
+
+      def block_quote(quote)
+        quote_text = normal_text(quote).chomp
+        quote_text.gsub!(/\A\n\n/, '')
+        "//quote{\n#{quote_text}//}\n\n"
+      end
+
+      def block_html(raw_html)
+        html_text = raw_html.chomp
+
+        # html コメントなら 何も出力しない
+        if html_text[0..3] == "<!--" && html_text[-3..-1] == "-->"
+          return
+        end
+
+        # エラーメッセージを表示
+        warning = "XXX: BLOCK_HTML: YOU SHOULD REWRITE IT"
+        "\n//list[][]{\n#{warning}\n#{html_text}\n//}\n"
+      end
+
+
+      # header
+      ########################################################################
+      def header(title, level, anchor="")
+        "#{"="*level} #{title}\n"
+      end
+
+      # table
+      ########################################################################
+      def paragraph(text)
+        if text =~ /\ATable:(.*)\z/
+          @table_caption = $1.strip
+          "" # no output line
+        elsif text =~ /\Achapterauthor:(.*)\z/
+          @chapterauthor = $1.strip
+          "//chapterauthor[#{@chapterauthor}]\n\n"
+        elsif text =~ /\Ainclude:(.*)\z/
+            link = $1.strip
+            filename = File.basename(link)
+            "//list[][#{filename}][file=source/#{link},1]{\n//}\n\n"
+        else
+          # "\n\n#{text}\n\n"
+          "#{text}\n\n"
+        end
+      end
+
+      def table(header, body)
+        body.chomp!
+
+        if @table_caption
+          caption = @table_caption
+          @table_caption = nil
+        end
+
+        column_count = 0
+        body.each_line do |line|
+          column_count = line.split(",").size
+          break
+        end
+
+        tsize = "//tsize[][#{'|l'*column_count+'|'}]\n"
+        "#{tsize}//table[][#{caption}][csv=on,headerrows=1]{\n#{header}#{body}\n//}\n\n"
+      end
+
+      def table_row(content)
+        @sep = nil
+        content+"\n"
+      end
+
+      def table_cell(content, alignment)
+        sep = @sep
+        @sep = ", "
+        if content == ""
+          content = " "
+        end
+        "#{sep}#{content}"
+      end
+
+      # image
+      ########################################################################
+      def image(link, title, alt_text)
+        allowed_params = %w(width border side sep boxwidth content caption)
+
+        path, query = link.split("?")
+        filename = File.basename(path, ".*")
+
+        if query
+          query.gsub!("&", ",")
+          hash = query.split(",").map { |attr| attr&.split("=") }.to_h
+
+          # Remove unauthorized parameters
+          hash.each do |key, value|
+            !allowed_params.include? key and hash.delete(key)
+          end
+
+          if hash.key? "caption"
+            alt_text = hash["caption"]
+            hash.delete("caption")
+          end
+
+          # for sideimage
+          sideimage = "side" if hash.key? "side"
+          width     = hash.delete("width") if sideimage
+          content   = hash.delete("content")
+          content << "\n" if content
+          option    = hash.map { |k, v| [k, v].join("=") }.join(",")
+        end
+
+        if sideimage
+          "//sideimage[#{filename}][#{width}][#{option}]{\n#{content}//}"
+        else
+          "//image[#{filename}][#{alt_text}][#{option}]"
+        end
+      end
+
+      # link
+      ########################################################################
+      def autolink(link, link_type)
+        "@<href>{#{link}}"
+      end
+
+      def link(link, title, content)
+        if content == "include"
+          filename = File.basename(link)
+          "//list[][#{filename}][file=source/#{link},1]{\n//}"
+        else
+          "@<href>{#{link},#{content}}"
+        end
+      end
+
+      # decoration
+      ########################################################################
+      def emphasis(text)
+        sandwitch_link('b', text)
+      end
+
+      def double_emphasis(text)
+        "@<B>{#{escape_inline(text)}}"
+      end
+
+      def strikethrough(text)
+        "@<del>{#{escape_inline(text)}}"
+      end
+
+      # list
+      ########################################################################
+      def list(content, list_type)
+        ret = ""
+        content.each_line do |item|
+          case list_type
+          when :ordered
+            if item =~ /^ +(\d+\.) (.*)/
+              ## XXX not support yet in Re:VIEW
+              ret << " #{$1} #{$2.chomp}" << "\n"
+            else
+              ret << " 1. " << item
+            end
+          when :unordered
+            if item =~ /^ (\*+) (.*)/
+              ret << " *#{$1} #{$2.chomp}" << "\n"
+            else
+              ret << " * " << item
+            end
+          else
+            # :nocov:
+            raise "invalid type: #{list_type}"
+            # :nocov:
+          end
+        end
+        ret << "\n"
+        ret
+      end
+
+      def list_item(content, list_type)
+        content.gsub!(%r<\n//(image|indepimage)\[([^\]]*?)\][^\{]*({\n//})?\n>){
+          "@<icon>{"+$2+"}\n"
+        }
+        case list_type
+        when :ordered
+          item = content.gsub(/\n(\s+[^0-9])/){ $1 }.gsub(/\n(\s+[0-9]+[^.])/){ $1 }.strip
+          "#{item}\n"
+        when :unordered
+          item = content.gsub(/\n(\s*[^* ])/){ $1 }.strip
+          "#{item}\n"
+        else
+          # :nocov:
+          raise "invalid type: #{list_type}"
+          # :nocov:
+        end
+      end
+
+      # hr / br
+      ########################################################################
+      def hrule
+        "//hr\n\n"
+      end
+
+      def linebreak
+        "@<br>{}\n"
+      end
+
+      # footnote
+      ########################################################################
+      def footnote_ref(number)
+        "@<fn>{#{number}}"
+      end
+
+      def footnotes(text)
+        "#{text}"
+      end
+
+      def footnote_def(text, number)
+        "//footnote[#{number}][#{text.strip}]\n"
+      end
+
+      # ruby
+      ########################################################################
+      def ruby(text)
+        rt, rb = text.split(/\|/, 2)
+        "@<ruby>{#{escape_inline(rt)},#{escape_inline(rb)}}"
+      end
+
+      # postprocess
+      ########################################################################
+      def postprocess(text)
+        text = text.gsub(%r|^[ \t]+(//image\[[^\]]+\]\[[^\]]+\]{$\n^//})|, '\1')
+        while %r|〓MATHBLOCK:(\d+):〓| =~ text
+          # text.sub!(%r|〓MATHBLOCK:(\d+):〓|){ "\n//texequation[][]{\n" + escape_inline(@math_block_buf[$1.to_i]) + "\n//}\n" }
+          text.sub!(%r|〓MATHBLOCK:(\d+):〓|){ "\n//texequation[][]{\n" + (@math_block_buf[$1.to_i]) + "\n//}\n" }
+        end
+
+        while %r|〓MATHINLINE:(\d+):〓| =~ text
+          text.sub!(%r|〓MATHINLINE:(\d+):〓|){ "@<m>{" + escape_inline(@math_inline_buf[$1.to_i]) + "}" }
+        end
+
+        while %r|〓RUBY:(\d+):〓| =~ text
+          text.sub!(%r|〓RUBY:(\d+):〓|){ ruby(@ruby_buf[$1.to_i]) }
+        end
+
+        text + @links.map { |key, link| footnote_def(link, key) }.join
+      end
+
+      def remove_inline_markups(text)
+        text.gsub(/@<(?:b|strong|tt)>{([^}]*)}/, '\1')
+      end
+
+      def sandwitch_link(op, text)
+        head, match, tail = text.partition(/@<href>{(?:\\,|[^}])*}/)
+
+        if match.empty? && tail.empty?
+          return "@<#{op}>{#{escape_inline(text)}}"
+        end
+
+        sandwitch_link(op, head) + match + sandwitch_link(op, tail)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: md2starter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Atelier Mirai
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-13 00:00:00.000000000 Z
+dependencies: []
+description: A converter from Markdown to Re:VIEW Starter. It uses redcarpet.
+email:
+- contact@atelier-mirai.net
+executables:
+- md2starter
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/md2starter
+- lib/md2starter.rb
+- lib/md2starter/command.rb
+- lib/md2starter/markdown.rb
+- lib/md2starter/version.rb
+- lib/redcarpet/render/review.rb
+homepage: https://github.com/Atelier-Mirai/md2starter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Atelier-Mirai/md2starter
+  source_code_uri: https://github.com/Atelier-Mirai/md2starter
+  changelog_uri: https://github.com/Atelier-Mirai/md2starter/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A converter from Markdown to Re:VIEW Starter.
+test_files: []