md2site 0.1.2 → 0.1.4

data/lib/md2site/statusfile.rb

@@ -1,11 +1,30 @@
 module Md2site
   require "yaml"
 
+  #
+  # ダウンロードステータスファイルクラス
   class StatusFile
-    attr_accessor :baseurl, :fname, :fpath, :last_datetime, :last_contents_path, :path
+    # @return [String] ダウンロード先ホストのURL
+    attr_accessor :baseurl
+    # @return [String] ダウンロードヘッダ一覧ファイル名
+    attr_accessor :fname
+    # @return [String] ダウンロードヘッダ一覧ファイルへのパス
+    attr_accessor :fpath
+    # @return [String] ダウンロード開始日時
+    attr_accessor :last_datetime
+    # ダウンロード保存先ディレクトリへのパス
+    attr_accessor :last_contents_path
 
-    def initialize(path, baseurl, mes)
+    #
+    # 初期化
+    #
+    # @param path [String] ダウンロードステータスファイルへのパス
+    # @param baseurl [String] ダウンロード先ホストのURL
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    def initialize(path, absolutepath_root, baseurl, mes)
       @path = path
+      @absolutepath_root_pn = Pathname.new(absolutepath_root)
+
       @baseurl = baseurl
       @mes = mes
 
@@ -18,9 +37,12 @@ module Md2site
         obj = Filex::Filex.load_yaml(content, @mes)
         @baseurl = obj[:baseurl]
         @fname = obj[:fname]
-        @fpath = obj[:path]
+        @fpath = obj[:fpath]
+        @absolutepath_fpath_pn = Pathname.new(get_absolute_path(@fpath))
         @last_datetime = obj[:last_datetime]
+
         @last_contents_path = obj[:last_contents_path]
+        @absolutepath_last_contents_path_pn = Pathname.new(get_absolute_path(@last_contents_path))
       else
         @baseurl = @baseurl
         @fname = nil
@@ -30,6 +52,12 @@ module Md2site
       end
     end
 
+    #
+    # ダウンロードステータスファイル出力
+    #
+    # @param path [String] ダウンロードステータスファイルへのパス
+    # @param content [String] ダウンロードステータスファイルの内容
+    # @return [void]
     def output(path, content)
       File.open(path, "w") do |ofile|
         ofile.puts(content)
@@ -37,8 +65,26 @@ module Md2site
       end
     end
 
+    #
+    # ダウンロードステータスファイル更新
+    #
+    # @return [void]
+    # @note YAML形式に変換できなければダウンロードステータスファイルを更新しない
     def update
-      hs = { baseurl: @baseurl, fname: @fname, path: @fpath, last_datetime: @last_datetime, last_contents_path: @last_contents_path }
+      if @fpath
+        @absolutepath_fpath_pn = Pathname.new(get_absolute_path(@fpath))
+        @fpath = @absolutepath_fpath_pn.relative_path_from(@absolutepath_root_pn).to_s
+      else
+        @fpath = ""
+      end
+
+      if @last_contents_path
+        @absolutepath_last_contents_path_pn = Pathname.new(get_absolute_path(@last_contents_path))
+        @last_contents_path = @absolutepath_last_contents_path_pn.relative_path_from(@absolutepath_root_pn).to_s
+      else
+        @last_contents_path = ""
+      end
+      hs = { baseurl: @baseurl, fname: @fname, fpath: @fpath, last_datetime: @last_datetime, last_contents_path: @last_contents_path }
       begin
         content = YAML.dump(hs)
       rescue Error => e
@@ -51,6 +97,12 @@ module Md2site
       @mes.exc_file_write(@path) { output(@path, content) }
     end
 
+    #
+    # ダウンロードステータスファイルの内容の取得
+    #
+    # @param path [String] ダウンロードステータスファイルへのパス
+    # @return [String] ダウンロードステータスファイルの内容
+    # @note 引数pathがnilであれば例外発生
     def get_statusfile(path)
       unless path
         raise
@@ -63,13 +115,53 @@ module Md2site
       content
     end
 
