mdextab 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 409eda158bf955f5ae51fa53d5a087e00b642452d77610d5d9af13e57ff76758
-  data.tar.gz: 91765084458edf0fbe1042e926d4dc0b641c018ef020e7662661216771c5251f
+  metadata.gz: 30954db83b3ff5d42198eb363617f1dd143bc753f602410d9f2accf108636ac1
+  data.tar.gz: 4482a475295a0d00705173c6bb1682486e3d74bfed580810362f6ab142080909
 SHA512:
-  metadata.gz: b9d17b9cfc05a3ea645d723b049f83f26e80b8ca562ef6405bafc979b3b5afa8309f3e837b26e2f7d64fbe1d9d94404370fa28e1cb41ff082d2d592838a014e2
-  data.tar.gz: c1846f3aa1ee6bec4c3f5a2a6e78dfc2b1fd21d6b9dc1e45804e464d9f2317b2b7589ee405f8e08e0043b2b4b689892be91d255f52cc44c000d8fa6b0734e114
+  metadata.gz: 16fa6d519c1570b4cf4243265601a4489eb6743827b7cd298c991d87b0b562416118439616550ff20cfcfad65cd9798840dba6cb1627dfb721473cc84aa70d26
+  data.tar.gz: cb837801ecbcc40b90d2b0d37eba3059dbf675e14bb3eeb0eafedaf013f78c5a8c83eda1befd2bdff76e7577bf54f93c8e5be33bb02bc9f5110dc6765f62de4b

data/lib/mdextab/layer.rb

@@ -1,43 +1,82 @@
 module Mdextab
+  #
+  # 入れ子のTableにを管理するレイヤークラス
   class Layer
-    attr_accessor :return_from_nested_env, :cur_layer, :size
-
+    # 入れ子のレイヤーからリターンしたかを示す
+    # @return [Boolean]
+    attr_accessor :return_from_nested_layer
+    # 現在のレイヤー
+    # @return [Layer]
+    attr_accessor :cur_layer
+    # レイヤーの階層数
+    # @return [Integer]
+    attr_accessor :size
+
+    #
+    # 初期化
+    #
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @param output [IO] 出力先
     def initialize(mes, output)
       @mes = mes
       @output = output
-      @return_from_nested_env = false
+      @return_from_nested_layer = false
 
       @layer_struct = Struct.new(:table, :star, :cur_state, :fname, :lineno)
       @cur_layer = nil
       @layers = []
     end
 
+    # @overload cur_state=(val)
+    # カレントレイヤーの状態を設定
+    # @param val [Symbol]
     def cur_state=(val)
       # raise if val.class != Symbol
       @cur_layer.cur_state = val
     end
 
+    # @overload cur_state
+    # カレントレイヤーの状態を設定
+    # @return [Symbol] 現在の状態
     def cur_state
       raise if @cur_layer.cur_state.class != Symbol
       @cur_layer.cur_state
     end
 
-    def table
-      @cur_layer.table
-    end
-
+    # @overload table=(val)
+    # カレントレイヤーのtableを設定
+    # @param val [Table] カレントレイヤーのtable
     def table=(val)
       @cur_layer.table = val
     end
 
+    # @overload tablee=(val)
+    # カレントレイヤーのtableを取得
+    # @param val [Table] カレントレイヤーのtable
+    def table
+      @cur_layer.table
+    end
+
+    # @overload star=(val)
+    # カレントレイヤーのstarの存在の有無を設定
+    # @param val [Boolean] カレントレイヤーのstarの存在の有無 true:starが存在 false:startが存在しない
     def star=(val)
       @cur_layer.star = val
     end
 
+    # @overload star=(val)
+    # カレントレイヤーのstarの存在の有無を取得
+    # @return [Boolean] カレントレイヤーのstaの存在の有無 true:starが存在 false:startが存在しない
     def star
       @cur_layer.star
     end
 
+    #
+    # 新しいレイヤーの追加
+    #
+    # @param fname [String] 構文解析対象のMarkdownファイル名
+    # @param lineno [String] TABLE_STARTトークン出現行の行番号
+    # @return [Symbol] テーブル拡張向け構文解析での状態
     def add_layer(fname, lineno, state=:START)
       new_layer = @layer_struct.new(nil, nil, nil, fname, lineno)
       @layers << new_layer
@@ -52,7 +91,11 @@ module Mdextab
       @cur_layer = new_layer
     end
 
-    def pop_prev_layer
+    #
+    # カレントレイヤーを取り出して返す
+    #
+    # @return [Layer] 取り出されたカレントレイヤー
+    def pop_layer
       tmp_ = @layers.pop
       @size = @layers.size
       @cur_layer = @layers.last
@@ -60,63 +103,96 @@ module Mdextab
       tmp_
     end
 
+    #
+    # 1つ前のレイヤーを返す
+    #
+    # @return [Layer,nil] 1つ前のレイヤーまたはnil
+    #   (1つ前のレイヤーが存在しない場合)
     def peek_prev_layer
       return nil unless @layers.size > 1
 
       @layers[@layers.size - 2]
     end
 
+    #
+    # 入れ子のTABLE_STARTトークンとトークン出現行の処理
+    #
+    # @param token [Token] 読み込んだトークン
+    # @param lineno [Integer] トークン出現行の行番号
+    # @param fname [String] 構文解析対象のMarkdownファイル名
+    # @return [void]
     def process_nested_table_start(token, lineno, fname)
+      # TBODYトークンが出現する前にTABLE_STARTトークンが出現した場合、仮想的なTBODYトークンが出現したとみなす
       if table.tbody.nil?
         table.add_tbody(lineno)
       end
       @mes.output_debug("B process_nested_table_start 1 @cur_layer.table=#{@cur_layer.table.object_id} token.kind=#{token.kind} token.opt[:lineno]=#{token.opt[:lineno]} cur_state=#{@cur_layer.cur_state}")
