tldr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b1d2d2176a02f16901ea2c2c739fd576c46fd363e5ea79790718f58efadedba
-  data.tar.gz: 727de7ca74f16a4676636780e19abc1f7c9cd0d906b4577de1aa462039f6e8f5
+  metadata.gz: dff20d2ad060e8ac1b1219978e871b9dc06014186429371dd2de8e929c092b78
+  data.tar.gz: 5922e6fb5053898d5ff70162d9d542f759332db59f29cfbd89ab4aadfb7d5623
 SHA512:
-  metadata.gz: ca384136a4c9c1863f4f22916090f8c4f6f1836f3935495d0c0018d7fee48237c1ce9797ecc7e35739a14890893aa32a85b2159ceecc501959729f8bc2071543
-  data.tar.gz: 8580d4cf390cc8f15515e45f7354007bd3419bbbed0749ec9d0b574d52f96de4d8a8ec3966480d96a6c2e853a520964cb8e671b371407070d78d414f4c74c2a3
+  metadata.gz: 46165b260ba40d54acbc986258c9a7f94377960f05acaec34bba27b6dc16cde89a19884393b008d751f64c413d54c445a39202c493293f106fd7a2cbd32f06fa
+  data.tar.gz: 60785c5e4bb01cc804636c770b299e1c08b1f97165a1459a17e8de59a178df2267e04e9ffb9a98e95aa9fc698aeb26139094b79b20c035d72a6ffa7780d89aa7

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.0]
+
+- Add a rake task "tldr"
+## [0.1.1]
+
+- Improve Minitest compatibility by mixing in Assertions#capture_io
+- Fix whitespace in reporter
+
 ## [0.1.0]
 
 - Initial release

data/README.md

@@ -203,6 +203,28 @@ with these caveats:
   TLDR::Assertions::MinitestCompatibility` into the `TLDR` base class or
   individual test classes
 
+### Running TLDR with Rake
+
+TLDR ships with a [very](lib/tldr/rake.rb) minimal rake task that simply shells
+out to the `tldr` CLI. If you want to run TLDR with Rake, you can configure
+the test run by setting flags on an env var named `TLDR_OPTS` or else in
+the [.tldr.yml](#setting-defaults-in-tldryml).
+
+Here's an example Rakefile:
+
+```ruby
+require "standard/rake"
+require "tldr/rake"
+
+task default: [:tldr, "standard:fix"]
+```
+
+You could then run the task with:
+
+```
+$ TLDR_OPTS="--no-parallel" bundle exec rake tldr
+```
+
 ### How will I run all my tests in CI without the time bomb going off?
 
 TLDR will run all your tests in CI without the time bomb going off.

data/lib/tldr/assertions.rb

@@ -28,7 +28,7 @@ class TLDR
       SuperDiff::EqualityMatchers::Main.call(expected:, actual:)
     end
 
-    def self.capture_io
+    def capture_io
       captured_stdout, captured_stderr = StringIO.new, StringIO.new
 
       original_stdout, original_stderr = $stdout, $stderr
@@ -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 = Assertions.capture_io(&block)
+      actual_stdout, actual_stderr = capture_io(&block)
 
       if Regexp === expected_stderr
         assert_match expected_stderr, actual_stderr, "In stderr"

data/lib/tldr/backtrace_filter.rb

@@ -1,8 +1,6 @@
 class TLDR
   class BacktraceFilter
     BASE_PATH = __dir__.freeze
-    SORBET_RUNTIME_PATTERN = %r{sorbet-runtime.*[/\\]lib[/\\]types[/\\]private[/\\]}
-    CONCURRENT_RUBY_PATTERN = %r{concurrent-ruby.*[/\\]lib[/\\]concurrent-ruby[/\\]concurrent[/\\]}
 
     def filter backtrace
       return ["No backtrace"] unless backtrace
@@ -32,9 +30,7 @@ class TLDR
     end
 
     def internal? frame
-      frame.start_with?(BASE_PATH) ||
-        frame.match?(SORBET_RUNTIME_PATTERN) ||
-        frame.match?(CONCURRENT_RUBY_PATTERN)
+      frame.start_with?(BASE_PATH)
     end
   end
 

data/lib/tldr/rake.rb

@@ -0,0 +1,4 @@
+desc "Run tests with TLDR (use TLDR_OPTS or .tldr.yml to configure)"
+task :tldr do
+  fail unless system "#{"bundle exec " if defined?(Bundler)}tldr #{ENV["TLDR_OPTS"]}"
+end

data/lib/tldr/reporters/default.rb

@@ -73,10 +73,8 @@ class TLDR
         duration = time_diff @suite_start_time
         test_results = test_results.sort_by { |result| [result.test.location.file, result.test.location.line] }
 
-        @out.print "\n\n"
         @err.print summarize_failures(test_results).join("\n\n")
 
-        @out.print "\n\n"
         @out.print summarize_skips(test_results).join("\n")
 
         @out.print "\n\n"
@@ -102,7 +100,7 @@ class TLDR
         failures = results.select { |result| result.failing? }
         return failures if failures.empty?
 
-        ["Failing tests:"] + failures.map.with_index { |result, i| summarize_result result, i }
+        ["\n\nFailing tests:"] + failures.map.with_index { |result, i| summarize_result result, i }
       end
 
       def summarize_result result, index
@@ -119,7 +117,7 @@ class TLDR
         skips = results.select { |result| result.skip? }
         return skips if skips.empty?
 
-        ["Skipped tests:\n"] + skips.map { |result| "  - #{describe(result.test)}" }
+        ["\n\nSkipped tests:\n"] + skips.map { |result| "  - #{describe(result.test)}" }
       end
 
       def describe test, location = test.location

data/lib/tldr/version.rb

@@ -1,3 +1,3 @@
 class TLDR
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/script/setup

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

data/script/test

@@ -1,25 +1,14 @@
-#!/usr/bin/env ruby
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+#!/usr/bin/env bash
 
-require "tldr"
+set -e
 
-class FunTest < TLDR
-  def test_passes
-    assert true
-  end
+bundle exec rake
 
-  def test_false
-    assert false
-  end
+cd example/a
+bundle exec tldr | grep "😁😁"
+cd ../..
 
-  def test_hello
-    raise "💥"
-  end
-
-  def test_slow
-    skip
-    sleep 2
-  end
-end
-
-TLDR::Run.run(TLDR::Config.new(paths: []))
+cd example/b
+bundle exec ruby -Itest test/some_test.rb | grep "😁"
+bundle exec rake tldr | grep "😁"
+cd ../..

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tldr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Searls
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-25 00:00:00.000000000 Z
+date: 2023-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: super_diff
@@ -61,6 +61,7 @@ files:
 - lib/tldr/backtrace_filter.rb
 - lib/tldr/error.rb
 - lib/tldr/planner.rb
+- lib/tldr/rake.rb
 - lib/tldr/reporters.rb
 - lib/tldr/reporters/base.rb
 - lib/tldr/reporters/default.rb
@@ -76,8 +77,7 @@ files:
 - lib/tldr/value/test_result.rb
 - lib/tldr/value/wip_test.rb
 - lib/tldr/version.rb
-- script/parse
-- script/run
+- script/setup
 - script/test
 homepage: https://github.com/tenderlove/tldr
 licenses:
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: TLDR will run your tests, but only for 1.8 seconds.

data/script/parse

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-
-require "tldr"
-
-pp TLDR::ArgvParser.new.parse(ARGV).to_h

data/script/run

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-
-require "tldr"
-
-TLDR::Run.cli(ARGV)