readapt 1.3.0 → 1.4.0

data/lib/readapt.rb

@@ -1,21 +1,21 @@
-require 'backport'
-
-require 'readapt/version'
-require 'readapt/readapt'
-require 'readapt/references'
-require 'readapt/breakpoint'
-require 'readapt/thread'
-require 'readapt/frame'
-require 'readapt/monitor'
-require 'readapt/snapshot'
-require 'readapt/finder'
-require 'readapt/debugger'
-require 'readapt/message'
-require 'readapt/variable'
-require 'readapt/data_reader'
-require 'readapt/server'
-require 'readapt/adapter'
-require 'readapt/input'
-require 'readapt/output'
-require 'readapt/error'
-require 'readapt/shell'
+require 'backport'
+
+require 'readapt/version'
+require 'readapt/readapt'
+require 'readapt/references'
+require 'readapt/breakpoint'
+require 'readapt/thread'
+require 'readapt/frame'
+require 'readapt/monitor'
+require 'readapt/snapshot'
+require 'readapt/finder'
+require 'readapt/debugger'
+require 'readapt/message'
+require 'readapt/variable'
+require 'readapt/data_reader'
+require 'readapt/server'
+require 'readapt/adapter'
+require 'readapt/input'
+require 'readapt/output'
+require 'readapt/error'
+require 'readapt/shell'

data/lib/readapt/adapter.rb

@@ -1,98 +1,98 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module Readapt
-  module Adapter
-    # @!parse include Backport::Adapter
-
-    @@debugger = nil
-
-    def self.host debugger
-      @@debugger = debugger
-    end
-
-    def self.procid= pid
-      @@procid = pid
-    end
-
-    def procid
-      @@procid
-    end
-
-    def open_message
-      @@open_message ||= "<readapt-#{procid}>"
-    end
-
-    def close_message
-      @@close_message ||= "</readapt-#{procid}>"
-    end
-
-    def format result
-      write_line result.to_protocol.to_json
-    end
-
-    def opening
-      @@debugger.add_observer self
-      @data_reader = DataReader.new
-      @data_reader.set_message_handler do |message|
-        process message
-      end
-    end
-
-    def closing
-      @@debugger.delete_observer(self)
-    end
-
-    def receiving data
-      @data_reader.receive data
-    end
-
-    def update event, data
-      obj = {
-        type: 'event',
-        event: event
-      }
-      obj[:body] = data unless data.nil?
-      json = obj.to_json
-      envelope = "#{open_message}Content-Length: #{json.bytesize}\r\n\r\n#{json}#{close_message}"
-      write envelope
-      write "#{open_message}__TERMINATE__#{close_message}" if event == 'terminated'
-    end
-
-    private
-
-    # @param data [Hash]
-    # @return [void]
-    def process data
-      message = Message.process(data, @@debugger)
-      if data['seq']
-        json = {
-          type: 'response',
-          request_seq: data['seq'],
-          success: true,
-          command: data['command'],
-          body: message.body
-        }.to_json
-        envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
-        write "#{open_message}#{envelope}#{close_message}"
-        if data['command'] == 'disconnect'
-          @@debugger.disconnect
-          # @todo It does not appear necessary to close the adapter after
-          #   disconnecting the debugger.
-          # close
-        end
-        return unless data['command'] == 'initialize'
-        json = {
-          type: 'event',
-          event: 'initialized'
-        }.to_json
-        envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
-        write "#{open_message}#{envelope}#{close_message}"
-      end
-    rescue RuntimeError => e
-      STDERR.puts "[#{e.class}] #{e.message}"
-      STDERR.puts e.backtrace.join
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'json'
+
+module Readapt
+  module Adapter
+    # @!parse include Backport::Adapter
+
+    @@debugger = nil
+
+    def self.host debugger
+      @@debugger = debugger
+    end
+
+    def self.procid= pid
+      @@procid = pid
+    end
+
+    def procid
+      @@procid
+    end
+
+    def open_message
+      @@open_message ||= "<readapt-#{procid}>"
+    end
+
+    def close_message
+      @@close_message ||= "</readapt-#{procid}>"
+    end
+
+    def format result
+      write_line result.to_protocol.to_json
+    end
+
+    def opening
+      @@debugger.add_observer self
+      @data_reader = DataReader.new
+      @data_reader.set_message_handler do |message|
+        process message
+      end
+    end
+
+    def closing
+      @@debugger.delete_observer(self)
+    end
+
+    def receiving data
+      @data_reader.receive data
+    end
+
+    def update event, data
+      obj = {
+        type: 'event',
+        event: event
+      }
+      obj[:body] = data unless data.nil?
+      json = obj.to_json
+      envelope = "#{open_message}Content-Length: #{json.bytesize}\r\n\r\n#{json}#{close_message}"
+      write envelope
+      write "#{open_message}__TERMINATE__#{close_message}" if event == 'terminated'
+    end
+
+    private
+
+    # @param data [Hash]
+    # @return [void]
+    def process data
+      message = Message.process(data, @@debugger)
+      if data['seq']
+        json = {
+          type: 'response',
+          request_seq: data['seq'],
+          success: true,
+          command: data['command'],
+          body: message.body
+        }.to_json
+        envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
+        write "#{open_message}#{envelope}#{close_message}"
+        if data['command'] == 'disconnect'
+          @@debugger.disconnect
+          # @todo It does not appear necessary to close the adapter after
+          #   disconnecting the debugger.
+          # close
+        end
+        return unless data['command'] == 'initialize'
+        json = {
+          type: 'event',
+          event: 'initialized'
+        }.to_json
+        envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
+        write "#{open_message}#{envelope}#{close_message}"
+      end
+    rescue RuntimeError => e
+      STDERR.puts "[#{e.class}] #{e.message}"
+      STDERR.puts e.backtrace.join
+    end
+  end
+end