+      # 新しいレイヤーを追加して、それをカレントレイヤーとし、カレントレイヤーにTableを追加する
       add_layer(fname, lineno, :OUT_OF_TABLE)
       @cur_layer.table = Table.new(token.opt[:lineno], @mes, token.opt[:attr])
       @mes.output_debug("process_nested_table_start 3 token.kind=#{token.kind} cur_state=#{@cur_layer.cur_state}")
     end
 
+    #
+    # TABLE_ENDトークンの処理
+    #
+    # @param token [Token] 読み込んだトークン
+    # @return [void]
     def process_table_end(token)
       prev_layer = peek_prev_layer
-      return unless prev_layer
+      retrun unless prev_layer
 
-      process_table_end_for_prev_env(token, prev_layer)
+      # 一つ前のレイヤーが存在すれば、入れ子のTABLE_ENDトークンとして処理する
+      process_table_end_for_prev_env(token)
     end
 
-    def process_table_end_for_prev_env(token, prev_layer)
+    #
+    # 入れ子のTABLE_ENDトークンの処理
+    #
+    # @param token [Token] 読み込んだトークン
+    # @return [void]
+    # @note tokenはデバッグ出力、エラー出力に使う
+    def process_table_end_for_prev_env(token)
       tmp_table = @cur_layer.table
-      pop_prev_layer
-      @return_from_nested_env = true
+      pop_layer
+      @return_from_nested_layer = true
 
+      # pop_layerを呼んだ後なので、カレントレイヤーはメソッド呼び出し時より一つ前のレイヤー
       case @cur_layer.cur_state
       when :IN_TD
-        prev_layer.table.td_append(tmp_table, prev_layer.star)
+        @cur_layer.table.td_append(tmp_table, @cur_layer.star)
       when :IN_TD_NO_TBODY
-        prev_layer.table.td_append(tmp_table, prev_layer.star)
+        @cur_layer.table.td_append(tmp_table, @cur_layer.star)
       when :IN_TH
-        prev_layer.table.th_append(tmp_table, prev_layer.star)
+        @cur_layer.table.th_append(tmp_table, @cur_layer.star)
       when :IN_TH_NO_TBODY
-        prev_layer.table.th_append(tmp_table, prev_layer.star)
+        @cur_layer.table.th_append(tmp_table, @cur_layer.star)
       when :IN_TABLE
-        if prev_layer.table.nil?
+        if @cur_layer.table.nil?
           @mes.output_debug("In process_nested_table_env_for_prev_env: table=nil token.kind=#{token.kind} token.opt[:lineno]=#{token.opt[:lineno]} cur_state=#{@cur_layer.cur_state}")
           raise
         end
-        prev_layer.table.add(tmp_table)
+        @cur_layer.table.add(tmp_table)
       when :IN_TABLE_BODY
-        prev_layer.table.add(tmp_table)
+        @cur_layer.table.add(tmp_table)
       when :START
         @mes.output_debug("In process_nested_table_env_for_prev_env: table=nil token.kind=#{token.kind} token.opt[:lineno]=#{token.opt[:lineno]} cur_state=#{@cur_layer.cur_state}")
         raise
       else
-        v = prev_layer.cur_state || "nil"
+        v = @cur_layer.cur_state || "nil"
         @mes.output_fatal("E100 cur_state=#{v}")
-        @mes.output_fatal("table=#{prev_layer.table}")
+        @mes.output_fatal("table=#{@cur_layer.table}")
         @mes.output_fatal("IllegalState(#{@cur_layer.cur_state} in process_table_end(#{token})")
         exit(@mes.ec("EXIT_CODE_TABLE_END"))
       end
     end
 
+    #
+    # 全レイヤーの状態検査
+    #
+    # @param fname [String] 構文解析対象のMarkdownファイル名
+    # @return [void]
+    # @note fnameはデバッグ出力、エラー出力に使う
     def check_layers(fname)
       case @cur_layer.cur_state
       when :OUT_OF_TABLE
@@ -146,12 +222,5 @@ module Mdextab
         exit(@mes.ec("EXIT_CODE_ILLEAG<AL_STATE"))
       end
     end
-
-    def debug(nth, token)
-      @mes.output_debug("***#{nth}")
-      @layers.each_with_index {|_x, ind| @mes.output_debug("@layers[#{ind}]=#{@layers[ind]}") }
-      @mes.output_debug("******#{nth}")
-      @mes.output_debug("Layer#debug 1 token.kind=#{token.kind} @layer.cur_state=#{@cur_layer.cur_state}")
-    end
   end
 end

data/lib/mdextab/makemdtab.rb

@@ -3,27 +3,31 @@ module Mdextab
   require "pp"
   require "filex"
 
+  #
+  # テーブル拡張Markdown生成クラス
   class Makemdtab
+    #
+    # 初期化
+    #
+    # @param opt [Hash] オプション
+    # @option opt [Symbol] :debug Messagexクラスのインスタンスに与えるデバッグモード
+    # @param eruby_variable_str [String] 2回の置き換えが必要なeRubyスクリプト
+    # @param eruby_static_str [String] 1回の置き換えが必要なeRubyスクリプト
+    # @param obj_by_yaml [Hash] eRubyスクリプト向け置換用ハッシュ
+    # @param mes [Messagex] Messagexクラスのインスタンス
     def initialize(opts, eruby_variable_str, eruby_static_str, obj_by_yaml, mes=nil)
-      @yamlfiles = {}
-      @str_yamlfiles = {}
-      @str_mdfiles = {}
-      @str_erubyfiles = {}
-      @dataop = opts["dataop"]
-      @datayamlfname = opts["data"]
+      @dataop = opts[:dataop]
+      @datayamlfname = opts[:data]
       @eruby_variable_str = eruby_variable_str
       @eruby_static_str = eruby_static_str
-      @outputfname = opts["output"]
+      @outputfname = opts[:output]
       @obj_by_yaml = obj_by_yaml
 
