pry-stack_explorer 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7458ddda997e35095c5ebe7330a0ff651c4e424fdf0abbc6178fc8d7ae8367cb
-  data.tar.gz: ef6c275c07566ae94163be5df2f3358b671c4692789432a8dcd0e864891ee018
+  metadata.gz: 2c56f14de411b367961ead30e9542e8d9f8b7a936243c4c552af3688e98b49d3
+  data.tar.gz: 49c07c2ca2761bff019a48ef94efe2a6c225d95ea5178e93ed11d7714bc8392f
 SHA512:
-  metadata.gz: c5f740846b70146461babd122cc2b67f4b97fce0697ffca96a8ec24be9abca029427a5500bc2e4b8d211fd574b31e719a8a97d9b9201b52c22c04a7137cb8a39
-  data.tar.gz: 80bdd4a91d73943051f83847ee7933763c06a3c089e50ed3e7b28d595a691a693bf1c4b5b11022bde82f7658922cc5bc3e81a025803deafad0ff7997135fc220
+  metadata.gz: 54b7217454501440658502c54f644d624d61b301e5d220a14a9c16476015aa58ecb629c0e99dc1b033fbc07ece4325de9ba63f6b33264306ab6d4614b63a34e7
+  data.tar.gz: 63690ac1f3db937c810deb4f5b330435fcce8845ce74c3bea904e5f4ee334943737747351c4baad00f2887ea996ad598cd4c891531abd942c7efe49fd39a9420

data/.gitignore

@@ -0,0 +1,9 @@
+Makefile
+*.so
+*.o
+*.def
+doc/
+pkg/
+.yardoc/
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,5 @@
+--format documentation
+--color
+--require ./test/test_helper.rb
+--pattern "**{,/*/**}/*_{spec,test}.rb"
+--default-path test

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+
+script:
+  rspec --backtrace
+
+before_install:
+  - gem install bundler
+
+rvm:
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+
+notifications:
+  irc: "irc.freenode.org#pry"
+
+branches:
+  only:
+    - master

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CHANGELOG

