break 0.20.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8847ce453f4b00d664fec2f77e2f553f1a25d95847fad8e44aeb849bcc696dd6
-  data.tar.gz: 3d0f52bba812f6dac645936822721ad60246ad79c379f1475154d9c53c45cbc2
+  metadata.gz: fdf6c48bd31f4c1f5429be6e033e16c6a4b8f00338f4b7e06b0b4dfa667bb8fd
+  data.tar.gz: 251bf10ffd1cf68afcd65563b0217c92fb19993eb97c0a7d27c5b17bdc9aba43
 SHA512:
-  metadata.gz: f52722f40b4ce06b009bfa2a18dd53c547c3e93d4735bd53dcc38318fbcac65449f87a4672f0dbff6f25473a41f2ff5a81e27e99b60872a5ca2b365da49c1f0d
-  data.tar.gz: e3fe4853aa0c51e7d33368b176e101ffaaaa9309dcf3c23577720e71877278636f98476dc974e7b321c75fa62355b4ad303ba1d5cf9c53dc02c3baca5d2cffdf
+  metadata.gz: f3b7249a8df78892931d60a88198b577185bce8937500c0e90d77104489e915b78bfc9650eb961394c478e60c62643adb496f9106557cac2f751a152ef818de5
+  data.tar.gz: 28fad7cbe70a6eb09094761cc776889b9243cb694f04c422d2abe946d8e575ace9dae0edea1635648f6904328423eed103058ae0224340d0fe6ac97f97e9d6b7

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+## 0.40.0 (2022-05-06)
+### Changed
+- Remote integration (`pry-remote`) needs to be manually activated by requiring `break/remote` ([@gsamokovarov][])
+
+## 0.30.0 (2021-06-20)
+### Added
+- Officially Ruby 3.0 support. ([@gsamokovarov][])
+### Fixed
+- Fix broken `next` command for Ruby 2.7+. ([@gsamokovarov][])
+- Fix circular require for `pry` integrations. ([@gsamokovarov][])
+
+## 0.21.0 (2020-08-19)
+### Fixed
+- Fix broken `pry` commands like `ls`. ([@jamesfischer8][])
+
+## 0.20.0 (2020-07-30)
+### Added
+- Support for `pry-remote`. ([@gsamokovarov][])
+### Fixed
+- Fix `up` and `down` commands in `pry`. ([@gsamokovarov][])
+
+## 0.12.0 (2020-07-17)
+### Added
+- Support for `pry` version `0.13` and above. ([@gsamokovarov][])
+### Fixed
+- Fix a crash in multi-threaded environments. ([@gsamokovarov][])
+
+## 0.11.0 (2020-02-08)
+### Changed
+- Requiring `pry` before `break` is no longer a prerequisite for automatic Pry integration. ([@gsamokovarov][])
+
+[@gsamokovarov]: https://github.com/gsamokovarov
+[@jamesfischer8]: https://github.com/jamesfischer8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Genadi Samokovarov
+
+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.

data/README.md

