rspec-debugging 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 896e136df71d2e337174b069c599e26004bc84255a13b226abe2d29aea474f1c
-  data.tar.gz: 89ce8e417c627add4db5d53896b072fc45b00b25f478f8ee3e383242f837e0f2
+  metadata.gz: 36fab720f096a8d0db955d8560666e60cfb13e3346bee84fb228ab1638a6784d
+  data.tar.gz: f45cfa7bbc17ba60a3847c05e6feb38c3fb5dcfdeb93227e250bb8afb6cea75f
 SHA512:
-  metadata.gz: 46ba38fe0e0e119b61f3648dc6d9b7e3661bc0fe511f710bab8d711d151c071d5ae086c637e5fe7886b3b6a661aed8175286bb7fbf0316dc6f9c86f68610c080
-  data.tar.gz: 48f3376fc2e14099fc319e18dc64169d020eeff444d14b1452e0f75411eeb99aca47e3cc24680fb5ee5206c409c566d41e91b13b5342ce23e93d3a53476a2f4d
+  metadata.gz: 6f69fb8e97573a353809337c5aac04a16d4659f5b0284e126b10db367afb18db1fe493db4cc76a473a03895a3e4eb712986f0fb4b47c1c1ed5d926e4ff9eef21
+  data.tar.gz: 726a432e06a848ccc328b9f9ee4857f2eea2754c48520079b2547186490da7c3e18aa6701143f57eb208b92534bfb80ce8e56ffb9a5826b0c1db22c5e8e3a8d6

data/CHANGELOG.md

@@ -1,2 +1,10 @@
+###  0.0.3  (2025-01-21)
+- let_variable_reset
+- test coverage
+- readme
+
+###  0.0.2  (2025-01-14)
+- dit - debugging examples
+
 ###  0.0.1  (2025-01-10)
 - init

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-debugging (0.0.1)
+    rspec-debugging (0.0.3)
       rspec-expectations (>= 3)
 
 GEM

data/README.md

@@ -4,15 +4,77 @@ rspec-debugging
 [![codecov](https://codecov.io/gh/dpep/rspec-debugging/branch/main/graph/badge.svg)](https://codecov.io/gh/dpep/rspec-debugging)
 
 
-Tools to make debugging RSpec easier.
+Tools to make debugging RSpec tests easier.
+
+
+Debug broken specs
+----
+Use `dit`, `dcontext`, or `ddescribe` to run a subset of examples and and start the debugger if anything breaks.
 
 ```ruby
 require "rspec/debugging"
 
+describe MySpec do
+  dit { is_expected.to ... }
+end
+```
+
+
+Stop and explore
+----
+Drop `dit` anywhere to start a debugger.
 
+```ruby
+describe MySpec do
+  dit
+end
 ```
 
 
+Got let variables?
+----
+`let` variables are great, but complexity can obscure their value.
+
+```ruby
+describe RSpec::Debugging do
+  describe RSpec::Debugging::LetVariables do
+    subject { a }
+
+    let(:a) { "a" }
+    let!(:b) { "b" }
+
+    it { is_expected.to be ??? }
+
+    context "when we nest" do
+      let(:a) { "A" + b }
+
+      it { is_expected.to be ??? }
+
+      context "...and nest" do
+        let(:a) { super() * 2 }
+
+        it { is_expected.to be ??? }
+      end
+    end
+```
+
+...add a hundred lines of legacy code and then solve for `a`.  Or use tooling :)
+
+### let_variables
+* Returns the list of variables defined by RSpec `let`
+
+
+### let_variable_initialized?(name)
+* Has the specified let variable been initialized?
+
+
+### let_variable_get(name)
+* Returns the value of a let variable, if initialized
+
+### let_variable_values(name)
+* Return all locations where the specified variable has been defined or redefined, and it's value at each location.
+
+
 ----
 ## Contributing
 

data/lib/rspec/debugging/debug_it.rb

@@ -0,0 +1,59 @@
+require 'debug/session'
+
+module RSpec
+  module Debugging
+    module DebugIt
+      ENABLED = ['1', 'true'].include?(ENV['RSPEC_DEBUGGING'])
+
+      def initialize(example_group_class, description, user_metadata, example_block=nil)
+        return super unless user_metadata[:debug] || ENABLED
+
+        if example_block
+          orig_example_block = example_block
+
+          example_block = Proc.new do
+            e = DEBUGGER__::SESSION.capture_exception_frames /(exe|bin|lib)\/rspec/ do
+              instance_exec(&orig_example_block)
+            end
+
+            if e
+              $stderr.puts <<~MSG
+
+              Error:
+              #{e.message}
+
+              MSG
+
+              DEBUGGER__::SESSION.enter_postmortem_session e
+              raise e
+            end
+          end # Proc.new
+        elsif user_metadata[:debug] && user_metadata[:skip] == RSpec::Core::Pending::NOT_YET_IMPLEMENTED
+          # called with no block
+          user_metadata.delete(:skip)
+
+          location = RSpec::Core::Metadata.relative_path(caller[2].split(":in").first)
+
+          example_block = Proc.new do
+            $stderr.puts <<~MSG
+            debugging: #{location}
+
+            MSG
+
+            debugger
+          end.tap do |block|
+            # redefine source_location to return the correct location
+            block.define_singleton_method(:source_location) { location.split(":") }
+          end
+        end
+
+        super
+      end
+    end
+  end
+end
+
+RSpec::Core::Example.prepend RSpec::Debugging::DebugIt
+RSpec::Core::ExampleGroup.define_example_method(:dit, debug: true, focus: true)
+RSpec::Core::ExampleGroup.define_example_group_method(:ddescribe, debug: true, focus: true)
+RSpec::Core::ExampleGroup.define_example_group_method(:dcontext, debug: true, focus: true)

data/lib/rspec/debugging/let_variables.rb

@@ -13,6 +13,10 @@ module RSpec
         __memoized.instance_variable_get("@memoized")[name]
       end
 
+      def let_variable_reset(name)
+        __memoized.instance_variable_get("@memoized").delete(name)
+      end
+
       def let_variable_locations(name)
         let_variable_methods(self)[name].map do |fn|
           normalize_path(fn.source_location.join(":"))

data/lib/rspec/debugging/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Debugging
-    VERSION = Gem.loaded_specs["rspec-debugging"].version.to_s
+    VERSION = "0.0.3"
   end
 end

data/lib/rspec/debugging.rb

@@ -1,5 +1,6 @@
 require "rspec/expectations"
 
+require "rspec/debugging/debug_it"
 require "rspec/debugging/let_variables"
 require "rspec/debugging/version"
 

data/rspec-debugging.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/dpep/rspec-debugging"
   s.license     = "MIT"
   s.name        = File.basename(__FILE__, ".gemspec")
-  s.summary     = "RSpec::Debugging"
-  s.version     = "0.0.1"
+  s.summary     = s.description
+  s.version     = "0.0.3"
 
   s.required_ruby_version = ">= 3.1"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-debugging
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-11 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
@@ -79,6 +79,7 @@ files:
 - README.md
 - lib/rspec-debugging.rb
 - lib/rspec/debugging.rb
+- lib/rspec/debugging/debug_it.rb
 - lib/rspec/debugging/let_variables.rb
 - lib/rspec/debugging/version.rb
 - rspec-debugging.gemspec
@@ -104,5 +105,5 @@ requirements: []
 rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
-summary: RSpec::Debugging
+summary: Tools to improve debugging in RSpec
 test_files: []