cztop 0.14.1 → 1.1.0.pre1

data/lib/cztop/actor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CZTop
   # Represents a CZMQ::FFI::Zactor.
   #
@@ -33,6 +35,7 @@ module CZTop
   #
   # @see http://api.zeromq.org/czmq3-0:zactor
   class Actor
+
     include HasFFIDelegate
     extend CZTop::HasFFIDelegate::ClassMethods
     include ZsockOptions
@@ -40,12 +43,15 @@ module CZTop
     include PolymorphicZsockMethods
     include ::CZMQ::FFI
 
+
     # Raised when trying to interact with a terminated actor.
     class DeadActorError < RuntimeError; end
 
+
     # @return [Exception] the exception that crashed this actor, if any
     attr_reader :exception
 
+
     # Creates a new actor. Either pass a callback directly or a block. The
     # block will be called for every received message.
     #
@@ -60,15 +66,16 @@ module CZTop
     # @yieldparam pipe [Socket::PAIR]
     # @see #process_messages
     def initialize(callback = nil, c_args = nil, &handler)
-      @running = true
-      @mtx = Mutex.new
-      @callback = callback || handler
-      @callback = shim(@callback) unless @callback.is_a? ::FFI::Pointer
-      ffi_delegate = Zactor.new(@callback, c_args)
+      @running         = true
+      @mtx             = Mutex.new
+      @callback        = callback || handler
+      @callback        = shim(@callback) unless @callback.is_a? ::FFI::Pointer
+      ffi_delegate     = Zactor.new(@callback, c_args)
       attach_ffi_delegate(ffi_delegate)
-      options.sndtimeo = 20#ms # see #<<
+      options.sndtimeo = 20 # ms # see #<<
     end
 
+
     # Send a message to the actor.
     # @param message [Object] message to send to the actor, see {Message.coerce}
     # @return [self] so it's chainable
@@ -88,7 +95,8 @@ module CZTop
       else
         begin
           @mtx.synchronize do
-            raise DeadActorError if not @running
+            raise DeadActorError unless @running
+
             message.send_to(self)
           end
         rescue IO::EAGAINWaitWritable
@@ -109,19 +117,23 @@ module CZTop
           retry
         end
       end
+
       self
     end
 
+
     # Receive a message from the actor.
     # @return [Message]
     # @raise [DeadActorError] if actor is terminated
     def receive
       @mtx.synchronize do
-        raise DeadActorError if not @running
+        raise DeadActorError unless @running
+
         super
       end
     end
 
+
     # Same as {#<<}, but also waits for a response from the actor and returns
     # it.
     # @param message [Message] the request to the actor
@@ -129,9 +141,11 @@ module CZTop
     # @raise [ArgumentError] if the message is "$TERM" (use {#terminate})
     def request(message)
       @mtx.synchronize do
-        raise DeadActorError if not @running
+        raise DeadActorError unless @running
+
         message = Message.coerce(message)
-        raise ArgumentError, "use #terminate" if TERM == message[0]
+        raise ArgumentError, 'use #terminate' if TERM == message[0]
+
         message.send_to(self)
         Message.receive_from(self)
       end
@@ -140,6 +154,7 @@ module CZTop
       retry
     end
 
+
     # Sends a message according to a "picture".
     # @see zsock_send() on http://api.zeromq.org/czmq3-0:zsock
     # @note Mainly added for {Beacon}. If implemented there, it wouldn't be
@@ -151,11 +166,13 @@ module CZTop
     # @return [void]
     def send_picture(picture, *args)
       @mtx.synchronize do
-        raise DeadActorError if not @running
+        raise DeadActorError unless @running
+
         Zsock.send(ffi_delegate, picture, *args)
       end
     end
 
+
     # Thread-safe {PolymorphicZsockMethods#wait}.
     # @return [Integer]
     def wait
@@ -164,12 +181,14 @@ module CZTop
       end
     end
 
+
     # Tells the actor to terminate and waits for it. Idempotent.
     # @return [Boolean] whether it died just now (+false+ if it was dead
     #   already)
     def terminate
       @mtx.synchronize do
-        return false if not @running
+        return false unless @running
+
         Message.new(TERM).send_to(self)
         await_handler_death
         true
@@ -179,19 +198,23 @@ module CZTop
       retry
     end
 
+
     # @return [Boolean] whether this actor is dead (terminated or crashed)
     def dead?
       !@running
     end
 
+
     # @return [Boolean] whether this actor has crashed
     # @see #exception
     def crashed?
       !!@exception # if set, it has crashed
     end
 
+
     private
 
+
     # Shims the given handler. The shim is used to do the handshake, to
     # {#process_messages}, and ensure we're notified when the handler has
     # terminated.
@@ -200,35 +223,37 @@ module CZTop
     # @return [FFI::Function] the callback function to be passed to the zactor
     # @raise [ArgumentError] if invalid handler given
     def shim(handler)
-      raise ArgumentError, "invalid handler" if !handler.respond_to?(:call)
+      raise ArgumentError, 'invalid handler' unless handler.respond_to?(:call)
 
