debugtrace 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04bce05e2d9f97e7a4c0e1aa1e4b097a49cd4669615ca56e69ab197d2f2a494b
-  data.tar.gz: 4a6ab354ae3515f2167dd6779027f89fc49e49710a17b9d842570d8ec92a13f1
+  metadata.gz: afb02cff204f024316f82e26158c1bae6d0875426a121527e46dd47fc8a7c2a8
+  data.tar.gz: 52f5a47c52c4c2d33009f2f29391215d58ab61dc9726bf6cb2d9b8ebf49b0579
 SHA512:
-  metadata.gz: c46e1e92e14d5f42f22b208b39911ff6c4f651fa15f4f5be89ace408f6e0448e2a931f1e0983d82d1a831b03f5167cbe2ccd369bf8eed6014cecbb202acdf8c8
-  data.tar.gz: 930dd3f482134f6e39dfc96e64f73c23f8630ac32241aa725e0ebc772c02ccae29f3911f850da5c31e02dac2a87a61af2591a4f8f414d94e09eaf3f3e138f33d
+  metadata.gz: a4c61532b60b0d9055cfb1e28fea67a4967baef7ee2956898f29d050ff75501d65453a7ce833c5af0fe10915593dfe6188cdd99884557aa43f21e1488f117f4a
+  data.tar.gz: 7b3eed480352befe9fd66d96268106e0ec5ddb2e6008df42341529b04bf235765e8d0cf363da5dc781496e32a57214ba193345a0bb01dcd9fdf4bf44e802c33e

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.3.0 - July 12, 2025
+
+* Added optional argument `string_as_bytes` (default: `false`) to the `print` method. The string will be output in hexadecimal if it is `true`.
+* Hexadecimal output of strings with encoding `ASCII_8BIT` has been discontinued.
+
 ## 1.2.0 - July 5, 2025
 
 * Changed source file name output to a relative path from the current directory.

data/CHANGELOG_ja.md

@@ -1,29 +1,34 @@
+## 1.3.0 - 2025/7/12
+
+* `print`メソッドにオプション引数`string_as_bytes`(デフォルト: `false`)を追加しました。`true`を指定した場合は、文字列を16進数で出力します。
+* エンコーディングが`ASCII_8BIT`の文字列の16進数出力を廃止しました。
+
 ## 1.2.0 - 2025/7/5
 
-* ソースファイル名の出力をカレントディレクトリからの相対パスに変更。
-* メソッド名の出力にクラス名を追加。
+* ソースファイル名の出力をカレントディレクトリからの相対パスに変更しました。
+* メソッド名の出力にクラス名を追加しました。
 
 ## 1.1.2 - 2025/7/2
 
-条件によって`print`メソッドで例外がスローされるバグを修正。
+条件によって`print`メソッドで例外がスローされるバグを修正しました。
 
 ## 1.1.1 - 2025/7/1
 
-条件によって`enter`, `leave`, `print`メソッドで例外がスローされるバグを修正。
+条件によって`enter`, `leave`, `print`メソッドで例外がスローされるバグを修正しました。
 
 ## 1.1.0 - 2025/5/25
 
-`print`メソッドで`Array`, `Hash`および`Set`を出力する場合に要素間での改行が行われないバグの修正。
+`print`メソッドで`Array`, `Hash`および`Set`を出力する場合に要素間で改行が行われないバグの修正しました。
 
 #### 仕様変更
 
-* `print`メソッドの以下のキーワード引数名を変更、また`debugtrace.yml`の同名のプロパティ名も変更
+* `print`メソッドの以下のキーワード引数名を変更し、`debugtrace.yml`の同名のプロパティ名も変更しました。
     * `output_size_limit` ← `collection_limit`
     * `output_length_limit` ← `string_limit` および `bytes_limit` _(統一)_
  
 ## 1.0.1 - 2025/5/19
 
-環境変数 `DEBUGTRACE_CONFIG` が設定されていない場合にエラーが発生するバグを修正。
+環境変数 `DEBUGTRACE_CONFIG` が設定されていない場合にエラーが発生するバグを修正しました。
 
 ## 1.0.0 - 2025/5/18
 

data/README.md

@@ -120,28 +120,29 @@ DebugTrace module has the following methods.
   <tr>
     <td><code>enter</code></td>
     <td><i>None</i></td>
-    <td><i>None</i></td>
+    <td><code>nil</code></td>
     <td>Outputs the start of the method to the log.</td>
   </tr>
   <tr>
     <td><code>leave</code></td>
