track_open_instances 0.1.0 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 264fbcefa796af11230c90bc8f1221363d3af1515975e8647a694a486499c874
-  data.tar.gz: 7a5129b04a6ff432a8b7641f80b0b18e98ea52a96b8bb45599ba991650558fea
+  metadata.gz: c549220e45116c5a6ac033c6b1aa740c2e31834f96bd1e3c0550d58ebfd86b8e
+  data.tar.gz: 534a96da8b84a9a0936498de5c53603389251776dc6de94996bea7ac5531be54
 SHA512:
-  metadata.gz: '0963b6a2fcd9fb91f42dfadc663425365de598b82e1635d8178216ca05da85d19cf1ba8c0bf67807bf3ff650b73558717703ade5772bb516d357b2c2517e363c'
-  data.tar.gz: 57aa5b10f7fc3b96f062cab47985ac5e060aebff83a408293c91339809f68105414b34bff748a016a53f055b23bbf30f37ae3dde43ce05c24a660d59896382f4
+  metadata.gz: 47fbd1a4870a53d0cc203a377e15bcc35683ebf885e7ab9065c885afb2a8a52da8398f2d60d99dbd17405dc316582bf708525c43a2a51e1a8163677c5afecec1
+  data.tar.gz: accf55976f9ac9c5ee7cf6e96bcfa8f5844db80e4624ef13f5f5d0458dfeb3e8640230f1874f11dc83c169aca66e1b30a22ec1a0ee1014f807bdcd0923ee6786

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.10"
+}

data/.yardopts

@@ -5,5 +5,4 @@
 --readme README.md
 - CHANGELOG.md
 - CONTRIBUTING.md
-- RELEASING.md
 - LICENSE.txt

data/CHANGELOG.md

@@ -1,19 +1,100 @@
 # Change Log
 
+## [0.1.10](https://github.com/main-branch/track_open_instances/compare/v0.1.9...v0.1.10) (2025-04-15)
+
+
+### Bug Fixes
+
+* Amend release task so it does not create a new tag ([4ba194c](https://github.com/main-branch/track_open_instances/commit/4ba194ce6c744db3ab57bed022e8d311166a4e64))
+
+## [0.1.9](https://github.com/main-branch/track_open_instances/compare/v0.1.8...v0.1.9) (2025-04-15)
+
+
+### Bug Fixes
+
+* Amend release task so it does not create a new tag ([7bedd17](https://github.com/main-branch/track_open_instances/commit/7bedd176c140f6b3979f39388f0ca803c32f9282))
+
+## [0.1.8](https://github.com/main-branch/track_open_instances/compare/v0.1.7...v0.1.8) (2025-04-15)
+
+
+### Bug Fixes
+
+* Remove component name from release version tag ([5991728](https://github.com/main-branch/track_open_instances/commit/59917284241eaa173fd4f83a38710cb50a23c750))
+
+## [0.1.7](https://github.com/main-branch/track_open_instances/compare/track_open_instances-v0.1.6...track_open_instances/v0.1.7) (2025-04-15)
+
+
+### Bug Fixes
+
+* Add package-name to release-please configuration ([83d0198](https://github.com/main-branch/track_open_instances/commit/83d0198bfab34e26b641ca7e27af08b68e07c396))
+* Automatically push the new gem release to rubygems.org ([d133153](https://github.com/main-branch/track_open_instances/commit/d13315396f590fefeb07cc4b71a13c9e9709842b))
+* Checkout project before the release-please step in release workflow ([80d9a35](https://github.com/main-branch/track_open_instances/commit/80d9a35ed155f3ba7e14a585e54d9ec34d2722e2))
+* Fix several documentation and report errors ([fd17199](https://github.com/main-branch/track_open_instances/commit/fd171997871796df746c8e1312a4fdb07cb363d5))
+* Make release-please use a different tag than release-gem ([a7d42dc](https://github.com/main-branch/track_open_instances/commit/a7d42dcb132bd40ceb3830a6a02a09694022844a))
+* Make small change to test release ([8304c90](https://github.com/main-branch/track_open_instances/commit/8304c905883c760e6419210be300b637f01e054d))
+* Release workflow should checkout project ([869a7e0](https://github.com/main-branch/track_open_instances/commit/869a7e011438b57bcb810680ecdf0eb5beec193b))
+* Remove the qlty.sh integration ([4c4492b](https://github.com/main-branch/track_open_instances/commit/4c4492bb19d1f39fa96ec30ad0af12d103067e92))
+* Specify the version file ([be826cf](https://github.com/main-branch/track_open_instances/commit/be826cfe9a8aa526cdaa3f1ecb5912641f3db38c))
+* Start autoreleases at 0.1.0 ([5a2fad7](https://github.com/main-branch/track_open_instances/commit/5a2fad7a9cb029a5dbfb9785f979fc07bf7f127b))
+
+## [0.1.6](https://github.com/main-branch/track_open_instances/compare/v0.1.5...v0.1.6) (2025-04-15)
+
+
+### Bug Fixes
+
+* Make release-please use a different tag than release-gem ([a7d42dc](https://github.com/main-branch/track_open_instances/commit/a7d42dcb132bd40ceb3830a6a02a09694022844a))
+
+## [0.1.5](https://github.com/main-branch/track_open_instances/compare/v0.1.4...v0.1.5) (2025-04-14)
+
+
+### Bug Fixes
+
+* Checkout project before the release-please step in release workflow ([80d9a35](https://github.com/main-branch/track_open_instances/commit/80d9a35ed155f3ba7e14a585e54d9ec34d2722e2))
+* Specify the version file ([be826cf](https://github.com/main-branch/track_open_instances/commit/be826cfe9a8aa526cdaa3f1ecb5912641f3db38c))
+
+## [0.1.4](https://github.com/main-branch/track_open_instances/compare/v0.1.3...v0.1.4) (2025-04-14)
+
+
+### Bug Fixes
+
+* Release workflow should checkout project ([869a7e0](https://github.com/main-branch/track_open_instances/commit/869a7e011438b57bcb810680ecdf0eb5beec193b))
+
+## [0.1.3](https://github.com/main-branch/track_open_instances/compare/v0.1.2...v0.1.3) (2025-04-14)
+
+
+### Bug Fixes
+
+* Automatically push the new gem release to rubygems.org ([d133153](https://github.com/main-branch/track_open_instances/commit/d13315396f590fefeb07cc4b71a13c9e9709842b))
+* Remove the qlty.sh integration ([4c4492b](https://github.com/main-branch/track_open_instances/commit/4c4492bb19d1f39fa96ec30ad0af12d103067e92))
+
+## [0.1.2](https://github.com/main-branch/track_open_instances/compare/v0.1.1...v0.1.2) (2025-04-14)
+
+
+### Bug Fixes
+
+* Make small change to test release ([8304c90](https://github.com/main-branch/track_open_instances/commit/8304c905883c760e6419210be300b637f01e054d))
+
+## [0.1.1](https://github.com/main-branch/track_open_instances/compare/v0.1.0...v0.1.1) (2025-04-14)
+
+### Bug Fixes
+
+* Fix several documentation and report errors ([fd17199](https://github.com/main-branch/track_open_instances/commit/fd171997871796df746c8e1312a4fdb07cb363d5))
+* Start autoreleases at 0.1.0 ([5a2fad7](https://github.com/main-branch/track_open_instances/commit/5a2fad7a9cb029a5dbfb9785f979fc07bf7f127b))
+
 ## v0.1.0 (2025-04-08)
 
 [Full Changelog](https://github.com/main-branch/track_open_instances/compare/f0fb459..v0.1.0)
 
 Changes:
 
-- f2d5318 chore: remove radarline-ruby from qlty checks
-- 177eba8 chore: fix formatting errors reported by `qlty fmt`
-- 943359f build: remove rubocop plugin from qlty
-- 476f271 chore: integrate yamllint
-- 56811ca fix: add qlty configuration in order to run qlty checks locally
-- e83546a fix: fix continuous integration workflow issues reported by qlty.sh
-- 6f67aed test: add predicate methods to determine the Ruby engine and platform
-- 34e3829 build: generate JSON coverage report for qlty.sh coverage reporting
-- 9db2052 docs: update README links
-- 937a971 build: update code coverage reporting
-- f0fb459 feat: initial implementation of TrackOpenInstances
+* f2d5318 chore: remove radarline-ruby from qlty checks
+* 177eba8 chore: fix formatting errors reported by `qlty fmt`
+* 943359f build: remove rubocop plugin from qlty
+* 476f271 chore: integrate yamllint
+* 56811ca fix: add qlty configuration in order to run qlty checks locally
+* e83546a fix: fix continuous integration workflow issues reported by qlty.sh
+* 6f67aed test: add predicate methods to determine the Ruby engine and platform
+* 34e3829 build: generate JSON coverage report for qlty.sh coverage reporting
+* 9db2052 docs: update README links
+* 937a971 build: update code coverage reporting
+* f0fb459 feat: initial implementation of TrackOpenInstances

data/README.md

@@ -4,8 +4,6 @@
 [![Build Status](https://github.com/main-branch/track_open_instances/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/main-branch/track_open_instances/actions/workflows/continuous_integration.yml)
 [![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/track_open_instances/)
 [![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/track_open_instances/file/CHANGELOG.md)
-[![Maintainability](https://qlty.sh/badges/52f7402e-ab92-4f8f-9f62-d879ca628adb/maintainability.svg)](https://qlty.sh/gh/main-branch/projects/track_open_instances)
-[![Code Coverage](https://qlty.sh/badges/52f7402e-ab92-4f8f-9f62-d879ca628adb/test_coverage.svg)](https://qlty.sh/gh/main-branch/projects/track_open_instances)
 [![Slack](https://img.shields.io/badge/slack-main--branch/track__open__instances-yellow.svg?logo=slack)](https://main-branch.slack.com/archives/C01CHR7TMM2)
 
 `TrackOpenInstances` is a Ruby mixin designed to help manage resources that require
@@ -22,7 +20,7 @@ to aid debugging.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's or gem's Gemfile:
 
 ```Ruby
 gem 'track_open_instances'

data/Rakefile

@@ -17,6 +17,13 @@ Bundler::Audit::Task.new
 require 'bundler'
 require 'bundler/gem_tasks'
 
+# Make it so that calling `rake release` just calls `rake release:rubygems_push` to
+# avoid creating and pushing a new tag.
+
+Rake::Task['release'].clear
+desc 'Customized release task to avoid creating a new tag'
+task release: 'release:rubygem_push'
+
 # RSpec
 
 require 'rspec/core/rake_task'

data/lib/track_open_instances/version.rb

@@ -2,5 +2,5 @@
 
 module TrackOpenInstances
   # The last released version of this gem
-  VERSION = '0.1.0'
+  VERSION = '0.1.10'
 end

data/lib/track_open_instances.rb

@@ -20,7 +20,7 @@ require_relative 'track_open_instances/version'
 #       # Simulate opening the file
 #       puts "Opening file: #{path}"
 #       # Register the instance for tracking
-#       self.class.add_instance(self)
+#       self.class.add_open_instance(self)
 #     end
 #
 #     # Implement the close logic specific to the resource
@@ -28,20 +28,20 @@ require_relative 'track_open_instances/version'
 #       # Simulate closing the file
 #       puts "Closing file: #{path}"
 #       # Remove the instance from tracking
-#       self.class.remove_instance(self)
+#       self.class.remove_open_instance(self)
 #     end
 #   end
 #
 #   file1 = ManagedFile.new('/tmp/file1.txt')
 #   file2 = ManagedFile.new('/tmp/file2.txt')
 #
-#   puts ManagedFile.unclosed_instances.count #=> 2
-#   puts ManagedFile.unclosed_instances.inspect #=> [#<ManagedFile:...>, #<ManagedFile:...>]
+#   puts ManagedFile.open_instances.count #=> 2
+#   puts ManagedFile.open_instances.keys.inspect #=> [#<ManagedFile:...>, #<ManagedFile:...>]
 #
 #   file1.close
 #
-#   puts ManagedFile.unclosed_instances.count #=> 1
-#   puts ManagedFile.unclosed_instances.inspect #=> [#<ManagedFile:...>]
+#   puts ManagedFile.open_instances.count #=> 1
+#   puts ManagedFile.open_instances.keys.inspect #=> [#<ManagedFile:...>]
 #
 #   # In a test suite's teardown, you might use:
 #   # ManagedFile.assert_no_open_instances # This would raise if file2 wasn't closed
@@ -65,7 +65,8 @@ module TrackOpenInstances
     # Initializes a new OpenInstance
     #
     # @param instance [Object] The tracked instance
-    # @param creation_stack [Array<String>] The call stack at the time of instance creation
+    # @param creation_stack [Array<Thread::Backtrace::Location>] The call stack at
+    #   the time of instance creation
     #
     # @return [void]
     #
@@ -91,11 +92,11 @@ module TrackOpenInstances
     base.extend(ClassMethods)
     # @!attribute [rw] open_instances
     #   Internal storage for all tracked instances
-    #   @return [Hash{Integer => OpenInstance}] The list of currently tracked instances
+    #   @return [Hash{Object => OpenInstance}] The list of currently tracked instances
     base.instance_variable_set(:@open_instances, {}.compare_by_identity)
     # @!visibility private
     # @!attribute [r] open_instances_mutex
-    #   Mutex to ensure thread-safe access to the open_instances list
+    #   Mutex to ensure thread-safe access to the open_instances hash
     base.instance_variable_set(:@open_instances_mutex, Thread::Mutex.new)
   end
 
@@ -106,16 +107,16 @@ module TrackOpenInstances
     # Direct access to the internal list of tracked instances
     #
     # Note: This returns all instances ever tracked unless explicitly removed.
-    # Use `unclosed_instances` for checking leaks. Direct use is uncommon.
+    # Use `open_instances` for checking leaks. Direct use is uncommon.
     #
     # @example
     #   # Assuming MyResource includes TrackOpenInstances
     #   res1 = MyResource.new
     #   res2 = MyResource.new
     #   res1.close
-    #   MyResource.open_instances #=> [#<MyResource... object_id=res2>] (after res1 removed)
+    #   MyResource.open_instances.keys #=> [#<MyResource... object_id=res2>] (after res1 removed)
     #
-    # @return [Array<Object>] The raw list of currently tracked instances
+    # @return [Hash{Object => OpenInstance}] The raw list of currently tracked instances
     #
     # @api private
     def open_instances
@@ -135,7 +136,7 @@ module TrackOpenInstances
     # @api private
     def add_open_instance(instance)
       @open_instances_mutex.synchronize do
-        @open_instances[instance] = OpenInstance.new(instance, caller(3..))
+        @open_instances[instance] = OpenInstance.new(instance, caller_locations(3))
       end
     end
 
@@ -159,7 +160,7 @@ module TrackOpenInstances
     # @example
     #   res1 = MyResource.new
     #   res2 = MyResource.new
-    #   MyResource.open_instance_count #=> 1
+    #   MyResource.open_instance_count #=> 2
     #
     # @return [Integer]
     #
@@ -206,9 +207,10 @@ module TrackOpenInstances
     #
     def open_instances_report_header
       count = @open_instances.count
+      class_name = name || 'anonymous class'
 
       "There #{count == 1 ? 'is' : 'are'} #{count} " \
-        "open #{self.class} instance#{count == 1 ? '' : 's'}:\n"
+        "open #{class_name} instance#{count == 1 ? '' : 's'}:\n"
     end
 
     # The body of the report detailing each open instance
@@ -222,21 +224,24 @@ module TrackOpenInstances
         @open_instances.each do |instance, open_instance|
           body << " - object_id=#{instance.object_id}\n"
           body << "   Call stack when created:\n"
-          open_instance.creation_stack.reverse.each { |line| body << "     #{line}\n" }
+          open_instance.creation_stack.each do |location|
+            body << "     #{location.path}:#{location.lineno}:in `#{location.label}'\n"
+          end
         end
       end
     end
 
     # Asserts that no instances of the class remain unclosed
     #
-    # Raises a ProcessExecuter::Error with a detailed report if any instances
-    # are found to be unclosed. Commonly used in test suite teardown blocks.
+    # Commonly used in test suite teardown blocks to enure that all resources were
+    # released.
     #
     # @example
     #   # In RSpec teardown (e.g., after(:each))
     #   MyResource.assert_no_open_instances
     #
-    # @raise [RuntimeError] If any instances are found unclosed
+    # @raise [RuntimeError] If any instances are found unclosed with a report of
+    # unclosed instances
     #
     # @return [void]
     #

data/package.json

@@ -1,8 +1,8 @@
 {
   "devDependencies": {
-    "@commitlint/cli": "^19.5.0",
-    "@commitlint/config-conventional": "^19.5.0",
-    "husky": "^9.1.0"
+    "@commitlint/cli": "^19.8.0",
+    "@commitlint/config-conventional": "^19.8.0",
+    "husky": "^9.1.7"
   },
   "scripts": {
     "postinstall": "husky",

data/release-please-config.json

@@ -0,0 +1,22 @@
+{
+  "bootstrap-sha": "c0076bab53d3eae31f3798217e281e3d51a292a3",
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "track_open_instances",
+      "changelog-path": "CHANGELOG.md",
+      "version-file": "lib/track_open_instances/version.rb",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": true,
+      "draft": false,
+      "prerelease": false,
+      "include-component-in-tag": false
+    }
+  },
+  "plugins": [
+    {
+      "type": "sentence-case"
+    }
+  ],
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: track_open_instances
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.10
 platform: ruby
 authors:
 - James Couball
 bindir: exe
 cert_chain: []
-date: 2025-04-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -195,7 +195,7 @@ extra_rdoc_files: []
 files:
 - ".husky/commit-msg"
 - ".markdownlint.yml"
-- ".qlty/qlty.toml"
+- ".release-please-manifest.json"
 - ".rspec"
 - ".rubocop.yml"
 - ".yamllint.yml"
@@ -204,13 +204,13 @@ files:
 - CONTRIBUTING.md
 - LICENSE.txt
 - README.md
-- RELEASING.md
 - Rakefile
 - commitlint.config.js
 - lib/track_open_instances.rb
 - lib/track_open_instances/version.rb
 - package.json
 - pre-commit
+- release-please-config.json
 homepage: https://github.com/main-branch/track_open_instances
 licenses:
 - MIT
@@ -218,8 +218,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/main-branch/track_open_instances
   source_code_uri: https://github.com/main-branch/track_open_instances
-  documentation_uri: https://rubydoc.info/gems/track_open_instances/0.1.0
-  changelog_uri: https://rubydoc.info/gems/track_open_instances/0.1.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/track_open_instances/0.1.10
+  changelog_uri: https://rubydoc.info/gems/track_open_instances/0.1.10/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -237,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - 'Platform: Mac, Linux, or Windows'
 - 'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A mixin to ensure that all instances of a class are closed
 test_files: []

data/.qlty/qlty.toml

@@ -1,104 +0,0 @@
-# This file was automatically generated by `qlty init`.
-# You can modify it to suit your needs.
-# We recommend you to commit this file to your repository.
-#
-# This configuration is used by both Qlty CLI and Qlty Cloud.
-#
-#     Qlty CLI -- Code quality toolkit for developers
-#     Qlty Cloud -- Fully automated Code Health Platform
-#
-# Try Qlty Cloud: https://qlty.sh
-#
-# For a guide to configuration, visit https://qlty.sh/d/config
-# Or for a full reference, visit https://qlty.sh/d/qlty-toml
-config_version = "0"
-
-exclude_patterns = [
-  "*_min.*",
-  "*-min.*",
-  "*.min.*",
-  "**/*.d.ts",
-  "**/.yarn/**",
-  "**/bower_components/**",
-  "**/build/**",
-  "**/cache/**",
-  "**/config/**",
-  "**/db/**",
-  "**/deps/**",
-  "**/dist/**",
-  "**/extern/**",
-  "**/external/**",
-  "**/generated/**",
-  "**/Godeps/**",
-  "**/gradlew/**",
-  "**/mvnw/**",
-  "**/node_modules/**",
-  "**/protos/**",
-  "**/seed/**",
-  "**/target/**",
-  "**/testdata/**",
-  "**/vendor/**",
-  "**/assets/**",
-]
-
-test_patterns = [
-  "**/test/**",
-  "**/spec/**",
-  "**/*.test.*",
-  "**/*.spec.*",
-  "**/*_test.*",
-  "**/*_spec.*",
-  "**/test_*.*",
-  "**/spec_*.*",
-]
-
-[smells]
-mode = "comment"
-
-[[source]]
-name = "default"
-default = true
-
-[[plugin]]
-name = "actionlint"
-
-[[plugin]]
-name = "checkov"
-
-[[plugin]]
-name = "golangci-lint"
-mode = "comment"
-
-[[plugin]]
-name = "markdownlint"
-version = "0.41.0"
-mode = "comment"
-
-[[plugin]]
-name = "prettier"
-
-# [[plugin]]
-# name = "radarlint-ruby"
-
-[[plugin]]
-name = "ripgrep"
-mode = "comment"
-
-# [[plugin]]
-# name = "rubocop"
-# version = "1.75.2"
-# package_file = "Gemfile"
-# package_filters = ["rubocop"]
-
-[[plugin]]
-name = "trivy"
-drivers = [
-  "config",
-  "fs-vuln",
-]
-
-[[plugin]]
-name = "trufflehog"
-
-[[plugin]]
-name = "yamllint"

data/RELEASING.md

@@ -1,9 +0,0 @@
-# How to release a new track_open_instances gem
-
-Run `create-github-release <release-type>` in the root of a clean working tree.
-
-Where `release-type` is `major`, `minor`, or `patch` depending on the nature of the
-changes. Refer to the labels on each PR since the last release to determine which
-semver release type to specify.
-
-Follow the directions that `create-github-release` after it prepares the release PR.