rspec-memory 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a4c2e285080325137845f068d8b7a94e03b495b7290537d3642233122ebfc01
+  data.tar.gz: 84b2fd6ff30ed7759d0691c556f771b0732a87687fcd518dc066d6a6c793be2e
+SHA512:
+  metadata.gz: 3bfaf9c3914b29f48285dc720f7bc30ad854ebd8ac765de34678488d7064ba613c76fbdaafd1af0810d24ef6f28c76306b90e71d5b21d77c55acbabc5e800b60
+  data.tar.gz: 1df26e162deaad5d6e32620d6940930fa0bc490e263adf2555e831ce645b25a3c26e3360d31d24a4a7d7ddcc91f085b0b8b88ea07f520ff82c2929cb6b30d2c3

data/.editorconfig

@@ -0,0 +1,6 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.covered.db

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+dist: xenial
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: 2.6
+      env: COVERAGE=BriefSummary,Coveralls
+    - rvm: ruby-head
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+    - rvm: truffleruby
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: truffleruby

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-memory.gemspec
+gemspec

data/README.md

@@ -0,0 +1,87 @@
+# RSpec::Memory
+
+Make assertions about memory usage.
+
+[![Build Status](https://travis-ci.com/socketry/rspec-memory.svg?branch=master)](https://travis-ci.com/socketry/rspec-memory)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-memory'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install rspec-memory
+	
+Finally, add this require statement to the top of `spec/spec_helper.rb`
+
+```ruby
+require 'async/rspec'
+```
+
+## Usage
+
+Allocating large amounts of objects can lead to memery problems. `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 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
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test)
+
+task :default => :test

data/lib/rspec/memory.rb

@@ -0,0 +1,25 @@
+# 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_relative 'memory/matchers/limit_allocations'
+
+RSpec.shared_context RSpec::Memory do
+	include RSpec::Memory::Matchers
+end

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

@@ -0,0 +1,113 @@
+# 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 RSpec
+	module Memory
+		module Matchers
+			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 exactly #{limit}"
+						end
+					end
+				end
+				
+				def matches?(given_proc)
+					return true unless trace = Trace.capture(@allocations.keys, &given_proc)
+					
+					if @count or @size
+						# If the spec specifies a total limit, we have a limit which we can enforce which takes all allocations into account:
+						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
+					else
+						# Otherwise unspecified allocations are considered an error:
+						trace.ignored.each do |klass, allocation|
+							@errors << "allocated #{allocation.count} #{klass} instances, #{allocation.size} bytes, but it was not specified"
+						end
+					end
+					
+					trace.allocated.each do |klass, allocation|
+						next unless acceptable = @allocations[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} bytes"
+						end
+					end
+					
+					return @errors.empty?
+				end
+				
+				def failure_message
+					"exceeded allocation limit: #{@errors.join(', ')}"
+				end
+			end
+			
+			def limit_allocations(*args)
+				LimitAllocations.new(*args)
+			end
+		end
+	end
+end

data/lib/rspec/memory/trace.rb

@@ -0,0 +1,138 @@
+# 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 RSpec
+	module Memory
+		Allocation = Struct.new(:count, :size) do
+			SLOT_SIZE = 40
+			
+			def << object
+				self.count += 1
+				
+				# We don't want to force specs to take the slot size into account.
+				self.size += ObjectSpace.memsize_of(object) - SLOT_SIZE
+			end
+			
+			def self.default_hash
+				Hash.new{|h,k| h[k] = Allocation.new(0, 0)}
+			end
+		end
+		
+		class Trace
+			def self.supported?
+				# There are issues on truffleruby-1.0.0rc9
+				return false if RUBY_ENGINE == "truffleruby"
+				
+				ObjectSpace.respond_to?(:trace_object_allocations)
+			end
+			
+			if supported?
+				def self.capture(*args, &block)
+					self.new(*args).tap do |trace|
+						trace.capture(&block)
+					end
+				end
+			else
+				def self.capture(*args, &block)
+					yield
+					
+					return nil
+				end
+			end
+			
+			def initialize(klasses)
+				@klasses = klasses
+				
+				@allocated = Allocation.default_hash
+				@retained = Allocation.default_hash
+				
+				@ignored = Allocation.default_hash
+				
+				@total = Allocation.new(0, 0)
+			end
+			
+			attr :allocated
+			attr :retained
+			
+			attr :ignored
+			
+			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 find_base(object)
+				@klasses.find{|klass| object.is_a? klass}
+			end
+			
+			def capture(&block)
+				GC.start
+				
+				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|
+					if klass = find_base(object)
+						@allocated[klass] << object
+					else
+						# If the user specified classes, but we can't pin this allocation to a specific class, we issue a warning.
+						if @klasses.any?
+							warn "Ignoring allocation of #{object.class} at #{ObjectSpace.allocation_sourcefile(object)}:#{ObjectSpace.allocation_sourceline(object)}"
+						end
+						
+						@ignored[object.class] << object
+					end
+					
+					@total << object
+				end
+				
+				# Retained objects are still alive after a final GC:
+				retained.each do |object|
+					if klass = find_base(object)
+						@retained[klass] << object
+					end
+				end
+			end
+		end
+	end
+end

data/lib/rspec/memory/version.rb

@@ -0,0 +1,25 @@
+# Copyright, 2019, 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.
+
+module RSpec
+	module Memory
+		VERSION = "1.0.0"
+	end
+end

data/rspec-memory.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+require_relative 'lib/rspec/memory/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "rspec-memory"
+	spec.version       = RSpec::Memory::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+
+	spec.summary       = "Matches for checking memory allocations."
+	spec.homepage      = "https://github.com/socketry/rspec-memory"
+
+	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+		f.match(%r{^(test|spec|features)/})
+	end
+	
+	spec.require_paths = ["lib"]
+	
+	spec.add_dependency "rspec", "~> 3.0"
+	
+	spec.add_development_dependency "covered"
+	spec.add_development_dependency "bundler"
+	spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: rspec-memory
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: covered
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/rspec/memory.rb
+- lib/rspec/memory/matchers/limit_allocations.rb
+- lib/rspec/memory/trace.rb
+- lib/rspec/memory/version.rb
+- rspec-memory.gemspec
+homepage: https://github.com/socketry/rspec-memory
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Matches for checking memory allocations.
+test_files: []