debugtrace 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce8fe4113e5e6d49353414a4e204e96fd0bb18f303972a5e4aef48e0e7fa07d5
-  data.tar.gz: 0cdba9d53b9edbed09ef2ed76a76756abdc57fe5fbabd7ab886d06e3ab1d1623
+  metadata.gz: 7a1011528c478c032c1223c1fceb442bb32de6ba1ef40d9df2436b27718327c4
+  data.tar.gz: 5e11c1af69b68a0d8b380d7e4c09b703ad773ea43a23fb11cee1289827dfd926
 SHA512:
-  metadata.gz: cbdba0458650b624c0a7e6872c294f578e855fd3cb5d6e050ec4801a356a94fd29b3c3f5a00e01ef155860a8cde98e7b093c2f5f1b1cf5f0925c1904536e17d9
-  data.tar.gz: 34acc1fc0519aea58496c807f7716944696f596f2810d6403cee8c9e7b1184f29579420ab58cbe3a310d895e43ee9b351f90112c5d9154f71dfb5983075b58a1
+  metadata.gz: a74c1b4784462f0ebc6a6b40d55c9ebba4df3bd087ec5e421fecd8b0c79cdda06404fa7e5c914d83ddccd96b6aa3dadeef0d21b1f53a3164cbcf0c7932b86298
+  data.tar.gz: e6b556af241a5976d6e7731138cb48d3059ce90b0ec4b274d3844da134532ed0156280bb37d85ae7d03106d1ea855dd399723ba41546fbdd42b71221a41b65e1

data/lib/debugtrace/common.rb

@@ -30,6 +30,6 @@ module Common
         top_type_name == 'E' || top_type_name == 'O' ? 'an' : 'a'
       raise "Argument #{value_name} (=#{value_string}) must be #{a} #{type}"
     end
-    value
+    return value
   end
 end

data/lib/debugtrace/config.rb

@@ -62,10 +62,10 @@ 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)'
-    @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
+    @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
@@ -77,7 +77,7 @@ class Config
   # Returns true if logging is enabled, false otherwise.
   # @return true if logging is enabled, false otherwise
   def enabled?
-    @enabled
+    return @enabled
   end
 
   private
@@ -97,6 +97,6 @@ class Config
         Common.check_type("config[#{key}]", value, defalut_value.class)
       end
     end
-    value
+    return value
   end
 end

data/lib/debugtrace/log_buffer.rb

@@ -15,7 +15,7 @@ class LogBuffer
     attr_reader :nest_level, :log
 
     def to_s
-      "(LogBuffer.LevelAndLog){nest_level: #{@nest_level}, log: \"#{@log}\"}"
+      return "(LogBuffer.LevelAndLog){nest_level: #{@nest_level}, log: \"#{@log}\"}"
     end
   end
 
@@ -64,7 +64,7 @@ class LogBuffer
       @append_nest_level = nest_level
       @last_line += string
     end
-    self
+    return self
   end
 
   # Appends a string representation of the value.
@@ -72,7 +72,7 @@ class LogBuffer
   # @param value [Object] The value to append
   # @return LogBuffer: This object
   def no_break_append(value)
-    append(value, 0, true)
+    return append(value, 0, true)
   end
 
   # Appends lines of another LogBuffer.
@@ -90,23 +90,23 @@ class LogBuffer
       append(line.log, line.nest_level, index == 0 && separator != '')
       index += 1
     end
-    self
+    return self
   end
 
   # The length of the last line.
   def length
-    @last_line.length
+    return @last_line.length
   end
 
   # true if multiple line, false otherwise.
   def multi_lines?
-    @lines.length > 1 || @lines.length == 1 && length > 0
+    return @lines.length > 1 || @lines.length == 1 && length > 0
   end
 
   # A list of tuple of data indentation level && log string.
   def lines
     lines = @lines.dup
     lines << LevelAndLog.new(@nest_level, @last_line) if length > 0
-    lines
+    return lines
   end
 end

data/lib/debugtrace/loggers.rb

