allocation_stats 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58815fef555e954a433a92b7cef4eddd6858569a
-  data.tar.gz: 6607ada6920ec63153e39418023e77d216eca304
+  metadata.gz: 1bab6c1d1c04a30dff3888fe15caf0c70dd4b270
+  data.tar.gz: 42e214b270edde7ff0829000f68b79c315837523
 SHA512:
-  metadata.gz: 6d4da2e5ad7dc0257b91124fbd506e58dece431047d9e73aee0f20d251c1a462477b1cba0a44c483122be048b2d8b5826d67e83acdf2802174f22e576e622591
-  data.tar.gz: 52e28c0ba9065822aef3bc575c00c39e1096603b26b610b6df5b912e70e5edd5e17db72bc88c4591f7df9e226201052b2fd42d775ead90ad30ca8c08286384ce
+  metadata.gz: 6cd17f62c21a31baec49f1d4e888d3bd05526a544ce77ace63dae4237c61a5d0f0f53195119a6c1ad0b3ac9ed9ae09e1b2519e7acbdbdb51e7406ed633f81feb
+  data.tar.gz: d52980763fdb7a9445b2ac2de36a8dc927aa0da69df5596841d275534acfddc9a85d7bf48f1e29a0a0e25ca8924f795292346b5017c6e31ba2b0de828fbd6faf

data/.gitignore

@@ -1,2 +1,3 @@
+coverage
 doc
 .yardoc

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+v0.1.3
+
+* Fixed: BasicObjects can be tracked; fixes #1
+* Added: much more documentation: up to 83%
+* Fixed: Working with new frozen String keys
+
 v0.1.2
 
 * Added: `homepage` in the gemspec

data/Gemfile

@@ -9,6 +9,7 @@ end
 
 group :test do
   gem "rspec"
+  gem "simplecov", require: false
   gem "pry"
 
   gem "yajl-ruby", "= 1.1.0"

data/Gemfile.lock

@@ -3,7 +3,9 @@ GEM
   specs:
     coderay (1.0.9)
     diff-lcs (1.2.4)
+    docile (1.1.1)
     method_source (0.8.2)
+    multi_json (1.8.2)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -16,6 +18,11 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.1)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
     slop (3.4.6)
     yajl-ruby (1.1.0)
     yard (0.8.7)
@@ -26,5 +33,6 @@ PLATFORMS
 DEPENDENCIES
   pry
   rspec
+  simplecov
   yajl-ruby (= 1.1.0)
   yard

data/TODO

@@ -1,3 +1,2 @@
-* release first gem version
 * more in the README
 * binary

data/allocation_stats.gemspec

@@ -3,18 +3,20 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "allocation_stats"
-  spec.version       = "0.1.2"
+  spec.version       = "0.1.3"
   spec.authors       = ["Sam Rawlins"]
   spec.email         = ["sam.rawlins@gmail.com"]
   spec.homepage      = "https://github.com/srawlins/allocation_stats"
   spec.license       = "Apache v2"
   spec.summary       = "Tooling for tracing object allocations in Ruby 2.1"
-  spec.description   = "Tooling for tracing object allocations in Ruby 2.1"
+  spec.description   = "Tooling for tracing object allocations in Ruby 2.1; " +
+                       "aggregate information about object allocations; group, " +
+                       "sort, and filter allocation information."
 
   spec.files         = `git ls-files`.split("\n")
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "< 3"
 
   # ">= 2.1.0" seems logical, but rubygems thought that "2.1.0.dev.0" did not fit that bill.
   # "> 2.0.0" was my next guess, but apparently "2.0.0.247" _does_ fit that bill.

data/lib/allocation_stats.rb

@@ -2,6 +2,7 @@
 # Licensed under the Apache License, Version 2.0, found in the LICENSE file.
 
 require "objspace"
+require_relative "allocation_stats/core_ext/basic_object"
 require_relative "allocation_stats/allocation"
 require_relative "allocation_stats/allocations_proxy"
 
@@ -38,6 +39,9 @@ class AllocationStats
 
   def initialize(burn: 0)
     @burn = burn
+    # Copying ridiculous workaround from:
+    # https://github.com/ruby/ruby/commit/7170baa878ac0223f26fcf8c8bf25492415e6eaa
+    Class.name
   end
 
   def self.trace(&block)
@@ -62,8 +66,8 @@ class AllocationStats
     @existing_object_ids = {}
 
     ObjectSpace.each_object.to_a.each do |object|
-      @existing_object_ids[object.object_id / 1000] ||= []
-      @existing_object_ids[object.object_id / 1000] << object.object_id
+      @existing_object_ids[object.__id__ / 1000] ||= []
+      @existing_object_ids[object.__id__ / 1000] << object.__id__
     end
 
     ObjectSpace.trace_object_allocations {
@@ -77,6 +81,9 @@ class AllocationStats
     return self
   end
 
+  # Begin tracing object allocations. Tracing must be stopped with
+  # AllocationStats#stop. Garbage collection is disabled while tracing is
+  # enabled.
   def start
     GC.start
     GC.disable
@@ -84,8 +91,8 @@ class AllocationStats
     @existing_object_ids = {}
 
     ObjectSpace.each_object.to_a.each do |object|
-      @existing_object_ids[object.object_id / 1000] ||= []
-      @existing_object_ids[object.object_id / 1000] << object.object_id
+      @existing_object_ids[object.__id__ / 1000] ||= []
+      @existing_object_ids[object.__id__ / 1000] << object.__id__
     end
 
     ObjectSpace.trace_object_allocations_start
@@ -98,13 +105,14 @@ class AllocationStats
     ObjectSpace.each_object.to_a.each do |object|
       next if ObjectSpace.allocation_sourcefile(object).nil?
       next if ObjectSpace.allocation_sourcefile(object) == __FILE__
-      next if @existing_object_ids[object.object_id / 1000] &&
-              @existing_object_ids[object.object_id / 1000].include?(object.object_id)
+      next if @existing_object_ids[object.__id__ / 1000] &&
+              @existing_object_ids[object.__id__ / 1000].include?(object.__id__)
 
       @new_allocations << Allocation.new(object)
     end
   end
 
+  # Stop tracing object allocations that was started with AllocationStats#start.
   def stop
     collect_new_allocations
     ObjectSpace.trace_object_allocations_stop

data/lib/allocation_stats/allocation.rb

@@ -4,6 +4,7 @@
 require "json"
 
 class AllocationStats
+  # Information about an individual allocation is captured in this class.
   class Allocation
     # a convenience constants
     PWD = Dir.pwd
@@ -77,6 +78,16 @@ class AllocationStats
       alias_path ? sourcefile_alias : @sourcefile
     end
 
+    # Returns class name, plus, for Arrays, extended information. When all of
+    # the elements of the Array are instances of a total of three or fewer
+    # classes, then those classes are listed in brackets. For example:
+    #
+    # @example Array with only Fixnum and Bignum elements
+    #   allocation.class_plus  #=> "Array<Fixnum,Bignum>"
+    # @example Array with elements of class A, B, C, and D
+    #   allocation.class_plus  #=> "Array"
+    # @example String (not an Array)
+    #   allocation.class_plus  #=> "String"
     def class_plus
       case @object
       when Array

data/lib/allocation_stats/allocations_proxy.rb

@@ -139,6 +139,15 @@ class AllocationStats
       self
     end
 
+    # Group allocations by one or more attributes, that is, a list of symbols.
+    # Commonly, you might want to group allocations by:
+    #
+    # * :sourcefile, :sourceline, :class
+    # * :sourcefile, :method_id, :class
+    # * :classpath, :method_id, :class
+    #
+    # In this case, `:class` is the class of the allocated object (as opposed
+    # to `:classpath`, the classpath where the allocation occured).
     def group_by(*args)
       @group_keys = args
 
@@ -175,9 +184,9 @@ class AllocationStats
           lambda { |allocation| allocation.sourcefile(@alias_paths) }
         elsif Allocation::HELPERS.include?(faux) ||
               Allocation::ATTRIBUTES.include?(faux)
-          lambda { |allocation| allocation.send(faux) }
+          lambda { |allocation| allocation.__send__(faux) }
         else
-          lambda { |allocation| allocation.object.send(faux) }
+          lambda { |allocation| allocation.object.__send__(faux) }
         end
       end
     end
@@ -237,6 +246,9 @@ class AllocationStats
       to_a.to_json
     end
 
+    # Return tabular information about the un-grouped list of Allocations.
+    #
+    # @private
     def to_text_from_plain(resolved, columns: DEFAULT_COLUMNS)
       getters = attribute_getters(columns)
 
@@ -263,6 +275,9 @@ class AllocationStats
     end
     private :to_text_from_plain
 
+    # Return tabular information about the grouped Allocations.
+    #
+    # @private
     def to_text_from_groups(resolved)
       columns = @group_keys + ["count"]
 

data/lib/allocation_stats/core_ext/basic_object.rb

@@ -0,0 +1,11 @@
+# monkey patch to BasicObject, allowing it to respnd to :class
+#
+# @private
+class BasicObject
+  # monkey patch to BasicObject, allowing it to respnd to :class
+  #
+  # @private
+  def class
+    (class << self; self end).superclass
+  end
+end

data/spec/allocation_stats/allocations_proxy_spec.rb

@@ -53,6 +53,22 @@ describe AllocationStats::AllocationsProxy do
     results.keys.should include([__FILE__, Array])
   end
 
+  it "should track new BasicObjects" do
+    class BO < BasicObject; end
+
+    stats = AllocationStats.trace do
+      bo = BO.new
+    end
+
+    results = stats.allocations.group_by(:sourcefile).all
+    expect(results.class).to be(Hash)
+    expect(results.keys.size).to eq(1)
+    expect(results.keys.first).to eq([__FILE__])
+    expect(results[[__FILE__]].class).to eq(Array)
+    expect(results[[__FILE__]].size).to eq(1)
+    expect(results[[__FILE__]].first.object.class).to be(BO)
+  end
+
   it "should track new objects by path and class_name (Array with 1x type)" do
     stats = AllocationStats.trace do
       square_groups = []
@@ -312,7 +328,7 @@ describe AllocationStats::AllocationsProxy do
       first = {
         "file" => "<PWD>/spec/spec_helper.rb",
         "file (raw)" =>  "/usr/local/google/home/srawlins/code/allocation_stats/spec/spec_helper.rb",
-        "line" => 20,
+        "line" => 23,
         "class_path" => "MyClass",
         "method_id" => :my_method.to_s,
         "memsize" => 192,

data/spec/allocation_stats_spec.rb

@@ -33,14 +33,14 @@ describe AllocationStats do
     stats.new_allocations.size.should == 1
   end
 
-  it "should only track new objects; String keys in Hashes count twice :(" do
+  it "should only track new objects; String keys in Hashes are frozen" do
     existing_array = [1,2,3,4,5]
 
     stats = AllocationStats.trace do
       new_hash = {"foo" => "bar", "baz" => "quux"}
     end
 
-    stats.new_allocations.size.should == 7
+    stats.new_allocations.size.should == 3
   end
 
   it "should only track new objects, using instance method" do

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 # Copyright 2013 Google Inc. All Rights Reserved.
 # Licensed under the Apache License, Version 2.0, found in the LICENSE file.
 
+require "simplecov"
+SimpleCov.start
+
 require_relative "../lib/allocation_stats"
 require "yaml"
 require "yajl"

metadata

@@ -1,30 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: allocation_stats
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Sam Rawlins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-04 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Tooling for tracing object allocations in Ruby 2.1
+        version: '3'
+description: Tooling for tracing object allocations in Ruby 2.1; aggregate information
+  about object allocations; group, sort, and filter allocation information.
 email:
 - sam.rawlins@gmail.com
 executables: []
@@ -51,6 +52,7 @@ files:
 - lib/allocation_stats.rb
 - lib/allocation_stats/allocation.rb
 - lib/allocation_stats/allocations_proxy.rb
+- lib/allocation_stats/core_ext/basic_object.rb
 - spec/allocation_stats/allocations_proxy_spec.rb
 - spec/allocation_stats_spec.rb
 - spec/spec_helper.rb
@@ -74,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.preview.1
+rubygems_version: 2.2.0.rc.1
 signing_key: 
 specification_version: 4
 summary: Tooling for tracing object allocations in Ruby 2.1