pry-byebug 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b3ed5737036fb3e67543d8df53880500db2ea98
-  data.tar.gz: f4130936f658687b08af6ee8bed74e8554b6a77b
+  metadata.gz: d5b8fdd92c518cf1c6800d1c1d1c481c5c0154f4
+  data.tar.gz: 92484d0776f36921b38ff4f89f8a3c867c076544
 SHA512:
-  metadata.gz: a361fb51061ca0c6efd216623dca9754173352dcca012a82f48b80fffb767fbe1e39b649213c15b1737275f19ef6943394a9c3310dc9da7f2d9651f685d009d6
-  data.tar.gz: aeb8e5bed91c15c156cd739906791469369b55787a38a1c7212d3441f75ad6978b984877eae54d05814258205416ae17daa1da3bffe90434187bcfafc1b70f2d
+  metadata.gz: ac47acea5c530840ecaac8e51dffaf0c0d88ff45f78c1aebbd2ffba67e89461cf0cf9ef400cfdfc7b53b6c1e24ebd9405d24eca1ab90ed70dd37034ffd4d2b8b
+  data.tar.gz: a0f259126736dea8c91727c1a506fc87a4ff94626ae609892cc83e3c68e33eda8ed5767511a027189e8a7c2db4495010f1643f8915b1df95b0c02103ce36f8fe

data/.rubocop.yml

@@ -10,3 +10,5 @@ Style/FileName:
 
 Style/ModuleFunction:
   Enabled: false
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-03-13 12:00:51 -0300 using RuboCop version 0.29.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 39
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 142
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 23

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.1.0 (2015-04-14)
+
+- Improvements:
+  * Add frame nav commands up, down and frame.
+
 ## 3.0.1 (2015-04-02)
 
 - Improvements:

data/Gemfile

@@ -2,13 +2,13 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake', '~> 10.3'
+gem 'rake', '~> 10.4'
 
 group :development do
-  gem 'rubocop', '~> 0.26'
+  gem 'rubocop', '0.29.1'
 end
 
 group :test do
   gem 'mocha', '~> 1.1'
-  gem 'minitest', '~> 5.4'
+  gem 'minitest', '~> 5.5'
 end

data/README.md

@@ -51,6 +51,14 @@ optional numeric argument to step multiple lines.
 
 **continue:** Continue program execution and end the Pry session.
 
+**up:** Moves the stack frame up. Takes an optional numeric argument to move
+multiple frames.
+
+**down:** Moves the stack frame down. Takes an optional numeric argument to move
+multiple frames.
+
+**frame:** Moves to a specific frame. Called without arguments will show the
+current frame.
 
 ## Matching Byebug Behaviour
 

data/Rakefile

@@ -1,10 +1,17 @@
 require 'bundler/gem_tasks'
+
 require 'rake/testtask'
 
 desc 'Run tests'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
+  t.ruby_opts += ['-w']
   t.pattern = 'test/**/*_test.rb'
 end
 
-task default: :test
+require 'rubocop/rake_task'
+
+desc 'Run RuboCop'
+task(:rubocop) { RuboCop::RakeTask.new }
+
+task default: [:test, :rubocop]

data/lib/byebug/processors/pry_processor.rb

@@ -1,4 +1,3 @@
-require 'pry'
 require 'byebug'
 
 module Byebug
@@ -7,11 +6,17 @@ module Byebug
   #
   class PryProcessor < Processor
     attr_accessor :pry
+    attr_reader :state
+
+    extend Forwardable
+    def_delegators :@pry, :output
+    def_delegators Pry::Helpers::Text, :bold
 
     def initialize(interface = LocalInterface.new)
       super(interface)
 
       Byebug.handler = self
+      Byebug::Setting[:autolist] = false
     end
 
     def start
@@ -23,6 +28,14 @@ module Byebug
     # Wrap a Pry REPL to catch navigational commands and act on them.
     #
     def run(&_block)
+      @state ||= Byebug::RegularState.new(
+        Byebug.current_context,
+        [],
+        Byebug.current_context.frame_file,
+        interface,
+        Byebug.current_context.frame_line
+      )
+
       return_value = nil
 
       command = catch(:breakout_nav) do  # Throws from PryByebug::Commands
@@ -33,7 +46,7 @@ module Byebug
       # Pry instance to resume after stepping
       @pry = command[:pry]
 
-      perform(command[:action], (command[:times] || '1').to_i)
+      perform(command[:action], command[:options])
 
       return_value
     end
@@ -41,15 +54,12 @@ module Byebug
     #
     # Set up a number of navigational commands to be performed by Byebug.
     #
-    def perform(action, times)
-      case action
-      when :next
-        Byebug.current_context.step_over(times, 0)
-      when :step
-        Byebug.current_context.step_into(times)
-      when :finish
-        Byebug.current_context.step_out(times)
-      end
+    def perform(action, options = {})
+      return unless [
+        :next, :step, :finish, :up, :down, :frame
+      ].include?(action)
+
+      send("perform_#{action}", options)
     end
 
     # --- Callbacks from byebug C extension ---
@@ -76,34 +86,81 @@ module Byebug
     def at_breakpoint(_context, breakpoint)
       @pry ||= Pry.new
 
-      brkpt_num = "\n  Breakpoint #{breakpoint.id}. "
-      @pry.output.print Pry::Helpers::Text.bold(brkpt_num)
-
-      n_hits = breakpoint.hit_count
-      @pry.output.puts(n_hits == 1 ? 'First hit' : "Hit #{n_hits} times.")
+      output.puts bold("\n  Breakpoint #{breakpoint.id}. ") + n_hits(breakpoint)
 
       expr = breakpoint.expr
       return unless expr
 
-      @pry.output.print Pry::Helpers::Text.bold('Condition: ')
-      @pry.output.puts expr
+      output.puts bold('Condition: ') + expr
     end
 
     private
 
+    def n_hits(breakpoint)
+      n_hits = breakpoint.hit_count
+
+      n_hits == 1 ? 'First hit' : "Hit #{n_hits} times."
+    end
+
     #
     # Resume an existing Pry REPL at the paused point.
     #
     def resume_pry(context)
-      new_binding = context.frame_binding(0)
+      frame_position = state ? state.frame : 0
+
+      new_binding = context.frame_binding(frame_position)
 
       run do
-        if @pry
+        if defined?(@pry) && @pry
           @pry.repl(new_binding)
         else
           @pry = Pry.start_without_pry_byebug(new_binding)
         end
       end
     end
+
+    def perform_next(options)
+      lines = (options[:lines] || 1).to_i
+      state.context.step_over(lines, state.frame)
+    end
+
+    def perform_step(options)
+      times = (options[:times] || 1).to_i
+      state.context.step_into(times, state.frame)
+    end
+
+    def perform_finish(*)
+      state.context.step_out(1)
+    end
+
+    def perform_up(options)
+      times = (options[:times] || 1).to_i
+
+      command = Byebug::UpCommand.new(state)
+      command.match("up #{times}")
+      command.execute
+
+      resume_pry(state.context)
+    end
+
+    def perform_down(options)
+      times = (options[:times] || 1).to_i
+
+      command = Byebug::DownCommand.new(state)
+      command.match("down #{times}")
+      command.execute
+
+      resume_pry(state.context)
+    end
+
+    def perform_frame(options)
+      index = options[:index] ? options[:index].to_i : ''
+
+      command = Byebug::FrameCommand.new(state)
+      command.match("frame #{index}")
+      command.execute
+
+      resume_pry(state.context)
+    end
   end
 end

data/lib/pry-byebug.rb

@@ -1,4 +1,6 @@
+require 'pry'
 require 'pry-byebug/base'
 require 'pry-byebug/pry_ext'
 require 'pry/commands/stepping'
+require 'pry/commands/frames'
 require 'pry/commands/breakpoint'

data/lib/pry-byebug/cli.rb

@@ -1 +1,4 @@
-require 'pry-byebug'
+require 'pry-byebug/base'
+require 'pry-byebug/pry_ext'
+require 'pry/commands/stepping'
+require 'pry/commands/breakpoint'

data/lib/pry-byebug/pry_ext.rb

@@ -1,4 +1,3 @@
-require 'pry'
 require 'byebug/processors/pry_processor'
 
 class << Pry

data/lib/pry-byebug/version.rb

@@ -2,5 +2,5 @@
 # Main container module for Pry-Byebug functionality
 #
 module PryByebug
-  VERSION = '3.0.1'
+  VERSION = '3.1.0'
 end

data/lib/pry/byebug/breakpoints.rb

@@ -84,8 +84,11 @@ class Pry
       # Deletes an existing breakpoint with the given ID.
       #
       def delete(id)
