pry-stack_explorer 0.4.9.3 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6bb70a79cb849e48172099c2d9c3f5af036aef30
-  data.tar.gz: 20fa1752792193771ddffc61d3c366567cba14cb
+SHA256:
+  metadata.gz: 8b9a35f3f16a578dfe681562179beaaf5007c4f022510aeebd4e4cfffa167984
+  data.tar.gz: aa1ea9e43daffc284c731be4900ef522b1ef7b8eb49e4eb19aa395e8afce48b8
 SHA512:
-  metadata.gz: af459d4520f7939f5f89969329e5db9240c00ecefc9b66b4db046456f5f67241cd344ea72cf18d0772708587ce11ce059becf1158e4e657d6ebcf9fe9c79ee4a
-  data.tar.gz: bfc842c51b1314ea90f876e8b31609bb5ba36e0eaba2b89db041152cf95b8d5660abfe5b461f0b08cb344edac70fb62e8c120b0105ad2865e8bb88af3c6b5bc6
+  metadata.gz: 443cf425db06704c33ad85b5dc79140c3f0318543012067773442cc63a933d62469e9383581609895a66a974de470bb74f822f0468ae392a7596c1465fffcbf8
+  data.tar.gz: 37138108eec94b9f8705c5c2473b7ec92b27bc2224a58940a4fb9ef1fe013f2480940ec1b6c4ea8294fdc0ea431d0998775c3690f36f3d622fba3f89c5a2286b

data/README.md

@@ -1,10 +1,12 @@
 pry-stack_explorer
 ===========
 
-(C) John Mair (banisterfiend) 2011
-
 _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.
 
@@ -15,68 +17,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
 Pry's in-session help for more information on any of these commands.
 
-**How to use:**
+## Usage
+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
+
+
+## Install
+
+In Gemfile:
+```rb
+gem 'pry-stack_explorer', '~> 0.5.0'
+```
 
-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.
+```
+gem install pry-stack_explorer
+```
 
-* 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
+Example:
 --------
+Here we run the following ruby script:
+```Ruby
+require 'pry-stack_explorer'
 
-[![asciicast](https://asciinema.org/a/eJnrZNaUhTl12AVtnCG304d0V.png)](https://asciinema.org/a/eJnrZNaUhTl12AVtnCG304d0V)
+def alpha
+  x = "hello"
+  beta
+  puts x
+end
 
-Example: Modifying state in a caller
--------
-
-[![asciicast](https://asciinema.org/a/0KtCL9HB1bP08wNHLfIeOMa8K.png)](https://asciinema.org/a/0KtCL9HB1bP08wNHLfIeOMa8K)
+def beta
+  binding.pry
+end
 
-Output from above is `goodbye` as we changed the `x` local inside the `alpha` (caller) stack frame.
+alpha
+```
 
-Limitations
--------------------------
+We wander around the stack a little bit, and modify the state of a frame above the one we `binding.pry`'d at.
 
-* First release, so may have teething problems.
-* Limited to Rubinius, and MRI 1.9.2+ at this stage.
+[![asciicast](https://asciinema.org/a/257713.svg)](https://asciinema.org/a/257713)
 
-Contact
--------
+Output from above is `Goodbye` as we changed the `x` local inside the `alpha` (caller) stack frame.
 
-Problems or questions contact me at [github](http://github.com/banister)
+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
 -------
+Released under the [MIT License](https://github.com/pry/pry-stack_explorer/blob/master/LICENSE) by John Mair (banisterfiend) and contributors
 
-(The MIT License)
-
-Copyright (c) 2011 John Mair (banisterfiend)
-
-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.
-
-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}"
@@ -292,7 +292,7 @@ module PryStackExplorer
           output.puts "No caller stack available!"
         else
           content = ""
-          content << "\n#{text.bold("Showing all accessible frames in stack (#{frame_manager.bindings.size} in total):")}\n--\n"
+          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|

data/lib/pry-stack_explorer/version.rb

@@ -1,3 +1,3 @@
 module PryStackExplorer
-  VERSION = '0.4.9.3'
+  VERSION = '0.5.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

@@ -127,9 +127,9 @@ Pry.config.commands.import PryStackExplorer::Commands
 # monkey-patch the whereami command to show some frame information,
 # useful for navigating stack.
 Pry.config.hooks.add_hook(:before_whereami, :stack_explorer) do
-  if PryStackExplorer.frame_manager(_pry_) && !internal_binding?(target)
-    bindings      = PryStackExplorer.frame_manager(_pry_).bindings
-    binding_index = PryStackExplorer.frame_manager(_pry_).binding_index
+  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,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: pry-stack_explorer
 version: !ruby/object:Gem::Version
-  version: 0.4.9.3
+  version: 0.5.1
 platform: ruby
 authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-04 00:00:00.000000000 Z
+date: 2020-05-22 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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 - !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
@@ -66,37 +66,23 @@ dependencies:
     - - "~>"
       - !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: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -106,20 +92,15 @@ 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.6.13
+rubygems_version: 3.0.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,29 +0,0 @@
-script:
-  rake test --trace
-
-before_install:
-  - gem update --system
-
-rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1.10
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rmv: ruby-head
-  fast_finish: true
-
-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

data/Rakefile

@@ -1,112 +0,0 @@
-$:.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 -rubygems -I#{direc}/lib/ -r #{direc}/lib/#{PROJECT_NAME}")
-end
-
-desc "Run example"
-task :example do
-  sh "ruby -rubygems -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 -rubygems -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

data/examples/example.rb

@@ -1,45 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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

@@ -1,46 +0,0 @@
-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/pry-stack_explorer.gemspec

@@ -1,36 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = "pry-stack_explorer"
-  s.version = "0.4.9.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["John Mair (banisterfiend)"]
-  s.date = Time.now.strftime('%Y-%m-%d')
-  s.description = "Walk the stack in a Pry session"
-  s.email = "jrmair@gmail.com"
-  s.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"]
-  s.homepage = "https://github.com/pry/pry-stack_explorer"
-  s.require_paths = ["lib"]
-  s.summary = "Walk the stack in a Pry session"
-  s.test_files = ["test/helper.rb", "test/test_commands.rb", "test/test_frame_manager.rb", "test/test_stack_explorer.rb"]
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<binding_of_caller>, [">= 0.7"])
-      s.add_runtime_dependency(%q<pry>, [">= 0.9.11"])
-      s.add_development_dependency(%q<bacon>, ["~> 1.1.0"])
-      s.add_development_dependency(%q<rake>, ["~> 0.9"])
-    else
-      s.add_dependency(%q<binding_of_caller>, [">= 0.7"])
-      s.add_dependency(%q<pry>, [">= 0.9.11"])
-      s.add_dependency(%q<bacon>, ["~> 1.1.0"])
-      s.add_dependency(%q<rake>, ["~> 0.9"])
-    end
-  else
-    s.add_dependency(%q<binding_of_caller>, [">= 0.7"])
-    s.add_dependency(%q<pry>, [">= 0.9.11"])
-    s.add_dependency(%q<bacon>, ["~> 1.1.0"])
-    s.add_dependency(%q<rake>, ["~> 0.9"])
-  end
-end