cztop 0.14.1 → 1.1.0.pre1

data/lib/cztop/frame.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CZTop
   # Represents a CZMQ::FFI::Zframe, a part of a message.
   #
@@ -8,6 +10,7 @@ module CZTop
   #
   # @see http://api.zeromq.org/czmq3-0:zframe
   class Frame
+
     include HasFFIDelegate
     extend CZTop::HasFFIDelegate::ClassMethods
 
@@ -18,8 +21,8 @@ module CZTop
       self.content = content if content
     end
 
-    FLAG_MORE = 1
-    FLAG_REUSE = 2
+    FLAG_MORE     = 1
+    FLAG_REUSE    = 2
     FLAG_DONTWAIT = 4
 
     # Send {Message} to a {Socket}/{Actor}.
@@ -39,14 +42,14 @@ module CZTop
     # @raise [SystemCallError] if there was some error. In that case, the
     #   native counterpart still exists and this {Frame} can be reused.
     def send_to(destination, more: false, reuse: false, dontwait: false)
-      flags = 0
+      flags  = 0
       flags |= FLAG_MORE if more
       flags |= FLAG_REUSE if reuse
       flags |= FLAG_DONTWAIT if dontwait
 
       # remember pointer, in case the zframe_t won't be destroyed
       zframe_ptr = ffi_delegate.to_ptr
-      ret = CZMQ::FFI::Zframe.send(ffi_delegate, destination, flags)
+      ret        = CZMQ::FFI::Zframe.send(ffi_delegate, destination, flags)
 
       if reuse || ret == -1
         # zframe_t hasn't been destroyed yet: avoid memory leak.
@@ -55,14 +58,13 @@ module CZTop
       end
 
       if ret == -1
-        if dontwait && FFI.errno == Errno::EAGAIN::Errno
-          raise IO::EAGAINWaitWritable
-        end
+        raise IO::EAGAINWaitWritable if dontwait && FFI.errno == Errno::EAGAIN::Errno
 
         raise_zmq_err
       end
     end
 
+
     # Receive {Frame} from a {Socket}/{Actor}.
     # @note This is low-level. Consider just receiving a {Message}.
     # @return [Frame]
@@ -70,18 +72,20 @@ module CZTop
       from_ffi_delegate(CZMQ::FFI::Zframe.recv(source))
     end
 
+
     # @note This string is always binary. Use String#force_encoding if needed.
     # @return [String] content as string (encoding = Encoding::BINARY)
     def content
       ffi_delegate.data.read_string(size)
     end
-    alias_method :to_s, :content
+    alias to_s content
 
     # @return [Boolean] if this {Frame} has zero-sized content
     def empty?
       size.zero?
     end
 
+
     # Sets new content of this {Frame}.
     # @param new_content [String]
     # @return [new_content]
@@ -92,12 +96,14 @@ module CZTop
       # NOTE: FFI::MemoryPointer will autorelease
     end
 
+
     # Duplicates a frame.
     # @return [Frame] new frame with same content
     def dup
       from_ffi_delegate(ffi_delegate.dup)
     end
 
+
     # @return [Boolean] if the MORE indicator is set
     # @note This happens when reading a frame from a {Socket} or using
     #   {#more=}.
@@ -105,6 +111,7 @@ module CZTop
       ffi_delegate.more == 1
     end
 
+
     # Sets the MORE indicator.
     # @param indicator [Boolean]
     # @note This is NOT used when sending frame to socket.
@@ -114,6 +121,7 @@ module CZTop
       ffi_delegate.set_more(indicator ? 1 : 0)
     end
 
+
     # Compare to another frame.
     # @param other [Frame]
     # @return [Boolean] if this and the other frame have identical size and
@@ -151,10 +159,12 @@ module CZTop
     def routing_id=(new_routing_id)
       # need to raise manually, as FFI lacks this feature.
       # @see https://github.com/ffi/ffi/issues/473
-      raise RangeError if new_routing_id < 0
+      raise RangeError if new_routing_id.negative?
+
       ffi_delegate.set_routing_id(new_routing_id)
     end
 
+
     # Gets the group (radio/dish pattern).
     # @note This is only set when the frame has been read from
     #   a {CZTop::Socket::DISH} socket.
@@ -163,9 +173,11 @@ module CZTop
     def group
       group = ffi_delegate.group
       return nil if group.nil? || group.empty?
+
       group
     end
 
+
     # Sets a new group (radio/dish pattern).
     # @note This is used when the frame is sent via a {CZTop::Socket::RADIO}
     #   socket.
@@ -174,7 +186,8 @@ module CZTop
     # @return [new_group]
     def group=(new_group)
       rc = ffi_delegate.set_group(new_group)
-      raise_zmq_err("unable to set group to %p" % new_group) if rc == -1
+      raise_zmq_err(format('unable to set group to %p', new_group)) if rc == -1
     end
+
   end
 end

data/lib/cztop/has_ffi_delegate.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'socket' # for SocketError
 
 # This module is used to attach the low-level objects of classes within the
 # CZMQ::FFI namespace (coming from the _czmq-ffi-gen_ gem) as delegates.
 module CZTop::HasFFIDelegate
+
   # @return [CZMQ::FFI::*] the attached delegate
   attr_reader :ffi_delegate
 
@@ -12,6 +15,7 @@ module CZTop::HasFFIDelegate
     @ffi_delegate.to_ptr
   end
 
+
   # Attaches an FFI delegate to the current (probably new) {CZTop} object.
   # @param ffi_delegate an instance of the corresponding class in the
   #   CZMQ::FFI namespace
@@ -27,6 +31,7 @@ module CZTop::HasFFIDelegate
     @ffi_delegate = ffi_delegate
   end
 
+
   # Same as the counterpart in {ClassMethods}, but usable from within an
   # instance.
   # @see CZTop::FFIDelegate::ClassMethods#from_ffi_delegate
@@ -60,8 +65,10 @@ module CZTop::HasFFIDelegate
     end
   end
 
+
   # Some class methods related to FFI delegates.
   module ClassMethods
+
     include Forwardable
 
     # Delegate specified instance method to the registered FFI delegate.
@@ -73,6 +80,7 @@ module CZTop::HasFFIDelegate
       def_delegator(:@ffi_delegate, method)
     end
 
+
     # Allocates a new instance and attaches the FFI delegate to it. This is
     # useful if you already have an FFI delegate and need to attach it to a
     # fresh high-level object.
@@ -84,7 +92,9 @@ module CZTop::HasFFIDelegate
     def from_ffi_delegate(ffi_delegate)
       obj = allocate
       obj.attach_ffi_delegate(ffi_delegate)
-      return obj
+      obj
     end
+
   end
+
 end

data/lib/cztop/message/frames.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CZTop
   class Message
 
@@ -7,14 +9,17 @@ module CZTop
       frames.count
     end
 
+
     # Access to this {Message}'s {Frame}s.
     # @return [FramesAccessor]
     def frames
       FramesAccessor.new(self)
     end
 
+
     # Used to access a {Message}'s {Frame}s.
     class FramesAccessor
+
       include Enumerable
 
       # @param message [Message]
@@ -22,24 +27,29 @@ module CZTop
         @message = message
       end
 
+
       # Returns the last frame of this message.
       # @return [Frame] first frame of Message
       # @return [nil] if there are no frames
       def first
         first = @message.ffi_delegate.first
         return nil if first.null?
+
         Frame.from_ffi_delegate(first)
       end
 
+
       # Returns the last frame of this message.
       # @return [Frame] last {Frame} of {Message}
       # @return [nil] if there are no frames
       def last
         last = @message.ffi_delegate.last
         return nil if last.null?
+
         Frame.from_ffi_delegate(last)
       end
 
+
       # Index access to a frame/frames of this message, just like with an
       # array.
       # @overload [](index)
@@ -56,6 +66,7 @@ module CZTop
         end
       end
 
+
       # Yields all frames for this message to the given block.
       # @note Not thread safe.
       # @yieldparam frame [Frame]
@@ -63,12 +74,15 @@ module CZTop
       def each
         first = first()
         return unless first
+
         yield first
-        while frame = @message.ffi_delegate.next and not frame.null?
+        while (frame = @message.ffi_delegate.next) && !frame.null?
           yield Frame.from_ffi_delegate(frame)
         end