-        deleted = ::Byebug.started? &&
-          ::Byebug::Breakpoint.remove(id) && breakpoints.delete(find_by_id(id))
+        deleted =
+          ::Byebug.started? &&
+          ::Byebug::Breakpoint.remove(id) &&
+          breakpoints.delete(find_by_id(id))
+
         fail(ArgumentError, "No breakpoint ##{id}") unless deleted
       end
 
@@ -147,8 +150,8 @@ class Pry
       end
 
       def validate_expression(exp)
-        return unless exp &&
-                     (exp.empty? || !Pry::Code.complete_expression?(exp))
+        valid = exp && (exp.empty? || !Pry::Code.complete_expression?(exp))
+        return unless valid
 
         fail("Invalid breakpoint conditional: #{expression}")
       end

data/lib/pry/commands/breakpoint.rb

@@ -1,4 +1,3 @@
-require 'pry'
 require 'pry/byebug/breakpoints'
 
 #
@@ -57,8 +56,7 @@ class Pry
         all.each do |option|
           next unless opts.present?(option)
 
-          method_name = "process_#{option.gsub('-', '_')}"
-          return send(method_name)
+          return send("process_#{option.gsub('-', '_')}")
         end
 
         new_breakpoint unless args.empty?
@@ -141,7 +139,6 @@ class Pry
         else
           print_breakpoints_header
           breakpoints.each { |b| print_short_breakpoint(b) }
-          output.puts
         end
       end
     end
@@ -186,7 +183,7 @@ class Pry
       # Print out concise information about a breakpoint.
       #
       def print_short_breakpoint(breakpoint)
-        id = sprintf('%*d', max_width, breakpoint.id)
+        id = format('%*d', max_width, breakpoint.id)
         status = breakpoint.enabled? ? 'Yes' : 'No'
         expr = breakpoint.expr ? breakpoint.expr : ''
 

data/lib/pry/commands/frames.rb

@@ -0,0 +1,79 @@
+#
+# Main Pry class.
+#
+# We're going to add to it custom frame commands for Pry-Byebug
+#
+class Pry
+  FrameCommands = CommandSet.new do
+    create_command 'up' do
+      description 'Move current frame up.'
+
+      banner <<-BANNER
+        Usage: up [TIMES]
+
+        Move current frame up. By default, moves by 1 frame.
+
+        Examples:
+          up   #=> Move up 1 frame.
+          up 5 #=> Move up 5 frames.
+      BANNER
+
+      def process
+        PryByebug.check_file_context(target)
+
+        frame_navigation :up, times: args.first
+      end
+    end
+
+    create_command 'down' do
+      description 'Move current frame down.'
+
+      banner <<-BANNER
+        Usage: down [TIMES]
+
+        Move current frame down. By default, moves by 1 frame.
+
+        Examples:
+          down   #=> Move down 1 frame.
+          down 5 #=> Move down 5 frames.
+      BANNER
+
+      def process
+        PryByebug.check_file_context(target)
+
+        frame_navigation :down, times: args.first
+      end
+    end
+
+    create_command 'frame' do
+      description 'Move to specified frame #.'
+
+      banner <<-BANNER
+        Usage: frame [TIMES]
+
+        Move to specified frame #.
+
+        Examples:
+          frame   #=> Show current frame #.
+          frame 5 #=> Move to frame 5.
+      BANNER
+
+      def process
+        PryByebug.check_file_context(target)
+
+        frame_navigation :frame, index: args.first
+      end
+    end
+
+    helpers do
+      def frame_navigation(action, options = {})
+        _pry_.binding_stack.clear # Clear the binding stack.
+
+        # Break out of the REPL loop and signal tracer
+        throw :breakout_nav, action: action, options: options, pry: _pry_
+      end
+    end
+  end
+
+  Pry.commands.import(FrameCommands)
+end

data/lib/pry/commands/stepping.rb

@@ -1,5 +1,3 @@
-require 'pry'
-
 #
 # Main Pry class.
 #
@@ -23,7 +21,7 @@ class Pry
       def process
         PryByebug.check_file_context(target)
 
-        breakout_navigation :step, args.first
+        breakout_navigation :step, times: args.first
       end
     end
 
@@ -44,7 +42,7 @@ class Pry
       def process
         PryByebug.check_file_context(target)
 
-        breakout_navigation :next, args.first
+        breakout_navigation :next, lines: args.first
       end
     end
 
@@ -77,11 +75,11 @@ class Pry
     end
 
     helpers do
