tldr 0.9.5 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6929795fbe4a33bf03bc8bb107a4902b6f125bfc879edf0ec0441b5ec7e5d7a5
-  data.tar.gz: 52df3f72b9fcd4dd046d5513fd1c0c1ce69a04a6559f3edfc2c50c58fb7aa073
+  metadata.gz: 29759fb49b03f109abea0bc89b863a8094b965784e6827772dae2e148b6b38fd
+  data.tar.gz: f511164ea7cfb2602fe242dbd0cb3cfa36fee656d89a38cede3eb09ae73ffaef
 SHA512:
-  metadata.gz: d065a84fd62ebc48fdac9223a615540c02b570172e4337c07e362dcdd8fec94037fbb64447b1099e127641c8909e0148f465252fc5f2e48c5d2af2128b5d4e28
-  data.tar.gz: cbfbaee9dbbbc6854d48c415f3818611f9b980527a0afb5ce7d032484edce9753bf902c0f737b44480e1717484e74fac96221cc2104844a96d2b1e9c2b5eaaf5
+  metadata.gz: 4a2760b9496cf063b295c08661004e24def945d219b45869ac731ab856b6370138d3bb53549ea7612110bf7ed8f9f565400413ef7b8c1084b2dce96d916aea86
+  data.tar.gz: 47d2fa8f8c3a32a4ee6eb730d097960d404f9eef5f406b07bf599049e391614f6b095be5222c181bb2d35cbf527f8bae86829edf8758cddccb49c0e4dc438967

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.10.1]
+
+* Fix 3.4 / Prism [#17](https://github.com/tendersearls/tldr/pull/17)
+
+## [0.10.0]
+
+* Add an option to print the stack traces of interrupted tests [#13](https://github.com/tendersearls/tldr/pull/13) by [@henrahmagix](https://github.com/henrahmagix)
+
 ## [0.9.5]
 
 * Fix warning when defining `setup`/`teardown` on TLDR class itself [#7](https://github.com/tendersearls/tldr/issues/7)

data/README.md

@@ -122,6 +122,8 @@ Usage: tldr [options] some_tests/**/*.rb some/path.rb:13 ...
         --no-dotfile                 Disable loading .tldr.yml dotfile
         --no-emoji                   Disable emoji in the output
     -v, --verbose                    Print stack traces for errors
+        --print-interrupted-test-backtraces
+                                     Print stack traces for interrupted tests
         --[no-]warnings              Print Ruby warnings (Default: true)
         --watch                      Run your tests continuously on file save (requires 'fswatch' to be installed)
         --yes-i-know                 Suppress TLDR report when suite runs over 1.8s

data/lib/tldr/argv_parser.rb

@@ -78,6 +78,10 @@ class TLDR
           options[:verbose] = verbose
         end
 
+        opts.on CONFLAGS[:print_interrupted_test_backtraces], "Print stack traces for interrupted tests" do |print_interrupted_test_backtraces|
+          options[:print_interrupted_test_backtraces] = print_interrupted_test_backtraces
+        end
+
         opts.on CONFLAGS[:warnings], "Print Ruby warnings (Default: true)" do |warnings|
           options[:warnings] = warnings
         end

data/lib/tldr/assertions.rb

@@ -241,7 +241,7 @@ class TLDR
       begin
         yield
       rescue NoMatchingPatternError => e
-        assert false, Assertions.msg(message) { "Expected pattern match: #{e.message}" }
+        assert false, Assertions.msg(message) { "Expected pattern to match, but NoMatchingPatternError was raised: #{e.message}" }
       end
     end
 
@@ -250,7 +250,7 @@ class TLDR
 
       begin
         yield
-        refute true, Assertions.msg(message) { "Expected pattern not to match, but NoMatchingPatternError was raised" }
+        refute true, Assertions.msg(message) { "Expected pattern not to match, but NoMatchingPatternError was not raised" }
       rescue NoMatchingPatternError
       end
     end

data/lib/tldr/reporters/default.rb

@@ -47,7 +47,7 @@ class TLDR
               "#{@icons.run} Completed #{test_results.size} of #{planned_tests.size} tests (#{((test_results.size.to_f / planned_tests.size) * 100).round}%) before running out of time.",
               (<<~WIP.chomp if wip_tests.any?),
                 #{@icons.wip} #{plural(wip_tests.size, "test was", "tests were")} cancelled in progress:
-                #{wip_tests.map { |wip_test| "  #{time_diff(wip_test.start_time, stop_time)}ms - #{describe(wip_test.test)}" }.join("\n")}
+                #{wip_tests.map { |wip_test| "  #{time_diff(wip_test.start_time, stop_time)}ms - #{describe(wip_test.test)}#{print_wip_backtrace(wip_test, indent: "    ") if @config.print_interrupted_test_backtraces}" }.join("\n")}
               WIP
               (<<~SLOW.chomp if test_results.any?),
                 #{@icons.slow} Your #{[10, test_results.size].min} slowest completed tests:
@@ -137,6 +137,12 @@ class TLDR
         "#{test.test_class}##{test.method_name} [#{location.locator}]"
       end
 
+      def print_wip_backtrace wip_test, indent: ""
+        return unless wip_test.backtrace_at_exit
+
+        "\n#{indent}Backtrace at the point of cancellation:\n#{indent}#{wip_test.backtrace_at_exit.join("\n#{indent}")}"
+      end
+
       def plural count, singular, plural = "#{singular}s"
         "#{count} #{(count == 1) ? singular : plural}"
       end

data/lib/tldr/ruby_util.rb

@@ -0,0 +1,32 @@
+class TLDR
+  module RubyUtil
+    def self.version
+      @version ||= Gem::Version.new(RUBY_VERSION)
+    end
+
+    def self.parsing_with_prism?
+      @parsing_with_prism ||= RubyVM::InstructionSequence.compile("").to_a[4][:parser] == :prism
+    end
+
+    def self.find_prism_def_node_for(method)
+      require "prism"
+
+      iseq = RubyVM::InstructionSequence.of(method).to_a
+      method_metadata = iseq[4]
+      method_name = iseq[5]
+
+      file_path, line_number = method.source_location
+      parse_prism_ast(file_path).breadth_first_search { |node|
+        node.type == :def_node &&
+          line_number == node.start_line &&
+          method_name == node.name.to_s &&
+          method_metadata[:code_location] == [node.start_line, node.start_column, node.end_line, node.end_column]
+      }
+    end
+
+    def self.parse_prism_ast(file_path)
+      @prism_ast = Thread.current[:prism_parse_results] ||= {}
+      @prism_ast[file_path] ||= Prism.parse(File.read(file_path)).value
+    end
+  end
+end

data/lib/tldr/runner.rb

@@ -20,6 +20,7 @@ class TLDR
           next if ENV["CI"] && !$stderr.tty?
           next if @run_aborted.true?
           @run_aborted.make_true
+          @wip.each(&:capture_backtrace_at_exit)
           reporter.after_tldr(plan.tests, @wip.dup, @results.dup)
           exit!(3)
         end
@@ -51,7 +52,7 @@ class TLDR
     def run_test test, config, plan, reporter
       e = nil
       start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC, :microsecond)
-      wip_test = WIPTest.new(test, start_time)
+      wip_test = WIPTest.new(test, start_time, Thread.current)
       @wip << wip_test
       runtime = time_it(start_time) do
         instance = test.test_class.new

data/lib/tldr/value/config.rb

@@ -3,6 +3,7 @@ class TLDR
     seed: "--seed",
     no_helper: "--no-helper",
     verbose: "--verbose",
+    print_interrupted_test_backtraces: "--print-interrupted-test-backtraces",
     reporter: "--reporter",
     helper_paths: "--helper",
     load_paths: "--load-path",
@@ -26,7 +27,7 @@ class TLDR
   PATH_FLAGS = [:paths, :helper_paths, :load_paths, :prepend_paths, :exclude_paths].freeze
   MOST_RECENTLY_MODIFIED_TAG = "MOST_RECENTLY_MODIFIED".freeze
   CONFIG_ATTRIBUTES = [
-    :paths, :seed, :no_helper, :verbose, :reporter,
+    :paths, :seed, :no_helper, :verbose, :print_interrupted_test_backtraces, :reporter,
     :helper_paths, :load_paths, :parallel, :names, :fail_fast, :no_emoji,
     :prepend_paths, :no_prepend, :exclude_paths, :exclude_names, :base_path,
     :no_dotfile, :warnings, :watch, :yes_i_know, :i_am_being_watched,
@@ -47,7 +48,7 @@ class TLDR
         revert_working_directory_change_because_itll_ruin_everything!(original_base_path)
       end
 
-      super(**args)
+      super
     end
 
     # These are for internal tracking and resolved at initialization-time
@@ -60,6 +61,7 @@ class TLDR
         seed: rand(10_000),
         no_helper: false,
         verbose: false,
+        print_interrupted_test_backtraces: false,
         reporter: Reporters::Default,
         parallel: true,
         names: [],
@@ -109,7 +111,7 @@ class TLDR
       end
 
       # Booleans
-      [:no_helper, :verbose, :fail_fast, :no_emoji, :no_prepend, :warnings, :yes_i_know, :i_am_being_watched].each do |key|
+      [:no_helper, :verbose, :print_interrupted_test_backtraces, :fail_fast, :no_emoji, :no_prepend, :warnings, :yes_i_know, :i_am_being_watched].each do |key|
         merged_args[key] = defaults[key] if merged_args[key].nil?
       end
 
@@ -201,7 +203,7 @@ class TLDR
           next warnings ? "--warnings" : "--no-warnings"
         end
 
-        if defaults[key] == self[key]
+        if defaults[key] == self[key] && (key != :seed || !seed_set_intentionally)
           next
         elsif self[key].is_a?(Array)
           self[key].map { |value| [flag, stringify(key, value)] }

data/lib/tldr/value/test.rb

@@ -8,14 +8,6 @@ class TLDR
       @location = Location.new(file, line)
     end
 
-    # Memoizing at call time, because re-parsing isn't free and isn't usually necessary
-    def end_line
-      @end_line ||= begin
-        test_method = SorbetCompatibility.unwrap_method(test_class.instance_method(method_name))
-        RubyVM::AbstractSyntaxTree.of(test_method).last_lineno
-      end
-    end
-
     # Test exact match starting line condition first to save us a potential re-parsing to look up end_line
     def covers_line? l
       line == l || (l >= line && l <= end_line)
@@ -24,5 +16,19 @@ class TLDR
     def group?
       false
     end
+
+    private
+
+    # Memoizing at call time, because re-parsing isn't free and isn't usually necessary
+    def end_line
+      @end_line ||= begin
+        test_method = SorbetCompatibility.unwrap_method(test_class.instance_method(method_name))
+        if RubyUtil.parsing_with_prism?
+          RubyUtil.find_prism_def_node_for(test_method)&.end_line || -1
+        else
+          RubyVM::AbstractSyntaxTree.of(test_method).last_lineno
+        end
+      end
+    end
   end
 end

data/lib/tldr/value/wip_test.rb

@@ -1,3 +1,9 @@
 class TLDR
-  WIPTest = Struct.new(:test, :start_time)
+  WIPTest = Struct.new(:test, :start_time, :thread) do
+    attr_reader :backtrace_at_exit
+
+    def capture_backtrace_at_exit
+      @backtrace_at_exit = thread&.backtrace
+    end
+  end
 end

data/lib/tldr/version.rb

@@ -1,3 +1,3 @@
 class TLDR
-  VERSION = "0.9.5"
+  VERSION = "0.10.1"
 end

data/lib/tldr.rb

@@ -11,6 +11,7 @@ require_relative "tldr/parallel_controls"
 require_relative "tldr/path_util"
 require_relative "tldr/planner"
 require_relative "tldr/reporters"
+require_relative "tldr/ruby_util"
 require_relative "tldr/runner"
 require_relative "tldr/skippable"
 require_relative "tldr/sorbet_compatibility"

data/script/upgrade

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -e
+
+bundle update
+
+cd example/a
+bundle update
+cd ../..
+
+cd example/b
+bundle update
+cd ../..
+
+cd example/c
+bundle update
+cd ../..
+
+cd example/d
+bundle update
+cd ../..

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tldr
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.10.1
 platform: ruby
 authors:
 - Justin Searls
 - Aaron Patterson
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-15 00:00:00.000000000 Z
+date: 2025-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: super_diff
@@ -39,7 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description:
 email:
 - searls@gmail.com
 - tenderlove@ruby-lang.org
@@ -73,6 +71,7 @@ files:
 - lib/tldr/reporters/base.rb
 - lib/tldr/reporters/default.rb
 - lib/tldr/reporters/icon_provider.rb
+- lib/tldr/ruby_util.rb
 - lib/tldr/runner.rb
 - lib/tldr/skippable.rb
 - lib/tldr/sorbet_compatibility.rb
@@ -89,14 +88,14 @@ files:
 - lib/tldr/watcher.rb
 - script/setup
 - script/test
-homepage: https://github.com/tenderlove/tldr
+- script/upgrade
+homepage: https://github.com/tendersearls/tldr
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/tenderlove/tldr
-  source_code_uri: https://github.com/tenderlove/tldr
-  changelog_uri: https://github.com/tenderlove/tldr/blob/main/CHANGELOG.md
-post_install_message:
+  homepage_uri: https://github.com/tendersearls/tldr
+  source_code_uri: https://github.com/tendersearls/tldr
+  changelog_uri: https://github.com/tendersearls/tldr/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -111,8 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: TLDR will run your tests, but only for 1.8 seconds.
 test_files: []