heapy 0.1.4 → 0.2.0

data/lib/heapy/version.rb

@@ -1,3 +1,3 @@
 module Heapy
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: heapy
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - schneems
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-25 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '1.10'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -60,7 +74,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
+- ".github/workflows/check_changelog.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -73,50 +87,31 @@ files:
 - bin/heapy
 - heapy.gemspec
 - lib/heapy.rb
-- lib/heapy/alive.rb
 - lib/heapy/analyzer.rb
+- lib/heapy/diff.rb
 - lib/heapy/version.rb
-- scratch.rb
 - trace.rb
-- weird_memory/run.rb
-- weird_memory/singleton_class/singleton_class.rb
-- weird_memory/singleton_class/singleton_class_in_class.rb
-- weird_memory/singleton_class/singleton_class_in_proc.rb
-- weird_memory/singleton_class/singleton_class_method_in_proc.rb
-- weird_memory/singleton_class_instance_eval/singleton_class_instance_eval.rb
-- weird_memory/singleton_class_instance_eval/singleton_class_instance_eval_in_class.rb
-- weird_memory/singleton_class_instance_eval/singleton_class_instance_eval_in_proc.rb
-- weird_memory/singleton_class_instance_eval/singleton_class_instance_eval_method_in_proc.rb
-- weird_memory/string/string.rb
-- weird_memory/string/string_in_class.rb
-- weird_memory/string/string_in_proc.rb
-- weird_memory/string/string_method_in_proc.rb
-- weird_memory/times_map/times_map.rb
-- weird_memory/times_map/times_map_in_class.rb
-- weird_memory/times_map/times_map_in_proc.rb
-- weird_memory/times_map/times_map_method_in_proc.rb
 homepage: https://github.com/schneems/heapy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Inspects Ruby heap dumps
 test_files: []

data/lib/heapy/alive.rb

@@ -1,269 +0,0 @@
-require 'objspace'
-require 'stringio'
-
-module Heapy
-
-  # This is an experimental module and likely to change. Don't use in production.
-  #
-  # Use at your own risk. APIs are not stable.
-  #
-  # == What
-  #
-  # You can use it to trace objects to see if they are still "alive" in memory.
-  # Unlike the heapy CLI this is meant to be used in live running code.
-  #
-  # This works by retaining an object's address in memory, then running GC
-  # and taking a heap dump. If the object exists in the heap dump, it is retained.
-  # Since we have the whole heap dump we can also do things like find what is retaining
-  # your object preventing it from being collected.
-  #
-  # == Use It
-  #
-  # You need to first start tracing objects:
-  #
-  #   Heapy::Alive.start_object_trace!(heap_file: "./tmp/heap.json")
-  #
-  # Next in your code you want to specify the object ato trace
-  #
-  #   string = "hello world"
-  #   Heapy::Alive.trace_without_retain(string)
-  #
-  # When the code is done executing you can get a reference to all "tracer"
-  # objects by running:
-  #
-  #   Heapy::Alive.traced_objects.each do |tracer|
-  #     puts tracer.raw_json_hash if tracer.object_retained?
-  #   end
-  #
-  # A few helpful methods on `tracer` objects:
-  #
-  # - `raw_json_hash` returns the hash of the object from the heap dump.
-  # - `object_retained?` returns truthy if the object was still present in the heap dump.
-  # - `address` a string of the memory address of the object you're tracing.
-  # - `tracked_to_s` a string that represents the object you're tracing (default
-  #    is result of calling inspect on the method). You can pass in a custom representation
-  #    when initializing the object. Can be useful for when `inspect` on the object you
-  #    are tracing is too verbose.
-  # - `id2ref` returns the original object being traced (if it is still in memory).
-  # - `root?` returns false if the tracer isn't the root object.
-  #
-  # See `ObjectTracker` for more methods.
-  #
-  # If you want to see what retains an object, you can use `ObectTracker#retained_by`
-  # method (caution this is extremely expensive and requires re-walking the whole heap dump:
-  #
-  #   Heapy::Alive.traced_objects.each do |tracer|
-  #     if tracer.object_retained?
-  #       puts "Traced: #{tracer.raw_json_hash}"
-  #       tracer.retained_by.each do |retainer|
-  #         puts "  Retained by: #{retainer.raw_json_hash}"
-  #       end
-  #     end
-  #   end
-  #
-  # You can iterate up the whole retained tree by using the `retained_by` method on tracers
-  # returned. But again it's expensive. If you have large heap dump or if you're tracing a bunch
-  # of objects, continuously calling `retained_by` will take lots of time. We also don't
-  # do any circular dependency detection so if you have two objects that depend on each other,
-  # you may hit an infinite loop.
-  #
-  # If you know that you'll need the retained objects of the main objects you're tracing you can
-  # save re-walking the heap the first N times by using the `retained_by` flag:
-  #
-  #   Heapy::Alive.traced_objects(retained_by: true) do |tracer|
-  #     # ...
-  #   end
-  #
-  # This will pre-fetch the first level of "parents" for each object you're tracing.
-  #
-  # Did I mention this is all experimental and may change?
-  module Alive
-    @mutex = Mutex.new
-    @retain_hash = {}
-    @heap_file   = nil
-    @started     = false
-
-    def self.address_to_object(address)
-      obj_id = address.to_i(16) / 2
-      ObjectSpace._id2ref(obj_id)
-    rescue RangeError
-      nil
-    end
-
-    def self.start_object_trace!(heap_file: "./tmp/heap.json")
-      @mutex.synchronize do
-        @started   ||= true && ObjectSpace.trace_object_allocations_start
-        @heap_file ||= heap_file
-      end
-    end
-
-    def self.trace_without_retain(object, to_s: nil)
-      tracker = ObjectTracker.new(object_id: object.object_id, to_s: to_s || object.inspect)
-      @mutex.synchronize do
-        @retain_hash[tracker.address] = tracker
-      end
-    end
-
-    def self.retained_by(tracer: nil, address: nil)
-      target_address = address || tracer.address
-      tracer         = tracer  || @retain_hash[address]
-
-      raise "not a valid address #{target_address}" if target_address.nil?
-
-      retainer_array = []
-      Analyzer.new(@heap_file).read do |json_hash|
-        retainers_from_json_hash(json_hash, target_address: target_address, retainer_array: retainer_array)
-      end
-
-      retainer_array
-    end
-
-    class << self
-      private def retainers_from_json_hash(json_hash, retainer_array:, target_address:)
-        references = json_hash["references"]
-        return unless references
-
-        references.each do |address|
-          next unless address == target_address
-
-          if json_hash["root"]
-            retainer = RootTracker.new(json_hash)
-          else
-            address        = json_hash["address"]
-            representation = self.address_to_object(address)&.inspect || "object not traced".freeze
-            retainer = ObjectTracker.new(address: address, to_s: representation)
-            retainer.raw_json_hash = json_hash
-          end
-
-          retainer_array << retainer
-        end
-      end
-    end
-
-  private
-    @string_io = StringIO.new
-    # GIANT BALL OF HACKS || THERE BE DRAGONS
-    #
-    # There is so much I don't understand on why I need to do the things
-    # I'm doing in this method.
-    #
-    # Also see `living_dead` https://github.com/schneems/living_dead
-    def self.gc_start
-      # During debugging I found calling "puts" made some things
-      # mysteriously work, I have no idea why. If you remove this line
-      # then (more) tests fail. Maybe it has something to do with the way
-      # GC interacts with IO? I seriously have no idea.
-      #
-      @string_io.puts "=="
-
-      # Calling flush so we don't create a memory leak.
-      # Funny enough maybe calling flush without `puts` also works?
-      # IDK
-      #
-      @string_io.flush
-
-      # Calling GC multiple times fixes a different class of things
-      # Specifically the singleton_class.instance_eval tests.
-      # It might also be related to calling GC in a block, but changing
-      # to 1.times brings back failures.
-      #
-      # Calling 2 times results in eventual failure https://twitter.com/schneems/status/804369346910896128
-      # Calling 5 times results in eventual failure https://twitter.com/schneems/status/804382968307445760
-      # Trying 10 times
-      #
-      10.times { GC.start }
-    end
-  public
-
-    def self.traced_objects(retained_by: false)
-      raise "You aren't tracing anything call Heapy::Alive.trace_without_retain first" if @retain_hash.empty?
-      self.gc_start
-
-      ObjectSpace.dump_all(output: File.open(@heap_file,'w'))
-
-      retainer_address_array_hash = {}
-
-      Analyzer.new(@heap_file).read do |json_hash|
-        address = json_hash["address"]
-        tracer = @retain_hash[address]
-        next unless tracer
-        tracer.raw_json_hash = json_hash
-
-        if retained_by
-          retainers_from_json_hash(json_hash, target_address: address, retainer_array: tracer.retained_by)
-        end
-      end
-      @retain_hash.values
-    end
-
-    class RootTracker
-      def initialize(json)
-        @raw_json_hash = json
-      end
-
-      def references
-        []
-      end
-
-      def id2ref
-        raise "cannot turn root object into an object"
-      end
-
-      def root?
-        true
-      end
-
-      def address
-        raise "root does not have an address"
-      end
-
-      def object_retained?
-        true
-      end
-
-      def tracked_to_s
-        "ROOT"
-      end
-    end
-
-    class ObjectTracker
-      attr_reader :address, :tracked_to_s
-
-      def initialize(object_id: nil, address: nil, to_s: )
-        if object_id
-          @address = "0x#{ (object_id << 1).to_s(16) }"
-        else
-          @address = address
-        end
-
-        raise "must provide address: #{@address.inspect}" if @address.nil?
-
-        @tracked_to_s = to_s.dup
-        @retained_by  = nil
-      end
-
-      def id2ref
-        Heapy::Alive.address_to_object(address)
-      end
-
-      def root?
-        false
-      end
-
-      def object_retained?
-        raw_json_hash && raw_json_hash["address"]
-      end
-
-      def retainer_array
-        @retained_by ||= []
-        @retained_by
-      end
-
-      def retained_by
-        @retained_by || Heapy::Alive.retained_by(tracer: self)
-      end
-
-      attr_accessor :raw_json_hash
-    end
-  end
-end