-      @exit_cannot_find_file = 1
-      @exit_cannot_write_file = 2
-
       @mes = mes
       unless @mes
-        if opts["debug"]
+        if opts[:debug]
           @mes = Messagex::Messagex.new("EXIT_CODE_NORMAL_EXIT", 0, :debug)
-        elsif opts["verbose"]
+        elsif opts[:verbose]
           @mes = Messagex::Messagex.new("EXIT_CODE_NORMAL_EXIT", 0, :verbose)
         else
           @mes = Messagex::Messagex.new("EXIT_CODE_NORMAL_EXIT", 0)
@@ -35,11 +39,22 @@ module Mdextab
       @output = @mes.exc_file_write(@outputfname) { File.open(@outputfname, "w") }
     end
 
+    #
+    # ファイルから生成（使われていない？）
+    #
+    # @param opt [Hash] オプション
+    # @option opt [String] :debug Messagexクラスのインスタンスに与えるデバッグモード
+    # @option opt [IO] :output 出力先IO
+    # @param fname_variable_str [String] 2回の置き換えが必要なeRubyスクリプトファイル名
+    # @param fname_static_str [String] 1回の置き換えが必要なeRubyスクリプトファイル名
+    # @param root_settingfile [String] eRubyスクリプト向け置換用YAML形式ファイル名
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @retrun [Makemdtab]
     def self.create(opts, fname_variable, fname_static, root_settingfile, mes)
       Filex::Filex.setup(mes)
 
-      unless File.exist?(opts["output"])
-        mes.output_fatal("Can't find #{opts['output']}")
+      unless File.exist?(opts[:output])
+        mes.output_fatal("Can't find #{opts[:output]}")
         exit(mes.ec("EXIT_CODE_CANNOT_FIND_FILE"))
       end
       obj_by_yaml = Filex::Filex.check_and_load_yamlfile(root_settingfile, mes)
@@ -50,10 +65,19 @@ module Mdextab
       Makemdtab.new(opts, str_variable, str_static, obj_by_yaml, mes)
     end
 
+    #
+    # YAML形式ファイルからテーブル拡張Markdown形式ファイルを生成
+    #
+    # @param root_dir [String] ルートディレクト(templatefileが示す相対パスの起点)
+    # @param templatefile [String,nil] テーブル拡張Makrdown形式の変換元YAML形式ファイルへの相対パス
+    # @param auxhs [Hash] eRubyスクリプト向け置換用ハッシュ（@obj_by_yamlにマージする）
+    # @retrun [void]
     def make_md2(root_dir, templatefile=nil, auxhs={})
+      # 補助的な置換用ハッシュを@obj_by_yamlにマージする
       objx = @obj_by_yaml.merge(auxhs)
       case @dataop
       when :FILE_INCLUDE
+        # ハッシュobjxは、メソッドfileReadの実引数を、読み込むべきファイルの相対パスに変換する定義を含んでいる
         array = load_file_include(root_dir, @datayamlfname, objx)
       when :YAML_TO_MD
         unless templatefile
@@ -64,7 +88,7 @@ module Mdextab
           @mes.output_fatal("Not specified templatefile")
           exit(@mes.ec("EXIT_CODE_NOT_SPECIFIED_FILE"))
         end
-
+        # YAMLファイルを、eRubyスクリプトであるtemplatefileを用いてテーブル拡張Markdown形式に変換する
         array = load_yaml_to_md(@datayamlfname, templatefile, objx)
       else
         array = []
@@ -72,45 +96,78 @@ module Mdextab
       array.map {|x| @mes.exc_file_write(@outputfname) { @output.puts(x) } }
     end
 
-    def load_file_include(root_dir, datayamlfname, objx)
-      mdfname = datayamlfname
+    #
+    # eRubyスクリプト取り込み処理
+    #
+    # @param root_dir [String] ルートディレクト(eruby_fnameが示す相対パスの起点)
+    # @param eruby_fname [String] fileReadメソッド呼び出しを含むeRubyスクリプトファイル名
+    # @param objx [Hash] eRubyスクリプト向け置換用ハッシュ
+    # @retrun [Array<String>] 指定ファイルを取り込んで展開した結果の文字列の配列(ただし要素は1個のみ)
+    def load_file_include(root_dir, eruby_fname, objx)
+      # eruby_fnameはfileReadメソッド呼び出しを含むeRubyスクリプトファイル
+      # fileReadメソッドは、引数を読み込むべきファイルへのパスに変換して、ファイルを読み込む
+
+      # fileReadメソッドで参照するparentDirという変数に、root_dirの値を割り当てる
       objy = { "parentDir" => "%q!" + root_dir + "!" }
+      # @eruby_variable_strにfileReadメソッドの定義が含まれる
       eruby_exanpded_str = ""
       if @eruby_variable_str
         if @eruby_variable_str.empty?
           eruby_exanpded_str = ""
         else
+          # 変数parent_dirをobjyで定義された値に置換て、fileReadメソッドの定義を完成させる
+          # 置換して得られた文字列を、もう一度eRubyスクリプトにする
           eruby_exanpded_str = ["<% ", Filex::Filex.expand_str(@eruby_variable_str, objy, @mes), " %>"].join("\n")
         end
       end
-      mbstr = Filex::Filex.check_and_load_file(mdfname, @mes)
+      # fileReadメソッド呼び出しを含むeRubyスクリプトファイルを読み込む
+      mbstr = Filex::Filex.check_and_load_file(eruby_fname, @mes)
+      # fileReadメソッド定義とそれ以外のメソッド定義と読み込んだeRubuスクリプトを連結して一つのeRubyスクリプトにする
       dx = [eruby_exanpded_str, @eruby_static_str, mbstr].join("\n")
       if dx.strip.empty?
-        puts "empty mdfname=#{mdfname}"
+        puts "empty eruby_fname=#{eruby_fname}"
       else