-        return self
+        self
       end
+
     end
+
   end
 end

data/lib/cztop/message.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module CZTop
   # Represents a CZMQ::FFI::Zmsg.
   class Message
+
     include HasFFIDelegate
     extend CZTop::HasFFIDelegate::ClassMethods
     include ::CZMQ::FFI
@@ -12,14 +15,15 @@ module CZTop
     def self.coerce(msg)
       case msg
       when Message
-        return msg
+        msg
       when String, Frame, Array
-        return new(msg)
+        new(msg)
       else
-        raise ArgumentError, "cannot coerce message: %p" % msg
+        raise ArgumentError, format('cannot coerce message: %p', msg)
       end
     end
 
+
     # @param parts [String, Frame, Array<String>, Array<Frame>] initial parts
     #   of the message
     def initialize(parts = nil)
@@ -27,11 +31,13 @@ module CZTop
       Array(parts).each { |part| self << part } if parts
     end
 
+
     # @return [Boolean] if this message is empty or not
     def empty?
       content_size.zero?
     end
 
+
     # Send {Message} to a {Socket} or {Actor}.
     #
     # @note Do NOT use this {Message} anymore afterwards. Its native
@@ -56,12 +62,14 @@ module CZTop
     #
     def send_to(destination)
       rc = Zmsg.send(ffi_delegate, destination)
-      return if rc == 0
+      return if rc.zero?
+
       raise_zmq_err
     rescue Errno::EAGAIN
       raise IO::EAGAINWaitWritable
     end
 
+
     # Receive a {Message} from a {Socket} or {Actor}.
     # @param source [Socket, Actor]
     # @return [Message] the newly received message
@@ -73,11 +81,13 @@ module CZTop
     def self.receive_from(source)
       delegate = Zmsg.recv(source)
       return from_ffi_delegate(delegate) unless delegate.null?
+
       HasFFIDelegate.raise_zmq_err
     rescue Errno::EAGAIN
       raise IO::EAGAINWaitReadable
     end
 
+
     # Append a frame to this message.
     # @param frame [String, Frame] what to append
     # @raise [ArgumentError] if frame has an invalid type
@@ -90,16 +100,17 @@ module CZTop
       when String
         # NOTE: can't use addstr because the data might be binary
         mem = FFI::MemoryPointer.from_string(frame)
-        rc = ffi_delegate.addmem(mem, mem.size - 1) # without NULL byte
+        rc  = ffi_delegate.addmem(mem, mem.size - 1) # without NULL byte
       when Frame
         rc = ffi_delegate.append(frame.ffi_delegate)
       else
-        raise ArgumentError, "invalid frame: %p" % frame
+        raise ArgumentError, format('invalid frame: %p', frame)
       end
-      raise_zmq_err unless rc == 0
+      raise_zmq_err unless rc.zero?
       self
     end
 
+
     # Prepend a frame to this message.
     # @param frame [String, Frame] what to prepend
     # @raise [ArgumentError] if frame has an invalid type
@@ -112,30 +123,34 @@ module CZTop
       when String
         # NOTE: can't use pushstr because the data might be binary
         mem = FFI::MemoryPointer.from_string(frame)
-        rc = ffi_delegate.pushmem(mem, mem.size - 1) # without NULL byte
+        rc  = ffi_delegate.pushmem(mem, mem.size - 1) # without NULL byte
       when Frame
         rc = ffi_delegate.prepend(frame.ffi_delegate)
       else
-        raise ArgumentError, "invalid frame: %p" % frame
+        raise ArgumentError, format('invalid frame: %p', frame)
       end
-      raise_zmq_err unless rc == 0
+      raise_zmq_err unless rc.zero?
     end
 
+
     # Removes first part from message and returns it as a string.
     # @return [String, nil] first part, if any, or nil
     def pop
       # NOTE: can't use popstr because the data might be binary
       ptr = ffi_delegate.pop
       return nil if ptr.null?
+
       Frame.from_ffi_delegate(ptr).to_s
     end
 
+
     # @return [Integer] size of this message in bytes
     # @see size
     def content_size
       ffi_delegate.content_size
     end
 
+
     # Returns all frames as strings in an array. This is useful if for quick
     # inspection of the message.
     # @note It'll read all frames in the message and turn them into Ruby
@@ -143,30 +158,27 @@ module CZTop
     # @return [Array<String>] all frames
     def to_a
       ffi_delegate = ffi_delegate()
-      frame = ffi_delegate.first
+      frame        = ffi_delegate.first
       return [] if frame.null?
 
-      arr = [ frame.data.read_bytes(frame.size) ]
-      while frame = ffi_delegate.next and not frame.null?
+      arr          = [frame.data.read_bytes(frame.size)]
+      while (frame = ffi_delegate.next) && !frame.null?
         arr << frame.data.read_bytes(frame.size)
       end
 
-      return arr
+      arr
     end
 
+
     # Inspects this {Message}.
     # @return [String] shows class, number of frames, content size, and
     #   content (only if it's up to 200 bytes)
     def inspect
-      "#<%s:0x%x frames=%i content_size=%i content=%s>" % [
-        self.class,
-        to_ptr.address,
-        size,
-        content_size,
-        content_size <= 500 ? to_a.inspect : "[...]"
-      ]
+      format('#<%s:0x%x frames=%i content_size=%i content=%s>', self.class, to_ptr.address, size, content_size,
+             content_size <= 500 ? to_a.inspect : '[...]')
     end
 
+
     # Return a frame's content.
     # @return [String] the frame's content, if it exists
     # @return [nil] if frame doesn't exist at given index
@@ -193,8 +205,10 @@ module CZTop
 
       # need to raise manually, as FFI lacks this feature.
       # @see https://github.com/ffi/ffi/issues/473
-      raise RangeError if new_routing_id < 0
+      raise RangeError if new_routing_id.negative?
+
       ffi_delegate.set_routing_id(new_routing_id)
     end
+
   end
 end

data/lib/cztop/metadata.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module CZTop
@@ -13,12 +15,15 @@ module CZTop
   #
   # @see https://rfc.zeromq.org/spec:23/ZMTP
   class Metadata
-    VALUE_MAXLEN = 2**31-1
+
+    VALUE_MAXLEN = (2**31) - 1
+
 
     # Raised when decoding malformed metadata.
     class InvalidData < StandardError
     end
 
+
     # regular expression used to validate property names
     NAME_REGEX = /\A[[:alnum:]_.+-]{1,255}\Z/.freeze
 
@@ -29,47 +34,49 @@ module CZTop
     # @return [String]
     def self.dump(metadata)
       ic_names = Set.new
+
       metadata.map do |k, v|
         ic_name = k.to_sym.downcase
-        if ic_names.include?(ic_name)
-          raise ArgumentError, "property #{k.inspect}: duplicate name"
-        else
-          ic_names << ic_name
-        end
+        raise ArgumentError, "property #{k.inspect}: duplicate name" if ic_names.include? ic_name
+
+        ic_names << ic_name
+
         name = k.to_s
-        if NAME_REGEX !~ name
-          raise ArgumentError, "property #{k.inspect}: invalid name"
-        end
+        raise ArgumentError, "property #{k.inspect}: invalid name" if NAME_REGEX !~ name
+
         value = v.to_s
-        if value.bytesize > VALUE_MAXLEN
-          raise ArgumentError, "property #{k.inspect}: value too long"
-        end
-        [name.size, name, value.bytesize, value].pack("CA*NA*")
+        raise ArgumentError, "property #{k.inspect}: value too long" if value.bytesize > VALUE_MAXLEN
+
+        [name.size, name, value.bytesize, value].pack('CA*NA*')
       end.join
     end
 
+
     # @param data [String, Frame, #to_s] the data representing the metadata
     # @return [Hash]
     def self.load(data)
       properties = {}
-      consumed = 0
+      consumed   = 0
+
       while consumed < data.bytesize # while there are bytes to read
         # read property name
-        name_length = data.byteslice(consumed).unpack("C").first # never nil
-        raise InvalidData, "zero-length property name" if name_length.zero?
+        name_length = data.byteslice(consumed).unpack1('C') # never nil
+        raise InvalidData, 'zero-length property name' if name_length.zero?
+
         name = data.byteslice(consumed + 1, name_length)
