pry-stack_explorer 0.4.9.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 21a04786fb810c93a0ea183c18cca6254254ed87
-  data.tar.gz: db17a76ac8fed1d6ff7c517dc4496da16deeed4f
+SHA256:
+  metadata.gz: 53b80cf3c06d7bdfaec826bed2ad1963a7bc69331d656e73b84d00e97a500197
+  data.tar.gz: 1942e6ad4fd0b43279d860aa06b2ca354b64eac8b713d426996b9a93a12f48d9
 SHA512:
-  metadata.gz: dee7d3145e5cef1a2385c829d23b5f715b9e7bbd67b52a0cfd2035535e9f3c58308c654c5b045e7fc871ba75da5fa8a12bc5af715e0775ebdab44e84038dc4b4
-  data.tar.gz: 24d28605c51a2e5bb64fbdad268b958232baf4823865f67126bf6bc4dc1390b463660465c7329c52a3ef4407e0f36dd7252c8877ba02ccf3c4f2a584917bbe6f
+  metadata.gz: 2c51eb15eb17f9edff667c93fbead5a7ffe7fa1c4cd3114e516a2057e37ab728e8436f5123908d0fac07a823b2a61fbcc50072429fc8f5081c3c85be5bcaf1d2
+  data.tar.gz: 24dc58f1bfda481a2eddee4e294c953e7ead4bee736da3f07bc142f237e7fcb8b41da9a1bd39517ae53fb34a892b7cd9f2faae3240c2e382031b09ba31eced21

data/README.md

@@ -1,12 +1,12 @@
 pry-stack_explorer
 ===========
 
-(C) John Mair (banisterfiend) 2011
-
 _Walk the stack in a Pry session_
 
-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.
@@ -15,147 +15,66 @@ Unlike `ruby-debug`, pry-stack_explorer incurs no runtime cost and
 enables navigation right up the call-stack to the birth of the
 program.
 
-pry-stack_explorer is currently designed to work on **Rubinius and MRI
-Ruby 1.9.2+ (including 1.9.3)**. Support for other Ruby versions and
-implementations is planned for the future.
-
-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.
 
-**How to use:**
+## Usage
+Provides commands available in Pry sessions.
 
-After installing `pry-stack_explorer`, just start Pry as normal (typically via a `binding.pry`), the stack_explorer plugin will be detected and used automatically.
+Commands:
+* `up`/`down` - Move up or down the call stack
+* `frame [n]` - Go to frame *n*
+* `stack` - Show call stack
 
