memory_profiler 0.9.12 → 0.9.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 144e3c662a07ad7303cd60990d43aef9c050028689fbfef285e8eadd8a161b78
-  data.tar.gz: c24f4ed76fc71ee0fb17b9edf5f2d46b621aeb443a2006cd34c2eddad7ddb101
+  metadata.gz: df0b1ccbb40909e048bc0064c0f340997ab72629274a71704885c0d1988eb14c
+  data.tar.gz: 73181a0702537823a3f040c1dbe64a8a432ef945fdc761d923b094c8194a57ce
 SHA512:
-  metadata.gz: f5a9469d8ef19bace4028033dbee40b62aad465933eb8f393f1f1e3ea72f0ac88a390b20412e4f3edbae333c12a1ab75d8b63669d5fddf09fe79cab7c5261f16
-  data.tar.gz: dbad24a4cad1d5ef4adaac6ed89cd79695cd23d2fde7eb0e45d8bcb3b3193da5fefd24a10aa8f9653fa74f94d33602379b023b94dd97d544ecfaea5b799d5fc1
+  metadata.gz: db95ae6758da369bba200ccc7da4af2c01115f9c2d55d607a5e2e0bf135825a65acb0b44393870bdc0cc8fb4e1d0310533e40560721ab9a22856f175f661d58f
+  data.tar.gz: e6e9ca6e80929277f9d937c516d6582d206360b086e38ccd15ce7fe2d4a9be14c684749f665a8151affd54bcc107068493a815bc0d4f60caa4660a473954717e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.9.13 - 22-03-2019
+
+- remove support explicitly for all EOL rubies, 2.1 and 2.2
+- frozen string literal comment @RST-J
+- scale_bytes option @RST-J
+
 ## 0.9.12
 - Correct bug under-reporting memory for large string allocation @sam
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 TODO: Write your name
+Copyright (c) 2013 Sam Saffron
 
 MIT License
 

data/README.md

@@ -3,11 +3,11 @@
 
 # MemoryProfiler
 
-A memory profiler for Ruby 
+A memory profiler for Ruby
 
-## Requirements 
+## Requirements
 
-Ruby(MRI) Version 2.1.0 and above. 
+Ruby(MRI) Version 2.3.8 and above.
 
 ## Installation
 
@@ -52,7 +52,9 @@ be the only time you can retrieve the report using this API.
 
 ## Options
 
-The report method can take a few options:
+### `report`
+
+The `report` method can take a few options:
 
 * `top`: maximum number of entries to display in a report (default is 50)
 * `allow_files`: include only certain files from tracing - can be given as a String, Regexp, or array of Strings
@@ -84,7 +86,20 @@ allocated memory by file
 . . .
 ```
 
-Also you can print report to file. For this use `pretty_print` method with `to_file` option and `path_to_your_log_file` string:
+### `pretty_print`
+
+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
+* `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
+
+Check out `Results#pretty_print` for more details.
+
+For example to report to file, use `pretty_print` method with `to_file` option and `path_to_your_log_file` string:
 ```
 $ pry
 pry> require 'memory_profiler'
@@ -364,7 +379,7 @@ The report breaks down 2 key concepts.
 
 **Allocated**: All object allocation and memory allocation during code block.
 
-As a general rule "retained" will always be smaller than or equal to allocated. 
+As a general rule "retained" will always be smaller than or equal to allocated.
 
 Memory profiler will tell you aggregate costs of the above, for example requiring the mime-types gem above results in approx 2MB of retained memory in 22K or so objects. The actual RSS cost will always be slightly higher as MRI heaps are not squashed to size and memory fragments. In future we may be able to calculate a rough long term GC cost of retained objects (for major GCs).
 

data/lib/memory_profiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "memory_profiler/version"
 require "memory_profiler/helpers"
 require "memory_profiler/polychrome"

data/lib/memory_profiler/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MemoryProfiler
   class Helpers
 
@@ -13,13 +15,13 @@ module MemoryProfiler
         if /(\/gems\/.*)*\/gems\/(?<gemname>[^\/]+)/ =~ path
           gemname
         elsif /\/rubygems[\.\/]/ =~ path
-          "rubygems".freeze
+          "rubygems"
         elsif /ruby\/2\.[^\/]+\/(?<stdlib>[^\/\.]+)/ =~ path
           stdlib
         elsif /(?<app>[^\/]+\/(bin|app|lib))/ =~ path
           app
         else
-          "other".freeze
+          "other"
         end
     end
 

data/lib/memory_profiler/monochrome.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MemoryProfiler
 
   class Monochrome

data/lib/memory_profiler/polychrome.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MemoryProfiler
 
   class Polychrome

data/lib/memory_profiler/reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'objspace'
 module MemoryProfiler
   # Reporter is the top level API used for generating memory reports.
@@ -86,7 +88,6 @@ module MemoryProfiler
     def object_list(generation)
 
       rvalue_size = GC::INTERNAL_CONSTANTS[:RVALUE_SIZE]
-      rvalue_size_adjustment = RUBY_VERSION < '2.2' ? rvalue_size : 0
       helper = Helpers.new
 
       result = StatHash.new.compare_by_identity
@@ -94,7 +95,7 @@ module MemoryProfiler
       ObjectSpace.each_object do |obj|
         next unless ObjectSpace.allocation_generation(obj) == generation
 
-        file = ObjectSpace.allocation_sourcefile(obj) || "(no name)".freeze
+        file = ObjectSpace.allocation_sourcefile(obj) || "(no name)"
         next if @ignore_files && @ignore_files =~ file
         next if @allow_files && !(@allow_files =~ file)
 
@@ -113,7 +114,7 @@ module MemoryProfiler
 
           # we do memsize first to avoid freezing as a side effect and shifting
           # storage to the new frozen string, this happens on @hash[s] in lookup_string
-          memsize = ObjectSpace.memsize_of(obj) + rvalue_size_adjustment
+          memsize = ObjectSpace.memsize_of(obj)
           string     = klass == String ? helper.lookup_string(obj) : nil
 
           # compensate for API bug

data/lib/memory_profiler/results.rb

@@ -1,5 +1,18 @@
+# frozen_string_literal: true
+
 module MemoryProfiler
   class Results
+    UNIT_PREFIXES = {
+      0 => 'B',
+      3 => 'kB',
+      6 => 'MB',
+      9 => 'GB',
+      12 => 'TB',
+      15 => 'PB',
+      18 => 'EB',
+      21 => 'ZB',
+      24 => 'YB'
+    }.freeze
 
     def self.register_type(name, stat_attribute)
       @@lookups ||= []
@@ -46,6 +59,14 @@ module MemoryProfiler
       self
     end
 
+    def scale_bytes(bytes)
+      return "0 B" if bytes.zero?
+
+      scale = Math.log10(bytes).div(3) * 3
+      scale = 24 if scale > 24
+      "#{(bytes / 10.0**scale).round(2)} #{UNIT_PREFIXES[scale]}"
+    end
+
     def string_report(data, top)
       grouped_strings = data.values.
         keep_if { |stat| stat.string_value }.
@@ -76,6 +97,7 @@ module MemoryProfiler
     # @option opts [Integer] :retained_strings how many retained strings to print
     # @option opts [Integer] :allocated_strings how many allocated strings to print
     # @option opts [Boolean] :detailed_report should report include detailed information
+    # @option opts [Boolean] :scale_bytes calculates unit prefixes for the numbers of bytes
     def pretty_print(io = $stdout, **options)
       # Handle the special case that Ruby PrettyPrint expects `pretty_print`
       # to be a customized pretty printing function for a class
@@ -86,8 +108,16 @@ module MemoryProfiler
       color_output = options.fetch(:color_output) { io.respond_to?(:isatty) && io.isatty }
       @colorize = color_output ? Polychrome.new : Monochrome.new
 
-      io.puts "Total allocated: #{total_allocated_memsize} bytes (#{total_allocated} objects)"
-      io.puts "Total retained:  #{total_retained_memsize} bytes (#{total_retained} objects)"
+      if options[:scale_bytes]
+        total_allocated_output = scale_bytes(total_allocated_memsize)
+        total_retained_output = scale_bytes(total_retained_memsize)
+      else
+        total_allocated_output = "#{total_allocated_memsize} bytes"
+        total_retained_output = "#{total_retained_memsize} bytes"
+      end
+
+      io.puts "Total allocated: #{total_allocated_output} (#{total_allocated} objects)"
+      io.puts "Total retained:  #{total_retained_output} (#{total_retained} objects)"
 
       if options[:detailed_report] != false
         io.puts
@@ -95,7 +125,8 @@ module MemoryProfiler
             .product(["memory", "objects"])
             .product(["gem", "file", "location", "class"])
             .each do |(type, metric), name|
-              dump "#{type} #{metric} by #{name}", self.send("#{type}_#{metric}_by_#{name}"), io
+              scale_data = metric == "memory" && options[:scale_bytes]
+              dump "#{type} #{metric} by #{name}", self.send("#{type}_#{metric}_by_#{name}"), io, scale_data
             end
       end
 
@@ -129,12 +160,13 @@ module MemoryProfiler
       nil
     end
 
-    def dump(description, data, io)
+    def dump(description, data, io, scale_data)
       io.puts description
       io.puts @colorize.line("-----------------------------------")
       if data && !data.empty?
         data.each do |item|
-          io.puts "#{item[:count].to_s.rjust(10)}  #{item[:data]}"
+          data_string = scale_data ? scale_bytes(item[:count]) : item[:count].to_s
+          io.puts "#{data_string.rjust(10)}  #{item[:data]}"
         end
       else
         io.puts "NO DATA"

data/lib/memory_profiler/stat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MemoryProfiler
   class Stat
 

data/lib/memory_profiler/stat_hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MemoryProfiler
   class StatHash < Hash
     include TopN

data/lib/memory_profiler/top_n.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MemoryProfiler
   module TopN
     # Fast approach for determining the top_n entries in a Hash of Stat objects.

data/lib/memory_profiler/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MemoryProfiler
-  VERSION = "0.9.12"
+  VERSION = "0.9.13"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: memory_profiler
 version: !ruby/object:Gem::Version
-  version: 0.9.12
+  version: 0.9.13
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies: []
-description: Memory profiling routines for Ruby 2.1+
+description: Memory profiling routines for Ruby 2.3+
 email:
 - sam.saffron@gmail.com
 executables: []
@@ -42,16 +42,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Memory profiling routines for Ruby 2.1+
+summary: Memory profiling routines for Ruby 2.3+
 test_files: []