minitest-speed 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3428b035fe42f03dfdfa5ec731cbabeb3586b3beaa87c208103099fd80df7c03
-  data.tar.gz: 163aa55c499a09d57e200ea967bb7076a7006b77436c7e144eaf67f8030c18ac
+  metadata.gz: 5a6b0f795c932b715c2243a9de667729d1d5bf6b2b1f04052f8ccf093a9063aa
+  data.tar.gz: e5d75d409294f742b3c24a8ca28aabf00160dd1260f2af0c904e29920583922b
 SHA512:
-  metadata.gz: 6ab919c364c0feb38fafe73914a7fa32197aba01f2ca1d8a641afa2520fa0d13845d9e7af03c461754779b3dd8046f3b2bf8e3b97788042acc629541aa982f47
-  data.tar.gz: 53c1500e724d35152999bdae591d3c044f4d6e94675dacedc8c04c55a41910bd0180dd0355faaf8517a6f2f737f6e1c12658479f952c3753d478b9a0eab1fadc
+  metadata.gz: 736554b62ac40be16ed7a7de8c1c490680491e4ff209c2cfe8d50af21b4e6a740e24a186a13dd3a87662663067219254d10340ace7b4e71fac10961943a66f82
+  data.tar.gz: 23531330c8d3843b11b1c4d112955a52581be7174297863464c38d85a0a0bc69f4be4eab2eed179fd728fcdd49c552e7b8d03d5f1469e71a7f37210c0bf4c2e0

data/History.rdoc

@@ -1,7 +1,19 @@
+=== 1.1.0 / 2025-04-07
+
+* 3 minor enhancements:
+
+  * Added a message to the assertions to clarify which one fired. (HeyNonster)
+  * Added permit_slow_* methods to allow for disabling the speed checks. (HeyNonster)
+  * Allow for custom clock_time to be set. (HeyNonster)
+
 === 1.0.2 / 2025-01-06
 
 NINE YEARS!
 
+* 1 minor enhancement:
+
+  * Use Minitest.clock_time instead of Time.now for higher resolution when available.
+
 * 1 bug fix:
 
   * Fixed bug in max test time assertion.

data/lib/minitest/speed.rb

@@ -5,9 +5,21 @@ module Minitest; end # :nodoc:
 # and teardown phases of each test. If the time of any phase goes over
 # the maximum time, it fails the test. Use class variables to set the
 # maximum thresholds and crank it down over time.
+#
+#   class SpeedTest < Minitest::Test
+#     include Minitest::Speed
+#
+#     @@max_setup_time    = 0.01
+#     @@max_test_time     = 0.01
+#     @@max_teardown_time = 0.01
+#   end
+#
+#   class MyTest < SpeedTest
+#     # ...
+#   end
 
 module Minitest::Speed
-  VERSION = "1.0.2" # :nodoc:
+  VERSION = "1.1.0" # :nodoc:
 
   ##
   # Maximum setup time to pass a speed test. Default to 1.0 second.
@@ -24,18 +36,30 @@ module Minitest::Speed
 
   @@max_teardown_time = 1.0
 
+  mc = class << self; self; end # :nodoc:
+
+  ##
+  # Default way of getting the current time.
+  #
+  # Minitest::Speed.clock_time = proc { Minitest.clock_time }
+
+  mc.attr_accessor :clock_time
+
+  self.clock_time = -> { Minitest.clock_time }
+
+
   def before_setup # :nodoc:
     super
 
-    @setup_t0 = Minitest.clock_time
+    @setup_t0 = Minitest::Speed.clock_time.call
   end
 
   def after_setup # :nodoc:
-    delta = Minitest.clock_time - @setup_t0
+    delta = Minitest::Speed.clock_time.call - @setup_t0
 
-    @test_t0 = Minitest.clock_time
+    @test_t0 = Minitest::Speed.clock_time.call
 
-    assert_operator delta, :<=, @@max_setup_time
+    assert_operator delta, :<=, @@max_setup_time, "max_setup_time exceeded" unless @permit_slow_setup
 
     super
   end