-    def pint
+    #
+    # ダウンロードステータスファイルの内容の出力（デバッグ用）
+    #
+    # @return [void]
+    def print
       @mes.output_info("baseurl=#{@baseurl}")
       @mes.output_info("fname=#{@fname}")
       @mes.output_info("fpath=#{@fpath}")
       @mes.output_info("last_datetime=#{@last_datetime}")
       @mes.output_info("last_contents_path=#{@last_contents_path}")
-      @mes.output_info("path=#{@path}")
+    end
+
+    private
+
+    #
+    # プロジェクトのルートディレクトリに対する相対パス
+    #
+    # @param path [String] 相対パスにしたいパス
+    # @return [String] プロジェクトのルートディレクトリに対する相対パス
+    def get_relative_path(path)
+      if path
+        to_path_pn = Pathname.new(path)
+        unless to_path_pn.absolute?
+          to_path_pn = to_path_pn.expand_path
+        end
+      else
+        to_path_pn = Pathname.new("")
+      end
+      to_path_pn.relative_path_from(@absolutepath_fpath_pn).to_s
+    end
+
+    #
+    # プロジェクトのルートディレクトリと相対パスを合わせた絶対パスを得る
+    #
+    # @param path [String] 相対パス
+    # @return [String] プロジェクトのルートディレクトリと相対パスを合わせた絶対パスを得る
+    def get_absolute_path(path)
+      if path
+        path_pn = Pathname.new(path)
+        if path_pn.absolute?
+          path_pn.to_s
+        else
+          (@absolutepath_root_pn + path_pn).to_s
+        end
+      else
+        ""
+      end
     end
   end
 end

data/lib/md2site/testdata.rb

@@ -1,5 +1,14 @@
 module Md2site
+  #
+  # テストデータクラス
   class Testdata
+    #
+    # 初期化
+    #
+    # @param src_data_dir [String] テストデータのコピー元ディレクトリ
+    # @param templatedir [String] テストデータのテンプレートディレクトリ
+    # @param hash [Hash] 修正対象ハッシュ
+    # @param num [Integer]
     def initialize(src_data_dir, templatedir, hash, num=1)
       @hash = hash
       @src_data_dir = src_data_dir
@@ -9,20 +18,29 @@ module Md2site
       require_htmlutils(num) unless defined?(HTMLUtils)
     end
 
+    #
+    # URLに応じてハッシュの内容を修正する
+    #
+    # @param hash [Hash] 修正対象ハッシュ
+    # @return [void]
     def check_additional_conf(hash)
       url = hash["url"]
       hash["functions_variable"] ||= ""
