memory-leak 0.5.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1a1aa8b13b9b14b95e6bd4ae1c09eb042ce5771ca679999923f35dbc7e72aa5
-  data.tar.gz: 313df36998d573655a411fe3a0d73361d35b77da7e8ad557061e7d794bc82a6e
+  metadata.gz: 6ab8d8ab5e5ebff81f2847704ece1e34c20c71aa35a361caea8eafccc4b39f6f
+  data.tar.gz: e0a1dce4599132dc7a5aff55d1d639efb50e4d5f2b7c7f0f81289100471c8682
 SHA512:
-  metadata.gz: caba7b59ddf9077960030510220b1a971fc29d7947c21643ee0f1eeda72fa082841fe17f51d1e47a9caf042c64bcad60d6cf63429782f06db9e6bc083d9c232b
-  data.tar.gz: ebbcaabd44e33220917a476c6471e52534b21914046db1355bd0ba083f69dd0f8b36ebeadaec6982ec746809e23018badea4f24cf638b6cd012dca7880e659f8
+  metadata.gz: cff70665edfcdf6d0e3d6ed7510586deb57fbd04f16476e5795acb73635688dec1f455a343b7bd3ba595a1e00a84dd65a34b658fecb11ad0b9fb2ff093e174e5
+  data.tar.gz: 9a09bb3be13452c240289f6d5433fc11c46213d987ac2abea1db6f6c2484f8453670413d9a48555e57d9cbbbd0918d91049ebb4d05306f74fa683efd8e839829

data/lib/memory/leak/cluster.rb

@@ -87,7 +87,7 @@ module Memory
 			def sample!
 				System.memory_usages(@processes.keys) do |process_id, memory_usage|
 					if monitor = @processes[process_id]
-						monitor.current_size = memory_usage
+						monitor.sample!(memory_usage)
 					end
 				end
 			end
@@ -96,8 +96,6 @@ module Memory
 			#
 			# @yields {|process_id, monitor| ...} each process ID and monitor that is leaking or exceeds the memory limit.
 			def check!(&block)
-				return to_enum(__method__) unless block_given?
-				
 				self.sample!
 				
 				leaking = []
@@ -110,10 +108,14 @@ module Memory
 					end
 				end
 				
-				leaking.each(&block)
+				if block_given?
+					leaking.each(&block)
+				end
 				
 				# Finally, apply any per-cluster memory limits:
 				apply_limit!(@total_size_limit, &block) if @total_size_limit
+				
+				return leaking
 			end
 		end
 	end

data/lib/memory/leak/monitor.rb

@@ -33,9 +33,11 @@ module Memory
 			def initialize(process_id = Process.pid, maximum_size: nil, maximum_size_limit: nil, threshold_size: DEFAULT_THRESHOLD_SIZE, increase_limit: DEFAULT_INCREASE_LIMIT)
 				@process_id = process_id
 				
+				@sample_count = 0
 				@current_size = nil
 				@maximum_size = maximum_size
 				@maximum_size_limit = maximum_size_limit
+				@maximum_observed_size = nil
 				
 				@threshold_size = threshold_size
 				@increase_count = 0
@@ -46,6 +48,7 @@ module Memory
 			def as_json(...)
 				{
 					process_id: @process_id,
+					sample_count: @sample_count,
 					current_size: @current_size,
 					maximum_size: @maximum_size,
 					maximum_size_limit: @maximum_size_limit,
@@ -83,6 +86,9 @@ module Memory
 				System.memory_usage(@process_id)
 			end
 			
+			# @attribute [Integer] The number of samples taken.
+			attr :sample_count
+			
 			# @returns [Integer] The last sampled memory usage.
 			def current_size
 				@current_size ||= memory_usage
@@ -99,14 +105,18 @@ module Memory
 			#
 			# @returns [Boolean] True if a memory leak has been detected.
 			def increase_limit_exceeded?
-				@increase_count >= @increase_limit
+				if @increase_limit
+					@increase_count >= @increase_limit
+				end
 			end
 			
 			# Indicates that the current memory usage has grown beyond the maximum size limit.
 			#
 			# @returns [Boolean] True if the current memory usage has grown beyond the maximum size limit.
 			def maximum_size_limit_exceeded?
-				@maximum_size_limit && self.current_size > @maximum_size_limit
+				if @maximum_size_limit
+					self.current_size > @maximum_size_limit
+				end
 			end
 			
 			# Indicates whether a memory leak has been detected.
@@ -119,7 +129,9 @@ module Memory
 			# Capture a memory usage sample and yield if a memory leak is detected.
 			#
 			# @yields {|sample, monitor| ...} If a memory leak is detected.
-			def sample!
+			def sample!(memory_usage = self.memory_usage)
+				@sample_count += 1
+				
 				self.current_size = memory_usage
 				
 				if @maximum_observed_size

data/lib/memory/leak/version.rb

@@ -5,6 +5,6 @@
 
 module Memory
 	module Leak
-		VERSION = "0.5.2"
+		VERSION = "0.7.0"
 	end
 end

data/readme.md

@@ -12,6 +12,16 @@ Please see the [project documentation](https://socketry.github.io/memory-leak/)
 
 Please see the [project releases](https://socketry.github.io/memory-leak/releases/index) for all releases.
 
+### v0.7.0
+
+  - Make both `increase_limit` and `maximum_size_limit` optional (if `nil`).
+
+### v0.6.0
+
+  - Added `sample_count` attribute to monitor to track number of samples taken.
+  - `check!` method in cluster now returns an array of leaking monitors if no block is given.
+  - `Cluster#check!` now invokes `Monitor#sample!` to ensure memory usage is updated before checking for leaks.
+
 ### v0.5.0
 
   - Improved variable names.

data/releases.md

@@ -1,5 +1,15 @@
 # Releases
 
+## v0.7.0
+
+  - Make both `increase_limit` and `maximum_size_limit` optional (if `nil`).
+
+## v0.6.0
+
+  - Added `sample_count` attribute to monitor to track number of samples taken.
+  - `check!` method in cluster now returns an array of leaking monitors if no block is given.
+  - `Cluster#check!` now invokes `Monitor#sample!` to ensure memory usage is updated before checking for leaks.
+
 ## v0.5.0
 
   - Improved variable names.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memory-leak
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -36,7 +36,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-02-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 executables: []
 extensions: []
@@ -63,14 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A memory leak monitor.
 test_files: []