makit 0.0.172 → 0.0.173

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d33beba3997ecb2f3df901e594a88a7e297b0b9c668142e95f12e467695522f
-  data.tar.gz: 8379dea16c7a518519e8d911d666cf9d79a1adb241a0e8f1693d3bed54969f8a
+  metadata.gz: '08a43e1b5e0220843cd50b9e0bc225a7f735a2aba7d7b4af14588515f78aea51'
+  data.tar.gz: 6e8cee30fb685c771dbb84bc28fe35eb02526d70f66386ecf368567d0dc55743
 SHA512:
-  metadata.gz: f9050bff2fb06f6f5a265ea874354c13711de49b2a764e603d1fc8505248852c3839164b5e778d5f2cdf06852b14cead94e3e29dce1d0b0f49e75c0ac88a170f
-  data.tar.gz: 0072df008c5b88eef16b6ebec531608a3efd9656028ace1caf7ef5c7566e4c4248165af9af2982346e045d55975888b3d1e7a5fa61b72ef5e8041234d7f8f862
+  metadata.gz: 84923a1df4d918af850b09c9ebc110ba6cea43b1e405c173bed5b1252e13ba17cad9c7c79939cc0bb900400a2c54b57d733cc5ba9df83aee6aa28b9dff450613
+  data.tar.gz: e9280746a278890230747f65cbc1266e24d1d3428a5ef5a9adef6891c20174da3a7c207831d1db3a10275d87cf2eddf024875f11d3b7c0e226bfe6376a1c92b5

data/lib/makit/port.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
+require "open3"
+
 # This module provides classes for the Makit gem.
 module Makit
   # This class provide methods for working with ports
   #
   class Port
+    class Error < StandardError; end
+
     def self.is_port_available?(port)
       socket = Socket.new(:INET, :STREAM)
       socket.bind(Socket.sockaddr_in(port, ""))
@@ -28,5 +32,181 @@ module Makit
     def self.get_random_available_port
       get_available_port(get_random_port)
     end
