break 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13fa3f9ac130eeffc32382e965d87102c8abb8a2fab3a8e7c202c0f22fd005b4
+  data.tar.gz: 0d0e7b2e40529c5529bf7bd87383c92443348a69fb1bdc8cb8918d4f8ac404eb
+SHA512:
+  metadata.gz: ad3ea9e586d651c5929f6235ba969142615bc71e10bae00e9ce18a56a4f413a12413d188f854e9e5812118885b353f3fed942b3e047853a105f0bd2bdf9b82e9
+  data.tar.gz: 22b0d7d70b05bf44bb4a39795a3d37ac1f4b023b6b9deb37db7b38edacc347f490857ffd3cc0942d008e65395ccd6daee7cc0db5f1fad74031b80cfad732eb5d

data/lib/break.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "break/version"
+require_relative "break/session"
+require_relative "break/context"
+require_relative "break/command"
+require_relative "break/commands"
+require_relative "break/filter"
+require_relative "break/binding_ext"
+
+require_relative "break/irb"
+require_relative "break/pry"
+
+Break::Filter.register_internal __dir__

data/lib/break/binding_ext.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Binding
+  unless method_defined?(:source_location)
+    def source_location
+      eval "[__FILE__, __LINE__.to_i]"
+    end
+  end
+end

data/lib/break/command.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Break
+  class Command
+    extend Forwardable
+
+    def initialize(session)
+      @session = session
+    end
+
+    def execute
+      raise NotImplementedError
+    end
+
+    private
+
+    attr_reader :session
+    def_delegators :session, :context, :context!, :frontend
+  end
+end

data/lib/break/commands.rb

@@ -0,0 +1,6 @@
+require_relative "commands/tracepoint_command"
+require_relative "commands/next_command"
+require_relative "commands/step_command"
+require_relative "commands/up_command"
+require_relative "commands/down_command"
+require_relative "commands/where_command"

data/lib/break/commands/down_command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Break
+  class DownCommand < TracePointCommand
+    def execute(*)
+      if context.depth >= 0
+        frontend.notify("Cannot go further down the stack")
+      else
+        super
+      end
+    end
+
+    def execute_trace(trace, *)
+      trace.disable
+
+      context!(*context.bindings, depth: context.depth + 1)
+    end
+  end
+end

data/lib/break/commands/next_command.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Break
+  class NextCommand < TracePointCommand
+    trace :line, :call, :return, :class, :end, :b_call, :b_return
+
+    def execute_trace(trace, *)
+      case trace.event
+      when :call, :class, :b_call
+        context.bindings << trace.binding
+        context.depth += 1
+      when :return, :end, :b_return
+        context.bindings.pop
+        context.depth -= 1
+      when :line
+        return if context.depth.positive?
+
+        trace.disable
+
+        context!(*context.bindings[0...-1], trace.binding)
+      end
+    end
+  end
+end

data/lib/break/commands/step_command.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Break
+  class StepCommand < TracePointCommand
+    trace :line, :call, :return, :class, :end, :b_call, :b_return
+
+    def execute_trace(trace, *)
+      case trace.event
+      when :call, :class, :b_call
+        trace.disable
+
+        context!(*context.bindings, trace.binding)
+      when :return, :end, :b_return
+        context.bindings.pop
+        context.depth -= 1
+      when :line
+        return if context.depth.positive?
+
+        trace.disable
+
+        context!(*context.bindings[0...-1], trace.binding)
+      end
+    end
+  end
+end

data/lib/break/commands/tracepoint_command.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Break
+  class TracePointCommand < Command
+    class << self
+      attr_reader :trace_events
+
+      def trace(*events)
+        @trace_events = events
+      end
+    end
+
+    def initialize(*)
+      super
+
+      @delayed_context = Fiber.new do |*args|
+        session.context!(*args)
+
+        loop do
+          session.context!(*Fiber.yield)
+        end
+      end
+    end
+
+    def execute(*args)
+      TracePoint.trace(*trace_events) do |trace|
+        next if Filter.internal?(trace.path)
+
+        execute_trace(trace, *args)
+      end
+
+      session.leave
+    end
+
+    def execute_trace
+      raise NotImplementedError
+    end
+
+    private
+
+    def context!(*args)
+      @delayed_context.resume(*args)
+    rescue FiberError
+      session.context!(*args)
+    end
+
+    def trace_events
+      self.class.trace_events
+    end
+  end
+end

data/lib/break/commands/up_command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Break
+  class UpCommand < TracePointCommand
+    def execute(*)
+      if context.bindings[context.depth - 2]
+        super
+      else
+        frontend.notify("Cannot go further up the stack")
+      end
+    end
+
+    def execute_trace(trace, *)
+      trace.disable
+
+      context!(*context.bindings, depth: context.depth - 1)
+    end
+  end
+end

