debugtrace 0.3.1 → 1.0.1

data/lib/debugtrace/config.rb

@@ -10,8 +10,8 @@ class Config
   attr_reader :config
   attr_reader :logger_name
   attr_reader :log_path
-  attr_reader :logging_format
-  attr_reader :logging_datetime_format
+  attr_reader :rubylogger_format
+  attr_reader :log_datetime_format
   attr_reader :enter_format
   attr_reader :leave_format
   attr_reader :thread_boundary_format
@@ -19,8 +19,7 @@ class Config
   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 :circular_reference_string
   attr_reader :varname_value_separator
   attr_reader :key_value_separator
   attr_reader :print_suffix_format
@@ -28,51 +27,50 @@ class Config
   attr_reader :minimum_output_size
   attr_reader :length_format
   attr_reader :minimum_output_length
-  attr_reader :maximum_data_output_width
+  attr_reader :data_output_width
   attr_reader :bytes_count_in_line
   attr_reader :collection_limit
-  attr_reader :bytes_limit
   attr_reader :string_limit
+  attr_reader :bytes_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)
+    @config_path = config_path
     if File.exist?(@config_path)
       @config = YAML.load_file(@config_path)
     else
       @config_path = '<No config file>'
       @config = nil
     end
-    @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'      , 256
-    @length_format             = get_value 'length_format'            , '(length:%d)'
-    @minimum_output_length     = get_value 'minimum_output_length'    , 256
-    @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
+    @logger_name               = get_value 'logger'                    , 'stderr'
+    @log_path                  = get_value 'log_path'                  , 'debugtrace.log'
+    @rubylogger_format         = get_value 'rubylogger_format'         , "%2$s %1$s %4$s\n"
+    @log_datetime_format       = get_value 'log_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$d ______________________________'
+    @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'              , '...'
+    @circular_reference_string = get_value 'circular_reference_string' , '*** Circular 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'       , 256
+    @length_format             = get_value 'length_format'             , '(length:%d)'
+    @minimum_output_length     = get_value 'minimum_output_length'     , 256
+    @data_output_width         = get_value 'data_output_width'         , 70
+    @bytes_count_in_line       = get_value 'bytes_count_in_line'       , 16
+    @collection_limit          = get_value 'collection_limit'          , 128
+    @string_limit              = get_value 'string_limit'              , 256
+    @bytes_limit               = get_value 'bytes_limit'               , 256
+    @reflection_limit          = get_value 'reflection_limit'          , 4
   end
 
   # Returns true if logging is enabled, false otherwise.

data/lib/debugtrace/log_buffer.rb

@@ -27,8 +27,8 @@ class LogBuffer
   end
 
   # Initializes this object.
-  def initialize(maximum_data_output_width)
-    @maximum_data_output_width = Common.check_type('maximum_data_output_width', maximum_data_output_width, Integer)
+  def initialize(data_output_width)
+    @data_output_width = Common.check_type('data_output_width', data_output_width, Integer)
     @nest_level = 0
     @append_nest_level = 0
 
@@ -68,7 +68,7 @@ class LogBuffer
     Common.check_type('no_break', no_break, TrueClass)
     unless value.nil?
       string = value.to_s
-      line_feed if !no_break && length > 0 && length + string.length > @maximum_data_output_width
+      line_feed if !no_break && length > 0 && length + string.length > @data_output_width
       @append_nest_level = nest_level
       @last_line += string
     end

data/lib/debugtrace/loggers.rb

@@ -11,7 +11,7 @@ class LoggerBase
   # @param message [String] The message to output
   # @raise [Exception] always
   def print(message)
-    raise Exception.new('LoggerBase.print is an abstract method.')
+    raise Exception, 'LoggerBase.print is an abstract method.'
   end
 
   # Returns a string representation of this object.
@@ -35,7 +35,7 @@ class StdLogger < LoggerBase
   # @return [String] the message
   def print(message)
     Common::check_type("message", message, String)
-    datetime_str = Time.now().strftime(@config.logging_datetime_format)
+    datetime_str = Time.now().strftime(@config.log_datetime_format)
     @output.puts "#{datetime_str} #{message}"
   end
 
@@ -60,7 +60,7 @@ class StdErrLogger < StdLogger
 end
 
 # A logger class that outputs using Ruby Logger.
-class RubyLogger
+class RubyLogger < LoggerBase
   private
 
   class Formatter
@@ -71,8 +71,8 @@ class RubyLogger
     end
 
     def call(severity, datetime, progname, msg)
-      datetime_str = datetime.strftime(@config.logging_datetime_format)
-      format(@config.logging_format, severity, datetime_str, progname, msg)
+      datetime_str = datetime.strftime(@config.log_datetime_format)
+      format(@config.rubylogger_format, severity, datetime_str, progname, msg)
     end
   end
 
@@ -86,7 +86,7 @@ class RubyLogger
     @logger = Logger.new(
         @config.log_path,
         formatter: Formatter.new(@config),
-        datetime_format: @config.logging_datetime_format)
+        datetime_format: @config.log_datetime_format)
   end
 
   # Outputs the message.
@@ -94,7 +94,7 @@ class RubyLogger
   # @param message [String] The message to output
   def print(message)
     Common::check_type("message", message, String)
-    @logger.log(Logger::Severity::DEBUG, message, 'DebugTrace-rb')
+    @logger.log(Logger::Severity::DEBUG, message, 'DebugTrace')
     return message
   end
 
@@ -146,7 +146,7 @@ class FileLogger < LoggerBase
   def print(message)
     if File.exist?(@log_path)
       File.open(@log_path, 'a') { |file|
-        datetime_str = Time.now().strftime(@config.logging_datetime_format)
+        datetime_str = Time.now().strftime(@config.log_datetime_format)
         file.puts "#{datetime_str} #{message}"
       }
     end

data/lib/debugtrace/version.rb

@@ -2,5 +2,5 @@
 # (C) 2025 Masato Kokubo
 
 module DebugTrace
-  VERSION = '0.3.1'
+  VERSION = '1.0.1'
 end

data/lib/debugtrace.rb

@@ -44,13 +44,21 @@ module DebugTrace
   # The logger used by DebugTrace-py
   @@logger = nil
 
+  # The before thread id
+  @@before_thread_id = nil
+
+  @@DO_NOT_OUTPUT = 'Do not output'
+
   # Initialize this class
-  #
-  # @option [String] config_path the path to the configuration file. ./debugtrace.yml if not specified.
-  def self.initialize(config_path = './debugtrace.yml')
+  def self.initialize()
+    config_path = ENV['DEBUGTRACE_CONFIG']
+    if config_path == nil || config_path.empty?
+      config_path = './debugtrace.yml'
+    end
+
     @@config = Config.new(config_path)
 
-    @@last_log_buff = LogBuffer.new(@@config.maximum_data_output_width)
+    @@last_log_buff = LogBuffer.new(@@config.data_output_width)
 
     # Decide the logger class
     case @@config.logger_name.downcase
@@ -69,7 +77,7 @@ module DebugTrace
 
     return unless @@config.enabled?
 
-    config_path = File.expand_path(@@config.config_path)
+    config_path = @@config.config == nil ? @@config.config_path : File.expand_path(@@config.config_path)
     @@logger.print("DebugTrace-rb #{DebugTrace::VERSION} on Ruby #{RUBY_VERSION}")
     @@logger.print("  config file: #{config_path}")
     @@logger.print("  logger: #{@@logger}")
@@ -141,7 +149,7 @@ module DebugTrace
   # @param value [Object] the value
   # @param print_options [PrintOptions] the print options
   def self.to_string(name, value, print_options)
-    buff = LogBuffer.new(@@config.maximum_data_output_width)
+    buff = LogBuffer.new(@@config.data_output_width)
 
     unless name.empty?
       buff.append(name).no_break_append(@@config.varname_value_separator)
@@ -179,10 +187,10 @@ module DebugTrace
         to_s_string = reflection ? '' : value.to_s 
         if reflection || to_s_string.start_with?('#<')
           # use reflection
