pry-shell 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68f90c4cdfe746f83fe8d18649b1141a901b5ba38d1a200b74556c066dd6fa6f
-  data.tar.gz: a1849f725f15e7f639968d7145c5a48efb72b351118e745b3e804c0b0d37062d
+  metadata.gz: 3c2ada13df84d73e1825a12b3b6f1d48323a1ee26b259d0d621954f992b5bcba
+  data.tar.gz: '07290249ca6c84a110288199d5c467cb01a239066ec6ca219cac2ad6abdcda1e'
 SHA512:
-  metadata.gz: 9e7468ba04ac804e48428f95cf9ac1ffc6301dfef9c28d1b76d83d1e9816b2159f39a512c18a139f1aba8b79ae48929cb7b14d4daf65143e5a87f645e80b1889
-  data.tar.gz: 2f96b7544443dc1f2699d6e6da2e8165243e3d5617bbcc27493fe3d5da9d65c9d86a840f000c3aa2ef277e904aab6b0eba595e11a34f7b5396ad8e712640ccd2
+  metadata.gz: dfd6b5a61516dd27da717291944e550b8e6e15def4cd59ee21bd479f069f059c8d5e57047414fd6d36c51b81c8bcd691b39d8f2dc02fc595121381b6f7ad3349
+  data.tar.gz: 342f64a819c36580b331caf9bc67cc4407bace3531fb173c3d34f4bdfc25dab7a21cd9e8cb9803d91181a1db35652e5e48cabcb4a47c5cf74644ed39f6fbc65e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pry-shell (0.4.0)
+    pry-shell (0.5.1)
       pry (~> 0.13.0)
       tty-markdown
       tty-prompt
@@ -13,7 +13,7 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       rexml
     method_source (1.0.0)
     parallel (1.20.1)
@@ -31,7 +31,7 @@ GEM
     rake (13.0.3)
     regexp_parser (2.1.1)
     rexml (3.2.5)
-    rouge (3.26.0)
+    rouge (3.29.0)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -94,4 +94,4 @@ DEPENDENCIES
   rubocop (~> 1.7)
 
 BUNDLED WITH
-   2.2.16
+   2.3.15

data/README.md