@@ -16,7 +16,7 @@ class LoggerBase
   # Returns a string representation of this object.
   # @return [String] A string representation of this object
   def to_s
-    "#{self.class.name}"
+    return "#{self.class.name}"
   end
 end
 
@@ -85,12 +85,13 @@ class RubyLogger
   def print(message)
     Common::check_type("message", message, String)
     @logger.log(Logger::Severity::DEBUG, message, 'DebugTrace-rb')
+    return message
   end
 
   # Returns a string representation of this object.
   # @return [String] A string representation of this object
   def to_s
-    "Ruby #{Logger.name} path: #{@config.log_path}"
+    return "Ruby #{Logger.name} path: #{@config.log_path}"
   end
 end
 
@@ -132,11 +133,12 @@ class FileLogger < LoggerBase
         file.puts "#{datetime_str} #{message}"
       }
     end
+    return message
   end
 
   # Returns 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}"
+    return "#{self.class.name} path: #{@log_path}, append: #{@append}"
   end
 end

data/lib/debugtrace/state.rb

@@ -5,46 +5,23 @@ require_relative 'common'
 # Have the trace state for a thread
 # @author Masato Kokubo
 class State
+  attr_reader :thread_id
+  attr_reader :nest_level
+  attr_reader :previous_nest_level
+
   def initialize(thread_id)
-    @thread_id = Common::check_type('thread_id', thread_id, Integer)
+    @thread_id = thread_id
     reset()
   end
 
-  # @return the thread id.
-  def thread_id
-    @thread_id
-  end
-
-  # @return the nest level.
-  def nest_level
-    @nest_level
-  end
-
-  # @return the previous nest level.
-  def previous_nest_level
-    @previous_nest_level
-  end
-
-  # @return the previous line count.
-  def previous_line_count
-    @previous_line_count
-  end
-
-  # Sets the previous line count.
-  # @param value the previous line count
-  def previous_line_count=(value)
-    @previous_line_count = Common::check_type('value', value, Integer)
-  end
-
   def reset
     @nest_level = 0
     @previous_nest_level = 0
-    @previous_line_count = 0
     @times = []
   end
 
   def to_s()
-      "(State){thread_id: #{@thread_id}, nest_level: #{@nest_level}, previous_nest_level: #{@previous_nest_level}, previous_line_count: #{@previous_line_count}, times: #{@times}}"
+      return "(State){thread_id: #{@thread_id}, nest_level: #{@nest_level}, previous_nest_level: #{@previous_nest_level}, times: #{@times}}"
   end
 
   # Ups the nest level.
@@ -54,6 +31,7 @@ class State
           @times.push(Time.now)
       end
       @nest_level += 1
+      return nil
   end
 
   #Downs the nest level.

data/lib/debugtrace/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module DebugTrace
-  VERSION = '0.2.4'
+  VERSION = '0.2.6'
 end

data/lib/debugtrace.rb

@@ -16,7 +16,7 @@ module DebugTrace
   @@config = nil
 
   def self.config
-    @@config
+    return @@config
   end
 
   # A Mutex for thread safety
@@ -59,8 +59,9 @@ module DebugTrace
 
     return unless @@config.enabled?
 
+    config_path = File.expand_path(@@config.config_path)
     @@logger.print("DebugTrace-rb #{DebugTrace::VERSION} on Ruby #{RUBY_VERSION}")
-    @@logger.print("  config file: #{@@config.config_path}")
+    @@logger.print("  config file: #{config_path}")
     @@logger.print("  logger: #{@@logger}")
   end
 
@@ -95,13 +96,13 @@ module DebugTrace
       @@state_hash[thread_id] = state
     end
 
-    state
+    return state
   end
 
   def self.get_indent_string(nest_level, data_nest_level)
     indent_str = @@config.indent_string * [[0, nest_level].max, @@config.maximum_indents].min
     data_indent_str = @@config.data_indent_string * [[0, data_nest_level].max, @@config.maximum_indents].min