data/lib/break/commands/where_command.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Break
+  class WhereCommand < Command
+    def execute(*)
+      frontend.where
+    end
+  end
+end

data/lib/break/context.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Break
+  class Context
+    attr_accessor :bindings
+    attr_accessor :depth
+
+    def initialize(*bindings, depth: 0)
+      @bindings = bindings
+      @depth = depth
+    end
+
+    def binding
+      @bindings[@depth - 1]
+    end
+
+    def inspect
+      "#{path}:#{lineno}"
+    end
+  end
+end

data/lib/break/filter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Break
+  module Filter
+    extend self
+
+    attr_reader :internal
+
+    def register_internal(*paths)
+      (@internal ||= []).concat(paths)
+    end
+
+    def internal?(path)
+      @internal.any? { |location| path.include?(location) }
+    end
+  end
+end

data/lib/break/irb.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "irb/frontend"
+require_relative "irb/commands"
+require_relative "irb/overrides"
+
+require "open-uri"
+
+Break::Filter.register_internal IRB.method(:start).source_location.first.chomp(".rb")
+Break::Filter.register_internal URI.method(:open).source_location.first.chomp(".rb")
+Break::Filter.register_internal "(irb)"
+
+Binding.prepend Break::IRB::Overrides

data/lib/break/irb/commands.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module Break::IRB
+  class Commands < Module
+    def initialize(session)
+      define_command session, :next,     Break::NextCommand
+      define_command session, :step,     Break::StepCommand
+      define_command session, :up,       Break::UpCommand
+      define_command session, :down,     Break::DownCommand
+      define_command session, :whereami, Break::WhereCommand
+    end
+
+    private
+
+    def define_command(session, name, cls)
+      define_method(name) do |*args|
+        cls.new(session).execute(*args)
+      end
+    end
+  end
+end

data/lib/break/irb/frontend.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "irb"
+
+module Break::IRB
+  class Frontend
+    def initialize
+      IRB.setup caller_locations.first.path, argv: []
+    end
+
+    def attach(session)
+      @workspace = IRB::WorkSpace.new(session.context.binding)
+
+      begin
+        @irb = IRB::Irb.new(@workspace)
+        @irb.context.main.extend Commands.new(session)
+      rescue TypeError
+        return
+      end
+
+      where
+
+      @irb.suspend_context special_case_next_eval(@irb.context) do
+        @irb.run(IRB.conf)
+      end
+    end
+
+    def detach
+      @irb&.context&.exit
+    end
+
+    def where
+      puts @workspace.code_around_binding if @workspace
+    end
+
+    def notify(message)
+      puts message
+    end
+
+    private
+
+    # Evaling `next` is a `SyntaxError` in Ruby. Since IRB does not have
+    # commands support in the lexer level, we need to call the `next` command
+    # in syntactically correct way.
+    def special_case_next_eval(irb_context)
+      def irb_context.evaluate(line, line_no, *args, **kwargs)
+        line = "self.next\n" if line == "next\n"
+        super(line, line_no, *args, **kwargs)
+      end
+
+      irb_context
+    end
+  end
+end

data/lib/break/irb/overrides.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Break::IRB
+  module Overrides
+    def irb
+      session = Break::Session.new(self, frontend: Frontend.new)
+      session.enter
+    end
+  end
+end

data/lib/break/pry.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+begin
+  require "pry"
+  require "break"
+
+  require_relative "pry/frontend"
+  require_relative "pry/commands"
+
+  Break::Filter.register_internal MethodSource.method(:source_helper).source_location.first.chomp(".rb")
+  Break::Filter.register_internal CodeRay.method(:scan).source_location.first.chomp(".rb")
+  Break::Filter.register_internal Pry.method(:start).source_location.first.chomp("/pry_class.rb")
+  Break::Filter.register_internal Forwardable.instance_method(:def_delegator).source_location.first.chomp(".rb")
+  Break::Filter.register_internal "(pry)"
+  Break::Filter.register_internal __dir__
+
+  Pry.config.commands.import Break::Pry::Commands
+rescue LoadError
+  # Do nothing if we cannot require pry.
+end

