debugtrace 0.2.7 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ba0b48484b98dad04cefc154c88afc5e82e88d551ab00d81dd3ddbe323a0e7a
-  data.tar.gz: 6f858f96393d92d0b13f4ec5f34877d9d48623990d0251cd8c6c0f81d6616c1c
+  metadata.gz: 67184688a8a3f8b4a4ff9de1ef04799cf6957d9e94907c86073c083e3b6c1b98
+  data.tar.gz: c410dcd81f2aa49f307b20200fe487a335871bbec830c15ba2a900a022d9a309
 SHA512:
-  metadata.gz: 55d162f057c2686e1c350caac7c3b4a48f493d04b344711ea2beb8c5a995ff9066334c845fc58e0d6a82dee76d17cfe001f22a74f76d47841b8ad076877a6e61
-  data.tar.gz: ce01d78482c3fa14a84f21b8d7b7f68a5ffe2efd3dee453d5ae622256818509b4ec7b9df037f121e8caaf032dfe84a10ee3ea205e4b2793877a222a3b7395c1e
+  metadata.gz: 1fea6b71189147084795ad686aaca7c9621382a3516167f40a1811a4a7b889f4bd3a2d44823ed8a252a156ec42dc29f6f88919cd229ca287ea893f77ea35dc44
+  data.tar.gz: 625c317abee13df3c3e67bf2a2250f2d3685f341e9a2370b936f6c853b325f46571c47851d79827e96de4a850c196d0d308a912f23eae4f15e25bab15d6d4470

data/debugtrace.yml

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

data/lib/debugtrace/common.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # common.rb
 # (C) 2025 Masato Kokubo
 

data/lib/debugtrace/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # config.rb
 # (C) 2025 Masato Kokubo
 require 'yaml'

data/lib/debugtrace/log_buffer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # log_buffer.rb
 # (C) 2025 Masato Kokubo
 require_relative 'common'
@@ -85,17 +86,14 @@ class LogBuffer
 
   # Appends lines of another LogBuffer.
   #
-  # @param separator [String] the separator string to append if not ''
   # @param buff [LogBuffer] another LogBuffer
   # @return [LogBuffer] this object
-  def append_buffer(separator, buff)
-    Common.check_type('separator', separator, String)
+  def append_buffer(buff)
     Common.check_type('buff', buff, LogBuffer)
-    append(separator, 0, true) if separator != ''
     index = 0
     for line in buff.lines
       line_feed if index > 0
-      append(line.log, line.nest_level, index == 0 && separator != '')
+      append(line.log, line.nest_level, true)
       index += 1
     end
     return self

data/lib/debugtrace/loggers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # loggers.rb
 # (C) 2023 Masato Kokubo
 require 'logger'

data/lib/debugtrace/state.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # state.rb
 # (C) 2025 Masato Kokubo
 require_relative 'common'

data/lib/debugtrace/version.rb

@@ -1,6 +1,6 @@
-# (C) 2025 Masato Kokubo
 # frozen_string_literal: true
+# (C) 2025 Masato Kokubo
 
 module DebugTrace
-  VERSION = '0.2.7'
+  VERSION = '0.3.1'
 end

data/lib/debugtrace.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
 # debugtrace.rb
 # (C) 2025 Masato Kokubo
 require 'logger'
+require 'set'
+require 'date'
 
 # Require necessary files
 require_relative 'debugtrace/version'
@@ -12,6 +15,10 @@ require_relative 'debugtrace/state'
 
 # The main module of DebugTrace-rb.
 module DebugTrace
+  @@no_reflection_classes = [
+    FalseClass, TrueClass, Integer, Float, Rational, Complex, Range, Regexp,
+  ]
+
   # Configuration values
   @@config = nil
 
@@ -136,54 +143,58 @@ module DebugTrace
   def self.to_string(name, value, print_options)
     buff = LogBuffer.new(@@config.maximum_data_output_width)
 
-    separator = ''
     unless name.empty?
-      buff.append(name)
-      separator = @@config.varname_value_separator
+      buff.append(name).no_break_append(@@config.varname_value_separator)
     end
 
-    case value
-    when nil
-      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 = value.encoding == Encoding::ASCII_8BIT ?
-          to_string_bytes(value, print_options) : to_string_str(value, print_options)
-      buff.append_buffer(separator, value_buff)
-    when DateTime
-      buff.no_break_append(separator).append(value.strftime('%Y-%m-%d %H:%M-%S.%L%:z'))
-    when Date
-      buff.no_break_append(separator).append(value.strftime('%Y-%m-%d'))
-    when Time
-      buff.no_break_append(separator).append(value.strftime('%H:%M-%S.%L%:z'))
-    when Array, Set, Hash
-      value_buff = to_string_enumerable(value, print_options)
-      buff.append_buffer(separator, value_buff)
+    if @@no_reflection_classes.include?(value.class)
+      buff.append(value.to_s)
     else
-      if print_options.reflection
-        # use reflection
-        value_buff = LogBuffer.new(@@config.maximum_data_output_width)
-        if @@reflected_objects.any? { |obj| value.equal?(obj) }
-          # cyclic reference
-          value_buff.no_break_append(@@config.cyclic_reference_string)
-        elsif @@reflected_objects.length > print_options.reflection_limit
-          # over reflection level limitation
-          value_buff.no_break_append(@@config.limit_string)
+      case value
+      when nil
+        buff.append('nil')
+      when Symbol
+        buff.append(':').no_break_append(value.name)
+      when Class
+        buff.append(value.name).no_break_append(' class')
+      when Module
+        buff.append(value.name).no_break_append(' module')
+      when String
+        value_buff = value.encoding == Encoding::ASCII_8BIT ?
+            to_string_bytes(value, print_options) : to_string_str(value, print_options)
+        buff.append_buffer(value_buff)
+      when DateTime, Time
+        buff.append(value.strftime('%Y-%m-%d %H:%M:%S.%L%:z'))
+      when Date
+        buff.append(value.strftime('%Y-%m-%d'))
+      when Dir, File
+        buff.append(value.class.name)
+        buff.append_buffer(to_string_str(value.path, print_options))
+      when Array, Set, Hash
+        value_buff = to_string_enumerable(value, print_options)
+        buff.append_buffer(value_buff)
+      else
+        reflection = print_options.reflection || value.class.superclass == Struct
+        
+        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)
+          if @@reflected_objects.any? { |obj| value.equal?(obj) }
+            # cyclic reference
+            value_buff.no_break_append(@@config.cyclic_reference_string)
+          elsif @@reflected_objects.length > print_options.reflection_limit
+            # over reflection level limitation
+            value_buff.no_break_append(@@config.limit_string)
+          else
+            @@reflected_objects.push(value)
+            value_buff = to_string_reflection(value, print_options)
+            @@reflected_objects.pop
+          end
+          buff.append_buffer(value_buff)
         else
-          @@reflected_objects.push(value)
-          value_buff = to_string_reflection(value, print_options)
-          @@reflected_objects.pop
+          buff.append(to_s_string)
         end
-        buff.append_buffer(separator, value_buff)
-      else
-        buff.no_break_append(separator).append(value.to_s)
       end
     end
 
@@ -195,12 +206,11 @@ module DebugTrace
   # @param value [String] the value
   # @param print_options [PrintOptions] the print options
   def self.to_string_str(value, print_options)
-    has_single_quote = false
-    has_double_quote = false
+    double_quote = false
     single_quote_buff = LogBuffer.new(@@config.maximum_data_output_width)
     double_quote_buff = LogBuffer.new(@@config.maximum_data_output_width)
 
-    if value.length >= @@config.minimum_output_length
+    if value.length >= print_options.minimum_output_length
       single_quote_buff.no_break_append(format(@@config.length_format, value.length))
       double_quote_buff.no_break_append(format(@@config.length_format, value.length))
     end
@@ -217,30 +227,28 @@ module DebugTrace
       end
       case char
       when "'"
-        single_quote_buff.no_break_append("\\'")
+        double_quote = true
         double_quote_buff.no_break_append(char)
-        has_single_quote = true
       when '"'
         single_quote_buff.no_break_append(char)
         double_quote_buff.no_break_append("\\\"")
-        has_double_quote = true
       when "\\"
-        single_quote_buff.no_break_append("\\\\")
+        double_quote = true
         double_quote_buff.no_break_append("\\\\")
       when "\n"
-        single_quote_buff.no_break_append("\\n")
+        double_quote = true
         double_quote_buff.no_break_append("\\n")
       when "\r"
-        single_quote_buff.no_break_append("\\r")
+        double_quote = true
         double_quote_buff.no_break_append("\\r")
       when "\t"
-        single_quote_buff.no_break_append("\\t")
+        double_quote = true
         double_quote_buff.no_break_append("\\t")
       else
         char_ord = char.ord
         if char_ord >= 0x00 && char_ord <= 0x1F || char_ord == 0x7F
+          double_quote = true
           num_str = format('%02X', char_ord)
-          single_quote_buff.no_break_append("\\x" + num_str)
           double_quote_buff.no_break_append("\\x" + num_str)
         else
           single_quote_buff.no_break_append(char)
@@ -253,7 +261,7 @@ module DebugTrace
     double_quote_buff.no_break_append('"')
     single_quote_buff.no_break_append("'")
 
-    return has_single_quote && !has_double_quote ? double_quote_buff : single_quote_buff
+    return double_quote ? double_quote_buff : single_quote_buff
   end
 
   # Returns a string representation of the string value which encoding is ASCII_8BIT.
@@ -264,8 +272,8 @@ module DebugTrace
     bytes_length = value.length
     buff = LogBuffer.new(@@config.maximum_data_output_width)
 
-    if bytes_length >= @@config.minimum_output_length
-      buff.no_break_append(format(@@config.size_format, bytes_length))
+    if bytes_length >= print_options.minimum_output_length
+      buff.no_break_append(format(@@config.length_format, bytes_length))
     end
 
     buff.no_break_append('[')
@@ -321,7 +329,7 @@ module DebugTrace
   def self.to_string_reflection(value, print_options)
     buff = LogBuffer.new(@@config.maximum_data_output_width)
 
-    buff.append(get_type_name(value))
+    buff.append(get_type_name(value, -1, print_options))
 
     body_buff = to_string_reflection_body(value, print_options)
 
@@ -333,7 +341,7 @@ module DebugTrace
       buff.up_nest
     end
 
-    buff.append_buffer('', body_buff)
+    buff.append_buffer(body_buff)
 
     if multi_lines
       buff.line_feed if buff.length > 0
@@ -350,25 +358,42 @@ module DebugTrace
   # @param print_options [PrintOptions] the print options
   def self.to_string_reflection_body(value, print_options)
     buff = LogBuffer.new(@@config.maximum_data_output_width)
-
-    variables = value.instance_variables
-
     multi_lines = false
     index = 0
+
+    variables = value.instance_variables
     variables.each do |variable|
       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.append(variable)
-      member_buff.append_buffer(@@config.key_value_separator, to_string('', var_value, print_options))
+      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?)
-      buff.append_buffer('', member_buff)
+      buff.append_buffer(member_buff)
 
       multi_lines = member_buff.multi_lines?
       index += 1
     end
 
+    if value.class.superclass == Struct
+      members = value.members
+      hash = value.to_h
+      members.each do |member|
+        buff.no_break_append(', ') if index > 0
+
+        var_value = hash[member]
+        member_buff = LogBuffer.new(@@config.maximum_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?)
+        buff.append_buffer(member_buff)
+
+        multi_lines = member_buff.multi_lines?
+        index += 1
+      end
+    end
+
     return buff
   end
 
@@ -391,7 +416,7 @@ module DebugTrace
     end
 
     buff = LogBuffer.new(@@config.maximum_data_output_width)
-    buff.append(get_type_name(values, values.length))
+    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)
@@ -403,7 +428,7 @@ module DebugTrace
       buff.up_nest
     end
 
-    buff.append_buffer('', body_buff)
+    buff.append_buffer(body_buff)
 
     if multi_lines
       buff.line_feed
@@ -442,7 +467,7 @@ module DebugTrace
         end
 
       buff.line_feed if index > 0 && (multi_lines || element_buff.multi_lines?)
-      buff.append_buffer('', element_buff)
+      buff.append_buffer(element_buff)
 
       multi_lines = element_buff.multi_lines?
       index += 1
@@ -462,19 +487,20 @@ module DebugTrace
     buff = LogBuffer.new(@@config.maximum_data_output_width)
     key_buff = to_string('', key, print_options)
     value_buff = to_string('', value, print_options)
-    buff.append_buffer('', key_buff).append_buffer(@@config.key_value_separator, value_buff)
+    buff.append_buffer(key_buff).no_break_append(@@config.key_value_separator).append_buffer(value_buff)
     buff
   end
 
   # Returns the type name.
   #
   # @param value [Object] the value
-  # @option size [Object] the size of Array, Set or Hash
-  def self.get_type_name(value, size = -1)
+  # @param size [Object] the size of Array, Set or Hash
+  # @param print_options [PrintOptions] the print options
+  def self.get_type_name(value, size, print_options)
     type_name = value.class.to_s
     type_name = '' if %w[Array Hash Set].include?(type_name)
 
-    if size >= @@config.minimum_output_size
+    if size >= print_options.minimum_output_size
       type_name += @@config.size_format % size
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debugtrace
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.1
 platform: ruby
 authors:
 - Masato Kokubo
@@ -23,6 +23,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- debugtrace.yml
 - lib/debugtrace.rb
 - lib/debugtrace/common.rb
 - lib/debugtrace/config.rb