data/scratch.rb

@@ -1,64 +0,0 @@
-
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(__FILE__, "../lib")))
-
-load File.expand_path(File.join(__FILE__, "../lib/heapy.rb"))
-
-
-# class Foo
-# end
-
-# class Bar
-# end
-
-# class Baz
-# end
-
-# def run
-#     foo = Foo.new
-#     Heapy::Alive.trace_without_retain(foo)
-#     foo.singleton_class
-#     foo = nil
-
-#     bar = Bar.new
-#     Heapy::Alive.trace_without_retain(bar)
-#     bar.singleton_class
-#     bar = nil
-
-#     baz = Baz.new
-#     Heapy::Alive.trace_without_retain(baz)
-#     baz.singleton_class
-#     baz = nil
-#   nil
-# end
-
-# Heapy::Alive.start_object_trace!
-
-# run
-
-# objects = Heapy::Alive.traced_objects.each do |obj|
-#   puts "Address: #{obj.address} #{obj.tracked_to_s}\n  #{obj.raw_json_hash || "not found" }"
-# end
-
-Heapy::Alive.start_object_trace!
-
-def run
-  foo = ""
-  Heapy::Alive.trace_without_retain(foo)
-  b = []
-  b << foo
-  b
-end
-
-c = run
-
-objects = Heapy::Alive.traced_objects.each do |tracer|
-  puts "== Address: #{tracer.address} #{tracer.tracked_to_s}\n  #{tracer.raw_json_hash || "not found" }"
-  # tracer.raw_json_hash["references"].each do |address|
-  #   puts Heapy::Alive.address_to_object(address)
-  # end
-  Heapy::Alive.retained_by(tracer: tracer).each do |obj|
-    puts obj.inspect
-  end
-end