@@ -43,18 +67,61 @@ module Minitest::Speed
   def before_teardown # :nodoc:
     super
 
-    @teardown_t0 = Minitest.clock_time
+    @teardown_t0 = Minitest::Speed.clock_time.call
 
-    delta = Minitest.clock_time - @test_t0
+    delta = Minitest::Speed.clock_time.call - @test_t0
 
-    assert_operator delta, :<=, @@max_test_time
+    assert_operator delta, :<=, @@max_test_time, "max_test_time exceeded" unless @permit_slow_test
   end
 
   def after_teardown # :nodoc:
-    delta = Minitest.clock_time - @teardown_t0
+    delta = Minitest::Speed.clock_time.call - @teardown_t0
 
-    assert_operator delta, :<=, @@max_teardown_time
+    assert_operator delta, :<=, @@max_teardown_time, "max_teardown_time exceeded" unless @permit_slow_teardown
 
     super
   end
+
+  ##
+  # Disable setup speed assertion for the current setup.
+  #
+  #   def setup
+  #     permit_slow_setup
+  #
+  #     slow_setup_thing
+  #
+  #     super
+  #   end
+
+  def permit_slow_setup
+    @permit_slow_setup = true
+  end
+
+  ##
+  # Disable test speed assertion for the current test.
+  #
+  #   def test_slow_thing
+  #     permit_slow_test
+  #
+  #     slow_thing
+  #   end
+
+  def permit_slow_test
+    @permit_slow_test = true
+  end
+
+  ##
+  # Disable teardown speed assertion for the current teardown.
+  #
+  #   def teardown
+  #     permit_slow_teardown
+  #
+  #     slow_teardown_thing
+  #
+  #     super
+  #   end
+
+  def permit_slow_teardown
+    @permit_slow_teardown = true
+  end
 end

data/test/test_minitest_speed.rb

@@ -48,6 +48,19 @@ class TestMinitest::TestSpeed < Minitest::Test
     end
   end
 
+  def test_permit_slow_setup
+    assert_fast do
+      def setup
+        permit_slow_setup
+        sleep 0.01
+      end
+
+      def test_something
+        assert true
+      end
+    end
+  end
+
   def test_fast_test
     assert_fast do
       def test_something
@@ -64,6 +77,15 @@ class TestMinitest::TestSpeed < Minitest::Test
     end
   end
 
+  def test_permit_slow_test
+    assert_fast do
+      def test_something
+        permit_slow_test
+        sleep 0.02
+      end
+    end
+  end
+
   def test_fast_teardown
     assert_fast do
       def teardown
@@ -87,4 +109,33 @@ class TestMinitest::TestSpeed < Minitest::Test
       end
     end
   end
+
+  def test_permit_slow_teardown
+    assert_fast do
+      def teardown
+        permit_slow_teardown
+        sleep 0.03
+      end
+
+      def test_something
+        assert true
+      end
+    end
+  end
+
+  def test_clock_time
+    clock_time_was = Minitest::Speed.clock_time
+    assert_fast do
+      Minitest::Speed.clock_time = proc { 0 }
+      def setup
+        sleep(0.03)
+      end
+
+      def test_something
+        assert true
+      end
+    end
+  ensure
+    Minitest::Speed.clock_time = clock_time_was
+  end
 end

data.tar.gz.sig

@@ -1 +1,2 @@
-jM(J�h�ci
+�m�*�NW�y�����`�{R��<�@�Y��:�-v<?>0��&y`���w%�D�{�"�]p��.Z�ǟ��%���E�
+�8���0K�o�;%�韣�CU�>��pꖧ4�9,���P���='� �x�Q,�0)�83a*�]�I\�1�AZ����q��

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-speed
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -28,7 +28,7 @@ cert_chain:
   bwfinv7Yp5fA6AysuZLhCykyfDuZVRrUp0Vb68YCKsLjJly/Theak+euNTxvHsB+
   al9oSgPPHICMEX65qvLywitx
   -----END CERTIFICATE-----
-date: 2025-01-06 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: minitest-speed adds test hooks to verify the time it takes to run the setup,
   body, and teardown phases of each test