-        array = [Filex::Filex.expand_str(dx, objx, @mes, { "mdfname" => mdfname })]
+        # ハッシュobjxは、メソッドfileReadの実引数を、読み込むべきファイルの相対パスに変換する定義を含んでいる
+        # Filex::Filex.expand_strに渡すハッシュは、エラーメッセージに用いるためのものであり、eRubyスクリプトとは無関係である
+        array = [Filex::Filex.expand_str(dx, objx, @mes, { "eruby_fname" => eruby_fname })]
       end
 
       array
     end
 
+    #
+    # eRubyスクリプトファイルでもあるYAML形式ファイルからテーブル拡張Markdown形式に変換
+    #
+    # @param datayamlfname [String] eRubyスクリプトファイルでもあるYAML形式ファイル
+    # @param templatefile [String] YAML形式をテーブル拡張Markdwon形式に変換するeRubyスクリプトファイル
+    # @param objx [Hash] eRubyスクリプト向け置換用ハッシュ
+    # @retrun [Array<String>] 変換されたテーブル拡張Markdwon形式の文字列の配列(ただし要素は1個のみ)
     def load_yaml_to_md(datayamlfname, templatefile, objx)
       @mes.output_debug("datayamlfname=#{datayamlfname}")
       @mes.output_debug("objx=#{objx}")
 
+      # いったんeRubyスクリプトファイルとして読み込んで置換したあと、YAML形式として再度読み込み、Rubyのハッシュに変換する
       objy = Filex::Filex.check_and_expand_yamlfile(datayamlfname, objx, @mes)
       @mes.output_debug("objy=#{objy}")
       @mes.output_debug("templatefile=#{templatefile}")
 
+      # YAML形式をテーブル拡張Markdwon形式に変換するeRubyスクリプトファイルを読み込む
       erubystr = Filex::Filex.check_and_load_file(templatefile, @mes)
       @mes.output_debug("erubystr=#{erubystr}")
+      # メソッド定義を含むeRubyスクリプトとtemplatefileを一つのeRubyスクリプトにする
       dx = [@eruby_static_str, erubystr].join("\n")
       @mes.output_debug("dx=#{dx}")
+      # eRubyスクリプトにdatayamlfnameの内容を置換用ハッシュとして適用して、テーブル拡張Markdown形式に変換する
+      # Filex::Filex.expand_strに渡すハッシュは、エラーメッセージに用いるためのものであり、eRubyスクリプトとは無関係である
       array = [Filex::Filex.expand_str(dx, objy, @mes, { "datayamlfname" => datayamlfname, "templatefile" => templatefile })]
 
       array
     end
 
+    #
+    # 終了処理
+    #
+    # @return [void]
     def post_process
       @mes.exc_file_close(@outputfname) { @output&.close }
       @output = nil

data/lib/mdextab/table.rb

@@ -1,11 +1,38 @@
 require "forwardable"
 
 module Mdextab
+  #
+  # Tableクラス
+  #
   class Table
     extend Forwardable
+
+    # @!method add_thお
+    #   @see Tbody#add_th
+    # @!method add_td
+    #   @see Tbody#add_td
+    # @!method td_append
+    #   @see Tbody#td_append
+    # @!method th_append
+    #   @see Tbody#th_append
+    # @!method add
+    #   @see Tbody#add
+    def_delegators :@tbody, :add_th, :add_td, :td_append, :th_append, :add
+
     def_delegators :@tbody, :add_th, :add_td, :td_append, :th_append, :add
-    attr_reader :lineno, :tbody
 
+    # @return 入力Markdownファイル中のTABLEトークン出現行
+    attr_reader :lineno
+
+    # @return TABLE中のTBODYトークン出現行
+    attr_reader :tbody
+
+    #
+    # 初期化
+    #
+    # @param lineno [Integer] TABLE_STARTトークンの出現行の行番号
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @param sttr [String] TABLE_STARTトークンの属性
     def initialize(lineno, mes, attr=nil)
       @lineno = lineno
       @attr = attr
@@ -13,22 +40,36 @@ module Mdextab
       @mes = mes
     end
 
+    #
+    # tbodyの追加
+    #
+    # @param lineno [Integer] TBODY_STARTトークンまたは暗黙のtbodyの出現に係るトークンの出現行の行番号
+    # @return [void]
     def add_tbody(lineno)
       @tbody = Tbody.new(lineno, @mes)
     end
 
+    #
+    # tbodyの終了処理
+    #
+    # @return [void]
     def tbody_end
-      @tbody.end
-    end
-
-    def end
-      table_end
+      @tbody.finish
     end
 
+    #
+    # tableの終了処理
+    #
+    # @return (see #to_s)
     def table_end
       to_s
     end
 
+    #
+    # tableの文字列化
+    #
+    # @param debug [Symbol] デバッグ用フラグ true: デバッグ情報を付加する false: デバッグ情報を付加しない
+    # @return [String] HTMLのTABLEタグとして文字列化したもの
     def to_s(debug=false)
       if @attr
         if debug

data/lib/mdextab/tbody.rb

@@ -1,7 +1,25 @@
 module Mdextab
+  #
+  # TBODYトークン対応クラス
   class Tbody
+    extend Forwardable
+
+    # @return [Integer] TBODYトークン出現行の行番号
     attr_reader :lineno
 
+    # @!method td_append
+    #   @see Td#add
+    def_delegator :@td, :add, :td_append
+
+    # @!method th_append
+    #   @see Th#add
+    def_delegator :@th, :add, :th_append
+
+    #
+    # 初期化
+    #
+    # @param fname [String] 構文解析対象のMarkdownファイル名
+    # @param lineno [String] TBODYトークン出現行の行番号
     def initialize(lineno, mes)
       @array = []
       @tr = nil
@@ -11,7 +29,17 @@ module Mdextab
       @mes = mes
     end
 