+
+    # Ensures a port is available by killing any process using it, or finding the next available port.
+    #
+    # @param port [Integer] The port to ensure is available
+    # @param force [Boolean] If true (default), retries up to 3 times to kill processes on the port.
+    #   If false, does not kill; finds and returns the next available port starting from +port+.
+    # @return [Integer] The port number (guaranteed to be available)
+    # @raise [Makit::Port::Error] If force is true and the port is still in use after 3 attempts
+    #
+    # @example Force free the port (default)
+    #   Makit::Port.ensure_available(5261)           # => 5261
+    #   Makit::Port.ensure_available(5261, force: true)
+    #
+    # @example Find next available port without killing
+    #   Makit::Port.ensure_available(5261, force: false)  # => 5261 or next free port
+    #
+    def self.ensure_available(port, force: true)
+      raise ArgumentError, "port must be a positive integer" unless port.is_a?(Integer) && port > 0
+
+      return port unless port_in_use?(port)
+
+      if force
+        max_retries = 3
+        retries = 0
+
+        while port_in_use?(port) && retries < max_retries
+          kill_process_on_port(port)
+          sleep(0.5)
+          retries += 1
+        end
+
+        if port_in_use?(port)
+          raise Error, "Port #{port} is still in use after #{max_retries} attempts to free it"
+        end
+
+        return port
+      end
+
+      find_available_port(port)
+    end
+
+    # Ensures a port is free by killing any process using it.
+    #
+    # Examples:
+    #   Makit::Port.ensure_port_free(5261)
+    #   Makit::Port.ensure_port_free(5261, verbose: true)
+    #
+    # Returns true if the port is now free, false if it couldn't be freed.
+    #
+    def self.ensure_port_free(port, verbose: false)
+      raise ArgumentError, "port must be a positive integer" unless port.is_a?(Integer) && port > 0
+
+      return true unless port_in_use?(port)
+
+      puts "Port #{port} is in use. Attempting to free it..." if verbose
+
+      killed = kill_process_on_port(port, verbose: verbose)
+
+      if killed
+        # Wait a moment for the port to be released
+        sleep(1)
+        # Verify port is now free
+        unless port_in_use?(port)
+          puts "Port #{port} is now free." if verbose
+          return true
+        else
+          puts "Warning: Port #{port} is still in use after killing process." if verbose
+          return false
+        end
+      else
+        puts "Warning: Could not kill process on port #{port}." if verbose
+        return false
+      end
+    rescue Error, ArgumentError => e
+      puts "Error freeing port #{port}: #{e.message}" if verbose
+      false
+    end
+
+    # -----------------------
+    # Internals
+    # -----------------------
+
+    def self.port_in_use?(port)
+      if RUBY_PLATFORM =~ /mswin|mingw|cygwin/
+        # Windows: Use netstat
+        stdout, _stderr, status = Open3.capture3("netstat", "-ano")
+        return false unless status.success?
+        stdout.lines.any? { |line| line.include?(":#{port}") && line.include?("LISTENING") }
+      else
+        # Unix/macOS: Use lsof
+        stdout, _stderr, status = Open3.capture3("lsof", "-ti:#{port}")
+        status.success? && !stdout.strip.empty?
+      end
+    rescue Errno::ENOENT
+      # Command not found - assume port is not in use
+      false
+    end
+    private_class_method :port_in_use?
+
+    def self.kill_process_on_port(port, verbose: false)
+      if RUBY_PLATFORM =~ /mswin|mingw|cygwin/
+        # Windows: Use netstat to find PID, then taskkill
+        stdout, _stderr, status = Open3.capture3("netstat", "-ano")
+        return false unless status.success?
+
+        pids = []
+        stdout.lines.each do |line|
+          if line.include?(":#{port}") && line.include?("LISTENING")
+            parts = line.split
+            pid = parts.last
+            pids << pid if pid && pid.match?(/^\d+$/)
+          end
+        end
+
+        killed_any = false
+        pids.uniq.each do |pid|
+          begin
+            stdout, _stderr, status = Open3.capture3("taskkill", "/F", "/PID", pid)
+            if status.success?
+              puts "Killed process #{pid} on port #{port}" if verbose
+              killed_any = true
+            end
+          rescue Errno::ENOENT
+            # taskkill not found
+            return false
+          end
+        end
+
+        killed_any
+      else
+        # Unix/macOS: Use lsof to find PID, then kill
+        stdout, _stderr, status = Open3.capture3("lsof", "-ti:#{port}")
+        return false unless status.success?
+        return true if stdout.strip.empty? # Port is already free
+
+        pids = stdout.strip.split("\n").map(&:strip).reject(&:empty?)
+        return false if pids.empty?
+
+        killed_any = false
+        pids.each do |pid|
+          begin
+            stdout, _stderr, status = Open3.capture3("kill", "-9", pid)
+            if status.success?
+              puts "Killed process #{pid} on port #{port}" if verbose
+              killed_any = true
+            end
+          rescue Errno::ENOENT
+            # kill not found
+            return false
+          end
+        end
+
+        killed_any
+      end
+    rescue Errno::ENOENT
+      # Command not found
+      false
+    end
+    private_class_method :kill_process_on_port
+
+    def self.find_available_port(start_port, max_attempts = 100)
+      port = start_port
+      attempts = 0
+
+      while port_in_use?(port) && attempts < max_attempts
+        port += 1
+        attempts += 1
+      end
+
+      if attempts >= max_attempts
+        raise Error, "Could not find available port starting from #{start_port}"
+      end
+
+      port
+    end
+    private_class_method :find_available_port
   end
 end

data/lib/makit/port_utility.rb

@@ -1,128 +1,17 @@
 # frozen_string_literal: true
 
-require "open3"
+require_relative "port"
 
 module Makit
+  # @deprecated Use {Makit::Port} instead. This module delegates to Makit::Port for backward compatibility.
   module PortUtility
-    class Error < StandardError; end
+    Error = Makit::Port::Error
 
-    # Ensures a port is free by killing any process using it.
-    #
-    # Examples:
-    #   Makit::PortUtility.ensure_port_free(5261)
-    #   Makit::PortUtility.ensure_port_free(5261, verbose: true)
-    #
-    # Returns true if the port is now free, false if it couldn't be freed.
-    #
+    # @see Makit::Port.ensure_port_free
     def self.ensure_port_free(port, verbose: false)
-      raise ArgumentError, "port must be a positive integer" unless port.is_a?(Integer) && port > 0
-
-      return true unless port_in_use?(port)
-
-      puts "Port #{port} is in use. Attempting to free it..." if verbose
-
-      killed = kill_process_on_port(port, verbose: verbose)
-
-      if killed
-        # Wait a moment for the port to be released
-        sleep(1)
-        # Verify port is now free
-        unless port_in_use?(port)
-          puts "Port #{port} is now free." if verbose
-          return true
-        else
-          puts "Warning: Port #{port} is still in use after killing process." if verbose
-          return false
-        end
-      else
-        puts "Warning: Could not kill process on port #{port}." if verbose
-        return false
-      end
-    rescue Error, ArgumentError => e
-      puts "Error freeing port #{port}: #{e.message}" if verbose
-      false
-    end
-
-    # -----------------------
-    # Internals
-    # -----------------------
-
-    def self.port_in_use?(port)
-      if RUBY_PLATFORM =~ /mswin|mingw|cygwin/
-        # Windows: Use netstat
-        stdout, _stderr, status = Open3.capture3("netstat", "-ano")
-        return false unless status.success?
-        stdout.lines.any? { |line| line.include?(":#{port}") && line.include?("LISTENING") }
-      else
-        # Unix/macOS: Use lsof
-        stdout, _stderr, status = Open3.capture3("lsof", "-ti:#{port}")
-        status.success? && !stdout.strip.empty?
-      end
-    rescue Errno::ENOENT
-      # Command not found - assume port is not in use
-      false
-    end
-    private_class_method :port_in_use?
-
-    def self.kill_process_on_port(port, verbose: false)
-      if RUBY_PLATFORM =~ /mswin|mingw|cygwin/
-        # Windows: Use netstat to find PID, then taskkill
-        stdout, _stderr, status = Open3.capture3("netstat", "-ano")
-        return false unless status.success?
-
-        pids = []
-        stdout.lines.each do |line|
-          if line.include?(":#{port}") && line.include?("LISTENING")
-            parts = line.split
-            pid = parts.last
-            pids << pid if pid && pid.match?(/^\d+$/)
-          end
-        end
-
-        killed_any = false
-        pids.uniq.each do |pid|
-          begin
-            stdout, _stderr, status = Open3.capture3("taskkill", "/F", "/PID", pid)
-            if status.success?
-              puts "Killed process #{pid} on port #{port}" if verbose
-              killed_any = true
-            end
-          rescue Errno::ENOENT
-            # taskkill not found
-            return false
-          end
-        end
-
-        killed_any
-      else
-        # Unix/macOS: Use lsof to find PID, then kill
-        stdout, _stderr, status = Open3.capture3("lsof", "-ti:#{port}")
-        return false unless status.success?
-        return true if stdout.strip.empty? # Port is already free
-
-        pids = stdout.strip.split("\n").map(&:strip).reject(&:empty?)
-        return false if pids.empty?
-
-        killed_any = false
-        pids.each do |pid|
-          begin
-            stdout, _stderr, status = Open3.capture3("kill", "-9", pid)
-            if status.success?
-              puts "Killed process #{pid} on port #{port}" if verbose
-              killed_any = true
-            end
-          rescue Errno::ENOENT
-            # kill not found
-            return false
-          end
-        end
-
-        killed_any
-      end
-    rescue Errno::ENOENT
-      # Command not found
-      false
+      warn "[Makit::PortUtility] DEPRECATED: Makit::PortUtility.ensure_port_free is deprecated. " \
+           "Use Makit::Port.ensure_port_free(port, verbose: false) instead."
+      Makit::Port.ensure_port_free(port, verbose: verbose)
     end
-    private_class_method :kill_process_on_port
   end
 end

data/lib/makit/version.rb

@@ -2,7 +2,7 @@
 
 module Makit
   # Static version for now to avoid circular dependency issues
-  #VERSION = "0.0.172"
+  #VERSION = "0.0.173"
 
   # Version management utilities for various file formats
   #

data/lib/makit.rb

@@ -92,6 +92,7 @@ require_relative "makit/protoc"
 require_relative "makit/zip"
 require_relative "makit/gems"
 require_relative "makit/nuget_cache"
+require_relative "makit/port"
 require_relative "makit/port_utility"
 require_relative "makit/zip_utility"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: makit
 version: !ruby/object:Gem::Version
-  version: 0.0.172
+  version: 0.0.173
 platform: ruby
 authors:
 - Lou Parslow