async-rspec 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d82743af426d13dd6463e49155abd2d3a1f4e5111ea1f8dc5607b78c1fd77545
-  data.tar.gz: ccf15bf3cd995e71e05866e3935f845ef4f42999acda0cf3172ece2eefc1269e
+  metadata.gz: b82909dd774fe15191c43b09b44d2276f92538f7602230917d92a90ecc3c9e75
+  data.tar.gz: d4e2b8722931ece8de4fd5580b69977aacf07e482df5640d91a66231c0715271
 SHA512:
-  metadata.gz: a6e607fd2d6bd68f5414c9ffa87ea306c17bf1ba1c599320855eadfa12998e9f857f066b7781d87c12c6b35c120fc5ed1cffd86647c6f8a24d943712bb5c549a
-  data.tar.gz: bb604e41f0da0e384ad361b27770aa48c0545ded1290c3d711559ad93c5ed66cb655f3f7c35cc56ab81531d602df2cbe04bfbc7e2ed5aed6b170b7c21677dce9
+  metadata.gz: 6699ca96c6db25094e0705cc4e17e8ac4e28a6127f9e57192269a10b1361cda80ebfe5963de1850493f3ef2ba50122c391bf957fcdcba838bea857404fbcee45
+  data.tar.gz: 5246399920a6b4dcd41a3070b227e8d93eae3dff252ae2e15651ee9fe4b97d5254d7c110fda490bf2c5475d6f221b43c9e777ff64eede3d767034bfe1169abe4

data/README.md

@@ -43,6 +43,34 @@ end
 
 In some cases, the Ruby garbage collector will close IOs. In the above case, it's possible to just writing `IO.pipe` will not leak, as Ruby will garbage collect the resulting IOs immediately. It's still incorrect to not correctly close IOs, so don't depend on this behaviour.
 
+### Allocations
+
+Allocating large amounts of objects can lead to memery problems. `Async::RSpec::Memory` adds a `limit_allocations` matcher, which tracks the number of allocations and memory size for each object type and allows you to specify expected limits.
+
+```ruby
+RSpec.describe "memory allocations" do
+	include_context Async::RSpec::Memory
+	
+	it "limits allocation counts" do
+		expect do
+			6.times{String.new}
+		end.to limit_allocations(String => 10) # 10 strings can be allocated
+	end
+	
+	it "limits allocation counts (hash)" do
+		expect do
+			6.times{String.new}
+		end.to limit_allocations(String => { count: 10 }) # 10 strings can be allocated
+	end
+	
+	it "limits allocation size" do
+		expect do
+			6.times{String.new("foo")}
+		end.to limit_allocations(String => { size: 1024 }) # 1 KB of strings can be allocated
+	end
+end
+```
+
 ### Reactor
 
 Many specs need to run within a reactor. A shared context is provided which includes all the relevant bits, including the above leaks checks.

data/lib/async/rspec/memory.rb

@@ -18,128 +18,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'rspec/expectations'
-require 'objspace'
+require_relative 'memory/limit_allocations'
 
 module Async
 	module RSpec
-		module Memory
-			Allocation = Struct.new(:count, :size) do
-				def << object
-					self.count += 1
-					self.size += ObjectSpace.memsize_of(object)
-				end
-			end
-			
-			class Trace
-				def self.supported?
-					ObjectSpace.respond_to? :trace_object_allocations
-				end
-				
-				if supported?
-					def self.capture(&block)
-						self.new.tap do |trace|
-							trace.capture(&block)
-						end
-					end
-				else
-					def self.capture(&block)
-						yield
-						
-						return nil
-					end
-				end
-				
-				def initialize
-					@allocated = Hash.new{|h,k| h[k] = Allocation.new(0, 0)}
-					@retained = Hash.new{|h,k| h[k] = Allocation.new(0, 0)}
-				end
-				
-				attr :allocated
-				attr :retained
-				
-				def current_objects(generation)
-					allocations = []
-					
-					ObjectSpace.each_object do |object|
-						if ObjectSpace.allocation_generation(object) == generation
-							allocations << object
-						end
-					end
-					
-					return allocations
-				end
-				
-				def capture(&block)
-					allocated = nil
-					
-					begin
-						GC.disable
-						
-						generation = GC.count
-						ObjectSpace.trace_object_allocations(&block)
-						
-						allocated = current_objects(generation)
-					ensure
-						GC.enable
-					end
-					
-					GC.start
-					retained = current_objects(generation)
-					
-					allocated.each do |object|
-						@allocated[object.class] << object
-					end
-					
-					retained.each do |object|
-						@retained[object.class] << object
-					end
-				end
-			end
-			
-			class LimitAllocations
-				include ::RSpec::Matchers::Composable
-				
-				def initialize(allocations)
-					@allocations = allocations
-					@errors = []
-				end
-				
-				def supports_block_expectations?
-					true
-				end
-				
-				def matches?(given_proc)
-					return true unless trace = Trace.capture(&given_proc)
-					
-					@allocations.each do |klass, acceptable|
-						next unless allocation = allocation = trace.allocated[klass] 
-						
-						case acceptable
-						when Range
-							unless acceptable.include? allocation.count
-								@errors << "allocated #{allocation.count} instances (#{allocation.size} bytes) of #{klass}, expected within #{acceptable}"
-							end
-						when Integer
-							if allocation.count > acceptable
-								@errors << "allocated #{allocation.count} instances (#{allocation.size} bytes) of #{klass}, expected at most #{acceptable}"
-							end
-						end
-					end
-					
-					return @errors.empty?
-				end
-				
-				def failure_message
-					"exceeded allocation limit: #{@errors.join(', ')}"
-				end
-			end
-			
-			def limit_allocations(allocations)
-				LimitAllocations.new(allocations)
-			end
-		end
-		
 		RSpec.shared_context Memory do
 			include Memory
 		end

