md2site 0.1.2 → 0.1.4

data/lib/md2site/envcheck.rb

@@ -0,0 +1,186 @@
+module Md2site
+  #
+  # 環境検査クラス
+  #
+  class EnvCheck
+    #
+    # 初期化
+    #
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @param conf_path [String] 構成ファイルのパス
+    # @param verbose [Boolean] FileUtilsクラスのメソッドのverbose引数に与える値
+    def initialize(mes, conf_path)
+      @mes = mes
+      @conf_path = conf_path
+    end
+
+    #
+    # 有効な構成ファイルへのパスであるか調べる（無効であればexitする）
+    #
+    # @return [void]
+    def check_conf_path
+      unless @conf_path
+        @mes.output_error("Not specified conf file")
+        exit(@mes.ec("EXIT_CODE_NOT_SPECIFIED_CONFFILE"))
+      end
+
+      unless File.exist?(@conf_path)
+        @mes.output_fatal("Cannot find conf file(#{confPath})")
+        exit(@mes.ec("EXIT_CODE_CANNOT_FIND_CONFFILE"))
+      end
+    end
+
+    #
+    # Envクラスのattributeとして有効な値が構成ファイル中に指定されているか調べる（無効であればexitする）
+    #
+    # @param conf_hs [Hash] 構成ハッシュ
+    # @return [void]
+    def check_conf_hs_for_attribute(conf_hs)
+      @absolute_path_root_conf = conf_hs["ABSOLUTE_PATH_ROOT_CONF"]
+      unless @absolute_path_root_conf
+        @mes.output_fatal("Cannot get ABSOLUTE_PATH_ROOT_CONF in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_ABSOLUTE_PATH_ROOT_CONF"))
+      end
+      unless File.exist?(@absolute_path_root_conf)
+        @mes.output_fatal("Cannot find root conf dir(#{@absolute_path_root_conf})")
+        exit(@mes.ec("EXIT_CODE_CANNOT_FIND_ROOTCONFFILE"))
+      end
+
+      @absolutepath_root_settingfile = conf_hs["ABSOLUTE_PATH_ROOT_SETTINGFILE"]
+      unless @absolutepath_root_settingfile
+        @mes.output_error("Can't get ABSOLUTE_PATH_ROOT_SETTINGFILE in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_ABSOLUTE_PATH_ROOT_SETTINGFILE"))
+      end
+      [@absolute_path_root_conf, @absolutepath_root_settingfile]
+    end
+
+    #
+    # 構成ファイルから変換したハッシュに有効な値が指定されているか調べる（無効であればexitする）
+    #
+    # @param conf_hs [Hash] 構成ハッシュ
+    # @param absolutepath_root [String] プロジェクトルートへの絶対パス
+    # @param root_output_dir [String] ルート出力ディレクトリ
+    # @return [void]
+    def check_conf_hs(conf_hs, absolutepath_root, root_output_dir) # rubocop:disable Metrics/MethodLength
+      default_table_template = conf_hs["DEFAULT_TABLE_TEMPLATE"] # 5col_no_attr_b.erb
+      unless default_table_template || !FileTest.exist?(default_table_template)
+        @mes.output_fatal("Cannot find valid DEFAULT_TABLE_TEMPLATE(=#{default_table_template}) in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_FIND_DEFAULT_TABLE_TEMPLATE"))
+      end
+
+      sitefile_path = conf_hs["ABSOLUTE_PATH_SITE_FILE"]
+      unless sitefile_path || !FileTest.exist?(sitefile_path)
+        @mes.output_error("Can't get valid ABSOLUTE_PATH_SITE_FILE in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_ABSOLUTE_PATH_SITE_FILE"))
+      end
+
+      absolute_path_status_file = conf_hs["ABSOLUTE_PATH_STATUS_FILE"]
+      unless absolute_path_status_file || !FileTest.exist?(absolute_path_status_file)
+        @mes.output_error("Can't find valid ABSOLUTE_PATH_STATUS_FILE in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_ABSOLUTE_PATH_STATUS_FILE"))
+      end
+
+      unless conf_hs["TEMPLELATE_DIR"]
+        @mes.output_error("Can't get TEPLATE_DIR in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_TEPLATE_DIR"))
+      end
+
+      unless conf_hs["CONF_DIR"]
+        @mes.output_error("Can't get CONF_DIR in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_CONF_DIR"))
+      end
+
+      unless conf_hs["URL"]
+        @mes.output_error("Can't get URL in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_URL"))
+      end
+
+      unless conf_hs["ROOT_TEMPLATE_FUNCTIONS_VARIABLE"]
+        @mes.output_fatal("Cannot get value by ROOT_TEMPLATE_FUNCTIONS_VARIABLE from #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_ROOT_TEMPLATE_FUNCTIONS_VARIABLE"))
+      end
+      root_output_path = File.join(absolutepath_root, root_output_dir)
+      unless File.exist?(root_output_path)
+        @mes.output_error("Can't find root_output_dir(=#{root_output_dir})")
+        exit(@mes.ec("EXIT_CODE_CANNOT_FIND_ROOTOUTPUTDIR"))
+      end
+
+      sitefile_path
+    end
+
+    #
+    # 構成ファイルから変換したハッシュに指定されている値が有効であれば、インスタンス変数で参照できるようにする（無効であればexitする）
+    #
+    # @param conf_hs [Hash] 構成ハッシュ
+    # @return [void]
+    def check_conf_hs_and_set(conf_hs) # rubocop:disable Metrics/MethodLength
+      @category_conf_prefix = conf_hs["CATEGORY_CONF_PREFIX"]
+      unless @category_conf_prefix
+        @mes.output_fatal("Cannot get category conf prefix  from #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_CATEGORY_CONF_PREFIX"))
+      end
+
+      @root_output_dir = conf_hs["OUTPUT_DIR"]
+      unless @root_output_dir
+        @mes.output_fatal("Cannot get rootOutputDir from #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_ROOTOUTPUTDIR"))
+      end
+
+      @src_dir = conf_hs["SRC_DIR"]
+      unless @src_dir
+        @mes.output_error("Can't get SRC_DIR in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_SRC_DIR"))
+      end
+
+      @data_dir = conf_hs["DATA_DIR"]
+      unless @data_dir
+        @mes.output_fatal("Cannot get DATA_DIR in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_DATA_DIR"))
+      end
+
+      @work_dir = conf_hs["WORK_DIR"]
+      unless @work_dir
+        @mes.output_fatal("Cannot get WORK_DIR in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_WORK_DIR"))
+      end
+
+      @material_dir = conf_hs["MATERIAL_DIR"]
+      unless @material_dir
+        @mes.output_fatal("Cannot get MATERIAL_DIR in #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_MATERIAL_DIR"))
+      end
+
+      @target_command_index = conf_hs["TARGET_COMMAND_INDEX"].to_i
+      unless @target_command_index
+        @mes.output_fatal("Cannot get targetCommandIndex from #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_CANNOT_GET_TARGET_COMMAND_INDEX"))
+      end
+
+      @subtarget_command_index = conf_hs["SUBTARGET_COMMAND_INDEX"].to_i
+      unless @subtarget_command_index
+        @mes.output_fatal("Cannot get subTargetCommandIndex from #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_SUBTARGET_COMMAND_INDEX"))
+      end
+
+      @key_index = conf_hs["KEY_INDEX"].to_i
+      unless @key_index
+        @mes.output_fatal("Cannot get keyIndex from #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_KEY_INDEX"))
+      end
+
+      @htmlfile_index = conf_hs["HTMLFILE_INDEX"].to_i
+      unless @htmlfile_index
+        @mes.output_fatal("Cannot get htmlfileIndex from #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_HTMLFILE_INDEX"))
+      end
+
+      @alias_htmlfile_index = conf_hs["ALIAS_HTMLFILE_INDEX"].to_i
+      unless @alias_htmlfile_index
+        @mes.output_fatal("Cannot get aliasHtmlfileIndex from #{@conf_path}")
+        exit(@mes.ec("EXIT_CODE_CANNOT_GET_ALIAS_HTMLFILE_INDEX"))
+      end
+
+      [@category_conf_prefix, @root_output_dir, @src_dir, @data_dir, @work_dir, @material_dir, @target_command_index, @subtarget_command_index, @key_index, @htmlfile_index, @alias_htmlfile_index]
+    end
+  end
+end

