memory 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c553347c5941efab19b0f3df37824d10193cbf138582cfc5d24a598ba5a850
-  data.tar.gz: edac25b5c09088fabde46d7af1cc5603897d26d5543b3c8b49adea9a92ef6c68
+  metadata.gz: 2400492846a2a2ac811dbdd279b3c1aa02446e6c2dfd45684e7c517d45ab3139
+  data.tar.gz: 649b747e821996d0aca2cb92782661916fb05b8c76418a8e95acef988f97909a
 SHA512:
-  metadata.gz: 69d25c208346c039acf4c7b190c9b9eece09e7f6fc970db1d4191ed384d2cd74b0650f1c5e69d744e8a1344021c39945d0e21604706887d8495a3f719682bbf9
-  data.tar.gz: 0d5d16c7def274988e920930c181e6abf0d5d32b60489d24d95d35b6fc9faa71e4cf285524246a53c3eb9ec589a6892af7685b52a3d320f933a130c0ca1f1553
+  metadata.gz: 34682359d1d6b6e04af1582fb9a3a43c798ca032a02fd79fe9f1f62ee00d4c717639867e41f53e998bfc2749afe9423e2a87865451b58de3e63cf033e40c2710
+  data.tar.gz: e5f1bbcf26cb1aae51c03d2fd465c38682ee35f8d9098af225791802ba5f9c34238d8b86993e10628b047da71c50336826ddf0f2beb1a0a204ffb244887894e0

data/bake/memory/profiler.rb

@@ -18,7 +18,7 @@ def check(paths:)
 	cache = Memory::Cache.new
 	wrapper = Memory::Wrapper.new(cache)
 	
-	measure = Console.logger.measure(report, total_size)
+	progress = Console.logger.progress(report, total_size)
 	
 	paths.each do |path|
 		Console.logger.info(report, "Loading #{path}, #{Memory.formatted_bytes File.size(path)}")
@@ -29,7 +29,7 @@ def check(paths:)
 			
 			report.concat(unpacker)
 			
-			measure.increment(io.size)
+			progress.increment(io.size)
 		end
 		
 		Console.logger.info(report, "Loaded allocations, #{report.total_allocated}")

data/lib/memory/aggregate.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2023, by Samuel Williams.
 
 module Memory
 	UNITS = {
@@ -43,7 +43,7 @@ module Memory
 				"(#{Memory.formatted_bytes memory} in #{count} allocations)"
 			end
 			
-			def as_json
+			def as_json(options = nil)
 				{
 					memory: memory,
 					count: count
@@ -89,11 +89,11 @@ module Memory
 			io.puts nil
 		end
 		
-		def as_json
+		def as_json(options = nil)
 			{
 				title: @title,
-				total: @total.as_json,
-				totals: @totals.map{|k, v| [k, v.as_json]}
+				total: @total.as_json(options),
+				totals: @totals.map{|k, v| [k, v.as_json(options)]}
 			}
 		end
 	end
@@ -130,7 +130,7 @@ module Memory
 			end
 		end
 		
-		def as_json
+		def as_json(options = nil)
 			{
 				title: @title,
 				aggregates: @aggregates.map{|k, v| [k, v.as_json]}

data/lib/memory/report.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2023, by Samuel Williams.
 
 require_relative 'aggregate'
 
@@ -26,7 +26,15 @@ module Memory
 		end
 		
 		attr :total_allocated
+		attr :total_retained
+		attr :aggregates
 		
+		# Add all samples from the given sampler to this report.
+		def add(sampler)
+			self.concat(sampler.allocated)
+		end
+		
+		# Add allocations to this report.
 		def concat(allocations)
 			allocations.each do |allocation|
 				@total_allocated << allocation
@@ -37,7 +45,7 @@ module Memory
 				end
 			end
 		end
-
+		
 		def print(io = $stderr)
 			io.puts "\# Memory Profile", nil
 			
@@ -50,11 +58,11 @@ module Memory
 			end
 		end
 		
-		def as_json
+		def as_json(options = nil)
 			{
-				total_allocated: @total_allocated.as_json,
-				total_retained: @total_retained.as_json,
-				aggregates: @aggregates.map(&:as_json)
+				total_allocated: @total_allocated.as_json(options),
+				total_retained: @total_retained.as_json(options),
+				aggregates: @aggregates.map{|aggregate| aggregate.as_json(options)}
 			}
 		end
 		

data/lib/memory/sampler.rb

@@ -75,6 +75,9 @@ module Memory
 		
 		def start
 			GC.disable
+			3.times{GC.start}
+			
+			# Ensure any allocations related to the block are freed:
 			GC.start
 			
 			@generation = GC.count
@@ -90,6 +93,9 @@ module Memory
 			GC.enable
 			3.times{GC.start}
 			
+			# See above.
+			GC.start
+			
 			ObjectSpace.each_object do |object|
 				next unless ObjectSpace.allocation_generation(object) == @generation
 				

data/lib/memory/version.rb

@@ -7,5 +7,5 @@
 # Copyright, 2020-2022, by Samuel Williams.
 
 module Memory
-	VERSION = "0.3.0"
+	VERSION = "0.4.1"
 end

data/lib/memory.rb

@@ -13,10 +13,17 @@ require_relative "memory/report"
 require_relative "memory/sampler"
 
 module Memory
-	def self.report(&block)
+	def self.capture(report = nil, &block)
 		sampler = Sampler.new
 		sampler.run(&block)
 		
-		return sampler.report
+		report ||= Report.general
+		report.add(sampler)
+		
+		return report
+	end
+	
+	def self.report(&block)
+		self.capture(&block)
 	end
 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-2022, by Samuel Williams.  
+Copyright, 2020-2023, 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

@@ -121,3 +121,11 @@ We welcome contributions to this project.
 3.  Commit your changes (`git commit -am 'Add some feature'`).
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memory
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Sam Saffron
 - Dave Gynn
+- Samuel Williams
 - Nick LaMuro
 - Jonas Peschla
-- Samuel Williams
 - Ashwin Maroli
 - Søren Skovsbøll
 - Richard Schneeman
@@ -61,7 +61,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-11-15 00:00:00.000000000 Z
+date: 2023-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake
@@ -105,62 +105,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description:
 email:
 executables: []
@@ -190,14 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Memory profiling routines for Ruby 2.3+