-* Install the [gem](https://rubygems.org/gems/pry-stack_explorer): `gem install pry-stack_explorer`
-* Read the [documentation](http://rdoc.info/github/banister/pry-stack_explorer/master/file/README.md)
-* See the [source code](http://github.com/pry/pry-stack_explorer)
-* See the [wiki](https://github.com/pry/pry-stack_explorer/wiki) for in-depth usage information.
 
-Example: Moving around between frames
---------
+## Install
 
-```
-[8] pry(J)> show-stack
-
-Showing all accessible frames in stack:
---
-=> #0 [method]  c <Object#c()>
-   #1 [block]   block in b <Object#b()>
-   #2 [method]  b <Object#b()>
-   #3 [method]  alphabet <Object#alphabet(y)>
-   #4 [class]   <class:J>
-   #5 [block]   block in <main>
-   #6 [eval]    <main>
-   #7 [top]     <main>
-[9] pry(J)> frame 3
-
-Frame number: 3/7
-Frame type: method
-
-From: /Users/john/ruby/projects/pry-stack_explorer/examples/example.rb @ line 10 in Object#alphabet:
-
-     5:
-     6: require 'pry-stack_explorer'
-     7:
-     8: def alphabet(y)
-     9:   x = 20
- => 10:   b
-    11: end
-    12:
-    13: def b
-    14:   x = 30
-    15:   proc {
-[10] pry(J)> x
-=> 20
+In Gemfile:
+```rb
+gem 'pry-stack_explorer', '~> 0.6.0'
 ```
 
-Example: Modifying state in a caller
--------
-
 ```
-Frame number: 0/3
-Frame type: method
-
-From: /Users/john/ruby/projects/pry-stack_explorer/examples/example2.rb @ line 15 in Object#beta:
-
-    10:   beta
-    11:   puts x
-    12: end
-    13:
-    14: def beta
- => 15:   binding.pry
-    16: end
-    17:
-    18: alpha
-[1] pry(main)> show-stack
-
-Showing all accessible frames in stack:
---
-=> #0 [method]  beta <Object#beta()>
-   #1 [method]  alpha <Object#alpha()>
-   #2 [eval]    <main>
-   #3 [top]     <main>
-[2] pry(main)> up
-
-Frame number: 1/3
-Frame type: method
-
-From: /Users/john/ruby/projects/pry-stack_explorer/examples/example2.rb @ line 10 in Object#alpha:
-
-     5:
-     6:
-     7:
-     8: def alpha
-     9:   x = "hello"
- => 10:   beta
-    11:   puts x
-    12: end
-    13:
-    14: def beta
-    15:   binding.pry
-[3] pry(main)> x = "goodbye"
-=> "goodbye"
-[4] pry(main)> ^D
-
-OUTPUT: goodbye
+gem install pry-stack_explorer
 ```
 
-Output from above is `goodbye` as we changed the `x` local inside the `alpha` (caller) stack frame.
+* 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.
 
-Limitations
--------------------------
 
-* First release, so may have teething problems.
-* Limited to Rubinius, and MRI 1.9.2+ at this stage.
+### 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)
 
-Contact
--------
+Example:
+--------
+Here we run the following ruby script:
+```Ruby
+require 'pry-stack_explorer'
 
-Problems or questions contact me at [github](http://github.com/banister)
+def alpha
+  x = "hello"
+  beta
+  puts x
+end
 
+def beta
+  binding.pry
+end
 
-License
--------
+alpha
+```
+
+We wander around the stack a little bit, and modify the state of a frame above the one we `binding.pry`'d at.
 
-(The MIT License)
+[![asciicast](https://asciinema.org/a/257713.svg)](https://asciinema.org/a/257713)
 
-Copyright (c) 2011 John Mair (banisterfiend)
+Output from above is `Goodbye` as we changed the `x` local inside the `alpha` (caller) stack frame.
 
-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.
+License
+-------
+Released under the [MIT License](https://github.com/pry/pry-stack_explorer/blob/master/LICENSE) by John Mair (banisterfiend) and contributors
 
-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.
+Contributions to this gem are released under the same license.

data/lib/pry-stack_explorer/commands.rb

@@ -5,13 +5,13 @@ module PryStackExplorer
     # @return [PryStackExplorer::FrameManager] The active frame manager for
     #   the current `Pry` instance.
     def frame_manager
-      PryStackExplorer.frame_manager(_pry_)
+      PryStackExplorer.frame_manager(pry_instance)
     end
 
     # @return [Array<PryStackExplorer::FrameManager>] All the frame
     #   managers for the current `Pry` instance.
     def frame_managers
-      PryStackExplorer.frame_managers(_pry_)
+      PryStackExplorer.frame_managers(pry_instance)
     end
 
     # @return [Boolean] Whether there is a context to return to once
@@ -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}"
@@ -125,7 +125,7 @@ module PryStackExplorer
         yield(b)
       end
 
-      frame_index = frame_manager.bindings.index(new_frame)
+      frame_manager.bindings.index(new_frame)
     end
   end
 
@@ -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#{text.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.9.2"
-end
+module PryStackExplorer
+  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

data/lib/pry-stack_explorer.rb

@@ -1,6 +1,7 @@
 # pry-stack_explorer.rb
 # (C) John Mair (banisterfiend); MIT license
 
+require "pry" unless defined?(::Pry)
 require "pry-stack_explorer/version"
 require "pry-stack_explorer/commands"
 require "pry-stack_explorer/frame_manager"
@@ -125,10 +126,10 @@ Pry.config.commands.import PryStackExplorer::Commands
 
 # monkey-patch the whereami command to show some frame information,
 # useful for navigating stack.
-Pry.config.commands.before_command("whereami") do |num|
-  if PryStackExplorer.frame_manager(_pry_) && !internal_binding?(target)
-    bindings      = PryStackExplorer.frame_manager(_pry_).bindings
-    binding_index = PryStackExplorer.frame_manager(_pry_).binding_index
+Pry.config.hooks.add_hook(:before_whereami, :stack_explorer) do
+  if PryStackExplorer.frame_manager(pry_instance) && !internal_binding?(target)
+    bindings      = PryStackExplorer.frame_manager(pry_instance).bindings
+    binding_index = PryStackExplorer.frame_manager(pry_instance).binding_index
 
     output.puts "\n"
     output.puts "#{Pry::Helpers::Text.bold('Frame number:')} #{binding_index}/#{bindings.size - 1}"

metadata

@@ -1,125 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: pry-stack_explorer
 version: !ruby/object:Gem::Version
-  version: 0.4.9.2
+  version: 0.6.1
 platform: ruby
 authors:
 - John Mair (banisterfiend)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
     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
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        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
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Walk the stack in a Pry session
-email: jrmair@gmail.com
+description:
+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: []
-metadata: {}
-post_install_message: 
+licenses:
+- MIT
+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:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.1.11
-signing_key: 
+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,7 +0,0 @@
-Makefile
-*.so
-*.o
-*.def
-doc/
-pkg/
-.yardoc/

data/.travis.yml

@@ -1,15 +0,0 @@
-script:
-  rake test --trace
-
-rvm:
-  - 1.9.2
-  - 1.9.3
-
-notifications:
-  irc: "irc.freenode.org#pry"
-  recipients:
-    - jrmair@gmail.com
-
-branches:
-  only:
-    - master

data/.yardopts

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

data/Gemfile

@@ -1,2 +0,0 @@
-source :rubygems
-gemspec