@@ -0,0 +1,93 @@
+# Break
+
+Break is a lightweight debugger for Ruby. It's written in plain Ruby and
+doesn't have its own frontend. Once you put `gem "break"` in your `Gemfile`, it
+integrates seamlessly with IRB or [Pry]. You have navigational commands like
+`next` and `step` straight in your REPL session. You don't need to remember to
+start your debugger or change your development flow. Break embraces your flow,
+instead of forcing you to abide to yet another tool.
+
+## Features
+
+- Control flow executing control.
+- No runtime cost. The tracing instructions kick in only when navigating.
+- Automatic integration with IRB and [Pry].
+- Rails 6 constant auto loading support (not available in other Ruby debuggers).
+
+## Installation
+
+Put `gem "break"` in your `Gemfile`. Then run `bundle install` and
+`binding.irb` (or `binding.pry`) to your heart's desire.
+
+## Commands
+
+The following commands are available in both IRB and [Pry].
+
+Command    | Description
+---------- | -----------
+`next`     | Continue to next line.
+`step`     | Step into method invocation.
+`up`       | Go up the stack.
+`down`     | Go down the stack.
+`whereami` | Show the code surrounding the current debugged line.
+`exit`     | Disconnect the debugger and continue to run the program.
+
+## Usage
+
+Add `break` in your application `Gemfile` and make sure to `require "break"`
+early in your program setup. In a Rails application, `break` will be required
+automatically and you don't need to worry about that.
+
+```ruby
+gem "break"
+```
+
+Break automatically injects its commands into `binding.irb` and `binding.pry`
+(if available).
+
+If you need to debug your program, type a `next` to go to the next line of
+program execution or `step` to step into a method, block, or class/module
+opening call. All of this, in the comfort of IRB or [Pry]. Simple!
+
+## Remote usage
+
+Break can integrate with `pry-remote` for remote process debugging. You have to
+require `break/remote` for Break's integration to kick in.
+
+You can declare `break` in your `Gemfile` with a custom `require` to get the
+remote integration loaded automatically by Bundler:
+
+```ruby
+gem "break", require: "break/remote"
+```
+
+## Why we need a debugger in Ruby?
+
+We had our fair share of abandoned Ruby debuggers written in C. During Ruby 1.8
+and Ruby 1.9 days, the interpreter itself changed often and didn't provide a
+stable API to aid the writing of development tools. This means that
+[ruby-debug], a debugger written for Ruby 1.8 had to be rewritten for 1.9 (as a
+different gem: [ruby-debug-base19]) and then again for Ruby 2.0. At this point
+the development was halted as maintaining 3 different implementations is hard.
+
+If we get better APIs in Ruby-land we won't run into the problems [ruby-debug]
+did. Even better, the debuggers can be thin layers on top of the heavy-lifting
+debugging instrumentation APIs that live in the interpreter themselves. This
+way the interpreter internals can change as much as they want but if they
+provide the same APIs, all of the debugging tools will still work. On top of
+that, our debuggers will work on JRuby, TruffleRuby or whatever alternative
+Ruby implementation is under active development at the time.
+
+Break exists to implement a functional debugger in pure Ruby using the
+[TracePoint API]. It also wants to serve as a catalyst for other Ruby-land
+available APIs that are useful for implementing debugging tools.
+
+Learn more from this [Ruby Russia talk]. ⚡️
+
+[TracePoint API]: https://ruby-doc.org/core-2.6.2/TracePoint.html
+[Pry]: https://github.com/pry/pry
+
+[ruby-debug]: https://github.com/ruby-debug/ruby-debug
+[ruby-debug-base19]: https://github.com/ruby-debug/ruby-debug-base19
+
+[Ruby Russia talk]: https://www.youtube.com/watch?v=3QADeUVwJtA

data/Rakefile

@@ -0,0 +1,11 @@
+require "rake/testtask"
+
+Bundler::GemHelper.install_tasks name: ENV.fetch("GEM_NAME", "break")
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/break/irb/frontend.rb

@@ -10,13 +10,7 @@ module Break::IRB
 
     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
+      @irb = safely_build_irb_instance(session, @workspace)
 
       where
 
@@ -50,5 +44,24 @@ module Break::IRB
 
       irb_context
     end
+
+    # Trying to instantiate an `IRB:Irb` object with a workspace having a
+    # binding coming from `BasicObject`.
+    def safely_build_irb_instance(session, workspace)
+      irb = IRB::Irb.allocate
+      irb.instance_variable_set :@context, IRB::Context.new(irb, workspace, nil)
+      irb.instance_variable_set :@signal_status, :IN_IRB
+      irb.instance_variable_set :@scanner, RubyLex.new
+
+      begin
+        irb.context.main.extend IRB::ExtendCommandBundle
+      rescue NameError, TypeError
+        # Potential `NameError`: undefined method `irb_print_working_workspace' for class `#<Class:#420>'.
+        # Ignore it.
+      end
+
+      irb.context.main.extend Commands.new(session)
+      irb
+    end
   end
 end

data/lib/break/pry/extensions.rb

@@ -4,7 +4,7 @@ module Break::Pry
   module PryExtensions
     attr_accessor :__break_session__
 
