break 0.21.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7f110da48355f896a203303aa3e2222f353d0acbac0306727a3116f07df1b43
-  data.tar.gz: '0917a04acaf202f58066d3d7f80b832c818bf8857b173e08dd09f7602c9ebfef'
+  metadata.gz: 9443110f09e59653a1336608fa1de1d3bc1e1a108a31bb3e6216443d44cc96cb
+  data.tar.gz: a7e3b2f728b0537bb878ee0d0db4d4235906c32806f9d84187e2a6254d91591e
 SHA512:
-  metadata.gz: 5ccfe1ab0272bfc57abc8f8e052a44b3ff56f42ac7b5c0f6addbfde1df0f42026898ae791a8eddc5aa295520286cdac2c874000b582e96269541cc9c938dd947
-  data.tar.gz: a42d6f8f47f17536ea8627160e6415101ff166e9022d83ff5fb5c88b437b50a842131f65012ce733c2f4365636e15061fb320a6e5e487c908b73c6672425cd9f
+  metadata.gz: ad6320a59b310ced431065562f8cd693f40beeca35e729bd15cb8eaae425ae2e8d499f6afa4428ae5cf5f0d14b19f1723dfbc0f783ffe378be3a28574373ce8b
+  data.tar.gz: 7950267f77100f32d0d168e0d773bbd1bc2c461cd76fe3a61d0a3b2cd862fabadeb77ce09d4dbb864b89b2fea55fef99e40633df67ee87140de75466768dacd4

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## Unreleased
+
+## 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,81 @@
+# 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!
+
+## 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.rb

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

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.rb

@@ -2,7 +2,6 @@
 
 begin
   require "pry"
-  require "break"
 
   require_relative "pry/frontend"
   require_relative "pry/commands"

data/lib/break/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: break
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Genadi Samokovarov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2021-06-20 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
@@ -102,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Lightweight Ruby debugger