memory-profiler 1.0.0 → 1.0.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    memory-profiler (1.0.0)
+    memory-profiler (1.0.1)
 
 GEM
   specs:

data/Rakefile

@@ -25,7 +25,6 @@ task :gemspec do
 	gemspec.validate
 end
 
-
 desc "Build gem locally"
 task :build => :gemspec do
 	system "gem#$version build #{gemspec.name}.gemspec"
@@ -38,6 +37,17 @@ task :install => :build do
 	system "gem#$version install pkg-#$version/#{gemspec.name}-#{gemspec.version}"
 end
 
+desc "Publish gem"
+task :push => :build do
+	system "gem#$version push pkg-#$version/#{gemspec.name}-#{gemspec.version}"
+end
+
+
+desc "Generate rdoc documentation"
+task :rdoc do
+	system "rdoc#$version #{gemspec.rdoc_options.map{|o| o =~ /\s/ ? '"'+o+'"' : o}.join(' ')}"
+end
+
 
 desc "Clean automatically generated files"
 task :clean do

data/lib/memory-profiler.rb

@@ -3,20 +3,20 @@
 =begin
 
   Author:  Matthew Kerwin  <matthew@kerwin.net.au>
-  Version: 1.0
-  Date:    2011-01-28
+  Version: 1.0.1
+  Date:    2011-01-31
 
 
-  Copyright 2011 Matthew Kerwin
+  Copyright 2011 Matthew Kerwin.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
-  You may obtain a copy of at
+  You may obtain a copy of the License at
 
       http://www.apache.org/licenses/LICENSE-2.0
 
   Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASES,
+  distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
@@ -48,7 +48,7 @@ module MemoryProfiler
 
 	#
 	# Begins an analysis thread that runs periodically, reporting to a text
-	# file at /tmp/memory_profiler-<pid>.log
+	# file at:  /tmp/memory_profiler-<pid>.log
 	#
 	# Returns the filename used.
 	#
@@ -101,7 +101,7 @@ module MemoryProfiler
 	end
 
 	#
-	# Generates in instantaneous report on the current Ruby ObjectSpace, saved to
+	# Generates an instantaneous report on the current Ruby ObjectSpace, saved to
 	# a text file at:  /tmp/memory_profiler-<pid>-<time>.log
 	#
 	# Returns the filename used.
@@ -136,7 +136,7 @@ module MemoryProfiler
 	# starts the analyser, and waits for a call to #restart or #stop.
 	#
 	# Returned data is an array of:
-	#    [ [Class, current_usage, usage_delta], ... ]
+	#    [  [Class, current_usage, usage_delta],  ...  ]
 	#
 	# Options:
 	#   :sort_by       => :current  # how to order classes;  :current | :delta | :absdelta | :none
@@ -151,7 +151,7 @@ module MemoryProfiler
 	#   :marshall_size => false     # see ObjectSpaceAnalyser#analyse
 	#
 	def self.start(opt = {}, &block)
-		opts = DEFAULTS.merge(opt)
+		opt = DEFAULTS.merge(opt)
 		if block_given?
 			# get pre-block analysis of ObjectSpace
 			GC.start if opt[:force_gc]
@@ -183,7 +183,7 @@ module MemoryProfiler
 	end
 
 	#
-	# Stops the current analysis and emite the results.
+	# Stops the current analysis and emits the results.
 	#
 	# See: #start
 	#
@@ -220,7 +220,7 @@ module MemoryProfiler
 		res
 	end
 
-	# => [ [Class, current, delta], ... ]
+	#  => [ [Class, current, delta], ... ]
 	def self._delta(curr, prev, opt={}) #:nodoc:
 		opt = DEFAULTS.merge(opt)
 
@@ -242,7 +242,7 @@ module MemoryProfiler
 		when :absdelta
 			data = data.sort_by{|k,c,d| -( d.abs ) }
 		else
-			warn "memoryProfiler: invalid option :sort_by => #{opt[:sort_by].inspect}; using :none"
+			warn "MemoryProfiler: invalid option :sort_by => #{opt[:sort_by].inspect}; using :none"
 			opt[:limit] = -1
 		end
 		data = data[0,opt[:limit]] if opt[:limit] > 0 and opt[:limit] < data.length
@@ -252,7 +252,7 @@ module MemoryProfiler
 	end
 
 	#
-	# Formats data, such as that returns by #start , into a printable,
+	# Formats data, such as that returned by #start , into a printable,
 	# readable string.
 	#
 	def self.format(data)
@@ -266,11 +266,11 @@ module MemoryProfiler
 		#
 		# Returns a hash mapping each Class to its usage.
 		#
-		# If opt[:marshall_size] is true, the usage is estimated using Marshall.dump() for each instance,
+		# If opt[:marshall_size] is true, the usage is estimated using Marshall.dump() for each instance;
 		# otherwise it is a simple instance count.
 		#
 		# If opt[:string_debug] is true, the analyser writes a text file containing every string
-		# in the Ruby ObjectSpace, at:  /tmp/memory_profiler-<pid>-string-<time>.log
+		# in the Ruby ObjectSpace, at:  /tmp/memory_profiler-<pid>-strings-<time>.log
 		#
 		# Uses opt[:only] and opt[:ignore] , as per MemoryProfiler#start
 		#
@@ -285,7 +285,7 @@ module MemoryProfiler
 			str = [] if string_debug
 			ObjectSpace.each_object do |o|
 				if res[o.class] or ((only.empty? or only.any?{|y| o.is_a? y }) and ign.none?{|x| o.is_a? x })
-					res[o.class] += ( marshall_size ? self.__sizeof(o) : 1 )
+					res[o.class] += (marshall_size ? self.__sizeof(o) : 1)
 				end
 				str.push o.inspect if string_debug and o.class == String
 			end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: memory-profiler
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Matthew Kerwin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-30 00:00:00 +10:00
+date: 2011-01-31 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -30,11 +30,11 @@ extra_rdoc_files: []
 
 files: 
 - lib/memory-profiler.rb
-- Gemfile
-- README
 - Rakefile
-- Gemfile.lock
 - LICENSE
+- README
+- Gemfile.lock
+- Gemfile
 has_rdoc: true
 homepage: http://code.google.com/p/memory-profiler-ruby/
 licenses: 
@@ -46,6 +46,8 @@ rdoc_options:
 - --main
 - MemoryProfiler
 - --line-numbers
+- --tab-width
+- "2"
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement