pry-shell 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f78367d80e34ffed27c18d3dfea89c22f3efc65fde39b043ac07628d6715b9c
-  data.tar.gz: 5b0e36dfdefe005810de67b5b41dcf4472b8e71744b325a2bdeab9be7bb42c6f
+  metadata.gz: 4b7c98d15684726ac960299f6b91bce6e5baae12c6c72d97c211150647026fce
+  data.tar.gz: 6b39ad64506fdc162e6f19220067aaad25a44e431d8f93533a4ae6a0f1f90b3a
 SHA512:
-  metadata.gz: d7d03a089b432e1e91c0a4210965d8faca9ef584d06d633fda07c8abace3e671962d38bff45b6d328fc3728075591a08c280659a5094714a66acaf42c5e4bd8e
-  data.tar.gz: 392014b4371beace17450468b5d2000ea1fb48419a5af4dc39c6d9ad346ff91ddf4ff38d20b3a259608463dabe4220d61cf181eaa566f78a2d7cbe3f6fe4c93a
+  metadata.gz: d534b80562457c6005d49be9551b59dcc26127d1cdace9426fe17d76aeb45cd4bf1ff784d6cd8d1de3ca90390c699f0835c7f17573f216310840ee6aa5df5313
+  data.tar.gz: 0a82202c3e05b20767d063cb6537b687bf5eafc96a29928e6a51a92a95068a319c3251e5b58d0808639231caa86fbc4c8eb36f13daf8775176816e3ea119c967

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/log/
 
 # rspec failure tracking
 .rspec_status

data/Gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in pry-shell.gemspec
 gemspec
 
+gem "pry-byebug"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pry-shell (0.2.0)
+    pry-shell (0.5.0)
       pry (~> 0.13.0)
       tty-markdown
       tty-prompt
@@ -10,6 +10,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.4.4)
     kramdown (2.3.1)
@@ -23,6 +24,9 @@ GEM
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
@@ -83,6 +87,7 @@ PLATFORMS
   x86_64-darwin-19
 
 DEPENDENCIES
+  pry-byebug
   pry-shell!
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -22,7 +22,7 @@ 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).
 
 ## Development
 

data/bin/console

@@ -11,6 +11,20 @@ require "pry/shell"
 # require "pry"
 # Pry.start
 
-a = 1
+def foo1
+  binding.pry_shell
 
-binding.pry_shell
+  foo2
+end
+
+def foo2
+  foo3
+end
+
+def foo3
+  5
+end
+
+a = 5 + foo1
+
+puts a

data/lib/pry-shell.rb

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

data/lib/pry/shell.rb

@@ -3,6 +3,7 @@
 require_relative "shell/version"
 require_relative "shell/client"
 require_relative "shell/command"
+require_relative "shell/configuration"
 require_relative "shell/logger"
 require_relative "shell/registry"
 require_relative "shell/server"
@@ -15,6 +16,8 @@ require_relative "shell/io/pager"
 require_relative "shell/ui"
 require_relative "shell/ui/base"
 require_relative "shell/ui/about"
+require_relative "shell/ui/configuration"
+require_relative "shell/ui/configuration/auto_connect"
 require_relative "shell/ui/list"
 require_relative "shell/ui/menu"
 require_relative "shell/ui/session"
@@ -25,12 +28,11 @@ class Pry
     DEFAULT_PORT = "1881"
 
     class << self
-      attr_reader :registry
-
-      def run(host:, port:, auto_connect:)
-        @registry = Registry.new(auto_connect)
-
-        new(host, port, registry).run
+      def run
+        run_server
+        draw_ui
+      rescue TTY::Reader::InputInterrupt, Interrupt
+        exit
       end
 
       def active_shell_options(thread: Thread.current)
@@ -40,29 +42,32 @@ class Pry
       def active_shell_options=(value)
         Thread.current[:active_shell_options] = value
       end
-    end
 
-    def initialize(host, port, registry)
-      @host = host
-      @port = port
-      @registry = registry
-    end
+      def clear_shell_options!
+        self.active_shell_options = nil
+      end
 
-    def run
-      run_server
-      draw_ui
-    end
+      def remove_active_connection!
+        active_shell_options&.fetch(:remove_connection)&.call
+      end
 
-    private
+      def configuration
+        @configuration ||= Configuration.new
+      end
 
