filex 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79be0fdcfe0f3da7f8fc16d5b300875a01d7c64668775cca92c9b2a659e93ea1
-  data.tar.gz: 07de986587dcc1d22588964d84af13613c25b29fec804ea43db44639f29095db
+  metadata.gz: '07842dde93309500dc3c9462ba33e530443a84376a4c6e5cf7edce3d5b9843a7'
+  data.tar.gz: 73b1b04a6b0c0e42693e8ee11d523647b1aeaa57e31238f57ef3aecab64fc6b8
 SHA512:
-  metadata.gz: e2c227e6164b81babb75a5d814b8504ce98ea198fc013430f4a492b34798727762fb9ff9b680a5887037b3c88f34b8f057fa89acb104f9226ed6ff415c630872
-  data.tar.gz: 1d2d6f933234c15062e191d21617fa21f105da96c58e44a58a2c575659146c024de8bdb3fbc51da2605b9eb3d6c4e6ea896905468ee3a40a868cde19f796e608
+  metadata.gz: da6c1f283a4578ef8e4bc7377fa5da990363db1c3c213783e98aa09f0564f7746999bf76750c4347f3ea10938d3b2414edadfe557c34ad0ab71b61e63e1fe87c
+  data.tar.gz: 6526c843d4e043e4b996b73640323a0dcc0850b37370a6ad23ed50ed78037b0a10d586cd396cabc210d7e24fd7fa6a206372c77023d0de8d9795f4c41b18ec91

data/.rubocop.yml

@@ -0,0 +1,115 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  DisplayCopNames: true
+#
+  StyleGuideBaseURL: https://github.com/fortissimo1997/ruby-style-guide/blob/japanese/README.ja.md
+#
+  Exclude:
+    - "Rakefile"
+    - "*.gemspec"
+    - "vendor/**/*"
+    - "spec/*.rb"
+    - 'bin/console'
+    - 'bin/setup'
+
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  SpaceBeforeBlockParameters: false
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+Metrics/ClassLength:
+  Exclude:
+#    - "test/**/*.rb"
+Metrics/ParameterLists:
+  Max: 7
+Metrics/MethodLength:
+  Max: 30
+
+Naming/FileName:
+  Enabled: false
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - z
+
+Style/AsciiComments:
+  Enabled: false
+Style/HashSyntax:
+  Exclude:
+    - "**/*.rake"
+    - "Rakefile"
+Style/EmptyMethod:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/WordArray:
+  Enabled: false
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+Style/BracesAroundHashParameters:
+  Enabled: false
+Style/PercentQLiterals:
+  Enabled: false
+Style/UnneededPercentQ:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false
+Style/SymbolArray:
+  Enabled: false
+Style/FormatString:
+  Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
+Style/WhileUntilModifier:
+  Enabled: false
+Style/RedundantBegin:
+  Enabled: false
+Style/YodaCondition:
+  EnforcedStyle: forbid_for_equality_operators_only
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+Style/MethodCallWithArgsParentheses:
+  Exclude:
+    - "**/*.rake"
+    - "Rakefile"
+    - "Gemfile"
+  Enabled: true
+  IgnoredMethods:
+    - p
+    - pp
+    - puts
+    - print
+    - printf
+    - raise
+    - require

data/lib/filex.rb

@@ -1,15 +1,30 @@
-require "filex/version"
+# frozen_string_literal: true
 
+#
+# ファイル操作用モジュール
+#
 module Filex
   require "digest"
   require "pp"
   require "erubis"
   require "yaml"
   require "messagex"
+  require "filex/version"
 
+  #
+  # ファイル操作用モジュールのエラークラス
+  #
   class Error < StandardError; end
 
-  class Filex
+  #
+  # ファイル操作用クラス
+  #
+  class Filex # rubocop:disable Metrics/ClassLength
+    #
+    # Filexクラスで利用する終了ステータスの登録
+    #
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @return [void]
     def self.setup(mes)
       mes.add_exitcode("EXIT_CODE_CANNOT_ANALYZE_YAMLFILE")
       mes.add_exitcode("EXIT_CODE_NAME_ERROR_EXCEPTION_IN_ERUBY")
@@ -17,6 +32,11 @@ module Filex
       mes.add_exitcode("EXIT_CODE_FILE_IS_EMPTY")
     end
 
+    #
+    # YAML形式文字列をRubyのオブジェクトに変換
+    # @param str [String] YAML形式の文字列
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @return [Hash] YAMLの変換結果
     def self.load_yaml(str, mes)
       yamlhs = {}
       begin
