pry-stack_explorer 0.4.12 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 466d7cd0c0e7e63ac02490ad6406d5982e34976e785548031f8216fb7f2ac425
-  data.tar.gz: 3d33e39825f62326af401e7ef12e49c99c1f38967fa9f16a62232d4beed32c17
+  metadata.gz: 53b80cf3c06d7bdfaec826bed2ad1963a7bc69331d656e73b84d00e97a500197
+  data.tar.gz: 1942e6ad4fd0b43279d860aa06b2ca354b64eac8b713d426996b9a93a12f48d9
 SHA512:
-  metadata.gz: fd897f24e3c68263b93d86732739bafd008c4eba56620dfa5f866fe88121add00a4fa9a1d60975de916e1a140e30e9c8a13c032ebb6815c27fa75359e2e913e9
-  data.tar.gz: f08d59c40c3fe428755982dbda278e4f4f3e1895594b05ae34031c5db6f61c11fb2454ccf721c7a3f4736a703a68cf8975e0f7e6a03939a7cdcbad0e77a867b8
+  metadata.gz: 2c51eb15eb17f9edff667c93fbead5a7ffe7fa1c4cd3114e516a2057e37ab728e8436f5123908d0fac07a823b2a61fbcc50072429fc8f5081c3c85be5bcaf1d2
+  data.tar.gz: 24dc58f1bfda481a2eddee4e294c953e7ead4bee736da3f07bc142f237e7fcb8b41da9a1bd39517ae53fb34a892b7cd9f2faae3240c2e382031b09ba31eced21

data/README.md

@@ -3,12 +3,10 @@ pry-stack_explorer
 
 _Walk the stack in a Pry session_
 
-Ruby versions: **Branch v0.5 requires Ruby 2.6+**. Branch v0.4.11+ will remain for Ruby 2.5 users until its EOL in March 2021.
-
 ---
 
-pry-stack_explorer is a plugin for the [Pry](http://pry.github.com)
-REPL that enables the user to navigate the call-stack.
+Pry::StackExplorer is a plugin for [Pry](http://pry.github.com)
+that allows navigating the call stack.
 
 From the point a Pry session is started, the user can move up the stack
 through parent frames, examine state, and even evaluate code.
@@ -17,7 +15,7 @@ Unlike `ruby-debug`, pry-stack_explorer incurs no runtime cost and
 enables navigation right up the call-stack to the birth of the
 program.
 
-The `up`, `down`, `frame` and `show-stack` commands are provided. See
+The `up`, `down`, `frame` and `stack` commands are provided. See
 Pry's in-session help for more information on any of these commands.
 
 ## Usage
@@ -26,14 +24,14 @@ Provides commands available in Pry sessions.
 Commands:
 * `up`/`down` - Move up or down the call stack
 * `frame [n]` - Go to frame *n*
-* `show-stack` - Show call stack
+* `stack` - Show call stack
 
 
 ## Install
 
 In Gemfile:
 ```rb
-gem 'pry-stack_explorer', '~> 0.5.0'
+gem 'pry-stack_explorer', '~> 0.6.0'
 ```
 
 ```
@@ -43,6 +41,12 @@ gem install pry-stack_explorer
 * Read the [documentation](http://rdoc.info/github/banister/pry-stack_explorer/master/file/README.md)
 * See the [wiki](https://github.com/pry/pry-stack_explorer/wiki) for in-depth usage information.
 
+
+### Branches and compatible Ruby versions
+* 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)
+
 Example:
 --------
 Here we run the following ruby script:
@@ -68,12 +72,6 @@ We wander around the stack a little bit, and modify the state of a frame above t
 
 Output from above is `Goodbye` as we changed the `x` local inside the `alpha` (caller) stack frame.
 
-Compatible versions
--------------------
-* v0.5: Ruby 2.6+, Pry 0.13+
-* v0.4.11: Ruby 2.5, Pry 0.12+ (branch `works-with-ruby-2-5`)
-* v0.4.9.3: Older versions
-
 
 License
 -------

data/lib/pry-stack_explorer/commands.rb

@@ -55,7 +55,7 @@ module PryStackExplorer
       sig = meth_obj ? "<#{signature_with_owner(meth_obj)}>" : ""
 
       self_clipped = "#{Pry.view_clip(b_self)}"
-      path = "@ #{b.eval('__FILE__')}:#{b.eval('__LINE__')}"
+      path = '@ ' + b.source_location.join(':')
 
       if !verbose
         "#{type} #{desc} #{sig}"
@@ -231,13 +231,15 @@ module PryStackExplorer
       end
     end
 
-    create_command "show-stack", "Show all frames" do
+    create_command "stack", "Show all frames" do
       include FrameHelpers
 
       banner <<-BANNER
-        Usage: show-stack [OPTIONS]
+        Usage: stack [OPTIONS]
           Show all accessible stack frames.
-          e.g: show-stack -v
+          e.g: stack -v
+
+          alias: show-stack
       BANNER
 
       def options(opt)
@@ -245,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)
@@ -288,26 +291,75 @@ 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
 
-          stagger_output content
+      # "=> #0  method_name <Class#method(...)>"
+      def make_stack_line(b, i, active)
+        arw = active ? "=>" : "  "
+
+        "#{arw} ##{i} #{memoized_info(i, b, opts[:v])}"
+      end
+
+      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"
+
   end
 end

data/lib/pry-stack_explorer/version.rb

@@ -1,3 +1,3 @@
 module PryStackExplorer
-  VERSION = '0.4.12'
+  VERSION = '0.6.1'
 end

data/lib/pry-stack_explorer/when_started_hook.rb

@@ -47,6 +47,8 @@ module PryStackExplorer
     # remove internal frames related to setting up the session
     def remove_internal_frames(bindings)
       start_frames = internal_frames_with_indices(bindings)
+      return bindings if start_frames.empty?
+
       start_frame_index = start_frames.first.last
 
       if start_frames.size >= 2
@@ -60,7 +62,7 @@ module PryStackExplorer
 
     # remove pry-nav / pry-debugger / pry-byebug frames
     def remove_debugger_frames(bindings)
-      bindings.drop_while { |b| b.eval("__FILE__") =~ /pry-(?:nav|debugger|byebug)/ }
+      bindings.drop_while { |b| b.source_location[0] =~ /pry-(?:nav|debugger|byebug)/ }
     end
 
     # binding.pry frame

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-stack_explorer
 version: !ruby/object:Gem::Version
-  version: 0.4.12
+  version: 0.6.1
 platform: ruby
 authors:
 - John Mair (banisterfiend)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-17 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: bacon
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,38 +67,26 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description:
-email: jrmair@gmail.com
+email:
+- jrmair@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gemtest"
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
-- CHANGELOG
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- examples/example.rb
-- examples/example2.rb
-- examples/example3.rb
 - lib/pry-stack_explorer.rb
 - lib/pry-stack_explorer/commands.rb
 - lib/pry-stack_explorer/frame_manager.rb
 - lib/pry-stack_explorer/version.rb
 - lib/pry-stack_explorer/when_started_hook.rb
-- pry-stack_explorer.gemspec
-- test/helper.rb
-- test/test_commands.rb
-- test/test_frame_manager.rb
-- test/test_stack_explorer.rb
-- tester.rb
 homepage: https://github.com/pry/pry-stack_explorer
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/pry/pry-stack_explorer/issues
+  source_code_uri: https://github.com/pry/pry-stack_explorer
+  changelog_uri: https://github.com/pry/pry-stack_explorer/blob/master/CHANGELOG
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -107,19 +95,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Walk the stack in a Pry session
-test_files:
-- test/helper.rb
-- test/test_commands.rb
-- test/test_frame_manager.rb
-- test/test_stack_explorer.rb
+test_files: []

data/.gitignore

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

data/.travis.yml

@@ -1,27 +0,0 @@
-language: ruby
-
-script:
-  rake test --trace
-
-before_install:
-  - gem update --system
-
-rvm:
-  - 2.5.3
-  - 2.6.6
-  - 2.7.1
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-  fast_finish: true
-
-notifications:
-  irc: "irc.freenode.org#pry"
-  email:
-    - jrmair@gmail.com
-
-branches:
-  only:
-    - master

data/.yardopts

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

data/CHANGELOG

@@ -1,11 +0,0 @@
-## 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.12 (17 August 2020)
-* Require Ruby 2.5 in Gemspec (#54)
-
-## v0.4.11 (21 May 2020)
-* Special branch for Ruby 2.5
-* Fix Pry 0.13+ deprecations and broken `show-stack`

data/Gemfile

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

data/Rakefile

@@ -1,114 +0,0 @@
-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",">= 0.7")
-  s.add_dependency("pry",">=0.9.11")
-  s.add_development_dependency("bacon","~>1.1.0")
-  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 "bacon -Itest -a -q"
-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