rspec-debug 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68d1438cb27952d2d8afda27e88b854e58d9ea63a09be2d66a65b05df7992f61
+  data.tar.gz: 73de8f6f284e8118c9fc1ec7e8673cb179789e031291d5e531b804f612f851b4
+SHA512:
+  metadata.gz: 826b4d04dca70fb52a8d355e3257fc93282c4307e9a75c12660e338658de45e85353cf13c1bd7db2af0bd925af808078f4d96b0f2a371374b2eaddb4841a8e3a
+  data.tar.gz: a9ed097ae5245f2d11b351353aa521bae61d88975154ac57e5796a48d9433c82af4c5d08a3874a1d2fb54e5ed0707b06403fca2a12abc512f573d11469b2cf9a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec-debug.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Koichi Sasada
+
+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/README.md

@@ -0,0 +1,62 @@
+# Rspec::Debug
+
+Launch [debugger](https://github.com/ruby/debug) if spec is failed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-debug'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rspec-debug
+
+## Usage
+
+Add `RSPEC_DEBUG=1` environment variable for `rspec` (or `rake spec` and so on).
+
+```
+# example
+$ RSPEC_DEBUG=1 rspec foo_spec.rb
+$ RSPEC_DEBUG=1 rake spec
+```
+
+and invokes debugger if the spec is failed.
+
+If you clone this repository, you can try this gem with the following steps:
+
+```
+$ bundle install
+$ RSPEC_DEBUG=true bundle exec rake
+RSpec::Debug
+  has a version number
+
+try debug, 1st
+Failure:
+
+expected false
+     got true
+[9, 18] in .../rspec-debug/spec/rspec_debug_spec.rb
+     9|   require_relative '../lib/rspec/debug'
+    10|
+    11|   RSpec.describe 'try debug, 1st' do
+    12|     it 'should fail and debugger' do
+    13|       a = true
+=>  14|       expect(a).to be false
+    15|     end
+    16|
+    17|     it 'should fail and debugger, 2nd' do
+    18|       a = 42
+=>#0    block in <top (required)> (2 levels) at .../rspec-debug/spec/rspec_debug_spec.rb:14```
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/debug"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/debug/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Debug
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec/debug.rb

@@ -0,0 +1,49 @@
+require "rspec/debug/version"
+
+return unless ['1', 'true'].include?(ENV['RSPEC_DEBUG'])
+
+# start debug session
+require 'debug/session'
+DEBUGGER__::start no_sigint_hook: true, nonstop: true
+
+module RSpec
+  module Core
+    class Example
+      module DebugAtStop
+        def initialize example_group_class, description, user_metadata, example_block=nil
+          orig_example_block = example_block
+
+          if example_block
+            example_block = Proc.new do
+              begin
+                postmortem_hook = TracePoint.new(:raise){|tp|
+                  exc = tp.raised_exception
+                  frames = DEBUGGER__.capture_frames(nil)
+                  frames.delete_if{|e| /(exe|bin|lib)\/rspec/ =~ e.path}
+                  exc.instance_variable_set(:@__debugger_postmortem_frames, frames)
+                }
+
+                postmortem_hook.enable
+                begin
+                  self.instance_eval(&orig_example_block)
+                ensure
+                  postmortem_hook.disable
+                end
+
+              rescue Exception => e
+                STDERR.puts "Failure:"
+                STDERR.puts e.message
+                DEBUGGER__::SESSION.enter_postmortem_session e
+                raise
+              end
+            end # Proc.new
+          end
+
+          super
+        end
+      end
+      prepend DebugAtStop
+    end
+  end
+end
+

data/rspec-debug.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/rspec/debug/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-debug"
+  spec.version       = RSpec::Debug::VERSION
+  spec.authors       = ["Koichi Sasada"]
+  spec.email         = ["ko1@atdot.net"]
+
+  spec.summary       = %q{invoke debugger if spec fails}
+  spec.description   = %q{invoke debugger if spec fails}
+  spec.homepage      = "https://github.com/ko1/rspec-debug"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency 'debug', '>= 1.3.2'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rspec-debug
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koichi Sasada
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+description: invoke debugger if spec fails
+email:
+- ko1@atdot.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/debug.rb
+- lib/rspec/debug/version.rb
+- rspec-debug.gemspec
+homepage: https://github.com/ko1/rspec-debug
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ko1/rspec-debug
+  source_code_uri: https://github.com/ko1/rspec-debug
+  changelog_uri: https://github.com/ko1/rspec-debug
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: invoke debugger if spec fails
+test_files: []