tldr 0.6.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82e76ebc309cbf643c22244a1674aa3a7ae32578006ce05fac262aec15292bec
-  data.tar.gz: 99610ebabba0d069f3618f6fa7cf79793c44491c4764463283e304fe329c7247
+  metadata.gz: 81e3d6734a718c5abbf80cfb088369d5a6bb89b81fc261020d97e34cbd6903bb
+  data.tar.gz: 1c4d0b5a53a948d868556b027f6fd6cdb4b9a96e67b459f0b2bf73e05a251d2f
 SHA512:
-  metadata.gz: de39822a1208f86b69a45ac1185d2c6de22462282a6fa2f59054e84bfa55b135f61279ae3b9be2f61463557a2a04516397bd02083a6c2c8a26c8e627875a44d1
-  data.tar.gz: ae0c0ed4ec84f2969a0b223a668351ce475536121fb59e2b56a4fbd7be18be844d5fec3aaf3d5ebfd5cf37ddb6a0a02afeef1f0e1f2f975c7d2796d322ab0ccb
+  metadata.gz: df9de67f0609adc2c5e0d2fc44a3bec44dd8a25a4ed0d128b8f1beaad6f45343dc9e5644e8d3b94b5bbe4db919f3becdf2e9a468a6eda0978669018135993d1f
+  data.tar.gz: 00e813b4947ef3d9e267e3ea4248def3254829b4b910719ad4cdd258cf809d751d7c5a539d527a708f9ff3471fe45fe24fc342d132f15948a56d7d5a56b38c7e

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.8.0]
+
+* Add a `--yes-i-know` flag that will suppress the large warning when your test
+suite runs over the 1.8s limit
+
+## [0.7.0]
+
+* Add a `tldt` alias for folks who have another executable named `tldr` on their
+paths
+* BREAKING: Reverse decision in 0.1.1 to capture_io on every TLDR subclass;
+moving back to the MinitestCompatibility mixin
+* Fix `assert_in_delta` defaultarg to retain Minitest compatibility
+* Add `mu_pp` to the MinitestCompatibility mixin
+
 ## [0.6.2]
 
 * Since TLDR runs fine on 3.1, reduce the gem requirement

data/README.md

@@ -123,7 +123,8 @@ Usage: tldr [options] some_tests/**/*.rb some/path.rb:13 ...
         --no-emoji                   Disable emoji in the output
     -v, --verbose                    Print stack traces for errors
         --[no-]warnings              Print Ruby warnings (Default: true)
-        --comment COMMENT            No-op comment, used internally for multi-line execution instructions
+        --yes-i-know                 Suppress TLDR report when suite runs over 1.8s
+        --comment COMMENT            No-op; used for multi-line execution instructions
 ```
 
 After being parsed, all the CLI options are converted into a
@@ -319,6 +320,14 @@ TLDR will run all your tests in CI without the time bomb going off. If
 `tldr` is run in a non-interactive shell and a `CI` environment variable is set
 (as it is on virtually every CI service), then the bomb will be defused.
 
+### What if I already have another `tldr` executable on my path?
+
+There's a [command-line utility named tldr](https://tldr.sh) that might conflict
+with this gem's binary in your PATH. If that's the case you could change your
+path, invoke `bundle exec tldr`, run [with Rake](#running-tldr-with-rake), or
+use the `tldt` ("too long; didn't test") executable alias that ships with this
+gem.
+
 ### Is there a plugin system?
 
 There is not.
@@ -328,12 +337,26 @@ with the `--reporter` command line option. It can be set to any fully-qualified
 class name that extends from
 [TLDR::Reporters::Base](/lib/tldr/reporters/base.rb).
 
+### I know my tests are over 1.8s, how do I suppress the huge output?
+
+Plenty of test suites are over 1.8s and having TLDR repeatedly print out the
+huge summary at the end of each test run can be distracting and make it harder
+to spot test failures. If you know your test suite is too slow, you can simply
+add the `--yes-i-know` flag
+
 ### What about mocking?
 
 TLDR is laser-focused on running tests, so it doesn't provide a built-in mocking
 facility. Might we interest you in a refreshing
 [mocktail](https://github.com/testdouble/mocktail), instead?
 
+### Contributing to TLDR
+
+If you want to submit PRs on this repo, please know that the code style is
+[Kirkland-style Ruby](https://mastodon.social/@searls/111137666157318482), where
+method definitions have parentheses omitted but parentheses are generally
+expected for method invocations.
+
 ## Acknowledgements
 
 Thanks to [George Sheppard](https://github.com/fuzzmonkey) for freeing up the

data/exe/tldt

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "tldr"
+
+TLDR::Run.cli(ARGV)

data/lib/tldr/argv_parser.rb

@@ -82,7 +82,11 @@ class TLDR
           options[:warnings] = warnings
         end
 
-        opts.on "--comment COMMENT", String, "No-op comment, used internally for multi-line execution instructions" do
+        opts.on CONFLAGS[:yes_i_know], "Suppress TLDR report when suite runs over 1.8s" do
+          options[:yes_i_know] = true
+        end
+
+        opts.on "--comment COMMENT", String, "No-op; used for multi-line execution instructions" do
           # See "--comment" in lib/tldr/reporters/default.rb for an example of how this is used internally
         end
       end.parse!(args)

data/lib/tldr/assertions/minitest_compatibility.rb

@@ -33,6 +33,23 @@ class TLDR
 
         assert receiver.__send__(method, *args), message
       end
+
+      def capture_io(&blk)
+        Assertions.capture_io(&blk)
+      end
+
+      def mu_pp obj
+        s = obj.inspect.encode(Encoding.default_external)
+
+        if String === obj && (obj.encoding != Encoding.default_external ||
+                              !obj.valid_encoding?)
+          enc = "# encoding: #{obj.encoding}"
+          val = "#    valid: #{obj.valid_encoding?}"
+          "#{enc}\n#{val}\n#{s}"
+        else
+          s
+        end
+      end
     end
   end
 end

data/lib/tldr/assertions.rb

@@ -28,7 +28,7 @@ class TLDR
       SuperDiff::EqualityMatchers::Main.call(expected:, actual:)
     end
 
-    def capture_io
+    def self.capture_io
       captured_stdout, captured_stderr = StringIO.new, StringIO.new
 
       original_stdout, original_stderr = $stdout, $stderr
@@ -85,7 +85,7 @@ class TLDR
       refute expected == actual, message
     end
 
-    def assert_in_delta expected, actual, delta, message = nil
+    def assert_in_delta expected, actual, delta = 0.001, message = nil
       difference = (expected - actual).abs
       message = Assertions.msg(message) {
         "Expected |#{expected} - #{actual}| (#{difference}) to be within #{delta}"
@@ -204,7 +204,7 @@ class TLDR
     def assert_output expected_stdout, expected_stderr, message = nil, &block
       assert_block "assert_output requires a block to capture output" unless block
 
-      actual_stdout, actual_stderr = capture_io(&block)
+      actual_stdout, actual_stderr = Assertions.capture_io(&block)
 
       if Regexp === expected_stderr
         assert_match expected_stderr, actual_stderr, "In stderr"

data/lib/tldr/reporters/default.rb

@@ -31,29 +31,31 @@ class TLDR
         end
       end
 
-      def time_diff start, stop = Process.clock_gettime(Process::CLOCK_MONOTONIC, :microsecond)
-        ((stop - start) / 1000.0).round
-      end
-
       def after_tldr planned_tests, wip_tests, test_results
         stop_time = Process.clock_gettime Process::CLOCK_MONOTONIC, :microsecond
 
         @out.print @icons.tldr
         @err.print "\n\n"
-        wrap_in_horizontal_rule do
-          @err.print [
-            "too long; didn't run!",
-            "#{@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
-            (<<~SLOW.chomp if test_results.any?),
-              #{@icons.slow} Your #{[10, test_results.size].min} slowest completed tests:
-              #{test_results.sort_by(&:runtime).last(10).reverse.map { |result| "  #{result.runtime}ms - #{describe(result.test)}" }.join("\n")}
-            SLOW
-            describe_tests_that_didnt_finish(planned_tests, test_results)
-          ].compact.join("\n\n")
+
+        if @config.yes_i_know
+          @err.print "🚨 TLDR! Display summary by omitting --yes-i-know"
+        else
+          wrap_in_horizontal_rule do
+            @err.print [
+              "too long; didn't run!",
+              "#{@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
+              (<<~SLOW.chomp if test_results.any?),
+                #{@icons.slow} Your #{[10, test_results.size].min} slowest completed tests:
+                #{test_results.sort_by(&:runtime).last(10).reverse.map { |result| "  #{result.runtime}ms - #{describe(result.test)}" }.join("\n")}
+              SLOW
+              describe_tests_that_didnt_finish(planned_tests, test_results),
+              "🙈 Suppress this summary with --yes-i-know"
+            ].compact.join("\n\n")
+          end
         end
 
         after_suite test_results
@@ -102,6 +104,10 @@ class TLDR
 
       private
 
+      def time_diff start, stop = Process.clock_gettime(Process::CLOCK_MONOTONIC, :microsecond)
+        ((stop - start) / 1000.0).round
+      end
+
       def summarize_failures results
         failures = results.select { |result| result.failing? }
         return failures if failures.empty?
@@ -138,7 +144,7 @@ class TLDR
         rule = @icons.alarm + "=" * 20 + " ABORTED RUN " + "=" * 20 + @icons.alarm
         @err.print "#{rule}\n\n"
         yield
-        @err.print "\n\n#{rule}\n\n"
+        @err.print "\n\n#{rule}"
       end
 
       def describe_tests_that_didnt_finish planned_tests, test_results
@@ -150,7 +156,7 @@ class TLDR
         failed_locators = consolidate failed, exclude: unrun_locators
         suggested_locators = unrun_locators + [
           ("--comment \"Also include #{plural failed.size, "test"} that failed:\"" if failed_locators.any?)
-        ] + failed_locators
+        ].compact + failed_locators
         <<~MSG
           #{@icons.rock_on} Run the #{plural unrun.size, "test"} that didn't finish:
             #{tldr_command} #{@config.to_full_args exclude: [:paths]} #{suggested_locators.join(" \\\n    ")}

data/lib/tldr/value/config.rb

@@ -17,6 +17,7 @@ class TLDR
     base_path: "--base-path",
     no_dotfile: "--no-dotfile",
     warnings: "--[no-]warnings",
+    yes_i_know: "--yes-i-know",
     paths: nil
   }.freeze
 
@@ -26,7 +27,7 @@ class TLDR
     :paths, :seed, :no_helper, :verbose, :reporter,
     :helper_paths, :load_paths, :parallel, :names, :fail_fast, :no_emoji,
     :prepend_paths, :no_prepend, :exclude_paths, :exclude_names, :base_path,
-    :no_dotfile, :warnings,
+    :no_dotfile, :warnings, :yes_i_know,
     # Internal properties
     :config_intended_for_merge_only, :seed_set_intentionally, :cli_defaults
   ].freeze
@@ -64,7 +65,8 @@ class TLDR
         exclude_paths: [],
         exclude_names: [],
         base_path: nil,
-        warnings: true
+        warnings: true,
+        yes_i_know: false
       }
 
       if cli_defaults
@@ -101,7 +103,7 @@ class TLDR
       end
 
       # Booleans
-      [:no_helper, :verbose, :fail_fast, :no_emoji, :no_prepend, :warnings].each do |key|
+      [:no_helper, :verbose, :fail_fast, :no_emoji, :no_prepend, :warnings, :yes_i_know].each do |key|
         merged_args[key] = defaults[key] if merged_args[key].nil?
       end
 

data/lib/tldr/version.rb

@@ -1,3 +1,3 @@
 class TLDR
-  VERSION = "0.6.2"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tldr
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Justin Searls
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: super_diff
@@ -45,6 +45,7 @@ email:
 - tenderlove@ruby-lang.org
 executables:
 - tldr
+- tldt
 extensions: []
 extra_rdoc_files: []
 files:
@@ -54,6 +55,7 @@ files:
 - README.md
 - Rakefile
 - exe/tldr
+- exe/tldt
 - lib/tldr.rb
 - lib/tldr/argv_parser.rb
 - lib/tldr/assertions.rb