readapt 0.3.1

data/lib/readapt/message/variables.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Readapt
+  module Message
+    class Variables < Base
+      def run
+        ref = arguments['variablesReference']
+        frame = debugger.frame(ref)
+        vars = if frame
+          frame.locals
+        elsif ref == TOPLEVEL_BINDING.receiver.object_id
+          global_variables.map do |gv|
+            Variable.new(gv, eval(gv.to_s))
+          end
+        else
+          obj = object_reference
+          result = []
+          if obj.is_a?(Array)
+            obj.each_with_index do |itm, idx|
+              result.push Variable.new("[#{idx}]", itm)
+            end
+          elsif obj.is_a?(Hash)
+            obj.each_pair do |idx, itm|
+              result.push Variable.new("[#{idx}]", itm)
+            end
+          else
+            obj.instance_variables.each do |iv|
+              result.push Variable.new(iv, obj.instance_variable_get(iv))
+            end
+            obj.class.class_variables.each do |cv|
+              result.push Variable.new(cv, obj.class.class_variable_get(cv))
+            end
+          end
+          result
+        end
+        set_body({
+          variables: vars.map do |var|
+            {
+              name: var.name,
+              value: var.value,
+              type: var.type,
+              variablesReference: var.reference
+            }
+          end
+        })
+      end
+
+      private
+
+      def object_reference
+        ObjectSpace._id2ref(arguments['variablesReference'])
+      rescue RangeError
+        nil
+      end
+    end
+  end
+end

data/lib/readapt/monitor.rb

@@ -0,0 +1,31 @@
+module Readapt
+  # The module responsible for stepping through code and providing snapshots.
+  #
+  # @!method self.start &block
+  #   Enable tracepoints. Yield a Snapshot to the provided block for every
+  #   stop (breakpoints, steps, etc.).
+  #   @yieldparam [Snapshot]
+  #   @return [Boolean]
+  #
+  # @!method self.stop
+  #   Disable tracepoints.
+  #   @return [Boolean]
+  module Monitor
+    @@breakpoints = Breakpoints.new
+
+    # @return [Breakpoints]
+    def self.breakpoints
+      @@breakpoints
+    end
+
+    def self.set_breakpoints bps
+      @@breakpoints = bps
+    end
+
+    def self.update
+      know_breakpoints
+    end
+
+    @@breakpoints.add_observer self
+  end
+end

data/lib/readapt/shell.rb

@@ -0,0 +1,48 @@
+require 'thor'
+require 'socket'
+require 'stringio'
+require 'backport'
+
+module Readapt
+  class Shell < Thor
+    map %w[--version -v] => :version
+
+    desc "--version, -v", "Print the version"
+    def version
+      puts Readapt::VERSION
+    end
+
+    desc 'serve', 'Run a DAP server'
+    option :host, type: :string, aliases: :h, description: 'The server host', default: '127.0.0.1'
+    option :port, type: :numeric, aliases: :p, description: 'The server port', default: 1234
+    def serve
+      machine = Backport::Machine.new
+      machine.run do
+        Signal.trap("INT") do
+          Backport.stop
+        end
+        Signal.trap("TERM") do
+          Backport.stop
+        end
+        debugger = Readapt::Debugger.new(machine)
+        ::Thread.new do
+          Readapt::Adapter.host debugger
+          machine.prepare Backport::Server::Tcpip.new(host: options[:host], port: options[:port], adapter: Readapt::Adapter)
+        end
+        STDERR.puts "Readapt Debugger #{Readapt::VERSION} is listening HOST=#{options[:host]} PORT=#{options[:port]}"
+        # Redirect STDOUT and STDERR through the adapter protocol
+        # @todo This feature does not always work with STDERR, e.g, when
+        #   running RSpec
+        cats = ['stdout', 'stderr']
+        [STDOUT, STDERR].each do |io|
+          cat = cats.shift
+          io.instance_eval do
+            define_singleton_method :write do |*args, &block|
+              debugger.output args.join, cat
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/readapt/snapshot.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Readapt
+  # Information about the state of the debugger.
+  #
+  class Snapshot
+    # @return [Integer]
+    attr_reader :thread_id
+
+    # @return [Integer]
+    attr_reader :binding_id
+
+    # @return [String]
+    attr_reader :file
+
+    # @return [Integer]
+    attr_reader :line
+
+    # @return [Symbol]
+    attr_reader :method_name
+
+    # The reason for pausing the debugging, e.g., "breakpoint" or "step"
+    # @return [String, Symbol]
+    attr_reader :event
+
+    # @return [Integer]
+    attr_reader :depth
+
+    # @return [Symbol]
+    attr_accessor :control
+
+    # @param thread_id [Integer]
+    # @param binding_id [Integer]
+    # @param file [String]
+    # @param line [Integer]
+    # @param method_name [Symbol]
+    # @param event [String, Symbol]
+    # @param depth [Integer]
+    def initialize thread_id, binding_id, file, line, method_name, event, depth
+      @thread_id = thread_id
+      @binding_id = binding_id
+      @file = file
+      @line = line
+      @method_name = method_name
+      @event = event
+      @depth = depth
+      @control = :pause
+    end
+  end
+end

data/lib/readapt/thread.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module Readapt
+  class Thread
+    @@next_id = 0
+
+    # @return [Integer]
+    attr_reader :id
+
+    # @return [String]
+    attr_reader :name
+
+    # @return [Symbol]
+    attr_accessor :control
+
+    def initialize id
+      @id = id
+      @@next_id += 1
+      @name = "Thread #{@@next_id}"
+    end
+
+    def frames
+      @frames ||= []
+    end
+
+    class NullThread < Thread
+      def initialize
+        @id = 0
+        @name = 'Null Thread'
+        @frames = [].freeze
+      end
+    end
+    private_constant :NullThread
+
+    NULL_THREAD = NullThread.new
+  end
+end

data/lib/readapt/variable.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Readapt
+  # Data retrieved from variable reference in the debugger.
+  #
+  class Variable
+    # @return [String]
+    attr_reader :name
+
+    # @param name [String, Symbol]
+    # @param object [Object]
+    def initialize name, object
+      @name = name
+      @object = object
+    end
+
+    # @return [Integer]
+    def reference
+      @reference ||= unstructured || object.object_id
+    end
+
+    # @return [String]
+    def value
+      @value ||= if object.nil?
+        'nil'
+      elsif show_class_for_value?
+        "#{empty? ? 'Empty ' : ''}#{object.class}"
+      else
+        object.to_s
+      end
+    end
+
+    # @return [String]
+    def type
+      object.class.to_s
+    end
+
+    private
+
+    UNSTRUCTURED_TYPES = [NilClass, String, TrueClass, FalseClass, Numeric].freeze
+    private_constant :UNSTRUCTURED_TYPES
+
+    # @return [Object]
+    attr_reader :object
+
+    # @return [Integer, nil]
+    def unstructured
+      0 if UNSTRUCTURED_TYPES.any? { |cls| object.is_a?(cls) } || no_references?
+    end
+
+    # @return [Boolean]
+    def show_class_for_value?
+      object.is_a?(Array) || object.is_a?(Hash)
+    end
+
+    def no_references?
+      (object.instance_variables.empty? &&
+        object.class.class_variables.empty?) &&
+        (!enumerable? || object.empty?)
+    end
+
+    def enumerable?
+      object.is_a?(Array) || object.is_a?(Hash)
+    end
+
+    def empty?
+      enumerable? && object.empty?
+    end
+  end
+end

data/lib/readapt/version.rb

@@ -0,0 +1,3 @@
+module Readapt
+  VERSION = "0.3.1"
+end

data/readapt.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "readapt/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "readapt"
+  spec.version       = Readapt::VERSION
+  spec.authors       = ["Fred Snyder"]
+  spec.email         = ["fsnyder@castwide.com"]
+
+  spec.summary       = 'A Ruby debugger for the Debug Adapter Protocol'
+  spec.description   = 'Readapt is a Ruby debugger that natively supports the Debug Adapter Protocol. Features include next/step in/step out, local and global variable data, and individual thread control.'
+  spec.homepage      = "https://castwide.com"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/castwide/readapt"
+  spec.metadata["changelog_uri"] = "https://github.com/castwide/readapt/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions = ['ext/readapt/extconf.rb']
+
+  spec.required_ruby_version = '>= 2.2'
+
+  spec.add_dependency 'backport', '~> 1.1'
+  spec.add_dependency 'thor', '~> 0.20'
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler", "~> 1.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: readapt
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Fred Snyder
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: backport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: Readapt is a Ruby debugger that natively supports the Debug Adapter Protocol.
+  Features include next/step in/step out, local and global variable data, and individual
+  thread control.
+email:
+- fsnyder@castwide.com
+executables:
+- readapt
+extensions:
+- ext/readapt/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/readapt
+- ext/readapt/extconf.rb
+- ext/readapt/monitor.c
+- ext/readapt/monitor.h
+- ext/readapt/readapt.c
+- ext/readapt/threads.c
+- ext/readapt/threads.h
+- lib/readapt.rb
+- lib/readapt/adapter.rb
+- lib/readapt/breakpoint.rb
+- lib/readapt/breakpoints.rb
+- lib/readapt/debugger.rb
+- lib/readapt/finder.rb
+- lib/readapt/frame.rb
+- lib/readapt/location.rb
+- lib/readapt/message.rb
+- lib/readapt/message/attach.rb
+- lib/readapt/message/base.rb
+- lib/readapt/message/configuration_done.rb
+- lib/readapt/message/continue.rb
+- lib/readapt/message/disconnect.rb
+- lib/readapt/message/initialize.rb
+- lib/readapt/message/launch.rb
+- lib/readapt/message/next.rb
+- lib/readapt/message/pause.rb
+- lib/readapt/message/scopes.rb
+- lib/readapt/message/set_breakpoints.rb
+- lib/readapt/message/set_exception_breakpoints.rb
+- lib/readapt/message/stack_trace.rb
+- lib/readapt/message/step_in.rb
+- lib/readapt/message/step_out.rb
+- lib/readapt/message/threads.rb
+- lib/readapt/message/variables.rb
+- lib/readapt/monitor.rb
+- lib/readapt/shell.rb
+- lib/readapt/snapshot.rb
+- lib/readapt/thread.rb
+- lib/readapt/variable.rb
+- lib/readapt/version.rb
+- readapt.gemspec
+homepage: https://castwide.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://castwide.com
+  source_code_uri: https://github.com/castwide/readapt
+  changelog_uri: https://github.com/castwide/readapt/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+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: A Ruby debugger for the Debug Adapter Protocol
+test_files: []