debugtrace 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5937a3c3f6b9d19ab3bb040ef763ada32e262c5046532331a7082f3edc3128cb
-  data.tar.gz: 31b5c3027993f50d06409ec9c54d55adff5e68563a8f02b66ae6e618027ec550
+  metadata.gz: ce8fe4113e5e6d49353414a4e204e96fd0bb18f303972a5e4aef48e0e7fa07d5
+  data.tar.gz: 0cdba9d53b9edbed09ef2ed76a76756abdc57fe5fbabd7ab886d06e3ab1d1623
 SHA512:
-  metadata.gz: 33e2b5d74dcfcabfc0868652118694478e47ad5c6066e70c75090b50db7dc61008cfdfe5d4a9b438d7d7a2df91be97110d3766bfbbbd43536dfbaeacf0414c22
-  data.tar.gz: bd78a8be204cd636d3104d06e3ff777ade2458f0492c5e50fd6f115f7108d290d4348cf02454721ca2680ef6a872455122b50e95fa836e8f9ed7efb1a17e7e6b
+  metadata.gz: cbdba0458650b624c0a7e6872c294f578e855fd3cb5d6e050ec4801a356a94fd29b3c3f5a00e01ef155860a8cde98e7b093c2f5f1b1cf5f0925c1904536e17d9
+  data.tar.gz: 34acc1fc0519aea58496c807f7716944696f596f2810d6403cee8c9e7b1184f29579420ab58cbe3a310d895e43ee9b351f90112c5d9154f71dfb5983075b58a1

data/lib/debugtrace/common.rb

@@ -1,22 +1,30 @@
 # common.rb
 # (C) 2025 Masato Kokubo
+
+#　Defines commonly used functions.
+# @author Masato Kokubo
 module Common
+  # Check the value types.
+  # @param value_name [String] the value name
+  # @param value [String] the value
+  # @param type [Class] the type
+  # @raise if the value is not an instance of the type or the subclass of the type
   def self.check_type(value_name, value, type)
-    if !(value_name.is_a? String); raise "Argument value_name (=#{value_name}) must be a String"; end
-    if !(type.is_a? Class); raise "Argument type (=#{type}) must be a Class"; end
+    raise "Argument value_name (=#{value_name}) must be a String" unless value_name.is_a?(String)
+    raise "Argument type (=#{type}) must be a Class" unless type.is_a?(Class)
 
     error = false
     if type == FalseClass || type == TrueClass
       # false or true
       if value.class != FalseClass && value.class != TrueClass
-        check_error = true
+        error = true
       end
     else
-        error = value.class != type
+      error = !value.is_a?(type)
     end
 
     if error
-      value_string = value.class == String ? "\"#{value}\"" : "#{value}"
+      value_string = value.instance_of?(String) ? "\"#{value}\"" : "#{value}"
       top_type_name = type.name.slice(0).upcase
       a = top_type_name == 'A' || top_type_name == 'I' || top_type_name == 'U' ||
         top_type_name == 'E' || top_type_name == 'O' ? 'an' : 'a'

data/lib/debugtrace/config.rb

@@ -3,7 +3,40 @@
 require 'yaml'
 require_relative 'common'
 
+# Retains the contents defined in debugtrace.yml.
+# @author Masato Kokubo
 class Config
+  attr_reader :config_path
+  attr_reader :config
+  attr_reader :logger_name
+  attr_reader :log_path
+  attr_reader :logging_format
+  attr_reader :logging_datetime_format
+  attr_reader :enter_format
+  attr_reader :leave_format
+  attr_reader :thread_boundary_format
+  attr_reader :maximum_indents
+  attr_reader :indent_string
+  attr_reader :data_indent_string
+  attr_reader :limit_string
+  attr_reader :non_output_string
+  attr_reader :cyclic_reference_string
+  attr_reader :varname_value_separator
+  attr_reader :key_value_separator
+  attr_reader :print_suffix_format
+  attr_reader :size_format
+  attr_reader :minimum_output_size
+  attr_reader :length_format
+  attr_reader :minimum_output_length
+  attr_reader :maximum_data_output_width
+  attr_reader :bytes_count_in_line
+  attr_reader :collection_limit
+  attr_reader :bytes_limit
+  attr_reader :string_limit
+  attr_reader :reflection_limit
+
+  # Initializes with a yml file in the config_path.
+  # @param config_path [String] path of the yml file
   def initialize(config_path)
     @config_path = Common.check_type('config_path', config_path, String)
     if File.exist?(@config_path)