-    <td><code>return_value</code>: return value of this method<small>(Optional)</small></td>
-    <td><code>return_value</code> <small>(<code>nil</code> if <code>return_value</code> is omitted)</small></td>
+    <td><code>return_value</code>: return value of this method <small>(Optional)</small></td>
+    <td><code>return_value</code> (<code>nil</code> if <code>return_value</code> is omitted)</td>
     <td>Output the end of the method to the log.</td>
   </tr>
   <tr>
     <td><code>print</code></td>
     <td>
-      <code>name</code>: the value name<br>
-      <code>value</code>: the value <small>(Optional)</small><br>
-      <small><i>The following arguments are keyword arguments and optional</i></small><br>
-      <code>reflection</code>: reflection is used aggressively if <code>true</code>, used passively if <code>false</code><small>(Default: <code>false</code>)</small><br>
-      <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>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>
+      <p><code>name</code>: the value name</p>
+      <p><code>value</code>: the value <small>(Optional)</small></p>
+      <small><i>The following arguments are keyword arguments and optional</i></small></p>
+      <p><code>reflection</code>: reflection is used aggressively if <code>true</code>, used passively if <code>false</code> (Default: <code>false</code>)</p>
+      <p><code>string_as_bytes</code>: Output strings in hexadecimal if <code>true</code> <small>(Default: <code>false</code>)</small></p>
+      <small><i>The following arguments can be specified in debugtrace.yml (argument specification takes precedence)</i></small></p>
+      <p><code>minimum_output_size</code>: The minimum number of elements to print for <code>Array</code>, <code>Hash</code> and <code>Set</code></p>
+      <p><code>minimum_output_length</code>: The minimum length to print the length of the string<br>
+      <p><code>output_size_limit</code>: The limit on the number of elements output for <code>Map</code>, <code>Hash</code> and <code>Set</code></p>
+      <p><code>output_length_limit</code>: The limit on the number of characters that can be output from a string<br>
+      <p><code>reflection_limit</code>: The limit of reflection nesting</p>
     </td>
     <td>the argument value if it is specified, otherwise <code>nil</code></td>
     <td>

data/README_ja.md

@@ -120,7 +120,7 @@ DebugTraceモジュールには以下のメソッドがあります。
   <tr>
     <td><code>enter</code></td>
     <td>なし</td>
-    <td>なし</td>
+    <td><code>nil</code></td>
     <td>メソッドの開始のログを出力する</td>
   </tr>
   <tr>
@@ -132,16 +132,17 @@ DebugTraceモジュールには以下のメソッドがあります。
   <tr>
     <td><code>print</code></td>
     <td>
-      <code>name</code>: 値の名前<br>
-      <code>value</code>: 値 <small>(省略可)</small><br>
-      <small><i>以降の引数は、キーワード引数で省略可</i></small><br>
-      <code>reflection</code>: <code>true</code>ならリフレクションを積極的に使用、<code>false</code>なら消極的に使用 <small>(デフォルト: <code>false</code>)</small><br>
+      <p><code>name</code>: 値の名前</p>
+      <p><code>value</code>: 値 <small>(省略可)</small></p>
+      <small><i>以降の引数は、キーワード引数で省略可</i></small>
+      <code>reflection</code>: <code>true</code>ならリフレクションを積極的に使用、<code>false</code>なら消極的に使用 <small>(デフォルト: <code>false</code>)</small></p>
+      <p><code>string_as_bytes</code>: <code>true</code>なら文字列を16進数で出力する<small>(デフォルト: <code>false</code>)</small></p>
       <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>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>
+      <p><code>minimum_output_size</code>: <code>Array</code>, <code>Hash</code>および<code>Set</code>の要素数を出力する最小要素数</p>
+      <p><code>minimum_output_length</code>: 文字列の長さを出力する最小の長さ<br>
+      <p><code>output_size_limit</code>: <code>Array</code>, <code>Hash</code>および<code>Set</code>の要素の出力数の制限値</p>
+      <p><code>output_length_limit</code>: 文字列の出力文字数の制限値</p>
+      <p><code>reflection_limit</code>: リフレクションのネスト数の制限値</p>
     </td>
     <td>値の指定があれば引数値、なければ<code>nil</code></td>
     <td>

data/lib/debugtrace/location.rb

@@ -1,35 +1,35 @@
-# frozen_string_literal: true
-# location.rb
-# (C) 2025 Masato Kokubo
-
-# Contains source location information.
-class Location
-  attr_reader :name
-  attr_reader :path
-  attr_reader :lineno
-
-  # Initializes this object.
-  #
-  # @param caller_location [Thread::Backtrace::Location] the caller location
-  def initialize(caller_location)
-    if caller_location == nil
-      @name = 'unknown'
-      @path = 'unknown'
-      @lineno = 0
-    else
-      @name = caller_location.label
-      if @name.start_with?('Object#')
-        @name = caller_location.base_label
-      end
-      @path = caller_location.path || 'unknown'
-      @lineno = caller_location.lineno
-    end
-  end
-
-  # Returns a string representation of this object.
-  #
-  # @return [String] A string representation of this object
-  def to_s()
-      return "(Location){name: #{@name}, path: #{@path}, lineno: #{@lineno}"
-  end
-end
+# frozen_string_literal: true
+# location.rb
+# (C) 2025 Masato Kokubo
+
+# Contains source location information.
+class Location
+  attr_reader :name
+  attr_reader :path
+  attr_reader :lineno
+
+  # Initializes this object.
+  #
+  # @param caller_location [Thread::Backtrace::Location] the caller location
+  def initialize(caller_location)
+    if caller_location == nil
+      @name = 'unknown'
+      @path = 'unknown'
+      @lineno = 0
+    else
+      @name = caller_location.label
+      if @name.start_with?('Object#')
+        @name = caller_location.base_label
+      end
+      @path = caller_location.path || 'unknown'
+      @lineno = caller_location.lineno
+    end
+  end
+
+  # Returns a string representation of this object.
+  #
+  # @return [String] A string representation of this object
+  def to_s()
+      return "(Location){name: #{@name}, path: #{@path}, lineno: #{@lineno}"
+  end
+end

data/lib/debugtrace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DebugTrace
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/lib/debugtrace.rb

@@ -78,7 +78,6 @@ module DebugTrace
 
     return unless @@config.enabled?
 
-    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}")
@@ -86,12 +85,13 @@ module DebugTrace
 
   # Contains options to pass to the print method.
   class PrintOptions
-    attr_reader :reflection, :minimum_output_size, :minimum_output_length,
+    attr_reader :reflection, :string_as_bytes, :minimum_output_size, :minimum_output_length,
                 :output_size_limit, :output_length_limit, :reflection_limit
 
     # Initializes this object.
     #
     # @param reflection [TrueClass, FalseClass] use reflection if true
+    # @param string_as_bytes [TrueClass, FalseClass] print string as byte array 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 output_size_limit [Integer] Output limit of collection elements (overrides debugtarace.yml value)
@@ -99,6 +99,7 @@ module DebugTrace
     # @param reflection_limit [Integer] reflection limits when using reflection (overrides debugtarace.yml value)
     def initialize(
       reflection,
+      string_as_bytes,
       minimum_output_size,
       minimum_output_length,
       output_size_limit,
@@ -106,6 +107,7 @@ module DebugTrace
       reflection_limit
     )
       @reflection = reflection
+      @string_as_bytes = string_as_bytes
       @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
       @output_size_limit = output_size_limit == -1 ? DebugTrace.config.output_size_limit : output_size_limit
@@ -166,7 +168,7 @@ module DebugTrace
       when Module
         buff.append(value.name).no_break_append(' module')
       when String
-        value_buff = value.encoding == Encoding::ASCII_8BIT ?
+        value_buff = print_options.string_as_bytes ?
             to_string_bytes(value, print_options) : to_string_str(value, print_options)
         buff.append_buffer(value_buff)
       when DateTime, Time
@@ -540,13 +542,14 @@ module DebugTrace
   # @param name [String] a message if the value is not specified, otherwise the value name
   # @option value [Object] the value
   # @option reflection [TrueClass, FalseClass] use reflection if true
+  # @param string_as_bytes [TrueClass, FalseClass] print string as byte array 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 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,
+      reflection: false, string_as_bytes: 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
@@ -564,7 +567,7 @@ module DebugTrace
       else
         # with value
         print_options = PrintOptions.new(
-          reflection, minimum_output_size, minimum_output_length,
+          reflection, string_as_bytes, minimum_output_size, minimum_output_length,
           output_size_limit, output_length_limit, reflection_limit
         )
         @@last_log_buff = to_string(name, value, print_options)

metadata

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