data/lib/readapt/breakpoint.rb

@@ -1,21 +1,21 @@
-module Readapt
-  class Breakpoint
-    attr_reader :source
-    attr_reader :line
-    attr_reader :condition
-    attr_reader :hit_condition
-    attr_writer :hit_cursor
-
-    def initialize source, line, condition, hit_condition
-      @source = source
-      @line = line
-      @condition = condition
-      @hit_condition = hit_condition
-    end
-
-    # @return [Integer]
-    def hit_cursor
-      @hit_cursor ||= 0
-    end
-  end
-end
+module Readapt
+  class Breakpoint
+    attr_reader :source
+    attr_reader :line
+    attr_reader :condition
+    attr_reader :hit_condition
+    attr_writer :hit_cursor
+
+    def initialize source, line, condition, hit_condition
+      @source = source
+      @line = line
+      @condition = condition
+      @hit_condition = hit_condition
+    end
+
+    # @return [Integer]
+    def hit_cursor
+      @hit_cursor ||= 0
+    end
+  end
+end

data/lib/readapt/data_reader.rb

@@ -1,62 +1,62 @@
-module Readapt
-  class DataReader
-    def initialize
-      @in_header = true
-      @content_length = 0
-      @buffer = String.new
-    end
-
-    # Declare a block to be executed for each message received from the
-    # client.
-    #
-    # @yieldparam [Hash] The message received from the client
-    def set_message_handler &block
-      @message_handler = block
-    end
-
-    # Process raw data received from the client. The data will be parsed
-    # into messages based on the JSON-RPC protocol. Each message will be
-    # passed to the block declared via set_message_handler. Incomplete data
-    # will be buffered and subsequent data will be appended to the buffer.
-    #
-    # @param data [String]
-    def receive data
-      data.each_char do |char|
-        @buffer.concat char
-        if @in_header
-          prepare_to_parse_message if @buffer.end_with?("\r\n\r\n")
-        else
-          parse_message_from_buffer if @buffer.bytesize == @content_length
-        end
-      end
-    end
-
-    private
-
-    def prepare_to_parse_message
-      @in_header = false
-      @buffer.each_line do |line|
-        parts = line.split(':').map(&:strip)
-        if parts[0] == 'Content-Length'
-          @content_length = parts[1].to_i
-          break
-        end
-      end
-      @buffer.clear
-    end
-
-    def parse_message_from_buffer
-      begin
-        msg = JSON.parse(@buffer)
-        @message_handler.call msg unless @message_handler.nil?
-      rescue JSON::ParserError => e
-        Solargraph::Logging.logger.warn "Failed to parse request: #{e.message}"
-        Solargraph::Logging.logger.debug "Buffer: #{@buffer}"
-      ensure
-        @buffer.clear
-        @in_header = true
-        @content_length = 0
-      end
-    end
-  end
-end
+module Readapt
+  class DataReader
+    def initialize
+      @in_header = true
+      @content_length = 0
+      @buffer = String.new
+    end
+
+    # Declare a block to be executed for each message received from the
+    # client.
+    #
+    # @yieldparam [Hash] The message received from the client
+    def set_message_handler &block
+      @message_handler = block
+    end
+
+    # Process raw data received from the client. The data will be parsed
+    # into messages based on the JSON-RPC protocol. Each message will be
+    # passed to the block declared via set_message_handler. Incomplete data
+    # will be buffered and subsequent data will be appended to the buffer.
+    #
+    # @param data [String]
+    def receive data
+      data.each_char do |char|
+        @buffer.concat char
+        if @in_header
+          prepare_to_parse_message if @buffer.end_with?("\r\n\r\n")
+        else
+          parse_message_from_buffer if @buffer.bytesize == @content_length
+        end
+      end
+    end
+
+    private
+
+    def prepare_to_parse_message
+      @in_header = false
+      @buffer.each_line do |line|
+        parts = line.split(':').map(&:strip)
+        if parts[0] == 'Content-Length'
+          @content_length = parts[1].to_i
+          break
+        end
+      end
+      @buffer.clear
+    end
+
+    def parse_message_from_buffer
+      begin
+        msg = JSON.parse(@buffer)
+        @message_handler.call msg unless @message_handler.nil?
+      rescue JSON::ParserError => e
+        Solargraph::Logging.logger.warn "Failed to parse request: #{e.message}"
+        Solargraph::Logging.logger.debug "Buffer: #{@buffer}"
+      ensure
+        @buffer.clear
+        @in_header = true
+        @content_length = 0
+      end
+    end
+  end
+end

