unix_socks 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0f764d873f571896fc2d79546686a8f722abb42b7ea49faa6dbbf92838d6111
-  data.tar.gz: 6c60782c964da95978b2f241978173cdf458d797bbd6f5273616fe738b8d5bb9
+  metadata.gz: 69a0d625a0a16de2b2c9e7fdf8e9237050153707accde9497cfa5945219a40a4
+  data.tar.gz: 5e45a9d545e4aaba75462c2c63e15a26c2e7ac41fcd1b6eb0b5e6c59ce5292c4
 SHA512:
-  metadata.gz: 19a87b5e4625954c38e72f88f42f667f2e47f9ab8a49f6ebc36ddf80025c6d84da288a55b810312628c4ae9307dd380b2cbea2c8c0c1ce2af0f95f1844bc5c4e
-  data.tar.gz: 06ab0fe90890dbde75b12bb5294b81bfb85b544944dffb0e2a2e536e5a22c61359ce328c053004499cf781931f3433429754b23f684562130d3028de87b7cda9
+  metadata.gz: fee22225f513d715172777d32630bfa822b4f3e8356966504e028e17f0a2025bae7fcdf450d075f66501d9704772bb92c576344a1adc7edb725768a54a5b397a
+  data.tar.gz: '01690791bf91770466c600dff26ed41d8ae92844375e82b5d80e03abbd83c74df06f72b918e8c39832a336639e92a1ba835ccf4ecea3632ff94eb42781f6e06f'

data/CHANGES.md

@@ -1,5 +1,18 @@
 # Changes
 
+## 2025-12-23 v0.2.1
+
+- Updated `receive_in_background` method to validate socket file existence
+  before thread creation and raise `Errno::EEXIST` in the calling thread
+  instead of the background thread
+- Added comprehensive test case for `receive_in_background` to verify proper
+  exception propagation when socket already exists
+- Enhanced documentation for `receive_in_background` method with clearer description and parameter details
+- Improved documentation line wrapping for UnixSocks server methods
+- Added detailed documentation for JSON message parsing and popping functionality
+- Added changelog generation support via `changelog` block in `Rakefile`
+- Updated `gem_hadar` development dependency from version **2.10** to **2.14**
+
 ## 2025-12-20 v0.2.0
 
 - Updated `required_ruby_version` from `~> 3.1` to `>= 3.1` in `Rakefile` and

data/Rakefile

@@ -26,6 +26,10 @@ GemHadar do
     '.rspec', '.github'
   readme      'README.md'
 
+  changelog do
+    filename 'CHANGES.md'
+  end
+
   required_ruby_version  '>= 3.1'
 
   dependency             'json',        '~> 2.0'

data/lib/unix_socks/server.rb

@@ -94,13 +94,21 @@ class UnixSocks::Server
     end
   end
 
-  # The receive_in_background method runs the server socket listener in a
-  # separate thread, allowing it to continue executing without blocking the
-  # main program flow.
+  # Runs the message receiver in a background thread to prevent blocking.
   #
-  # @param force [ Boolean ] Whether to overwrite any existing server socket file.
-  # @yield [ UnixSocks::Message ] The received message.
+  # This method starts a new thread that continuously listens for incoming
+  # messages from connected clients. The server socket is created in the
+  # background, allowing the main execution flow to continue without
+  # waiting for messages.
+  #
+  # @param force [Boolean] Whether to overwrite any existing server socket file
+  # @yield [UnixSocks::Message] The received message
+  #
+  # @return [Thread] The background thread running the receiver
   def receive_in_background(force: false, &block)
+    if !force && socket_path_exist?
+      raise Errno::EEXIST, "Path already exists #{server_socket_path.inspect}"
+    end
     Thread.new do
       receive(force:, &block)
     ensure
@@ -122,10 +130,37 @@ class UnixSocks::Server
 
   private
 
+  # Parses a JSON message from the socket and associates it with the socket
+  # connection
+  #
+  # This method retrieves a line of data from the socket, strips whitespace,
+  # and attempts to parse it as JSON. If successful, it creates a
+  # UnixSocks::Message object with the parsed data and assigns the socket
+  # connection to the message. If parsing fails, it logs a warning and
+  # returns nil.
+  #
+  # @param socket [ Socket ] the socket connection to read from
+  #
+  # @return [ UnixSocks::Message, nil ] the parsed message object or nil if
+  #   parsing fails
   def pop_message(socket)
     parse_json_message(socket.gets, socket)
   end
 
+  # Parses a JSON message from the given data and associates it with the
+  # provided socket connection.
+  #
+  # This method processes the input data by stripping whitespace and attempting
+  # to parse it as JSON. If parsing is successful, it creates a
+  # UnixSocks::Message object with the parsed data and assigns the socket
+  # connection to the message. In case of a JSON parsing error, it
+  # logs a warning and returns nil.
+  #
+  # @param data [ String ] The raw data string to be parsed as JSON.
+  # @param socket [ Socket ] The socket connection associated with the message.
+  #
+  # @return [ UnixSocks::Message, nil ] The parsed message object or nil if
+  #   parsing fails.
   def parse_json_message(data, socket)
     data = data.strip
     data.empty? and return nil

data/lib/unix_socks/version.rb

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

data/spec/unix_socks/server_spec.rb

@@ -127,6 +127,18 @@ describe UnixSocks::Server do
 
       server.receive_in_background(force: true)
     end
+
+    it 'it raises Errno::EEXIST if socket already exists' do
+      expect(Thread).not_to receive(:new).and_yield
+      expect(FileUtils).not_to receive(:rm_f).with(server.server_socket_path)
+      expect(server).to receive(:socket_path_exist?).and_return true
+      expect(server).not_to receive(:at_exit)
+      expect(server).not_to receive(:receive).with(force: false)
+
+      expect {
+        server.receive_in_background(force: false)
+      }.to raise_error(Errno::EEXIST)
+    end
   end
 
   describe '#socket_path_exist?' do

data/unix_socks.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: unix_socks 0.2.0 ruby lib
+# stub: unix_socks 0.2.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "unix_socks".freeze
-  s.version = "0.2.0".freeze
+  s.version = "0.2.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -23,7 +23,7 @@ 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.14".freeze])
   s.add_development_dependency(%q<all_images>.freeze, ["~> 0.4".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.2".freeze])
   s.add_development_dependency(%q<debug>.freeze, [">= 0".freeze])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unix_socks
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement