maxitest 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e06cbb1ba436c88ea73dfd4b7dbb9120c6c792ca6567241f7f0021c47a3586c
-  data.tar.gz: 83e7039de6f6a61edcde5832e1b2852fdc908602eff7f838a01bfa6cb7accfba
+  metadata.gz: 9061b66cde59aa2093b1b9b0261c18d5134e64790936084086bcf4dd6ef9f954
+  data.tar.gz: cca38bde23d12a34db6c54dbd0f783eb8b568555fcdfa81aa259aaca1020af3c
 SHA512:
-  metadata.gz: d8004ce78125ad9cf96d3259a8924e92f18e45c4e53b7883ee112919b7124f21f417f0ab443cc36a09e85fa353f7949598ea09cf139fdae67ab0025c126d3314
-  data.tar.gz: aa0e90f8862c314d23f9043d932b757208324ce0f18c7fdf8af3d8f577e616a4b6e025c8b4b2d5b5f34e103c9478321ad7fbf539e6073a0f030f5f854e4b251e
+  metadata.gz: 0303fec9b3ca3f7f6fe419576beb0ebf9185f9bcd9850d386308ad2781bfa004138c2c01d77e7496b6a3516c1b783a0c5a7f0d8efe2b82cd4fabc45ad0135541
+  data.tar.gz: 80e22f71856fce5b79cf8e26fcf60887fce07f6934b4923cd9e1a0e7ab25c297c72ab3c98c7a6e54d343a8d91c3863e0ce3555caccbdf635a0a20c51e62e596c

data/README.md

@@ -22,6 +22,8 @@ Features
  - `pending { assert false }` is skip when it fails, but fails when it passes
  - implicit subject via `require 'maxitest/implicit_subject'`
  - `xit` to skip test (also does not call setup or teardown)
+ - `with_env` to change environment variables during test run
+ - `capture_stdout` and `capture_stderr` to capture stdout or stderr but not both (like `capture_io` does)
  - `require 'maxitest/timeout'` to make hanging tests fail after `Maxitest.timeout` seconds
  - `require 'maxitest/threads'` fail tests that leave extra threads running
  - `require 'maxitest/global_must'` (before autorun) disable deprecation on global `must_*` or [global_expectations](https://github.com/jeremyevans/minitest-global_expectations) gem
@@ -42,6 +44,11 @@ require "maxitest/autorun"
 ... normal tests ...
 ```
 
+### pending
+
+- `pending "need to fix" do` to show why something is pending 
+- `pending "need to fix", if: ENV["CI"] do` to only skip on CI (if something is supposed to work locally) 
+
 Development
 ===========
  - everything vendored into 1 gem to avoid dependency madness

data/lib/maxitest/autorun.rb

@@ -6,6 +6,7 @@ require "maxitest/let_bang"
 require "maxitest/let_all"
 require "maxitest/hook_all"
 require "maxitest/pending"
+require "maxitest/helpers"
 require "maxitest/xit"
 require "maxitest/static_class_order"
 require "maxitest/shorted_backtrace"
@@ -20,3 +21,8 @@ Minitest::Spec::DSL.send(:alias_method, :context, :describe)
 class << Minitest::Test
   alias_method :order_dependent!, :i_suck_and_my_tests_are_order_dependent!
 end
+
+# do not show maxitest as causing errors, but the last line in the users code
+old = MiniTest::BacktraceFilter::MT_RE
+MiniTest::BacktraceFilter.send(:remove_const, :MT_RE)
+MiniTest::BacktraceFilter::MT_RE = Regexp.union(old, %r%lib/maxitest%)

data/lib/maxitest/helpers.rb

@@ -0,0 +1,54 @@
+module Maxitest
+  module Helpers
+    module InstanceMethods
+      def with_env(env)
+        _synchronize do
+          old = ENV.to_h
+          env.each { |k, v| ENV[k.to_s] = v }
+          yield
+        ensure
+          ENV.replace old
+        end
+      end
+
+      # stripped down version of capture_io
+      def capture_stdout
+        _synchronize do
+          begin
+            captured_stdout = StringIO.new
+            orig_stdout = $stdout
+            $stdout = captured_stdout
+            yield
+            return captured_stdout.string
+          ensure
+            $stdout = orig_stdout
+          end
+        end
+      end
+
+      # stripped down version of capture_io
+      def capture_stderr
+        _synchronize do
+          begin
+            captured_stderr = StringIO.new
+            orig_stderr = $stderr
+            $stderr = captured_stderr
+            yield
+            return captured_stderr.string
+          ensure
+            $stderr = orig_stderr
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      def with_env(env)
+        around { |t| with_env(env, &t) }
+      end
+    end
+  end
+end
+
+Minitest::Test.send(:include, Maxitest::Helpers::InstanceMethods)
+Minitest::Test.send(:extend, Maxitest::Helpers::ClassMethods)

data/lib/maxitest/pending.rb

@@ -1,16 +1,16 @@
 module Maxitest
   module Pending
-    def pending(reason=nil)
-      if block_given?
-        begin
-          yield
-        rescue StandardError, Minitest::Assertion
-          skip reason
-        else
-          raise "Fixed"
-        end
+    def pending(reason=nil, **kwargs)
+      raise ArgumentError, "Need a block to execute" unless block_given?
+      raise ArgumentError, "Only :if option is supported" if (kwargs.keys | [:if] != [:if])
+      return yield if kwargs.fetch(:if, true) == false # allow user to for example mark test only pending on CI with `if: ENV["CI"]`
+
+      begin
+        yield # execute test
+      rescue StandardError, Minitest::Assertion
+        skip reason # test failed as expected
       else
-        raise ArgumentError, "Need a block to execute"
+        flunk "Test is fixed, remove `pending`"
       end
     end
   end

data/lib/maxitest/version.rb

@@ -1,3 +1,3 @@
 module Maxitest
-  VERSION = "5.2.0"
+  VERSION = "5.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maxitest
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2023-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -71,6 +71,7 @@ files:
 - lib/maxitest.rb
 - lib/maxitest/autorun.rb
 - lib/maxitest/global_must.rb
+- lib/maxitest/helpers.rb
 - lib/maxitest/hook_all.rb
 - lib/maxitest/implicit_subject.rb
 - lib/maxitest/let_all.rb