memory 0.6.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ab40ebc992286597b6a01b5157fca5393b29563c7131483d2e7839f15172541
-  data.tar.gz: d5b9b73ea305840435c242a6e34bf755d94e77350846f6618467fef4fa7561ff
+  metadata.gz: 8f828b63a1b278be8fa689f21263c6850971984cb3de7d5743ea86b855c2585e
+  data.tar.gz: 162f043ffe9de59804533cd33ba3140531d56b2e454ccf29cad5fe7698f92d56
 SHA512:
-  metadata.gz: 5a10c287ab778c7deb2e12b5a04e7214107ae7afbdf12e57af3423128fe0dc9c233735892ae97ec18d90f47ba46856f08ab5624389a1cb61dbdc4d9af3733bf3
-  data.tar.gz: db0d83a8c69a4bdf37e058d6a9e304a7b0608791f8a1f89ad1f2864f2d4119aa8c61c9726b813800e4b45506e1cfa2eec7227ca8eeed99170b931927878e4efb
+  metadata.gz: 48a61fdd8df592811bb547cff195b00b21abc470633c7c7706ae9f2d5fe29b069443c468268e27372e9d808bc0f72bf25b14f19cf86d9bfdc9d98bdbb8163fee
+  data.tar.gz: 464a4ff8bdf9ef59afc9a0a18057b67862d467be36659b7a9efe1f35fda0c80bb1d14f23a3f570c733a7a68da4cb67b4e8b7a357e5dd9ca8a15f86243b84227e

data/bake/memory/report.rb

@@ -5,7 +5,7 @@
 
 def initialize(...)
 	super
-
+	
 	require_relative "../../lib/memory"
 end
 
@@ -26,6 +26,6 @@ def print(input:)
 	end
 	
 	report.print($stderr)
-
+	
 	return report
 end

data/bake/memory/sampler.rb

@@ -6,7 +6,7 @@
 def initialize(...)
 	super
 	
-	require_relative '../../lib/memory'
+	require_relative "../../lib/memory"
 end
 
 # Load a sampler from one or more .mprof files.
@@ -27,7 +27,7 @@ def load(paths:)
 	paths.each do |path|
 		Console.logger.info(sampler, "Loading #{path}, #{Memory.formatted_bytes File.size(path)}")
 		
-		File.open(path, 'r', encoding: Encoding::BINARY) do |io|
+		File.open(path, "r", encoding: Encoding::BINARY) do |io|
 			unpacker = wrapper.unpacker(io)
 			count = unpacker.read_array_header
 			
@@ -56,7 +56,7 @@ end
 # @parameter output [String] Path to write the .mprof file.
 # @returns [Memory::Sampler] The input sampler.
 def dump(path, input:)
-	File.open(path, 'w', encoding: Encoding::BINARY) do |io|
+	File.open(path, "w", encoding: Encoding::BINARY) do |io|
 		input.dump(io)
 	end
 	
@@ -76,7 +76,7 @@ def load_object_space_dump(path)
 	Console.logger.info(self, "Loading heap dump from #{path} (#{Memory.formatted_bytes(file_size)})")
 	
 	sampler = nil
-	File.open(path, 'r') do |io|
+	File.open(path, "r") do |io|
 		sampler = Memory::Sampler.load_object_space_dump(io) do |line_count, object_count|
 			# Update progress based on bytes read:
 			progress.increment(io.pos - progress.current)

data/lib/memory/aggregate.rb

@@ -129,7 +129,7 @@ module Memory
 			@title = title
 			@metric = block
 			
-			@aggregates = Hash.new{|h,k| h[k] = Aggregate.new(k.inspect, &@metric)}
+			@aggregates = Hash.new{|h,k| h[k] = Aggregate.new(safe_key(k.inspect), &@metric)}
 		end
 		
 		attr :title
@@ -169,10 +169,14 @@ module Memory
 		# @parameter options [Hash | Nil] Optional JSON serialization options.
 		# @returns [Hash] JSON-compatible representation.
 		def as_json(options = nil)
-			{
+			result = {
 				title: @title,
-				aggregates: @aggregates.map{|k, v| [k, v.as_json]}
+				aggregates: @aggregates.map{|k, v| [safe_key(k), v.as_json]}
 			}
 		end
+		
+		private def safe_key(key)
+			key.to_s.encode(Encoding::UTF_8, invalid: :replace, undef: :replace)
+		end
 	end
 end

data/lib/memory/report.rb

@@ -90,16 +90,16 @@ module Memory
 			}
 		end
 		
-	# Convert this report to a JSON string.
-	# @returns [String] JSON representation of this report.
-	def to_json(...)
-		as_json.to_json(...)
-	end
-
-	# Generate a human-readable representation of this report.
-	# @returns [String] Summary showing allocated and retained totals.
-	def inspect
-		"#<#{self.class}: #{@total_allocated} allocated, #{@total_retained} retained>"
+		# Convert this report to a JSON string.
+		# @returns [String] JSON representation of this report.
+		def to_json(...)
+			as_json.to_json(...)
+		end
+		
+		# Generate a human-readable representation of this report.
+		# @returns [String] Summary showing allocated and retained totals.
+		def inspect
+			"#<#{self.class}: #{@total_allocated} allocated, #{@total_retained} retained>"
+		end
 	end
 end
-end

data/lib/memory/sampler.rb

@@ -66,72 +66,72 @@ module Memory
 	# end
 	# ~~~
 	class Sampler
