minitest-gcstats 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e934b4bc7ea0b03bf24a93a559b430fedded0684
-  data.tar.gz: 10a52ed10df4f64515867a4174b5d7901af26060
+SHA256:
+  metadata.gz: 18da434e843b23c6fc0fa45a865681afeafad449b7cc53d80bdfcfbef4545900
+  data.tar.gz: 4cc273bbd7bbbfd43038fd046d24bb3e6f2f8192cc5bb0bdac015eb608c7bc73
 SHA512:
-  metadata.gz: c8bbd313972599e4c742574f6e4a8ebcdfd026f506f81c5d2cf8e2e8fa0494991f7d3a99827f391e0d32b1225f2b28e0c7d99b7f9cf2484e5d959047a894a476
-  data.tar.gz: 46229689d74458d2e28b0a6c733dc9b7f090f890a592fde75fb1b54edb192ad1456e94df427c9bef2ca9da8a44836b74736ed3d32237ef8ce85222c825bc2cb7
+  metadata.gz: 961cd9d0d7e9f4b3edd4c00c81db1b78e164de572e214c8a179a324ecea451debd912efc2890fbb2176938e2135296e1aac2ad9055b62b02ab2626c969bfbc9b
+  data.tar.gz: 27bc5c7c452a1fe2e95216224fc672552f8ca4e5d0d800ae0e44d5773648ce1c58a9dd53bcf9f6962a524f2f675f4c7dd76a67462fd418dfc9a11434b3860dd4

data/History.rdoc

@@ -1,3 +1,37 @@
+=== 1.3.0 / 2021-10-27
+
+This is release 1024!?!
+
+* 1 minor enhancement:
+
+  * Switched to prepending GCStats in and overriding run to record. Helps w/ 3.0.
+
+* 1 bug fix:
+
+  * MOSTLY Fixed testing for ruby 3.0, which allocates inline cache in GC
+
+=== 1.2.2 / 2016-06-13
+
+* 1 bug fix:
+
+  * Added minitest-proveit developer dependency to help with minitest/hell gauntlet.
+
+=== 1.2.1 / 2015-05-28
+
+* 1 bug fix:
+
+  * Remove deprecation warning in ruby 2.2. (filipegiusti)
+
+=== 1.2.0 / 2015-05-06
+
+* 1 minor enhancement:
+
+  * Added assert_allocations to verify the number of objects allocated in tests.
+
+* 1 bug fix:
+
+  * Fixed dependencies
+
 === 1.1.0 / 2014-09-26
 
 * 1 minor enhancement:

data/Rakefile

@@ -3,15 +3,21 @@
 require "rubygems"
 require "hoe"
 
-Hoe.plugin :isolate
 Hoe.plugin :seattlerb
 Hoe.plugin :rdoc
+Hoe.plugin :isolate
 
 Hoe.add_include_dirs "../../minitest/dev/lib"
 
 Hoe.spec "minitest-gcstats" do
   developer "Ryan Davis", "ryand-ruby@zenspider.com"
   license "MIT"
+
+  dependency "minitest", "~> 5.0"
+  dependency "rake", "< 11", :developer
+  dependency "minitest-proveit", "~> 1.0", :developer
+
+  multiruby_skip << '1.8'
 end
 
 # vim: syntax=ruby

data/lib/minitest/gcstats.rb

@@ -1,24 +1,35 @@
 require "minitest"
 
 module Minitest::GCStats
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 
   attr_accessor :gc_stats
 
   HASH = {}
 
   begin
-    GC.stat :total_allocated_object
-
-    def self.current
-      GC.stat :total_allocated_object
+    if GC.stat[:total_allocated_objects] then # ruby 2.2
+      def self.current
+        GC.stat :total_allocated_objects
+      end
+    else                                      # ruby 2.1
+      GC.stat :total_allocated_object         # force raise
+      def self.current
+        GC.stat :total_allocated_object
+      end
     end
   rescue TypeError
-    def self.current
+    def self.current                          # ruby 2.0
       GC.stat(HASH)[:total_allocated_object]
     end
   end
 
+  def run
+    r = super
+    r.gc_stats = self.gc_stats
+    r
+  end
+
   def before_setup
     super
     self.gc_stats = -Minitest::GCStats.current
@@ -30,6 +41,39 @@ module Minitest::GCStats
   end
 end
 
+class Minitest::Result
+  attr_accessor :gc_stats
+end
+
+Minitest::Test.prepend Minitest::GCStats
+
+module Minitest::Assertions
+  ##
+  # Assert that the number of object allocations during block
+  # execution is what you think it is. Uses +assert_operator+ so +op+
+  # should be something like :== or :<=. Defaults to :==.
+  #
+  #   assert_allocations 3 do ... end
+  #
+  # is equivalent to:
+  #
+  #   assert_allocations :==, 3 do ... end
+
+  def assert_allocations op_or_exp, exp = nil, msg = nil
+    m0 = Minitest::GCStats.current
+    yield
+    m1 = Minitest::GCStats.current
+
+    op = op_or_exp
+    op, exp, msg = :==, op, exp if Integer === op
+
+    act = m1 - m0
+    msg ||= "Object allocations"
+
+    assert_operator act, op, exp, msg
+  end
+end
+
 class Minitest::GCStatsReporter < Minitest::AbstractReporter
   attr_accessor :stats, :max
 

data/lib/minitest/gcstats_plugin.rb

@@ -13,7 +13,6 @@ module Minitest
     if @gcstats then
       require "minitest/gcstats"
       self.reporter << Minitest::GCStatsReporter.new(@gcstats)
-      Minitest::Test.send :include, Minitest::GCStats
     end
   end
 end

data/test/minitest/test_gcstats.rb

@@ -1,349 +1,105 @@
 require "minitest/autorun"
+require "minitest/gcstats"
+require "minitest/proveit"
 
 module TestMinitest; end
 
 class TestMinitest::TestGcstats < Minitest::Test
-  def test_empty
-    # 0 objects
-  end
-
-  def test_full
-    Object.new          # 1 object
-  end
-
-  def test_assert
-    assert :woot
-  end
-
-  def test_assert_bad
-    assert nil
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_assert_empty
-    assert_empty []
-  end
-
-  def test_assert_empty_bad
-    assert_empty [42]
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_assert_equal
-    assert_equal :a, :a
-  end
-
-  def test_assert_equal_bad
-    assert_equal :a, :b
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_assert_in_delta
-    assert_in_delta 1.0, 1.0001
-  end
-
-  def test_assert_in_delta_bad
-    assert_in_delta 1.0, 1.1
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_assert_in_epsilon
-    assert_in_epsilon 1.0, 1.001
-  end
-
-  def test_assert_in_epsilon_bad
-    assert_in_epsilon 1.0, 1.1
-  rescue Minitest::Assertion
-    # do nothing
-  end
+  self.prove_it = false
 
-  def test_assert_includes
-    assert_includes [:a, :woot, :c], :woot
+  def util_n_times_full n
+    n.times { test_full }
   end
 
-  def test_assert_includes_bad
-    assert_includes [:a, :woot, :c], :b
-  rescue Minitest::Assertion
-    # do nothing
+  def util_array
+    [test_full]
   end
 
-  def test_assert_instance_of
-    assert_instance_of Symbol, :woot
-  end
-
-  def test_assert_instance_of_bad
-    assert_instance_of Array, :woot
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_assert_kind_of
-    assert_kind_of Symbol, :woot
-  end
-
-  def test_assert_kind_of_bad
-    assert_kind_of Array, :woot
-  rescue Minitest::Assertion
-    # do nothing
-  end
+  def setup
+    util_n_times_full 1 # warm
 
-  def test_assert_match
-    assert_match(/woot/, "woot")
-  end
-
-  def test_assert_match_bad
-    assert_match(/woot/, "blah")
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_assert_nil
-    assert_nil nil
-  end
-
-  def test_assert_nil_bad
-    assert_nil true
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_assert_operator
-    assert_operator [:a], :include?, :a
-  end
-
-  def test_assert_operator_bad
-    assert_operator [:b], :include?, :a
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_assert_output
-    assert_output "woot\n" do
-      puts "woot"
+    assert_allocations :<, 99 do
+       # warm it up
     end
   end
 
-  def test_assert_output_bad
-    assert_output "woot" do
-      # do nothing
-    end
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_assert_predicate
-    assert_predicate "", :empty?
+  def test_empty
+    # 0 objects
   end
 