@@ -12,52 +45,48 @@ class Config
       @config_path = '<No config file>'
       @config = nil
     end
-    @logger_name               = _get_config_value 'logger'                    , 'stderr'
-    @logging_destination       = _get_config_value 'logging_destination'       , 'STDERR'
-    @logging_format            = _get_config_value 'logging_format'            , "%2$s %1$s %4$s\n"
-    @logging_datetime_format   = _get_config_value 'logging_datetime_format'   , '%Y-%m-%d %H:%M:%S.%L%:z'
-    @enabled                   = _get_config_value 'enabled'                   , true
-    @enter_format              = _get_config_value 'enter_format'              , 'Enter %1$s (%2$s:%3$d) <- %4$s (%5$s:%6$d)'
-    @leave_format              = _get_config_value 'leave_format'              , 'Leave %1$s (%2$s:%3$d) duration: %4$.3f ms'
-    @thread_boundary_format    = _get_config_value 'thread_boundary_format'    , '______________________________ %1$s #%2$s ______________________________'
-    @maximum_indents           = _get_config_value 'maximum_indents'           , 32
-    @indent_string             = _get_config_value 'indent_string'             , '| '
-    @data_indent_string        = _get_config_value 'data_indent_string'        , '  '
-    @limit_string              = _get_config_value 'limit_string'              , '...'
-    @non_output_string         = _get_config_value 'non_output_string'         , '...'
-    @cyclic_reference_string   = _get_config_value 'cyclic_reference_string'   , '*** Cyclic Reference ***'
-    @varname_value_separator   = _get_config_value 'varname_value_separator'   , ' = '
-    @key_value_separator       = _get_config_value 'key_value_separator'       , ': '
-    @print_suffix_format       = _get_config_value 'print_suffix_format'       , ' (%2$s:%3$d)'
-    @count_format              = _get_config_value 'count_format'              , 'count:%d'
-    @minimum_output_count      = _get_config_value 'minimum_output_count'      , 16
-    @length_format             = _get_config_value 'length_format'             , 'length:%d'
-    @minimum_output_length     = _get_config_value 'minimum_output_length'     , 16
-    @maximum_data_output_width = _get_config_value 'maximum_data_output_width' , 70
-    @bytes_count_in_line       = _get_config_value 'bytes_count_in_line'       , 16
-    @collection_limit          = _get_config_value 'collection_limit'          , 128
-    @bytes_limit               = _get_config_value 'bytes_limit'               , 256
-    @string_limit              = _get_config_value 'string_limit'              , 256
-    @reflection_limit          = _get_config_value 'reflection_limit'          , 4
+    @logger_name               = get_value 'logger'                   , 'stderr'
+    @log_path                  = get_value 'log_path'                 , 'debugtrace.log'
+    @logging_format            = get_value 'logging_format'           , "%2$s %1$s %4$s\n"
+    @logging_datetime_format   = get_value 'logging_datetime_format'  , '%Y-%m-%d %H:%M:%S.%L%:z'
+    @enabled                   = get_value 'enabled'                  , true
+    @enter_format              = get_value 'enter_format'             , 'Enter %1$s (%2$s:%3$d) <- %4$s (%5$s:%6$d)'
+    @leave_format              = get_value 'leave_format'             , 'Leave %1$s (%2$s:%3$d) duration: %4$.3f ms'
+    @thread_boundary_format    = get_value 'thread_boundary_format'   , '______________________________ %1$s #%2$s ______________________________'
+    @maximum_indents           = get_value 'maximum_indents'          , 32
+    @indent_string             = get_value 'indent_string'            , '| '
+    @data_indent_string        = get_value 'data_indent_string'       , '  '
+    @limit_string              = get_value 'limit_string'             , '...'
+    @non_output_string         = get_value 'non_output_string'        , '...'
+    @cyclic_reference_string   = get_value 'cyclic_reference_string'  , '*** Cyclic Reference ***'
+    @varname_value_separator   = get_value 'varname_value_separator'  , ' = '
+    @key_value_separator       = get_value 'key_value_separator'      , ': '
+    @print_suffix_format       = get_value 'print_suffix_format'      , ' (%2$s:%3$d)'
+    @size_format               = get_value 'size_format'              , 'size:%d'
+    @minimum_output_size       = get_value 'minimum_output_size'      , 16
+    @length_format             = get_value 'length_format'            , 'length:%d'
+    @minimum_output_length     = get_value 'minimum_output_length'    , 16
+    @maximum_data_output_width = get_value 'maximum_data_output_width', 70
+    @bytes_count_in_line       = get_value 'bytes_count_in_line'      , 16
+    @collection_limit          = get_value 'collection_limit'         , 128
+    @bytes_limit               = get_value 'bytes_limit'              , 256
+    @string_limit              = get_value 'string_limit'             , 256
+    @reflection_limit          = get_value 'reflection_limit'         , 4
   end
 
-  attr_reader :config_path, :logger_name, :logging_destination, :logging_format, :logging_datetime_format,
-              :enter_format, :leave_format, :thread_boundary_format, :maximum_indents,
-              :indent_string, :data_indent_string, :limit_string, :non_output_string,
-              :cyclic_reference_string, :varname_value_separator, :key_value_separator,
-              :print_suffix_format, :count_format, :minimum_output_count, :length_format,
-              :minimum_output_length, :maximum_data_output_width, :bytes_count_in_line,
-              :collection_limit, :bytes_limit, :string_limit, :reflection_limit
-
-  def enabled? = @enabled
+  # Returns true if logging is enabled, false otherwise.
+  # @return true if logging is enabled, false otherwise
+  def enabled?
+    @enabled
+  end
 
   private
 
-  # Gets the value related the key from debugtrace.ini file.
-  # @param key (String): The key
-  # @param defalut_value (Object): Value to return when the value related the key is undefined
-  # @return  Object: Value related the key
-  def _get_config_value(key, defalut_value)
+  # Gets the value related the key from debugtrace.yml file.
+  # @param key [String] the key
+  # @param defalut_value [Object] value to return if the value related the key is undefined
+  # @return [Object] value related the key
+  def get_value(key, defalut_value)
     Common.check_type('key', key, String)
     value = defalut_value
     unless @config.nil?

data/lib/debugtrace/log_buffer.rb

@@ -3,6 +3,7 @@
 require_relative 'common'
 
 # Buffers logs.
+# @author Masato Kokubo
 class LogBuffer
   class LevelAndLog
     # Initializes this object.
@@ -49,7 +50,7 @@ class LogBuffer
   end
 
   # Appends a string representation of the value.
-  # @param value (Object): The value to append
+  # @param value [Object] The value to append
   # @param nest_level (int, optional): The nest level of the value. Defaults to 0
   # @param no_break (bool, optional): If true, does not break even if the maximum width is exceeded.
   #         Defaults to false
@@ -68,7 +69,7 @@ class LogBuffer
 
   # Appends a string representation of the value.
   # Does not break even if the maximum width is exceeded.
-  # @param value (Object): The value to append
+  # @param value [Object] The value to append
   # @return LogBuffer: This object
   def no_break_append(value)
     append(value, 0, true)
@@ -76,7 +77,7 @@ class LogBuffer
 
   # Appends lines of another LogBuffer.
   # @param
-  # @param separator (String): The separator string to append if not ''
+  # @param separator [String] The separator string to append if not ''
   # @param buff (LogBuffer): Another LogBuffer
   # @returns LogBuffer: This object
   def append_buffer(separator, buff)

data/lib/debugtrace/loggers.rb

@@ -5,12 +5,19 @@ require_relative 'common'
 require_relative 'config'
 
 # Abstract base class for logger classes.
+# @author Masato Kokubo
 class LoggerBase
   # Outputs the message.
-  # @param message (String): The message to output
+  # @param message [String] The message to output
   def print(message)
     raise 'LoggerBase.print is an abstract method.'
   end
+
+  # Returns a string representation of this object.
+  # @return [String] A string representation of this object
+  def to_s
+    "#{self.class.name}"
+  end
 end
 
 # Abstract base class for StdOut and StdErr classes.
@@ -23,7 +30,7 @@ class StdLogger < LoggerBase
   end
 
   # Outputs the message.
-  # @param message (String): The message to output
+  # @param message [String] The message to output
   def print(message)
     Common::check_type("message", message, String)
     datetime_str = Time.now().strftime(@config.logging_datetime_format)