-	# Load allocations from an ObjectSpace heap dump.
-	#
-	# If a block is given, it will be called periodically with progress information.
-	#
-	# @parameter io [IO] The IO stream containing the heap dump JSON.
-	# @yields [line_count, object_count] Progress callback with current line and object counts.
-	# @returns [Sampler] A new sampler populated with allocations from the heap dump.
-	def self.load_object_space_dump(io, &block)
-		sampler = new
-		cache = sampler.cache
-		
-		line_count = 0
-		object_count = 0
-		report_interval = 10000
-		
-		io.each_line do |line|
-			line_count += 1
-			
-			begin
-				object = JSON.parse(line)
-			rescue JSON::ParserError
-				# Skip invalid JSON lines
-				next
-			end
-			
-			# Skip non-object entries (ROOT, SHAPE, etc.)
-			next unless object['address']
+		# Load allocations from an ObjectSpace heap dump.
+		#
+		# If a block is given, it will be called periodically with progress information.
+		#
+		# @parameter io [IO] The IO stream containing the heap dump JSON.
+		# @yields [line_count, object_count] Progress callback with current line and object counts.
+		# @returns [Sampler] A new sampler populated with allocations from the heap dump.
+		def self.load_object_space_dump(io, &block)
+			sampler = new
+			cache = sampler.cache
 			
-			# Get allocation information (may be nil if tracing wasn't enabled)
-			file = object['file'] || '(unknown)'
-			line_number = object['line'] || 0
+			line_count = 0
+			object_count = 0
+			report_interval = 10000
 			
-			# Get object type/class
-			type = object['type'] || 'unknown'
-			
-			# Get memory size
-			memsize = object['memsize'] || 0
-			
-			# Get value for strings
-			value = object['value']
-			
-			allocation = Allocation.new(
-				cache,
-				type,           # class_name
-				file,           # file
-				line_number,    # line
-				memsize,        # memsize
-				value,          # value (for strings)
-				true            # retained (all objects in heap dump are live)
-			)
+			io.each_line do |line|
+				line_count += 1
+				
+				begin
+					object = JSON.parse(line)
+				rescue JSON::ParserError
+					# Skip invalid JSON lines
+					next
+				end
+				
+				# Skip non-object entries (ROOT, SHAPE, etc.)
+				next unless object["address"]
+				
+				# Get allocation information (may be nil if tracing wasn't enabled)
+				file = object["file"] || "(unknown)"
+				line_number = object["line"] || 0
+				
+				# Get object type/class
+				type = object["type"] || "unknown"
+				
+				# Get memory size
+				memsize = object["memsize"] || 0
+				
+				# Get value for strings
+				value = object["value"]
+				
+				allocation = Allocation.new(
+					cache,
+					type,           # class_name
+					file,           # file
+					line_number,    # line
+					memsize,        # memsize
+					value,          # value (for strings)
+					true            # retained (all objects in heap dump are live)
+				)
+				
+				sampler.allocated << allocation
+				object_count += 1
+				
+				# Report progress periodically
+				if block && (object_count % report_interval == 0)
+					block.call(line_count, object_count)
+				end
+			end
 			
-			sampler.allocated << allocation
-			object_count += 1
+			# Final progress report
+			block.call(line_count, object_count) if block
 			
-			# Report progress periodically
-			if block && (object_count % report_interval == 0)
-				block.call(line_count, object_count)
-			end
+			return sampler
 		end
 		
-		# Final progress report
-		block.call(line_count, object_count) if block
-					
-		return sampler
-	end
-		
 		# Initialize a new sampler.
 		# @parameter filter [Block | Nil] Optional filter block to select which allocations to track.
 		def initialize(&filter)
@@ -231,6 +231,22 @@ module Memory
 			return report
 		end
 		
+		# Convert this sampler to a JSON-compatible summary.
+		# Returns the allocation count without iterating through all allocations.
+		# @parameter options [Hash | Nil] Optional JSON serialization options.
+		# @returns [Hash] JSON-compatible summary of sampler data.
+		def as_json(options = nil)
+			{
+				allocations: @allocated.size
+			}
+		end
+		
+		# Convert this sampler to a JSON string.
+		# @returns [String] JSON representation of this sampler summary.
+		def to_json(...)
+			as_json.to_json(...)
+		end
+		
 		# Collects object allocation and memory of ruby code inside of passed block.
 		def run(&block)
 			start

data/lib/memory/version.rb

@@ -4,8 +4,8 @@
 # Copyright, 2013-2019, by Sam Saffron.
 # Copyright, 2015-2016, by Dave Gynn.
 # Copyright, 2018, by Jonas Peschla.
-# Copyright, 2020-2024, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
 module Memory
-	VERSION = "0.6.1"
+	VERSION = "0.7.1"
 end

data/readme.md

@@ -94,6 +94,14 @@ end
 
 Please see the [project releases](https://socketry.github.io/memory/releases/index) for all releases.
 
+### v0.7.1
+
+  - Ensure aggregate keys are safe for serialization (and printing).
+
+### v0.7.0
+
+  - Add `Memory::Sampler#as_json` and `#to_json`.
+
 ### v0.6.0
 
   - Add agent context.

data/releases.md

@@ -1,5 +1,13 @@
 # Releases
 
+## v0.7.1
+
+  - Ensure aggregate keys are safe for serialization (and printing).
+
+## v0.7.0
+
+  - Add `Memory::Sampler#as_json` and `#to_json`.
+
 ## v0.6.0
 
   - Add agent context.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memory
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.1
 platform: ruby
 authors:
 - Sam Saffron