utils 0.80.0 → 0.81.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74d1c4048d40164e89c4edcd2b3bd91516b0bf82d6f8d0b0d68c25b70c21927e
-  data.tar.gz: 290d49a38bd95423c93f0c5df749ada24245731369c9233d11f3de619f5099d6
+  metadata.gz: 6f4a74cb28195b08e8c1105b16b40a4d79189c4e8a5396a1f2df3deba71ed9d4
+  data.tar.gz: 4d01dc2e96f809e5ed338f875f87e90468721b190bb79856aa854830a4b413bf
 SHA512:
-  metadata.gz: 253d562cff1325f5218f89b6d800d6e656eeb3c8c5067a38581271720161c55a181c2fbba3e2ff815219805438af9dea258e59e6b00f12ba8485db172d4abab3
-  data.tar.gz: defe6add59ce6268f5d16f3ccc7f20da40c7436f686dfafd5d66cc2f4ed8aedc1a591e2eb1da69cdcfbaf4693fe19d0ba46e8a5d1e297170fbed8a1fec5d717a
+  metadata.gz: 12e0c3edbef1d6ce684ea79bb80ac0379f5962626d07cc574906df58bd2158225c4732982850c6adefd0dbb4cd7347eff58f7f3422537bb96da57ac5f62ec5bd
+  data.tar.gz: cd3eddebabc474a530dfca7427bda4dffbbf377a09bf8b891d6c8ef51c2fc2aa033c625254ea88854d0b3b8e83207e59097276ccf06840c461c23fd872929995

data/Rakefile

@@ -20,7 +20,7 @@ GemHadar do
   readme      'README.md'
   licenses << 'GPL-2.0'
 
-  dependency 'unix_socks',     '~> 0.2'
+  dependency 'unix_socks',     '~> 0.3'
   dependency 'tins',           '~> 1.51'
   dependency 'term-ansicolor', '~> 1.11'
   dependency 'pstree',         '~> 0.3'

data/bin/probe

@@ -78,7 +78,10 @@ end
 # probe server instance to handle incoming requests and process jobs.
 def start_server
   Thread.abort_on_exception = $DEBUG
-  Utils::ProbeServer.new.start
+  Utils::ProbeServer.new(
+    server_type: $config.probe.server_type,
+    port: $config.probe.tcp_server_port
+  ).start
 end
 
 # The connect_server method establishes a connection to a probe server and
@@ -89,7 +92,10 @@ end
 # It also enqueues jobs for execution on the probe server when specified.
 #
 def connect_server
-  probe_client = ProbeClient.new
+  probe_client = Utils::ProbeClient.new(
+    server_type: $config.probe.server_type,
+    port: $config.probe.tcp_server_port
+  )
   if setting = $opts[?C]
     case setting
     when /\A([^=]+)=([^=]+)\z/

data/lib/utils/config_dir.rb

@@ -31,20 +31,6 @@ module Utils
       @directory_path = derive_directory_path(name, root_path)
     end
 
-    # Memoizes the foobar method's return value and returns the result of the computation.
-    # Initializes a new ConfigDir instance with the specified name and optional
-    # root path or environment variable.
-    #
-    # @param name [ String ] the name of the directory to be used
-    # @param root_path [ String, nil ] the root path to use; if nil, the
-    #                                  default root path is used
-    # @param env_var [ String, nil ] the name of the environment variable to
-    #                                check for the root path
-    def initialize(name, root_path: nil, env_var: nil)
-      root_path ||= env_var_path(env_var)
-      @directory_path = derive_directory_path(name, root_path)
-    end
-
     # Returns the string representation of the configuration directory path.
     #
     # @return [ String ] the path of the configuration directory as a string

data/lib/utils/config_file.rb

@@ -224,6 +224,23 @@ class Utils::ConfigFile
     # @param dirs [ Array<String> ] the array of directory names to include
     config :include_dirs, %w[lib test tests ext spec]
 
+    # The server_type method configures the type of server to be used.
+    #
+    # This method sets up the server type configuration option, which
+    # determines the underlying server implementation to be utilized, this is
+    # either :unix for UNIX domain sockets or :tcp for TCP Sockets.
+    #
+    # @return [ Symbol ] returns the server type configured
+    config :server_type, :unix
+
+    # The tcp_server_port method configures the TCP server port setting.
+    #
+    # This method sets up a configuration option that specifies the port number
+    # to be used for TCP server operations.
+    #
+    # @param value [ Integer ] the TCP server port number to use
+    config :tcp_server_port, 59999
+
     # The include_dirs_argument method constructs a colon-separated string from
     # include directories.
     #

data/lib/utils/probe_server.rb

@@ -2,6 +2,37 @@ require 'unix_socks'
 require 'term/ansicolor'
 
 module Utils
+  # A module that provides server handling functionality for creating and
+  # managing socket servers.
+  #
+  # This module encapsulates the logic for initializing different types of
+  # socket servers based on the specified server type, supporting both TCP and
+  # domain socket configurations. It provides a centralized approach to server
+  # creation and management within the Utils library.
+  module ServerHandling
+    # The create_server method initializes and returns a socket server instance
+    # based on the specified server type.
+    #
+    # This method creates either a TCP socket server or a domain socket server
+    # depending on the server type parameter. It configures the server with the
+    # appropriate parameters including port number for TCP servers or socket
+    # name and runtime directory for domain sockets.
+    #
+    # @param server_type [ Symbol ] the type of socket server to create, either :tcp or another value for domain socket
+    # @param port [ Integer ] the port number to use for TCP socket server creation
+    #
+    # @return [ UnixSocks::TCPSocketServer, UnixSocks::DomainSocketServer ] a
+    #   new socket server instance of the specified type
+    def create_server(server_type, port)
+      case server_type
+      when :tcp
+        UnixSocks::TCPSocketServer.new(port:)
+      else
+        UnixSocks::DomainSocketServer.new(socket_name: 'probe.sock', runtime_dir: Dir.pwd)
+      end
+    end
+  end
+
   # A process job representation for execution within the probe server system.
   #
   # This class encapsulates the information and behavior associated with a
@@ -138,6 +169,8 @@ module Utils
   # to communicate with the server, enabling distributed task execution and
   # configuration management.
   class ProbeClient
+    include ServerHandling
+
     # A proxy class for managing environment variables through a probe server communication channel.
     #
     # This class provides a wrapper around the ENV object that allows setting and retrieving
@@ -194,8 +227,8 @@ module Utils
     #
     # @return [ Utils::ProbeServer ] a new probe server instance configured with
     #         the specified socket name and runtime directory
-    def initialize
-      @server = UnixSocks::Server.new(socket_name: 'probe.sock', runtime_dir: Dir.pwd)
+    def initialize(server_type: :unix, port: 6666)
+      @server = create_server(server_type, port)
     end
 
     # The env method provides access to environment variable management through
@@ -234,6 +267,7 @@ module Utils
   # maintains a queue of jobs, tracks their execution status, and provides an
   # interactive interface for managing the server.
   class ProbeServer
+    include ServerHandling
     include Term::ANSIColor
 
     # The initialize method sets up a new probe server instance.
@@ -245,8 +279,8 @@ module Utils
     #
     # @return [ Utils::ProbeServer ] a new probe server instance configured
     # with the specified socket name and runtime directory
-    def initialize
-      @server         = UnixSocks::Server.new(socket_name: 'probe.sock', runtime_dir: Dir.pwd)
+    def initialize(server_type: :unix, port: 6666)
+      @server         = create_server(server_type, port)
       @history        = [].freeze
       @jobs_queue     = Queue.new
       @current_job_id = 0
@@ -258,7 +292,7 @@ module Utils
     # from the queue and entering a receive loop to handle incoming requests.
     # It also manages interrupt signals to enter interactive mode when needed.
     def start
-      output_message "Starting probe server listening to #{@server.server_socket_path}.", type: :info
+      output_message "Starting probe server listening to #{@server.to_url}", type: :info
       Thread.new do
         loop do
           job = @jobs_queue.pop
@@ -278,7 +312,7 @@ module Utils
           $VERBOSE = old
         end
         @server.remove_socket_path
-        output_message "Quitting interactive mode, but still listening to #{@server.server_socket_path}.", type: :info
+        output_message "Quitting interactive mode, but still listening to #{@server.to_url}", type: :info
         retry
       end
     end

data/lib/utils/version.rb

@@ -1,6 +1,6 @@
 module Utils
   # Utils version
-  VERSION         = '0.80.0'
+  VERSION         = '0.81.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/utils.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: utils 0.80.0 ruby lib
+# stub: utils 0.81.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "utils".freeze
-  s.version = "0.80.0".freeze
+  s.version = "0.81.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -23,9 +23,9 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.10".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.16.2".freeze])
   s.add_development_dependency(%q<test-unit>.freeze, [">= 0".freeze])
-  s.add_runtime_dependency(%q<unix_socks>.freeze, ["~> 0.2".freeze])
+  s.add_runtime_dependency(%q<unix_socks>.freeze, ["~> 0.3".freeze])
   s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.51".freeze])
   s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.11".freeze])
   s.add_runtime_dependency(%q<pstree>.freeze, ["~> 0.3".freeze])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utils
 version: !ruby/object:Gem::Version
-  version: 0.80.0
+  version: 0.81.0
 platform: ruby
 authors:
 - Florian Frank
@@ -13,16 +13,16 @@ dependencies:
   name: gem_hadar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 2.16.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 2.16.2
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: tins
   requirement: !ruby/object:Gem::Requirement