async-utilization 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bae4a631b828e8a236bcee48919460731116a2a521031f16ae8f11ed03234407
-  data.tar.gz: 3ca70a5a98f4ba4515d3f30271561e0764912cf1f7983d602307bf6ba869b296
+  metadata.gz: 10d5277f8a02e1f72a8466b86dae5245d8beacf60f7310b5f4b2fbbe829ad2b2
+  data.tar.gz: 8e1519b41206468ffcd4c5197aecd0843882e5c637db9db24fce67f87fd34386
 SHA512:
-  metadata.gz: 0ae6db6c1108dcc43ef14a38b6fb88de1c882deeeac95df60c843bac006a4de88c6d6344128f0cd9e53344572391ab6833b4a2f36ebbea741fceb1b22e26ecef
-  data.tar.gz: 664e8d90bee5423e467aa01a502d043838d2a139fbd53bda712c27422839abe501e1a250cb760492f95b79f0e9245dde2cf09d33fcfba85a11435bc97be23f16
+  metadata.gz: aff8c89a734ee90bb716186f4a9133373bc222c26a0b4bb089152a9bce6bd2d76105a91a6c99f3a5333be4afef83ba3c88637e64b69a2629ab185e94b6035a4a
+  data.tar.gz: 853481053488156d6baa7be3cff2f7c19e9bad60028e44649f96bfc978c07c173065bb0d8bd17105ae1248204d569bc115fcc0e146ce3ee25886b8efcc2580e9

data/lib/async/utilization/metric.rb

@@ -43,30 +43,38 @@ module Async
 				@cached_buffer = nil
 			end
 			
-			# Increment the metric value, optionally with a block that auto-decrements.
+			# Increment the metric value.
 			#
 			# Uses the fast path (direct buffer write) when cache is valid and observer is available.
 			#
-			# @yield Optional block - if provided, decrements the field after the block completes.
 			# @returns [Integer] The new value of the field.
-			def increment(&block)
+			def increment
 				@guard.synchronize do
 					@value += 1
 					write_direct(@value)
 				end
 				
-				if block_given?
-					begin
-						yield
-					ensure
-						# Decrement after block completes
-						decrement
-					end
-				end
-				
 				@value
 			end
 			
+			# Track an operation: increment before the block, decrement after it completes.
+			#
+			# Returns the block's return value. Use for active/count metrics that should
+			# reflect the number of operations currently in progress.
+			#
+			# @yield The operation to track.
+			# @returns [Object] The block's return value.
+			def track(&block)
+				raise ArgumentError, "block required" unless block_given?
+				
+				increment
+				begin
+					yield
+				ensure
+					decrement
+				end
+			end
+			
 			# Decrement the metric value.
 			#
 			# Uses the fast path (direct buffer write) when cache is valid and observer is available.

data/lib/async/utilization/registry.rb

@@ -22,7 +22,7 @@ module Async
 		# 	
 		# 	# Emit metrics - values tracked in registry
 		# 	registry.increment(:total_requests)
-		# 	registry.increment(:active_requests) do
+		# 	registry.track(:active_requests) do
 		# 		# Handle request - auto-decrements when block completes
 		# 	end
 		# 	
@@ -93,15 +93,25 @@ module Async
 				metric(field).set(value)
 			end
 			
-			# Increment a field value, optionally with a block that auto-decrements.
+			# Increment a field value.
 			#
 			# Delegates to the metric instance for the given field.
 			#
 			# @parameter field [Symbol] The field name to increment.
-			# @yield Optional block - if provided, decrements the field after the block completes.
 			# @returns [Integer] The new value of the field.
-			def increment(field, &block)
-				metric(field).increment(&block)
+			def increment(field)
+				metric(field).increment
+			end
+			
+			# Track an operation: increment before the block, decrement after it completes.
+			#
+			# Delegates to the metric instance for the given field.
+			#
+			# @parameter field [Symbol] The field name to track.
+			# @yield The operation to track.
+			# @returns [Object] The block's return value.
+			def track(field, &block)
+				metric(field).track(&block)
 			end
 			
 			# Decrement a field value.