data/lib/readapt/debugger.rb

@@ -1,220 +1,228 @@
-# frozen_string_literal: true
-
-require 'backport'
-require 'observer'
-require 'set'
-
-module Readapt
-  class Debugger
-    include Observable
-    include Finder
-
-    attr_reader :monitor
-
-    attr_reader :file
-
-    def initialize
-      @stack = []
-      @frames = {}
-      @running = false
-      @attached = false
-      @request = nil
-      @config = {}
-      @original_argv = ARGV.clone
-      @original_prog = $0
-      @breakpoints = {}
-    end
-
-    def config arguments, request
-      @file = Readapt.normalize_path(find(arguments['program']))
-      @config = arguments
-      @request = request
-    rescue LoadError => e
-      STDERR.puts e.message
-    end
-
-    # @return [Readapt::Thread]
-    def thread id
-      Thread.find(id)
-    end
-
-    def threads
-      Thread.all
-    end
-
-    def frame id
-      @frames[id] || Frame::NULL_FRAME
-    end
-
-    def launched?
-      @request == :launch
-    end
-
-    def attached?
-      @request == :attach
-    end
-
-    def start
-      ::Thread.new do
-        set_program_args
-        run { load @file }
-        set_original_args
-      end
-    end
-
-    def run
-      # raise RuntimeError, 'Debugger is already running' if @running
-      @running = true
-      send_event('process', {
-        name: @file
-      })
-      Monitor.start @file do |snapshot|
-        debug snapshot
-      end
-      yield if block_given?
-    rescue StandardError => e
-      STDERR.puts "[#{e.class}] #{e.message}"
-      STDERR.puts e.backtrace.join("\n")
-    ensure
-      Monitor.stop
-      @running = false
-      STDOUT.flush #unless STDOUT.closed?
-      STDERR.flush #unless STDERR.closed?
-      changed
-      send_event 'terminated', nil
-    end
-
-    def output data, category = :console
-      send_event('output', {
-        output: data,
-        category: category
-      })
-    end
-
-    def get_breakpoint source, line
-      @breakpoints["#{source}:#{line}"] || Breakpoint.new(source, line, nil, 0)
-    end
-
-    def set_breakpoint source, line, condition, hitcount
-      @breakpoints["#{source}:#{line}"] = Breakpoint.new(source, line, condition, hitcount)
-    end
-
-    def clear_breakpoints source
-      @breakpoints.delete_if { |_key, value|
-        value.source == source
-      }
-    end
-
-    def disconnect
-      shutdown if launched?
-      @request = nil
-    end
-
-    def self.run &block
-      new.run &block
-    end
-
-    private
-
-    # @param [Snapshot]
-    # return [void]
-    def debug snapshot
-      sleep 0.001 # @todo Trying to let thread data sync
-      References.clear
-      if snapshot.event == :thread_begin || snapshot.event == :entry
-        thr = Thread.find(snapshot.thread_id)
-        thr.control = :continue
-        send_event('thread', {
-          reason: 'started',
-          threadId: snapshot.thread_id
-        }, true)
-        snapshot.control = :continue
-      elsif snapshot.event == :thread_end
-        thr = thread(snapshot.thread_id)
-        thr.control = :continue
-        send_event('thread', {
-          reason: 'exited',
-          threadId: snapshot.thread_id
-        })
-        snapshot.control = :continue
-      else
-        confirmed_pause = true
-        thread = self.thread(snapshot.thread_id)
-        if snapshot.event == :breakpoint
-          bp = get_breakpoint(snapshot.file, snapshot.line)
-          unless bp.condition.nil? || bp.condition.empty?
-            # @type [Binding]
-            bnd = thread.frames.first.frame_binding
-            begin
-              unless bnd.eval(bp.condition)
-                confirmed_pause = false
-              end
-            rescue Exception => e
-              STDERR.puts "Breakpoint condition raised an error"
-              STDERR.puts "#{snapshot.file}:#{snapshot.line} - `#{bp.condition}`"
-              STDERR.puts "[#{e.class}] #{e.message}"
-              confirmed_pause = false
-            end
-          end
-          unless !confirmed_pause || bp.hit_condition.nil? || bp.hit_condition.empty?
-            bp.hit_cursor += 1
-            bnd = thread.frames.first.frame_binding
-            begin
-              hit_count = bnd.eval(bp.hit_condition)
-              if bp.hit_cursor == hit_count
-                bp.hit_cursor = 0
-              else
-                confirmed_pause = false
-              end
-            rescue Exception => e
-              STDERR.puts "Breakpoint condition raised an error"
-              STDERR.puts "#{snapshot.file}:#{snapshot.line} - `#{bp.condition}`"
-              STDERR.puts "[#{e.class}] #{e.message}"
-              confirmed_pause = false
-            end
-          end
-        end
-        if confirmed_pause
-          changed
-          thread.control = :pause
-          thread.frames.each do |frm|
-            @frames[frm.local_id] = frm
-          end
-          send_event('stopped', {
-            reason: snapshot.event,
-            threadId: thread.id
-          })
-          sleep 0.01 until thread.control != :pause || !Thread.include?(thread.id)
-          thread.frames.each do |frm|
-            @frames.delete frm.local_id
-          end
-        else
-          thread.control = :continue
-        end
-        snapshot.control = thread.control
-      end
-    end
-
-    def set_program_args
-      $0 = file
-      ARGV.clear
-      ARGV.replace(@config['programArgs'] || [])
-    end
-
-    def set_original_args
-      $0 = @original_prog
-      ARGV.clear
-      ARGV.replace @original_argv
-    end
-
-    def shutdown
-      exit
-    end
-
-    def send_event event, data, wait = false
-      changed
-      notify_observers event, data
-      sleep 0.01 if wait
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'backport'
+require 'observer'
+require 'set'
+
+module Readapt
+  class Debugger
+    include Observable
+    include Finder
+
+    attr_reader :monitor
+
+    attr_reader :file
+
+    attr_writer :pause_on_raise
+
+    def initialize
+      @stack = []
+      @frames = {}
+      @running = false
+      @attached = false
+      @request = nil
+      @config = {}
+      @original_argv = ARGV.clone
+      @original_prog = $0
+      @breakpoints = {}
+    end
+
+    def config arguments, request
+      @file = Readapt.normalize_path(find(arguments['program']))
+      @config = arguments
+      @request = request
+    rescue LoadError => e
+      STDERR.puts e.message
+    end
+
+    def pause_on_raise?
+      @pause_on_raise ||= false
+    end
+
+    # @return [Readapt::Thread]
+    def thread id
+      Thread.find(id)
+    end
+
+    def threads
+      Thread.all
+    end
+
+    def frame id
+      @frames[id] || Frame::NULL_FRAME
+    end
+
+    def launched?
+      @request == :launch
+    end
+
+    def attached?
+      @request == :attach
+    end
+
+    def start
+      ::Thread.new do
+        set_program_args
+        run { load @file }
+        set_original_args
+      end
+    end
+
+    def run
+      # raise RuntimeError, 'Debugger is already running' if @running
+      @running = true
+      send_event('process', {
+        name: @file
+      })
+      Monitor.start @file do |snapshot|
+        debug snapshot
+      end
+      yield if block_given?
+    rescue StandardError => e
+      STDERR.puts "[#{e.class}] #{e.message}"
+      STDERR.puts e.backtrace.join("\n")
+    ensure
+      Monitor.stop
+      @running = false
+      STDOUT.flush #unless STDOUT.closed?
+      STDERR.flush #unless STDERR.closed?
+      changed
+      send_event 'terminated', nil
+    end
+
+    def output data, category = :console
+      send_event('output', {
+        output: data,
+        category: category
+      })
+    end
+
+    def get_breakpoint source, line
+      @breakpoints["#{source}:#{line}"] || Breakpoint.new(source, line, nil, 0)
+    end
+
+    def set_breakpoint source, line, condition, hitcount
+      @breakpoints["#{source}:#{line}"] = Breakpoint.new(source, line, condition, hitcount)
+    end
+
+    def clear_breakpoints source
+      @breakpoints.delete_if { |_key, value|
+        value.source == source
+      }
+    end
+
+    def disconnect
+      shutdown if launched?
+      @request = nil
+    end
+
+    def self.run &block
+      new.run &block
+    end
+
+    private
+
+    # @param [Snapshot]
+    # return [void]
+    def debug snapshot
+      sleep 0.001 # @todo Trying to let thread data sync
+      References.clear
+      if snapshot.event == :thread_begin || snapshot.event == :entry
+        thr = Thread.find(snapshot.thread_id)
+        thr.control = :continue
+        send_event('thread', {
+          reason: 'started',
+          threadId: snapshot.thread_id
+        }, true)
+        snapshot.control = :continue
+      elsif snapshot.event == :thread_end
+        thr = thread(snapshot.thread_id)
+        thr.control = :continue
+        send_event('thread', {
+          reason: 'exited',
+          threadId: snapshot.thread_id
+        })
+        snapshot.control = :continue
+      else
+        confirmed_pause = true
+        thread = self.thread(snapshot.thread_id)
+        if snapshot.event == :breakpoint
+          bp = get_breakpoint(snapshot.file, snapshot.line)
+          unless bp.condition.nil? || bp.condition.empty?
+            # @type [Binding]
+            bnd = thread.frames.first.frame_binding
+            begin
+              unless bnd.eval(bp.condition)
+                confirmed_pause = false
+              end
+            rescue Exception => e
+              STDERR.puts "Breakpoint condition raised an error"
+              STDERR.puts "#{snapshot.file}:#{snapshot.line} - `#{bp.condition}`"
+              STDERR.puts "[#{e.class}] #{e.message}"
+              confirmed_pause = false
+            end
+          end
+          unless !confirmed_pause || bp.hit_condition.nil? || bp.hit_condition.empty?
+            bp.hit_cursor += 1
+            bnd = thread.frames.first.frame_binding
+            begin
+              hit_count = bnd.eval(bp.hit_condition)
+              if bp.hit_cursor == hit_count
+                bp.hit_cursor = 0
+              else
+                confirmed_pause = false
+              end
+            rescue Exception => e
+              STDERR.puts "Breakpoint condition raised an error"
+              STDERR.puts "#{snapshot.file}:#{snapshot.line} - `#{bp.condition}`"
+              STDERR.puts "[#{e.class}] #{e.message}"
+              confirmed_pause = false
+            end
+          end
+        elsif snapshot.event == :raise && !pause_on_raise?
+          confirmed_pause = false
+        end
+        if confirmed_pause
+          changed
+          thread.control = :pause
+          thread.frames.each do |frm|
+            @frames[frm.local_id] = frm
+          end
+          send_event('stopped', {
+            reason: snapshot.event,
+            threadId: thread.id
+          })
+          sleep 0.01 until thread.control != :pause || !Thread.include?(thread.id)
+          thread.frames.each do |frm|
+            @frames.delete frm.local_id
+          end
+        else
+          thread.control = :continue
+        end
+        snapshot.control = thread.control
+      end
+    end
+
+    def set_program_args
+      $0 = file
+      ARGV.clear
+      ARGV.replace(@config['programArgs'] || [])
+    end
+
+    def set_original_args
+      $0 = @original_prog
+      ARGV.clear
+      ARGV.replace @original_argv
+    end
+
+    def shutdown
+      exit
+    end
+
+    def send_event event, data, wait = false
+      changed
+      notify_observers event, data
+      sleep 0.01 if wait
+    end
+  end
+end