-    indent_str + data_indent_str
+    return indent_str + data_indent_str
   end
 
   def self.to_string(name, value, print_options)
@@ -153,7 +154,7 @@ module DebugTrace
       buff.append_buffer(separator, value_buff)
     end
 
-    buff
+    return buff
   end
 
   def self.to_string_str(value, print_options)
@@ -163,12 +164,8 @@ module DebugTrace
     double_quote_buff = LogBuffer.new(@@config.maximum_data_output_width)
 
     if value.length >= @@config.minimum_output_length
-      single_quote_buff.no_break_append('(')
       single_quote_buff.no_break_append(format(@@config.length_format, value.length))
-      single_quote_buff.no_break_append(')')
-      double_quote_buff.no_break_append('(')
       double_quote_buff.no_break_append(format(@@config.length_format, value.length))
-      double_quote_buff.no_break_append(')')
     end
 
     single_quote_buff.no_break_append("'")
@@ -219,9 +216,7 @@ module DebugTrace
     double_quote_buff.no_break_append('"')
     single_quote_buff.no_break_append("'")
 
-    return double_quote_buff if has_single_quote && !has_double_quote
-
-    single_quote_buff
+    return has_single_quote && !has_double_quote ? double_quote_buff : single_quote_buff
   end
 
   def self.to_string_bytes(value, print_options)
@@ -236,11 +231,10 @@ module DebugTrace
     end
 
     if bytes_length >= @@config.minimum_output_length
-      buff.no_break_append(' ')
       buff.no_break_append(format(@@config.size_format, bytes_length))
     end
 
-    buff.no_break_append(') [')
+    buff.no_break_append('[')
 
     multi_lines = bytes_length >= @@config.bytes_count_in_line
 
@@ -283,7 +277,7 @@ module DebugTrace
     end
     buff.no_break_append(']')
 
-    buff
+    return buff
   end
 
   def self.to_string_reflection(value, print_options)
@@ -309,7 +303,7 @@ module DebugTrace
     end
     buff.no_break_append('}')
 
-    buff
+    return buff
   end
 
   def self.to_string_reflection_body(value, print_options)
@@ -333,7 +327,7 @@ module DebugTrace
       index += 1
     end
 
-    buff
+    return buff
   end
 
   def self.to_string_enumerable(values, print_options)
@@ -372,7 +366,7 @@ module DebugTrace
 
     buff.no_break_append(close_char)
 
-    buff
+    return buff
   end
 
   def self.to_string_enumerable_body(values, print_options)
@@ -406,7 +400,7 @@ module DebugTrace
 
     buff.no_break_append(':') if values.is_a?(Hash) && values.empty?
 
-    buff
+    return buff
   end
 
   def self.to_string_key_value(key, value, print_options)
@@ -422,11 +416,10 @@ module DebugTrace
     type_name = '' if %w[Array Hash Set].include?(type_name)
 
     if count >= @@config.minimum_output_size
-      type_name += ' ' unless type_name.empty?
       type_name += @@config.size_format % count
     end
 
-    type_name
+    return type_name
   end
 
   def self.has_to_s_method?(value)
@@ -507,7 +500,7 @@ module DebugTrace
       end
     end
 
-    value
+    return value
   end
 
   def self.enter
@@ -543,10 +536,10 @@ module DebugTrace
     end
   end
 
-  def self.leave
+  def self.leave(return_value = nil)
     @@thread_mutex.synchronize do
       print_start
-      return unless @@config.enabled?
+      return return_value unless @@config.enabled?
 
       state = current_state
 
@@ -567,6 +560,7 @@ module DebugTrace
       )
       @@last_log_buff.line_feed
       @@logger.print(get_indent_string(state.nest_level, 0) + @@last_log_buff.lines[0].log)
+      return return_value
     end
   end
 
@@ -579,6 +573,6 @@ module DebugTrace
       state = current_state
     end
 
-    "#{get_indent_string(state.nest_level, 0)}#{buff_string}"
+    return "#{get_indent_string(state.nest_level, 0)}#{buff_string}"
   end
 end

metadata

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