cztop 1.0.0 → 1.1.0.pre1

data/lib/cztop/zsock_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CZTop
   # This module adds the ability to access options of a {Socket} or an
   # {Actor}.
@@ -9,26 +11,30 @@ module CZTop
   # @see http://api.zeromq.org/czmq3-0:zsock-option
   #
   module ZsockOptions
+
     # Access to the options of this socket.
     # @return [OptionsAccessor] the memoized options accessor
     def options
       @options ||= OptionsAccessor.new(self)
     end
 
+
     # Checks whether there's a message that can be read from the socket
     # without blocking.
     # @return [Boolean] whether the socket is readable
     def readable?
-      (options.events & Poller::ZMQ::POLLIN) > 0
+      (options.events & Poller::ZMQ::POLLIN).positive?
     end
 
+
     # Checks whether at least one message can be written to the socket without
     # blocking.
     # @return [Boolean] whether the socket is writable
     def writable?
-      (options.events & Poller::ZMQ::POLLOUT) > 0
+      (options.events & Poller::ZMQ::POLLOUT).positive?
     end
 
+
     # Useful for registration in an event-loop.
     # @return [Integer]
     # @see OptionsAccessor#fd
@@ -36,8 +42,10 @@ module CZTop
       options.fd
     end
 
+
     # Used to access the options of a {Socket} or {Actor}.
     class OptionsAccessor
+
       # @return [Socket, Actor] whose options this {OptionsAccessor} instance
       #   is accessing
       attr_reader :zocket
@@ -47,18 +55,21 @@ module CZTop
         @zocket = zocket
       end
 
+
       # Fuzzy option getter. This is to make it easier when porting
       # applications from CZMQ libraries to CZTop.
       # @param option_name [Symbol, String] case insensitive option name
       # @raise [NoMethodError] if option name can't be recognized
       def [](option_name)
         # NOTE: beware of predicates, especially #CURVE_server? & friends
-        meth = public_methods.reject { |m| m =~ /=$/ }
-              .find { |m| m =~ /^#{option_name}\??$/i }
+        meth = public_methods.grep_v(/=$/)
+                             .find { |m| m =~ /^#{option_name}\??$/i }
         raise NoMethodError, option_name if meth.nil?
+
         __send__(meth)
       end
 
+
       # Fuzzy option setter. This is to make it easier when porting
       # applications from CZMQ libraries to CZTop.
       # @param option_name [Symbol, String] case insensitive option name
@@ -67,6 +78,7 @@ module CZTop
       def []=(option_name, new_value)
         meth = public_methods.find { |m| m =~ /^#{option_name}=$/i }
         raise NoMethodError, option_name if meth.nil?
+
         __send__(meth, new_value)
       end
 
@@ -75,20 +87,37 @@ module CZTop
       # @!group High Water Marks
 
       # @return [Integer] the send high water mark
-      def sndhwm() Zsock.sndhwm(@zocket) end
+      def sndhwm
+        Zsock.sndhwm(@zocket)
+      end
+
+
       # @param value [Integer] the new send high water mark.
-      def sndhwm=(value) Zsock.set_sndhwm(@zocket, value) end
+      def sndhwm=(value)
+        Zsock.set_sndhwm(@zocket, value)
+      end
+
+
       # @return [Integer] the receive high water mark
-      def rcvhwm() Zsock.rcvhwm(@zocket) end
+      def rcvhwm
+        Zsock.rcvhwm(@zocket)
+      end
+
+
       # @param value [Integer] the new receive high water mark
-      def rcvhwm=(value) Zsock.set_rcvhwm(@zocket, value) end
+      def rcvhwm=(value)
+        Zsock.set_rcvhwm(@zocket, value)
+      end
 
       # @!endgroup
 
       # @!group Security Mechanisms
 
       # @return [Boolean] whether this zocket is a CURVE server
-      def CURVE_server?() Zsock.curve_server(@zocket) > 0 end
+      def CURVE_server?
+        Zsock.curve_server(@zocket).positive?
+      end
+
 
       # Make this zocket a CURVE server.
       # @param bool [Boolean]
@@ -97,6 +126,7 @@ module CZTop
         Zsock.set_curve_server(@zocket, bool ? 1 : 0)
       end
 
+
       # @return [String] Z85 encoded server key set
       # @return [nil] if the current mechanism isn't CURVE or CURVE isn't
       #   supported
@@ -104,13 +134,16 @@ module CZTop
         CURVE_key(:curve_serverkey)
       end
 
+
       # Get one of the CURVE keys.
       # @param key_name [Symbol] something like +:curve_serverkey+
       # @return [String, nil] key, if CURVE is supported and active, or nil
       def CURVE_key(key_name)
         return nil if mechanism != :CURVE
+
         ptr = Zsock.__send__(key_name, @zocket)
         return nil if ptr.null?
+
         ptr.read_string
       end
       private :CURVE_key
@@ -127,7 +160,7 @@ module CZTop
           ptr = ::FFI::MemoryPointer.from_string(key)
           Zsock.set_curve_serverkey_bin(@zocket, ptr)
         else
-          raise ArgumentError, "invalid server key: %p" % key
+          raise ArgumentError, format('invalid server key: %p', key)
         end
       end
 
@@ -137,18 +170,19 @@ module CZTop
         1 => :PLAIN, # ZMQ_PLAIN
         2 => :CURVE, # ZMQ_CURVE
         3 => :GSSAPI # ZMQ_GSSAPI
-      }
+      }.freeze
 
       # @return [Symbol] the current security mechanism in use
       # @note This is automatically set through the use of CURVE certificates,
       #   etc
       def mechanism
-        #int zsock_mechanism (void *self);
+        # int zsock_mechanism (void *self);
         code = Zsock.mechanism(@zocket)
         MECHANISMS[code] or
-          raise "unknown ZMQ security mechanism code: %i" % code
+          raise format('unknown ZMQ security mechanism code: %i', code)
       end
 
+
       # @return [String] Z85 encoded secret key set
       # @return [nil] if the current mechanism isn't CURVE or CURVE isn't
       #   supported
@@ -156,6 +190,7 @@ module CZTop
         CURVE_key(:curve_secretkey)
       end
 
+
       # @return [String] Z85 encoded public key set
       # @return [nil] if the current mechanism isn't CURVE or CURVE isn't
       #   supported
@@ -163,21 +198,29 @@ module CZTop
         CURVE_key(:curve_publickey)
       end
 
+
       # Gets the ZAP domain used for authentication.
       # @see http://rfc.zeromq.org/spec:27
       # @return [String]
       def zap_domain
         Zsock.zap_domain(@zocket).read_string
       end
+
+
       # Sets the ZAP domain used for authentication.
       # @param domain [String] the new ZAP domain
       def zap_domain=(domain)
-        raise ArgumentError, "domain too long" if domain.bytesize > 254
+        raise ArgumentError, 'domain too long' if domain.bytesize > 254
+
         Zsock.set_zap_domain(@zocket, domain)
       end
 
+
       # @return [Boolean] whether this zocket is a PLAIN server
-      def PLAIN_server?() Zsock.plain_server(@zocket) > 0 end
+      def PLAIN_server?
+        Zsock.plain_server(@zocket).positive?
+      end
+
 
       # Make this zocket a PLAIN server.
       # @param bool [Boolean]
@@ -186,23 +229,32 @@ module CZTop
         Zsock.set_plain_server(@zocket, bool ? 1 : 0)
       end
 
+
       # @return [String] username set for PLAIN mechanism
       # @return [nil] if the current mechanism isn't PLAIN
       def PLAIN_username
         return nil if mechanism != :PLAIN
+
         Zsock.plain_username(@zocket).read_string
       end
+
+
       # @param username [String] username for PLAIN mechanism
       # @note You'll have to use a {CZTop::Authenticator}.
       def PLAIN_username=(username)
         Zsock.set_plain_username(@zocket, username)
       end
+
+
       # @return [String] password set for PLAIN mechanism
       # @return [nil] if the current mechanism isn't PLAIN
       def PLAIN_password
         return nil if mechanism != :PLAIN
+
         Zsock.plain_password(@zocket).read_string
       end
+
+
       # @param password [String] password for PLAIN mechanism
       def PLAIN_password=(password)
         Zsock.set_plain_password(@zocket, password)
@@ -214,17 +266,30 @@ module CZTop
 
       # @return [Integer] the timeout when receiving a message
       # @see Message.receive_from
-      def rcvtimeo() Zsock.rcvtimeo(@zocket) end
+      def rcvtimeo
+        Zsock.rcvtimeo(@zocket)
+      end
+
+
       # @param timeout [Integer] new timeout
       # @see Message.receive_from
-      def rcvtimeo=(timeout) Zsock.set_rcvtimeo(@zocket, timeout) end
+      def rcvtimeo=(timeout)
+        Zsock.set_rcvtimeo(@zocket, timeout)
+      end
+
 
       # @return [Integer] the timeout when sending a message
       # @see Message#send_to
-      def sndtimeo() Zsock.sndtimeo(@zocket) end
+      def sndtimeo
+        Zsock.sndtimeo(@zocket)
+      end
+
+
       # @param timeout [Integer] new timeout
       # @see Message#send_to
-      def sndtimeo=(timeout) Zsock.set_sndtimeo(@zocket, timeout) end
+      def sndtimeo=(timeout)
+        Zsock.set_sndtimeo(@zocket, timeout)
+      end
 
       # @!endgroup
 
@@ -235,59 +300,90 @@ module CZTop
         Zsock.set_router_mandatory(@zocket, bool ? 1 : 0)
       end
 
+
       # @return [String] current socket identity
-      def identity() Zsock.identity(@zocket).read_string end
+      def identity
+        Zsock.identity(@zocket).read_string
+      end
+
+
       # @param identity [String] new socket identity
       # @raise [ArgumentError] if identity is invalid
       def identity=(identity)
-        raise ArgumentError, "zero-length identity" if identity.bytesize.zero?
-        raise ArgumentError, "identity too long" if identity.bytesize > 255
-        raise ArgumentError, "invalid identity" if identity.start_with? "\0"
+        raise ArgumentError, 'zero-length identity' if identity.bytesize.zero?
+        raise ArgumentError, 'identity too long' if identity.bytesize > 255
+        raise ArgumentError, 'invalid identity' if identity.start_with? "\0"
+
         Zsock.set_identity(@zocket, identity)
       end
 
+
       # @return [Integer] current value of Type of Service
-      def tos() Zsock.tos(@zocket) end
+      def tos
+        Zsock.tos(@zocket)
+      end
+
+
       # @param new_value [Integer] new value for Type of Service
       def tos=(new_value)
-        raise ArgumentError, "invalid TOS" unless new_value >= 0
+        raise ArgumentError, 'invalid TOS' unless new_value >= 0
+
         Zsock.set_tos(@zocket, new_value)
       end
 
+
       # @return [Integer] current value of Heartbeat IVL
-      def heartbeat_ivl() Zsock.heartbeat_ivl(@zocket) end
+      def heartbeat_ivl
+        Zsock.heartbeat_ivl(@zocket)
+      end
+
+
       # @param new_value [Integer] new value for Heartbeat IVL
       def heartbeat_ivl=(new_value)
-        raise ArgumentError, "invalid IVL" unless new_value >= 0
+        raise ArgumentError, 'invalid IVL' unless new_value >= 0
+
         Zsock.set_heartbeat_ivl(@zocket, new_value)
       end
 
+
       # @return [Integer] current value of Heartbeat TTL, in milliseconds
-      def heartbeat_ttl() Zsock.heartbeat_ttl(@zocket) end
+      def heartbeat_ttl
+        Zsock.heartbeat_ttl(@zocket)
+      end
+
+
       # @param new_value [Integer] new value for Heartbeat TTL, in
       #   milliseconds
       # @note The value will internally be rounded to the nearest decisecond.
       #   So a value of less than 100 will have no effect.
       def heartbeat_ttl=(new_value)
-        unless new_value.is_a? Integer
-          raise ArgumentError, "invalid TTL: #{new_value}"
-        end
-        unless (0..65536).include? new_value
-          raise ArgumentError, "TTL out of range: #{new_value}"
-        end
+        raise ArgumentError, "invalid TTL: #{new_value}" unless new_value.is_a? Integer
+        raise ArgumentError, "TTL out of range: #{new_value}" unless (0..65_536).include? new_value
+
         Zsock.set_heartbeat_ttl(@zocket, new_value)
       end
 
+
       # @return [Integer] current value of Heartbeat Timeout
-      def heartbeat_timeout() Zsock.heartbeat_timeout(@zocket) end
+      def heartbeat_timeout
+        Zsock.heartbeat_timeout(@zocket)
+      end
+
+
       # @param new_value [Integer] new value for Heartbeat Timeout
       def heartbeat_timeout=(new_value)
-        raise ArgumentError, "invalid timeout" unless new_value >= 0
+        raise ArgumentError, 'invalid timeout' unless new_value >= 0
+
         Zsock.set_heartbeat_timeout(@zocket, new_value)
       end
 
+
       # @return [Integer] current value of LINGER
-      def linger() Zsock.linger(@zocket) end
+      def linger
+        Zsock.linger(@zocket)
+      end
+
+
       # This defines the number of milliseconds to wait while
       # closing/disconnecting a socket if there are outstanding messages to
       # send.
@@ -300,11 +396,16 @@ module CZTop
         Zsock.set_linger(@zocket, new_value)
       end
 
+
       # @return [Boolean] current value of ipv6
-      def ipv6?() Zsock.ipv6(@zocket) != 0 end
+      def ipv6?
+        Zsock.ipv6(@zocket) != 0
+      end
+
+
       # Set the IPv6 option for the socket. A value of true means IPv6 is
       # enabled on the socket, while false means the socket will use only
-      # IPv4.  When IPv6 is enabled the socket will connect to, or accept 
+      # IPv4.  When IPv6 is enabled the socket will connect to, or accept
       # connections from, both IPv4 and IPv6 hosts.
       # Default is false.
       # @param new_value [Boolean] new value for ipv6
@@ -312,15 +413,26 @@ module CZTop
         Zsock.set_ipv6(@zocket, new_value ? 1 : 0)
       end
 
+
       # @return [Integer] socket file descriptor
-      def fd() Zsock.fd(@zocket) end
+      def fd
+        Zsock.fd(@zocket)
+      end
+
 
       # @return [Integer] socket events (readable/writable)
       # @see CZTop::Poller::ZMQ::POLLIN and CZTop::Poller::ZMQ::POLLOUT
-      def events() Zsock.events(@zocket) end
+      def events
+        Zsock.events(@zocket)
+      end
+
 
       # @return [Integer] current value of RECONNECT_IVL
-      def reconnect_ivl() Zsock.reconnect_ivl(@zocket) end
+      def reconnect_ivl
+        Zsock.reconnect_ivl(@zocket)
+      end
+
+
       # This defines the number of milliseconds to wait while
       # closing/disconnecting a socket if there are outstanding messages to
       # send.
@@ -333,86 +445,7 @@ module CZTop
         Zsock.set_reconnect_ivl(@zocket, new_value)
       end
 
-# TODO: a reasonable subset of these
-#//  Get socket options
-#int zsock_gssapi_server (void *self);
-#int zsock_gssapi_plaintext (void *self);
-#char * zsock_gssapi_principal (void *self);
-#char * zsock_gssapi_service_principal (void *self);
-#int zsock_immediate (void *self);
-#int zsock_type (void *self);
-#int zsock_affinity (void *self);
-#int zsock_rate (void *self);
-#int zsock_recovery_ivl (void *self);
-#int zsock_sndbuf (void *self);
-#int zsock_rcvbuf (void *self);
-#int zsock_reconnect_ivl_max (void *self);
-#int zsock_backlog (void *self);
-#int zsock_maxmsgsize (void *self);
-#int zsock_multicast_hops (void *self);
-#int zsock_tcp_keepalive (void *self);
-#int zsock_tcp_keepalive_idle (void *self);
-#int zsock_tcp_keepalive_cnt (void *self);
-#int zsock_tcp_keepalive_intvl (void *self);
-#int zsock_rcvmore (void *self);
-#char * zsock_last_endpoint (void *self);
-#attach_function :zsock_connect_timeout, [:pointer], :int, **opts
-#attach_function :zsock_handshake_ivl, [:pointer], :int, **opts
-#attach_function :zsock_invert_matching, [:pointer], :int, **opts
-#attach_function :zsock_multicast_maxtpdu, [:pointer], :int, **opts
-#attach_function :zsock_socks_proxy, [:pointer], :pointer, **opts
-#attach_function :zsock_tcp_maxrt, [:pointer], :int, **opts
-#attach_function :zsock_thread_safe, [:pointer], :int, **opts
-#attach_function :zsock_use_fd, [:pointer], :int, **opts
-#attach_function :zsock_vmci_buffer_max_size, [:pointer], :int, **opts
-#attach_function :zsock_vmci_buffer_min_size, [:pointer], :int, **opts
-#attach_function :zsock_vmci_buffer_size, [:pointer], :int, **opts
-#attach_function :zsock_vmci_connect_timeout, [:pointer], :int, **opts
-#
-#//  Set socket options
-#void zsock_set_router_handover (void *self, int router_handover);
-#void zsock_set_probe_router (void *self, int probe_router);
-#void zsock_set_req_relaxed (void *self, int req_relaxed);
-#void zsock_set_req_correlate (void *self, int req_correlate);
-#void zsock_set_conflate (void *self, int conflate);
-#void zsock_set_gssapi_server (void *self, int gssapi_server);
-#void zsock_set_gssapi_plaintext (void *self, int gssapi_plaintext);
-#void zsock_set_gssapi_principal (void *self, const char * gssapi_principal);
-#void zsock_set_gssapi_service_principal (void *self, const char * gssapi_service_principal);
-#void zsock_set_immediate (void *self, int immediate);
-#void zsock_set_delay_attach_on_connect (void *self, int delay_attach_on_connect);
-#void zsock_set_affinity (void *self, int affinity);
-#void zsock_set_rate (void *self, int rate);
-#void zsock_set_recovery_ivl (void *self, int recovery_ivl);
-#void zsock_set_sndbuf (void *self, int sndbuf);
-#void zsock_set_rcvbuf (void *self, int rcvbuf);
-#void zsock_set_reconnect_ivl_max (void *self, int reconnect_ivl_max);
-#void zsock_set_backlog (void *self, int backlog);
-#void zsock_set_maxmsgsize (void *self, int maxmsgsize);
-#void zsock_set_multicast_hops (void *self, int multicast_hops);
-#void zsock_set_xpub_verbose (void *self, int xpub_verbose);
-#void zsock_set_tcp_keepalive (void *self, int tcp_keepalive);
-#void zsock_set_tcp_keepalive_idle (void *self, int tcp_keepalive_idle);
-#void zsock_set_tcp_keepalive_cnt (void *self, int tcp_keepalive_cnt);
-#void zsock_set_tcp_keepalive_intvl (void *self, int tcp_keepalive_intvl);
-#attach_function :zsock_set_connect_rid, [:pointer, :string], :void, **opts
-#attach_function :zsock_set_connect_rid_bin, [:pointer, :pointer], :void, **opts
-#attach_function :zsock_set_connect_timeout, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_handshake_ivl, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_invert_matching, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_multicast_maxtpdu, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_socks_proxy, [:pointer, :string], :void, **opts
-#attach_function :zsock_set_stream_notify, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_tcp_maxrt, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_use_fd, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_vmci_buffer_max_size, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_vmci_buffer_min_size, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_vmci_buffer_size, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_vmci_connect_timeout, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_xpub_manual, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_xpub_nodrop, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_xpub_verboser, [:pointer, :int], :void, **opts
-#attach_function :zsock_set_xpub_welcome_msg, [:pointer, :string], :void, **opts
     end
+
   end
 end

data/lib/cztop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'czmq-ffi-gen'
 require_relative 'cztop/version'
 
@@ -40,7 +42,6 @@ require_relative 'cztop/z85/padded'
 require_relative 'cztop/z85/pipe'
 require_relative 'cztop/zap'
 
-
 # make Ctrl-C work in case a low-level call hangs
 CZMQ::FFI::Signals.disable_default_handling
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.pre1
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-08 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: czmq-ffi-gen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.1.0.pre1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.1.0.pre1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
 description: 
 email:
 - paddor@gmail.com
@@ -131,10 +145,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/workflows/coverage.yml"
+- ".github/workflows/draft_api.yml"
+- ".github/workflows/stable_api.yml"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
+- ".rubocop.yml"
 - ".yardopts"
 - AUTHORS
 - CHANGES.md
@@ -144,6 +160,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- ci/install-libczmq
+- ci/install-libzmq
 - cztop.gemspec
 - examples/ruby_actor/actor.rb
 - examples/simple_req_rep/rep.rb
@@ -212,14 +230,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.4
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: CZMQ Ruby binding based on the generated low-level FFI bindings of CZMQ

data/.ruby-version

@@ -1 +0,0 @@
-3.0