im-lost 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38b1a5b729438621357238f12f64f1d397ee56e18174c2cc1ec60067dd0ab15e
-  data.tar.gz: 157e15bcf3c9e9539467347e9cac31b5ed40adf9953bc6ab28dab6d163907288
+  metadata.gz: 533f4f50596d5c6a55f674e813d7053d954a26864ea80c2e266f8c6bd92c00fd
+  data.tar.gz: 31a7bd884fabb3aba95789ff9771811300e3c7cb6e75ec3c762a394df603b2ed
 SHA512:
-  metadata.gz: 8ad0cc365f318ef0113d6f099618204b11ecd547a84d525893cc2691a59a5159594c8606de34bad9268867751708cf98f03102a1b0feefbab6cefa41c2436449
-  data.tar.gz: eb0a3abf3fffc2273593741c880c9aa5b4461d2b14877e324834216327d9ec427a80eaf2b075381df601b920477b50c8b95190c34ae9cc73fb3d1b25407aa4a1
+  metadata.gz: 4631c248cc8af2691d09651ed3a90b863f72ba6954e3c14172208ceb153e69b834e5f67c12555347fa474f2f97a44ad579f8ef85a6b5db4be07ea574b76a7f36
+  data.tar.gz: d1accd54c95db533220dd98a6a741380be91050568d16cbc3b6acdaef1ba147b98f2ad39f560b1613b7351c01dca4a44bafd4db46e7ef526b169e5821da68fc0

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Mike Blumtritt
+Copyright (c) 2024-2025 Mike Blumtritt
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -10,7 +10,7 @@ ImLost helps you by analyzing function calls of objects, informing you about exc
 
 ## Description
 
-If you like to undertsand method call details you get a call trace with `ImLost.trace`:
+If you like to understand method call details you get a call trace with `ImLost.trace`:
 
 ```ruby
 File.open('test.txt', 'w') do |file|

data/lib/im-lost/version.rb

@@ -2,5 +2,5 @@
 
 module ImLost
   # The version number of the gem.
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/lib/im-lost.rb

@@ -54,7 +54,7 @@ module ImLost
       return @output = value if defined?(value.<<)
       raise(
         NoMethodError,
-        "undefined method `<<' for an instance of #{
+        "undefined method '<<' for an instance of #{
           Kernel.instance_method(:class).bind(value).call
         }"
       )
@@ -73,18 +73,18 @@ module ImLost
     # @attribute [r] trace_calls
     # @return [Boolean] whether method calls will be traced
     #
-    def trace_calls = @trace_calls[0].enabled?
+    def trace_calls = @trace_calls.enabled?
 
     def trace_calls=(value)
       if value
-        @trace_calls.each(&:enable) unless trace_calls
+        @trace_calls.enable unless trace_calls
       elsif trace_calls
-        @trace_calls.each(&:disable)
+        @trace_calls.disable
       end
     end
 
     #
-    # Traces execptions raised within a given block.
+    # Traces exceptions raised within a given block.
     #
     # @example Trace exception and rescue handling
     #   ImLost.trace_exceptions do
@@ -101,7 +101,7 @@ module ImLost
     #   #   x RuntimeError: something went wrong!
     #   #     /examples/test.rb:4
     #
-    # @param with_locations [Boolean] wheter the locations should be included
+    # @param with_locations [Boolean] whether the locations should be included
     #   into the exception trace information
     # @yieldreturn [Object] return result
     #
@@ -118,19 +118,19 @@ module ImLost
     end
 
     #
-    # Enables/disables tracing of returned valuess of method calls.
+    # Enables/disables tracing of returned values of method calls.
     # This is enabled by default.
     #
     # @attribute [r] trace_results
     # @return [Boolean] whether return values will be traced
     #
-    def trace_results = @trace_results[0].enabled?
+    def trace_results = @trace_results.enabled?
 
     def trace_results=(value)
       if value
-        @trace_results.each(&:enable) unless trace_results
+        @trace_results.enable unless trace_results
       elsif trace_results
-        @trace_results.each(&:disable)
+        @trace_results.disable
       end
     end
 
@@ -259,7 +259,7 @@ module ImLost
     #
     # Inspect internal variables of a given object.
     #
