allocation_stats 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce3ad497b9d8343b112d199d186f508a22e68515
-  data.tar.gz: 1f323cfd6854e10f26b66eb8f592cb8b577a88a7
+  metadata.gz: 58815fef555e954a433a92b7cef4eddd6858569a
+  data.tar.gz: 6607ada6920ec63153e39418023e77d216eca304
 SHA512:
-  metadata.gz: 55b43fd195b3540b872af0c05e5a4b10d3f94fce8678dc00b7b7325d6eebb7b12e688caf858a8f9424d2e6bcc98347385a4807e840c3c95fc4759f501dfde9ec
-  data.tar.gz: 946cd053f108b4f6548b5991fa37d620cf2d5ae3df176a4a5cd8c9ec0a4a52ca6036f8abd67e28f3868dbf36ac6dd658c018ace0d1da761814ed1cbbde35aa4e
+  metadata.gz: 6d4da2e5ad7dc0257b91124fbd506e58dece431047d9e73aee0f20d251c1a462477b1cba0a44c483122be048b2d8b5826d67e83acdf2802174f22e576e622591
+  data.tar.gz: 52e28c0ba9065822aef3bc575c00c39e1096603b26b610b6df5b912e70e5edd5e17db72bc88c4591f7df9e226201052b2fd42d775ead90ad30ca8c08286384ce

data/CHANGELOG.markdown

@@ -0,0 +1,12 @@
+v0.1.2
+
+* Added: `homepage` in the gemspec
+* Added: more documentation: up to 71% now
+
+v0.1.1
+
+* Fixed: `required_ruby_version` in the gemspec
+
+v0.1.0
+
+* A lot of stuff

data/README.markdown

@@ -203,14 +203,15 @@ line to see how we can pull useful information out:
 ```
 
 If you are used to chaining ActiveRecord relations, some of this might look
-familiar to you: `stats.allocations` will hand you back an {AllocationsProxy}
-object, designed to hold the various transformations that you wish to run the
-allocations through.  AllocationsProxy uses the Command pattern to store up
-transformations before they will actually be applied. In this example, we only
-make one transformation: `group_by(:@sourcefile, :class)`.  This method just
-returns the same 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).
+familiar to you: `stats.allocations` will hand you back an
+{AllocationStats::AllocationsProxy} object, designed to hold the various
+transformations that you wish to run the allocations through. AllocationsProxy
+uses the Command pattern to store up transformations before they will actually
+be applied. In this example, we only make one transformation:
+`group_by(:@sourcefile, :class)`.  This method just returns the same
+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
 -------------

data/allocation_stats.gemspec

@@ -3,9 +3,10 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "allocation_stats"
-  spec.version       = "0.1.1"
+  spec.version       = "0.1.2"
   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"

data/lib/allocation_stats/allocation.rb

@@ -119,6 +119,8 @@ class AllocationStats
       }
     end
 
+    # Convert into a JSON string, which can be used in rack-allocation_stats's
+    # interactive mode.
     def to_json(*a)
       as_json.to_json(*a)
     end

data/lib/allocation_stats/allocations_proxy.rb

@@ -50,6 +50,8 @@ class AllocationStats
       @alias_paths = alias_paths
     end
 
+    # Apply all transformations to the contained list of Allocations. This is
+    # aliased as `:all`.
     def to_a
       results = @allocations
 
@@ -69,6 +71,9 @@ class AllocationStats
     end
     alias :all :to_a
 
+    # If a value is passed in, @alias_paths will be set to this value, and the
+    # AllocationStats object will be returned. If no value is passed in, this
+    # will return the @alias_paths.
     def alias_paths(value = nil)
       # reader
       return @alias_paths if value.nil?
@@ -178,7 +183,8 @@ class AllocationStats
     end
     private :attribute_getters
 
-    # Map to bytes via {Allocation#memsize #memsize}. This is done in one of two ways:
+    # Map to bytes via {Allocation#memsize #memsize}. This is done in one of
+    # two ways:
     #
     # * If the current result set is an Array, then this transform just maps
     #   each Allocation to its `#memsize`.
@@ -226,6 +232,7 @@ class AllocationStats
       end
     end
 
+    # Resolve all transformations, and convert the resultant Array to JSON.
     def to_json
       to_a.to_json
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allocation_stats
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sam Rawlins
@@ -14,14 +14,14 @@ dependencies:
   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
@@ -31,8 +31,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .yardopts
+- ".gitignore"
+- ".yardopts"
+- CHANGELOG.markdown
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -53,7 +54,7 @@ files:
 - spec/allocation_stats/allocations_proxy_spec.rb
 - spec/allocation_stats_spec.rb
 - spec/spec_helper.rb
-homepage: 
+homepage: https://github.com/srawlins/allocation_stats
 licenses:
 - Apache v2
 metadata: {}
@@ -63,18 +64,19 @@ 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
+rubygems_version: 2.2.0.preview.1
 signing_key: 
 specification_version: 4
 summary: Tooling for tracing object allocations in Ruby 2.1
 test_files: []
+has_rdoc: