loggerx 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d670b6073866d77bce705fbfee4766ec35a56efa25915c1640bacc6752ef76
-  data.tar.gz: 1ccd5529fb4a87b383e500cad777d7c58441b803343753ea93c43f34c940e42d
+  metadata.gz: b94fc11a31ed8efbf76e939a7765325fc226339bdea71edb61c026a16f2dad67
+  data.tar.gz: 48b1a9cca11d4610bdfc1146d5a83076827e8be5b045e3d9c7501b39608734e9
 SHA512:
-  metadata.gz: 1727d5e45c7910f3fe631b52329d0fadcb6e9d05eed54ed1731552dcf46c3ba257ade18e53bb51ae9a9bbf5477f69fe16bbff6067e0f495412b1b42c289516d4
-  data.tar.gz: 7fe553f310c18547b0274e6f45f2a06b8bedd69df01c2eb06700c62e7fa2434312b2f5dfee9a2f76df3600670fd1f0956a829aba4905b264d7e31700f5bf5b30
+  metadata.gz: 73b6239ea4cbc60897f3017a7ed10b56d2a1de0abbb9aa5a21ef58d5217a88dda7444253d7c4e6b472f96d6e5b3064e41addb76eeb6f3d3d669623373714cefa
+  data.tar.gz: 73d856baf3ab5a92e6415bac098bba6915aaf6a789ea136c5d4a11e015cb0f5337baf70d3ce231903f11f8b1e8cbd4845c530f989c931d0afa0ea3f887c59775

data/.rubocop.yml

@@ -8,29 +8,80 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 3.1
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
+  DisplayCopNames: true
+  StyleGuideBaseURL: https://github.com/fortissimo1997/ruby-style-guide/blob/japanese/README.ja.md
+  # 結果のsuggest部分を非表示にする
+  SuggestExtensions: false
+  # rubocopの対象外ファイル
+  Exclude:
+    - "Gemfile"
+    - "bin/**/*"
+    - "db/**/*"
+    - "log/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+    - "lib/tasks/auto_annotate_models.rake"
+    - "config/environments/*"
+    - "config/puma.rb"
+    - "root/**/*"
+    - "test_data/**/*"
+    - "test_data_y/**/*"
+    - "test_other/**/*"
+    - "test_output/**/*"
+    - "tmp/**/*"
+    - "pkg/**/*"
+    - "docs/**/*"
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
 
-Layout/LineLength:
-  Max: 120
+Layout:
+  # メソッド名をcamelCase に設定します
+  MethodName:
+    #  EnforcedStyle: camelCase
+    EnforcedStyle: snake_case
+  # 一行に 120 文字まで書いても OK とする
+  LineLength:
+    Max: 120
 
+Style:
+  StringLiterals:
+    Enabled: true
+    EnforcedStyle: double_quotes
+
+  StringLiteralsInInterpolation:
+    Enabled: true
+    EnforcedStyle: double_quotes
 #追加
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-Style/GuardClause:
-  Enabled: false
-Style/IfUnlessModifier: 
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
+  rozenStringLiteralComment:
+    Enabled: false
+  ClassAndModuleChildren:
+    Enabled: false
+  GuardClause:
+    Enabled: false
+  IfUnlessModifier: 
+    Enabled: false
+  # 日本語のコメントを OK とする
+  AsciiComments:
+    Enabled: false
+  BlockComments:
+    Enabled: false
+
+  # class documentation commentのアラートを出さない
+  Documentation:
+    Enabled: false
+  IfWithBooleanLiteralBranches:
+    Enabled: false
+
+Naming:
+  RescuedExceptionsVariableName:
+    PreferredName: exc
+
+Lint:
+  DuplicateRegexpCharacterClassElement:
+    Enabled: false
+
+
+Metrics:
+  ClassLength:
+    # Enabled: false
+    Max: 440 # クラスの最大行数をここで設定
+

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.2
+ruby 3.3.4

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/loggerx/loggerx.rb

@@ -2,15 +2,15 @@
 
 module Loggerx
   class Loggerx
-    require "logger"
-    require "fileutils"
-    require "stringio"
+    require 'logger'
+    require 'fileutils'
+    require 'stringio'
 
     LOG_FILENAME_BASE = "#{Time.now.strftime("%Y%m%d-%H%M%S")}.log".freeze
     @log_file = nil
     @log_stdout = nil
     @stdout_backup = $stdout
-    @stringio = StringIO.new(+"", "w+")
+    @stringio = StringIO.new(+'', 'w+')
 
     attr_reader :error_count
 
@@ -38,14 +38,9 @@ module Loggerx
       fname = nil if fname == false
       fname = prefix + LOG_FILENAME_BASE if fname == :default
       @log_file = setup_logger_file(log_dir, fname) if fname
-
-      obj = proc do |_, _, _, msg|
-        "#{msg}\n"
-      end
       # register_log_format(obj)
-      formatter = obj
       # register_log_level(level_hs[level])
-      level = level_hs[level]
+      level_hs[level]
     end
 
     def formatter
@@ -81,7 +76,6 @@ module Loggerx
 
     def setup_logger_file(log_dir, fname)
       filepath = Pathname.new(log_dir).join(fname)
-      log_file = nil
       begin
         log ||= ActiveSupport::TaggedLogging.new(filepath)
       rescue Errno::EACCES
@@ -116,7 +110,7 @@ module Loggerx
     def to_string(value)
       if value.instance_of?(Array)
         @stdout_backup ||= $stdout
-        @stringio ||= StringIO.new(+"", "w+")
+        @stringio ||= StringIO.new(+'', 'w+')
         $stdout = @stringio
         $stdout = @stdout_backup
         @stringio.rewind
@@ -150,7 +144,6 @@ module Loggerx
 
     def debug(value)
       str = to_string(value)
-      # p str
       @log_file&.debug(str)
       @log_stdout&.debug(str)
       true
@@ -188,39 +181,39 @@ module Loggerx
       end
 
       def hash_to_args(hash)
-        prefix = hash["prefix"]
-        log_dir_pn = Pathname.new(hash["log_dir"])
+        prefix = hash['prefix']
+        log_dir_pn = Pathname.new(hash['log_dir'])
 
-        stdout_flag_str = hash["stdout_flag"]
+        stdout_flag_str = hash['stdout_flag']
         stdout_flag = if stdout_flag_str.instance_of?(String)
-            case stdout_flag_str
-            when "true"
-              true
-            else
-              false
-            end
-          else
-            stdout_flag_str
-          end
-
-        fname_str = hash["fname"]
+                        case stdout_flag_str
+                        when 'true'
+                          true
+                        else
+                          false
+                        end
+                      else
+                        stdout_flag_str
+                      end
+
+        fname_str = hash['fname']
         fname = case fname_str
-          when "default"
-            fname_str.to_sym
-          when "false"
-            false
-          else
-            fname_str
-          end
+                when 'default'
+                  fname_str.to_sym
+                when 'false'
+                  false
+                else
+                  fname_str
+                end
 
-        level = hash["level"].to_sym
+        level = hash['level'].to_sym
 
         [prefix, fname, log_dir_pn, stdout_flag, level]
       end
 
       def create_by_hash(hash)
         prefix, fname, log_dir_pn, stdout_flag, level = hash_to_args(hash)
-        new(prefix, fname, log_dir_pn, stdout_flag, level)
+        Loggerx.new(prefix, fname, log_dir_pn, stdout_flag, level)
       end
 
       def init_by_hash(hash)

data/lib/loggerx/loggerxcm.rb

@@ -1,19 +1,35 @@
 # frozen_string_literal: true
 
-require "pathname"
+require 'pathname'
 
 module Loggerx
+  # The `Loggerx::Loggerxcm0` class is designed to provide logging functionality specific to the Mkspec framework.
+  # It encapsulates the logging mechanism, offering a unified interface for recording various levels of messages,
+  # such as debug, info, warning, and error. This class aims to facilitate debugging and tracking of the application's
+  # flow by providing detailed and structured log messages. It can be configured to log messages to different outputs,
+  # including standard output, files, or external logging services, depending on the needs of the framework.
+  #
+  # @example Logging a debug message
+  #   Loggerx::Loggerxcm0.debug("This is a debug message")
+  #
+  # @example Logging an error message
+  #   Loggerx::Loggerxcm0.error("This is an error message")
+  #
+  # This class may also support log rotation, filtering of log messages based on severity, and formatting of log messages
+  # to include timestamps, source identifiers, and other relevant information.
   class Loggerxcm0
-    require "logger"
-    require "fileutils"
-    require "stringio"
+    # Implementation omitted
+    require 'logger'
+    require 'fileutils'
+    require 'stringio'
 
-    LOG_FILENAME_BASE = "#{Time.now.strftime("%Y%m%d-%H%M%S")}.log".freeze
+    LOG_FILENAME_BASE = "#{Time.now.strftime('%Y%m%d-%H%M%S')}.log".freeze
     @log_file = nil
     @log_stdout = nil
     @stdout_backup = $stdout
-    @stringio = StringIO.new(+"", "w+")
-    # @limit_of_num_of_files ||= 3
+    @stringio = StringIO.new(+"", 'w+')
+
+    @valid = false
 
     class << self
       def ensure_quantum_log_files(log_dir_pn, limit_of_num_of_files, prefix)
@@ -32,7 +48,7 @@ module Loggerx
           warn: Logger::WARN,
           error: Logger::ERROR,
           fatal: Logger::FATAL,
-          unknown: Logger::UNKNOWN,
+          unknown: Logger::UNKNOWN
         }
         @log_dir_pn = Pathname.new(log_dir)
 
@@ -51,10 +67,15 @@ module Loggerx
         end
         register_log_format(obj)
         register_log_level(level_hs[level])
-      end
 
-      def valid?
-        !@log_file.nil?
+        @valid = true
+
+        Loggerxcm.fatal("fatal")
+        Loggerxcm.debug("debug")
+        Loggerxcm.info("info")
+        Loggerxcm.warn("warn")
+        Loggerxcm.error("error")
+        #        Loggerxcm.unknown("unknown")
       end
 
       def setup_logger_stdout(log_stdout)
@@ -62,7 +83,8 @@ module Loggerx
 
         begin
           log_stdout = Logger.new($stdout)
-        rescue StandardError
+        rescue StandardError => exc
+          pust exc.message
           @error_count += 1
         end
         log_stdout
@@ -72,10 +94,11 @@ module Loggerx
         filepath = Pathname.new(log_dir).join(fname)
         if log_file.nil?
           begin
-            log_file = Logger.new(filepath)
+            log_file = Logger.new(filepath.to_s)
           rescue Errno::EACCES
             @error_count += 1
-          rescue StandardError
+          rescue StandardError => exc
+            puts exc
             @error_count += 1
           end
         end
@@ -88,6 +111,7 @@ module Loggerx
       end
 
       def register_log_level(level)
+        puts "============ Loggerxcm.register_log_level level=#{level} ==========="
         @log_file&.level = level
         @log_stdout&.level = level
         #
@@ -98,12 +122,12 @@ module Loggerx
       def to_string(value)
         if value.instance_of?(Array)
           @stdout_backup ||= $stdout
-          @stringio ||= StringIO.new(+"", "w+")
+          @stringio ||= StringIO.new(+"", 'w+')
           $stdout = @stringio
-          $stdout = @stdout_backup
           @stringio.rewind
           str = @stringio.read
           @stringio.truncate(0)
+          $stdout = @stdout_backup
           str
         else
           value
@@ -111,17 +135,27 @@ module Loggerx
       end
 
       def show(value)
-        puts(value)
-        str = error_sub(value)
-        # puts(str) unless @log_stdout
-        puts(str) # unless @log_stdout
+        if @valid
+          if value.instance_of?(Array)
+            value.map do |v|
+              str = v.to_s
+              Util.puts_valid_str(str)
+            end
+          else
+            Util.puts_valid_str(str)
+          end
+          str = error_sub(value)
+          Util.puts_valid_str(str)
+        end
         true
       end
 
       def error_sub(value)
         str = to_string(value)
-        @log_file&.error(str)
-        @log_stdout&.error(str)
+        if @valid
+          @log_file&.error(str)
+          @log_stdout&.error(str)
+        end
         str
       end
 
@@ -132,34 +166,49 @@ module Loggerx
 
       def debug(value)
         str = to_string(value)
-        @log_file&.debug(str)
-        @log_stdout&.debug(str)
+        if @valid
+          @log_file&.debug(str)
+          @log_stdout&.debug(str)
+        end
+
         true
       end
 
       def info(value)
         str = to_string(value)
-        @log_file&.info(str)
-        @log_stdout&.info(str)
+        if @valid
+          @log_file&.info(str)
+          @log_stdout&.info(str)
+        end
         true
       end
 
       def warn(value)
         str = to_string(value)
-        @log_file&.warn(str)
-        @log_stdout&.warn(str)
+        if @valid
+          @log_file&.warn(str)
+          @log_stdout&.warn(str)
+        end
         true
       end
 
       def fatal(value)
         str = to_string(value)
-        @log_file&.fatal(str)
-        @log_stdout&.fatal(str)
+        if @valid
+          @log_file&.fatal(str)
+          @log_stdout&.fatal(str)
+        end
         true
       end
 
       def close
+        retrun unless @valid
+
         @log_file&.close
+        @log_file = nil
+        @log_stdout = nil
+
+        @valid = false
         # @log_stdout&.close
       end
     end

data/lib/loggerx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Loggerx
-  VERSION = "0.3.0"
+  VERSION = '0.3.2'
 end

data/lib/loggerx.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "loggerx/version"
-require_relative "loggerx/loggerx"
-require_relative "loggerx/loggerxcm"
+require_relative 'loggerx/version'
+require_relative 'loggerx/loggerx'
+require_relative 'loggerx/loggerxcm'
 
 module Loggerx
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loggerx
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - ykominami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-19 00:00:00.000000000 Z
+date: 2024-12-14 00:00:00.000000000 Z
 dependencies: []
 description: Utility class for Logging.
 email:
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Utility class for Logging.