-    # @note The dedictaed handling of `Fiber` is platform dependend!
+    # @note The dedicated handling of `Fiber` is platform dependent!
     #
     # @example Inspect current instance variables
     #   @a = 22
@@ -303,19 +303,18 @@ module ImLost
     # @return [Object] the given object
     #
     def vars(object)
-      out = Out.new
+      out = LineStore.new
       traced = @trace.delete(object)
       return _local_vars(out, object) if Binding === object
-      location = Kernel.caller_locations(1, 1)[0]
-      out << "* #{location.path}:#{location.lineno}"
+      out.location(Kernel.caller_locations(1, 1)[0])
       return _thread_vars(out, object) if Thread === object
-      return _fiber_vars(out, object) if @fiber_supported && Fiber === object
+      return _fiber_vars(out, object) if @fiber_support && Fiber === object
       return _instance_vars(out, object) if defined?(object.instance_variables)
       out << '  !!! unable to retrieve vars'
       object
     ensure
       @trace[traced] = traced if traced
-      out.flush(@output)
+      @output << out.to_s
     end
 
     private
@@ -329,10 +328,7 @@ module ImLost
       arg
     end
 
-    def _trace_all(args)
-      args.each { |arg| @trace[arg] = arg if _can_trace?(arg) }
-      args
-    end
+    def _trace_all(args) = args.each { @trace[_1] = _1 if _can_trace?(_1) }
 
     def _trace_b(arg)
       return yield(arg) if @trace.key?(arg) || !_can_trace?(arg)
@@ -390,14 +386,11 @@ module ImLost
       object
     end
 
-    def _thread_identifier(thread)
-      "#{THREAD_STATE[thread.status] || thread.status} Thread #{
-        if defined?(thread.native_thread_id)
-          thread.native_thread_id
-        else
-          thread.__id__
-        end
-      } #{thread.name}".rstrip
+    def _thread_identifier(thr)
+      state = thr.status
+      "#{state || (state.nil? ? 'aborted' : 'terminated')} Thread #{
+        defined?(thr.native_thread_id) ? thr.native_thread_id : thr.__id__
+      } #{thr.name}".rstrip
     end
   end
 
@@ -456,12 +449,12 @@ module ImLost
     def count = ids.size
 
     # @attribute [r] empty?
-    # @return [Boolean] wheter the timer store is empty or not
+    # @return [Boolean] whether the timer store is empty or not
     def empty? = ids.empty?
 
     # @attribute [r] ids
     # @return [Array<Integer>] IDs of all registered timers
-    def ids = (@ll.keys.keep_if { _1.is_a?(Integer) })
+    def ids = (@ll.keys.keep_if { Integer === _1 })
 
     #
     # Create and register a new named or anonymous timer.
@@ -487,7 +480,7 @@ module ImLost
     #
     def delete(*id_or_names)
       id_or_names.flatten.each do |id|
-        if id.is_a?(Integer)
+        if Integer === id
           del = @ll.delete(id)
           @ll.delete(del[0]) if del
         else
@@ -508,10 +501,10 @@ module ImLost
     #   identifier or name
     #
     def [](id_or_name)
-      time = self.class.now
-      timer = @ll[id_or_name.is_a?(Integer) ? id_or_name : id_or_name.to_s]
+      now = self.class.now
+      timer = @ll[Integer === id_or_name ? id_or_name : id_or_name.to_s]
       raise(ArgumentError, "not a timer - #{id_or_name.inspect}") unless timer
-      @cb[timer[0], Kernel.caller_locations(1, 1)[0], time - timer[1]]
+      @cb[timer[0], Kernel.caller_locations(1, 1)[0], (now - timer[1]).round(4)]
       timer.__id__
     end
 
@@ -528,125 +521,132 @@ module ImLost
       nil
     end
 
-    # @!visibility private
+    private
+
     def initialize(&block)
       @cb = block
       @ll = {}
     end
   end
 
-  class Out
+  class LineStore
     def initialize(*lines) = (@lines = lines)
+    def to_s = (@lines << nil).join("\n")
     def <<(str) = @lines << str
