pry-remote-reloaded 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47fa701330dfe9b2c3e6745b87c0430bac660b92902be714ab46954f291e2ecf
-  data.tar.gz: 606e6c99c628770bf0c21990ccf7ca5a76afa4b6a32cc7b843363598af81e7ed
+  metadata.gz: 38f0e97fed566e5ed687b4795bfcdfc283bdb0b735edea3f2b1d3169e2838244
+  data.tar.gz: 3f235f316d76c8909f1ddfadae37466e03d5b24afe1144ee9474b2215a3a917f
 SHA512:
-  metadata.gz: 030a3a24700260d03f35a6a32096d122b3e699b408b21979a4cd7632ce86c159aa9698e02d4b8c4de9d946081835be61ab29f9bbe4a3033143943ef58a598ab6
-  data.tar.gz: 1df4cc61e9cd28392ce74989d201a6ae94c123cc910e59946a7363d67d9921cca21d350ee2ddb952a203eab584cf340511c43a64f2a4e202f0453abb3f99c5e2
+  metadata.gz: d4c3b3cca08b280632864eef241a58010bd53fd1812cd6649f1b506de820eb81025c619a089b4b97e16f1b61ee7fae4d22590bbd26a43b0cee940178b0dc3157
+  data.tar.gz: 5e659b7d3dae7bdc9791dc330f14a4e98696a2947805347d393f3f5ed2481476fb504aa77cd050e515847c19b3f314cf57180417470cd1f04f98b1a2b83a7d9b

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 3.0.0 (2025-08-20)
+
+* Allow configuring server URI instead of host and port (#4)
+  * The CLI still allows to configure server/port, but allows to pass the
+    URI which takes precedence
+  * This is a breaking change for `Object#remote_pry` as its signature is
+    changed to keyword arguments (`uri:, **options`)
+  * The `PryRemoteReloaded::Server.new` and `PryRemoteReloaded::Server.run`
+    signatures also changed to keyword arguments,
+    but thats only for internal use
+
 ## 2.0.0 (205-08-19)
 
 * Upgraded to slop 4.x (#3)

data/lib/pry-remote-reloaded.rb

@@ -7,6 +7,8 @@ require 'open3'
 module PryRemoteReloaded
   DefaultHost = ENV['PRY_REMOTE_DEFAULT_HOST'] || "127.0.0.1"
   DefaultPort = ENV['PRY_REMOTE_DEFAULT_PORT'] || 9876
+  DefaultURI = ENV.fetch('PRY_REMOTE_DEFAULT_URI',
+                         "druby://#{DefaultHost}:#{DefaultPort}")
 
   # A class to represent an input object created from DRb. This is used because
   # Pry checks for arity to know if a prompt should be passed to the object.
@@ -140,13 +142,12 @@ module PryRemoteReloaded
   end
 
   class Server
-    def self.run(object, host = DefaultHost, port = DefaultPort, options = {})
-      new(object, host, port, options).run
+    def self.run(object, uri: DefaultURI, **options)
+      new(object, uri:, **options).run
     end
 
-    def initialize(object, host = DefaultHost, port = DefaultPort, options = {})
-      @host    = host
-      @port    = port
+    def initialize(object, uri: DefaultURI, **options)
+      @uri = uri
 
       @object  = object
       @options = options
@@ -154,7 +155,7 @@ module PryRemoteReloaded
       @client = PryRemoteReloaded::Client.new
       DRb.start_service uri, @client
     rescue Errno::EADDRINUSE => e
-      puts "[pry-remote] Port already in use: #{e.message}"
+      puts "[pry-remote] Address already in use: #{e.message}"
     end
 
     # Code that has to be called for Pry-remote to work properly
@@ -249,16 +250,8 @@ module PryRemoteReloaded
     # @return [PryServer::Client] Client connecting to the pry-remote server
     attr_reader :client
 
-    # @return [String] Host of the server
-    attr_reader :host
-
-    # @return [Integer] Port of the server
-    attr_reader :port
-
     # @return [String] URI for DRb
-    def uri
-      "druby://#{host}:#{port}"
-    end
+    attr_reader :uri
   end
 
   # Parses arguments and allows to start the client.
@@ -272,6 +265,8 @@ module PryRemoteReloaded
                     default: DefaultHost
         conf.int '-p', '--port', "Port of the server (#{DefaultPort})",
                  default: DefaultPort
+        conf.string '-u', '--uri', 'URI of the server, instead of ' \
+                                   "server/port (#{DefaultURI})"
 
         conf.bool '-w', '--wait', 'Wait for the pry server to come up',
                   default: false
@@ -291,8 +286,11 @@ module PryRemoteReloaded
         end
       end
 
-      @host = opts[:server]
-      @port = opts[:port]
+      if opts[:uri]
+        @uri = opts[:uri]
+      else
+        @uri = "druby://#{opts[:server]}:#{opts[:port]}"
+      end
 
       @wait = opts[:wait]
       @persist = opts[:persist]
@@ -304,16 +302,8 @@ module PryRemoteReloaded
       exit 1
     end
 
-    # @return [String] Host of the server
-    attr_reader :host
-
-    # @return [Integer] Port of the server
-    attr_reader :port
-
     # @return [String] URI for DRb
-    def uri
-      "druby://#{host}:#{port}"
-    end
+    attr_reader :uri
 
     attr_reader :wait
     attr_reader :persist
@@ -387,11 +377,10 @@ end
 class Object
   # Starts a remote Pry session
   #
-  # @param [String]  host Host of the server
-  # @param [Integer] port Port of the server
-  # @param [Hash] options Options to be passed to Pry.start
-  def remote_pry(host = PryRemoteReloaded::DefaultHost, port = PryRemoteReloaded::DefaultPort, options = {})
-    PryRemoteReloaded::Server.new(self, host, port, options).run
+  # @param uri [String] URI for DRb server
+  # @param options [Hash{Symbol => Mixed}] options to be passed to Pry.start
+  def remote_pry(uri: PryRemoteReloaded::DefaultURI, **options)
+    PryRemoteReloaded::Server.new(self, uri:, **options).run
   end
 
   # a handy alias as many people may think the method is named after the gem

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-remote-reloaded
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Mon ouie
@@ -73,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="