rspec-debugging 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d232979bdf2295fb58cec0c7295355366fb703f74e327d0d87d6d6febc35da9
-  data.tar.gz: 98d1146bb2abb4e83f4308f47f302d74755c1d5b1f2c622ef216390ec25c6496
+  metadata.gz: 36fab720f096a8d0db955d8560666e60cfb13e3346bee84fb228ab1638a6784d
+  data.tar.gz: f45cfa7bbc17ba60a3847c05e6feb38c3fb5dcfdeb93227e250bb8afb6cea75f
 SHA512:
-  metadata.gz: b22241789c483ef578ef866f7262e263938629486ed90f931f0a09511d3b662b0818cbbccd7cb5f3df2c441be2decdadfd775c6e61c37fcf080b5a100d245bb6
-  data.tar.gz: d537656b7b9d64d8e572a2844e83dfd86450bb1a803a910f58322d5a14ec23d62a6b00e3958f27d5f9bd2ba2d50ab5292abf4a6fe97a7837e341a8c81d7db770
+  metadata.gz: 6f69fb8e97573a353809337c5aac04a16d4659f5b0284e126b10db367afb18db1fe493db4cc76a473a03895a3e4eb712986f0fb4b47c1c1ed5d926e4ff9eef21
+  data.tar.gz: 726a432e06a848ccc328b9f9ee4857f2eea2754c48520079b2547186490da7c3e18aa6701143f57eb208b92534bfb80ce8e56ffb9a5826b0c1db22c5e8e3a8d6

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+###  0.0.3  (2025-01-21)
+- let_variable_reset
+- test coverage
+- readme
+
 ###  0.0.2  (2025-01-14)
 - dit - debugging examples
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-debugging (0.0.2)
+    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

@@ -17,7 +17,7 @@ module RSpec
             end
 
             if e
-              STDERR.puts <<~MSG
+              $stderr.puts <<~MSG
 
               Error:
               #{e.message}
@@ -32,15 +32,18 @@ module RSpec
           # called with no block
           user_metadata.delete(:skip)
 
-          file, line = caller[2].split(":")
+          location = RSpec::Core::Metadata.relative_path(caller[2].split(":in").first)
 
           example_block = Proc.new do
-            STDERR.puts <<~MSG
-            debugging: #{file}:#{line}
+            $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
 

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/rspec-debugging.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.license     = "MIT"
   s.name        = File.basename(__FILE__, ".gemspec")
   s.summary     = s.description
-  s.version     = "0.0.2"
+  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.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-13 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-expectations