debugtrace 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 007becfaaebee62ef14be62da8bcff6530fd2ca3835c09e153254f9699b1ac7b
-  data.tar.gz: 4bb241654f775b6891bc95234dad0b24f4caf0a770e56488521c10ce26e9d818
+  metadata.gz: fa74406233753b57eb94f0f05e67ec9e9818014ccaa6fda15a93ff65bd406be4
+  data.tar.gz: 131f249a1bddfd25c5be1d7c87a140c8b77540863ea8b84a6b9a5205f3bb57db
 SHA512:
-  metadata.gz: fd547264f234ca06406199fb09ea1e689366c5096e62565f1926b96a1f888ec15322f145991deb155ef0dd61f6fff96aedfa246bc6a3fe6f69e297ea93bda06d
-  data.tar.gz: 6a0b7a8f3026dab44469ec6c5ab2bd2b1cace79e855dfc5165a2d35445ce4e2484d36283d5cf9d3a3e1bc99e17aff0b8e2d3ebc452683007ef76f397f79add11
+  metadata.gz: 1ff6920733cfc9e0f51d3fe0b532cb5389ca419cf6f950c3bd4083a6202e4673cd0eb93ba67df1aaca431562dc8a36c43c67572d20fc90e0e30b0a265f18ec3c
+  data.tar.gz: de378f10d17017256fa03c5fac2fa2709e9b0ee8775f79c7373139302baeb062584ea5534f43a3d74f4725e2ae448257aa69bd3ba6c245bd5e26a7c5b31650ba

data/CHANGELOG.md

@@ -1,5 +1,19 @@
-## [Unreleased]
+## 1.1.0 - May 25, 2025
 
-## [0.1.0] - 2022-12-10
+### Bug fixes
 
-- Initial release
+* Fixed a bug where line breaks were not inserted between elements when outputting `Array`, `Hash`, and `Set` using the print method.
+
+### Specification changes
+
+* Changed the following keyword argument names for the `print` method, and also changed the property names of the same names in `debugtrace.yml`.
+    * `output_size_limit` ← `collection_limit`
+    * `output_length_limit` ← `string_limit` and `bytes_limit` _(Unified)_
+
+## 1.0.1 - May 19, 2025
+
+Fixed a bug that caused an error if the environment variable `DEBUGTRACE_CONFIG` was not set.
+
+## 1.0.0 - May 18, 2025
+
+This is the initial release.

data/README.md

@@ -140,8 +140,8 @@ DebugTrace module has the following methods.
       <small><i>The following arguments can be specified in debugtrace.yml (argument specification takes precedence)</i></small><br>
       <code>minimum_output_size</code>: The minimum number of elements to print for <code>Array</code>, <code>Hash</code> and <code>Set</code><br>
       <code>minimum_output_length</code>: The minimum length to print the length of the string<br>
-      <code>collection_limit</code>: The limit on the number of elements output for <code>Map</code>, <code>Hash</code> and <code>Set</code><br>
-      <code>string_limit</code>: The limit on the number of characters that can be output from a string<br>
+      <code>output_size_limit</code>: The limit on the number of elements output for <code>Map</code>, <code>Hash</code> and <code>Set</code><br>
+      <code>output_length_limit</code>: The limit on the number of characters that can be output from a string<br>
       <code>reflection_limit</code>: The limit of reflection nesting<br>
     </td>
     <td>the argument value if it is specified, otherwise <code>nil</code></td>
@@ -527,44 +527,30 @@ You can specify the following properties in debugtrace.yml.
     </td>
   </tr>
   <tr>
-    <td><code>collection_limit</code></td>
+    <td><code>output_size_limit</code></td>
     <td>
       The limit on the number of elements output for <code>Array</code>, <code>Hash</code>, and <code>Set</code><br>
       <small><b>Example:</b></small>
       <ul>
-        <code>collection_limit: 64</code>
+        <code>output_size_limit: 64</code>
       </ul>
       <small><b>Default Value:</b></small>
       <ul>
-        <code>collection_limit: 128</code>
+        <code>output_size_limit: 128</code>
       </ul>
     </td>
   </tr>
   <tr>
-    <td><code>string_limit</code></td>
+    <td><code>output_length_limit</code></td>
     <td>
-      文字列の出力文字数の制限値<br>
+      The limit on the number of characters that can be output from a string<br>
       <small><b>Example:</b></small>
       <ul>
