minitest-memory 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ebf51378aad65a92a5563045128674d105040e0c8c6a923d8f94aea5a47099c
+  data.tar.gz: 4c3ac6868a00e6b00e47e4ccd96bb0d69ad275e3aa7d7287fdd0036c7d4c6f8d
+SHA512:
+  metadata.gz: 23abb466ddad6de511d47c7d77a84a61c60f362cb815115a711f120ae59ba2920129644beee0d29fc4943ec55170aa152335a796444d4bd18f203c2ab95a4ed6
+  data.tar.gz: dda3dd7ebefb5aafe8f1225ea9760a194fb4cd951921c0566a0d32ef6c5acb65ee2372d2de4a388cc624da22c3eaf503aa40fd35dbfa0b916faa3c51e24ee26a

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-03-06
+
+### Added
+
+- `Minitest::Memory::AllocationCounter.count` — counts object allocations by class within a block
+- `assert_allocations` — fails if any class exceeds its allocation limit within a block

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Erik Berlin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# minitest-memory
+
+Minitest assertions for tracking memory allocations. Verify that your code
+allocates only the expected number of objects.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "minitest-memory"
+```
+
+## Usage
+
+Include `Minitest::Memory` in your test class, then use `assert_allocations`
+to set upper bounds on object allocations within a block:
+
+```ruby
+require "minitest/autorun"
+require "minitest/memory"
+
+class MyTest < Minitest::Test
+  include Minitest::Memory
+
+  def test_no_string_allocations
+    assert_allocations(String => 0) do
+      # code that should not allocate strings
+    end
+  end
+
+  def test_limited_allocations
+    assert_allocations(String => 2, Array => 1) do
+      # code that should allocate at most 2 Strings and 1 Array
+    end
+  end
+end
+```
+
+It also works with `Minitest::Spec`:
+
+```ruby
+require "minitest/autorun"
+require "minitest/memory"
+
+class Minitest::Spec
+  include Minitest::Memory
+end
+
+describe MyClass do
+  it "does not allocate strings" do
+    assert_allocations(String => 0) do
+      # code under test
+    end
+  end
+end
+```
+
+## How It Works
+
+`assert_allocations` uses `ObjectSpace.trace_object_allocations` to track
+every object allocated during the block's execution. It then compares the
+counts per class against the limits you provide. If any class exceeds its
+limit, the assertion fails with a message like:
+
+```
+Expected at most 0 String allocations, got 3
+```
+
+## License
+
+MIT

data/lib/minitest/memory/version.rb

@@ -0,0 +1,8 @@
+module Minitest # :nodoc:
+  ##
+  # Version information for minitest-memory.
+  module Memory
+    # Current version of minitest-memory.
+    VERSION = "1.0.0".freeze
+  end
+end

data/lib/minitest/memory.rb

@@ -0,0 +1,60 @@
+require "objspace"
+require "minitest/strict"
+require_relative "memory/version"
+
+##
+# Minitest extensions for memory allocation assertions.
+
+module Minitest
+  ##
+  # Provides assertions for tracking memory allocations in tests.
+  # Include this module in your test class to use +assert_allocations+.
+  module Memory
+    ##
+    # Counts object allocations within a block using ObjectSpace.
+    class AllocationCounter
+      ##
+      # Counts allocations by class within a block. Returns a Hash
+      # mapping each class to its allocation count. Temporarily
+      # disables GC during counting.
+
+      def self.count(&)
+        GC.start
+        GC.disable
+        generation = GC.count
+        ObjectSpace.trace_object_allocations(&)
+        count_allocations generation
+      ensure
+        GC.enable
+      end
+
+      ##
+      # Returns a Hash of allocations from the given +generation+.
+
+      def self.count_allocations generation
+        allocations = Hash.new(0)
+        ObjectSpace.each_object do |obj|
+          allocations[obj.class] += 1 if ObjectSpace.allocation_generation(obj) == generation
+        end
+        allocations
+      end
+    end
+
+    ##
+    # Fails if any class in +limits+ exceeds its allocation count
+    # within a block. +limits+ is a Hash mapping classes to maximum
+    # allowed allocations. Eg:
+    #
+    #   assert_allocations(String => 1) { "hello" }
+
+    def assert_allocations(limits, &)
+      actual = AllocationCounter.count(&)
+
+      limits.each do |klass, max_count|
+        count = actual[klass]
+        msg = "Expected at most #{max_count} #{klass} allocations, got #{count}"
+        assert_operator max_count, :>=, count, msg
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: minitest-memory
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Erik Berlin
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.21'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.21'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: minitest-strict
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Provides assert_allocations to verify object allocation counts within
+  a block.
+email:
+- sferik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/minitest/memory.rb
+- lib/minitest/memory/version.rb
+homepage: https://sferik.github.io/minitest-memory
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/sferik/minitest-memory
+  bug_tracker_uri: https://github.com/sferik/minitest-memory/issues
+  changelog_uri: https://github.com/sferik/minitest-memory/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/minitest-memory
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.7
+specification_version: 4
+summary: Memory allocation assertions for Minitest
+test_files: []