-        raise InvalidData, "incomplete name" if name.bytesize != name_length
+        raise InvalidData, 'incomplete name' if name.bytesize != name_length
+
         name_sym = name.to_sym.downcase
-        if properties.has_key?(name_sym)
-          raise InvalidData, "property #{name.inspect}: duplicate name"
-        end
+        raise InvalidData, "property #{name.inspect}: duplicate name" if properties.key?(name_sym)
+
         consumed += 1 + name.bytesize
 
         # read property value
-        value_length = data.byteslice(consumed, 4).unpack("N").first or
-          raise InvalidData, "incomplete length"
-        value = data.byteslice(consumed + 4, value_length)
-        raise InvalidData, "incomplete value" if value.bytesize != value_length
+        value_length = data.byteslice(consumed, 4).unpack1('N') or
+          raise InvalidData, 'incomplete length'
+        value        = data.byteslice(consumed + 4, value_length)
+        raise InvalidData, 'incomplete value' if value.bytesize != value_length
+
         consumed += 4 + value.bytesize
 
         # remember
@@ -78,12 +85,14 @@ module CZTop
       new(properties)
     end
 
+
     # @param properties [Hash<Symbol, String>] the properties as loaded by
     #   {load}
     def initialize(properties)
       @properties = properties
     end
 
+
     # Gets the value corresponding to a property name. The case of the name
     # is insignificant.
     # @param name [Symbol, String] the property name
@@ -92,9 +101,11 @@ module CZTop
       @properties[name.to_sym.downcase]
     end
 
+
     # @return [Hash<Symbol, String] all properties
     def to_h
       @properties
     end
+
   end
 end

data/lib/cztop/monitor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CZTop
   # CZMQ monitor. Listen for socket events.
   #
@@ -8,11 +10,12 @@ module CZTop
   # @see http://api.zeromq.org/czmq3-0:zmonitor
   # @see http://api.zeromq.org/4-1:zmq-socket-monitor
   class Monitor
+
     include ::CZMQ::FFI
 
     # function pointer to the +zmonitor()+ function
     ZMONITOR_FPTR = ::CZMQ::FFI.ffi_libraries.each do |dl|
-      fptr = dl.find_function("zmonitor")
+      fptr = dl.find_function('zmonitor')
       break fptr if fptr
     end
     raise LoadError, "couldn't find zmonitor()" if ZMONITOR_FPTR.nil?
@@ -31,10 +34,11 @@ module CZTop
       @actor.terminate
     end
 
+
     # Enable verbose logging of commands and activity.
     # @return [void]
     def verbose!
-      @actor << "VERBOSE"
+      @actor << 'VERBOSE'
     end
 
     # @return [Array<String>] types of valid events
@@ -55,7 +59,7 @@ module CZTop
       HANDSHAKE_FAILED_NO_DETAIL
       HANDSHAKE_FAILED_PROTOCOL
       HANDSHAKE_FAILED_AUTH
-    ]
+    ].freeze
 
     # Configure monitor to listen for specific events.
     # @param events [String] one or more events from {EVENTS}
@@ -65,16 +69,18 @@ module CZTop
         EVENTS.include?(event) or
           raise ArgumentError, "invalid event: #{event.inspect}"
       end
-      @actor << [ "LISTEN", *events ]
+      @actor << ['LISTEN', *events]
     end
 
+
     # Start the monitor. After this, you can read events using {#next}.
     # @return [void]
     def start
-      @actor << "START"
+      @actor << 'START'
       @actor.wait
     end
 
+
     # Useful for registration in an event-loop.
     # @return [Integer] the FD
     # @see ZsockOptions#fd
@@ -82,11 +88,13 @@ module CZTop
       @actor.fd
     end
 
+
     # @return [Boolean] whether there's at least one event available
     def readable?
       @actor.readable?
     end
 
+
     # Get next event. This blocks until the next event is available.
     # @example
     #   socket = CZTop::Socket::ROUTER.new("tcp://127.0.0.1:5050")
@@ -112,5 +120,6 @@ module CZTop
     def next
       @actor.receive
     end
+
   end
 end