-      @handler_thread = nil
+      @handler_thread      = nil
       @handler_dead_signal = Queue.new # used for signaling
 
       Zactor.fn do |pipe_delegate, _args|
-        begin
-          @mtx.synchronize do
-            @handler_thread = Thread.current
-            @pipe = Socket::PAIR.from_ffi_delegate(pipe_delegate)
-            @pipe.signal # handshake, so zactor_new() returns
-          end
-          process_messages(handler)
-        rescue Exception
-          @exception = $!
-        ensure
-          signal_shimmed_handler_death
+        @mtx.synchronize do
+          @handler_thread = Thread.current
+          @pipe           = Socket::PAIR.from_ffi_delegate(pipe_delegate)
+          @pipe.signal # handshake, so zactor_new() returns
         end
+
+        process_messages(handler)
+      rescue Exception
+        @exception = $ERROR_INFO
+      ensure
+        signal_shimmed_handler_death
       end
     end
 
+
     # @return [Boolean] whether the handler is a Ruby object, like a simple
     #   block (as opposed to a FFI::Pointer to a C function)
     def handler_shimmed?
       !!@handler_thread # if it exists, it's shimmed
     end
 
+
     # the command which causes an actor handler to terminate
-    TERM = "$TERM"
+    TERM = '$TERM'
+
 
     # Successively receive messages that were sent to the actor and
     # yield them to the given handler to process them. The a pipe (a
@@ -256,12 +281,14 @@ module CZTop
       end
     end
 
+
     # Receives the next message even across any interrupts.
     # @return [Message] the next message
     def next_message
       @pipe.receive
     end
 
+
     # Creates a new thread that will signal the definitive termination of the
     # Ruby handler.
     #
@@ -286,6 +313,7 @@ module CZTop
       end
     end
 
+
     # Waits for the C or Ruby handler to die.
     # @return [void]
     def await_handler_death
@@ -303,5 +331,6 @@ module CZTop
         @running = false
       end
     end
+
   end
 end

data/lib/cztop/authenticator.rb

@@ -1,16 +1,18 @@
-module CZTop
+# frozen_string_literal: true
 
+module CZTop
   # Authentication for ZeroMQ security mechanisms.
   #
   # This is implemented using an {Actor}.
   #
   # @see http://api.zeromq.org/czmq3-0:zauth
   class Authenticator
+
     include ::CZMQ::FFI
 
     # function pointer to the +zauth()+ function
     ZAUTH_FPTR = ::CZMQ::FFI.ffi_libraries.each do |dl|
-      fptr = dl.find_function("zauth")
+      fptr = dl.find_function('zauth')
       break fptr if fptr
     end
     raise LoadError, "couldn't find zauth()" if ZAUTH_FPTR.nil?
@@ -23,6 +25,7 @@ module CZTop
     def initialize(cert_store = nil)
       if cert_store
         raise ArgumentError unless cert_store.is_a?(CertStore)
+
         cert_store = cert_store.ffi_delegate
         cert_store.__undef_finalizer # native object is now owned by zauth() actor
       end
@@ -38,13 +41,15 @@ module CZTop
       @actor.terminate
     end
 
+
     # Enable verbose logging of commands and activity.
     # @return [void]
     def verbose!
-      @actor << "VERBOSE"
+      @actor << 'VERBOSE'
       @actor.wait
     end
 
+
     # Add a list of IP addresses to the whitelist. For _NULL_, all clients
     # from these addresses will be accepted. For _PLAIN_ and _CURVE_, they
     # will be allowed to continue with authentication.
@@ -52,10 +57,11 @@ module CZTop
     # @param addrs [String] IP address(es) to allow
     # @return [void]
     def allow(*addrs)
-      @actor << ["ALLOW", *addrs]
+      @actor << ['ALLOW', *addrs]
       @actor.wait
     end
 
+
     # Add a list of IP addresses to the blacklist. For all security
     # mechanisms, this rejects the connection without any further
     # authentication. Use either a whitelist, or a blacklist, not not both. If
@@ -65,22 +71,23 @@ module CZTop
     # @param addrs [String] IP address(es) to deny
     # @return [void]
     def deny(*addrs)
-      @actor << ["DENY", *addrs]
+      @actor << ['DENY', *addrs]
       @actor.wait
     end
 
+
     # Configure PLAIN security mechanism using a plain-text password file. The
     # password file will be reloaded automatically if modified externally.
     #
     # @param filename [String] path to the password file
     # @return [void]
     def plain(filename)
-      @actor << ["PLAIN", *filename]
+      @actor << ['PLAIN', *filename]
       @actor.wait
     end
 
     # used to allow any CURVE client
-    ALLOW_ANY = "*"
+    ALLOW_ANY = '*'
 
     # Configure CURVE authentication, using a directory that holds all public
     # client certificates, i.e. their public keys. The certificates must have been
@@ -90,15 +97,17 @@ module CZTop
     # @param directory [String] the directory to take the keys from
     # @return [void]
     def curve(directory = ALLOW_ANY)