@@ -38,12 +45,6 @@ class StdOutLogger < StdLogger
   def initialize(config)
     super(config, $stdout)
   end
-
-  # Returns a string representation of this object.
-  # @return String: A string representation of this object
-  def to_s
-    '$stdout logger'
-  end
 end
 
 # A logger class that outputs to $stderr.
@@ -52,16 +53,10 @@ class StdErrLogger < StdLogger
   def initialize(config)
     super(config, $stderr)
   end
-
-  # Returns a string representation of this object.
-  # @return String: A string representation of this object
-  def to_s
-    '$stderr logger'
-  end
 end
 
 # A logger class that outputs using the logging library.
-class LoggerLogger
+class RubyLogger
   private
 
   class Formatter
@@ -80,43 +75,59 @@ class LoggerLogger
   def initialize(config)
     @config = Common::check_type("config", config, Config)
     @logger = Logger.new(
-        @config.logging_destination,
+        @config.log_path,
         formatter: Formatter.new(@config),
         datetime_format: @config.logging_datetime_format)
   end
 
   # Outputs the message.
-  # @param message (String): The message to output
+  # @param message [String] The message to output
   def print(message)
     Common::check_type("message", message, String)
     @logger.log(Logger::Severity::DEBUG, message, 'DebugTrace-rb')
   end
 
   # Returns a string representation of this object.
-  # @return String: A string representation of this object
+  # @return [String] A string representation of this object
   def to_s
-    'logging.Logger logger'
+    "Ruby #{Logger.name} path: #{@config.log_path}"
   end
 end
 
 # A logger class that outputs the file.
 class FileLogger < LoggerBase
-  def initialize(config, log_path)
+  @@log_path_default = 'debugtrace.log'
+
+  def initialize(config)
+    @log_path = @@log_path_default
     @config = Common::check_type("config", config, Config)
-    Common::check_type("log_path", log_path, String)
-    dir_path = File.dirname(log_path)
-    if Dir.exist?(dir_path)
-      @log_path = log_path
-    else
-      $stderr.puts "DebugTrace-rb: FileLogger: The directory '#{dir_path}' cannot be found."
-      @log_path = ''
+    Common::check_type("log_path", config.log_path, String)
+    @log_path = config.log_path
+    @append = false
+
+    if @log_path.start_with?('+')
+      @log_path = @log_path[1..-1]
+      @append = true
+    end
+
+    dir_path = File.dirname(@log_path)
+
+    if !Dir.exist?(dir_path)
+      @log_path = @@log_path_default
+      @append = true
+      print("DebugTrace-rb: FileLogger: The directory '#{dir_path}' cannot be found.\n")
+    end
+
+    if !@append
+      File.open(@log_path, 'w') { |file|
+      }
     end
   end
   
   def print(message)
