memory 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91e6bf9d1a607a68dd5d8f368d6dfe4a4319bf5730b6283194f99fb587b96364
-  data.tar.gz: 9a4335bfa899416c7fec144236dc5e711382f49f5631a4b0dbde03d73e84a58e
+  metadata.gz: 629175076a1c5aaf4cc1c75ea5bd8bcbb2b0366a2bfab17b6b95dc6b5834db12
+  data.tar.gz: 5a9a623b425a324c3d9692e1d20bda001cbc6de12c9e6c01035044964ecb5942
 SHA512:
-  metadata.gz: 0a704a533f5ac299f5b0da35814c7d93d13dc9881fda6c69c8f274a9331dedf3f9b57e1afa22b28888892092f2daf9a0c583259fbcbf26757d2f3c3805594caf
-  data.tar.gz: cc67f1e0781d93b648ed720efb1a4ce6d05c5d18c15e2b781ecbb00321fec08c674d2be2a051f1835bf9de1f2e1a90c5ee6df4be72ac46d0e4ba6f50ec48f5f5
+  metadata.gz: 28d5d336d183df4140d6ab94a24ed69974598daa544ece8590cd37d3e0be7d3dbe38db69a6965eacb35107822cc1af93efd8bcf85d6f49076c73b8490b5ac603
+  data.tar.gz: aefccd3ad62ff34cd869ef52709f82b44323e273dd96da80ecf8af8a792cfc69bbea32f6b44011fd08e8bb9364e758bccb6685dcd8fc042e18c372b01b2d7137

data/context/getting-started.md

@@ -197,7 +197,7 @@ report = Memory::Report.new([
 sampler = Memory::Sampler.new
 sampler.run do
 	# Your code here
-	10000.times {"test string"}
+	10000.times{"test string"}
 end
 
 # Add samples to the custom report:
@@ -221,7 +221,7 @@ Reports can be exported as JSON for integration with other tools:
 ``` ruby
 report = Memory.report do
 	# Your code
-	data = Array.new(1000) {{value: rand(1000)}}
+	data = Array.new(1000){{value: rand(1000)}}
 end
 
 # Export as JSON:

data/lib/memory/cache.rb

@@ -17,7 +17,7 @@ module Memory
 		# Initialize a new cache with empty lookup tables.
 		def initialize
 			@gem_guess_cache = Hash.new
-			@location_cache = Hash.new {|h, k| h[k] = Hash.new.compare_by_identity}
+			@location_cache = Hash.new{|h, k| h[k] = Hash.new.compare_by_identity}
 			@class_name_cache = Hash.new.compare_by_identity
 			@string_cache = Hash.new
 		end
@@ -56,14 +56,22 @@ module Memory
 		end
 		
 		# Look up and cache a string value.
+		#
+		# This maps the original string to a shortened representation.
+		#
 		# Strings are truncated to 64 characters to reduce memory usage.
 		# @parameter obj [String] The string object to cache.
 		# @returns [String] A cached copy of the string (truncated to 64 characters).
 		def lookup_string(obj)
-			# This string is shortened to 200 characters which is what the string report shows
-			# The string report can still list unique strings longer than 200 characters
-			#   separately because the object_id of the shortened string will be different
-			@string_cache[obj] ||= String.new << obj[0, 64]
+			# This string is shortened to 64 characters which is what the string report shows. The string report (by value) can still list unique strings longer than 64 characters separately because the `object_id` of the shortened string will be different.
+			@string_cache[obj] ||= obj[0, 64]
+		rescue RuntimeError => error
+			# It is possible for the String to be temporarily locked from another Fiber which raises an error when we try to use it as a hash key. i.e: `Socket#read` locks a buffer string while reading data into it. In this case we `#dup`` the string to get an unlocked copy.
+			if error.message == "can't modify string; temporarily locked"
+				@string_cache[obj.dup] ||= obj[0, 64]
+			else
+				raise
+			end
 		end
 	end
 end

data/lib/memory/graph.rb

@@ -13,6 +13,11 @@ module Memory
 		
 		# Represents a node in the object graph with usage information.
 		class Node
+			# Initialize a new node in the object graph.
+			# @parameter object [Object] The object this node represents.
+			# @parameter usage [Usage] The memory usage of this object.
+			# @parameter parent [Node | Nil] The parent node in the traversal tree.
+			# @parameter reference [Symbol | Nil] The reference type from parent to this object.
 			def initialize(object, usage = Usage.new, parent = nil, reference: nil)
 				@object = object
 				@usage = usage
@@ -151,16 +156,21 @@ module Memory
 			# @parameter options [Hash] Options for JSON serialization.
 			# @returns [Hash] A hash representation of this node.
 			def as_json(*)
-				{
+				json = {
 					path: path,
-						object: {
-							class: @object.class.name,
-							object_id: @object.object_id
-						},
-						usage: @usage.as_json,
-						total_usage: total_usage.as_json,
-						children: @children&.transform_values(&:as_json)
+								object: {
+									class: @object.class.name,
+									object_id: @object.object_id
+								},
+								usage: @usage.as_json,
 				}
+				
+				if @children&.any?
+					json[:total_usage] = total_usage.as_json
+					json[:children] = @children.transform_values(&:as_json)
+				end
+				
+				return json
 			end
 			
 			# Convert this node to a JSON string.

data/lib/memory/sampler.rb

@@ -32,8 +32,8 @@ module Memory
 			@cache = cache
 			
 			self.register_type(0x01, Allocation,
-				packer: ->(instance){self.pack(instance.pack)},
-				unpacker: ->(data){Allocation.unpack(@cache, self.unpack(data))},
+				packer: ->(instance) {self.pack(instance.pack)},
+				unpacker: ->(data) {Allocation.unpack(@cache, self.unpack(data))},
 			)
 			
 			self.register_type(0x02, Symbol)
@@ -290,9 +290,6 @@ module Memory
 				class_name = @cache.lookup_class_name(klass)
 				value = (klass == String) ? @cache.lookup_string(object) : nil
 				
-				# compensate for API bug
-				memsize = rvalue_size if memsize > 100_000_000_000
-				
 				allocation = Allocation.new(@cache, class_name, file, line, memsize, value, false)
 				
 				@allocated << allocation

data/lib/memory/usage.rb

@@ -9,7 +9,13 @@ require "set"
 require "objspace"
 
 module Memory
+	# Tracks memory usage statistics including size and object count.
+	#
+	# Can be used to measure allocations or compute usage of object graphs.
 	class Usage
+		# Initialize a new usage tracker.
+		# @parameter size [Integer] The total size in bytes.
+		# @parameter count [Integer] The total count of objects.
 		def initialize(size = 0, count = 0)
 			@size = size
 			@count = count
@@ -103,17 +109,24 @@ module Memory
 			return new(size, count)
 		end
 		
+		# Convert this usage to a JSON-compatible hash.
+		# @parameter options [Hash | Nil] Optional JSON serialization options.
+		# @returns [Hash] Hash with `:size` and `:count` keys.
 		def as_json(...)
 			{
 				size: @size,
-				count: @count
+					count: @count
 			}
 		end
 		
+		# Convert this usage to a JSON string.
+		# @returns [String] JSON representation of this usage.
 		def to_json(...)
 			as_json.to_json(...)
 		end
 		
+		# Generate a human-readable string representation.
+		# @returns [String] Formatted string showing size and allocation count.
 		def to_s
 			"(#{Memory.formatted_bytes(@size)} in #{@count} allocations)"
 		end

data/lib/memory/version.rb

@@ -7,5 +7,5 @@
 # Copyright, 2020-2025, by Samuel Williams.
 
 module Memory
-	VERSION = "0.11.0"
+	VERSION = "0.12.0"
 end

data/lib/memory.rb

@@ -37,4 +37,12 @@ module Memory
 	def self.report(&block)
 		self.capture(&block)
 	end
+	
+	# @namespace Used by the `memory-profiler` gem.
+	module Profiler
+	end
+	
+	# @namespace Used by the `memory-leaks` gem.
+	module Leaks
+	end
 end

data/readme.md

@@ -94,6 +94,10 @@ end
 
 Please see the [project releases](https://socketry.github.io/memory/releases/index) for all releases.
 
+### v0.11.1
+
+  - Compressed `Memory::Graph::Node` JSON representation for leaf nodes.
+
 ### v0.11.0
 
   - Remove support for `Memory::Usage.of(..., via:)` and instead use `Memory::Graph.for` which collects more detailed usage until the specified depth, at which point it delgates to `Memory::Usage.of`. This should be more practical.
@@ -132,10 +136,6 @@ Please see the [project releases](https://socketry.github.io/memory/releases/ind
 
   - Ensure aggregate keys are safe for serialization (and printing).
 
-### v0.7.0
-
-  - Add `Memory::Sampler#as_json` and `#to_json`.
-
 ## Contributing
 
 We welcome contributions to this project.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.11.1
+
+  - Compressed `Memory::Graph::Node` JSON representation for leaf nodes.
+
 ## v0.11.0
 
   - Remove support for `Memory::Usage.of(..., via:)` and instead use `Memory::Graph.for` which collects more detailed usage until the specified depth, at which point it delgates to `Memory::Usage.of`. This should be more practical.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memory
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -29,6 +29,7 @@ authors:
 - Olle Jonsson
 - Vasily Kolesnikov
 - William Tabi
+- Michael Go
 bindir: bin
 cert_chain:
 - |
@@ -145,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Memory profiling routines for Ruby 2.3+
 test_files: []