data/lib/break/pry/commands.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Break::Pry
+  Commands = Pry::CommandSet.new do
+    create_command "next", "Go to the next line." do
+      group "Break"
+
+      banner <<-BANNER
+        Usage: next
+
+        Step over within the same frame.
+
+        Examples:
+          next #=> Move a line forward.
+      BANNER
+
+      def process
+        pry = defined?(pry_instance) ? pry_instance : _pry_
+        session = Break::Session.new(pry.binding_stack.first, frontend: Frontend.new(pry))
+
+        command = Break::NextCommand.new(session)
+        command.execute
+      end
+    end
+
+    create_command "step", "Step into the current line invocation." do
+      group "Break"
+
+      banner <<-BANNER
+        Usage: step
+
+        Step into a method call.
+
+        Examples:
+          step #=> Step into the method invocation.
+      BANNER
+
+      def process
+        pry = defined?(pry_instance) ? pry_instance : _pry_
+        session = Break::Session.new(pry.binding_stack.first, frontend: Frontend.new(pry))
+
+        command = Break::StepCommand.new(session)
+        command.execute
+      end
+    end
+
+    create_command "up", "Go up a frame." do
+      group "Break"
+
+      banner <<-BANNER
+        Usage: up
+
+        Go to the frame that called the current one. Can be used only if the
+        command `step` was issued before.
+
+        Examples:
+          up #=> Step into the method invocation.
+      BANNER
+
+      def process
+        pry = defined?(pry_instance) ? pry_instance : _pry_
+        session = Break::Session.new(pry.binding_stack.first, frontend: Frontend.new(pry))
+
+        command = Break::UpCommand.new(session)
+        command.execute
+      end
+    end
+
+    create_command "down", "Go down a frame." do
+      group "Break"
+
+      banner <<-BANNER
+        Usage: down
+
+        Go to the frame called from the current one. Can be used only if the
+        command `step` was issued before.
+
+        Examples:
+          down #=> Step to the previous frame.
+      BANNER
+
+      def process
+        pry = defined?(pry_instance) ? pry_instance : _pry_
+        session = Break::Session.new(pry.binding_stack.first, frontend: Frontend.new(pry))
+
+        command = Break::DownCommand.new(session)
+        command.execute
+      end
+    end
+  end
+end

data/lib/break/pry/frontend.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Break::Pry
+  class Frontend
+    def initialize(pry)
+      @pry = pry
+    end
+
+    def attach(session)
+      @pry = Pry.start(session.context.binding)
+      where
+    end
+
+    def detach
+      throw :breakout
+    end
+
+    def where
+      @pry&.run_command "whereami".dup
+    rescue MethodSource::SourceNotFoundError
+      puts "Cannot find method code."
+    end
+
+    def notify(message)
+      puts message
+    end
+  end
+end

data/lib/break/session.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Break
+  class Session
+    attr_reader :contexts
+    attr_reader :frontend
+
+    def initialize(binding, frontend:)
+      @contexts = [Context.new(binding)]
+      @frontend = frontend
+    end
+
+    def enter
+      frontend.attach(self)
+    end
+
+    def leave
+      frontend.detach
+    end
+
+    def context
+      contexts.last
+    end
+
+    def context!(*bindings, depth: 0)
+      contexts << Context.new(*bindings, depth: depth)
+      enter
+    end
+  end
+end

data/lib/break/testing.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "minitest"
+
+module Break
+  class TestingFrontend
+    class << self
+      def build(&block)
+        Class.new(self, &block)
+      end
+
+      def stack
+        @stack ||= []
+      end
+
+      def [](index)
+        stack[index]
+      end
+
+      def last
+        stack.last
+      end
+
+      def clear
+        stack.clear
+      end
+    end
+
+    attr_reader :session
+
+    def initialize
+      self.class.stack << self
+    end
+
+    def attach(session)
+      @session = session
+    end
+
+    def detach; end
+
+    def where; end
+
+    def notify(_message); end
+  end
+
+  class Test < Minitest::Test
+    def self.test(name, &block)
+      define_method("test_#{name}", &block)
+    end
+
+    def pass
+      Kernel.binding.tap do |binding|
+        yield binding if block_given?
+      end
+    end
+  end
+end

data/lib/break/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Break
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: break
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Genadi Samokovarov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+description: Lightweight Ruby debugger written in plain Ruby using the TracePoint
+  API
+email:
+- gsamokovarov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/break.rb
+- lib/break/binding_ext.rb
+- lib/break/command.rb
+- lib/break/commands.rb
+- lib/break/commands/down_command.rb
+- lib/break/commands/next_command.rb
+- lib/break/commands/step_command.rb
+- lib/break/commands/tracepoint_command.rb
+- lib/break/commands/up_command.rb
+- lib/break/commands/where_command.rb
+- lib/break/context.rb
+- lib/break/filter.rb
+- lib/break/irb.rb
+- lib/break/irb/commands.rb
+- lib/break/irb/frontend.rb
+- lib/break/irb/overrides.rb
+- lib/break/pry.rb
+- lib/break/pry/commands.rb
+- lib/break/pry/frontend.rb
+- lib/break/session.rb
+- lib/break/testing.rb
+- lib/break/version.rb
+homepage: https://github.com/gsamokovarov/break
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Lightweight Ruby debugger
+test_files: []