-        <code>string_limit: 64</code>
+        <code>output_length_limit: 64</code>
       </ul>
       <small><b>Default Value:</b></small>
       <ul>
-        <code>string_limit: 256</code>
-      </ul>
-    </td>
-  </tr>
-  <tr>
-    <td><code>bytes_limit</code></td>
-    <td>
-      The limit on the number of characters to be output a string as a byte array<br>
-      <small><b>Example:</b></small>
-      <ul>
-        <code>bytes_limit: 64</code>
-      </ul>
-      <small><b>Default Value:</b></small>
-      <ul>
-        <code>bytes_limit: 256</code>
+        <code>output_length_limit: 256</code>
       </ul>
     </td>
   </tr>
@@ -584,7 +570,11 @@ You can specify the following properties in debugtrace.yml.
   </tr>
 </table>
 
-### 6. License
+### 6. CHANGELOG
+
+[CHANGELOG](CHANGELOG.md)
+
+### 7. License
 
 [MIT License(MIT)](LICENSE.txt)
 

data/README_ja.md

@@ -138,8 +138,8 @@ DebugTraceモジュールには以下のメソッドがあります。
       <small><i>以降の引数は、debugtrace.ymlで指定可能 (引数指定が優先)</i></small><br>
       <code>minimum_output_size</code>: <code>Array</code>, <code>Hash</code>および<code>Set</code>の要素数を出力する最小要素数<br>
       <code>minimum_output_length</code>: 文字列の長さを出力する最小の長さ<br>
-      <code>collection_limit</code>: <code>Map</code>, <code>Hash</code>および<code>Set</code>の要素の出力数の制限値<br>
-      <code>string_limit</code>: 文字列の出力文字数の制限値<br>
+      <code>output_size_limit</code>: <code>Array</code>, <code>Hash</code>および<code>Set</code>の要素の出力数の制限値<br>
+      <code>output_length_limit</code>: 文字列の出力文字数の制限値<br>
       <code>reflection_limit</code>: リフレクションのネスト数の制限値<br>
     </td>
     <td>値の指定があれば引数値、なければ<code>nil</code></td>
@@ -525,44 +525,30 @@ debugtrace.ymlには以下のプロパティを指定できます。
     </td>
   </tr>
   <tr>
-    <td><code>collection_limit</code></td>
+    <td><code>output_size_limit</code></td>
     <td>
       Array</code>, <code>Hash</code>および<code>Set</code>の要素の出力数の制限値<br>
       <small><b>設定例:</b></small>
       <ul>
-        <code>collection_limit: 64</code>
+        <code>output_size_limit: 64</code>
       </ul>
       <small><b>初期値:</b></small>
       <ul>
-        <code>collection_limit: 128</code>
+        <code>output_size_limit: 128</code>
       </ul>
     </td>
   </tr>
   <tr>
-    <td><code>string_limit</code></td>
+    <td><code>output_length_limit</code></td>
     <td>
       文字列の出力文字数の制限値<br>
       <small><b>設定例:</b></small>
       <ul>
-        <code>string_limit: 64</code>
+        <code>output_length_limit: 64</code>
       </ul>
       <small><b>初期値:</b></small>
       <ul>
-        <code>string_limit: 256</code>
-      </ul>
-    </td>
-  </tr>
-  <tr>
-    <td><code>bytes_limit</code></td>
-    <td>
-      文字列をバイト配列として出力する場合のの出力数の制限値<br>
-      <small><b>設定例:</b></small>
-      <ul>
-        <code>bytes_limit: 64</code>
-      </ul>
-      <small><b>初期値:</b></small>
-      <ul>
-        <code>bytes_limit: 256</code>
+        <code>output_length_limit: 256</code>
       </ul>
     </td>
   </tr>
@@ -582,7 +568,11 @@ debugtrace.ymlには以下のプロパティを指定できます。
   </tr>
 </table>
 
-### 6. ライセンス
+### 6. 修正履歴
+
+[修正履歴](CHANGELOG_ja.md)
+
+### 7. ライセンス
 
 [MIT ライセンス(MIT)](LICENSE.txt)
 

data/examples/debugtrace.yml

@@ -22,7 +22,6 @@ length_format: "(length=%d)"
 minimum_output_length: 6
 data_output_width: 40
 bytes_count_in_line: 32
