review-retrovert 0.9.7 → 0.9.8

data/lib/review/retrovert/reviewcompat.rb

@@ -0,0 +1,57 @@
+require 'review'
+
+module ReVIEW
+  module Retrovert
+    class Preprocessor
+      @preprocessor = nil
+
+      def initialize(param)
+        if Gem::Version.new(ReVIEW::VERSION) >= Gem::Version.new('5.2.0')
+          @preprocessor = ReVIEW::Preprocessor.new(param)
+        else
+          @preprocessor = ReVIEW::Preprocessor.new(ReVIEW::Repository.new(param), param)
+        end
+      end
+
+      def process(path)
+        if Gem::Version.new(ReVIEW::VERSION) >= Gem::Version.new('5.2.0')
+          @preprocessor.process(path)
+        else
+          buf = StringIO.new
+          File.open(path) { |f| @preprocessor.process(f, buf) }
+          buf.string
+        end
+      end
+    end
+
+    class ReViewCompat
+      class << self
+        def has_nested_minicolumn()
+          Gem::Version.new(ReVIEW::VERSION) >= Gem::Version.new('5.0.0')
+        end
+
+        def is_need_space_term_list()
+          Gem::Version.new(ReVIEW::VERSION) >= Gem::Version.new('4.0.0')
+        end
+
+        def is_allow_empty_image_caption()
+          v = Gem::Version.new(ReVIEW::VERSION)
+          v < Gem::Version.new('4.0.0') || v >= Gem::Version.new('5.1.0')
+        end
+
+        def has_bou()
+          Gem::Version.new(ReVIEW::VERSION) >= Gem::Version.new('3.2.0')
+        end
+
+        def Preprocessor(param)
+          Preprocessor.new(param)
+        end
+
+        def Catalog(path)
+          ReVIEW::Catalog.new(File.open(path))
+        end
+
+      end
+    end
+  end
+end

data/lib/review/retrovert/reviewdef.rb

@@ -0,0 +1,70 @@
+module ReVIEW
+  module Retrovert
+    class ReViewDef
+      class << self
+        attr_accessor :r_option_inner
+
+        def is_has_id_block_command(cmd)
+          no_id_block_command().none?(cmd)
+        end
+
+        def fence_close(open)
+          case open
+          when "$", "|" then
+            return open
+          when "{" then
+            return "}"
+          end
+          nil
+        end
+
+        # id 指定しないブロックコマンド
+        def no_id_block_command()
+          [
+            "emlist",
+            "emlistnum",
+            "emtable",
+            "note",
+            "memo",
+            "info",
+            "warning",
+            "important",
+            "caution",
+            "notice",
+          ]
+        end
+
+        # id 参照するインラインコマンド
+        def id_ref_inline_commands()
+          [
+            "list",
+            "img",
+            "table",
+            "eq",
+          ]
+        end
+
+        # キャプションを取得する
+        def get_caption(line)
+          m = line.match(/^\/\/(\w+?)((\[#{r_option_inner}\])*)([$|{])*$/)
+          if m
+            cmd = m[1]
+            options = m[2]
+            if options
+              if no_id_block_command().include?(cmd)
+                n = options.match(/\[(#{r_option_inner})\].*/)
+                return n[1] if n
+              else
+                n = options.match(/\[#{r_option_inner}\]\[(#{@r_option_inner})\].*/)
+                return n[1] if n
+              end
+            end
+          end
+          nil
+        end
+      end
+
+      self.r_option_inner = '(.*?\\[.*?\\\\\\].*?)*.*?'
+    end
+  end
+end

data/lib/review/retrovert/sty/{ird.sty → ird.sty.erb}

@@ -198,6 +198,8 @@
   \vspace{-5.5pt}
   }
 
+<% if Gem::Version.new(ReVIEW::VERSION) >= Gem::Version.new('3.1.0') %>
+
 % \renewcommand\reviewimagecaption[1]{%
 %   \captionsetup{format=hang,font=scriptsize,labelfont=bf,margin=50pt,name=図}
 %   \caption{ \bfseries\scriptsize{#1}} \vspace{-1.5mm}}
@@ -214,6 +216,8 @@
 %   \includegraphics[#1]{#2}}%
 %   }
 
+<% end %>
+
 %
 % 表
 %
@@ -276,8 +280,10 @@
 % cmd
 %
 
+<% if Gem::Version.new(ReVIEW::VERSION) >= Gem::Version.new('3.1.0') %>
 \renewenvironment{reviewlistblock}{\needspace{\Cvs}}{}
 
+<% end %>
 \renewenvironment{reviewcmd}{%
   \medskip%
   \ifdefined\reviewlistxkanjiskip%
@@ -314,5 +320,7 @@
 %   \vspace*{-0.2mm}% 枠の後ろの余白の調整
 %   }
 
-  % code
+<% if Gem::Version.new(ReVIEW::VERSION) >= Gem::Version.new('3.1.0') %>
+% code
 \DeclareRobustCommand{\reviewcode}[1]{{\small\ttfamily\reviewbreakall{#1}}}
+<% end %>

data/lib/review/retrovert/sty/review-retrovert-custom.sty.erb

@@ -0,0 +1,6 @@
+% for retrovert comaptible macro
+
+<% if Gem::Version.new(ReVIEW::VERSION) >= Gem::Version.new('5.1.0') %>
+\usepackage{ulem}
+\renewcommand{\reviewstrike}[1]{\sout{#1}}
+<% end %>

data/lib/review/retrovert/utils.rb

@@ -0,0 +1,35 @@
+require 'csv'
+
+module ReVIEW
+  module Retrovert
+    class Utils
+      class << self
+
+        # tsv to csv
+        def Tsv2Csv(infile, outfile)
+          File.open(infile, 'r') do |file|
+            CSV.open(outfile, 'w') do |csv|
+              file.each_line do |line|
+                csv << line.chomp.split(/\t+/)
+              end
+            end
+          end
+        end
+
+        def NormalizeCSVArray(ar)
+          ar&.each do |c|
+            c.gsub!(/\A"|"\z/, '')
+            c.gsub!(/^\s*/, '')
+            c.gsub!(/[\r\n]/, '')
+          end
+          ar
+        end
+
+        def GenerateTsv(c)
+          CSV.generate_line(Utils::NormalizeCSVArray(c), col_sep: "\t")
+        end
+
+      end
+    end
+  end
+end

data/lib/review/retrovert/version.rb

@@ -1,5 +1,5 @@
 module ReVIEW
   module Retrovert
-    VERSION = "0.9.7"
+    VERSION = "0.9.8"
   end
 end

data/lib/review/retrovert/yamlconfig.rb

@@ -131,7 +131,6 @@ module ReVIEW
           # YAML.dump(yaml, File.open(yamlfile, "w"))
           content = Psych.dump(yaml)
           content.gsub!('---','')
-          content.gsub!(/^(.*):\s*$/, '\1: null')
           File.write(yamlfile, content)
         }
       end

data/package-lock.json

@@ -0,0 +1,6 @@
+{
+  "name": "review-retrovert",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {}
+}

data/package.json

@@ -0,0 +1 @@
+{}

data/review-retrovert.gemspec

@@ -28,6 +28,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "thor"
-  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "rspec", ['~> 3.0']
+  spec.add_development_dependency "rake", ['~> 12.0']
+  spec.add_development_dependency 'aruba', ['~> 1.0.2']
+  spec.add_development_dependency "ruby-debug-ide"
+#   spec.add_development_dependency "debase"
   spec.add_runtime_dependency "review", ['>= 3.0.0']
 end

data/testdata/mybook/.gitignore

@@ -2,6 +2,8 @@
 *~
 *.bak
 *.yml.orig
-*.erb.orig
+#*.erb.orig
+rubygems/*
 tmp/*
 mybook-pdf/*
+mybook-md/*

data/testdata/mybook/.textlintrc

@@ -0,0 +1,11 @@
+{
+  "filters": {
+  }
+, "rules": {
+    "preset-japanese": false
+  , "preset-ja-technical-writing": true
+  , "preset-jtf-style": false
+  , "preset-ja-spacing": false
+  , "preset-ja-engineering-paper": false
+  }
+}

data/testdata/mybook/Rakefile

@@ -3,10 +3,18 @@
 ## Instead, edit 'lib/tasks/mytasks.rake' file.
 ##
 
+## `gem install foobar` will raise error in macOS.
+## the following is a hack to avoid that error.
+rubygems_dir = File.join(Dir.pwd, 'rubygems')
+if ENV['GEM_HOME'].to_s.empty? && File.directory?(rubygems_dir)
+  #ENV['GEM_HOME'] = rubygems_dir
+  Gem.paths = {'GEM_HOME' => rubygems_dir}
+end
 Dir.glob('lib/tasks/*.rake').each do |file|
   load(file)
 end
 
+##
 desc "+ list tasks"
 task :help do
   sh "rake -T"

data/testdata/mybook/catalog.yml

@@ -1,6 +1,14 @@
+# -*- coding: utf-8 -*-
+
+##
+## 注：タブ文字を使わないこと（使うとエラーになる）
+##
+
+## まえがき
 PREDEF:
   - 00-preface.re
 
+## 本文
 CHAPS:
   - 01-install.re
   - 02-tutorial.re
@@ -10,25 +18,43 @@ CHAPS:
   - 06-bestpractice.re
   - r0-root.re
 
+## 付録
 APPENDIX:
   - 91-compare.re
   - 92-filelist.re
   - 93-background.re
 
+## あとがき
 POSTDEF:
   - 99-postface.re
 
 ##
-## ■Tips
-## 第I部、第II部、…のように「部」を使うには、「CHAPS:」を次のようにする。
+## 【Tips】
+##
+## ・付録やまえがきやあとがきがなければ、空にする。
+##   例：
+##
+##     PREDEF:
+##
+##     CHAPS:
+##       - 01-install.re
+##
+##     APPENDIX:
+##
+##     POSTDEF:
+##
 ##
-##   CHAPS:
-##     - 部タイトル:
-##         - chap01.re
-##         - chap02.re
-##     - 部タイトル:
-##         - chap03.re
-##         - chap04.re
+## ・第I部、第II部、…のように「部」を使うには、次のようにする。
+##   （部タイトルの最後に半角の「:」をつけることに注意）
 ##
-## 「部タイトル」の最後に半角の「:」をつけることに注意。
+##     CHAPS:
+##       - 初級編:
+##           - 01-install.re
+##           - 02-tutorial.re
+##       - 中級編:
+##           - 03-syntax.re
+##           - 04-customize.re
+##       - 上級編:
+##           - 05-faq.re
+##           - 06-bestpractice.re
 ##

data/testdata/mybook/config-starter.yml

@@ -18,6 +18,12 @@ starter:
   ## ・B5 … 少年ジャンプ、ジャポニカ学習帳の大きさ
   pagesize:  A5            # A5 or B5
 
+  ## 上下左右の塗り足し幅（印刷用PDFのみ）
+  ## （参考：https://www.eikou.com/making/basis#nuritashi ）
+  bleedsize:           # 通常は指定しなくてよい
+  #bleedsize: 3mm      # 背景色を使うなら、上下左右に3mmの塗り足しが必要
+  bleedcolor:          # 通常は無指定、確認時のみ使用（red/blue/green/yellow/gray）
+
   ## フォントサイズ
   ## ・A5なら「9pt」、B5なら「10pt」を推奨
   ## ・初心者向け入門書なら大きめにして、A5「10pt」、B5「11pt」を推奨
@@ -35,6 +41,35 @@ starter:
   fontweight_ja: normal    # (日本語) normal: 通常, light: 細字
   fontweight_en: normal    # (英数字) normal: 通常, light: 細字
 
+  ## 表紙や大扉（タイトルページ）や奥付のページのPDFファイルを指定
+  ## ・PDFファイルは `images/` フォルダに置くこと。
+  ## ・PDFは1ファイルにつき1ページであること。もし複数ページのPDFを指定する場合は
+  ##   取り込むページ番号を `cover.pdf<2>` のように指定すること（実験的機能）。
+  ## ・ファイル名の後ろに `*` をつけると、上下左右の塗り足し部分が除かれる。
+  ## ・必要なら配列を使って複数ファイルを指定可能（例： [a.pdf, b.pdf]）。
+  frontcover_pdffile: cover_a5.pdf   # 表表紙（電子用のみ、印刷用にはつかない）
+  #frontcover_pdffile: cover.pdf<2>* # （ページ番号を指定し、塗り足しを除く場合）
+  backcover_pdffile:  null           # 裏表紙（電子用のみ、印刷用にはつかない）
+  titlepage_pdffile:  null           # 大扉（印刷用・電子用どちらにもつく）
+  colophon_pdffile:   null           # 奥付（印刷用・電子用どちらにもつく）
+  includepdf_option:  null           # PDFの位置調整が必要な場合
+  #includepdf_option:  "offset=-2.3mm 2.3mm"  # 位置調整の指定例
+
+  ## ノンブル（1枚目からの通し番号）の設定
+  ## （注：印刷用PDFのときのみ有効、電子用PDFではノンブルはつかない）
+  nombre:               on           # on ならノンブルをつける
+  nombre_sidemargin:    0.5mm        # ページ左右からのマージン幅
+  nombre_bottommargin:  2.0mm        # ページ下からのマージン高
+  nombre_fontcolor:     gray         # 'gray' or 'black'
+  nombre_fontsize:      6pt          # フォントサイズ（6〜8pt）
+  nombre_startnumber:   1            # ノンブルの開始番号（3から始める流儀もある）
+
+  ## 部 (Part) の開始番号（上・下巻に分割する場合に必要）
+  part_startnumber: 1          # 5 なら「第5部」から始まる
+
+  ## 章 (Chapter) の開始番号
+  chapter_startnumber: 1       # 0 なら「第0章」から始まる
+
   ## 章 (Chapter) タイトルの装飾
   ## （none: なし、underline: 下線、boldlines: 上下に太線）
   chapter_decoration: boldlines
@@ -55,8 +90,9 @@ starter:
   section_notopmargin: true
 
   ## 節 (Section) タイトルの装飾
-  ## （none: なし、underline: 下線、grayback: 灰色の背景色、leftline: 左に縦線, numbox: 節番号を黒背景に）
-  ## （節タイトルが長くて二行になる場合は「leftline」または「numbox」がお勧め）
+  ## （none: なし、underline: 下線、grayback: 灰色の背景色、
+  ##   leftline: 左に縦線、numbox: 節番号を黒背景に、circle: 円）
+  ## （節タイトルが長くて二行になる場合は「leftline」「numbox」「circle」がお勧め）
   section_decoration: grayback
 
   ## 項 (Subsection) タイトルの装飾
@@ -72,13 +108,7 @@ starter:
   ## キャプション直後での改ページを防ぐために、最低限必要とする高さ
   ## （もしキャプション直後での改ページが発生するなら値を増やす。
   ##   もし十分なスペースがあるのに改ページされるなら値を減らす。）
-  caption_needspace: 4.6zh        # 全角文字4.6個分の高さ（実験で得た境界値）
-
-  ## プログラム（//list）のフォントサイズ
-  program_fontsize: normal  # 'normal' or 'small'
-
-  ## ターミナル（//cmd, //terminal）のフォントサイズ
-  terminal_fontsize: normal  # 'normal' or 'small'
+  caption_needspace: 4.0zh        # 全角文字4個分の高さ（実験で得た境界値）
 
   ## プログラム用（//list）の等幅フォント。
   ##  * lmodern … LaTeXのデフォルト。1とl、0とOが見分けにくい。太字が目立たない。
@@ -106,12 +136,64 @@ starter:
   ## 詳細は https://twitter.com/_kauplan/status/1162167825407963137
   terminal_widen:  0.0mm         # 0.3mmとか
 
+  ## プログラム（//list）のデフォルトオプション
+  ## （注：YAMLでは `on, off, ~` は `true, false, null` と同じ）
+  program_default_options:
+    fold:        on        # on なら長い行を右端で折り返す
+    foldmark:    on        # on なら折り返し記号をつける
+    eolmark:     off       # on なら行末に改行記号をつける
+    lineno:      ~         # 1 なら行番号をつける
+    linenowidth: ~         # 行番号の幅を半角文字数で指定する
+    indent:      ~         # インデント幅（指定するとインデント記号がつく）
+    fontsize:    ~         # null, or small/x-small/xx-smal
+    lang:        ~         # デフォルトのプログラミング言語名
+    #file:       ~         # （使用しない）
+    encoding:    utf-8     # ファイルの文字コード
+    widecharfit: off       # on なら全角1文字を半角2文字幅に
+    charspace:   ~         # 文字の間隔を空ける/詰める（例：-0.03em）
+
+  ## ターミナル（//terminal）のデフォルトオプション
+  ## （注：YAMLでは `on, off, ~` は `true, false, null` と同じ）
+  terminal_default_options:
+    fold:        on        # on なら長い行を右端で折り返す
+    foldmark:    on        # on なら折り返し記号をつける
+    eolmark:     off       # on なら行末に改行記号をつける
+    lineno:      ~         # 1 なら行番号をつける
+    linenowidth: ~         # 行番号の幅を半角文字数で指定する
+    indent:      ~         # インデント幅（指定するとインデント記号がつく）
+    fontsize:    ~         # null, or small/x-small/xx-smal
+    lang:        ~         # デフォルトのプログラミング言語名
+    #file:       ~         # （使用しない）
+    encoding:    utf-8     # ファイルの文字コード
+    widecharfit: off       # on なら全角1文字を半角2文字幅に
+    charspace:   ~         # 文字の間隔を空ける/詰める（例：-0.03em）
+
   ## プログラム（//list）を枠で囲むか？
   program_border: true
 
   ## ターミナル（//terminal, //cmd）を枠で囲むか？
   terminal_border: false
 
+
+  ## 出力結果（//output）の設定
+  output_ttfont:   beramono
+  output_widen:    0.0mm         # 0.3mmとか
+  output_border:   true          # 枠線で囲むか？
+  output_default_options:
+    fold:        on        # on なら長い行を右端で折り返す
+    foldmark:    on        # on なら折り返し記号をつける
+    eolmark:     off       # on なら行末に改行記号をつける
+    lineno:      ~         # 1 なら行番号をつける
+    linenowidth: ~         # 行番号の幅を半角文字数で指定する
+    indent:      ~         # インデント幅（指定するとインデント記号がつく）
+    fontsize:    ~         # null, or small/x-small/xx-smal
+    lang:        ~         # デフォルトのプログラミング言語名
+    #file:       ~         # （使用しない）
+    encoding:    utf-8     # ファイルの文字コード
+    widecharfit: on        # on なら全角1文字を半角2文字幅に
+    charspace:   ~         # 文字の間隔を空ける/詰める（例：-0.03em）
+
+
   ## 文章中の「@<code>{...}」の背景色を薄いグレーにするか？
   inlinecode_gray: false
 
@@ -137,3 +219,46 @@ starter:
 
   ## @<secref>{}において、親の節のタイトルを含めるか？
   secref_parenttitle: false # trueなら親の節のタイトルを含める
+
+  ## PDF中のテキストをマウスで選択したとき、折り返し記号やインデント記号を選択対象から外すか？
+  ## ・trueだとコンパイル時間が大幅に増えるので、デフォルトではfalse。
+  ## ・環境変数「$STARTER_EXCLUDE_MOUSESELECT=on」でもtrueにできる。
+  ## ・AcrobatReaderでは機能するが、macOS Preview.appでは機能しない。
+  exclude_mouseselect: false
+
+
+  ## 説明リスト（`//desclist`）のデフォルトオプション
+  ## （注：YAMLでは `on` は `true` と同じ、`off` は `false` と同じ）
+  desclist_default_options:
+    indent:      3zw       # 説明文の左側の空き幅
+    space:       1zw       # キーや用語の直後の空き幅
+    bold:        off       # on ならキーや用語を太字に
+    compact:     off       # on ならキーや用語の直後で改行しない
+    listmargin:  0.5zw     # 説明リスト上下の空きの高さ
+    itemmargin:  0mm       # 説明項目間の空きの高さ
+    classname:             # HTMLタグに含めるクラス名
+
+  ## 会話形式（`//talklist`）のデフォルトオプション
+  ## （注：YAMLでは `on` は `true` と同じ、`off` は `false` と同じ）
+  talklist_default_options:
+    indent:      6zw       # 本文左端から会話部分までの幅
+    separator:   "："      # 名前と会話文との区切り文字列
+    imagewidth:  4zw       # 画像幅
+    imageheight:           # 画像高さ（通常は無指定でよい）
+    imageborder: off       # on なら画像に枠線をつける
+    needvspace:  4zw       # 必要な空きがなければ改ページ
+    itemmargin:  1mm       # 会話項目間の空き
+    listmargin:  0.5zw     # 会話リストの最初と最後の空き
+    itemstart:   "「"      # 会話文の先頭につける文字列
+    itemend:     "」"      # 会話文の最後につける文字列
+    classname:             # HTMLタグに含めるクラス名
+
+  ## 大量の会話形式をより簡単に入力するための設定
+  ## （例：`//t[b1]` が `//talk[avatar-b][]` の短縮形となる）
+  talk_shortcuts:
+    ## アイコン画像を使う場合
+    "b1":         {image: "avatar-b"}
+    "g1":         {image: "avatar-g"}
+    ## アイコン画像を使わない場合
+    #"b1":        {name: "アリス"}
+    #"g1":        {name: "ボブ"}