-      @actor << ["CURVE", directory]
+      @actor << ['CURVE', directory]
       @actor.wait
     end
 
+
     # Configure GSSAPI authentication.
     # @return [void]
     def gssapi
-      @actor << "GSSAPI"
+      @actor << 'GSSAPI'
       @actor.wait
     end
+
   end
 end

data/lib/cztop/beacon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CZTop
   # Used for LAN discovery and presence.
   #
@@ -5,11 +7,12 @@ module CZTop
   #
   # @see http://api.zeromq.org/czmq3-0:zbeacon
   class Beacon
+
     include ::CZMQ::FFI
 
     # function pointer to the +zbeacon()+ function
     ZBEACON_FPTR = ::CZMQ::FFI.ffi_libraries.each do |dl|
-      fptr = dl.find_function("zbeacon")
+      fptr = dl.find_function('zbeacon')
       break fptr if fptr
     end
     raise LoadError, "couldn't find zbeacon()" if ZBEACON_FPTR.nil?
@@ -28,12 +31,14 @@ module CZTop
       @actor.terminate
     end
 
+
     # Enable verbose logging of commands and activity.
     # @return [void]
     def verbose!
-      @actor << "VERBOSE"
+      @actor << 'VERBOSE'
     end
 
+
     # Run the beacon on the specified UDP port.
     #
     # @param port [Integer] port number to
@@ -43,7 +48,7 @@ module CZTop
     #   interrupted
     # @raise [NotImplementedError] if the system doesn't support UDP broadcasts
     def configure(port)
-      @actor.send_picture("si", :string, "CONFIGURE", :int, port)
+      @actor.send_picture('si', :string, 'CONFIGURE', :int, port)
       ptr = Zstr.recv(@actor)
 
       # NULL if context terminated or interrupted
@@ -64,42 +69,49 @@ module CZTop
     # @raise [ArgumentError] if data is longer than {MAX_BEACON_DATA} bytes
     # @return [void]
     def publish(data, interval)
-      raise ArgumentError, "data too long" if data.bytesize > MAX_BEACON_DATA
-      @actor.send_picture("sbi", :string, "PUBLISH", :string, data,
-                              :int, data.bytesize, :int, interval)
+      raise ArgumentError, 'data too long' if data.bytesize > MAX_BEACON_DATA
+
+      @actor.send_picture('sbi', :string, 'PUBLISH', :string, data,
+                          :int, data.bytesize, :int, interval)
     end
 
+
     # Stop broadcasting the beacon.
     # @return [void]
     def silence
-      @actor << "SILENCE"
+      @actor << 'SILENCE'
     end
 
+
     # Start listening to beacons from peers.
     # @param filter [String] do a prefix match on received beacons
     # @return [void]
     def subscribe(filter)
-      @actor.send_picture("sb", :string, "SUBSCRIBE",
+      @actor.send_picture('sb', :string, 'SUBSCRIBE',
                           :string, filter, :int, filter.bytesize)
     end
 
+
     # Just like {#subscribe}, but subscribe to all peer beacons.
     # @return [void]
     def listen
-      @actor.send_picture("sb", :string, "SUBSCRIBE",
+      @actor.send_picture('sb', :string, 'SUBSCRIBE',
                           :string, nil, :int, 0)
     end
 
+
     # Stop listening to other peers.
     # @return [void]
     def unsubscribe
-      @actor << "UNSUBSCRIBE"
+      @actor << 'UNSUBSCRIBE'
     end
 
+
     # Receive next beacon from a peer.
     # @return [Message] 2-frame message with ([ipaddr, data])
     def receive
       @actor.receive
     end
+
   end
 end

data/lib/cztop/cert_store.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module CZTop
-
   # A store for CURVE security certificates, either backed by files on disk or
   # in-memory.
   #
   # @see http://api.zeromq.org/czmq3-0:zcertstore
   class CertStore
+
     include ::CZMQ::FFI
     include HasFFIDelegate
     extend CZTop::HasFFIDelegate::ClassMethods
@@ -21,6 +23,7 @@ module CZTop
       attach_ffi_delegate(Zcertstore.new(location))
     end
 
+
     # Looks up a certificate in the store by its public key.
     #
     # @param pubkey [String] the public key in question, in Z85 format
@@ -29,9 +32,11 @@ module CZTop
     def lookup(pubkey)
       ptr = ffi_delegate.lookup(pubkey)
       return nil if ptr.null?
+
       Certificate.from_ffi_delegate(ptr)
     end
 
+
     # Inserts a new certificate into the store.
     #
     # @note The same public key must not be inserted more than once.
@@ -43,11 +48,12 @@ module CZTop
       raise ArgumentError unless cert.is_a?(Certificate)
 
       @_inserted_pubkeys ||= Set.new
-      pubkey = cert.public_key
+      pubkey               = cert.public_key
       raise ArgumentError if @_inserted_pubkeys.include? pubkey
 
       ffi_delegate.insert(cert.ffi_delegate)
       @_inserted_pubkeys << pubkey
     end
+
   end
 end