-      hash["functions_static"]   ||= %Q(ROOT_TEMPLATE_FUNCTIONS_VARIABLE=#{File.join(@src_data_dir, %q(/template/functions_variable.erb))})
+      hash["functions_static"]   ||= %Q(ROOT_TEMPLATE_FUNCTIONS_VARIABLE=#{%q(${ABSOLUTE_PATH_ROOT_TEMPLATE}/functions_variable.erb)})
       hash["contentDivisionWay"] ||= ""
 
       case url
       when /www\.toppers\.jp/
         hash["contentDivisionWay"] = "CONTENT_DIVISION_WAY=0"
-        hash["functions_variable"] = %Q(ROOT_TEMPLATE_FUNCTIONS_VARIABLE=#{File.join(@src_data_dir, %q(/template/functions_variable.erb))})
-        hash["functions_static"]   = %Q(ROOT_TEMPLATE_FUNCTIONS_STATIC=#{File.join(@src_data_dir, %q(/template/functions_static.erb))})
+        hash["functions_variable"] = %Q(ROOT_TEMPLATE_FUNCTIONS_VARIABLE=#{%q(${ABSOLUTE_PATH_ROOT_TEMPLATE}/functions_variable.erb)})
+        hash["functions_static"]   = %Q(ROOT_TEMPLATE_FUNCTIONS_STATIC=#{%q(${ABSOLUTE_PATH_ROOT_TEMPLATE}/functions_static.erb)})
       end
     end
 
+    #
+    # URLに応じたテンプレートディレクトリを得る
+    #
+    # @return [Array<String>] URLに応じたテンプレートディレクトリの配列
     def template_dir_array
       array = [@templatedir]
 
@@ -34,6 +52,28 @@ module Md2site
       array
     end
 
+    #
+    # URLに応じたテストデータディレクトリを得る
+    #
+    # @return [Array<String>] URLに応じたテストデータディレクトリの配列
+    def testdata_dir_array
+      array = []
+
+      case @hash["url"]
+      when /www\.toppers\.jp/
+        array << TESTDATA_DIR_TOPPERS
+      when /northern-cross\.info/
+        array << TESTDATA_DIR_TOPPERS
+      end
+
+      array
+    end
+
+    #
+    # 適切なHTMLファイル分割クラスの読み込み
+    #
+    # @param num [Integer]
+    # @return [Array<String>] URLに応じた適切なHTMLファイル分割クラスの読み込み
     def require_htmlutils(num=1)
       if @content_division
         num = @content_division.to_i

data/lib/md2site/testx.rb

@@ -1,5 +1,15 @@
 module Md2site
+  #
+  # 全サブコマンド実行クラス
   class Testx
+    #
+    # 初期化
+    #
+    # @param option [Hash] オプション
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @param verbose [Boolean] FileUtilsクラスのメソッドのverbose引数に与える値
+    # @param src_data_dir [String] テストデータコピー元
+    # @param opt_struct [Struct] オプションストラクト
     def initialize(option, mes, verbose, src_data_dir, opt_struct)
       @option = option
       @mes = mes
@@ -8,6 +18,11 @@ module Md2site
       @opt_struct = opt_struct
     end
 
+    #
+    # initサブコマンド実行
+    #
+    # @param option_url [Struct] オプションURL
+    # @return [void]
     def execute_subcommand_init(option_url)
       case option_url.value
       when /northern\-cross\.info/
@@ -21,6 +36,10 @@ module Md2site
       end
     end
 
+    #
+    # initサブコマンドAパターン実行
+    #
+    # @return [void]
     def init_a(option_url, tsv_filepath, test_data_dir_path)
       root_path = @option.value
       optionx = @opt_struct.new("init", root_path)
@@ -28,7 +47,7 @@ module Md2site
       init.execute_subcommand(optionx, option_url)
 
       conf_dir = File.join(root_path, init.hs["conf_dir"])
-      conf_path = File.join(conf_dir, init.confFile)
+      conf_path = File.join(conf_dir, init.conf_file)
       dir = File.dirname(root_path)
       base = File.basename(root_path)
       content_path = File.join(dir, %Q(#{base}-contents))
@@ -44,12 +63,20 @@ module Md2site
       [conf_path, content_path]
     end
 
+    #
+    # initサブコマンドBパターン実行
+    #
+    # @return [void]
     def init_b(option, option_url)
       @mes.output_warn(%Q(option=#{option.value}))
       @mes.output_warn(%Q(optionUrl=#{option_url.value}))
       exit(@mes.ec("EXIT_CODE_NORMAL_EXIT"))
     end
 
+    #
+    # initサブコマンド以外のサブコマンド実行
+    #
+    # @return [void]
     def execute_subcommand_remain(env, content_path, str_variable, str_static, obj_by_yaml)
       setup = Setup.new(env, @mes)
       optionx = @opt_struct.new("zcontents", content_path)

data/lib/md2site/version.rb

@@ -1,3 +1,3 @@
 module Md2site
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/md2site.rb

@@ -1,36 +1,70 @@
 require "md2site/version"
 
+#
+# Markdown形式ファイルによるサイト作成
 module Md2site
+  # 構成ファイル名
   CONF_FILE = "conf.sh"
+  # 構成ディレクトリ名
   CONF_DIR = "conf"
+  # テンプレートディレクトリ名
   TEMPLATE_DIR = "template"
+  # 出力ディレクトリ名
   OUTPUT_DIR = "output"
+  # ソースディレクトリ名
   SRC_DIR = "src"
+  # データディレクトリ名
   DATA_DIR = "data"
+  # ワークディレクトリ名
   WORK_DIR = "work"
+  # 素材ディレクトリ名
   MATERIAL_DIR = "material"
+  # ダウンロードステータスファイル
   STATUS_FILE = "status.txt"
+  # サイト構成ファイル
   SITE_FILE = "site.tsv"
+  # サイト固有設定ファイル
   SETTING_FILE = "setting.yml"
+  # カテゴリ構成ファイルプレフィックス
   CATEGORY_CONF_PREFIX = "conf-"
+  # デフォルトテーブルテンプレートファイル名
   DEFAULT_TABLE_TEMPLATE_FILE = "5col_no_attr_b.erb"
+  # デフォルトURL設定
   DEFAULT_URL_SETTING = %Q(# URL=http://example.com)
-  KEY_ABSOLUTE_PATH_ROOT = "absolutePathRoot"
+  # urlを示すハッシュのキー
   KEY_URL = "url"
+  # カテゴリ構成ファイル中のINCLUDE指示子
   INCLUDE_INDICATOR = ":include"
+  # infoサブコマンドのzindexオプションで生成されるHTMLファイル名
   ZINDEX_HTML_FILE = "zindex.html"
+  # 全てのターゲットを示すターゲットコマンド名
   TARGET_COMMAND_OF_ALL = "_z"
+  # サブターゲットを全ての示すサブターゲットコマンド名
   SUB_TARGET_COMMAND_OF_ALL = "_z"
+  # ダウンロードファイル一覧ファイル名
   LIST_FILE = "filelist.tsv"
+  # ダウンロードファイル一覧ファイルのファイル名フィールドのフィールド名
   FIELD_FILENMAE = "filename"
+  # ダウンロードファイル一覧ファイルの日時フィールドのフィールド名
   FIELD_DATETIMESTR = "datetimestr"
+  # ダウンロードファイル一覧ファイルのUNIXタイムフィールドのフィールド名
   FIELD_UNIXTIME = "unixtime"
+  # ダウンロードファイル一覧ファイルのMD5値フィールドのフィールド名
   FIELD_MD5 = "md5"
+  # テストデータディレクトリ下の第2テンプレート用のサブディレクトリ名
   TEMPLATE_DIR2 = "template2"
+  # テストデータディレクトリ下のtoppersサイト用ディレクトリ
+  TESTDATA_DIR_TOPPERS = "testdata0/conf"
+  # テストデータディレクトリ下のnciサイト用ディレクトリ
+  TESTDATA_DIR_NCI = "testdata/conf"
 
+  #
+  # Md2siteモジュール内でのエラークラス
   class Error < StandardError; end
   # Your code goes here...
 
+  #
+  # Markdown形式ファイルによるサイト作成クラス
   class Md2site
     require "mdextab"
     require "messagex"
@@ -38,6 +72,7 @@ module Md2site
     require "open3"
     require "tempfile"
     require "md2site/env"
+    require "md2site/envcheck"
     require "md2site/init"
     require "md2site/testdata"
     require "md2site/setup"
@@ -45,8 +80,13 @@ module Md2site
     require "md2site/make"
     require "md2site/testx"
 
-    attr_accessor :option, :optionUrl, :mes, :verbose, :srcDataDir, :optStruct
-
+    #
+    # 初期化
+    #
+    # @param opts [Hash] オプション
+    # @option opts [Boolean] :debug nilでなければMessagexクラスのインスタンスに与えるデバッグモードであり、かつFileUtilsクラスのインスタンスメソッドに与える:verboseオプションの値を真にする
+    # @option opts [Boolean] :verbose nilでなければMessagexクラスのインスタンスに与えるデバッグモードであり、、かつFileUtilsクラスのインスタンスメソッドに与える:verboseオプションの値を真にする
+    # @option opts [String] :logfile Messagexクラスのインスタンスに与えるLoggerの出力先ファイル名
     def initialize(opts)
       @src_data_dir = File.expand_path(File.dirname(__FILE__) + %q(/../data))
 
@@ -56,10 +96,10 @@ module Md2site
       @setup = nil
       @info = nil
 
-      if opts["debug"]
+      if opts[:debug]
         @debug = :debug
         @verbose = true
-      elsif opts["verbose"]
+      elsif opts[:verbose]
         @debug = :verbose
         @verbose = true
       else
@@ -67,7 +107,7 @@ module Md2site
         @verbose = false
       end
 
-      @mes = Messagex::Messagex.new("EXIT_CODE_NORMAL_EXIT", 0, @debug, nil, opts["logfile"])
+      @mes = Messagex::Messagex.new("EXIT_CODE_NORMAL_EXIT", 0, @debug, nil, opts[:logfile])
       @mes.register_exc
       @mes.add_exitcode("EXIT_CODE_BY_CANNOT_FIND_TARGET")
       @mes.add_exitcode("EXIT_CODE_BY_CANNOT_FIND_SUBTARGET")
@@ -82,51 +122,77 @@ module Md2site
       option_parse(opts)
     end
 
+    #
+    # オプション解析
+    #
+    # @param opts [Hash] オプション
+    # @option opts [String,nil] :targetCommand nilでなければターゲットコマンド名
+    # @option opts [String,nil] :subTargetCommand nilでなければサブターゲットコマンド名
+    # @option opts [String,nil] :zcontents nilでなければダウンロード先ディレクトリ名
+    # @option opts [String,nil] :contentUpdate nilでなければアップデート元ディレクトリ名
+    # @option opts [String,nil] :getfiles nilでなければダウンロード先ディレクトリ名
+    # @option opts [true,nil] :zlist nilでなければinfoサブコマンドのzlistオプションが有効
+    # @option opts [true,nil] :zindex nilでなければinfoサブコマンドのzindexオプションが有効
+    # @option opts [true,nil] :contentUpdate nilでなければsetupサブコマンドのzupdateオプションが有効
+    # @option opts [String,nil] :init nilでなければプロジェクトルートディレクトリ
+    # @option opts [String,nil] :url nilでなければダウンロード対象URL
+    # @option opts [String] :confPath 構成ファイルパス
+    # @return [void]
     def option_parse(opts)
-      @target_command = opts["targetCommand"]
-      @subtarget_command = opts["subTargetCommand"]
-      if opts["all"]
-        @option = @opt_struct.new("all", opts["all"])
-      elsif opts["zcontents"]
-        @option = @opt_struct.new("zcontents", opts["zcontents"])
-      elsif opts["contentUpdate"]
+      @target_command = opts[:targetCommand]
+      @subtarget_command = opts[:subTargetCommand]
+      if opts[:zcontents]
+        @option = @opt_struct.new("zcontents", opts[:zcontents])
+      elsif opts[:contentUpdate]
         @option = @opt_struct.new("contentUpdate")
-      elsif opts["getfiles"]
-        @option = @opt_struct.new("getfiles", opts["getfiles"])
-      elsif opts["zlist"]
+      elsif opts[:getfiles]
+        @option = @opt_struct.new("getfiles", opts[:getfiles])
+      elsif opts[:zlist]
         @option = @opt_struct.new("zlist")
-      elsif opts["zindex"]
+      elsif opts[:zindex]
         @option = @opt_struct.new("zindex")
-      elsif opts["zsetup"]
-        @option = @opt_struct.new("zsetup", opts["zsetup"])
-      elsif opts["init"]
-        @option = @opt_struct.new("init", opts["init"])
+      elsif opts[:zsetup]
+        @option = @opt_struct.new("zsetup", opts[:zsetup])
+      elsif opts[:init]
+        @option = @opt_struct.new("init", opts[:init])
       end
 
       @option_url = nil
-      if opts["url"]
-        @option_url = @opt_struct.new("url", opts["url"])
+      if opts[:url]
+        @option_url = @opt_struct.new("url", opts[:url])
       end
-      @option_conf_path = @opt_struct.new("confPath", opts["confPath"])
+
+      @option_conf_path = @opt_struct.new("confPath", opts[:confPath])
     end
 
+    #
+    # 構成ファイル、サイト固有設定ファイルで初期化
+    #
+    # @param conf_path [String] 構成ファイルパス
+    # @param src_data_dir [String] インストール先データディレクトリ名
     def setup_env(conf_path, src_data_dir)
       unless File.exist?(conf_path)
         @mes.output_fatal("Can't find #{conf_path} specified by -c or --confpath option")
         exit(@mes.ec("EXIT_CODE_CANNOT_FIND_CONFPATH"))
       end
 
+      # 構成ファイル読み込みEnvクラスのインスタンスの属性としてアクセス可能にする
       @env = Env.new(conf_path, @mes, @verbose)
 
+      # サイト固有設定ファイル（YAML形式ファイル）を読み込み、Rubyのハッシュとしてアクセス可能にする
       @obj_by_yaml = Filex::Filex.check_and_load_yamlfile(@env.absolutepath_root_settingfile, @mes)
 
-      Testdata.new(src_data_dir, @init.templateDir, @env.conf_hs)
+#      Testdata.new(src_data_dir, @init.template_dir, @env.conf_hs)
       fname_variable = @env.conf_hs["ROOT_TEMPLATE_FUNCTIONS_VARIABLE"]
       @str_variable = Filex::Filex.check_and_load_file(fname_variable, @mes) if fname_variable
       fname_static = @env.conf_hs["ROOT_TEMPLATE_FUNCTIONS_STATIC"]
       @str_static = ["<% ", Filex::Filex.check_and_expand_file(fname_static, @obj_by_yaml, @mes), "%>"].join("\n") if fname_static
     end
 
+    #
+    # サブコマンド実行
+    #
+    # @param cmd [String] サブコマンド名
     def execute_command(cmd)
       @init ||= Init.new(@src_data_dir, @mes, @verbose)
 
@@ -136,6 +202,7 @@ module Md2site
         @testx ||= Testx.new(@option, @mes, @verbose, @src_data_dir, @opt_struct)
         conf_path, content_path = testx.execute_subcommandInit(@option_url)
         setup_env(conf_path, @src_data_dir)
+
         @testx.execute_subcommandRemain(@env, content_path, @str_variable, @str_static, @obj_by_yaml)
       else
         setup_env(@option_conf_path.value, @src_data_dir) unless @env
@@ -144,7 +211,7 @@ module Md2site
         when "make"
           @make ||= Make.new(@env, @mes, @verbose, @str_variable, @str_static, @obj_by_yaml)
           if @target_command == "_z"
-            @env.commands.map {|x| @make.do_multiple_commands(x[0]) }
+            @env.commands.keys.map {|x| @make.do_multiple_commands(x) }
           else
             @make.execute_subcommand(@target_command, @subtarget_command)
           end

data/md2site.gemspec

@@ -36,24 +36,23 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "bundler", "~> 2.0"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug"
-  spec.add_development_dependency "power_assert", "~> 1.1.4"
   spec.add_development_dependency "test-unit"
   spec.add_development_dependency "test-unit-rr"
-  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop", "0.69.0"
   spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "power_assert", "~> 1.1.5"
 
+  spec.add_runtime_dependency "bundler", "~> 2.0"
   spec.add_runtime_dependency "simpleoptparse"
   spec.add_runtime_dependency "erubis"
   spec.add_runtime_dependency "mdextab", "~> 0.1.4"
   spec.add_runtime_dependency "nokogiri"
-  spec.add_runtime_dependency "messagex"
-  spec.add_runtime_dependency "filex"
+  spec.add_runtime_dependency "messagex", "~> 0.1.3"
+  spec.add_runtime_dependency "filex", "~> 0.1.3"
   spec.add_runtime_dependency "faraday"
   spec.add_runtime_dependency "faraday_middleware"
 end