memory 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2400492846a2a2ac811dbdd279b3c1aa02446e6c2dfd45684e7c517d45ab3139
-  data.tar.gz: 649b747e821996d0aca2cb92782661916fb05b8c76418a8e95acef988f97909a
+  metadata.gz: 116b9be7bb4a7d1c7b906923132406708953a8e3e7d43687d82f7920192ad74f
+  data.tar.gz: bf093a25998cefbf01f8fbc79d92d23bc972c016596acb3678cd6303eb09e034
 SHA512:
-  metadata.gz: 34682359d1d6b6e04af1582fb9a3a43c798ca032a02fd79fe9f1f62ee00d4c717639867e41f53e998bfc2749afe9423e2a87865451b58de3e63cf033e40c2710
-  data.tar.gz: e5f1bbcf26cb1aae51c03d2fd465c38682ee35f8d9098af225791802ba5f9c34238d8b86993e10628b047da71c50336826ddf0f2beb1a0a204ffb244887894e0
+  metadata.gz: 403676e22f95cd9239f3da72898a9be935c100e236bd51a6fca58d2ebf472a33609efb373dff628cf5f6f1e7ed9ace28dc3abc45adbbdc9975d489539b2f853d
+  data.tar.gz: be14f62bb150ab3daec0c9743800e887e606b0ba1545725143484362278779451f9a98dab2a35126d4396d6a57e08c1ccdce28b1a21fe5e894516b16e235b79c

data/lib/memory/aggregate.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 module Memory
 	UNITS = {
@@ -31,7 +31,7 @@ module Memory
 			end
 			
 			def << allocation
-				self.memory += allocation.size
+				self.memory += allocation.memsize
 				self.count += 1
 			end
 			

data/lib/memory/report.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require_relative 'aggregate'
 
 module Memory
 	class Report
-		def self.general
+		def self.general(**options)
 			Report.new([
 				Aggregate.new("By Gem", &:gem),
 				Aggregate.new("By File", &:file),
@@ -15,10 +15,12 @@ module Memory
 				Aggregate.new("By Class", &:class_name),
 				ValueAggregate.new("Strings By Gem", &:gem),
 				ValueAggregate.new("Strings By Location", &:location),
-			])
+			], **options)
 		end
 		
-		def initialize(aggregates)
+		def initialize(aggregates, retained_only: true)
+			@retained_only = retained_only
+			
 			@total_allocated = Aggregate::Total.new
 			@total_retained = Aggregate::Total.new
 			
@@ -38,16 +40,25 @@ module Memory
 		def concat(allocations)
 			allocations.each do |allocation|
 				@total_allocated << allocation
-				@total_retained << allocation if allocation.retained
 				
-				@aggregates.each do |aggregate|
-					aggregate << allocation
+				if allocation.retained
+					@total_retained << allocation
+				end
+				
+				if !@retained_only || allocation.retained
+					@aggregates.each do |aggregate|
+						aggregate << allocation
+					end
 				end
 			end
 		end
 		
 		def print(io = $stderr)
-			io.puts "\# Memory Profile", nil
+			if @retained_only
+				io.puts "\# Retained Memory Profile", nil
+			else
+				io.puts "\# Memory Profile", nil
+			end
 			
 			io.puts "- Total Allocated: #{@total_allocated}"
 			io.puts "- Total Retained: #{@total_retained}"

data/lib/memory/sampler.rb

@@ -11,12 +11,14 @@
 # Copyright, 2018, by Jonas Peschla.
 # Copyright, 2018, by Espartaco Palma.
 # Copyright, 2020, by Jean Boussier.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require 'objspace'
 require 'msgpack'
 require 'console'
 
+require_relative 'cache'
+
 module Memory
 	class Wrapper < MessagePack::Factory
 		def initialize(cache)
@@ -67,6 +69,10 @@ module Memory
 			@allocated = Array.new
 		end
 		
+		def inspect
+			"#<#{self.class} #{@allocated.size} allocations>"
+		end
+		
 		attr :filter
 		
 		attr :cache
@@ -90,6 +96,9 @@ module Memory
 			
 			# **WARNING** Do not allocate any new Objects between the call to GC.start and the completion of the retained lookups. It is likely that a new Object would reuse an object_id from a GC'd object.
 			
+			# Overwrite any immediate values on the C stack to avoid retaining them.
+			ObjectSpace.dump(Object.new)
+			
 			GC.enable
 			3.times{GC.start}
 			
@@ -127,8 +136,8 @@ module Memory
 			@allocated.concat(allocations)
 		end
 		
-		def report
-			report = Report.general
+		def report(**options)
+			report = Report.general(**options)
 			
 			report.concat(@allocated)
 			
@@ -154,7 +163,7 @@ module Memory
 		def track_allocations(generation)
 			rvalue_size = GC::INTERNAL_CONSTANTS[:RVALUE_SIZE]
 			
-			allocated = Hash.new.compare_by_identity
+			allocated = Hash.new
 			
 			ObjectSpace.each_object do |object|
 				next unless ObjectSpace.allocation_generation(object) == generation

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-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 module Memory
-	VERSION = "0.4.1"
+	VERSION = "0.5.0"
 end

data/license.md

@@ -24,7 +24,7 @@ Copyright, 2019-2020, by Jean Boussier.
 Copyright, 2019, by Ashwin Maroli.  
 Copyright, 2019, by Olle Jonsson.  
 Copyright, 2019, by Danny Ben Shitrit.  
-Copyright, 2020-2023, by Samuel Williams.  
+Copyright, 2020-2024, by Samuel Williams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -49,41 +49,40 @@ report.print
 ``` ruby
 memory_sampler = nil
 config.before(:all) do |example_group|
-	name = example_group.class.description.gsub(/[^\w]+/, "-")
+	name = example_group.class.description.gsub(/[^\w]+/, '-')
 	path = "#{name}.mprof"
-	
+
 	skip if File.exist?(path)
-	
+
 	memory_sampler = Memory::Sampler.new
 	memory_sampler.start
 end
 
 config.after(:all) do |example_group|
-	name = example_group.class.description.gsub(/[^\w]+/, "-")
+	name = example_group.class.description.gsub(/[^\w]+/, '-')
 	path = "#{name}.mprof"
-	
+
 	if memory_sampler
 		memory_sampler.stop
-		
+
 		File.open(path, "w", encoding: Encoding::BINARY) do |io|
 			memory_sampler.dump(io)
 		end
-		
+
 		memory_sampler = nil
 	end
 end
 
 config.after(:suite) do
 	memory_sampler = Memory::Sampler.new
-	
-	Dir.glob("*.mprof") do |path|
-		memory_sampler.load(File.read(
-			path,
-			encoding: Encoding::BINARY,
-		))
+
+	Dir.glob('*.mprof') do |path|
+		$stderr.puts "Loading #{path}..."
+		memory_sampler.load(File.read(path, encoding: Encoding::BINARY))
 	end
-	
-	memory_sampler.results.print
+
+	$stderr.puts "Memory usage:"
+	memory_sampler.report.print
 end
 ```
 
@@ -128,4 +127,4 @@ This project uses the [Developer Certificate of Origin](https://developercertifi
 
 ### Contributor Covenant
 
-This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memory
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -61,7 +61,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake
@@ -125,7 +125,9 @@ files:
 homepage: https://github.com/socketry/memory
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://socketry.github.io/memory/
+  source_code_uri: https://github.com/socketry/memory.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -134,14 +136,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Memory profiling routines for Ruby 2.3+