data/lib/async/rspec/memory/limit_allocations.rb

@@ -0,0 +1,107 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2018, by Janko Marohnić.
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'trace'
+
+require 'rspec/expectations'
+
+module Async
+	module RSpec
+		module Memory
+			# expect{...}.to allocate < 10.megabytes
+			#
+			class LimitAllocations
+				include ::RSpec::Matchers::Composable
+				
+				def initialize(allocations = {}, count: nil, size: nil)
+					@count = count
+					@size = size
+					
+					@allocations = {}
+					@errors = []
+					
+					allocations.each do |klass, count|
+						self.of(klass, count: count)
+					end
+				end
+				
+				def supports_block_expectations?
+					true
+				end
+				
+				def of(klass, **limits)
+					@allocations[klass] = limits
+					
+					return self
+				end
+				
+				private def check(value, limit)
+					case limit
+					when Range
+						unless limit.include? value
+							yield "expected within #{limit}"
+						end
+					when Integer
+						unless value < limit
+							yield "expected at most #{limit}"
+						end
+					end
+				end
+				
+				def matches?(given_proc)
+					return true unless trace = Trace.capture(&given_proc)
+					
+					if total = trace.total
+						check(total.count, @count) do |expected|
+							@errors << "allocated #{total.count} instances, #{total.size} bytes, #{expected} instances"
+						end if @count
+						
+						check(total.size, @size) do |expected|
+							@errors << "allocated #{total.count} instances, #{total.size} bytes, #{expected} bytes"
+						end if @size
+					end
+					
+					@allocations.each do |klass, acceptable|
+						next unless allocation = trace.allocated[klass]
+						
+						check(allocation.count, acceptable[:count]) do |expected|
+							@errors << "allocated #{allocation.count} #{klass} instances, #{allocation.size} bytes, #{expected} instances"
+						end
+						
+						check(allocation.size, acceptable[:size]) do |expected|
+							@errors << "allocated #{allocation.count} #{klass} instances, #{allocation.size} bytes, #{expected} instances"
+						end
+					end
+					
+					return @errors.empty?
+				end
+				
+				def failure_message
+					"exceeded allocation limit: #{@errors.join(', ')}"
+				end
+			end
+			
+			def limit_allocations(allocations)
+				LimitAllocations.new(allocations)
+			end
+		end
+	end
+end

data/lib/async/rspec/memory/trace.rb

@@ -0,0 +1,107 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'objspace'
+
+module Async
+	module RSpec
+		module Memory
+			Allocation = Struct.new(:count, :size) do
+				def << object
+					self.count += 1
+					self.size += ObjectSpace.memsize_of(object)
+				end
+			end
+			
+			class Trace
+				def self.supported?
+					ObjectSpace.respond_to? :trace_object_allocations
+				end
+				
+				if supported?
+					def self.capture(&block)
+						self.new.tap do |trace|
+							trace.capture(&block)
+						end
+					end
+				else
+					def self.capture(&block)
+						yield
+						
+						return nil
+					end
+				end
+				
+				def initialize
+					@allocated = Hash.new{|h,k| h[k] = Allocation.new(0, 0)}
+					@retained = Hash.new{|h,k| h[k] = Allocation.new(0, 0)}
+					
+					@total = Allocation.new(0, 0)
+				end
+				
+				attr :allocated
+				attr :retained
+				
+				attr :total
+				
+				def current_objects(generation)
+					allocations = []
+					
+					ObjectSpace.each_object do |object|
+						if ObjectSpace.allocation_generation(object) == generation
+							allocations << object
+						end
+					end
+					
+					return allocations
+				end
+				
+				def capture(&block)
+					allocated = nil
+					
+					begin
+						GC.disable
+						
+						generation = GC.count
+						ObjectSpace.trace_object_allocations(&block)
+						
+						allocated = current_objects(generation)
+					ensure
+						GC.enable
+					end
+					
+					GC.start
+					retained = current_objects(generation)
+					
+					# All allocated objects, including those freed in the last GC:
+					allocated.each do |object|
+						@allocated[object.class] << object
+						@total << object
+					end
+					
+					# Retained objects are still alive after a final GC:
+					retained.each do |object|
+						@retained[object.class] << object
+					end
+				end
+			end
+		end
+	end
+end

data/lib/async/rspec/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module RSpec
-		VERSION = "1.6.0"
+		VERSION = "1.7.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-rspec
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-09 00:00:00.000000000 Z
+date: 2018-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -83,6 +83,8 @@ files:
 - lib/async/rspec.rb
 - lib/async/rspec/leaks.rb
 - lib/async/rspec/memory.rb
+- lib/async/rspec/memory/limit_allocations.rb
+- lib/async/rspec/memory/trace.rb
 - lib/async/rspec/profile.rb
 - lib/async/rspec/reactor.rb
 - lib/async/rspec/ssl.rb