tcp-client 0.11.2 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4665e444c265a00de59f416c23db910d3ed7a96fc62ba6bf966c4e14b6564a9e
-  data.tar.gz: 04c8e56bd884b61d5f5219233aa6bdfd7d2ce89c0f5892deebe27029e436ec4b
+  metadata.gz: 7d7af455e50934e3a112047a9f8779993e890b44e01f100c78695ed52fdde979
+  data.tar.gz: f144e06f7a7e5be0c2691bfafb536a3709a0a069b6280141b876b4a6b56b118d
 SHA512:
-  metadata.gz: a40b4af0dbe5c65c3a52b0250206ab31442c7efd34df1916293a60299ef87f73d0bb0e3cc0ab4bd5ad4d5a401035fb7f9939f60fc0ef1873a945663387253221
-  data.tar.gz: e4333df6c2ca755f8054bd6bee511835ae20965b1784c613f21545e4fc999f8e8b52da8d5c389528a473b779e1a9b5c87348474599daf47356e7081820da535d
+  metadata.gz: 82f2061ef746877f1152475e836d925181353d3b6f7e4a1592dafb5d6151cd495882da17801b487ccade8c5b46dfe75b63b9d8f9b16d781a22d51cb9e79e8227
+  data.tar.gz: 1b42dc104cd5f9c0d02c98d4f020136658f428ce629347c7065101f55195c8f94e2bbaaf36e08a6adc74989b566f99042849c9fe2320df3a53872d8ef085528b

data/.yardopts

@@ -2,4 +2,4 @@
 --title 'tcp-client Documentation'
 --charset utf-8
 --markup markdown
-'lib/**/*.rb' - 'LICENSE'
+'lib/**/*.rb' - 'README.md' 'LICENSE'

data/README.md

@@ -1,10 +1,10 @@
-# TCPClient
+# TCPClient ![version](https://img.shields.io/gem/v/tcp-client?label=)
 
 Use your TCP connections with working timeout.
 
 - Gem: [rubygems.org](https://rubygems.org/gems/tcp-client)
 - Source: [github.com](https://github.com/mblumtritt/tcp-client)
-- Help: [rubydoc.info](https://rubydoc.info/github/mblumtritt/tcp-client/main/index)
+- Help: [rubydoc.info](https://rubydoc.info/gems/tcp-client/TCPClient)
 
 ## Description
 
@@ -38,13 +38,13 @@ response =
 puts(response)
 ```
 
-For more samples see [the examples dir](https://github.com/mblumtritt/tcp-client/tree/main/examples)
+For more samples see [the examples dir](./examples)
 
 ## Installation
 
-Use [Bundler](http://gembundler.com/) to use TCPClient in your own project:
+Use [Bundler](http://gembundler.com/) to add TCPClient in your own project:
 
-Add to your `Gemfile`:
+Include in your `Gemfile`:
 
 ```ruby
 gem 'tcp-client'

data/lib/tcp-client/address.rb

@@ -111,8 +111,11 @@ class TCPClient
 
     def init_from_string(str)
       @hostname, port = from_string(str.to_s)
-      return init_from_addrinfo(Addrinfo.tcp(nil, port)) unless @hostname
-      @addrinfo = Addrinfo.tcp(@hostname, port)
+      if @hostname
+        @addrinfo = Addrinfo.tcp(@hostname, port)
+      else
+        init_from_addrinfo(Addrinfo.tcp(nil, port)) unless @hostname
+      end
     end
 
     def from_string(str)

data/lib/tcp-client/deadline.rb

@@ -4,15 +4,15 @@ class TCPClient
   class Deadline
     def initialize(timeout)
       timeout = timeout&.to_f
-      @deadline = timeout&.positive? ? now + timeout : 0
+      @deadline = timeout&.positive? ? now + timeout : nil
     end
 
     def valid?
-      @deadline != 0
+      !@deadline.nil?
     end
 
     def remaining_time
-      (@deadline != 0) && (remaining = @deadline - now) > 0 ? remaining : nil
+      @deadline&.-(now)
     end
 
     private

data/lib/tcp-client/mixin/io_with_deadline.rb

@@ -2,10 +2,18 @@
 
 class TCPClient
   module IOWithDeadlineMixin
-    def self.included(mod)
-      methods = mod.instance_methods
-      return if methods.index(:wait_writable) && methods.index(:wait_readable)
-      mod.include(methods.index(:to_io) ? WaitWithIO : WaitWithSelect)
+    class << self
+      private
+
+      def included(mod)
+        return if supports_wait?(mod)
+        mod.include(method_defined?(:to_io) ? WaitWithIO : WaitWithSelect)
+      end
+
+      def supports_wait?(mod)
+        mod.method_defined?(:wait_writable) &&
+          mod.method_defined?(:wait_readable)
+      end
     end
 
     def read_with_deadline(nbytes, deadline, exception)
@@ -37,8 +45,8 @@ class TCPClient
     end
 
     def write_with_deadline(data, deadline, exception)
-      raise(exception) unless deadline.remaining_time
       return 0 if (size = data.bytesize).zero?
+      raise(exception) unless deadline.remaining_time
       result = 0
       loop do
         written =
@@ -62,6 +70,7 @@ class TCPClient
     end
 
     def fetch_slice(size)
+      return ''.b if size.zero?
       result = @read_buffer.byteslice(0, size)
       rest = @read_buffer.bytesize - result.bytesize
       @read_buffer = rest.zero? ? nil : @read_buffer.byteslice(size, rest)
@@ -79,10 +88,10 @@ class TCPClient
         case ret = yield
         when :wait_writable
           remaining_time = deadline.remaining_time or raise(exception)
-          raise(exception) if wait_writable(remaining_time).nil?
+          wait_writable(remaining_time) or raise(exception)
         when :wait_readable
           remaining_time = deadline.remaining_time or raise(exception)
-          raise(exception) if wait_readable(remaining_time).nil?
+          wait_readable(remaining_time) or raise(exception)
         else
           return ret
         end

data/lib/tcp-client/version.rb

@@ -2,5 +2,5 @@
 
 class TCPClient
   # The current version number.
-  VERSION = '0.11.2'
+  VERSION = '0.11.3'
 end

data/lib/tcp-client.rb

@@ -153,7 +153,7 @@ class TCPClient
   #
   # @return [TCPClient] itself
   #
-  # @raise {NoOpenSSLError} if SSL should be used but OpenSSL is not avail
+  # @raise [NoOpenSSLError] if SSL should be used but OpenSSL is not avail
   #
   # @see NetworkError
   #
@@ -225,9 +225,8 @@ class TCPClient
   def readline(separator = $/, chomp: false, timeout: nil, exception: nil)
     raise(NotConnectedError) if closed?
     deadline = create_deadline(timeout, configuration.read_timeout)
-    unless deadline.valid?
+    deadline.valid? or
       return stem_errors { @socket.readline(separator, chomp: chomp) }
-    end
     exception ||= configuration.read_timeout_error
     line =
       stem_errors(exception) do
@@ -328,7 +327,7 @@ class TCPClient
     yield
   rescue *NETWORK_ERRORS => e
     raise unless configuration.normalize_network_errors
-    (except && e.is_a?(except)) ? raise : raise(NetworkError, e)
+    except && e.is_a?(except) ? raise : raise(NetworkError, e)
   end
 
   NETWORK_ERRORS =

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcp-client
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.3
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-30 00:00:00.000000000 Z
+date: 2023-01-15 00:00:00.000000000 Z
 dependencies: []
 description: |
   This gem implements a customizable TCP client class that gives you control
@@ -51,14 +51,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.3
 signing_key:
 specification_version: 4
 summary: Use your TCP connections with working timeout.