allocation_stats 0.1.1

data/spec/allocation_stats_spec.rb

@@ -0,0 +1,74 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+require_relative File.join("spec_helper")
+
+describe AllocationStats do
+  it "should trace everything if TRACE_PROCESS_ALLOCATIONS" do
+    IO.popen({"TRACE_PROCESS_ALLOCATIONS" => "1"}, "ruby -r ./lib/allocation_stats -e 'puts 0'") do |io|
+      out = io.read
+      out.should match("Object Allocation Report")
+    end
+  end
+
+  it "should only track new objects" do
+    existing_array = [1,2,3,4,5]
+
+    stats = AllocationStats.trace do
+      new_array = [1,2,3,4,5]
+    end
+
+    stats.new_allocations.class.should be Array
+    stats.new_allocations.size.should == 1
+  end
+
+  it "should only track new objects, non-block mode" do
+    existing_array = [1,2,3,4,5]
+
+    stats = AllocationStats.trace
+    new_array = [1,2,3,4,5]
+    stats.stop
+
+    stats.new_allocations.class.should be Array
+    stats.new_allocations.size.should == 1
+  end
+
+  it "should only track new objects; String keys in Hashes count twice :(" 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
+  end
+
+  it "should only track new objects, using instance method" do
+    existing_array = [1,2,3,4,5]
+
+    stats = AllocationStats.new
+
+    stats.trace do
+      new_object = Object.new
+      new_array  = [4]
+      new_string = "yarn"
+    end
+
+    stats.new_allocations.class.should be Array
+    stats.new_allocations.size.should == 3
+  end
+
+  it "should only track new objects" do
+    existing_array = [1,2,3,4,5]
+
+    my_instance = MyClass.new
+
+    stats = AllocationStats.new(burn: 3).trace do
+      # this method instantiates 2**(n-1) Strings on the n'th call
+      my_instance.memoizing_method
+    end
+
+    stats.new_allocations.class.should be Array
+    stats.new_allocations.size.should == 8
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+# Copyright 2013 Google Inc. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0, found in the LICENSE file.
+
+require_relative "../lib/allocation_stats"
+require "yaml"
+require "yajl"
+require "pry"
+
+if RbConfig::CONFIG["MAJOR"].to_i < 2 || RbConfig::CONFIG["MINOR"].to_i < 1
+  warn "Error: AllocationStats requires Ruby 2.1 or greater"
+  exit 1
+end
+
+def allocate_a_string_from_spec_helper
+  return "a string from spec_helper"
+end
+
+class MyClass
+  def my_method
+    @new_hash = {0 => "foo", 1 => "bar"}
+  end
+
+  MY_METHOD_BODY_LINE = __LINE__ - 3
+
+  # This method allocates a different number of objects each call:
+  # 1st call: 1x Array, 1x String
+  # 2nd call;           2x Strings
+  # 3rd call;           4x Strings
+  # 4th call;           8x Strings
+  def memoizing_method
+    @c ||= []
+
+    (@c.size + 1).times { @c << "string" }
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: allocation_stats
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sam Rawlins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Tooling for tracing object allocations in Ruby 2.1
+email:
+- sam.rawlins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- TODO
+- allocation_stats.gemspec
+- examples/my_class.rb
+- examples/trace_my_class_group_by.rb
+- examples/trace_my_class_raw.rb
+- examples/trace_object_allocations.rb
+- examples/trace_psych_group_by.rb
+- examples/trace_psych_keys.rb
+- lib/active_support/core_ext/module/delegation.rb
+- lib/allocation_stats.rb
+- lib/allocation_stats/allocation.rb
+- lib/allocation_stats/allocations_proxy.rb
+- spec/allocation_stats/allocations_proxy_spec.rb
+- spec/allocation_stats_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- Apache v2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 2.0.99
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Tooling for tracing object allocations in Ruby 2.1
+test_files: []