@@ -30,11 +50,24 @@ module Filex
       yamlhs
     end
 
+    #
+    # YAML形式ファイルをRubyのオブジェクトに変換
+    #
+    # @param yamlfname [String] yamlファイル名
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @return [Hash] YAMLの変換結果
     def self.check_and_load_yamlfile(yamlfname, mes)
       str = Filex.check_and_load_file(yamlfname, mes)
       load_yaml(str, mes)
     end
 
+    #
+    # YAML形式ファイルを存在チェック、（eRubyスクリプトとしての）YAMLファイルをハッシュを用いて置換した後にRubyのオブジェクトに変換
+    #
+    # @param yamlfname [String] yamlファイル名(eRubyスクリプトでもある)
+    # @param objx [Hash] eRubyスクリプト置換用ハッシュ
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @return [Hash] YAMLの変換結果
     def self.check_and_expand_yamlfile(yamlfname, objx, mes)
       lines = Filex.check_and_expand_file_lines(yamlfname, objx, mes)
       str = escape_by_single_quote_with_lines_in_yamlformat(lines, mes).join("\n")
@@ -43,10 +76,23 @@ module Filex
       load_yaml(str, mes)
     end
 
+    #
+    # eRubyスクリプトの存在チェック、ハッシュを用いて置換したものを行の配列として得る
+    #
+    # @param fname [String] eRubyスクリプト名
+    # @param data [Hash] eRubyスクリプト置換用ハッシュ
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @return [Array<String>] eRubyスクリプトの変換結果
     def self.check_and_expand_file_lines(fname, data, mes)
       check_and_expand_file(fname, data, mes).split("\n")
     end
 
+    #
+    # テキストファイルの存在チェック、ファイルの内容を1個の文字列に変換
+    #
+    # @param fname [String] ファイル名
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @return [String] ファイルの内容
     def self.check_and_load_file(fname, mes)
       size = File.size?(fname)
       if size && (size > 0)
@@ -81,6 +127,14 @@ module Filex
       strdata
     end
 
+    #
+    # eRubyスクリプト文字列を、ハッシュを用いて置換した内容を1個の文字列に変換
+    #
+    # @param eruby_str [String] eRubyスクリプト文字列
+    # @param data [Hash] eRubyスクリプト置換用ハッシュ
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @param fnames [Hash] 入力ファイル名群
+    # @return [String] eRubyスクリプトの変換結果
     def self.expand_str(eruby_str, data, mes, fnames={})
       begin
         mes.output_info("eruby_str=|#{eruby_str}|")
@@ -98,139 +152,209 @@ module Filex
       strdata
     end
 
+    #
+    # eRubyスクリプトファイルの存在チェック、ハッシュを用いてを置換後に1個の文字列に変換
+    #
+    # @param fname [String] eRubyスクリプトファイル
+    # @param objx [Hash] eRubyスクリプト置換用ハッシュ
+    # @param mes [Messagex] Messagexクラスのインスタンス
+    # @return [String] eRubyスクリプトファイルの変換結果
     def self.check_and_expand_file(fname, objx, mes)
       strdata = check_and_load_file(fname, mes)
       mes.output_info("fname=#{fname}")
       mes.output_info("strdata=#{strdata}")
       mes.output_info("objx=#{objx}")
-      strdata2 = expand_str(strdata, objx, mes, { fname: fname })
+      strdata2 = expand_str(strdata, objx, mes, fname: fname)
       strdata2
     end
 
+    #
+    # 最初に現れる「:」と空白文字の組み合わせを区切り文字列として、文字列を２つに分割する
+    #
+    # @param str [String] 分割対象文字列
+    # @return [Array<String>] 第0要素　分割文字列の左側部分、第１要素　分割文字列の右側部分
     def self.colon_space(str)
       if (m = /^(\s*([^\s]+):\s)(.*)$/.match(str))
-        key = m[1]
-        value = m[3]
+        left = m[1]
+        right = m[3]
       end
 
-      [key, value]
+      [left, right]
     end
 
+    #
+    # 最初に現れる「:」と空白文字以外の文字の組み合わせを区切り文字列として、文字列を２つに分割する
+    #
+    # @param str [String] 分割対象文字列
+    # @return [Array<String>] 第0要素　分割文字列の左側部分、第１要素　分割文字列の右側部分
     def self.colon_not_space(str)
       if (m = /^(\s*([^\s]+):[^\s])(.*)$/.match(str))
-        key = m[1]
-        value = m[3]
+        left = m[1]
+        right = m[3]
       end
 