-collection_limit: 64
-string_limit: 5
-bytes_limit: 64
+output_size_limit: 64
+output_length_limit: 5
 reflection_limit: 3

data/lib/debugtrace/common.rb

@@ -12,8 +12,8 @@ module Common
   # @return [String] the value
   # @raise [TypeError] if the value is not an instance of the type or the subclass of the type
   def self.check_type(value_name, value, type)
-    raise TypeError("Argument value_name (=#{value_name}) must be a String") unless value_name.is_a?(String)
-    raise TypeError("Argument type (=#{type}) must be a Class") unless type.is_a?(Class)
+    raise TypeError, "Argument value_name (=#{value_name}) must be a String" unless value_name.is_a?(String)
+    raise TypeError, "Argument type (=#{type}) must be a Class" unless type.is_a?(Class)
 
     error = false
     if type == FalseClass || type == TrueClass
@@ -30,7 +30,7 @@ module Common
       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'
-      raise TypeError("Argument #{value_name} (=#{value_string}) must be #{a} #{type}")
+      raise TypeError, "Argument #{value_name} (=#{value_string}) must be #{a} #{type}"
     end
     return value
   end

data/lib/debugtrace/config.rb

@@ -8,69 +8,67 @@ require_relative 'common'
 class Config
   attr_reader :config_path
   attr_reader :config
-  attr_reader :logger_name
-  attr_reader :log_path
-  attr_reader :rubylogger_format
-  attr_reader :log_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 :circular_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 :data_output_width
-  attr_reader :bytes_count_in_line
-  attr_reader :collection_limit
-  attr_reader :string_limit
-  attr_reader :bytes_limit
-  attr_reader :reflection_limit
+  attr_accessor :logger_name
+  attr_accessor :log_path
+  attr_accessor :rubylogger_format
+  attr_accessor :log_datetime_format
+  attr_accessor :enter_format
+  attr_accessor :leave_format
+  attr_accessor :thread_boundary_format
+  attr_accessor :maximum_indents
+  attr_accessor :indent_string
+  attr_accessor :data_indent_string
+  attr_accessor :limit_string
+  attr_accessor :circular_reference_string
+  attr_accessor :varname_value_separator
+  attr_accessor :key_value_separator
+  attr_accessor :print_suffix_format
+  attr_accessor :size_format
+  attr_accessor :minimum_output_size
+  attr_accessor :length_format
+  attr_accessor :minimum_output_length
+  attr_accessor :data_output_width
+  attr_accessor :bytes_count_in_line
+  attr_accessor :output_size_limit
+  attr_accessor :output_length_limit
+  attr_accessor :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'
-    @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
+    @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
+    @output_size_limit         = get_value 'output_size_limit'        , 128
+    @output_length_limit       = get_value 'output_length_limit'      , 256
+    @reflection_limit          = get_value 'reflection_limit'         , 4
   end
 
   # Returns true if logging is enabled, false otherwise.

data/lib/debugtrace/log_buffer.rb

@@ -93,7 +93,7 @@ class LogBuffer
     index = 0
     for line in buff.lines
       line_feed if index > 0
-      append(line.log, line.nest_level, true)
+      append(line.log, line.nest_level)
       index += 1
     end
     return self

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.

data/lib/debugtrace/version.rb

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

data/lib/debugtrace.rb

@@ -52,7 +52,7 @@ module DebugTrace
   # Initialize this class
   def self.initialize()
     config_path = ENV['DEBUGTRACE_CONFIG']
-    if config_path == ''
+    if config_path == nil || config_path.empty?
       config_path = './debugtrace.yml'
     end
 
@@ -86,32 +86,29 @@ module DebugTrace
   # Contains options to pass to the print method.
   class PrintOptions
     attr_reader :reflection, :minimum_output_size, :minimum_output_length,
-                :collection_limit, :bytes_limit, :string_limit, :reflection_limit
+                :output_size_limit, :output_length_limit, :reflection_limit
 
     # Initializes this object.
     #
     # @param reflection [TrueClass, FalseClass] use reflection if true
     # @param minimum_output_size [Integer] the minimum value to output the number of elements for Array and Hash (overrides debugtarace.yml value)
     # @param minimum_output_length [Integer] the minimum value to output the length of String and byte array (overrides debugtarace.yml value)
