tldr 0.9.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 661e0ea905baa7122eba59c8f5954a3228698a2972a3567447bca5d8e7478f7e
-  data.tar.gz: 15ca7a5c88ee2406952f760bfbb58143b37a2ba929d34183722a4eb2cb05d7ac
+  metadata.gz: 99a624f1917fbfcd057cf445c09e01c41dbbe9666d9e30219dae66ca63d2ae96
+  data.tar.gz: 19aa8844384432251b27c3303d714535f688b48ee1b0813eb3adaf22fdc8c094
 SHA512:
-  metadata.gz: 62b464ca2538db776cc6d8f3b664f465c230c1faff70196342ef48b04b98b5419bc4a43718cad80b159887c64f840816caaf79f8451baa8adea05f5424e2ab98
-  data.tar.gz: 1c7b685b900c2b47de3750c6e5ae4706853d9d1b8758cd514373e56dcfca580a40e9ca0bc7c391a52286acee9d25a1147673d86bdf4b95d14ae67e808146c4a9
+  metadata.gz: 92077e5052669276a18135bcb14fc04d70ba84d7b6af4d6c74afb234fb4fbbe21ff419ab3760ed0fc8a46feca6b7c15a7dd5ba11218168a41fcd3fc625f048c0
+  data.tar.gz: fc6e72b814928a0cf7b76a2586f495094932e0d0115361540bba8c172e1f2f09e647e6e1cc318d3646849325dc834ac55fc6e91a337091fa34ec2ffaacf937b4

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [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)
 
 ## [0.9.4]
 

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/hooks.rb

@@ -0,0 +1,9 @@
+class TLDR
+  module Hooks
+    def setup
+    end
+
+    def teardown
+    end
+  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/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,
@@ -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/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.4"
+  VERSION = "0.10.0"
 end

data/lib/tldr.rb

@@ -6,6 +6,7 @@ require_relative "tldr/backtrace_filter"
 require_relative "tldr/class_util"
 require_relative "tldr/error"
 require_relative "tldr/executor"
+require_relative "tldr/hooks"
 require_relative "tldr/parallel_controls"
 require_relative "tldr/path_util"
 require_relative "tldr/planner"
@@ -21,12 +22,7 @@ require_relative "tldr/watcher"
 class TLDR
   include Assertions
   include Skippable
-
-  def setup
-  end
-
-  def teardown
-  end
+  include Hooks
 
   module Run
     def self.cli argv

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tldr
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.0
 platform: ruby
 authors:
 - Justin Searls
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-14 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: super_diff
@@ -64,6 +64,7 @@ files:
 - lib/tldr/class_util.rb
 - lib/tldr/error.rb
 - lib/tldr/executor.rb
+- lib/tldr/hooks.rb
 - lib/tldr/parallel_controls.rb
 - lib/tldr/path_util.rb
 - lib/tldr/planner.rb
@@ -88,13 +89,13 @@ files:
 - lib/tldr/watcher.rb
 - script/setup
 - script/test
-homepage: https://github.com/tenderlove/tldr
+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
+  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
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: TLDR will run your tests, but only for 1.8 seconds.