-    def initialize(options)
+    def initialize(options = {})
       super(options)
 
       @__break_session__ = options[:__break_session__]
@@ -13,40 +13,3 @@ module Break::Pry
 end
 
 Pry.prepend Break::Pry::PryExtensions
-
-begin
-  require "pry-remote"
-
-  module Break::Pry
-    class << self
-      attr_accessor :current_remote_server
-    end
-
-    module PryRemoteServerExtensions
-      def initialize(*)
-        Break::Pry.current_remote_server&.teardown
-
-        super
-      end
-
-      def run
-        return if Break::Pry.current_remote_server
-        Break::Pry.current_remote_server = self
-
-        setup
-
-        Pry.start @object, @options.merge(input: client.input_proxy, output: client.output)
-      end
-
-      def teardown
-        super
-      ensure
-        Break::Pry.current_remote_server = nil
-      end
-    end
-  end
-
-  PryRemote::Server.prepend Break::Pry::PryRemoteServerExtensions
-rescue LoadError
-  # Do nothing if we cannot require pry-remote.
-end

data/lib/break/pry/remote.rb

@@ -0,0 +1,43 @@
+begin
+  require "pry-remote"
+
+  module Break::Pry
+    class << self
+      attr_accessor :current_remote_server
+    end
+
+    module PryRemoteServerExtensions
+      def initialize(*)
+        Break::Pry.current_remote_server&.teardown
+
+        super
+      end
+
+      def run
+        return if Break::Pry.current_remote_server
+        Break::Pry.current_remote_server = self
+
+        setup
+
+        Pry.start @object, @options.merge(input: client.input_proxy, output: client.output)
+      end
+
+      def teardown
+        super
+      ensure
+        Break::Pry.current_remote_server = nil
+      end
+    end
+  end
+
+  PryRemote::Server.prepend Break::Pry::PryRemoteServerExtensions
+
+  Break::Filter.register_internal binding.method(:remote_pry).source_location.first.chomp('.rb')
+  Break::Filter.register_internal DRb.method(:start_service).source_location.first.chomp('/drb.rb')
+
+  at_exit do
+    Break::Pry.current_remote_server&.teardown
+  end
+rescue LoadError
+  # Do nothing if we cannot require pry-remote.
+end

data/lib/break/pry.rb

@@ -2,7 +2,6 @@
 
 begin
   require "pry"
-  require "break"
 
   require_relative "pry/frontend"
   require_relative "pry/commands"
@@ -20,19 +19,6 @@ begin
   end
 
   Pry.config.commands.import Break::Pry::Commands
-
-  begin
-    require "pry-remote"
-
-    Break::Filter.register_internal binding.method(:remote_pry).source_location.first.chomp('.rb')
-    Break::Filter.register_internal DRb.method(:start_service).source_location.first.chomp('/drb.rb')
-
-    at_exit do
-      Break::Pry.current_remote_server&.teardown
-    end
-  rescue LoadError
-    # Do nothing if we cannot require pry-remote.
-  end
 rescue LoadError
   # Do nothing if we cannot require pry.
 end

data/lib/break/remote.rb

@@ -0,0 +1,2 @@
+require "break"
+require_relative "pry/remote"

data/lib/break/version.rb

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

data/lib/break.rb

@@ -12,3 +12,4 @@ require_relative "break/irb"
 require_relative "break/pry"
 
 Break::Filter.register_internal __dir__
+Break::Filter.register_internal "<internal:"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: break
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.40.0
 platform: ruby
 authors:
 - Genadi Samokovarov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
 - lib/break.rb
 - lib/break/binding_ext.rb
 - lib/break/command.rb
@@ -80,6 +84,8 @@ files:
 - lib/break/pry/commands.rb
 - lib/break/pry/extensions.rb
 - lib/break/pry/frontend.rb
+- lib/break/pry/remote.rb
+- lib/break/remote.rb
 - lib/break/session.rb
 - lib/break/testing.rb
 - lib/break/version.rb
@@ -102,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Lightweight Ruby debugger