-    # @param collection_limit [Integer] Output limit of collection elements (overrides debugtarace.yml value)
-    # @param bytes_limit [Integer] the limit value of elements for bytes and bytearray to output (overrides debugtarace.yml value)
-    # @param string_limit [Integer] the limit value of characters for string to output (overrides debugtarace.yml value)
+    # @param output_size_limit [Integer] Output limit of collection elements (overrides debugtarace.yml value)
+    # @param output_length_limit [Integer] the limit value of characters for string to output (overrides debugtarace.yml value)
     # @param reflection_limit [Integer] reflection limits when using reflection (overrides debugtarace.yml value)
     def initialize(
       reflection,
       minimum_output_size,
       minimum_output_length,
-      collection_limit,
-      bytes_limit,
-      string_limit,
+      output_size_limit,
+      output_length_limit,
       reflection_limit
     )
       @reflection = reflection
       @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
-      @string_limit = string_limit == -1 ? DebugTrace.config.string_limit : string_limit
+      @output_size_limit = output_size_limit == -1 ? DebugTrace.config.output_size_limit : output_size_limit
+      @output_length_limit = output_length_limit == -1 ? DebugTrace.config.output_length_limit : output_length_limit
       @reflection_limit = reflection_limit == -1 ? DebugTrace.config.reflection_limit : reflection_limit
     end
   end
@@ -228,7 +225,7 @@ module DebugTrace
 
     count = 1
     value.each_char do |char|
-      if count > print_options.string_limit
+      if count > print_options.output_length_limit
         single_quote_buff.no_break_append(@@config.limit_string)
         double_quote_buff.no_break_append(@@config.limit_string)
         break
@@ -302,7 +299,7 @@ module DebugTrace
         buff.line_feed
         chars = ''
       end
-      if count >= print_options.bytes_limit
+      if count >= print_options.output_length_limit
         buff.no_break_append(@@config.limit_string)
         break
       end
@@ -414,11 +411,11 @@ module DebugTrace
     close_char = ']'
 
     if values.is_a?(Hash)
-      # Array
+      # Hash
       open_char = '{'
       close_char = '}'
     elsif values.is_a?(Set)
-      # Sete
+      # Set
       open_char = 'Set['
       close_char = ']'
     end
@@ -461,7 +458,7 @@ module DebugTrace
     values.each do |element|
       buff.no_break_append(', ') if index > 0
 
-      if index >= print_options.collection_limit
+      if index >= print_options.output_size_limit
         buff.append(@@config.limit_string)
         break
       end
@@ -540,15 +537,12 @@ module DebugTrace
   # @option reflection [TrueClass, FalseClass] use reflection if true
   # @option minimum_output_size [Integer] the minimum value to output the number of elements for Array and Hash (overrides debugtarace.yml value)
   # @option minimum_output_length [Integer] the minimum value to output the length of String and byte array (overrides debugtarace.yml value)
-  # @option collection_limit [Integer] Output limit of collection elements (overrides debugtarace.yml value)
-  # @option bytes_limit [Integer] the limit value of elements for bytes and bytearray to output (overrides debugtarace.yml value)
-  # @option string_limit [Integer] the limit value of characters for string to output (overrides debugtarace.yml value)
+  # @option output_size_limit [Integer] Output limit of collection elements (overrides debugtarace.yml value)
+  # @option output_length_limit [Integer] the limit value of characters for string to output (overrides debugtarace.yml value)
   # @option reflection_limit [Integer] reflection limits when using reflection (overrides debugtarace.yml value)
   def self.print(name, value = @@DO_NOT_OUTPUT,
-      reflection: false,
-      minimum_output_size: -1, minimum_output_length: -1,
-      collection_limit: -1, bytes_limit: -1,
-      string_limit: -1, reflection_limit: -1)
+      reflection: false, minimum_output_size: -1, minimum_output_length: -1,
+      output_size_limit: -1, output_length_limit: -1, reflection_limit: -1)
     @@thread_mutex.synchronize do
       print_start
       return value unless @@config.enabled?
@@ -565,10 +559,8 @@ module DebugTrace
       else
         # with value
         print_options = PrintOptions.new(
-          reflection,
-          minimum_output_size, minimum_output_length,
-          collection_limit, bytes_limit,
-          string_limit, reflection_limit
+          reflection, minimum_output_size, minimum_output_length,
+          output_size_limit, output_length_limit, reflection_limit
         )
         @@last_log_buff = to_string(name, value, print_options)
       end

metadata

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