-    Common::check_type("message", message, String)
-    if @log_path != ''
-      File.open(@log_path, 'a') {|file|
+  # Common::check_type("message", message, String)
+    if File.exist?(@log_path)
+      File.open(@log_path, 'a') { |file|
         datetime_str = Time.now().strftime(@config.logging_datetime_format)
         file.puts "#{datetime_str} #{message}"
       }
@@ -124,8 +135,8 @@ class FileLogger < LoggerBase
   end
 
   # Returns a string representation of this object.
-  # @return String: A string representation of this object
+  # @return [String] A string representation of this object
   def to_s
-    "File logger: '#{@log_path}"
+    "#{self.class.name} path: #{@log_path}, append: #{@append}"
   end
 end

data/lib/debugtrace/state.rb

@@ -3,6 +3,7 @@
 require_relative 'common'
 
 # Have the trace state for a thread
+# @author Masato Kokubo
 class State
   def initialize(thread_id)
     @thread_id = Common::check_type('thread_id', thread_id, Integer)

data/lib/debugtrace/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module DebugTrace
-  VERSION = '0.2.2'
+  VERSION = '0.2.4'
 end

data/lib/debugtrace.rb

@@ -10,6 +10,7 @@ require_relative 'debugtrace/log_buffer'
 require_relative 'debugtrace/loggers'
 require_relative 'debugtrace/state'
 
+# @author Masato Kokubo
 module DebugTrace
   # Configuration values
   @@config = nil
@@ -47,35 +48,35 @@ module DebugTrace
       @@logger = StdOutLogger.new(@@config)
     when 'stderr'
       @@logger = StdErrLogger.new(@@config)
-    when 'logger'
-      @@logger = LoggerLogger.new(@@config)
-    when /^file:/
+    when 'rubylogger'
+      @@logger = RubyLogger.new(@@config)
+    when 'file'
       @@logger = FileLogger.new(@@config)
     else
-      Pr._print("debugtrace: (#{@@config.config_path}) logger = #{@@config.logger_name} is unknown", STDERR)
+      @@logger = StdErrLogger.new(@@config)
+      @@logger.print("DebugTrace-rb: logger = #{@@config.logger_name} is unknown. (#{@@config.config_path}) \n")
     end
 
     return unless @@config.enabled?
 
-    ruby_version = RUBY_VERSION
-    @@logger.print("DebugTrace-rb #{DebugTrace::VERSION} on Ruby #{ruby_version}")
-    @@logger.print("  config file path: #{@@config.config_path}")
+    @@logger.print("DebugTrace-rb #{DebugTrace::VERSION} on Ruby #{RUBY_VERSION}")
+    @@logger.print("  config file: #{@@config.config_path}")
     @@logger.print("  logger: #{@@logger}")
   end
 
   class PrintOptions
-    attr_reader :minimum_output_count, :minimum_output_length,
+    attr_reader :minimum_output_size, :minimum_output_length,
                 :collection_limit, :bytes_limit, :string_limit, :reflection_limit
 
     def initialize(
-      minimum_output_count,
+      minimum_output_size,
       minimum_output_length,
       collection_limit,
       bytes_limit,
       string_limit,
       reflection_limit
     )
-      @minimum_output_count = minimum_output_count == -1 ? DebugTrace.config.minimum_output_count : minimum_output_count
+      @minimum_output_size = minimum_output_size == -1 ? DebugTrace.config.minimum_output_size : minimum_output_size
       @minimum_output_length = minimum_output_length == -1 ? DebugTrace.config.minimum_output_length : minimum_output_length
       @collection_limit = collection_limit == -1 ? DebugTrace.config.collection_limit : collection_limit
       @bytes_limit = bytes_limit == -1 ? DebugTrace.config.bytes_limit : bytes_limit
@@ -117,6 +118,12 @@ module DebugTrace
       buff.no_break_append(separator).append('nil')
     when FalseClass, TrueClass, Integer, Float
       buff.no_break_append(separator).append(value.to_s)
+    when Symbol
+      buff.no_break_append(separator).append(':').no_break_append(value.name)
+    when Class
+      buff.no_break_append(separator).append(value.name).no_break_append(' class')
+    when Module
+      buff.no_break_append(separator).append(value.name).no_break_append(' module')
     when String
       value_buff = to_string_str(value, print_options)
       buff.append_buffer(separator, value_buff)
@@ -230,7 +237,7 @@ module DebugTrace
 
     if bytes_length >= @@config.minimum_output_length
       buff.no_break_append(' ')
-      buff.no_break_append(format(@@config.length_format, bytes_length))
+      buff.no_break_append(format(@@config.size_format, bytes_length))
     end
 
     buff.no_break_append(') [')
@@ -414,9 +421,9 @@ module DebugTrace
     type_name = value.class.to_s
     type_name = '' if %w[Array Hash Set].include?(type_name)
 
-    if count >= @@config.minimum_output_count
+    if count >= @@config.minimum_output_size
       type_name += ' ' unless type_name.empty?
-      type_name += @@config.count_format % count
+      type_name += @@config.size_format % count
     end
 
     type_name
@@ -453,7 +460,7 @@ module DebugTrace
   @@DO_NOT_OUTPUT = 'Do not output'
 
   def self.print(name, value = @@DO_NOT_OUTPUT,
-      minimum_output_count: -1, minimum_output_length: -1,
+      minimum_output_size: -1, minimum_output_length: -1,
       collection_limit: -1, bytes_limit: -1,
       string_limit: -1, reflection_limit: -1)
     @@thread_mutex.synchronize do
@@ -472,7 +479,7 @@ module DebugTrace
       else
         # with value
         print_options = PrintOptions.new(
-          minimum_output_count, minimum_output_length,
+          minimum_output_size, minimum_output_length,
           collection_limit, bytes_limit,
           string_limit, reflection_limit
         )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debugtrace
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Masato Kokubo