-    attr_reader :host, :port, :registry
+      def registry
+        @registry ||= Registry.new
+      end
 
-    def run_server
-      Server.new(host, port, registry).run
-    end
+      private
 
-    def draw_ui
-      UI.draw!
+      def run_server
+        Server.run
+      end
+
+      def draw_ui
+        UI.draw!
+      end
     end
   end
 end

data/lib/pry/shell/cli.rb

@@ -10,35 +10,27 @@ class Pry
         def run
           options.parse!
 
-          Shell.run(**config)
+          Shell.run
 
           join_drb_thread
         end
 
         private
 
-        def config
-          @config ||= {
-            host: DEFAULT_HOST,
-            port: DEFAULT_PORT,
-            auto_connect: false
-          }
-        end
-
         def options # rubocop:disable Metrics/MethodLength
           @parser = OptionParser.new do |o|
             o.banner = "Usage: bundle exec pry-shell [options]"
 
             o.on "-h", "--host HOST", "Host name" do |arg|
-              config[:host] = arg
+              Shell.configuration.host = arg
             end
 
             o.on "-p", "--post PORT", "Port of the shell application" do |arg|
-              config[:port] = arg
+              Shell.configuration.port = arg
             end
 
-            o.on "-a", "--auto-connect", "Connect automatically to the first Pry session" do
-              config[: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/client.rb

@@ -9,13 +9,16 @@ class Pry
       # we should make sure the instance lives on the server.
       include DRb::DRbUndumped
 
+      MAX_PROCESS_NAME = 50
+
       attr_reader :id
 
-      def initialize(id, process_name, host, location)
+      def initialize(id, process_name, host, pid, location)
         @id = id
         @process_name = process_name
         @host = host
         @location = location
+        @pid = pid
         @created_at = Time.now
       end
 
@@ -36,7 +39,7 @@ class Pry
       end
 
       def to_s
-        "#{process_name} @#{host} - #{full_location}"
+        "[#{pid}] \"#{humanized_process_name}\" @\"#{host}\" - #{full_location}"
       end
 
       def current?
@@ -45,11 +48,15 @@ class Pry
 
       private
 
-      attr_reader :process_name, :host, :location, :created_at
+      attr_reader :process_name, :host, :pid, :location, :created_at
 
       def full_location
         location.join(":")
       end
+
+      def humanized_process_name
+        process_name.length > MAX_PROCESS_NAME ? "#{process_name[0..50]}..." : process_name
+      end
     end
   end
 end

data/lib/pry/shell/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Pry
+  class Shell
+    class Configuration
+      CONFIG_KEYS = {
+        host: "localhost",
+        port: "1881",
+        auto_connect: true
+      }.freeze
+
+      CONFIG_KEYS.each do |config_key, default_value|
+        attr_writer config_key
+
+        define_method(config_key) do
+          return default_value unless instance_variable_defined?("@#{config_key}")
+
+          instance_variable_get("@#{config_key}")
+        end
+      end
+    end
+  end
+end

data/lib/pry/shell/logger.rb

@@ -7,7 +7,7 @@ require "fileutils"
 class Pry
   class Shell
     class Logger
-      LOG_FOLDER = "tmp"
+      LOG_FOLDER = "log"
 
       class << self
         extend Forwardable

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

@@ -4,8 +4,8 @@ class Pry
   class Shell
     module Patches
       module Object
-        def pry_shell(host: DEFAULT_HOST, port: DEFAULT_PORT)
-          Session.run(self, host: host, port: port)
+        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
     end

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

@@ -1,24 +1,87 @@
 # frozen_string_literal: true
 
-class Pry
-  class Shell
-    module Patches
-      module PryByebug
-        def start_with_pry_byebug(target = nil, options = {})
-          return start_without_pry_byebug(target, options) if Shell.active_shell_options
-
-          super
+begin
+  require "pry-byebug"
+  require "pry-byebug/pry_ext"
+
+  module Byebug
+    class PryShellProcessor < PryProcessor
+      class << self
+        def start
+          Byebug.start
+          Setting[:autolist] = false
+          Context.processor = self
+          Byebug.current_context.step_out(7, true)
+          at_exit { teardown! }
+        end
+
+        private
+
+        def teardown!
+          Pry::Shell.remove_active_connection!
+          Pry::Shell.clear_shell_options!
+        end
+      end
+
+      def resume_pry
+        run do
+          pry_started? ? start_new_pry_repl : start_new_pry_session
         end
+      rescue DRb::DRbConnError
+        puts "DRb connection failed!"
+      end
+
+      private
+
+      def pry_started?
+        defined?(@pry) && @pry
+      end
+
+      def start_new_pry_session
+        @pry = Pry.start_without_pry_byebug(frame._binding, Pry::Shell.active_shell_options)
+      end
+
+      def start_new_pry_repl
+        Pry::Shell::Repl.new(@pry, target: frame._binding).start
       end
     end
   end
-end
 
-begin
-  require "pry-byebug"
-  require "pry-byebug/pry_ext"
+  class Pry
+    class Shell
+      module Patches
+        module PryByebug
+          def start_with_pry_byebug(target = nil, options = {})
+            return start_with_pry_shell(target) if Shell.active_shell_options
+
+            super
+          end
+
+          def start_with_pry_shell(target)
+            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

@@ -7,20 +7,19 @@ class Pry
     class Registry
       include DRb::DRbUndumped
 
-      attr_reader :auto_connect, :clients, :current, :mutex
+      attr_reader :clients, :current, :mutex
 
-      def initialize(auto_connect)
-        @auto_connect = auto_connect
+      def initialize
         @clients = {}
         @mutex = Mutex.new
       end
 
-      def register(id:, name:, host:, location:)
-        Client.new(id, name, host, location).tap do |client|
+      def register(id:, name:, host:, pid:, location:)
+        Client.new(id, name, host, pid, location).tap do |client|
           Logger.debug("New client connected - #{client}")
 
           @clients[id] = client
-          connect_to(client) if auto_connect
+          connect_to(client) if Shell.configuration.auto_connect
         end
       end
 

data/lib/pry/shell/server.rb

@@ -5,24 +5,18 @@ require "drb"
 class Pry
   class Shell
     class Server
-      def initialize(host, port, registry)
-        @host = host
-        @port = port
-        @registry = registry
-      end
-
-      def run
-        Logger.info("Running Drb server on '#{uri}'")
-
-        DRb.start_service(uri, registry)
-      end
+      class << self
+        def run
+          Logger.info("Running Drb server on '#{uri}'")
 
-      private
+          DRb.start_service(uri, Shell.registry)
+        end
 
-      attr_reader :host, :port, :registry
+        private
 
-      def uri
-        "druby://#{host}:#{port}"
+        def uri
+          "druby://#{Shell.configuration.host}:#{Shell.configuration.port}"
+        end
       end
     end
   end

data/lib/pry/shell/session.rb

@@ -13,15 +13,16 @@ class Pry
   class Shell
     class Session
       class << self
-        def run(object, host:, port:)
-          new(object, host, port).run
+        def run(object, host:, port:, with_byebug:)
+          new(object, host, port, with_byebug).run
         end
       end
 
-      def initialize(object, host, port)
+      def initialize(object, host, port, with_byebug)
         @object = object
         @host = host
         @port = port
+        @with_byebug = with_byebug
       end
 
       def run
@@ -31,15 +32,22 @@ class Pry
       rescue DRb::DRbConnError
         puts "DRb connection failed!"
       ensure
-        Shell.active_shell_options = nil
+        # Since we run `Byebug.current_context.step_out` this ensure
+        # block already runs and clears the options which are necessary
+        # to setup the Byebug.
+        # We are clearing this options in `PryShellProcessor` to ensure
+        # they do not leak.
+        Shell.clear_shell_options! unless enable_byebug?
       end
 
       private
 
-      attr_reader :object, :host, :port
+      attr_reader :object, :host, :port, :with_byebug
 
       def pry_options
         {
+          remove_connection: -> { registry.remove(client) },
+          enable_byebug?: enable_byebug?,
           driver: Pry::Shell::Repl,
           pager: false,
           input: client.input,
@@ -49,6 +57,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
@@ -65,7 +79,12 @@ class Pry
       end
 
       def attributes
-        { name: $PROGRAM_NAME, host: Socket.gethostname, location: object.source_location }
+        {
+          name: $PROGRAM_NAME,
+          host: Socket.gethostname,
+          pid: Process.pid,
+          location: object.source_location
+        }
       end
 
       def uri

data/lib/pry/shell/ui.rb

@@ -8,6 +8,7 @@ class Pry
       class << self
         def draw!
           UI::Menu.draw!
+          draw!
         rescue StopMainUI
           sleep
           draw!

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

@@ -9,7 +9,7 @@ class Pry
           pry-shell version "#{VERSION}"
 
           Pry-shell provides you a standalone shell for accessing multiple `pry` sessions running on different processes.
-          You can switch between sessions by using the "\\h" command.
+          You can switch between sessions by going back to the menu using the "\\m" command.
 
           Written by Mehmet Emin INAC.
         MARKDOWN

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

@@ -42,7 +42,7 @@ class Pry
           end
 
           def draw_footer
-            return_menu_prompt
+            prompt.keypress("Press any key to return to the menu...")
           end
 
           def header
@@ -60,12 +60,6 @@ class Pry
           def print_markdown(text)
             puts TTY::Markdown.parse(text)
           end
-
-          def return_menu_prompt
-            prompt.keypress("Press any key to return to the menu...")
-
-            Menu.draw!
-          end
         end
       end
     end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Pry
+  class Shell
+    class UI
+      class Configuration < Base
+        HEADER = "PRY-SHELL Configuration"
+        ITEMS = [
+          { name: "Auto-connect", value: "auto_connect" },
+          { name: "Go back to menu", value: "menu" }
+        ].freeze
+        ACTIONS = {
+          "auto_connect" => -> { AutoConnect.draw! & draw! },
+          "menu" => -> {}
+        }.freeze
+
+        class << self
+          def draw_content
+            selection = prompt.select("Select a configuration item to change it's value", ITEMS)
+
+            ACTIONS[selection].call
+          end
+
+          def draw_footer; end
+        end
+      end
+    end
+  end
+end

data/lib/pry/shell/ui/configuration/auto_connect.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class Pry
+  class Shell
+    class UI
+      class Configuration
+        class AutoConnect < Base
+          class << self
+            def draw!
+              Shell.configuration.auto_connect = show_prompt
+            end
+
+            private
+
+            def show_prompt
+              prompt.select("Accept connections automatically?", cycle: true) do |config|
+                config.default default_value
+
+                config.choice "yes", true
+                config.choice "no", false
+              end
+            end
+
+            def default_value
+              Shell.configuration.auto_connect ? "yes" : "no"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,11 +7,13 @@ class Pry
         HEADER = "PRY-SHELL Main Menu"
         ITEMS = [
           { name: "1) Available sessions", value: "list" },
-          { name: "2) About pry-shell", value: "about" },
-          { name: "3) Quit", value: "quit" }
+          { name: "2) Configuration", value: "configuration" },
+          { name: "3) About pry-shell", value: "about" },
+          { name: "4) Quit", value: "quit" }
         ].freeze
         MENU_ACTIONS = {
           "list" => -> { List.draw! },
+          "configuration" => -> { Configuration.draw! },
           "about" => -> { About.draw! },
           "quit" => -> { clear! && exit(0) }
         }.freeze
@@ -23,6 +25,9 @@ class Pry
             switch_to(selection)
           end
 
+          # Override this to remove "press any key" prompt
+          def draw_footer; end
+
           def switch_to(selected_ui)
             MENU_ACTIONS[selected_ui].call
           end

data/lib/pry/shell/version.rb

@@ -2,6 +2,6 @@
 
 class Pry
   class Shell
-    VERSION = "0.2.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-shell
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mehmet Emin INAC
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -71,10 +71,12 @@ 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
 - lib/pry/shell/command.rb
+- lib/pry/shell/configuration.rb
 - lib/pry/shell/io/base.rb
 - lib/pry/shell/io/editor.rb
 - lib/pry/shell/io/input.rb
@@ -92,6 +94,8 @@ files:
 - lib/pry/shell/ui.rb
 - lib/pry/shell/ui/about.rb
 - lib/pry/shell/ui/base.rb
+- lib/pry/shell/ui/configuration.rb
+- lib/pry/shell/ui/configuration/auto_connect.rb
 - lib/pry/shell/ui/list.rb
 - lib/pry/shell/ui/menu.rb
 - lib/pry/shell/ui/session.rb