data/lib/md2site/htmlutils0.rb

@@ -1,12 +1,26 @@
 module Md2site
+  #
+  # HTMLファイル分割クラス
   class HTMLUtils
     require "md2site/nkfguess"
 
+    #
+    # 初期化
+    #
+    # @param htmlfname [String] 分割対象HTMLファイル名
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @return [void]
     def initialize(htmlfname, mes)
       @htmlfname = htmlfname
       @mes = mes
     end
 
+    #
+    # 1行解析
+    #
+    # @param state [Symbol] 分割対象HTMLファイル名
+    # @param line [String] 解析対象行
+    # @return [Symbol] 構文解析上の次の状態
     def parse_line(state, line)
       event = get_event(line)
 
@@ -29,6 +43,10 @@ module Md2site
       next_state
     end
 
+    #
+    # HTMLファイル分割
+    #
+    # @return [Array] 第0要素:HTML先頭部 第1要素:HTML中間部 第2要素:HTML末尾部
     def divide_html
       part_struct = Struct.new(:lines, :status)
       @part0 = part_struct.new([], false)
@@ -58,6 +76,11 @@ module Md2site
 
     private
 
+    #
+    # 解析対象行からトークン取得
+    #
+    # @param line [String] 解析対象行
+    # @return [Symbol] トークン種別
     def get_event(line)
       line.chomp!
       @lineno += 1
