debugtrace 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 573b6a776aab4ba5ffcd8b5f5b5c62c93250c9a637c11ee455325e79013b6243
-  data.tar.gz: 23f331e71a62a005ce75eb2e966fcafda2854d8ff73d42f6e399328df84deac1
+  metadata.gz: ce8fe4113e5e6d49353414a4e204e96fd0bb18f303972a5e4aef48e0e7fa07d5
+  data.tar.gz: 0cdba9d53b9edbed09ef2ed76a76756abdc57fe5fbabd7ab886d06e3ab1d1623
 SHA512:
-  metadata.gz: 60707f1a062650f909b2a6f194a55edc0ad546823ea91f226b90b15dc943cd0157159bcde691ba5bae795fa3ad08698e5a6e6dfe139a6fbdd61087b74a1d06f2
-  data.tar.gz: 474b9c3cdfee32220b5bd182d14446c4762bd0e2d807dba3710ff797c653beb61087cffd2eb380fa3b9e28c8a6e0afcb87af82e28fed6caca78294bbc12f7b38
+  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,9 +3,11 @@
 require 'yaml'
 require_relative 'common'
 
+# Retains the contents defined in debugtrace.yml.
+# @author Masato Kokubo
 class Config
-  attr_reader :config
   attr_reader :config_path
+  attr_reader :config
   attr_reader :logger_name
   attr_reader :log_path
   attr_reader :logging_format
@@ -22,8 +24,8 @@ class Config
   attr_reader :varname_value_separator
   attr_reader :key_value_separator
   attr_reader :print_suffix_format
-  attr_reader :count_format
-  attr_reader :minimum_output_count
+  attr_reader :size_format
+  attr_reader :minimum_output_size
   attr_reader :length_format
   attr_reader :minimum_output_length
   attr_reader :maximum_data_output_width
@@ -33,6 +35,8 @@ class Config
   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)
@@ -58,8 +62,8 @@ class Config
     @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)'
-    @count_format              = get_value 'count_format'             , 'count:%d'
-    @minimum_output_count      = get_value 'minimum_output_count'     , 16
+    @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
@@ -70,14 +74,18 @@ class Config
     @reflection_limit          = get_value 'reflection_limit'         , 4
   end
 
-  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
+  # 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

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,15 +5,16 @@ 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
+  # @return [String] A string representation of this object
   def to_s
     "#{self.class.name}"
   end
@@ -29,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)
@@ -80,14 +81,14 @@ class RubyLogger
   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
     "Ruby #{Logger.name} path: #{@config.log_path}"
   end
@@ -134,7 +135,7 @@ 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
     "#{self.class.name} path: #{@log_path}, append: #{@append}"
   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.3'
+  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
@@ -64,18 +65,18 @@ module DebugTrace
   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.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Masato Kokubo