@@ -2,8 +2,6 @@
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pry/shell`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,7 +20,29 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Here's a [video showing how to use pry-shell](https://www.youtube.com/watch?v=Lzs_PL_BySo).
+
+### Start the shell
+
+    $ pry-shell
+
+### Add breakpoints
+
+Include this snippet in the code line you are interested:
+
+```ruby
+binding.pry_shell
+```
+
+PryShell will enable [Byebug](https://github.com/deivid-rodriguez/byebug) by default if the `pry-byebug` gem has already been installed. In case if you want to disable byebug, you can set the `with_byebug` option as false, like so;
+
+```ruby
+binding.pry_shell(with_byebug: false)
+```
+
+### Get access to the Pry session
+
+Start the shell, add a breakpoint and make your program hit the desired code section. Afterwards, choose "Available sessions" from the shell main menu and hit "Enter". Then select your desired pry session and hit "Enter".
 
 ## Development
 

data/bin/console

@@ -12,7 +12,7 @@ require "pry/shell"
 # Pry.start
 
 def foo1
-  binding.pry_shell(with_byebug: true)
+  binding.pry_shell
 
   foo2
 end

data/lib/pry/shell/cli.rb

@@ -29,8 +29,8 @@ class Pry
               Shell.configuration.port = arg
             end
 
-            o.on "-a", "--auto-connect", "Connect automatically to the first Pry session" do
-              Shell.configuration.auto_connect = true
+            o.on "--disable-auto-connect", "Disable auto connect feature" do
+              Shell.configuration.auto_connect = false
             end
 
             o.on "-v", "--version", "Print version and exit" do

data/lib/pry/shell/configuration.rb

@@ -6,7 +6,7 @@ class Pry
       CONFIG_KEYS = {
         host: "localhost",
         port: "1881",
-        auto_connect: false
+        auto_connect: true
       }.freeze
 
       CONFIG_KEYS.each do |config_key, default_value|

data/lib/pry/shell/io/input.rb

@@ -7,11 +7,21 @@ class Pry
     module IO
       class Input < Base
         def readline(prompt)
+          drb_thread
+
           wait_until_current
 
           string = object.readline(prompt, true)
 
           Command.execute(client, string)
+        rescue
+          drb_thread.kill
+
+          nil
+        end
+
+        def drb_thread
+          @drb_thread ||= Thread.current
         end
 
         # Assigns the `completion_proc` given by the

data/lib/pry/shell/patches/object.rb

@@ -4,7 +4,7 @@ class Pry
   class Shell
     module Patches
       module Object
-        def pry_shell(host: DEFAULT_HOST, port: DEFAULT_PORT, with_byebug: false)
+        def pry_shell(host: DEFAULT_HOST, port: DEFAULT_PORT, with_byebug: true)
           Session.run(self, host: host, port: port, with_byebug: with_byebug)
         end
       end

data/lib/pry/shell/patches/pry_byebug.rb

@@ -58,18 +58,30 @@ begin
           end
 
           def start_with_pry_shell(target)
-            if Shell.active_shell_options[:with_byebug]
+            if Shell.active_shell_options[:enable_byebug?]
               ::Byebug::PryShellProcessor.start
             else
               start_without_pry_byebug(target, Shell.active_shell_options)
             end
           end
         end
+
+        module PryProcessor
+          def start
+            super
+
+            # We should step out one more frame as we are
+            # prepending another module to the hierarchy
+            ::Byebug.current_context.step_out(5, true)
+          end
+        end
       end
     end
   end
 
   Pry.singleton_class.prepend(Pry::Shell::Patches::PryByebug)
   Pry.singleton_class.alias_method(:start, :start_with_pry_byebug)
+
+  Byebug::PryProcessor.singleton_class.prepend(Pry::Shell::Patches::PryProcessor)
 rescue LoadError # rubocop:disable Lint/SuppressedException
 end

data/lib/pry/shell/registry.rb

@@ -44,11 +44,12 @@ class Pry
       end
 
       def remove(client)
-        @current = nil
-
         @clients.delete(client.id)
 
-        UI.restart!
+        if client.current?
+          @current = nil
+          UI.restart!
+        end
       end
     end
   end

data/lib/pry/shell/session.rb

@@ -37,7 +37,11 @@ class Pry
         # to setup the Byebug.
         # We are clearing this options in `PryShellProcessor` to ensure
         # they do not leak.
-        Shell.clear_shell_options! unless with_byebug
+        unless enable_byebug?
+          pry_options[:remove_connection].call
+
+          Shell.clear_shell_options!
+        end
       end
 
       private
@@ -47,7 +51,7 @@ class Pry
       def pry_options
         {
           remove_connection: -> { registry.remove(client) },
-          with_byebug: with_byebug,
+          enable_byebug?: enable_byebug?,
           driver: Pry::Shell::Repl,
           pager: false,
           input: client.input,
@@ -57,6 +61,12 @@ class Pry
         }
       end
 
+      # Setting the `with_byebug` option as `true` is not enough as the
+      # `pry-byebug` gem can be missing which we are currently depending on.
+      def enable_byebug?
+        with_byebug && defined?(::Byebug::PryShellProcessor)
+      end
+
       def client
         @client ||= registry.register(id: id, **attributes)
       end

data/lib/pry/shell/ui/menu.rb

@@ -20,6 +20,15 @@ class Pry
 
         class << self
           def draw_content
+            prompt.on(:keypress) do |event|
+              if event.value == "j"
+                prompt.trigger(:keydown)
+              end
+
+              if event.value == "k"
+                prompt.trigger(:keyup)
+              end
+            end
             selection = prompt.select("Select a menu item", ITEMS)
 
             switch_to(selection)

data/lib/pry/shell/version.rb

@@ -2,6 +2,6 @@
 
 class Pry
   class Shell
-    VERSION = "0.4.0"
+    VERSION = "0.5.1"
   end
 end

data/lib/pry-shell.rb

@@ -0,0 +1 @@
+require 'pry/shell'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-shell
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Mehmet Emin INAC
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-16 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -71,6 +71,7 @@ files:
 - bin/console
 - bin/setup
 - exe/pry-shell
+- lib/pry-shell.rb
 - lib/pry/shell.rb
 - lib/pry/shell/cli.rb
 - lib/pry/shell/client.rb
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Provides remote pry sessions.