@@ -0,0 +1,22 @@
+## v0.6.2 (13 March 2026)
+* Require binding_of_caller >= 1.0 to support Ruby 4 (via 2.0.0+)
+
+## v0.6.1 (8 February 2021)
+* Fix 'Source Code' link in gem metadata
+* Stack now filters for application frames (#53)
+
+## v0.6.0 (31 December 2020)
+* Use binding_of_caller version for Ruby 3.0 (#55)
+* Rename 'show-stack' to 'stack' (#50, #8)
+
+## v0.5.1 (21 May 2020)
+* Fix exception in started hook
+
+## v0.5.0 (21 May 2020)
+* Should fix most deprecation warnings as of release
+* Require Pry 0.13
+* Fix Pry#_pry_ => #pry_instance deprecation
+
+## v0.4.11 (21 May 2020)
+* Special branch for Ruby 2.5
+* Fix Pry 0.13+ deprecations and broken `show-stack`

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -31,7 +31,7 @@ Commands:
 
 In Gemfile:
 ```rb
-gem 'pry-stack_explorer', '~> 0.5.0'
+gem 'pry-stack_explorer', '~> 0.6.0'
 ```
 
 ```
@@ -43,7 +43,7 @@ gem install pry-stack_explorer
 
 
 ### Branches and compatible Ruby versions
-* v0.5: Ruby 2.6+, Pry 0.13+
+* v0.5, v0.6: Ruby 2.6+, Pry 0.13+
 * v0.4.11+: Ruby 2.5, Pry 0.12+ (branch `0-4` – end-of-life in March 2021)
 * v0.4.9.3: Older versions (unsupported)
 

data/Rakefile

@@ -0,0 +1,114 @@
+require "bundler/gem_tasks"
+
+$:.unshift 'lib'
+
+dlext = RbConfig::CONFIG['DLEXT']
+direc = File.dirname(__FILE__)
+
+PROJECT_NAME = "pry-stack_explorer"
+
+require 'rake/clean'
+require 'rubygems/package_task'
+require "#{PROJECT_NAME}/version"
+
+CLOBBER.include("**/*~", "**/*#*", "**/*.log")
+CLEAN.include("**/*#*", "**/*#*.*", "**/*_flymake*.*", "**/*_flymake",
+              "**/*.rbc", "**/.#*.*")
+
+def apply_spec_defaults(s)
+  s.name = PROJECT_NAME
+  s.summary = "Walk the stack in a Pry session"
+  s.version = PryStackExplorer::VERSION
+  s.date = Time.now.strftime '%Y-%m-%d'
+  s.author = "John Mair (banisterfiend)"
+  s.email = 'jrmair@gmail.com'
+  s.description = s.summary
+  s.require_path = 'lib'
+  s.add_dependency("binding_of_caller",">= 1.0")
+  s.add_dependency("pry","~> 0.13")
+  s.add_development_dependency("rspec","~> 3.9")
+  s.add_development_dependency('rake', '~> 0.9')
+  s.homepage = "https://github.com/pry/pry-stack_explorer"
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+end
+
+desc "run pry with plugin enabled"
+task :pry do
+  exec("pry -I#{direc}/lib/ -r #{direc}/lib/#{PROJECT_NAME}")
+end
+
+desc "Run example"
+task :example do
+  sh "ruby -I#{direc}/lib/ #{direc}/examples/example.rb "
+end
+
+desc "Run example2"
+task :example2 do
+  sh "ruby -I#{direc}/lib/ #{direc}/examples/example2.rb "
+end
+
+desc "Run example3"
+task :example3 do
+  sh "ruby -I#{direc}/lib/ #{direc}/examples/example3.rb "
+end
+
+desc "Show version"
+task :version do
+  puts "PryStackExplorer version: #{PryStackExplorer::VERSION}"
+end
+
+desc "run tests"
+task :default => :test
+
+desc "run tests"
+task :test do
+  sh "rspec"
+end
+
+desc "generate gemspec"
+task :gemspec => "ruby:gemspec"
+
+namespace :ruby do
+  spec = Gem::Specification.new do |s|
+    apply_spec_defaults(s)
+    s.platform = Gem::Platform::RUBY
+  end
+
+  Gem::PackageTask.new(spec) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+
+  desc  "Generate gemspec file"
+  task :gemspec do
+    File.open("#{spec.name}.gemspec", "w") do |f|
+      f << spec.to_ruby
+    end
+  end
+end
+
+desc "build all platform gems at once"
+task :gems => [:clean, :rmgems, :gemspec, "ruby:gem"]
+
+desc "remove all platform gems"
+task :rmgems => ["ruby:clobber_package"]
+
+desc "reinstall gem"
+task :reinstall => :gems do
+  sh "gem uninstall pry-stack_explorer" rescue nil
+  sh "gem install -l #{direc}/pkg/#{PROJECT_NAME}-#{PryStackExplorer::VERSION}.gem"
+end
+
+task :install => :reinstall
+
+desc "build and push latest gems"
+task :pushgems => :gems do
+  chdir("#{File.dirname(__FILE__)}/pkg") do
+    Dir["*.gem"].each do |gemfile|
+      sh "gem push #{gemfile}"
+    end
+  end
+end
+
+task :pushgem => :pushgems

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/examples/example.rb

@@ -0,0 +1,45 @@
+unless Object.const_defined? :PryStackExplorer
+  $:.unshift File.expand_path '../../lib', __FILE__
+  require 'pry'
+end
+
+require 'pry-stack_explorer'
+
+def alphabet(y)
+  x = 20
+  b
+end
+
+def b
+  x = 30
+  proc {
+    c
+  }.call
+end
+
+def c
+  u = 50
+  binding.pry
+end
+
+# hello
+def beta
+  gamma
+end
+
+def gamma
+  zeta
+end
+
+def zeta
+  vitamin = 100
+  binding.pry
+end
+#
+
+proc {
+  class J
+    alphabet(22)
+  end
+}.call
+

data/examples/example2.rb

@@ -0,0 +1,18 @@
+unless Object.const_defined? :PryStackExplorer
+  $:.unshift File.expand_path '../../lib', __FILE__
+  require 'pry'
+end
+
+require 'pry-stack_explorer'
+
+def alpha
+  x = "hello"
+  beta
+  puts x
+end
+
+def beta
+  binding.pry
+end
+
+alpha

data/examples/example3.rb

@@ -0,0 +1,46 @@
+unless Object.const_defined? :PryStackExplorer
+  $:.unshift File.expand_path '../../lib', __FILE__
+  require 'pry'
+end
+
+require 'pry-stack_explorer'
+
+def b
+  x = 30
+  proc {
+    c
+  }.call
+end
+
+def c
+  u = 50
+  V.new.beta
+end
+
+# hello
+class V
+  def beta
+    gamma
+  end
+
+  def gamma
+    zeta
+  end
+end
+
+def zeta
+  vitamin = 100
+  binding.pry
+end
+#
+
+proc {
+  class J
+    def alphabet(y)
+      x = 20
+      b
+    end
+  end
+}.call
+
+J.new.alphabet(122)

data/lib/pry-stack_explorer/commands.rb

@@ -247,6 +247,7 @@ module PryStackExplorer
         opt.on :H, :head, "Display the first N stack frames (defaults to 10).", :optional_argument => true, :as => Integer, :default => 10
         opt.on :T, :tail, "Display the last N stack frames (defaults to 10).", :optional_argument => true, :as => Integer, :default => 10
         opt.on :c, :current, "Display N frames either side of current frame (default to 5).", :optional_argument => true, :as => Integer, :default => 5
+        opt.on :a, :app, "Display application frames only", optional_argument: true
       end
 
       def memoized_info(index, b, verbose)
@@ -290,26 +291,72 @@ module PryStackExplorer
       private :selected_stack_frames
 
       def process
-        if !frame_manager
-          output.puts "No caller stack available!"
+        return no_stack_available! unless frame_manager
+
+        title = "Showing all accessible frames in stack (#{frame_manager.bindings.size} in total):"
+
+        content = [
+          bold(title),
+          "---",
+          make_stack_lines
+        ].join("\n")
+
+        stagger_output content
+      end
+
+      private
+
+      def make_stack_lines
+        frames_with_indices.map do |b, i|
+          make_stack_line(b, i, (i == frame_manager.binding_index))
+        end.join("\n")
+      end
+
+      def frames_with_indices
+        if opts.present?(:app) && defined?(ActiveSupport::BacktraceCleaner)
+          app_frames
         else
-          content = ""
-          content << "\n#{bold("Showing all accessible frames in stack (#{frame_manager.bindings.size} in total):")}\n--\n"
-
-          base_frame_index, frames = selected_stack_frames
-          frames.each_with_index do |b, index|
-            i = index + base_frame_index
-            if i == frame_manager.binding_index
-              content << "=> ##{i} #{memoized_info(i, b, opts[:v])}\n"
-            else
-              content << "   ##{i} #{memoized_info(i, b, opts[:v])}\n"
-            end
-          end
+          offset_frames
+        end
+      end
+
+      # "=> #0  method_name <Class#method(...)>"
+      def make_stack_line(b, i, active)
+        arw = active ? "=>" : "  "
+
+        "#{arw} ##{i} #{memoized_info(i, b, opts[:v])}"
+      end
 
-          stagger_output content
+      def offset_frames
+        base_frame_index, frames = selected_stack_frames
+
+        frames.each_with_index.map do |frame, index|
+          [frame, index + base_frame_index]
         end
       end
 
+      def no_stack_available!
+        output.puts "No caller stack available!"
+      end
+
+      LOCATION_LAMBDA = ->(_binding){ _binding.source_location[0] }
+
+      def app_frames
+        locations = frame_manager.bindings.map(&LOCATION_LAMBDA)
+        filtered = backtrace_cleaner.clean(locations)
+
+        frame_manager.bindings
+          .each_with_index
+          .map
+          .select do |_binding, _index|
+            LOCATION_LAMBDA.call(_binding).in?(filtered)
+          end
+      end
+
+      # also see Rails::BacktraceCleaner
+      def backtrace_cleaner
+        @backtrace_cleaner ||= ActiveSupport::BacktraceCleaner.new
+      end
     end
 
     alias_command "show-stack", "stack"

data/lib/pry-stack_explorer/version.rb

@@ -1,3 +1,3 @@
 module PryStackExplorer
-  VERSION = '0.6.0'
+  VERSION = '0.6.2'
 end

data/pry-stack_explorer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+# stub: pry-stack_explorer 0.6.2 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "pry-stack_explorer".freeze
+  s.version = "0.6.2".freeze
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["John Mair (banisterfiend)".freeze]
+  s.date = "2026-03-13"
+  s.description = "Walk the stack in a Pry session".freeze
+  s.email = "jrmair@gmail.com".freeze
+  s.files = [".gemtest".freeze, ".gitignore".freeze, ".rspec".freeze, ".travis.yml".freeze, ".yardopts".freeze, "CHANGELOG".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/rspec".freeze, "examples/example.rb".freeze, "examples/example2.rb".freeze, "examples/example3.rb".freeze, "lib/pry-stack_explorer.rb".freeze, "lib/pry-stack_explorer/commands.rb".freeze, "lib/pry-stack_explorer/frame_manager.rb".freeze, "lib/pry-stack_explorer/version.rb".freeze, "lib/pry-stack_explorer/when_started_hook.rb".freeze, "pry-stack_explorer.gemspec".freeze, "test/commands_test.rb".freeze, "test/frame_manager_test.rb".freeze, "test/stack_explorer_test.rb".freeze, "test/support/bingbong.rb".freeze, "test/support/input_tester.rb".freeze, "test/support/io_utils.rb".freeze, "test/support/reset_helper.rb".freeze, "test/test_helper.rb".freeze]
+  s.homepage = "https://github.com/pry/pry-stack_explorer".freeze
+  s.rubygems_version = "3.6.9".freeze
+  s.summary = "Walk the stack in a Pry session".freeze
+  s.test_files = ["test/commands_test.rb".freeze, "test/frame_manager_test.rb".freeze, "test/stack_explorer_test.rb".freeze, "test/support/bingbong.rb".freeze, "test/support/input_tester.rb".freeze, "test/support/io_utils.rb".freeze, "test/support/reset_helper.rb".freeze, "test/test_helper.rb".freeze]
+
+  s.specification_version = 4
+
+  s.add_runtime_dependency(%q<binding_of_caller>.freeze, [">= 1.0".freeze])
+  s.add_runtime_dependency(%q<pry>.freeze, ["~> 0.13".freeze])
+  s.add_development_dependency(%q<rspec>.freeze, ["~> 3.9".freeze])
+  s.add_development_dependency(%q<rake>.freeze, ["~> 0.9".freeze])
+end