-          value_buff = LogBuffer.new(@@config.maximum_data_output_width)
+          value_buff = LogBuffer.new(@@config.data_output_width)
           if @@reflected_objects.any? { |obj| value.equal?(obj) }
             # cyclic reference
-            value_buff.no_break_append(@@config.cyclic_reference_string)
+            value_buff.no_break_append(@@config.circular_reference_string)
           elsif @@reflected_objects.length > print_options.reflection_limit
             # over reflection level limitation
             value_buff.no_break_append(@@config.limit_string)
@@ -207,8 +215,8 @@ module DebugTrace
   # @param print_options [PrintOptions] the print options
   def self.to_string_str(value, print_options)
     double_quote = false
-    single_quote_buff = LogBuffer.new(@@config.maximum_data_output_width)
-    double_quote_buff = LogBuffer.new(@@config.maximum_data_output_width)
+    single_quote_buff = LogBuffer.new(@@config.data_output_width)
+    double_quote_buff = LogBuffer.new(@@config.data_output_width)
 
     if value.length >= print_options.minimum_output_length
       single_quote_buff.no_break_append(format(@@config.length_format, value.length))
@@ -270,7 +278,7 @@ module DebugTrace
   # @param print_options [PrintOptions] the print options
   def self.to_string_bytes(value, print_options)
     bytes_length = value.length
-    buff = LogBuffer.new(@@config.maximum_data_output_width)
+    buff = LogBuffer.new(@@config.data_output_width)
 
     if bytes_length >= print_options.minimum_output_length
       buff.no_break_append(format(@@config.length_format, bytes_length))
@@ -327,13 +335,13 @@ module DebugTrace
   # @param value [Object] the value
   # @param print_options [PrintOptions] the print options
   def self.to_string_reflection(value, print_options)
-    buff = LogBuffer.new(@@config.maximum_data_output_width)
+    buff = LogBuffer.new(@@config.data_output_width)
 
     buff.append(get_type_name(value, -1, print_options))
 
     body_buff = to_string_reflection_body(value, print_options)
 
-    multi_lines = body_buff.multi_lines? || buff.length + body_buff.length > @@config.maximum_data_output_width
+    multi_lines = body_buff.multi_lines? || buff.length + body_buff.length > @@config.data_output_width
 
     buff.no_break_append('{')
     if multi_lines
@@ -357,7 +365,7 @@ module DebugTrace
   # @param value [Object] the value
   # @param print_options [PrintOptions] the print options
   def self.to_string_reflection_body(value, print_options)
-    buff = LogBuffer.new(@@config.maximum_data_output_width)
+    buff = LogBuffer.new(@@config.data_output_width)
     multi_lines = false
     index = 0
 
@@ -366,7 +374,7 @@ module DebugTrace
       buff.no_break_append(', ') if index > 0
 
       var_value = value.instance_variable_get(variable)
-      member_buff = LogBuffer.new(@@config.maximum_data_output_width)
+      member_buff = LogBuffer.new(@@config.data_output_width)
       member_buff.append(variable).no_break_append(@@config.key_value_separator)
       member_buff.append_buffer(to_string('', var_value, print_options))
       buff.line_feed if index > 0 && (multi_lines || member_buff.multi_lines?)
@@ -383,7 +391,7 @@ module DebugTrace
         buff.no_break_append(', ') if index > 0
 
         var_value = hash[member]
-        member_buff = LogBuffer.new(@@config.maximum_data_output_width)
+        member_buff = LogBuffer.new(@@config.data_output_width)
         member_buff.append(member).no_break_append(@@config.key_value_separator)
         member_buff.append_buffer(to_string('', var_value, print_options))
         buff.line_feed if index > 0 && (multi_lines || member_buff.multi_lines?)
@@ -415,13 +423,13 @@ module DebugTrace
       close_char = ']'
     end
 
-    buff = LogBuffer.new(@@config.maximum_data_output_width)
+    buff = LogBuffer.new(@@config.data_output_width)
     buff.append(get_type_name(values, values.size, print_options))
     buff.no_break_append(open_char)
 
     body_buff = to_string_enumerable_body(values, print_options)
 
-    multi_lines = body_buff.multi_lines? || buff.length + body_buff.length > @@config.maximum_data_output_width
+    multi_lines = body_buff.multi_lines? || buff.length + body_buff.length > @@config.data_output_width
 
     if multi_lines
       buff.line_feed
@@ -445,7 +453,7 @@ module DebugTrace
   # @param value [Array, Set, Hash] the value
   # @param print_options [PrintOptions] the print options
   def self.to_string_enumerable_body(values, print_options)
-    buff = LogBuffer.new(@@config.maximum_data_output_width)
+    buff = LogBuffer.new(@@config.data_output_width)
 
     multi_lines = false
     index = 0
@@ -484,7 +492,7 @@ module DebugTrace
   # @param value [Object] the value
   # @param print_options [PrintOptions] the print options
   def self.to_string_key_value(key, value, print_options)
-    buff = LogBuffer.new(@@config.maximum_data_output_width)
+    buff = LogBuffer.new(@@config.data_output_width)
     key_buff = to_string('', key, print_options)
     value_buff = to_string('', value, print_options)
     buff.append_buffer(key_buff).no_break_append(@@config.key_value_separator).append_buffer(value_buff)
@@ -507,14 +515,12 @@ module DebugTrace
     return type_name
   end
 
-  @@before_thread_id = nil
-
   # Called at the start of the print method.
   def self.print_start
-    if @@before_thread_id == nil
-      DebugTrace.initialize
-      return unless @@config.enabled?
+    if @@config == nil
+      initialize
     end
+    return unless @@config.enabled?
 
     thread = Thread.current
     thread_id = thread.object_id
@@ -527,8 +533,6 @@ module DebugTrace
     @@before_thread_id = thread_id
   end
 
-  @@DO_NOT_OUTPUT = 'Do not output'
-
   # Prints the message or the value.
   #
   # @param name [String] a message if the value is not specified, otherwise the value name
@@ -556,7 +560,7 @@ module DebugTrace
 
       if value.equal? @@DO_NOT_OUTPUT
         # without value
-        @@last_log_buff = LogBuffer.new(@@config.maximum_data_output_width)
+        @@last_log_buff = LogBuffer.new(@@config.data_output_width)
         @@last_log_buff.no_break_append(name)
       else
         # with value
@@ -590,7 +594,7 @@ module DebugTrace
       end
     end
 
-    return value
+    return value.equal? @@DO_NOT_OUTPUT ? nil : value
   end
 
   # Prints the start of the method.
@@ -616,7 +620,7 @@ module DebugTrace
         @@logger.print(indent_string) # Empty Line
       end
 
-      @@last_log_buff = LogBuffer.new(@@config.maximum_data_output_width)
+      @@last_log_buff = LogBuffer.new(@@config.data_output_width)
       @@last_log_buff.no_break_append(
         format(@@config.enter_format, name, filename, lineno, parent_name, parent_filename, parent_lineno)
       )
@@ -649,7 +653,7 @@ module DebugTrace
 
       time = (Time.now.utc - state.down_nest) * 1000 # milliseconds <- seconds
 
-      @@last_log_buff = LogBuffer.new(@@config.maximum_data_output_width)
+      @@last_log_buff = LogBuffer.new(@@config.data_output_width)
       @@last_log_buff.no_break_append(
         format(@@config.leave_format, name, filename, lineno, time)
       )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debugtrace
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Masato Kokubo
@@ -20,10 +20,12 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - CHANGELOG.md
-- LICENSE
+- LICENSE.txt
 - README.md
+- README_ja.md
 - Rakefile
-- debugtrace.yml
+- examples/debugtrace.yml
+- examples/readme-example.rb
 - lib/debugtrace.rb
 - lib/debugtrace/common.rb
 - lib/debugtrace/config.rb
@@ -53,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: DebugTrace-rb is a library that helps debug ruby programs.
 test_files: []

data/debugtrace.yml

@@ -1,3 +0,0 @@
-logger: file
-log_path: logs/debugtrace.log
-maximum_data_output_width: 100