-    def location(loc) = @lines << "  #{loc.path}:#{loc.lineno}"
-    def flush(dev) = dev << (@lines << nil).join("\n")
+    def location(loc) = @lines << "* #{loc.path}:#{loc.lineno}"
+
+    def vars(kind, names)
+      return @lines << "  <no #{kind} defined>" if names.empty?
+      @lines << "  > #{kind}"
+      names.sort!.each { @lines << "    #{_1}: #{yield(_1).inspect}" }
+    end
+  end
+  private_constant :LineStore
 
-    def sig(prefix, info, args)
-      args = args.join(', ')
-      @lines << case info.self
+  class CCallLineStore < LineStore
+    def initialize(prefix, info, include_location)
+      @info = info
+      sig = "#{info.method_id}(#{args.join(', ')})"
+      case info.self
       when Class, Module
-        "#{prefix} #{info.self}.#{info.method_id}(#{args})"
+        super("#{prefix} #{info.self}.#{sig}")
       else
-        "#{prefix} #{info.defined_class}##{info.method_id}(#{args})"
+        super("#{prefix} #{info.defined_class}##{sig}")
       end
+      return unless include_location
+      loc = location
+      path = loc.path
+      path = path[10..-2] if path.start_with?('<internal:')
+      @lines << "  #{path}:#{loc.lineno}"
     end
 
-    def vars(kind, names)
-      return @lines << "  <no #{kind} defined>" if names.empty?
-      @lines << "  > #{kind}"
-      names.sort!.each { @lines << "    #{_1}: #{yield(_1).inspect}" }
+    def location = @info
+
+    def args
+      argc = -1
+      @info.parameters.map do |kind, _|
+        argc += 1
+        CARG_TYPE[kind] || "arg#{argc}"
+      end
     end
+
+    CARG_TYPE = {
+      rest: '*args',
+      keyrest: '**kwargs',
+      block: '&block'
+    }.compare_by_identity.freeze
   end
-  private_constant :Out
+  private_constant :CCallLineStore
 
-  ARG_SIG = { rest: '*', keyrest: '**', block: '&' }.compare_by_identity.freeze
-  NO_NAME = { :* => 1, :** => 1, :& => 1 }.compare_by_identity.freeze
-  THREAD_STATE = {
-    false => 'terminated',
-    nil => 'aborted'
-  }.compare_by_identity.freeze
-  private_constant :ARG_SIG, :NO_NAME, :THREAD_STATE
+  class RbCallLineStore < CCallLineStore
+    def initialize(prefix, info, include_location)
+      @ctx = info.binding
+      super
+      @ctx = nil
+    end
 
-  @trace = {}.compare_by_identity
-  @caller_locations = @exception_locations = true
-  @output = STDERR
+    def location
+      locations = @ctx.eval('caller_locations(7,3)')
+      unless locations[1].path.start_with?('<internal:prelude')
+        return locations[1]
+      end
+      locations[0].path.start_with?('<internal:') ? locations[0] : locations[2]
+    end
 
-  @timer = TimerStore.new { |title, location, time| @output << <<~TIMER_MSG }
-    T #{title}: #{time ? "#{time} sec." : 'created'}
-      #{location.path}:#{location.lineno}
-  TIMER_MSG
-  TimerStore.private_class_method(:new)
+    def args
+      @info.parameters.map do |kind, name|
+        next name if ARG_SKIP.key?(name)
+        "#{ARG_TYPE[kind]}#{@ctx.local_variable_get(name).inspect}"
+      end
+    end
 
-  @trace_calls = [
-    TracePoint.new(:c_call) do |tp|
-      next if !@trace.key?(tp.self) || tp.path == __FILE__
-      out = Out.new
-      out.sig('>', tp, tp.parameters.map { ARG_SIG[_1[0]] || '?' })
-      out.location(tp) if @caller_locations
-      out.flush(@output)
-    end,
-    TracePoint.new(:call) do |tp|
+    ARG_TYPE = { rest: :*, keyrest: :**, block: :& }.compare_by_identity.freeze
+    ARG_SKIP = ARG_TYPE.invert.compare_by_identity.freeze
+  end
+  private_constant :RbCallLineStore
+
+  @trace_calls =
+    TracePoint.new(:c_call, :call) do |tp|
       next if !@trace.key?(tp.self) || tp.path == __FILE__
-      ctx = tp.binding
-      out = Out.new
-      out.sig(
-        '>',
-        tp,
-        tp.parameters.map do |kind, name|
-          next name if NO_NAME.key?(name)
-          "#{ARG_SIG[kind]}#{ctx.local_variable_get(name).inspect}"
-        end
-      )
-      out.location(ctx.eval('caller_locations(4,1)')[0]) if @caller_locations
-      out.flush(@output)
+      klass = tp.event == :c_call ? CCallLineStore : RbCallLineStore
+      @output << klass.new('>', tp, @caller_locations).to_s
     end
-  ]
 
-  @trace_results = [
-    TracePoint.new(:c_return) do |tp|
+  @trace_results =
+    TracePoint.new(:c_return, :return) do |tp|
       next if !@trace.key?(tp.self) || tp.path == __FILE__
-      out = Out.new
-      out.sig('<', tp, tp.parameters.map { ARG_SIG[_1[0]] || '?' })
-      out.location(tp) if @caller_locations
+      klass = tp.event == :c_return ? CCallLineStore : RbCallLineStore
+      out = klass.new('<', tp, @caller_locations)
       out << "  = #{tp.return_value.inspect}"
-      out.flush(@output)
-    end,
-    TracePoint.new(:return) do |tp|
-      next if !@trace.key?(tp.self) || tp.path == __FILE__
-      ctx = tp.binding
-      out = Out.new
-      out.sig(
-        '<',
-        tp,
-        tp.parameters.map do |kind, name|
-          next name if NO_NAME.key?(name)
-          "#{ARG_SIG[kind]}#{ctx.local_variable_get(name).inspect}"
-        end
-      )
-      out.location(ctx.eval('caller_locations(4,1)')[0]) if @caller_locations
-      out << "  = #{tp.return_value.inspect}"
-      out.flush(@output)
+      @output << out.to_s
     end
-  ]
 
-  supported = RUBY_VERSION.to_f < 3.3 ? %i[raise] : %i[raise rescue]
+  exception_support = RUBY_VERSION.to_f < 3.3 ? %i[raise] : %i[raise rescue]
   @trace_exceptions =
-    TracePoint.new(*supported) do |tp|
+    TracePoint.new(*exception_support) do |tp|
       ex = tp.raised_exception
       mark, parent = tp.event == :rescue ? ['!', ex.cause] : 'x'
       ex = ex.inspect
-      out = Out.new("#{mark} #{ex[0] == '#' ? ex[2..-2] : ex}")
+      out = LineStore.new("#{mark} #{ex[0] == '#' ? ex[2..-2] : ex}")
       while parent
         ex = parent.inspect
         out << "  [#{ex[0] == '#' ? ex[2..-2] : ex}]"
         parent = parent.cause
       end
-      out.location(tp) if @exception_locations
-      out.flush(@output)
+      out << "  #{tp.path}:#{tp.lineno}" if @exception_locations
+      @output << out.to_s
     end
 
-  @fiber_supported =
-    !!(defined?(Fiber.current) && defined?(Fiber.current.storage))
+  @timer = TimerStore.new { |title, location, time| @output << <<~TIMER_MSG }
+    T #{title}: #{time ? "#{time} sec." : 'created'}
+      #{location.path}:#{location.lineno}
+  TIMER_MSG
+  TimerStore.private_class_method(:new)
+
+  @fiber_support = !!defined?(Fiber.current.storage)
 
+  @output = STDERR
+  @trace = {}.compare_by_identity
+  @caller_locations = @exception_locations = true
   self.trace_calls = self.trace_results = true
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: im-lost
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Mike Blumtritt
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2025-01-30 00:00:00.000000000 Z
 dependencies: []
 description: |
   If you have overlooked something again and don't really understand what
@@ -19,7 +18,6 @@ description: |
   ImLost helps you by analyzing function calls of objects, informing you
   about exceptions and logging your way through your code. In short, ImLost
   is your debugging helper!
-email:
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -42,7 +40,6 @@ metadata:
   bug_tracker_uri: https://github.com/mblumtritt/im-lost/issues
   documentation_uri: https://rubydoc.info/gems/im-lost
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -57,8 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.13
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Your debugging helper.
 test_files: []