-      [key, value]
+      [left, right]
     end
 
+    #
+    # 最初に現れる「:」を区切り文字として、文字列を２つに分割する
+    #
+    # @param str [String] 分割対象文字列
+    # @return [Array<String>] 第0要素　分割文字列の左側部分、第１要素　分割文字列の右側部分
     def self.colon(str)
       if (m = /^(\s*([^\s]+):)(.*)$/.match(str))
-        key = m[1]
-        value = m[3]
+        left = m[1]
+        right = m[3]
       end
 
-      [key, value]
+      [left, right]
     end
 
+    #
+    # 最初に現れる「-」と空白文字の組み合わせを区切り文字列として、文字列を２つに分割する
+    #
+    # @param str [String] 分割対象文字列
+    # @return [Array<String>] 第0要素　分割文字列の左側部分、第１要素　分割文字列の右側部分
     def self.hyphen_space(str)
       if (m = /^(\s*((\-\s+)+))(.+)$/.match(str))
-        key = m[1]
-        value = m[4]
+        left = m[1]
+        right = m[4]
       end
 
-      [key, value]
+      [left, right]
     end
 
+    #
+    # YAML形式の文字列に、シングルクォーテーションでのエスケープが必要かを調べる（第1段階）
+    #
+    # @param line [String] 対象文字列
+    # @param state [Hash] 状態
+    # @return [Array<String>] 第0要素　分割文字列の左側部分、第１要素　分割文字列の右側部分
     def self.escape_single_quote_yaml_first(line, state)
-      k, v = colon_space(line)
-      state[:mes].output_info("1|k=#{k}")
-      k, v = colon(line) unless k
-      state[:mes].output_info("2|k=#{k}")
-
-      if v&.index("-")
-        k, v = hyphen_space(line)
-        state[:mes].output_info("3|k=#{k}")
-        if k
+      # lineに対して": "での分割を試みる
+      left, right = colon_space(line)
+      state[:mes].output_info("1|left=#{left}")
+      left, right = colon(line) unless left
+      state[:mes].output_info("2|left=#{left}")
+
+      if right&.index("-")
+        left, right = hyphen_space(line)
+        state[:mes].output_info("3|left=#{left}")
+        if left
           state[:need_quoto] = true
           state[:mes].output_info("NQ|1|need_quoto=#{state[:need_quoto]}")
         end
       end
 
-      unless k
-        k, v = hyphen_space(line)
+      unless left
+        left, right = hyphen_space(line)
       end
 
-      [k, v]
+      [left, right]
     end
 
-    def self.escape_single_quote_yaml_second(line, state, key, value)
-      state[:mes].output_info("4|k=#{key}|v=#{value}")
+    #
+    # YAML形式の文字列に、シングルクォーテーションでのエスケープが必要かを調べる（第2段階）
+    #
+    # @param line [String] 対象文字列
+    # @param right [String] 対象文字列の分割右側部分
+    # @param state [Hash] 状態
+    # @option state [Messagex] :mes Messagexクラスのインスタンス
+    # @option state [Booleand] :has_quoto true: 対象文字列がエスケープされている false: 対象文字列はエスケープされていない
+    # @return [Array<String>] 第0要素　分割文字列の左側部分、第１要素　分割文字列の右側部分
+    def self.check_colon_in_right(right, state)
+      left3, right3 = colon_not_space(right)
+      state[:mes].output_info("52|left3=#{left3}|right3=#{right3}")
+      state[:need_quoto] = true
+      return [nil, nil] if left3
+
+      left2, right2 = colon(right)
+      state[:mes].output_info("53|left2=#{left2}|right2=#{right2}")
+      state[:need_quoto] = true
+      [left2, right2]
+    end
 
-      return [key, value] if value.nil? || value.strip.empty?
+    #
+    # YAML形式の文字列に、シングルクォーテーションでのエスケープが必要かを調べる（第2段階）
+    #
+    # @param line [String] 対象文字列
+    # @param state [Hash] 状態
+    # @option state [Messagex] :mes Messagexクラスのインスタンス
+    # @option state [Booleand] :has_quoto true: 対象文字列がエスケープされている false: 対象文字列はエスケープされていない
+    # @param left [String] 対象文字列の分割左側部分
+    # @param right [String] 対象文字列の分割右側部分
+    # @return [Array<String>] 第0要素　分割された文字列の左側部分、第１要素　分割された文字列の右側部分
+    def self.escape_single_quote_yaml_second(line, state, left, right)
+      state[:mes].output_info("4|left=#{left}|right=#{right}")
 
