minitest-speed 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8d5602f0d650efd86b71dab5ab2c63df82040a0f
-  data.tar.gz: 15d624414639de4cbaf2191d38d36c36dfa5aa3d
+SHA256:
+  metadata.gz: 5a6b0f795c932b715c2243a9de667729d1d5bf6b2b1f04052f8ccf093a9063aa
+  data.tar.gz: e5d75d409294f742b3c24a8ca28aabf00160dd1260f2af0c904e29920583922b
 SHA512:
-  metadata.gz: 2f0bdabbfbe2cfc73ef78321949dc3b23122a7d02f88efa3dfc2bf2708bc228d51b19502fbd29e9c0af20dc2ac4a7b729d4c194423ab88345755392445ed98bd
-  data.tar.gz: ac90054eccc056b3481a5dbeeb7b2275f738a5e0ae9b99766cd9fc4b9599a42aac7593e0c989679e29a5e85a887ad05864b21e22717dbb8b634f6990870e3802
+  metadata.gz: 736554b62ac40be16ed7a7de8c1c490680491e4ff209c2cfe8d50af21b4e6a740e24a186a13dd3a87662663067219254d10340ace7b4e71fac10961943a66f82
+  data.tar.gz: 23531330c8d3843b11b1c4d112955a52581be7174297863464c38d85a0a0bc69f4be4eab2eed179fd728fcdd49c552e7b8d03d5f1469e71a7f37210c0bf4c2e0

data/History.rdoc

@@ -1,3 +1,23 @@
+=== 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.
+
 === 1.0.1 / 2016-10-09
 
 * 1 bug fix:
@@ -9,4 +29,3 @@
 * 1 major enhancement
 
   * Birthday!
-

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.1" # :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 = Time.now
+    @setup_t0 = Minitest::Speed.clock_time.call
   end
 
   def after_setup # :nodoc:
-    delta = Time.now - @setup_t0
+    delta = Minitest::Speed.clock_time.call - @setup_t0
 
-    @test_t0 = Time.now
+    @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,16 +67,61 @@ module Minitest::Speed
   def before_teardown # :nodoc:
     super
 
-    @teardown_t0 = Time.now
+    @teardown_t0 = Minitest::Speed.clock_time.call
+
+    delta = Minitest::Speed.clock_time.call - @test_t0
 
-    delta = Time.now - @test_t0
-    assert_operator delta, :<=, @@max_teardown_time
+    assert_operator delta, :<=, @@max_test_time, "max_test_time exceeded" unless @permit_slow_test
   end
 
   def after_teardown # :nodoc:
-    delta = Time.now - @teardown_t0
+    delta = Minitest::Speed.clock_time.call - @teardown_t0
+
+    assert_operator delta, :<=, @@max_teardown_time, "max_teardown_time exceeded" unless @permit_slow_teardown
 
-    assert_operator delta, :<=, @@max_teardown_time
     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

@@ -6,9 +6,9 @@ module TestMinitest; end
 class SpeedTest < Minitest::Test
   include Minitest::Speed
 
-  @@max_setup_time    = 0.01
-  @@max_test_time     = 0.01
-  @@max_teardown_time = 0.01
+  @@max_setup_time    = 0.005
+  @@max_test_time     = 0.015
+  @@max_teardown_time = 0.025
 
   def self.go(&b)
     Class.new(SpeedTest, &b).new(:test_something).run
@@ -16,14 +16,30 @@ class SpeedTest < Minitest::Test
 end
 
 class TestMinitest::TestSpeed < Minitest::Test
-  def assert_test_speed(&b)
+  def assert_slow(&b)
     refute_predicate SpeedTest.go(&b), :passed?
   end
 
+  def assert_fast(&b)
+    assert_predicate SpeedTest.go(&b), :passed?
+  end
+
+  def test_fast_setup
+    assert_fast do
+      def setup
+        sleep 0.001
+      end
+
+      def test_something
+        assert true
+      end
+    end
+  end
+
   def test_slow_setup
-    assert_test_speed do
+    assert_slow do
       def setup
-        sleep 0.1
+        sleep 0.01
       end
 
       def test_something