data/lib/async/utilization/version.rb

@@ -7,6 +7,6 @@
 module Async
 	# @namespace
 	module Utilization
-		VERSION = "0.2.0"
+		VERSION = "0.3.0"
 	end
 end

data/readme.md

@@ -14,6 +14,10 @@ Please see the [project documentation](https://socketry.github.io/async-utilizat
 
 Please see the [project releases](https://socketry.github.io/async-utilization/releases/index) for all releases.
 
+### v0.3.0
+
+  - Introduce `Metric#track{...}` for increment -\> decrement.
+
 ### v0.1.0
 
   - Initial implementation.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.3.0
+
+  - Introduce `Metric#track{...}` for increment -\> decrement.
+
 ## v0.1.0
 
   - Initial implementation.

data/test/async/utilization/metric.rb

@@ -80,23 +80,62 @@ describe Async::Utilization::Metric do
 		expect(metric.value).to be == 100
 	end
 	
-	it "can increment with auto-decrement block" do
+	it "can track an operation with auto-decrement" do
 		registry.observer = observer
 		metric = registry.metric(:active_requests)
 		
-		metric.increment do
+		metric.track do
 			expect(metric.value).to be == 1
 		end
 		
 		expect(metric.value).to be == 0
 	end
 	
-	it "decrements even if block raises an error" do
+	it "returns the metric value when increment is called" do
+		registry.observer = observer
+		metric = registry.metric(:total_requests)
+		
+		result = metric.increment
+		expect(result).to be == 1
+		expect(result).to be == metric.value
+		
+		result = metric.increment
+		expect(result).to be == 2
+		expect(result).to be == metric.value
+	end
+	
+	it "returns the block's return value when track is called" do
+		registry.observer = observer
+		metric = registry.metric(:active_requests)
+		
+		# Block returns a string
+		result = metric.track do
+			"connection_object"
+		end
+		expect(result).to be == "connection_object"
+		expect(metric.value).to be == 0 # Should be decremented after block
+		
+		# Block returns an integer
+		result = metric.track do
+			42
+		end
+		expect(result).to be == 42
+		expect(metric.value).to be == 0 # Should be decremented after block
+		
+		# Block returns nil
+		result = metric.track do
+			nil
+		end
+		expect(result).to be == nil
+		expect(metric.value).to be == 0 # Should be decremented after block
+	end
+	
+	it "decrements even if track block raises an error" do
 		registry.observer = observer
 		metric = registry.metric(:active_requests)
 		
 		begin
-			metric.increment do
+			metric.track do
 				raise "Test error"
 			end
 		rescue => error
@@ -106,6 +145,14 @@ describe Async::Utilization::Metric do
 		expect(metric.value).to be == 0
 	end
 	
+	it "raises ArgumentError when track is called without a block" do
+		metric = registry.metric(:active_requests)
+		
+		expect do
+			metric.track
+		end.to raise_exception(ArgumentError, message: be == "block required")
+	end
+	
 	it "writes directly to shared memory when observer is set" do
 		registry.observer = observer
 		metric = registry.metric(:total_requests)

data/test/async/utilization/registry.rb

@@ -37,17 +37,17 @@ describe Async::Utilization::Registry do
 		expect(registry.values[:test_field]).to be == 42
 	end
 	
-	it "can auto-decrement with a block" do
-		registry.increment(:test_field) do
+	it "can track an operation with auto-decrement" do
+		registry.track(:test_field) do
 			expect(registry.values[:test_field]).to be == 1
 		end
 		
 		expect(registry.values[:test_field]).to be == 0
 	end
 	
-	it "decrements even if block raises an error" do
+	it "decrements even if track block raises an error" do
 		begin
-			registry.increment(:test_field) do
+			registry.track(:test_field) do
 				raise "Error!"
 			end
 		rescue

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-utilization
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -97,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="