+    #
+    # THの追加
+    #
+    # @param lineno [String] THトークン出現行の行番号
+    # @param content [String] THトークンのコンテンツ
+    # @param nth [Integer] THトークンの出現順番
+    # @param attr [String] THトークンの属性
+    # @param condense [Boolean] 文字列化方法 true:改行を含めない false:改行を含める
+    # @return [void]
     def add_th(lineno, content, nth, attr, condense)
+      # TRトークンが出現せずにTHトークンが出現したら、仮想的なTRトークンが出現したとみなす
       if nth == 1
         @tr = Tr.new(lineno)
         @array << @tr
@@ -21,8 +49,18 @@ module Mdextab
       @tr.add(@th)
     end
 
+    #
+    # TDの追加
+    #
+    # @param lineno [String] TDトークン出現行の行番号
+    # @param content [String] TDトークンのコンテンツ
+    # @param nth [Integer] TDトークンの出現順番
+    # @param attr [String] TDトークンの属性
+    # @param condense [Boolean] 文字列化方法 true:改行を含めない false:改行を含める
+    # @return [void]
     def add_td(lineno, content, nth, attr, condense)
       @mes.output_debug("content=#{content}|nth=#{nth}|attr=#{attr}")
+      # TRトークンが出現せずにTDトークンが出現したら、仮想的なTDトークンが出現したとみなす
       if nth == 1
         @tr = Tr.new(lineno)
         @array << @tr
@@ -32,22 +70,18 @@ module Mdextab
       @tr.add(@td)
     end
 
-    def td_append(content, condense)
-      @td.add(content, condense)
-    end
-
-    def th_append(content, condense)
-      @th.add(content, condense)
-    end
-
-    def add(cont)
-      @array << cont
-    end
-
-    def end
+    #
+    # TBODYの追加終了
+    #
+    # @return [void]
+    def finish
       @tr = nil
     end
 
+    #
+    # tbodyの文字列化
+    #
+    # @return [String] HTMLのTBODYタグとして文字列化したもの
     def to_s
       ["<tbody>", @array.map(&:to_s), "</tbody>"].join("\n")
     end

data/lib/mdextab/td.rb

@@ -1,31 +1,50 @@
-class Td
-  def initialize(lineno, attr=nil)
-    @lineno = lineno
-    @attr = attr
-    @content = ""
-  end
+module Mdextab
+  #
+  # TDトークン対応クラス
+  class Td
+    #
+    # 初期化
+    #
+    # @param lineno [String] TDトークン出現行の行番号
+    # @param attr [String] TDトークンの属性
+    def initialize(lineno, attr=nil)
+      @lineno = lineno
+      @attr = attr
+      @content = ""
+    end
 
-  def add(content, condnese)
-    if condnese
-      if @content
-        if @contnet.match?(/^\s*$/)
-          @content = content.to_s
+    #
+    # TDトークンのコンテンツ追加
+    #
+    # @param content [String] TDトークンのコンテンツ
+    # @param condense [Boolean] 文字列化方法 true:改行を含めない false:改行を含める
+    # @return [void]
+    def add(content, condnese)
+      if condnese
+        if @content
+          if @contnet.match?(/^\s*$/)
+            @content = content.to_s
+          else
+            @content += content.to_s
+          end
         else
-          @content += content.to_s
+          @content = content.to_s
         end
-      else
-        @content = content.to_s
+      elsif content
+        @content = [@content, content].join("\n")
       end
-    elsif content
-      @content = [@content, content].join("\n")
     end
-  end
 
