im-lost 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 796abdca36d4d079d74289f0634dc097d346accafc3a57bdc67134bb92e6b6e7
-  data.tar.gz: a996b51a85a883f39becc17271ec0e079a64b51f3e5a187deffc1a0b18b6cd66
+  metadata.gz: 997bc0a130f9ac4aad8b517db8b2e1de8ff8d8720c88b6866105e8948e3ee563
+  data.tar.gz: 806757992aa14e484919b319c56f3fa694c4c52973b6b32cf925234ea145359c
 SHA512:
-  metadata.gz: d69fccba333bb177eae38483db1a4edfda2b3b2ec3ca5e7efe59701bfaa9ab0cda1ddd0d01339e8f3124330ccad73bce148de8054914e55af8e5880db650242d
-  data.tar.gz: 51b9f2f387f0e93309ce2fd7677627d0b1eb2b3764437a216441f1947e710d6646d519c6e0e1358a93c78709553fd385e71151dafc62f39a07f41b82ae5f056b
+  metadata.gz: 14ff2167f66b94d8ffc165dd973a0ca848c7f32818cfe521e2cc82e1a2c0a285e909ceadf6fbeee3c18947d3163264c0faa0d830522bbd81c7ae5fa5a55fc816
+  data.tar.gz: c06a25f0310464f1a9ce19ba137a3f6fc5cf644c6c0ac7d9ef421077f3dbb07658014503b411492caa6477cafbc57296ae6eab990aab837db4d009ed2ac4e02f

data/README.md

@@ -6,7 +6,7 @@ ImLost helps you by analyzing function calls of objects, informing you about exc
 
 - Gem: [rubygems.org](https://rubygems.org/gems/im-lost)
 - Source: [codeberg.org](https://codeberg.org/mblumtritt/im-lost)
-- Help: [rubydoc.info](https://rubydoc.info/gems/im-lost)
+- Help: [rubydoc.info](https://rubydoc.info/gems/im-lost/ImLost)
 
 ## Description
 

data/lib/im-lost/version.rb

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

data/lib/im-lost.rb

@@ -46,7 +46,7 @@ module ImLost
     #     ImLost.output = original
     #   end
     #
-    # @return [#puts] the output device
+    # @return [#<<] the output device
     #
     attr_reader :output
 
@@ -61,8 +61,8 @@ module ImLost
     end
 
     #
-    # @return [TimerStore] the timer store used to estimate the runtime of
-    #   your code
+    # @return [TimerStore]
+    #   the timer store used to estimate the runtime of your code
     #
     attr_reader :timer
 
@@ -101,8 +101,9 @@ module ImLost
     #   #   x RuntimeError: something went wrong!
     #   #     /examples/test.rb:4
     #
-    # @param with_locations [Boolean] whether the locations should be included
-    #   into the exception trace information
+    # @param with_locations [Boolean]
+    #   whether the locations should be included into the exception trace
+    #   information
     # @yieldreturn [Object] return result
     #
     def trace_exceptions(with_locations: true)
@@ -235,8 +236,8 @@ module ImLost
     #
     # @see trace
     #
-    # @param args [[]Object]] one or more objects which should not longer be
-    #   traced
+    # @param args [[]Object]]
+    #   one or more objects which should not longer be traced
     # @return [Array<Object>] the object(s) which are not longer be traced
     # @return [nil] when none of the objects was traced before
     #
@@ -319,17 +320,38 @@ module ImLost
       @output << out
     end
 
+    #
+    # Measure runtime of given block.
+    #
+    # @param title [#to_s] optional title to display
+    # @return [Object] the block's result
+    #
+    def time(title = nil, &block)
+      title &&= "#{title} "
+      if @caller_locations
+        loc = Kernel.caller_locations(1, 1)[0]
+        suffix = "  #{loc.path}:#{loc.lineno}\n"
+      end
+      unless block_given?
+        @output << "t #{title}#{TimerStore.now}\n#{suffix}"
+        return
+      end
+      t = TimerStore.now
+      begin
+        yield
+      ensure
+        t = (TimerStore.now - t).round(4)
+        @output << "R #{title}#{t} sec.\n#{suffix}  #{block.inspect}\n"
+      end
+    end
+
     private
 
     def _can_trace?(arg)
       (id = arg.__id__) != __id__ && id != @output.__id__
     end
 
-    def _trace(arg)
-      @trace[arg] = arg if _can_trace?(arg)
-      arg
-    end
-
+    def _trace(arg) = _can_trace?(arg) ? @trace[arg] = arg : arg
     def _trace_all(args) = args.each { @trace[_1] = _1 if _can_trace?(_1) }
 
     def _trace_b(arg)
@@ -375,8 +397,8 @@ module ImLost
         storage = fiber.storage || {}
         out.vars('fiber storage', storage.keys) { storage[_1] }
       else
-        out << '  !!! given Fiber is not the current Fiber' <<
-          "      #{fiber.inspect}"
+        out << '  !!! given Fiber is not the current Fiber'
+        out << "      #{fiber.inspect}"
       end
       fiber
     end
@@ -653,10 +675,10 @@ module ImLost
       @output << out.to_s
     end
 
-  @timer = TimerStore.new { |title, location, time| @output << <<~TIMER_MSG }
+  @timer = TimerStore.new { |title, location, time| @output << <<~MSG }
     T #{title}: #{time ? "#{time} sec." : 'created'}
       #{location.path}:#{location.lineno}
-  TIMER_MSG
+  MSG
   TimerStore.private_class_method(:new)
 
   untrace_all!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: im-lost
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -54,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 4.0.0
 specification_version: 4
 summary: Your debugging helper.
 test_files: []