@@ -32,23 +48,94 @@ 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
+        sleep 0.01
+      end
+    end
+  end
+
   def test_slow_test
-    assert_test_speed do
+    assert_slow do
       def test_something
-        sleep 0.1
+        sleep 0.02
+      end
+    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
+        sleep 0.01
+      end
+
+      def test_something
+        assert true
       end
     end
   end
 
   def test_slow_teardown
-    assert_test_speed do
+    assert_slow do
+      def teardown
+        sleep 0.03
+      end
+
+      def test_something
+        assert true
+      end
+    end
+  end
+
+  def test_permit_slow_teardown
+    assert_fast do
       def teardown
-        sleep 0.1
+        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

metadata

@@ -1,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: minitest-speed
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan Davis
-autorequire: 
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDijCCAnKgAwIBAgIBATANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBCTANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTE2MDkyNjAxNTczNVoXDTE3MDkyNjAxNTczNVowRTETMBEGA1UE
+  GRYDY29tMB4XDTI1MDEwNjIzMjcwMVoXDTI2MDEwNjIzMjcwMVowRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -20,66 +19,71 @@ cert_chain:
   oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
   GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
-  gBEfoTEGr7Zii72cx+sCAwEAAaOBhDCBgTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
-  sDAdBgNVHQ4EFgQUR8V72Z3+v+2P9abCnL4wjx32T+EwIwYDVR0RBBwwGoEYcnlh
-  bmQtcnVieUB6ZW5zcGlkZXIuY29tMCMGA1UdEgQcMBqBGHJ5YW5kLXJ1YnlAemVu
-  c3BpZGVyLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEAIGzgp0aZ2W9+v96ujmBcQHoC
-  buy0iU68MVj2VlxMyfr1KPZIh1OyhU4UO4zrkREcH8ML70v9cYHNvOd9oynRHnvC
-  l2tj/fD3YJ0AEkJxGrYwRWQmvMfC4bJ02bC1+rVOUIXXKp3+cUmiN4sTniof8VFo
-  bo/YYP4c7erpERa+9hrqygg6WQbJlk2YRlH3JXPFjmu869i2dcbR5ZLOAeEy+axH
-  E4oJcnPkJAr0rw504JGtlZtONZQblwmRJOIdXzolaE3NRGUzGVOUSptZppAKiavY
-  fO6tdKQc/5RfA8oQEkg8hrxA5PQSz4TOFJGLpFvIapEk6tMruQ0bHgkhr9auXg==
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBCwUAA4IB
+  AQAC0WQJcPOWPFwkojhzweilRVjTJ19UiLhiBTw3C1wJO3LVdBkWDmnnhAmKuX4D
+  r7vjQvESlABGIPdutI1Yl7mrHQzTkfLfXvNN6MT0nLChPyIYauT6SZZxubwJrUfA
+  7R0c2CJTIboZ0XaGpLsXqHEF1c29H7TV1QvVuqKAN2mCjh4N82QVn+ZKtys28AwT
+  6GfQX2fqLoi4KSc7xIzHKaNzqxeOICmJofk9w5VZ2rRN6yes8jvFYwz9HR41wdj8
+  bwfinv7Yp5fA6AysuZLhCykyfDuZVRrUp0Vb68YCKsLjJly/Theak+euNTxvHsB+
+  al9oSgPPHICMEX65qvLywitx
   -----END CERTIFICATE-----
-date: 2016-10-09 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '7'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
+        version: '4.2'
 description: |-
   minitest-speed adds test hooks to verify the time it takes to run the
   setup, body, and teardown phases of each test. If the time of any
@@ -94,7 +98,7 @@ extra_rdoc_files:
 - Manifest.txt
 - README.rdoc
 files:
-- .autotest
+- ".autotest"
 - History.rdoc
 - Manifest.txt
 - README.rdoc
@@ -104,27 +108,25 @@ files:
 homepage: https://github.com/seattlerb/minitest-speed
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/seattlerb/minitest-speed
 rdoc_options:
-- --main
+- "--main"
 - README.rdoc
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+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