memory_profiler 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dea36221189a4ea796d262870a9a09acf48fcfe3b6321814fc3e86cc1f4c37db
-  data.tar.gz: '059ab396fc3c0e928046dd3f5c0e6271a616a369f427ee8d134521bb934e8cd8'
+  metadata.gz: e4c8c5a12cd11ab3f9c5ab852e6bca0cb442ccc25f54997f49243a19aa6cef9b
+  data.tar.gz: 5c0ca217ca3cbc0edca725071512688443ac24a5d3e9f28980d93d3dd30a323f
 SHA512:
-  metadata.gz: 69a830fb9ac126817342cc84e70f0796417d119ae337172a6b79a26d10e78a08146a4496915c384c7f993e8c514d43168e8e9d1d925acb856ca77092bdd1535e
-  data.tar.gz: 6de39e21847f551fac3b53107e5fa9d8cba5c6d00cfd39fb104432bc44f83008afefe9c46138ce4560e91880f245456b00f60718593198d735a379e4d93b8d71
+  metadata.gz: 11d3bf57b920c915a0a98f6cea8798349983b0c64047f481ab1227301ff100a8de16f858ee7d21028d32e3dd04015446f77555bfd050755637714da5d1cc08b3
+  data.tar.gz: 46d2df335163a6ddc35ea3a0eff97573dc7b8a50d671e9aa8940a5acb300ea342d7eb38e10f03f39f3705c4e9ed318a336c68f72ddf39a5cdf4f6bb81b9cc7e5

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.0.1 - 23-10-2022
+
+- Adapts tests to Ruby 3.0 / 3.1
+- Lazy report evaluation
+- Tested under Truffle Ruby
+
 ## 1.0.0 - 02-12-2020
 
 - Added new CLI `ruby-memory-profiler` which can be used to profile scripts @fatkodima

data/README.md

@@ -112,7 +112,7 @@ The `pretty_print` method can take a few options:
 * `to_file`: a path to your log file - can be given a String
 * `color_output`: a flag for whether to colorize output - can be given a Boolean
 * `retained_strings`: how many retained strings to print - can be given an Integer
-* `allocated_strings`: how many allocated strings to print - can be given a String
+* `allocated_strings`: how many allocated strings to print - can be given a Integer
 * `detailed_report`: should report include detailed information - can be given a Boolean
 * `scale_bytes`: flag to convert byte units (e.g. 183200000 is reported as 183.2 MB, rounds with a precision of 2 decimal digits) - can be given a Boolean
 * `normalize_paths`: flag to remove a gem's directory path from printed locations - can be given a Boolean

data/lib/memory_profiler/helpers.rb

@@ -16,7 +16,7 @@ module MemoryProfiler
           gemname
         elsif /\/rubygems[\.\/]/ =~ path
           "rubygems"
-        elsif /ruby\/2\.[^\/]+\/(?<stdlib>[^\/\.]+)/ =~ path
+        elsif /ruby\/\d\.[^\/]+\/(?<stdlib>[^\/\.]+)/ =~ path
           stdlib
         elsif /(?<app>[^\/]+\/(bin|app|lib))/ =~ path
           app

data/lib/memory_profiler/reporter.rb

@@ -34,8 +34,7 @@ module MemoryProfiler
     end
 
     def start
-      GC.start
-      GC.start
+      3.times { GC.start }
       GC.start
       GC.disable
 
@@ -49,8 +48,11 @@ module MemoryProfiler
       retained = StatHash.new.compare_by_identity
 
       GC.enable
-      GC.start
-      GC.start
+      # for whatever reason doing GC in a block is more effective at
+      # freeing objects.
+      # full_mark: true, immediate_mark: true, immediate_sweep: true are already default
+      3.times { GC.start }
+      # another start outside of the block to release the block
       GC.start
 
       # Caution: Do not allocate any new Objects between the call to GC.start and the completion of the retained
@@ -86,8 +88,6 @@ module MemoryProfiler
     # Iterates through objects in memory of a given generation.
     # Stores results along with meta data of objects collected.
     def object_list(generation)
-
-      rvalue_size = GC::INTERNAL_CONSTANTS[:RVALUE_SIZE]
       helper = Helpers.new
 
       result = StatHash.new.compare_by_identity
@@ -114,7 +114,7 @@ module MemoryProfiler
           string = klass == String ? helper.lookup_string(obj) : nil
 
           # compensate for API bug
-          memsize = rvalue_size if memsize > 100_000_000_000
+          memsize = GC::INTERNAL_CONSTANTS[:RVALUE_SIZE] if memsize > 100_000_000_000
           result[obj.__id__] = MemoryProfiler::Stat.new(class_name, gem, file, location, memsize, string)
         rescue
           # give up if any any error occurs inspecting the object

data/lib/memory_profiler/results.rb

@@ -24,7 +24,16 @@ module MemoryProfiler
 
       TYPES.each do |type|
         METRICS.each do |metric|
-          attr_accessor "#{type}_#{metric}_by_#{name}"
+          class_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def #{type}_#{metric}_by_#{name}                                                  # def allocated_memory_by_file
+              @#{type}_#{metric}_by ||= {}                                                    #   @allocated_memory_by ||= {}
+                                                                                              #
+              @#{type}_#{metric}_by['#{name}'] ||= begin                                      #   @allocated_memory_by['file'] ||= begin
+                _, stat_attribute = @@lookups.find { |(n, _stat_attribute)| n == '#{name}' }  #     _, stat_attribute = @@lookups.find { |(n, _stat_attribute)| n == 'file' }
+                @#{type}.top_n_#{metric}(@top, stat_attribute)                                #     @allocated.top_n_memory(@top, stat_attribute)
+              end                                                                             #   end
+            end                                                                               # end
+          RUBY
         end
       end
     end
@@ -34,27 +43,20 @@ module MemoryProfiler
     register_type 'location', :location
     register_type 'class', :class_name
 
-    attr_accessor :strings_retained, :strings_allocated
+    attr_writer :strings_retained, :strings_allocated
     attr_accessor :total_retained, :total_allocated
     attr_accessor :total_retained_memsize, :total_allocated_memsize
 
-    def register_results(allocated, retained, top)
-
-      @@lookups.each do |name, stat_attribute|
-
-        memsize_results, count_results = allocated.top_n(top, stat_attribute)
-
-        self.send("allocated_memory_by_#{name}=", memsize_results)
-        self.send("allocated_objects_by_#{name}=", count_results)
-
-        memsize_results, count_results = retained.top_n(top, stat_attribute)
-
-        self.send("retained_memory_by_#{name}=", memsize_results)
-        self.send("retained_objects_by_#{name}=", count_results)
-      end
+    def initialize
+      @allocated = StatHash.new
+      @retained = StatHash.new
+      @top = 50
+    end
 
-      self.strings_allocated = string_report(allocated, top)
-      self.strings_retained = string_report(retained, top)
+    def register_results(allocated, retained, top)
+      @allocated = allocated
+      @retained = retained
+      @top = top
 
       self.total_allocated = allocated.size
       self.total_allocated_memsize = total_memsize(allocated)
@@ -64,6 +66,14 @@ module MemoryProfiler
       self
     end
 
+    def strings_allocated
+      @strings_allocated ||= string_report(@allocated, @top)
+    end
+
+    def strings_retained
+      @strings_retained ||= string_report(@retained, @top)
+    end
+
     def scale_bytes(bytes)
       return "0 B" if bytes.zero?
 
@@ -139,10 +149,10 @@ module MemoryProfiler
             end
           end
         end
-      end
 
-      io.puts
-      print_string_reports(io, options)
+        io.puts
+        print_string_reports(io, options)
+      end
 
       io.close if io.is_a? File
     end
@@ -162,7 +172,7 @@ module MemoryProfiler
       @normalize_path[path] ||= begin
         if %r!(/gems/.*)*/gems/(?<gemname>[^/]+)(?<rest>.*)! =~ path
           "#{gemname}#{rest}"
-        elsif %r!ruby/2\.[^/]+/(?<stdlib>[^/.]+)(?<rest>.*)! =~ path
+        elsif %r!ruby/\d\.[^/]+/(?<stdlib>[^/.]+)(?<rest>.*)! =~ path
           "ruby/lib/#{stdlib}#{rest}"
         elsif %r!(?<app>[^/]+/(bin|app|lib))(?<rest>.*)! =~ path
           "#{app}#{rest}"

data/lib/memory_profiler/top_n.rb

@@ -5,32 +5,40 @@ module MemoryProfiler
     # Fast approach for determining the top_n entries in a Hash of Stat objects.
     # Returns results for both memory (memsize summed) and objects allocated (count) as a tuple.
     def top_n(max, metric_method)
+      [
+        top_n_memory(max, metric_method),
+        top_n_objects(max, metric_method)
+      ]
+    end
 
+    def top_n_memory(max, metric_method)
       metric_memsize = Hash.new(0)
-      metric_objects_count = Hash.new(0)
 
       each_value do |value|
         metric = value.send(metric_method)
-
         metric_memsize[metric] += value.memsize
-        metric_objects_count[metric] += 1
       end
 
-      stats_by_memsize =
-        metric_memsize
-          .to_a
-          .sort_by! { |metric, memsize| [-memsize, metric] }
-          .take(max)
-          .map! { |metric, memsize| { data: metric, count: memsize } }
+      metric_memsize
+        .to_a
+        .sort_by! { |metric, memsize| [-memsize, metric] }
+        .take(max)
+        .map! { |metric, memsize| { data: metric, count: memsize } }
+    end
 
-      stats_by_count =
-        metric_objects_count
-          .to_a
-          .sort_by! { |metric, count| [-count, metric] }
-          .take(max)
-          .map! { |metric, count| { data: metric, count: count } }
+    def top_n_objects(max, metric_method)
+      metric_objects_count = Hash.new(0)
+
+      each_value do |value|
+        metric = value.send(metric_method)
+        metric_objects_count[metric] += 1
+      end
 
-      [stats_by_memsize, stats_by_count]
+      metric_objects_count
+        .to_a
+        .sort_by! { |metric, count| [-count, metric] }
+        .take(max)
+        .map! { |metric, count| { data: metric, count: count } }
     end
   end
 end

data/lib/memory_profiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MemoryProfiler
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memory_profiler
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2022-10-26 00:00:00.000000000 Z
 dependencies: []
 description: Memory profiling routines for Ruby 2.5+
 email:
@@ -52,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.20
 signing_key:
 specification_version: 4
 summary: Memory profiling routines for Ruby 2.5+