nicetest 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca570cb158012e0e98984c7abf67f6aa92b2653bda115e6ce933287854ef269d
-  data.tar.gz: 551b0ba37750778871181487bae3f9c17d0a8dbb662d0e94b1967191c753483f
+  metadata.gz: e5039d33254ce5a534e39a585909dceefe1dd3bcc40dbbf406700b952f293264
+  data.tar.gz: 7a80a7e24b2d5ce333362f2b3ba929aa181e8112cd11dfec9a63799632f53a7a
 SHA512:
-  metadata.gz: 397a83bad37cedcce9c4804872c6d8f749ba3ded816e26767fa056260d6145e44373b2dd59409e55e1ddced29a3090dbe676adcb548b54c8b8f43a2dbc2970d9
-  data.tar.gz: 23d3fccdca0763553f62e9be37d60079d869aefa71c861c9518a9db1de2ff52496d5b100727ad7bd0d5a297fb768d0b9a1ac361e43f1f1c0f44c1d6209d76bcc
+  metadata.gz: 5ad2f7a6140d4a536bed67b234b66af9af985faa3f87b09aeda005ae71318b0f2d72a5af657a1edb79ff01913f0a02e1f7e7d736f0da8c98909076f9a5a60532
+  data.tar.gz: 6443e1ca210c7f3ad4bf19e06c3590baa59cb163fbae978c6315e87366ae20a1fb446f70dfe90b5c6d64037fa063680b4618a1ffc2b1e6350e208cf56dc6d2a4

checksums.yaml.gz.sig

@@ -1,2 +1,2 @@
-�C;�횦�6�zL`�v����z�_�G�s�
-��ԞR¼�a��2�xd���I7�ov
.��S���ddMk��e=Ť�R�CD��	V�+�@�.� q�T�ʥ�c��V��u{�f�D4
+0�l.┧@^��U�
m���KjO�@��;����Td�x��Fd@�},w<Ly�I�5g��
ʶ�{��nF�Ξ�{0�犫}��m����^����K��	�8�)#$���1�J��2y_�h9�1ф- El�a��7~^
+������

data/README.md

@@ -26,19 +26,35 @@ $ gem install nicetest
 # Go into a repo
 $ git clone https://github.com/Shopfy/liquid; cd liquid; bundle install
 
-# Run the tests
-$ nicetest --reporter doc test/integration/capture_test.rb
-Started with run options --reporter doc --seed 12874
+# Run a test
+❯ nicetest --reporter doc test/integration/capture_test.rb:14
+Started with run options --reporter doc --name=/CaptureTest#test_capture_with_hyphen_in_variable_name/ --seed 24518
 
 CaptureTest
-  test_increment_assign_score_by_bytes_not_characters             PASS (0.00s)
-  test_captures_block_content_in_variable                         PASS (0.00s)
-  test_capture_to_variable_from_outer_scope_if_existing           PASS (0.00s)
-  test_assigning_from_capture                                     PASS (0.00s)
   test_capture_with_hyphen_in_variable_name                       PASS (0.00s)
 
-Finished in 0.00123s
-5 tests, 5 assertions, 0 failures, 0 errors, 0 skips
+Finished in 0.00115s
+1 tests, 1 assertions, 0 failures, 0 errors, 0 skips
+
+# JUnit is easy
+❯ nicetest --reporter junit,progress                          
+Emptying /Users/ianks/Code/Shopify/liquid/tmp/nicetest/junit/1721874837
+Started with run options --reporter junit,progress --seed 36139
+
+  799/799: [================================================================================] 100% Time: 00:00:00, Time: 00:00:00
+Writing XML reports to /Users/ianks/Code/Shopify/liquid/tmp/nicetest/junit/1721874837
+
+Finished in 0.94625s
+799 tests, 1924 assertions, 0 failures, 0 errors, 0 skips
+
+# Filter by name
+❯ nicetest --name=/assign/ 
+Started with run options --name=/assign/ --seed 44734
+
+  33/33: [====================================================================================] 100% Time: 00:00:00, Time: 00:00:00
+
+Finished in 0.03157s
+33 tests, 69 assertions, 0 failures, 0 errors, 0 skips
 ```
 
 ### Add to project
@@ -86,6 +102,14 @@ task :test do
 end
 ```
 
+## Recognition
+
+- [minitest] for superb testing
+- [minitest-reporters] for the excellent reporting
+- [super_diff] for the pretty diffs
+- [prism] for the blissful parser
+- [pastel] for the pretty colors
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
@@ -95,3 +119,9 @@ https://github.com/ianks/nicetest.
 
 The gem is available as open source under the terms of the [MIT
 License](https://opensource.org/licenses/MIT).
+
+[minitest]: https://github.com/minitest/minitest
+[minitest-reporters]: https://github.com/minitest-reporters/minitest-reporters
+[super_diff]: https://github.com/mcmire/super_diff
+[prism]: https://github.com/ruby/prism
+[pastel]: https://github.com/piotrmurach/pastel

data/lib/minitest/nicetest_plugin.rb

@@ -6,14 +6,18 @@ require "nicetest"
 module Minitest
   class << self
     def plugin_nicetest_options(opts, options)
-      opts.banner = Nicetest::Cli::BANNER
-      ValidateMinitestFocus.apply!
+      opts.banner = ::Nicetest::Cli::BANNER
+      Nicetest::NicetestPlugin::ValidateMinitestFocus.apply!
     end
 
     def plugin_nicetest_init(_options)
       Minitest.backtrace_filter = Nicetest::BacktraceFilter.new
     end
+  end
+end
 
+module Nicetest
+  module NicetestPlugin
     module ValidateMinitestFocus
       class << self
         def apply!

data/lib/minitest/reporters_plugin.rb

@@ -1,25 +1,11 @@
 # frozen_string_literal: true
 
 module Minitest
-  module ReportersPlugin
-    MAPPING ||= {
-      "none" => ->(_options) { nil },
-      "default" => ->(options) { Minitest::Reporters::DefaultReporter.new(io: options[:io]) },
-      "spec" => ->(options) { Minitest::Reporters::SpecReporter.new(io: options[:io]) },
-      "doc" => ->(options) { MAPPING["spec"].call(options) },
-      "junit" => ->(options) {
-        ENV["MINITEST_REPORTERS_REPORTS_DIR"] ||= "tmp/nicetest/junit/#{Time.now.to_i}"
-        Minitest::Reporters::JUnitReporter.new(io: options[:io])
-      },
-      "progress" => ->(options) { Minitest::Reporters::ProgressReporter.new(io: options[:io]) },
-    }
-  end
-
   class << self
     def plugin_reporters_options(opts, options)
       options[:reporters] = ["progress"]
 
-      vals = Minitest::ReportersPlugin::MAPPING.keys.join(",")
+      vals = Nicetest::ReportersPlugin::MAPPING.keys.join(",")
       description = <<~DESC.strip
         The reporters to use for test output as comma-seperated list.
       DESC
@@ -27,7 +13,7 @@ module Minitest
       opts.on("-r", "--reporter #{vals}", Array, description) do |reporters|
         reporters = options[:reporters] + reporters if reporters == ["junit"]
 
-        is_subset = (reporters - Minitest::ReportersPlugin::MAPPING.keys).empty?
+        is_subset = (reporters - Nicetest::ReportersPlugin::MAPPING.keys).empty?
         raise OptionParser::InvalidArgument, "Invalid reporter: #{reporters.join(", ")}" unless is_subset
 
         options[:reporters] = reporters
@@ -40,10 +26,26 @@ module Minitest
       require "minitest/reporters"
 
       reporters = options[:reporters].map do |reporter|
-        ReportersPlugin::MAPPING.fetch(reporter).call(options)
+        Nicetest::ReportersPlugin::MAPPING.fetch(reporter).call(options)
       end.compact
 
       Minitest::Reporters.use!(reporters, ENV, Minitest.backtrace_filter) unless reporters.empty?
     end
   end
 end
+
+module Nicetest
+  module ReportersPlugin
+    MAPPING = {
+      "none" => ->(_options) { nil },
+      "default" => ->(options) { Minitest::Reporters::DefaultReporter.new(io: options[:io]) },
+      "spec" => ->(options) { Minitest::Reporters::SpecReporter.new(io: options[:io]) },
+      "doc" => ->(options) { MAPPING["spec"].call(options) },
+      "junit" => ->(options) {
+        ENV["MINITEST_REPORTERS_REPORTS_DIR"] ||= "tmp/nicetest/junit/#{Time.now.to_i}"
+        Minitest::Reporters::JUnitReporter.new(io: options[:io])
+      },
+      "progress" => ->(options) { Minitest::Reporters::ProgressReporter.new(io: options[:io]) },
+    }
+  end
+end

data/lib/minitest/superdiff_plugin.rb

@@ -12,13 +12,16 @@ module Minitest
       return if options[:no_superdiff]
 
       require "super_diff"
-      Minitest::Assertions.prepend(SuperdiffPlugin)
+      Minitest::Assertions.prepend(Nicetest::SuperdiffPlugin)
     end
   end
+end
 
+module Nicetest
   module SuperdiffPlugin
     module Helpers
       extend self
+
       def inspect_styled(obj, style, prefix: nil)
         obj = SuperDiff.inspect_object(obj, as_lines: false)
         SuperDiff::Core::Helpers.style(style, "#{prefix}#{obj}")
@@ -42,54 +45,54 @@ module Minitest
       exception.set_backtrace(e.backtrace)
       raise exception
     end
-  end
 
-  class AssertIncludesMessage
-    include SuperdiffPlugin::Helpers
+    class AssertIncludesMessage
+      include SuperdiffPlugin::Helpers
 
-    def initialize(collection:, item:)
-      @collection = collection
-      @item = item
-    end
+      def initialize(collection:, item:)
+        @collection = collection
+        @item = item
+      end
 
-    def to_s
-      return @to_s if defined?(@to_s)
+      def to_s
+        return @to_s if defined?(@to_s)
 
-      content = if (diff = optional_diff)
-        collection = inspect_styled(@collection, :expected)
-        item = inspect_styled(@item, :actual)
+        content = if (diff = optional_diff)
+          collection = inspect_styled(@collection, :expected)
+          item = inspect_styled(@item, :actual)
 
-        <<~OUTPUT.strip
-          Expected #{collection} to include #{item}, but it did not.
+          <<~OUTPUT.strip
+            Expected #{collection} to include #{item}, but it did not.
 
-          #{diff}
-        OUTPUT
-      else
-        expected = inspect_styled(@collection, :expected, prefix: "  Collection: ")
-        actual = inspect_styled(@item, :actual, prefix: "Missing item: ")
+            #{diff}
+          OUTPUT
+        else
+          expected = inspect_styled(@collection, :expected, prefix: "  Collection: ")
+          actual = inspect_styled(@item, :actual, prefix: "Missing item: ")
 
-        <<~OUTPUT.strip
-          Expected collection to include item but it did not.
+          <<~OUTPUT.strip
+            Expected collection to include item but it did not.
 
-          #{expected}
-          #{actual}
-        OUTPUT
-      end
+            #{expected}
+            #{actual}
+          OUTPUT
+        end
 
-      @to_s ||= content
-    end
+        @to_s ||= content
+      end
 
-    def optional_diff
-      case @collection
-      when Array, Set
-        collection_with_item = @collection + [@item].flatten(1)
-        basic_diff(@collection, collection_with_item)
+      def optional_diff
+        case @collection
+        when Array, Set
+          collection_with_item = @collection + [@item].flatten(1)
+          basic_diff(@collection, collection_with_item)
+        end
       end
-    end
 
-    def basic_diff(expected, actual)
-      content = SuperDiff.diff(expected, actual)
-      "\nDiff:\n\n#{content}"
+      def basic_diff(expected, actual)
+        content = SuperDiff.diff(expected, actual)
+        "\nDiff:\n\n#{content}"
+      end
     end
   end
 end

data/lib/nicetest/cli.rb

@@ -11,6 +11,7 @@ module Nicetest
     def initialize(argv)
       @argv = argv
       @logger = Logger.new($stderr)
+      adjust_load_path!
     end
 
     def run
@@ -26,7 +27,6 @@ module Nicetest
 
     def run_tests(cli_options = Opts.parse!(@argv))
       disable_autorun!
-      adjust_load_path!
 
       args = @argv.dup
       argv_test_files = select_file_args(args)
@@ -42,6 +42,10 @@ module Nicetest
         filters << name
       end
 
+      # Gross hack to allow for plugins to be loaded before we require the test files
+      Minitest.load_plugins unless args.delete("--no-plugins") || ENV["MT_NO_PLUGINS"]
+      processed_args = Minitest.process_args(args)
+
       required_files = argv_test_files.map do |pattern|
         file_or_dir, filter = finder.filter_for(pattern)
         filters << filter if filter && !cli_options.name
@@ -49,13 +53,29 @@ module Nicetest
       end
 
       @logger.fatal!("no test files found") if required_files.compact.empty?
-      args << "--name=/#{filters.to_a.join("|")}/" if filters.any?
+
+      if filters.any?
+        processed_args[:filter] = Regexp.union(*filters.map do |filter|
+          Regexp.new("^#{filter}$")
+        end)
+        processed_args[:args] = "#{processed_args[:args]} --name=/^#{processed_args[:filter].source}$/"
+      end
+
+      patch_minitest_process_args!(processed_args)
 
       Minitest.run(args)
     end
 
     private
 
+    def patch_minitest_process_args!(preprocessed)
+      original_process_args = Minitest.method(:process_args)
+      Minitest.define_singleton_method(:process_args) do |_input_args|
+        Minitest.define_singleton_method(:process_args, original_process_args)
+        preprocessed
+      end
+    end
+
     def fetch_dep_loadpaths(gemspec, seen = {})
       return [] if seen[gemspec.name]
 
@@ -87,6 +107,7 @@ module Nicetest
 
       loadpaths = fetch_dep_loadpaths(Gem.loaded_specs["nicetest"]).map { |path| "-I#{path}" }
       requires = ["-rnicetest"]
+      includes = ["-I#{dir}/test"]
       args_with_removed_leading_path = @argv.map do |arg|
         arg = arg.dup
         arg.delete_prefix!(dir)
@@ -102,6 +123,7 @@ module Nicetest
           RbConfig.ruby,
           *loadpaths,
           *requires,
+          *includes,
           "-e",
           "exit(Nicetest::Cli.new(ARGV).run_tests)",
           "--",
@@ -123,7 +145,7 @@ module Nicetest
 
     def select_file_args(args)
       args = args.dup
-      Minitest.instance_variable_set(:@extensions, Set.new) # Avoid double-loading plugins
+      Minitest.instance_variable_set(:@extensions, Set.new(Minitest.extensions)) # Avoid double-loading plugins
       Minitest.load_plugins unless args.delete("--no-plugins") || ENV["MT_NO_PLUGINS"]
       # this will remove all options from the args array
       temporarily_disable_optparse_callbacks { Minitest.process_args(args) }
@@ -131,14 +153,17 @@ module Nicetest
     end
 
     def glob_test_files(dir)
-      Dir.glob("#{dir}/**{,/*/**}/*_test.rb")
+      Dir[
+        "#{dir}/**/test_*.rb",
+        "#{dir}/**/*_{test,spec}.rb",
+      ]
     end
 
     def require_path_or_dir(path_or_dir)
       if path_or_dir.end_with?(".rb")
         [try_require(path_or_dir)]
       else
-        Dir.glob("#{path_or_dir}/**{,/*/**}/*_test.rb").map do |f|
+        glob_test_files(path_or_dir).map do |f|
           try_require(f)
         end
       end
@@ -159,7 +184,8 @@ module Nicetest
     end
 
     def adjust_load_path!
-      $LOAD_PATH.unshift(File.expand_path("test"))
+      $LOAD_PATH.unshift(File.expand_path("test")) unless @adjusted
+      @adjusted = true
     end
 
     def temporarily_disable_optparse_callbacks(&blk)
@@ -190,9 +216,8 @@ module Nicetest
               options[:cd] = dir
             end
 
-            opts.on("--version", "Show the version") do
-              puts "nicetest #{Nicetest::VERSION}"
-              exit
+            opts.on("-n", "--name=PATTERN", "Filter test names on pattern") do |pattern|
+              options[:name] = pattern
             end
           end
 

data/lib/nicetest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nicetest
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/nicetest.rb

@@ -8,6 +8,9 @@ require_relative "nicetest/logger"
 require_relative "nicetest/cli"
 require_relative "nicetest/backtrace_filter"
 require_relative "nicetest/test_finder"
+require_relative "minitest/nicetest_plugin"
+require_relative "minitest/reporters_plugin"
+require_relative "minitest/superdiff_plugin"
 
 module Nicetest
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nicetest
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ian Ker-Seymer
@@ -29,7 +29,7 @@ cert_chain:
   Lvd35BNvZkhFzs9xfykhurpkT2TiP2F3ZFn9dwLXMFe41pwrtEYLIWhYi8mUG4Ek
   6aR8M/tqIpChVV39
   -----END CERTIFICATE-----
-date: 2024-07-25 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest