allocation_stats 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bab6c1d1c04a30dff3888fe15caf0c70dd4b270
-  data.tar.gz: 42e214b270edde7ff0829000f68b79c315837523
+  metadata.gz: 67f90cfc4c5d04fb2be23255b4194c037a506ef4
+  data.tar.gz: 35c20f3a4e115f097f079c9f2c71e60eeadbf49a
 SHA512:
-  metadata.gz: 6cd17f62c21a31baec49f1d4e888d3bd05526a544ce77ace63dae4237c61a5d0f0f53195119a6c1ad0b3ac9ed9ae09e1b2519e7acbdbdb51e7406ed633f81feb
-  data.tar.gz: d52980763fdb7a9445b2ac2de36a8dc927aa0da69df5596841d275534acfddc9a85d7bf48f1e29a0a0e25ca8924f795292346b5017c6e31ba2b0de828fbd6faf
+  metadata.gz: 1a7d4b6a68b4ef81ba559f87b1cf2eeca88548f294a06f53423e2839049cb5c609e23e956665a1025057c07d66d5604619f4aacd041f4b13d4a174f82febd169
+  data.tar.gz: 17d1f24af19d8668461b4d1d31bf7b24ac84b18986c26f3566056524e1bf1affdf5d7061cdd40e2ccfdae126661a02cc96c9dc6bc54457f7de47c873e126a7ea

data/.gitignore

@@ -1,3 +1,4 @@
 coverage
 doc
 .yardoc
+demos

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+ - 2.1.0

data/CHANGELOG.markdown

@@ -1,3 +1,11 @@
+v0.1.4
+
+* Added: Build status now tracked with Travis
+* Fixed: Working... better? with new frozen String keys
+* Fixed: alias order changed so that PWD is searched after GEMDIR and
+  RUBYLIBDIR, in case of vendored bundler directory.
+* Added: `at_least` method for the AllocationsProxy, tested and documented
+
 v0.1.3
 
 * Fixed: BasicObjects can be tracked; fixes #1

data/Gemfile

@@ -8,6 +8,7 @@ group :development do
 end
 
 group :test do
+  gem "rake"
   gem "rspec"
   gem "simplecov", require: false
   gem "pry"

data/Gemfile.lock

@@ -10,6 +10,7 @@ GEM
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
+    rake (10.1.0)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)
@@ -32,6 +33,7 @@ PLATFORMS
 
 DEPENDENCIES
   pry
+  rake
   rspec
   simplecov
   yajl-ruby (= 1.1.0)

data/README.markdown

@@ -1,5 +1,8 @@
+AllocationStats [![Build Status](https://travis-ci.org/srawlins/allocation_stats.png?branch=master)](https://travis-ci.org/srawlins/allocation_stats)
+===============
+
 Introduction
-============
+------------
 
 AllocationStats is a rubygem that makes use of Ruby 2.1's new abilities to trace
 Ruby object allocations (MRI only). Ruby 2.1's new
@@ -11,8 +14,21 @@ AllocationStats collects all of the allocation information generated by
 `ObjectSpace.trace_object_allocations`, then provides mechanisms for filtering,
 grouping, and sorting the allocation information.
 
-Tabular Output examples
------------------------
+### Install
+
+To install AllocationStats, add the following line to a project's Gemfile, perhaps to the development group:
+
+```ruby
+gem 'allocation_stats'
+```
+
+or run the following command:
+
+```shell
+gem install allocation_stats
+```
+
+### Tabular Output examples
 
 It is very easy to get some simple statistics out of AllocationStats.
 Wrap some code with `AllocationStats.trace` and print out a listing of all of the
@@ -69,8 +85,7 @@ puts stats.allocations(alias_paths: true).group_by(:sourcefile, :sourceline, :cl
 (This full example is found in `examples/trace_my_class_group_by.rb`)
 
 
-More on `trace_object_allocations()`
----------------------------------------------
+### More on `trace_object_allocations()`
 
 To start at the beginning: Ruby 2.1 will be released with a new feature that
 enables one to trace object allocations. Through
@@ -99,8 +114,7 @@ allocations.rb
 4
 ```
 
-Example from the specs
-----------------------
+### Example from the specs
 
 ```ruby
 existing_array = [1,2,3,4,5]
@@ -177,8 +191,7 @@ You can see that there are three different groups:
 Only one allocation belongs to each of the first two groups, and two allocations
 make up the second group.
 
-A little slower
----------------
+### A little slower
 
 Let's look at this example a little slower. Firstly, let's look at how we
 collect object allocations using AllocationStats:
@@ -213,8 +226,7 @@ AllocationsProxy object back, so that transformations can be chained. The final
 call that will execute the transformations is `#to_a` (aliased to `#all`, just
 like ActiveRecord).
 
-Psych Example
--------------
+### Psych Example
 
 Let's look at an example with more varied allocations, using Ruby's Psych. This
 one is found in `examples/trace_psych_keys.rb`:
@@ -312,8 +324,7 @@ puts stats.allocations(alias_paths: true).group_by(:sourcefile, :class).to_text
 <RUBYLIBDIR>/psych/scalar_scanner.rb      MatchData                                 2
 ```
 
-Burn One
-========
+### Burn One
 
 If you find a lot of allocations in `kernel_require.rb` or a lot of allocations
 of `RubyVM::InstructuinSequences`, you can "burn" one or more calls to your
@@ -323,7 +334,7 @@ without tracing allocations, before calling the block a 4th time, tracing
 allocations.
 
 The API
-=======
+-------
 
 So what methods are available on that AllocationsProxy thing? So far, the API
 consists of:
@@ -346,10 +357,10 @@ consists of:
   ```ruby
   allocations.where(class: Array, size: ->(size) { size > 10 }
   ```
+* `#at_least(n)` selects allocation groups with at least `n` allocations per group.
 * `#bytes`, which has an inconsistent definition, I think... TODO
 
-What are faux attributes?
--------------------------
+### What are faux attributes?
 
 Valid values for `#group_by` and `#where` include:
 * instance variables on each `Allocation`. These include `:sourcefile`,
@@ -362,11 +373,10 @@ Valid values for `#group_by` and `#where` include:
 
 I'm calling these things that you can group by or filter by, "faux attributes."
 
-What is `class_plus`?
----------------------
+### What is `class_plus`?
 
 References
-==========
+----------
 
 This new feature was inspired by work that @tmm1 did at GitHub, as
 described in

data/allocation_stats.gemspec

@@ -3,20 +3,18 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "allocation_stats"
-  spec.version       = "0.1.3"
+  spec.version       = "0.1.4"
   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; " +
-                       "aggregate information about object allocations; group, " +
-                       "sort, and filter allocation information."
+  spec.description   = "Tooling for tracing object allocations in Ruby 2.1"
 
   spec.files         = `git ls-files`.split("\n")
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rspec", "< 3"
+  spec.add_development_dependency "rspec"
 
   # ">= 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/allocation.rb

@@ -59,12 +59,12 @@ class AllocationStats
     # @return the source file, aliased.
     def sourcefile_alias
       case
-      when @sourcefile[PWD]
-        @sourcefile.sub(PWD, "<PWD>")
       when @sourcefile[AllocationStats::RUBYLIBDIR]
         @sourcefile.sub(AllocationStats::RUBYLIBDIR, "<RUBYLIBDIR>")
       when @sourcefile[AllocationStats::GEMDIR]
         @sourcefile.sub(/#{AllocationStats::GEMDIR}\/gems\/([^\/]+)\//, '<GEM:\1>/')
+      when @sourcefile[PWD]
+        @sourcefile.sub(PWD, "<PWD>")
       else
         @sourcefile
       end

data/lib/allocation_stats/allocations_proxy.rb

@@ -94,6 +94,18 @@ class AllocationStats
     end
     alias :sort_by_count :sort_by_size
 
+    # Select allocation groups which have at least `count` allocations.
+    #
+    # @param [Fixnum] count the minimum number of Allocations for each group to
+    # be selected.
+    def at_least(count)
+      @mappers << Proc.new do |allocations|
+        allocations.delete_if { |key,value| value.size < count }
+      end
+
+      self
+    end
+
     # Select allocations for which the {Allocation#sourcefile sourcefile}
     # includes `pattern`.
     #

data/spec/allocation_stats/allocations_proxy_spec.rb

@@ -268,8 +268,8 @@ describe AllocationStats::AllocationsProxy do
       text = @stats.allocations.to_text
       spec_helper_plus_line = "#{SPEC_HELPER_PATH.ljust(MAX_PATH_LENGTH)}          #{MyClass::MY_METHOD_BODY_LINE}"
 
-      expect(text).to include("                                             sourcefile                                                sourceline  class_path  method_id  memsize   class")
-      expect(text).to include("-----------------------------------------------------------------------------------------------------  ----------  ----------  ---------  -------  -------")
+      expect(text).to include("#{"sourcefile".center(MAX_PATH_LENGTH)}  sourceline  class_path  method_id  memsize   class")
+      expect(text).to include("#{"-" * MAX_PATH_LENGTH}  ----------  ----------  ---------  -------  -------")
       expect(text).to include("#{spec_helper_plus_line}  MyClass     my_method      192  Hash")
       expect(text).to include("#{spec_helper_plus_line}  MyClass     my_method        0  String")
       expect(text).to include("#{__FILE__.ljust(MAX_PATH_LENGTH)}         #{@line}  Class       new              0  MyClass")
@@ -279,7 +279,7 @@ describe AllocationStats::AllocationsProxy do
       text = @stats.allocations.to_text(columns: [:sourcefile, :sourceline, :class])
       spec_helper_plus_line = "#{SPEC_HELPER_PATH.ljust(MAX_PATH_LENGTH)}          #{MyClass::MY_METHOD_BODY_LINE}"
 
-      expect(text).to include("                                             sourcefile                                                sourceline   class")
+      expect(text).to include("#{"sourcefile".center(MAX_PATH_LENGTH)}  sourceline   class")
       expect(text).to include("#{"-" * MAX_PATH_LENGTH}  ----------  -------")
       expect(text).to include("#{spec_helper_plus_line}  Hash")
       expect(text).to include("#{spec_helper_plus_line}  String")
@@ -327,7 +327,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",
+        "file (raw)" =>  "#{Dir.pwd}/spec/spec_helper.rb",
         "line" => 23,
         "class_path" => "MyClass",
         "method_id" => :my_method.to_s,
@@ -365,7 +365,16 @@ describe AllocationStats::AllocationsProxy do
       expect(results.values[2].size).to eq(1)
     end
 
-    it "should output to fixed-width text after group_by..sort_by_count correctly" do
+    it "should filter out low count Allocations" do
+      results = @stats.allocations.group_by(:sourcefile, :sourceline, :class).at_least(4).all
+
+      expect(results.size).to eq(1)
+
+      expect(results.keys[0]).to include(@lines[1])
+      expect(results.values[0].size).to eq(4)
+    end
+
+    it "should output to fixed-width text after group_by(...).sort_by_count correctly" do
       text = @stats.allocations(alias_paths: true)
                    .group_by(:sourcefile, :sourceline, :class)
                    .sort_by_count

metadata

@@ -1,31 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: allocation_stats
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Sam Rawlins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-17 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-description: Tooling for tracing object allocations in Ruby 2.1; aggregate information
-  about object allocations; group, sort, and filter allocation information.
+        version: '0'
+description: Tooling for tracing object allocations in Ruby 2.1
 email:
 - sam.rawlins@gmail.com
 executables: []
@@ -33,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.markdown
 - Gemfile
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Tooling for tracing object allocations in Ruby 2.1