@@ -81,6 +104,11 @@ module Md2site
       event
     end
 
+    #
+    # part0部のCONTENTS_ENDイベント処理
+    #
+    # @param line [String] 解析対象行
+    # @return [Symbol] 構文解析上の次の状態
     def state_in_part0_contents_end(line)
       @part0.lines << @lines
       if !@div_body_main.nil? && !@div_cse.nil?
@@ -93,6 +121,12 @@ module Md2site
       :IN_PART2
     end
 
+    #
+    # part0部のイベント処理
+    #
+    # @param event [Symbol] トークン種別
+    # @param line [String] 解析対象行
+    # @return [Symbol] 構文解析上の次の状態
     def state_in_part0(event, line)
       case event
       when :CONTENTS_BEGIN
@@ -125,7 +159,12 @@ module Md2site
       next_state
     end
 
-    def state_in_part0_contents_contents_env(line)
+    #
+    # part0_contents部のcontents_endイベント処理
+    #
+    # @param line [String] 解析対象行
+    # @return [Symbol] 構文解析上の次の状態
+    def state_in_part0_contents_contents_end(line)
       @part1.lines << @lines
       if !@div_body_main.nil? && !@div_cse.nil?
         @part1.status = true
@@ -137,13 +176,19 @@ module Md2site
       :IN_PART2
     end
 
+    #
+    # part0_contents部のイベント処理
+    #
+    # @param event [Symbol] トークン種別
+    # @param line [String] 解析対象行
+    # @return [Symbol] 構文解析上の次の状態
     def state_in_part0_contents(event, line)
       case event
       when :CONTENTS_BEGIN
         @lines << line
         next_state = :IN_PART0_CONTENTS
       when :CONTENTS_END
-        next_state = state_in_part0_contents_contents_env(line)
+        next_state = state_in_part0_contents_contents_end(line)
       when :ID_BODY_MAIN
         @lines << line
         @div_body_main = line
@@ -169,6 +214,11 @@ module Md2site
       next_state
     end
 
+    #
+    # part1部のcontents_endイベント処理
+    #
+    # @param line [String] 解析対象行
+    # @return [Symbol] 構文解析上の次の状態
     def state_in_part1_contents_end(line)
       @part1.lines << @lines
       if !@div_body_main.nil? && !@div_cse.nil?
@@ -181,6 +231,12 @@ module Md2site
       :IN_PART2
     end
 
+    #
+    # part1部のイベント処理
+    #
+    # @param event [Symbol] トークン種別
+    # @param line [String] 解析対象行
+    # @return [Symbol] 構文解析上の次の状態
     def state_in_part1(event, line)
       case event
       when :CONTENTS_BEGIN
@@ -214,6 +270,12 @@ module Md2site
       next_state
     end
 
+    #
+    # part2部のイベント処理
+    #
+    # @param event [Symbol] トークン種別
+    # @param line [String] 解析対象行
+    # @return [Symbol] 構文解析上の次の状態
     def state_in_part2(event, line)
       @lines << line
 

data/lib/md2site/info.rb

@@ -1,10 +1,22 @@
 module Md2site
+  #
+  # infoサブコマンドクラス
   class Info
+    #
+    # 初期化
+    #
+    # @param env [Env] Envクラスのインスタンス
+    # @param mes [Messagex] Messagexクラスのインスタンス
     def initialize(env, mes)
       @env = env
       @mes = mes
     end
 
+    #
+    # サブコマンド実行
+    #
+    # @param option [Struct] オプションストラクト
+    # @return [void]
     def execute_subcommand(option)
       case option.name
       when "zlist"

data/lib/md2site/init.rb

@@ -1,9 +1,33 @@
 module Md2site
+  #
+  # initサブコマンドクラス
   class Init
-    attr_reader :hs, :confFile, :templateDir
+    #
+    # ハッシュ
+    #
+    # return [Hash]
+    attr_reader :hs
+
+    #
+    # 構成ファイルのパス
+    #
+    # return [String]
+    attr_reader :conf_file
+
+    #
+    # テンプレートディレクトリ
+    #
+    # return [String]
+    attr_reader :template_dir
 
     require "md2site/testdata"
 
+    #
+    # 初期化
+    #
+    # @param src_root_dir [String] コピー元ルートディレクトリ
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @param verbose [Boolean] FileUtilsクラスのメソッドのverbose引数に与える値
     def initialize(src_root_dir, mes, verbose)
       @mes = mes
       @verbose = verbose
@@ -29,6 +53,12 @@ module Md2site
       }
     end
 
+    #
+    # サブコマンド実行
+    #
+    # @param option [Struct] オプションストラクト
+    # @param option_url [Struct] URLオプションストラクト
+    # @return [void]
     def execute_subcommand(option, option_url)
       root_dir = option.value
       unless File.exist?(root_dir)
@@ -42,12 +72,13 @@ module Md2site
         url = DEFAULT_URL_SETTING
       end
 
-      @hs[KEY_ABSOLUTE_PATH_ROOT] = absolute_path_root
       @hs[KEY_URL] = url
 
       td = Testdata.new(@src_root_dir, @template_dir, hs)
 
       copy_all_files(@src_root_dir, @conf_dir, absolute_path_root, @conf_dir)
+      testdata_dir_array = td.testdata_dir_array
+      testdata_dir_array.map {|dir| copy_all_files(@src_root_dir, dir, absolute_path_root, @conf_dir) }
       template_dir_array = td.template_dir_array
       copy_templatefile(@src_root_dir, template_dir_array, absolute_path_root, @template_dir)
       files = expand_and_write_files(@src_root_dir, @conf_dir, absolute_path_root, [@conf_file], @hs)
@@ -58,22 +89,47 @@ module Md2site
 
     private
 
+    #
+    # 読込元のファイル群を書込先ディレクトリに変数展開して書き込む
+    #
+    # @param src_root_dir [String] 読込元ルートディレクトリ
+    # @param src_dir [String] 読込元ディレクトリ
+    # @param dest_root_dir [String] 書込先ルートディレクトリ
+    # @param files [Array<String>] 変数展開対象ファイル群
+    # @param hash [Hash] 置換用ハッシュ
+    # @return [Array<String>] 書き込んだだファイルへのパスの配列
     def expand_and_write_files(src_root_dir, src_dir, dest_root_dir, files, hash)
-      files.map do |x|
-        src_path = File.join(src_root_dir, src_dir, x)
+      files.map do |fname|
+        src_path = File.join(src_root_dir, src_dir, fname)
         content = Filex::Filex.check_and_expand_file(src_path, hash, @mes)
         dest_dir = File.join(dest_root_dir, src_dir)
         @mes.exc_make_directory(dest_dir) { FileUtils.mkdir_p(dest_dir, { verbose: @verbose }) }
-        dest_path = File.join(dest_dir, x)
+        dest_path = File.join(dest_dir, fname)
         @mes.exc_file_write(dest_path) { File.open(dest_path, "w") {|f| f.puts(content) } }
         dest_path
       end
     end
 
+    #
+    # コピー元ディレクトリ下のファイル群をコピー先ディレクトリにコピーする
+    #
+    # @param src_root_dir [String] コピー元ルートディレクトリ
+    # @param src_dir_array [Array<String>] コピー元ディレクトリ群
+    # @param dest_root_dir [String] コピー先ルートディレクトリ
+    # @param dest_dir [String] コピー先ディレクトリ
+    # @return [void]
     def copy_templatefile(src_root_dir, src_dir_array, dest_root_dir, dest_dir)
       src_dir_array.map {|x| copy_all_files(src_root_dir, x, dest_root_dir, dest_dir) }.flatten
     end
 
+    #
+    # コピー元のファイル群をコピー先ディレクトリにコピーする
+    #
+    # @param src_root_dir [String] コピー元ルートディレクトリ
+    # @param src_dir [String] コピー元ディレクトリ
+    # @param dest_root_dir [String] コピー先ルートディレクトリ
+    # @param dest_dir [String] コピー先ディレクトリ
+    # @return [void]
     def copy_all_files(src_root_dir, src_dir, dest_root_dir, dest_dir)
       dir = File.join(src_root_dir, src_dir)
       files = Dir[%Q(#{dir}/*)].map do |x|

data/lib/md2site/listfile.rb

@@ -1,7 +1,14 @@
 module Md2site
   require "csv"
 
+  #
+  # ダウンロード一覧ファイルクラス
   class ListFile
+    #
+    # 初期化
+    #
+    # @param dir [String] 書込先ディレクトリ
+    # @param mes [Messagex] Messagexクラスのインスタンス
     def initialize(dir, mes)
       @fname = File.join(dir, LIST_FILE)
       @mes = mes
@@ -11,10 +18,19 @@ module Md2site
       @csv.add_row([FIELD_FILENMAE, FIELD_DATETIMESTR, FIELD_UNIXTIME, FIELD_MD5])
     end
 
+    #
+    # 行追加
+    #
+    # @param row [Array<String>] 1行分のフィールドの配列
+    # @return [void]
     def add(row)
       @csv.add_row(row)
     end
 
+    #
+    # ダウンロード一覧ファイルクローズ
+    #
+    # @return [void]
     def close
       @mes.exc_file_close(@fname) { @csv.close }
     end