-  def to_s
-    if @attr.nil?
-      %Q(<td>#{@content}</td>)
-    else
-      %Q(<td #{@attr}>#{@content}</td>)
+    #
+    # tdの文字列化
+    #
+    # @return [String] HTMLのTDタグとして文字列化したもの
+    def to_s
+      if @attr.nil?
+        %Q(<td>#{@content}</td>)
+      else
+        %Q(<td #{@attr}>#{@content}</td>)
+      end
     end
   end
 end

data/lib/mdextab/th.rb

@@ -1,11 +1,24 @@
 module Mdextab
+  #
+  # THトークン対応クラス
   class Th
+    #
+    # 初期化
+    #
+    # @param lineno [String] THトークン出現行の行番号
+    # @param attr [String] THトークンの属性
     def initialize(lineno, attr=nil)
       @lineno = lineno
       @attr = attr
       @content = ""
     end
 
+    #
+    # THトークンのコンテンツ追加
+    #
+    # @param content [String] THトークンのコンテンツ
+    # @param condense [Boolean] 文字列化方法 true:改行を含めない false:改行を含める
+    # @return [void]
     def add(content, condense)
       if condense
         if @content
@@ -22,6 +35,10 @@ module Mdextab
       end
     end
 
+    #
+    # thの文字列化
+    #
+    # @return [String] HTMLのTHタグとして文字列化したもの
     def to_s
       if @attr.nil?
         %Q(<th>#{@content}</th>)

data/lib/mdextab/token.rb

@@ -1,17 +1,44 @@
 module Mdextab
+  #
+  # Tokenクラス
   class Token
-    attr_reader :kind, :opt
+    # @return [Symbol] トークンの種類
+    attr_reader :kind
+    # @return [Hash] トークンのオプション
+    attr_reader :opt
 
+    #
+    # 初期化
+    #
+    # @param mes [Messagex] Messagexクラスのインスタンス
     def initialize(mes)
       @mes = mes
       @token_struct = Struct.new(:kind, :opt)
     end
 
+    #
+    # トークンの生成
+    #
+    # @param kind [Symbol] 生成するトークンの種類
+    # @param opt [Hash] 生成するトークンのオプション設定
+    # @option opt [String] :content トークンの内容
+    # @option opt [Integer] :lineno トークン出現行の行番号
+    # @option opt [Integer] :nth ":"の並び文字列長
+    # @option opt [String,nil] :attr トークンの属性またはnil(属性が存在しない場合)
+    # @option opt [Integer] :lineno トークン出現行の行番号
+    # @return [Struct] 生成されたトークン
     def create_token(kind, opt={})
       @token_struct.new(kind, opt)
     end
 
-    def get_token_start_table(line, lineno)
+    #
+    # TABLE_STARTトークンの取得
+    #
+    # @param line [String] 現在行
+    # @param lineno [Integer] 現在行の行番号
+    # @return [Struct,nil] 生成されたトークンまたはnil(トークンが存在しない場合)
+    # @note TABLE_STARTトークンが存在するかもしれないと判断されたときに呼ばれる
+    def get_token_table_start(line, lineno)
       if /^\s*<table>\s*$/.match?(line)
         ret = create_token(:TABLE_START, { lineno: lineno })
       elsif (m = /^\s*<table\s+(.+)>\s*$/.match(line))
@@ -22,7 +49,14 @@ module Mdextab
       ret
     end
 
-    def get_token_start_tbody(line, lineno)
+    #
+    # TBODY_STARTトークンの取得
+    #
+    # @param line [String] 現在行
+    # @param lineno [Integer] 現在行の行番号
+    # @return [Struct,nil] 生成されたトークンまたはnil(トークンが存在しない場合)
+    # @note TBODY_STARTトークンが存在するかもしれないと判断されたときに呼ばれる
+    def get_token_tbody_start(line, lineno)
       if /^\s*<tbody>\s*$/.match?(line)
         ret = create_token(:TBODY_START, { lineno: lineno })
       else
@@ -31,7 +65,16 @@ module Mdextab
       ret
     end
 
-    def get_token_start_colon(line, lineno, nth, cont)
+    #
+    # 先頭が:で始まる場合の適切なトークンの取得
+    #
+    # @param line [String] 現在行
+    # @param lineno [Integer] 現在行の行番号
+    # @param nth [Integer] 並んでいる:の個数
+    # @param cont [String] 現在行の中の:の並びを区切り文字列とした場合の右側の部分
+    # @return [Struct,nil] 生成されたトークンまたはnil(トークンが存在しない場合)
+    # @note 先頭が:のときに呼ばれる
+    def get_token_colon_start(line, lineno, nth, cont)
       if (m = /^th(.*)/.match(cont))
         cont2 = m[1]
         if (m2 = /^\s(.*)/.match(cont2))
@@ -61,7 +104,14 @@ module Mdextab
       ret
     end
 
-    def get_token_end_table(line, lineno)
+    #
+    # TABLE_ENDトークンの取得
+    #
+    # @param line [String] 現在行
+    # @param lineno [Integer] 現在行の行番号
+    # @return [Struct,nil] 生成されたトークンまたはnil(トークンが存在しない場合)
+    # @note TABLE_ENDトークンが存在するかもしれないと判断されたときに呼ばれる
+    def get_token_table_end(line, lineno)
       if %r{^\s*</table>\s*$}.match?(line)
         ret = create_token(:TABLE_END, { lineno: lineno })
       else
@@ -70,6 +120,12 @@ module Mdextab
       ret
     end
 
+    #
+    # トークンの取得
+    #
+    # @param line [String] 現在行
+    # @param lineno [Integer] 現在行の行番号
+    # @return [Struct,nil] 生成されたトークンまたはnil(トークンが存在しない場合)
     def get_token(line, lineno)
       case line
       when /^\*S(.+)$/
@@ -79,13 +135,13 @@ module Mdextab
         content = Regexp.last_match(1)
         ret = create_token(:STAR_END, { content: content, lineno: lineno })
       when /^\s*<table/
-        ret = get_token_start_table(line, lineno)
+        ret = get_token_table_start(line, lineno)
       when /^\s*<tbody/
-        ret = get_token_start_tbody(line, lineno)
+        ret = get_token_tbody_start(line, lineno)
       when /^\s*(\:+)(.*)$/
         nth = Regexp.last_match(1).size
         cont = Regexp.last_match(2)
-        ret = get_token_start_colon(line, lineno, nth, cont)
+        ret = get_token_colon_start(line, lineno, nth, cont)
       when %r{^\s*</table}
         ret = get_token_end_table(line, lineno)
       when %r{^\s*</tbody}

data/lib/mdextab/tr.rb

@@ -1,14 +1,29 @@
 module Mdextab
+  #
+  # TRトークン対応クラス
   class Tr
+    #
+    # 初期化
+    #
+    # @param lineno [String] TRトークン出現行の行番号
     def initialize(lineno)
       @lineno = lineno
       @array = []
     end
 
+    #
+    # TRトークンのコンテンツ追加
+    #
+    # @param content [String] TRトークンのコンテンツ
+    # @return [void]
     def add(cont)
       @array << cont
     end
 
+    #
+    # trの文字列化
+    #
+    # @return [String] HTMLのTRタグとして文字列化したもの
     def to_s
       ["<tr>", @array.map(&:to_s), "</tr>"].join("\n")
     end

data/lib/mdextab/version.rb

@@ -1,3 +1,4 @@
 module Mdextab
-  VERSION = "0.1.5"
+  # バージョン番号
+  VERSION = "0.1.6"
 end

data/lib/mdextab.rb

@@ -8,7 +8,7 @@ module Mdextab
   class Error < StandardError; end
 
   #
-  # MarkDownテーブル拡張モジュールクラス
+  # MarkDownテーブル拡張クラス
   #
   class Mdextab
     require "mdextab/version"
@@ -28,26 +28,26 @@ module Mdextab
 
     #
     # 初期化
-    # @param [Hash] オプション
-    # @param [String] 入力Markdownファイル名
-    # @param [String] 出力Markdownファイル名
-    # @param [Messagex] mes Messagexクラスのインスタンス
+    #
+    # @param opt [Hash] オプション
+    # @option opt [Symbol] :debug Messagexクラスのインスタンスに与えるデバッグモード
+    # @param fname [String] 入力Markdownファイル名
+    # @param o_fname [String] 出力Markdownファイル名
+    # @param mes [Messagex] Messagexクラスのインスタンス
     def initialize(opt, fname, o_fname, mes=nil)
       @fname = fname
       @o_fname = o_fname
 
       @mes = mes
       unless @mes
-        @mes = Messagex::Messagex.new("EXIT_CODE_NORMAL_EXIT", 0, opt["debug"])
+        @mes = Messagex::Messagex.new("EXIT_CODE_NORMAL_EXIT", 0, opt[:debug])
         @mes.register_ecx
       end
 
       @mes.add_exitcode("EXIT_CODE_NEXT_STATE")
       @mes.add_exitcode("EXIT_CODE_NIL")
       @mes.add_exitcode("EXIT_CODE_EXCEPTION")
-      @mes.add_exitcode("EXIT_CODE_TABLE_END")
       @mes.add_exitcode("EXIT_CODE_UNKNOWN")
-      @mes.add_exitcode("EXIT_CODE_ILLEAGAL_STATE")
 
       Filex::Filex.setup(@mes)
 
@@ -71,6 +71,7 @@ module Mdextab
     #
     # テーブル拡張向け構文解析用状態遷移テーブルの設定
     #
+    # @return [void]
     def set_state
       @states = {
         START: { TABLE_START: :IN_TABLE, ELSE: :OUT_OF_TABLE, STAR_START: :START, STAR_END: :START },
@@ -86,7 +87,9 @@ module Mdextab
 
     #
     # テーブル拡張向け構文解析
-    # @param [Hash] eRubyスクリプト向け置換用ハッシュ
+    #
+    # @param hash [Hash] eRubyスクリプト向け置換用ハッシュ
+    # @return [void]
     def parse(hash)
       lineno = 0
       @layer.add_layer(@fname, lineno)
@@ -103,7 +106,6 @@ module Mdextab
         else
           @mes.output_debug("(script)#{__LINE__}| @layer.cur_state=#{@layer.cur_state}")
         end
-        #        debug_envs(5, token)
 
         @layer.cur_state = process_one_line(@layer.cur_state, token, line, lineno)
         unless @layer.cur_state
@@ -119,7 +121,9 @@ module Mdextab
 
     #
     # テーブル拡張向け構文解析
-    # @param [String] eRubyスクリプト向け置換用データファイル名(YAML形式)
+    #
+    # @param yamlfname [String] eRubyスクリプト向け置換用データファイル名(YAML形式)
+    # @return [void]
     def parse2(yamlfname)
       hs = Filex::Filex.check_and_load_yamlfile(yamlfname, @mes)
       parse(hs)
@@ -127,9 +131,11 @@ module Mdextab
 
     #
     # テーブル拡張向け構文解析での次の状態を得る
-    # @param [String] token 読み込んだトークン
-    # @param [String] line 現在行
-    # @param [String] lineno 現在行の行番号
+    #
+    # @param token [Token] 読み込んだトークン
+    # @param line [String] トークン出現行
+    # @param lineno [String] トークン出現行の行番号
+    # @return [Symbol] テーブル拡張向け構文解析での次の状態
     def get_next_state(token, line, lineno)
       kind = token.kind
       @mes.output_debug("#{__LINE__}|@layer.cur_state=#{@layer.cur_state} #{@layer.cur_state.class}")
@@ -160,7 +166,9 @@ module Mdextab
 
     #
     # トークンELSEに対応する行の出力
-    # @param [String] str トークンELSEに対応する行
+    #
+    # @param str [String] トークンELSEに対応する行
+    # @return [void]
     def output_in_else(str)
       if @layer.star
         if str.match?(/^\s*$/)
@@ -175,7 +183,9 @@ module Mdextab
 
     #
     # テーブルのTHタグの一部として、トークンELSEに対応する行を追加
-    # @param [String] str トークンELSEに対応する行
+    #
+    # @param str [String] トークンELSEに対応する行
+    # @return [void]
     def table_th_append_in_else(str)
       if @layer.star
         if str.match?(/^\s*$/)
@@ -190,7 +200,9 @@ module Mdextab
 
     #
     # テーブルのTDタグの一部として、トークンELSEに対応する行を追加
-    # @param [String] str トークンELSEに対応する行
+    #
+    # @param str [String] トークンELSEに対応する行
+    # @return [void]
     def table_td_append_in_else(str)
       if @layer.star
         if str.match?(/^\s*$/)
@@ -204,10 +216,12 @@ module Mdextab
     end
 
     #
-    # START状態でのトークンと現在行の処理
-    # @param [String] token 読み込んだトークン
-    # @param [String] line 現在行
-    # @param [String] lineno 現在行の行番号
+    # START状態でのトークンとトークン出現行の処理
+    #
+    # @param token [Token] 読み込んだトークン
+    # @param line [String] トークン出現行
+    # @param lineno [String] トークン出現行の行番号
+    # @return [void]
     def process_one_line_for_start(token, line, lineno)
       case token.kind
       when :TABLE_START
@@ -229,10 +243,12 @@ module Mdextab
     end
 
     #
-    # OUT_OF_TABLE状態でのトークンと現在行の処理
-    # @param [String] token 読み込んだトークン
-    # @param [String] line 現在行
-    # @param [String] lineno 現在行の行番号
+    # OUT_OF_TABLE状態でのトークンとトークン出現行の処理
+    #
+    # @param token [Token] 読み込んだトークン
+    # @param line [String] トークン出現行
+    # @param lineno [String] トークン出現行の行番号
+    # @return [void]
     def process_one_line_for_out_of_table(token, line, lineno)
       case token.kind
       when :TABLE_START
@@ -257,20 +273,24 @@ module Mdextab
 
     #
     # TABLE_END状態でのトークン処理
-    # @param [String] token 読み込んだトークン
+    #
+    # @param token [Token] 読み込んだトークン
+    # @return [void]
     def process_one_line_for_table_end(token)
       @layer.process_table_end(token)
-      return if @layer.return_from_nested_env
+      return if @layer.return_from_nested_layer
 
-      @mes.output_debug("1 - process_one_line_table_end cur_state=#{@layer.cur_state} @return_from_nested_env~#{@layer.return_from_nested_env}")
-      @mes.exc_file_write(@o_fname) { @output.puts(@layer.table.end) }
+      @mes.output_debug("1 - process_one_line_table_end cur_state=#{@layer.cur_state} @return_from_nested_layer~#{@layer.return_from_nested_layer}")
+      @mes.exc_file_write(@o_fname) { @output.puts(@layer.table.table_end) }
     end
 
     #
-    # IN_TABLE状態でのトークンと現在行の処理
-    # @param [String] token 読み込んだトークン
-    # @param [String] line 現在行
-    # @param [String] lineno 現在行の行番号
+    # IN_TABLE状態でのトークンとトークン出現行の処理
+    #
+    # @param token [Token] 読み込んだトークン
+    # @param line [String] トークン出現行
+    # @param lineno [String] トークン出現行の行番号
+    # @return [void]
     def process_one_line_for_in_table(token, line, lineno)
       case token.kind
       when :TBODY_START
@@ -302,10 +322,12 @@ module Mdextab
     end
 
     #
-    # IN_TABLE_BODY状態でのトークンと現在行の処理
-    # @param [String] token 読み込んだトークン
-    # @param [String] line 現在行
-    # @param [String] lineno 現在行の行番号
+    # IN_TABLE_BODY状態でのトークンとトークン出現行の処理
+    #
+    # @param token [Token] 読み込んだトークン
+    # @param line [String] トークン出現行
+    # @param lineno [String] トークン出現行の行番号
+    # @return [void]
     def process_one_line_for_in_table_body(token, line, lineno)
       case token.kind
       when :TH
@@ -316,7 +338,7 @@ module Mdextab
       when :ELSE
         output_in_else(token.opt[:content])
       when :TABLE_START
-        @layer.process_nested_table_start(token, lineno, @fnam)
+        @layer.process_nested_table_start(token, lineno, @fname)
       when :TBODY_END
         true #  don't call process_table_end(token)
       when :TABLE_END
@@ -335,10 +357,12 @@ module Mdextab
     end
 
     #
-    # IN_TH状態でのトークンと現在行の処理
-    # @param [String] token 読み込んだトークン
-    # @param [String] line 現在行
-    # @param [String] lineno 現在行の行番号
+    # IN_TH状態でのトークンとトークン出現行の処理
+    #
+    # @param token [Token] 読み込んだトークン
+    # @param line [String] トークン出現行
+    # @param lineno [String] トークン出現行の行番号
+    # @return [void]
     def process_one_line_for_in_th(token, line, lineno)
       case token.kind
       when :ELSE
@@ -363,10 +387,12 @@ module Mdextab
     end
 
     #
-    # IN_TH_NO_TBODY状態でのトークンと現在行の処理
-    # @param [String] token 読み込んだトークン
-    # @param [String] line 現在行
-    # @param [String] lineno 現在行の行番号
+    # IN_TH_NO_TBODY状態でのトークンとトークン出現行の処理
+    #
+    # @param token [Token] 読み込んだトークン
+    # @param line [String] トークン出現行
+    # @param lineno [String] トークン出現行の行番号
+    # @return [void]
     def process_one_line_for_in_th_no_tbody(token, line, lineno)
       case token.kind
       when :ELSE
@@ -391,10 +417,12 @@ module Mdextab
     end
 
     #
-    # IN_TD状態でのトークンと現在行の処理
-    # @param [String] token 読み込んだトークン
-    # @param [String] line 現在行
-    # @param [String] lineno 現在行の行番号
+    # IN_TD状態でのトークンとトークン出現行の処理
+    #
+    # @param token [Token] 読み込んだトークン
+    # @param line [String] トークン出現行
+    # @param lineno [String] トークン出現行の行番号
+    # @return [void]
     def process_one_line_for_in_td(token, line, lineno)
       case token.kind
       when :ELSE
@@ -421,10 +449,12 @@ module Mdextab
     end
 
     #
-    # IN_TD_NO_TBODY状態でのトークンと現在行の処理
-    # @param [String] token 読み込んだトークン
-    # @param [String] line 現在行
-    # @param [String] lineno 現在行の行番号
+    # IN_TD_NO_TBODY状態でのトークンとトークン出現行の処理
+    #
+    # @param token [Token] 読み込んだトークン
+    # @param line [String] トークン出現行
+    # @param lineno [String] トークン出現行の行番号
+    # @return [void]
     def process_one_line_for_in_td_no_tbody(token, line, lineno)
       case token.kind
       when :ELSE
@@ -453,13 +483,15 @@ module Mdextab
     end
 
     #
-    # 現在の状態に対するトークンと現在行の処理
+    # 現在の状態に対するトークンとトークン出現行の処理
+    #
     # @param [Symbol] current_state 現在の状態
-    # @param [String] token 読み込んだトークン
-    # @param [String] line 現在行
-    # @param [String] lineno 現在行の行番号
+    # @param [Token] token 読み込んだトークン
+    # @param [String] line トークン出現行
+    # @param [String] lineno トークン出現行の行番号
+    # @return [void] テーブル拡張向け構文解析での次の状態
     def process_one_line(current_state, token, line, lineno)
-      @layer.return_from_nested_env = false
+      @layer.return_from_nested_layer = false
 
       case current_state
       when :START
@@ -484,7 +516,7 @@ module Mdextab
         exit(@mes.ec("EXIT_CODE_UNKNOWN"))
       end
 
-      if @layer.return_from_nested_env
+      if @layer.return_from_nested_layer
         next_state = @layer.cur_state
       else
         next_state = get_next_state(token, line, lineno)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdextab
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - yasuo kominami
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-25 00:00:00.000000000 Z
+date: 2019-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler