tldr 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32f7b9dbcf9e09433eef762eaafe19804643aa543ac2c0a9599303ea2e960f25
-  data.tar.gz: 789c07fb2db1fad39b234976999b575a1bea27c4796a4d062a373df11d3716e5
+  metadata.gz: 4be82f4551acdf8d4312b512a1c12d2a857cb1d1420b4eebc6d7a74632eecd19
+  data.tar.gz: 8f10cecb4d4701fb24f84c36ec78f6b91fe4b381bcf6c86f02f2743f93b61a1f
 SHA512:
-  metadata.gz: 7975ec24ae3f080ed564666c5319928964c970794a740a21253551be1be9b945374394b2f860cdd8737151f8e21fdb0d592c126895dd02b91dd21c899824226a
-  data.tar.gz: b11f3c52624b63a7aa44eadd4f17aa662d134648d61eb55eb7124e7956d0b28f20a04545552f9af8710330ffa98c94e85cec87dc80715a532522ccdeb15a8b42
+  metadata.gz: 8262b1e6ee4fd4154d9c46d883d1d49b76026a3752b5d26a4ea520fa8b0c0b786019cb3c770b319bd22130c1f194883d02cefbb38b9f171a4571b91ab1793d5f
+  data.tar.gz: 125b89ee409f0080a61ceb00232464c455213223883ce10502742a90a825c0a208ed625e5608ecd585a26a900bc49dd8d6a1b49202a88684386c455d9eb313a0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.6.0]
+
+* When `dont_run_these_in_parallel!` and `run_these_together!` are called from a
+super class, gather subclasses' methods as well when the method is `nil`
+* Stop shelling out to `tldr` from our Rake task. Rescue `SystemExit` instead
+* Rename `Config#helper` to `Config#helper_paths`, which YAML config keys
+* Print Ruby warnings by default (disable with --no-warnings)
+
 ## [0.5.0]
 
 * Define your own Rake tasks with `TLDR::Task` and pass in a custom configuration

data/README.md

@@ -23,8 +23,8 @@ suite.
 
 Some stuff you might like:
 
-* A CLI that can run tests by line number(s) (e.g. `foo.rb:5 bar.rb:3:10`) and
-by names or patterns (e.g. `--name test_fail,test_error --name "/_\d/"`)
+* A CLI that can specify tests by line number(s) (e.g. `foo.rb:5 bar.rb:3:10`)
+and by names or patterns (e.g. `--name test_fail,test_error --name "/_\d/"`)
 * Everything is **parallel by default**, and seems pretty darn fast; TLDR
 also provides [several escape hatches to sequester tests that aren't thread-safe](#parallel-by-default-is-nice-in-theory-but-half-my-tests-are-failing-wat)
 * Surprisingly delightful color diff output when two things fail to equal one
@@ -112,8 +112,8 @@ Usage: tldr [options] some_tests/**/*.rb some/path.rb:13 ...
     -n, --name PATTERN               One or more names or /patterns/ of tests to run (like: foo_test, /test_foo.*/, Foo#foo_test)
         --exclude-name PATTERN       One or more names or /patterns/ NOT to run
         --exclude-path PATH          One or more paths NOT to run (like: foo.rb, "test/bar/**", baz.rb:3)
-        --helper HELPER              Path to a test helper to load before any tests (Default: "test/helper.rb")
-        --no-helper                  Don't try loading a test helper before the tests
+        --helper PATH                One or more paths to a helper that is required before any tests (Default: "test/helper.rb")
+        --no-helper                  Don't require any test helpers
         --prepend PATH               Prepend one or more paths to run before the rest (Default: most recently modified test)
         --no-prepend                 Don't prepend any tests before the rest of the suite
     -l, --load-path PATH             Add one or more paths to the $LOAD_PATH (Default: ["test"])
@@ -122,6 +122,7 @@ 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
+        --[no-]warnings              Print Ruby warnings (Default: true)
         --comment COMMENT            No-op comment, used internally for multi-line execution instructions
 ```
 
@@ -193,7 +194,7 @@ require "tldr/rake"
 
 TLDR::Task.new(name: :safe_tests, config: TLDR::Config.new(
   paths: FileList["safe/**/*_test.rb"],
-  helper: "safe/helper.rb",
+  helper_paths: ["safe/helper.rb"],
   load_paths: ["lib", "safe"]
 ))
 ```

data/lib/tldr/argv_parser.rb

@@ -35,11 +35,12 @@ class TLDR
           options[:exclude_paths] += path
         end
 
-        opts.on "#{CONFLAGS[:helper]} HELPER", String, "Path to a test helper to load before any tests (Default: \"test/helper.rb\")" do |helper|
-          options[:helper] = helper
+        opts.on "#{CONFLAGS[:helper_paths]} PATH", Array, "One or more paths to a helper that is required before any tests (Default: \"test/helper.rb\")" do |path|
+          options[:helper_paths] ||= []
+          options[:helper_paths] += path
         end
 
-        opts.on CONFLAGS[:no_helper], "Don't try loading a test helper before the tests" do
+        opts.on CONFLAGS[:no_helper], "Don't require any test helpers" do
           options[:no_helper] = true
         end
 
@@ -77,6 +78,10 @@ class TLDR
           options[:verbose] = verbose
         end
 
+        opts.on CONFLAGS[:warnings], "Print Ruby warnings (Default: true)" do |warnings|
+          options[:warnings] = warnings
+        end
+
         opts.on "--comment COMMENT", String, "No-op comment, used internally for multi-line execution instructions" do
           # See "--comment" in lib/tldr/reporters/default.rb for an example of how this is used internally
         end

data/lib/tldr/class_util.rb

@@ -0,0 +1,15 @@
+class TLDR
+  module ClassUtil
+    def self.gather_descendants root_klass
+      root_klass.subclasses + root_klass.subclasses.flat_map { |subklass|
+        gather_descendants subklass
+      }
+    end
+
+    def self.gather_tests klass
+      klass.instance_methods.grep(/^test_/).sort.map { |method|
+        Test.new klass, method
+      }
+    end
+  end
+end

data/lib/tldr/path_util.rb

@@ -1,6 +1,8 @@
 class TLDR
   module PathUtil
-    def self.expand_search_locations path_strings
+    def self.expand_paths path_strings, globs: true
+      path_strings = expand_globs path_strings if globs
+
       path_strings.flat_map { |path_string|
         File.directory?(path_string) ? Dir["#{path_string}/**/*.rb"] : path_string
       }.flat_map { |path_string|

data/lib/tldr/planner.rb

@@ -3,7 +3,8 @@ require "pathname"
 class TLDR
   class Planner
     def plan config
-      search_locations = PathUtil.expand_search_locations config.paths
+      $VERBOSE = config.warnings
+      search_locations = PathUtil.expand_paths config.paths, globs: false
 
       prepend_load_paths config
       require_test_helper config
@@ -33,16 +34,14 @@ class TLDR
     private
 
     def gather_tests
-      gather_descendants(TLDR).flat_map { |subklass|
-        subklass.instance_methods.grep(/^test_/).sort.map { |method|
-          Test.new subklass, method
-        }
+      ClassUtil.gather_descendants(TLDR).flat_map { |subklass|
+        ClassUtil.gather_tests(subklass)
       }
     end
 
     def prepend tests, config
       return tests if config.no_prepend
-      prepended_locations = PathUtil.expand_search_locations PathUtil.expand_globs config.prepend_paths
+      prepended_locations = PathUtil.expand_paths config.prepend_paths
       prepended, rest = tests.partition { |test|
         PathUtil.locations_include_test? prepended_locations, test
       }
@@ -54,7 +53,7 @@ class TLDR
     end
 
     def exclude_by_path tests, exclude_paths
-      excluded_locations = PathUtil.expand_search_locations PathUtil.expand_globs exclude_paths
+      excluded_locations = PathUtil.expand_paths exclude_paths
       return tests if excluded_locations.empty?
 
       tests.reject { |test|
@@ -102,8 +101,12 @@ class TLDR
     end
 
     def require_test_helper config
-      return if config.no_helper || config.helper.nil? || !File.exist?(config.helper)
-      require File.expand_path(config.helper, Dir.pwd)
+      return if config.no_helper || config.helper_paths.empty?
+      PathUtil.expand_paths(config.helper_paths).map(&:file).uniq.each do |helper_file|
+        next unless File.exist?(helper_file)
+
+        require helper_file
+      end
     end
 
     def require_tests search_locations
@@ -112,12 +115,6 @@ class TLDR
       end
     end
 
-    def gather_descendants root_klass
-      root_klass.subclasses + root_klass.subclasses.flat_map { |subklass|
-        gather_descendants subklass
-      }
-    end
-
     def expand_names_with_patterns names
       names.map { |name|
         if name.is_a?(String) && name =~ /^\/(.*)\/$/

data/lib/tldr/rake.rb

@@ -16,13 +16,17 @@ class TLDR
     def define name, task_config
       desc "Run #{name} tests (use TLDR_OPTS or .tldr.yml to configure)"
       task name do
-        cli_args = build_cli_args(task_config)
-        fail unless system "#{"bundle exec " if defined?(Bundler)}tldr #{cli_args}"
+        argv = Shellwords.shellwords(merge_env_opts(task_config).to_full_args)
+        begin
+          TLDR::Run.cli(argv)
+        rescue SystemExit => e
+          fail "TLDR task #{name} failed with status #{e.status}" unless e.status == 0
+        end
       end
     end
 
-    def build_cli_args task_config
-      config = if ENV["TLDR_OPTS"]
+    def merge_env_opts task_config
+      if ENV["TLDR_OPTS"]
         env_argv = Shellwords.shellwords(ENV["TLDR_OPTS"])
         opts_config = ArgvParser.new.parse(env_argv, {
           config_intended_for_merge_only: true
@@ -31,8 +35,6 @@ class TLDR
       else
         task_config
       end
-
-      config.to_full_args
     end
   end
 end

data/lib/tldr/reporters/default.rb

@@ -9,7 +9,8 @@ class TLDR
       def before_suite tests
         @suite_start_time = Process.clock_gettime Process::CLOCK_MONOTONIC, :microsecond
         @out.print <<~MSG
-          Command: #{tldr_command} #{@config.to_full_args}#{"\n#{@icons.seed} #{CONFLAGS[:seed]} #{@config.seed}" unless @config.seed_set_intentionally}
+          Command: #{tldr_command} #{@config.to_full_args}
+          #{@icons.seed} #{CONFLAGS[:seed]} #{@config.seed}
 
           #{@icons.run} Running:
 

data/lib/tldr/strategizer.rb

@@ -42,7 +42,7 @@ class TLDR
     # Sadly duplicative with Planner.rb, necessitating the extraction of PathUtil
     # Suboptimal, but we do indeed need to do this work in two places ¯\_(ツ)_/¯
     def partition_prepend thread_unsafe_tests, prepend_paths
-      locations = PathUtil.expand_search_locations PathUtil.expand_globs prepend_paths
+      locations = PathUtil.expand_paths prepend_paths
 
       thread_unsafe_tests.partition { |test|
         PathUtil.locations_include_test? locations, test

data/lib/tldr/value/config.rb

@@ -4,7 +4,7 @@ class TLDR
     no_helper: "--no-helper",
     verbose: "--verbose",
     reporter: "--reporter",
-    helper: "--helper",
+    helper_paths: "--helper",
     load_paths: "--load-path",
     parallel: "--[no-]parallel",
     names: "--name",
@@ -16,19 +16,22 @@ class TLDR
     exclude_names: "--exclude-name",
     base_path: "--base-path",
     no_dotfile: "--no-dotfile",
+    warnings: "--[no-]warnings",
     paths: nil
   }.freeze
 
-  PATH_FLAGS = [:paths, :helper, :load_paths, :prepend_paths, :exclude_paths].freeze
+  PATH_FLAGS = [:paths, :helper_paths, :load_paths, :prepend_paths, :exclude_paths].freeze
   MOST_RECENTLY_MODIFIED_TAG = "MOST_RECENTLY_MODIFIED".freeze
-
-  Config = Struct.new :paths, :seed, :no_helper, :verbose, :reporter,
-    :helper, :load_paths, :parallel, :names, :fail_fast, :no_emoji,
+  CONFIG_ATTRIBUTES = [
+    :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,
+    :no_dotfile, :warnings,
     # Internal properties
-    :config_intended_for_merge_only, :seed_set_intentionally, :cli_defaults,
-    keyword_init: true do
+    :config_intended_for_merge_only, :seed_set_intentionally, :cli_defaults
+  ].freeze
+
+  Config = Struct.new(*CONFIG_ATTRIBUTES, keyword_init: true) do
     def initialize(**args)
       unless args[:config_intended_for_merge_only]
         change_working_directory_because_i_am_bad_and_i_should_feel_bad!(args[:base_path])
@@ -60,20 +63,21 @@ class TLDR
         no_prepend: false,
         exclude_paths: [],
         exclude_names: [],
-        base_path: nil
+        base_path: nil,
+        warnings: true
       }
 
       if cli_defaults
         common.merge(
           paths: Dir["test/**/*_test.rb", "test/**/test_*.rb"],
-          helper: "test/helper.rb",
+          helper_paths: ["test/helper.rb"],
           load_paths: ["test"],
           prepend_paths: [MOST_RECENTLY_MODIFIED_TAG]
         )
       else
         common.merge(
           paths: [],
-          helper: nil,
+          helper_paths: [],
           load_paths: [],
           prepend_paths: []
         )
@@ -92,17 +96,17 @@ class TLDR
       defaults = Config.build_defaults(cli_defaults: merged_args[:cli_defaults])
 
       # Arrays
-      [:paths, :load_paths, :names, :prepend_paths, :exclude_paths, :exclude_names].each do |key|
+      [:paths, :helper_paths, :load_paths, :names, :prepend_paths, :exclude_paths, :exclude_names].each do |key|
         merged_args[key] = defaults[key] if merged_args[key].nil? || merged_args[key].empty?
       end
 
       # Booleans
-      [:no_helper, :verbose, :fail_fast, :no_emoji, :no_prepend].each do |key|
+      [:no_helper, :verbose, :fail_fast, :no_emoji, :no_prepend, :warnings].each do |key|
         merged_args[key] = defaults[key] if merged_args[key].nil?
       end
 
       # Values
-      [:seed, :reporter, :helper].each do |key|
+      [:seed, :reporter].each do |key|
         merged_args[key] ||= defaults[key]
       end
 
@@ -166,7 +170,7 @@ class TLDR
             # Don't print prepended tests if they're disabled
             next
           end
-        elsif key == :helper && no_helper
+        elsif key == :helper_paths && no_helper
           # Don't print the helper if it's disabled
           next
         elsif key == :parallel
@@ -176,6 +180,8 @@ class TLDR
             "--parallel"
           end
           next val
+        elsif key == :warnings && defaults[:warnings] != self[:warnings]
+          next warnings ? "--warnings" : "--no-warnings"
         end
 
         if defaults[key] == self[key]
@@ -231,6 +237,9 @@ class TLDR
       if dotfile_args.key?(:reporter)
         dotfile_args[:reporter] = Kernel.const_get(dotfile_args[:reporter])
       end
+      if (invalid_args = dotfile_args.except(*CONFIG_ATTRIBUTES)).any?
+        raise Error, "Invalid keys in .tldr.yml file: #{invalid_args.keys.join(", ")}"
+      end
 
       dotfile_args.merge(args)
     end

data/lib/tldr/value/test_group.rb

@@ -6,8 +6,8 @@ class TLDR
       @tests ||= configuration.flat_map { |(klass, method)|
         klass = Kernel.const_get(klass) if klass.is_a? String
         if method.nil?
-          klass.instance_methods.grep(/^test_/).sort.map { |method|
-            Test.new klass, method
+          ([klass] + ClassUtil.gather_descendants(klass)).flat_map { |klass|
+            ClassUtil.gather_tests(klass)
           }
         else
           Test.new klass, method

data/lib/tldr/version.rb

@@ -1,3 +1,3 @@
 class TLDR
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/tldr.rb

@@ -3,6 +3,7 @@ require "concurrent-ruby"
 require_relative "tldr/argv_parser"
 require_relative "tldr/assertions"
 require_relative "tldr/backtrace_filter"
+require_relative "tldr/class_util"
 require_relative "tldr/error"
 require_relative "tldr/parallel_controls"
 require_relative "tldr/parallelizer"
@@ -40,6 +41,8 @@ class TLDR
     def self.at_exit! config = Config.new
       # Ignore at_exit when running tldr CLI, since that will run any tests
       return if $PROGRAM_NAME.end_with? "tldr"
+      # Also ignore if we're running from within our rake task
+      return if caller.any? { |line| line.include? "lib/tldr/rake.rb" }
       # Ignore at_exit when we've already registered an at_exit hook
       return if @@at_exit_registered
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tldr
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Justin Searls
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-28 00:00:00.000000000 Z
+date: 2023-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: super_diff
@@ -59,6 +59,7 @@ files:
 - lib/tldr/assertions.rb
 - lib/tldr/assertions/minitest_compatibility.rb
 - lib/tldr/backtrace_filter.rb
+- lib/tldr/class_util.rb
 - lib/tldr/error.rb
 - lib/tldr/parallel_controls.rb
 - lib/tldr/parallelizer.rb