-      state[:has_quoto] = true if value.index("'")
+      return [left, right] if right.nil? || right.strip.empty?
 
-      return [key, value] if value.index(":").nil?
+      state[:has_quoto] = true if right.index("'")
 
-      return([key, value]) if /\d:/.match?(value)
+      return [left, right] if right.index(":").nil?
 
-      k2, v2 = colon_space(value)
-      state[:mes].output_info("51|k2=#{k2}|v2=#{v2}")
+      return([left, right]) if /\d:/.match?(right)
 
-      unless k2
-        k3, v3 = colon_not_space(value)
-        state[:mes].output_info("52|k3=#{k3}|v3=#{v3}")
-        state[:need_quoto] = true
+      left2, right2 = colon_space(right)
+      state[:mes].output_info("51|left2=#{left2}|right2=#{right2}")
 
-        unless k3
-          k2, v2 = colon(value)
-          state[:mes].output_info("53|k2=#{k2}|v2=#{v2}")
-          state[:need_quoto] = true
-        end
+      unless left2
+        left2, right2 = check_colon_in_right(right, state)
       end
 
-      if k2
-        key += k2
-        value = v2
-        state[:mes].output_info("6|k=#{key}|v=#{value}")
+      if left2
+        left += left2
+        right = right2
+        state[:mes].output_info("6|left=#{left}|right=#{right}")
       end
-      [key, value]
+      [left, right]
     end
 
-    def self.escape_single_quote_yaml_third(line, state, key, value)
-      return line if value.nil? || value.strip.empty?
-
-      unless state[:need_quoto]
-        if value.index(":") || value.index("*")
-          state[:mes].output_info("1 not need_quoto")
-          unless value.index("-")
-            state[:need_quoto] = true
-            state[:mes].output_info("NQ|2|need_quoto=#{state[:need_quoto]}")
-          end
-          state[:mes].output_info("1A need_quoto=#{state[:need_quoto]}")
-        end
-      end
-
-      if state[:need_quoto] && !state[:has_quoto]
-        state[:mes].output_info("2 need_quoto")
-        key + %q(') + value + %q(')
-      else
-        line
+    #
+    # YAML形式の文字列に、シングルクォーテーションでのエスケープが必要かを調べる（第3段階）
+    #
+    # @param line [String] 対象文字列
+    # @param state [Hash] 状態
+    # @option state [Messagex] :mes Messagexクラスのインスタンス
+    # @option state [Booleand] :has_quoto true: 対象文字列がエスケープされている false: 対象文字列はエスケープされていない
+    # @param left [String] 対象文字列の分割左側部分
+    # @param right [String] 対象文字列の分割右側部分
+    # @return [void]
+    def self.escape_single_quote_yaml_third(line, state, left, right)
+      return if right.nil? || right.strip.empty?
+
+      return if state[:need_quoto]
+
+      return unless right.index(":") && right.index("*")
+
+      state[:mes].output_info("1 not need_quoto")
+      unless right.index("-")
+        state[:need_quoto] = true
+        state[:mes].output_info("NQ|2|need_quoto=#{state[:need_quoto]}")
       end
+      state[:mes].output_info("1A need_quoto=#{state[:need_quoto]}")
     end
 
+    #
+    # YAML形式の文字列の配列に（必要であれば）シングルクォーテーションでのエスケープを追加
+    #
+    # @param lines [Array<String>] 対象行の配列
+    # @param mes [Messagex] :mes Messagexクラスのインスタンス
+    # @return [Array<String>] 必要なエスケープがされた対象文字列
     def self.escape_by_single_quote_with_lines_in_yamlformat(lines, mes)
       state = { mes: mes }
       lines.map do |line|
         state[:need_quoto] = false
         state[:has_quoto] = false
 
-        k, v = escape_single_quote_yaml_first(line, state)
-        k, v = escape_single_quote_yaml_second(line, state, k, v)
-        if k
-          escape_single_quote_yaml_third(line, state, k, v)
+        left, right = escape_single_quote_yaml_first(line, state)
+        left, right = escape_single_quote_yaml_second(line, state, left, right)
+        if left
+          escape_single_quote_yaml_third(line, state, left, right)
+        end
+        if state[:need_quoto] && !state[:has_quoto]
+          state[:mes].output_info("2 need_quoto")
+          left + %q(') + right + %q(')
         else
           line
         end

data/lib/filex/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filex
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - yasuo kominami
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2019-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE