messagex 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1210c621ea510418004082f9d04c88aa3e3a8c4a19245c2b9d0c1b33297f3653
-  data.tar.gz: d37903a15c0cc39a290e8d7fa9e9bcbbeea998571f08bb7be44e3106d601d3bf
+  metadata.gz: a386955590d1742849e32e2de7d704fef132fe0c8c6c34be514affdb56423537
+  data.tar.gz: 76666c405b63c7e1996c91d638eb3dca914d82bbe3a0aee0b90fd5ff8760bf56
 SHA512:
-  metadata.gz: 5d322a5618c5f119de53a739e5fda6cb34c54843fccd0cf1b333a9bf937f7999c49eefcdd98e3cc998dd51d1edb3268fc8c69664406c965ed4c5533fd8e7b0c3
-  data.tar.gz: e926d9134224b5e99d138528124f5df3df9016d361f74e0d112e932c85b85506d91ce5adb8a01a355bacad527853310ff14335c58cfed5073c58bccfd551086a
+  metadata.gz: 1d44edde11c7dc2229f0a30569ca117a6fd06e79d18630f7ee65169b3d47a40cb74b5a9e78352d9c8567ea42674b1437c767259a796e759e2acd4cfe9e96e080
+  data.tar.gz: 7cf625ba7aaa239dfe4d425518c144d5733ad86a2fbc76e978064bb421d43fb38422fc2cfdd25f845bef35bb47d0bd6ae97f8737abaf876d3c97342e6a0d532c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    messagex (0.1.3)
+    messagex (0.1.4)
 
 GEM
   remote: https://rubygems.org/
@@ -20,24 +20,24 @@ GEM
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.68.1)
+    rubocop (0.71.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    rubocop-performance (1.2.0)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.3.0)
       rubocop (>= 0.68.0)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.5.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby

data/lib/messagex/exc.rb

@@ -1,9 +1,21 @@
 module Messagex
+  #
+  # I/O関連例外処理管理クラス
   class Exc
+    #
+    # 初期化
+    #
+    # @param mes [Messagex] Messagexクラスのインスタンス
     def initialize(mes)
       @mes = mes
     end
 
+    #
+    # I/O関連例外処理
+    #
+    # @param msg [String] エラーメッセージ
+    # @param exit_codestr [String] 終了ステータスの識別名
+    # @param block [Proc] Procのインスタンス
     def exc(msg, exit_codestr, block)
       begin
         block.call
@@ -18,48 +30,89 @@ module Messagex
       end
     end
 
+    #
+    # ディレクトリ移動失敗例外処理
+    #
+    # @param arg1 [String] 移動しようとしたディレクトリ名
+    # @param block [Proc] ブロック引数
     def exc_change_directory(arg1, &block)
       msg = "Can't change directory to |#{arg1}|"
       exit_codestr = "EXIT_CODE_CANNOT_CHANGE_DIRECTORY"
       exc(msg, exit_codestr, block)
     end
 
+    #
+    # ファイルオープン失敗例外処理
+    #
+    # @param arg1 [String] エラーメッセージに組みこむ値
+    # @param block [Proc] ブロック引数
     def exc_file_open(arg1, &block)
       msg = "Cannot open file #{arg1}"
       exit_codestr = "EXIT_CODE_CANNOT_OPEN_FILE"
       exc(msg, exit_codestr, block)
     end
 
+    #
+    # ファイル読込失敗例外処理
+    #
+    # @param arg1 [String] 読み込もうとしたファイル名
+    # @param block [Proc] ブロック引数
     def exc_file_read(arg1, &block)
       msg = "Cannot read file #{arg1}"
       exit_codestr = "EXIT_CODE_CANNOT_READ_FILE"
       exc(msg, exit_codestr, block)
     end
 
+    #
+    # ファイル１行読込失敗例外処理
+    #
+    # @param arg1 [String] 読み込もうとしたファイル名
+    # @param block [Proc] ブロック引数
     def exc_file_gets(arg1, &block)
       msg = "Cannot read file #{arg1}"
       exit_codestr = "EXIT_CODE_CANNOT_READ_FILE"
       exc(msg, exit_codestr, block)
     end
 
+    #
+    # ファイルクローズ失敗例外処理
+    #
+    # @param arg1 [String] クローズしようとしたファイル名
+    # @param block [Proc] ブロック引数
     def exc_file_close(arg1, &block)
       msg = "Cannot close file #{arg1}"
       exit_codestr = "EXIT_CODE_CANNOT_OPEN_FILE"
       exc(msg, exit_codestr, block)
     end
 
+    #
+    # ファイル書込失敗例外処理
+    #
+    # @param arg1 [String] 書き込もうとしたファイル名
+    # @param block [Proc] ブロック引数
     def exc_file_write(arg1, &block)
       msg = "Cannot write file #{arg1}"
       exit_codestr = "EXIT_CODE_CANNOT_WRITE_FILE"
       exc(msg, exit_codestr, block)
     end
 
+    #
+    # ファイルコピー失敗例外処理
+    #
+    # @param arg1 [String] コピー元ファイル名
+    # @param arg2 [String] コピー先ファイル名
+    # @param block [Proc] ブロック引数
     def exc_file_copy(arg1, arg2, &block)
       msg = "Can't copy file from #{arg1} to #{arg2}"
       exit_codestr = "EXIT_CODE_CANNOT_COPY_FILE"
       exc(msg, exit_codestr, block)
     end
 
+    #
+    # ディレクトリ作成失敗例外処理
+    #
+    # @param arg1 [String] 作成しようとしたディレクトリ名
+    # @param block [Proc] ブロック引数
     def exc_make_directory(arg1, &block)
       msg = "Can't make directory to #{arg1}"
       exit_codestr = "EXIT_CODE_CANNOT_MAKE_DIRECTORY"

data/lib/messagex/loggerx.rb

@@ -1,59 +1,105 @@
 require "logger"
 
 module Messagex
+  #
+  # 出力先が標準出力とファイルの２種類をもつログ機能管理クラス
   class Loggerx
+    #
+    # 初期化
+    #
+    # @param fname [String] ログの出力先ファイル名
     def initialize(fname)
-      @loggerSTDOUT = Logger.new(STDOUT)
-      @loggerSTDOUT.level = Logger::UNKNOWN
-      @loggerSTDOUT.formatter = proc do |severity, _datetime, _progname, msg|
+      @logger_stdout = Logger.new(STDOUT)
+      @logger_stdout.level = Logger::UNKNOWN
+      @logger_stdout.formatter = proc do |severity, _datetime, _progname, msg|
         "#{severity[0]}: #{msg}\n"
       end
       file = File.open(fname, "w")
-      @loggerFILE = Logger.new(file)
-      @loggerFILE.level = Logger::INFO
-      @loggerFILE.formatter = proc do |severity, _datetime, _progname, msg|
+      @logger_file = Logger.new(file)
+      @logger_file.level = Logger::INFO
+      @logger_file.formatter = proc do |severity, _datetime, _progname, msg|
         "#{severity}: #{msg}\n"
       end
     end
 
+    #
+    # ログ記録の日時フォーマットの設定
+    #
+    # @param format [String] ログ記録の日時フォーマット
+    # @return [void]
     def datetime_format=(format)
-      @loggerSTDOUT.datetime_format = format
-      @loggerFILE.datetime_format = format
+      @logger_stdout.datetime_format = format
+      @logger_file.datetime_format = format
     end
 
+    #
+    # ログ記録のフォーマットの設定
+    #
+    # @param format [String] ログ記録のフォーマット
+    # @return [void]
     def formatter=(format)
-      @loggerSTDOUT.formatter = format
-      @loggerFILE.formatter = format
+      @logger_stdout.formatter = format
+      @logger_file.formatter = format
     end
 
+    #
+    # ログレベルの設定
+    #
+    # @param value [String,Symbol] ログレベル
+    # @return [void]
     def level=(value)
-      @loggerSTDOUT.level = value
-      @loggerFILE.level = value
+      @logger_stdout.level = value
+      @logger_file.level = value
     end
 
-    def debug(mes)
-      @loggerSTDOUT.debug(mes)
-      @loggerFILE.debug(mes)
+    #
+    # ログレベルが DEBUG のメッセージを出力
+    #
+    # @param msg [String] メッセージ
+    # @return [void]
+    def debug(msg)
+      @logger_stdout.debug(msg)
+      @logger_file.debug(msg)
     end
 
-    def error(mes)
-      @loggerSTDOUT.error(mes)
-      @loggerFILE.error(mes)
+    #
+    # ログレベルが ERROR のメッセージを出力
+    #
+    # @param msg [String] メッセージ
+    # @return [void]
+    def error(msg)
+      @logger_stdout.error(msg)
+      @logger_file.error(msg)
     end
 
-    def fatal(mes)
-      @loggerSTDOUT.fatal(mes)
-      @loggerFILE.fatal(mes)
+    #
+    # ログレベルが FATAL のメッセージを出力
+    #
+    # @param msg [String] メッセージ
+    # @return [void]
+    def fatal(msg)
+      @logger_stdout.fatal(msg)
+      @logger_file.fatal(msg)
     end
 
-    def warn(mes)
-      @loggerSTDOUT.warn(mes)
-      @loggerFILE.warn(mes)
+    #
+    # ログレベルが WARN のメッセージを出力
+    #
+    # @param msg [String] メッセージ
+    # @return [void]
+    def warn(msg)
+      @logger_stdout.warn(msg)
+      @logger_file.warn(msg)
     end
 
-    def info(mes)
-      @loggerSTDOUT.info(mes)
-      @loggerFILE.info(mes)
+    #
+    # ログレベルが INFO のメッセージを出力
+    #
+    # @param msg [String] メッセージ
+    # @return [void]
+    def info(msg)
+      @logger_stdout.info(msg)
+      @logger_file.info(msg)
     end
   end
 end

data/lib/messagex/version.rb

@@ -1,3 +1,4 @@
 module Messagex
-  VERSION = "0.1.3"
+  # バージョン番号
+  VERSION = "0.1.4"
 end

data/lib/messagex.rb

@@ -1,24 +1,56 @@
+#
+# 終了ステータス管理、ログ機能管理のモジュール
 module Messagex
+  #
+  # 終了ステータス管理、ログ機能管理のクラス
   class Messagex
     extend Forwardable
 
+    # @!method exc
+    #   @see Exc#exc
+    # @!method exc_change_directory
+    #   @see Exc#exc_change_directory]
+    # @!method exc_file_open
+    #   @see Exc#exc_file_open
+    # @!method exc_file_read
+    #   @see Exc#exc_file_read
+    # @!method exc_file_gets
+    #   @see Exc#exc_file_gets
+    # @!method exc_file_close
+    #   @see Exc#exc_file_close
+    # @!method exc_file_write
+    #   @see Exc#exc_file_write
+    # @!method exc_file_copy
+    #   @see Exc#exc_file_copy
+    # @!method exc_make_directory
+    #   @see Exc#exc_make_directory
     def_delegators :@exc_inst, :exc, :exc_change_directory, :exc_file_open, :exc_file_read, :exc_file_gets, :exc_file_close, :exc_file_write, :exc_file_copy, :exc_make_directory
 
+    # @return [Loggerx] Loggerxクラスのインスタンス
     attr_reader :logger
 
     require "messagex/version"
     require "messagex/loggerx"
     require "messagex/exc"
 
-    def initialize(initialExitCode, initialNum, debug=:warn, logger=nil, logfname=nil)
+    #
+    # 初期化
+    #
+    # @param initial_exitcode [String] 最初に登録する終了ステータスの識別名
+    # @param initial_num [Integer] 登録する終了ステータスの初期値
+    # @param debug [Symbol] ログ機能のログレベル指定 `:debug`、`:verbose`、その他
+    # @param logger [Loggerx]　複数のLoggerクラスのインスタンスを持つことが出来るLoggerxクラスのインスタンス
+    # @param logfname [String] ログの出力先ファイル名
+    # @note 引数debugの値はLoggerクラスのログレベル設定とは指定方法が異なる
+    def initialize(initial_exitcode, initial_num, debug=:warn, logger=nil, logfname=nil)
       @exit_code = {}
-      set_initial_exitcode(initialExitCode, initialNum)
+      set_initial_exitcode(initial_exitcode, initial_num)
 
       if logger
         @logger = logger
       else
-        logFname = (!logfname.nil? && !logfname.empty?) ? logfname : "log.txt"
-        @logger = Loggerx.new(logFname)
+        log_fname = (!logfname.nil? && !logfname.empty?) ? logfname : "log.txt"
+        @logger = Loggerx.new(log_fname)
         #    Logger::WARN , Logger::INFO
 
         case debug
@@ -41,10 +73,14 @@ module Messagex
         end
       end
 
-      register_exit_codes
+      register_exitcodes
     end
 
-    def register_exit_codes
+    #
+    # Messagexクラスで利用する終了ステータスの登録
+    #
+    # @return [void]
+    def register_exitcodes
       add_exitcode("EXIT_CODE_CANNOT_READ_FILE")
       add_exitcode("EXIT_CODE_CANNOT_WRITE_FILE")
       add_exitcode("EXIT_CODE_CANNOT_FIND_DIRECTORY")
@@ -54,28 +90,53 @@ module Messagex
       add_exitcode("EXIT_CODE_CANNOT_COPY_FILE")
     end
 
+    #
+    # I/O関連例外処理管理クラスのインスタンスの登録
+    #
+    # @return [void]
     def register_exc
       @exc_inst = Exc.new(self)
     end
 
+    #
+    # 識別名で指定された終了ステータスを得る
+    #
+    # @param name [String] 登録された終了ステータスの識別名
+    # @return [Integer] 終了ステータス
     def ec(name)
       @exit_code[name]
     end
 
+    #
+    # 終了ステータスの最初の登録
+    #
+    # @param name [String] 登録する終了ステータスの識別名
+    # @param num [Integer] 登録する終了ステータスの値
+    # @return [void]
     def set_initial_exitcode(name, num)
-      @exit_code = {}
+      @exit_code ||= {}
       @exit_code[name] = num
-      @cur_exitcode = num
+      @cur_exit_code = num
     end
 
+    #
+    # 終了ステータスの値の自動割り当て
+    #
+    # @param name [String] 値の自動割り当て対象の終了ステータスの識別名
+    # @return [Integer] 自動割り当てされた終了ステータスの値
     def add_exitcode(str)
       return if @exit_code[str]
 
-      num = (@cur_exitcode + 1)
+      num = (@cur_exit_code + 1)
       @exit_code[str] = num
-      @cur_exitcode = num
+      @cur_exit_code = num
     end
 
+    #
+    # ログレベルが ERROR のメッセージを出力
+    #
+    # @param msg [String] 
+    # @return [void]
     def output_error(msg)
       if @logger
         @logger.error(msg)
@@ -84,6 +145,11 @@ module Messagex
       end
     end
 
+    #
+    # ログレベルが FATAL のメッセージを出力
+    #
+    # @param msg [String] 
+    # @return [void]
     def output_fatal(msg)
       if @logger
         @logger.fatal(msg)
@@ -92,6 +158,11 @@ module Messagex
       end
     end
 
+    #
+    # ログレベルが DEBUG のメッセージを出力
+    #
+    # @param msg [String] 
+    # @return [void]
     def output_debug(msg)
       if @logger
         @logger.debug(msg)
@@ -100,6 +171,11 @@ module Messagex
       end
     end
 
+    #
+    # ログレベルが INFO のメッセージを出力
+    #
+    # @param msg [String] 
+    # @return [void]
     def output_info(msg)
       if @logger
         @logger.info(msg)
@@ -108,6 +184,11 @@ module Messagex
       end
     end
 
+    #
+    # ログレベルが WARN のメッセージを出力
+    #
+    # @param msg [String] 
+    # @return [void]
     def output_warn(msg)
       if @logger
         @logger.warn(msg)
@@ -116,10 +197,15 @@ module Messagex
       end
     end
 
-    def output_exception(e)
-      output_fatal(e.class)
-      output_fatal(e.message)
-      output_fatal(e.backtrace.join("\n"))
+    #
+    # ログレベルが ERROR のメッセージを出力
+    #
+    # @param msg [String] 
+    # @return [void]
+    def output_exception(exception)
+      output_fatal(exception.class)
+      output_fatal(exception.message)
+      output_fatal(exception.backtrace.join("\n"))
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: messagex
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 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