-  def test_assert_predicate_bad
-    assert_predicate "woot", :empty?
-  rescue Minitest::Assertion
-    # do nothing
+  def test_full
+    Object.new          # 1 object
   end
 
-  def test_assert_raises
-    assert_raises RuntimeError do
-      raise "woot"
+  def test_assert_allocations
+    assert_allocations 1 do
+      test_full
     end
   end
 
-  def test_assert_raises_bad
-    assert_raises RuntimeError do
-      # do nothing
+  def test_assert_allocations_0
+    assert_allocations 0 do
+      # nothing
     end
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_assert_respond_to
-    assert_respond_to :a, :empty?
-  end
-
-  def test_assert_respond_to_bad
-    assert_respond_to :a, :full?
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_assert_same
-    assert_same :a, :a
-  end
-
-  def test_assert_same_bad
-    assert_same :a, :b
-  rescue Minitest::Assertion
-    # do nothing
   end
 
-  def test_assert_silent
-    assert_silent do
-      # do nothing
+  def test_assert_allocations_multi
+    assert_allocations 3 do
+      util_n_times_full 3
     end
   end
 
-  def test_assert_silent_bad
-    assert_silent do
-      puts "woot"
+  def test_assert_allocations_multi_eq
+    assert_allocations :==, 3 do
+      util_n_times_full 3
     end
-  rescue Minitest::Assertion
-    # do nothing
   end
 
-  def test_assert_throws
-    assert_throws :woot do
-      throw :woot
+  def test_assert_allocations_neg_lt
+    assert_allocations :<=, 3 do
+      util_n_times_full 2
     end
   end
 
-  def test_assert_throws_bad
-    assert_throws :woot do
-      # do nothing
+  def test_assert_allocations_neg_eq
+    assert_allocations :<=, 3 do
+      util_n_times_full 3
     end
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_refute
-    refute false
-  end
-
-  def test_refute_bad
-    refute true
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_refute_empty
-    refute_empty [:a]
-  end
-
-  def test_refute_empty_bad
-    refute_empty []
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_refute_equal
-    refute_equal :a, :b
-  end
-
-  def test_refute_equal_bad
-    refute_equal :a, :a
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_refute_in_delta
-    refute_in_delta 1.0, 1.1
-  end
-
-  def test_refute_in_delta_bad
-    refute_in_delta 1.0, 1.0001
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_refute_in_epsilon
-    refute_in_epsilon 1.0, 1.1
-  end
-
-  def test_refute_in_epsilon_bad
-    refute_in_epsilon 1.0, 1.001
-  rescue Minitest::Assertion
-    # do nothing
   end
 
-  def test_refute_includes
-    refute_includes [:a, :woot, :c], :b
-  end
-
-  def test_refute_includes_bad
-    refute_includes [:a, :woot, :c], :woot
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_refute_instance_of
-    refute_instance_of Array, :a
-  end
-
-  def test_refute_instance_of_bad
-    refute_instance_of Symbol, :a
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_refute_kind_of
-    refute_kind_of Array, :woot
-  end
-
-  def test_refute_kind_of_bad
-    refute_kind_of Symbol, :woot
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_refute_match
-    refute_match(/woot/, "blah")
-  end
-
-  def test_refute_match_bad
-    refute_match(/woot/, "woot")
-  rescue Minitest::Assertion
-    # do nothing
-  end
+  def assert_triggered expected, klass = Minitest::Assertion
+    e = assert_raises klass do
+      yield
+    end
 
-  def test_refute_nil
-    refute_nil true
-  end
+    msg = e.message.sub(/(---Backtrace---).*/m, '\1')
+    msg.gsub!(/\(oid=[-0-9]+\)/, "(oid=N)")
+    msg.gsub!(/(\d\.\d{6})\d+/, '\1xxx') # normalize: ruby version, impl, platform
 
-  def test_refute_nil_bad
-    refute_nil nil
-  rescue Minitest::Assertion
-    # do nothing
+    assert_equal expected, msg
   end
 
-  def test_refute_operator
-    refute_operator [:b], :include?, :a
-  end
+  def test_assert_allocations_bad
+    exp = "Object allocations.\nExpected 2 to be == 1."
 
-  def test_refute_operator_bad
-    assert_operator [:a], :include?, :a
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_refute_predicate
-    refute_predicate "woot", :empty?
-  end
+    util_array # warm
 
-  def test_refute_predicate_bad
-    refute_predicate "", :empty?
-  rescue Minitest::Assertion
-    # do nothing
-  end
-
-  def test_refute_respond_to
-    refute_respond_to :a, :full?
+    assert_triggered exp do
+      assert_allocations 1 do
+        util_array
+      end
+    end
   end
 
-  def test_refute_respond_to_bad
-    refute_respond_to :a, :empty?
-  rescue Minitest::Assertion
-    # do nothing
-  end
+  def test_assert_allocations_neg_bad
+    util_n_times_full 5
 
-  def test_refute_same
-    refute_same :a, :b
-  end
+    exp = "Object allocations.\nExpected #{5} to be <= 3."
 
-  def test_refute_same_bad
-    refute_same :a, :a
-  rescue Minitest::Assertion
-    # do nothing
+    assert_triggered exp do
+      assert_allocations :<=, 3 do
+        util_n_times_full 5
+      end
+    end
   end
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: minitest-gcstats
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ryan Davis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBAjANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBBTANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTE0MDkxNzIzMDcwN1oXDTE1MDkxNzIzMDcwN1owRTETMBEGA1UE
+  GRYDY29tMB4XDTIwMTIyMjIwMzgzMFoXDTIxMTIyMjIwMzgzMFowRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -21,58 +21,92 @@ cert_chain:
   GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
-  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
-  AQAFoDJRokCQdxFfOrmsKX41KOFlU/zjrbDVM9hgB/Ur999M6OXGSi8FitXNtMwY
-  FVjsiAPeU7HaWVVcZkj6IhINelTkXsxgGz/qCzjHy3iUMuZWw36cS0fiWJ5rvH+e
-  hD7uXxJSFuyf1riDGI1aeWbQ74WMwvNstOxLUMiV5a1fzBhlxPqb537ubDjq/M/h
-  zPUFPVYeL5KjDHLCqI2FwIk2sEMOQgjpXHzl+3NlD2LUgUhHDMevmgVua0e2GT1B
-  xJcC6UN6NHMOVMyAXsr2HR0gRRx4ofN1LoP2KhXzSr8UMvQYlwPmE0N5GQv1b5AO
-  VpzF30vNaJK6ZT7xlIsIlwmH
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBCwUAA4IB
+  AQAE3XRm1YZcCVjAJy5yMZvTOFrS7B2SYErc+0QwmKYbHztTTDY2m5Bii+jhpuxh
+  H+ETcU1z8TUKLpsBUP4kUpIRowkVN1p/jKapV8T3Rbwq+VuYFe+GMKsf8wGZSecG
+  oMQ8DzzauZfbvhe2kDg7G9BBPU0wLQlY25rDcCy9bLnD7R0UK3ONqpwvsI5I7x5X
+  ZIMXR0a9/DG+55mawwdGzCQobDKiSNLK89KK7OcNTALKU0DfgdTkktdgKchzKHqZ
+  d/AHw/kcnU6iuMUoJEcGiJd4gVCTn1l3cDcIvxakGslCA88Jubw0Sqatan0TnC9g
+  KToW560QIey7SPfHWduzFJnV
   -----END CERTIFICATE-----
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: minitest-proveit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '1.0'
 - !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.12'
+        version: '3.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.22'
 description: |-
   A minitest plugin that adds a report of the top tests by number of
   objects allocated.
@@ -85,8 +119,7 @@ extra_rdoc_files:
 - Manifest.txt
 - README.rdoc
 files:
-- .autotest
-- .gemtest
+- ".autotest"
 - History.rdoc
 - Manifest.txt
 - README.rdoc
@@ -97,29 +130,28 @@ files:
 homepage: https://github.com/seattlerb/minitest-gcstats
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/seattlerb/minitest-gcstats
+post_install_message:
 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.1
-signing_key: 
+rubygems_version: 3.2.16
+signing_key:
 specification_version: 4
 summary: A minitest plugin that adds a report of the top tests by number of objects
   allocated.
-test_files:
-- test/minitest/test_gcstats.rb
+test_files: []