-      def breakout_navigation(action, times = nil)
+      def breakout_navigation(action, options = {})
         _pry_.binding_stack.clear # Clear the binding stack.
 
         # Break out of the REPL loop and signal tracer
-        throw :breakout_nav, action: action, times: times, pry: _pry_
+        throw :breakout_nav, action: action, options: options, pry: _pry_
       end
     end
   end

data/pry-byebug.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 2.0.0'
 
   gem.add_runtime_dependency 'pry', '~> 0.10'
-  gem.add_runtime_dependency 'byebug', '~> 3.4'
+  gem.add_runtime_dependency 'byebug', '~> 4.0'
 end

data/test/breakpoints_test.rb

@@ -52,8 +52,10 @@ module BreakpointSpecs
   end
 
   def test_shows_breakpoint_hit
-    match = @output.string.match(@regexp)
-    @output.string.must_match(/^  Breakpoint #{match[:id]}\. First hit/)
+    result = @output.string
+    result.must_match(@regexp)
+    match = result.match(@regexp)
+    result.must_match(/^  Breakpoint #{match[:id]}\. First hit/)
   end
 
   def test_shows_breakpoint_line
@@ -70,21 +72,22 @@ class BreakpointsTestCommands < Minitest::Spec
 
   before do
     Pry.color, Pry.pager, Pry.hooks = false, false, Pry::DEFAULT_HOOKS
+    @input = InputTester.new 'break --delete-all'
+    redirect_pry_io(@input, StringIO.new) do
+      binding.pry # rubocop:disable Lint/Debugger
+    end
+    Object.send :remove_const, :Break1Example if defined? Break1Example
+    Object.send :remove_const, :Break2Example if defined? Break2Example
     @output = StringIO.new
   end
 
   describe 'Set Breakpoints' do
-    before do
-      @input = InputTester.new 'break --delete-all'
-      redirect_pry_io(@input, @output) { load break_first_file }
-    end
-
     describe 'set by line number' do
       before do
-        @input = InputTester.new('break 7')
+        @input = InputTester.new('break 6')
         redirect_pry_io(@input, @output) { load break_first_file }
-        @line = 7
-        @regexp = /  Breakpoint (?<id>\d+): #{break_first_file} @ 7 \(Enabled\)/
+        @line = 6
+        @regexp = /  Breakpoint (?<id>\d+): #{break_first_file} @ 6 \(Enabled\)/
       end
 
       include BreakpointSpecs
@@ -94,7 +97,7 @@ class BreakpointsTestCommands < Minitest::Spec
       before do
         @input = InputTester.new('break Break1Example#a')
         redirect_pry_io(@input, @output) { load break_first_file }
-        @line = 7
+        @line = 5
         @regexp = /  Breakpoint (?<id>\d+): Break1Example#a \(Enabled\)/
       end
 
@@ -105,7 +108,7 @@ class BreakpointsTestCommands < Minitest::Spec
       before do
         @input = InputTester.new('break Break1Example#c!')
         redirect_pry_io(@input, @output) { load break_first_file }
-        @line = 17
+        @line = 15
         @regexp = /  Breakpoint (?<id>\d+): Break1Example#c! \(Enabled\)/
       end
 
@@ -116,7 +119,7 @@ class BreakpointsTestCommands < Minitest::Spec
       before do
         @input = InputTester.new('break #b')
         redirect_pry_io(@input, @output) { load break_second_file }
-        @line = 11
+        @line = 7
         @regexp = /  Breakpoint (?<id>\d+): Break2Example#b \(Enabled\)/
       end
 
@@ -126,7 +129,7 @@ class BreakpointsTestCommands < Minitest::Spec
 
   describe 'List breakpoints' do
     before do
-      @input = InputTester.new('break --delete-all', 'break #b', 'breakpoints')
+      @input = InputTester.new('break #b', 'breakpoints')
       redirect_pry_io(@input, @output) { load break_second_file }
     end
 

data/test/examples/break1.rb

@@ -1,5 +1,3 @@
-binding.pry
-
 #
 # A toy example for testing break commands.
 #
@@ -20,4 +18,6 @@ class Break1Example
   end
 end
 
+binding.pry
+
 Break1Example.new.a

data/test/examples/deep_stepping.rb

@@ -6,4 +6,4 @@ new_str = 'string'.gsub!(/str/) do |_|
   binding.pry
 end
 
-new_str
+_foo = new_str

data/test/examples/frames.rb

@@ -0,0 +1,14 @@
+#
+# Toy class for testing frame commands
+#
+class Frames
+  def method_a
+    method_b
+  end
+
+  def method_b
+    binding.pry
+  end
+end
+
+Frames.new.method_a

data/test/examples/stepping.rb

@@ -26,4 +26,4 @@ ex = SteppingExample.new.method_a
   ex += 1
 end
 
-ex
+_foo = ex

data/test/frames_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+#
+# Tests for pry-byebug frame commands.
+#
+class FramesTest < MiniTest::Spec
+  let(:output) { StringIO.new }
+
+  before do
+    Pry.color, Pry.pager, Pry.hooks = false, false, Pry::DEFAULT_HOOKS
+  end
+
+  describe 'Up command' do
+    let(:input) { InputTester.new('up', 'down') }
+
+    before do
+      redirect_pry_io(input, output) { load test_file('frames') }
+    end
+
+    it 'shows current line' do
+      output.string.must_match(/=> \s*6: \s*method_b/)
+    end
+  end
+
+  describe 'Down command' do
+    let(:input) { InputTester.new('up', 'down') }
+
+    before do
+      redirect_pry_io(input, output) { load test_file('frames') }
+    end
+
+    it 'shows current line' do
+      output.string.must_match(/=> \s*11: \s*end/)
+    end
+  end
+
+  describe 'Frame command' do
+    before do
+      redirect_pry_io(input, output) { load test_file('frames') }
+    end
+
+    describe 'jump to frame 1' do
+      let(:input) { InputTester.new('frame 1', 'frame 0') }
+
+      it 'shows current line' do
+        output.string.must_match(/=> \s*6: \s*method_b/)
+      end
+    end
+
+    describe 'jump to current frame' do
+      let(:input) { InputTester.new('frame 0') }
+
+      it 'shows current line' do
+        output.string.must_match(/=> \s*11: \s*end/)
+      end
+    end
+  end
+end

data/test/processor_test.rb

@@ -14,6 +14,7 @@ class ProcessorTest < Minitest::Spec
     let(:step_file) { test_file('stepping') }
 
     before do
+      Object.send :remove_const, :SteppingExample if defined? SteppingExample
       @input = InputTester.new
       @output = StringIO.new
       redirect_pry_io(@input, @output) { load step_file }

data/test/{commands_test.rb → stepping_test.rb}

@@ -14,12 +14,13 @@ module SteppingSpecs
 end
 
 #
-# Tests for pry-byebug commands.
+# Tests for pry-byebug stepping commands.
 #
-class CommandsTest < MiniTest::Spec
+class SteppingTest < MiniTest::Spec
   let(:step_file) { test_file('stepping') }
 
   before do
+    Object.send :remove_const, :SteppingExample if defined? SteppingExample
     Pry.color, Pry.pager, Pry.hooks = false, false, Pry::DEFAULT_HOOKS
     @output = StringIO.new
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-byebug
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - David Rodríguez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '4.0'
 description: |-
   Combine 'pry' with 'byebug'. Adds 'step', 'next',
      'finish', 'continue' and 'break' commands to control execution.
@@ -49,6 +49,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -64,18 +65,21 @@ files:
 - lib/pry-byebug/version.rb
 - lib/pry/byebug/breakpoints.rb
 - lib/pry/commands/breakpoint.rb
+- lib/pry/commands/frames.rb
 - lib/pry/commands/stepping.rb
 - pry-byebug.gemspec
 - test/base_test.rb
 - test/breakpoints_test.rb
-- test/commands_test.rb
 - test/examples/break1.rb
 - test/examples/break2.rb
 - test/examples/deep_stepping.rb
+- test/examples/frames.rb
 - test/examples/stepping.rb
+- test/frames_test.rb
 - test/processor_test.rb
 - test/pry_ext_test.rb
 - test/pry_remote_ext_test.rb
+- test/stepping_test.rb
 - test/test_helper.rb
 homepage: https://github.com/deivid-rodriguez/pry-byebug
 licenses:
@@ -97,19 +101,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Fast debugging with Pry.
 test_files:
 - test/base_test.rb
 - test/breakpoints_test.rb
-- test/commands_test.rb
 - test/examples/break1.rb
 - test/examples/break2.rb
 - test/examples/deep_stepping.rb
+- test/examples/frames.rb
 - test/examples/stepping.rb
+- test/frames_test.rb
 - test/processor_test.rb
 - test/pry_ext_test.rb
 - test/pry_remote_ext_test.rb
+- test/stepping_test.rb
 - test/test_helper.rb