rspec-files 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f042fcdc5daea3efa16c9ba11105e0c6d741397d6e5efab694e139b324383e36
-  data.tar.gz: 4509456eab4a81bb802da35549d340576332b9465674e5e60dc8c2c7bf0bc716
+  metadata.gz: a57ef89fe557aa8a4f4835f33f098fd9fd80622332ec7c771393f25603317bec
+  data.tar.gz: 945faf4c968a80915c1d15be7a8244eed824c0c23484300e2780a738badd60d2
 SHA512:
-  metadata.gz: d590a98f1f8ca3d6843d11676221c9b388930ead5c0d663b6163eb67baf20c78dcc1d511f36da03308ad0785c5c718540b6196fb681f982554059776f9faeb27
-  data.tar.gz: 4e84fdc62929d7dcb1f7254e00e9917fbdb8ff1355b4828b1d65910f0f91ee3f1d487cb5de0c3192a056a983c30ba0847ab51485d53733231f609e2dfbd861e8
+  metadata.gz: 47f439683c0f001af66dd6a7873a066b354cf12860a552e59395a3ae1c635b723cd4c5d711acf734c671da44360d5eb887573e1652640a4f50cf660d51677972
+  data.tar.gz: 546190f6d23127763f282e5010b5f9c5a3952f42451473292730fa9fbfeb51217bc249e8c30595e14b431915e12316221e62fcf090cca459acdf6a3bdf7ea7ff

data/lib/rspec/files/leaks.rb

@@ -27,7 +27,7 @@ module RSpec
 				all_ios = ObjectSpace.each_object(::IO).to_a.sort_by(&:object_id)
 				
 				# We are not interested in ios that have been closed already:
-				return all_ios.reject{|io| io.closed?}
+				return all_ios.reject(&:closed?)
 			end
 		end
 		
@@ -35,14 +35,17 @@ module RSpec
 			include Leaks
 			
 			let(:before_ios) {current_ios}
-			let(:after_ios) {current_ios}
+			let(:leaked_ios) {current_ios - before_ios}
 			
 			# We use around(:each) because it's the highest priority.
 			around(:each) do |example|
+				# Here inspect is used to avoid reporting on handles that cannot
+				# be read from, as otherwise RSpec will attempt to test if they are
+				# readable and get stuck forever.
 				before_ios
 				
 				example.run.tap do
-					expect(after_ios).to be == before_ios
+					expect(leaked_ios).to be_empty
 				end
 			end
 		end

data/lib/rspec/files/version.rb

@@ -20,6 +20,6 @@
 
 module RSpec
 	module Files
-		VERSION = "1.0.2"
+		VERSION = "1.1.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-files
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2020-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,43 +52,21 @@ dependencies:
     - - ">="
       - !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: 
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
 - lib/rspec/files.rb
 - lib/rspec/files/buffer.rb
 - lib/rspec/files/leaks.rb
 - lib/rspec/files/version.rb
-- rspec-files.gemspec
 homepage: https://github.com/socketry/rspec-files
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: RSpec helpers for buffering and detecting file descriptor leaks.
 test_files: []

data/.editorconfig

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

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-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

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

data/README.md

@@ -1,95 +0,0 @@
-# RSpec::Files
-
-Detect leaked file descriptors and provides convenient file buffers.
-
-[![Build Status](https://travis-ci.com/socketry/rspec-files.svg?branch=master)](https://travis-ci.com/socketry/rspec-files)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'rspec-files'
-```
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install rspec-files
-	
-Finally, add this require statement to the top of `spec/spec_helper.rb`
-
-```ruby
-require 'rspec/files'
-```
-
-## Usage
-
-### Leaks
-
-Leaking sockets and other kinds of IOs are a problem for long running services. `RSpec::Files::Leaks` tracks all open sockets both before and after the spec. If any are left open, a `RuntimeError` is raised and the spec fails.
-
-```ruby
-RSpec.describe "leaky ios" do
-	include_context RSpec::Files::Leaks
-	
-	# The following fails:
-	it "leaks io" do
-		@input, @output = IO.pipe
-	end
-end
-```
-
-In some cases, the Ruby garbage collector will close IOs. In the above case, it's possible that just writing `IO.pipe` will not leak as Ruby will garbage collect the resulting IOs immediately. It's still incorrect to not close IOs, so don't depend on this behaviour.
-
-### Buffers
-
-File buffers are useful for specs which implement I/O operations. This context automatically manages a disk-based file which can be used for buffering.
-
-```ruby
-RSpec.describe "buffer" do
-	include_context RSpec::Files::Buffer
-	
-	it "can read and write data" do
-		buffer.write("Hello World")
-		buffer.seek(0)
-		
-		expect(buffer.read).to be == "Hello World"
-	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

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

data/rspec-files.gemspec

@@ -1,24 +0,0 @@
-
-require_relative 'lib/rspec/files/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "rspec-files"
-	spec.version       = RSpec::Files::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-
-	spec.summary       = "RSpec helpers for buffering and detecting file descriptor leaks."
-	spec.homepage      = "https://github.com/socketry/rspec-files"
-
-	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