cztop 1.0.0 → 1.1.0.pre1

data/lib/cztop/config/traversing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Methods used to traverse a {CZTop::Config} tree.
 module CZTop::Config::Traversing
 
@@ -12,24 +14,25 @@ module CZTop::Config::Traversing
   # @raise [Exception] the block's exception, in case it raises (it won't
   #   call the block any more after that)
   def execute
-    raise ArgumentError, "no block given" unless block_given?
-    exception = nil
-    block_value = nil
-    ret = nil
-    callback = CZMQ::FFI::Zconfig.fct do |zconfig, _arg, level|
+    raise ArgumentError, 'no block given' unless block_given?
+
+    exception                           = nil
+    block_value                         = nil
+    ret                                 = nil
+    callback                            = CZMQ::FFI::Zconfig.fct do |zconfig, _arg, level|
       begin
         # NOTE: work around JRuby and Rubinius bug, where it'd keep calling
         # this FFI::Function, even when the block `break`ed
         if ret != -1
-          config = from_ffi_delegate(zconfig)
+          config      = from_ffi_delegate(zconfig)
           block_value = yield config, level
-          ret = 0 # report success to keep zconfig_execute() going
+          ret         = 0 # report success to keep zconfig_execute() going
         end
-      rescue
+      rescue StandardError
         # remember exception, so we can raise it later to the ruby code
         # (it can't be raised now, as we have to report failure to
         # zconfig_execute())
-        exception = $!
+        exception = $ERROR_INFO
 
         ret = -1 # report failure to stop zconfig_execute() immediately
       ensure
@@ -39,15 +42,18 @@ module CZTop::Config::Traversing
     end
     ffi_delegate.execute(callback, _arg = nil)
     raise exception if exception
-    return block_value
+
+    block_value
   end
 
+
   # Access to this config item's direct children.
   # @return [ChildrenAccessor]
   def children
     ChildrenAccessor.new(self)
   end
 
+
   # Access to this config item's siblings.
   # @note Only the "younger" (later in the ZPL file) config items are
   #   considered.
@@ -56,9 +62,11 @@ module CZTop::Config::Traversing
     SiblingsAccessor.new(self)
   end
 
+
   # Used to give access to a {Config} item's children or siblings.
   # @abstract
   class FamilyAccessor
+
     include Enumerable
 
     # @param config [Config] the relative starting point (either parent or
@@ -67,25 +75,30 @@ module CZTop::Config::Traversing
       @config = config
     end
 
+
     # This is supposed to return the first relevant config item.
     # @abstract
     # @return [Config, nil]
     def first; end
 
+
     # Yields all direct children/younger siblings. Starts with {#first}, if
     # set.
     # @yieldparam config [Config]
     def each
-      current = first()
+      current = first
       return if current.nil?
+
       yield current
-      current_delegate = current.ffi_delegate
+      current_delegate       = current.ffi_delegate
       while current_delegate = current_delegate.next
         break if current_delegate.null?
+
         yield CZTop::Config.from_ffi_delegate(current_delegate)
       end
     end
 
+
     # Recursively compares these config items with the ones of the other.
     # @param other [FamilyAccessor]
     def ==(other)
@@ -94,30 +107,39 @@ module CZTop::Config::Traversing
       these.size == those.size && these.zip(those) do |this, that|
         this.tree_equal?(that) or return false
       end
-      return true
+      true
     end
+
   end
 
+
   # Accesses the younger siblings of a given {Config} item.
   class SiblingsAccessor < FamilyAccessor
+
     # Returns the first sibling.
     # @return [Config]
     # @return [nil] if no younger siblings
     def first
       ptr = @config.ffi_delegate.next
       return nil if ptr.null?
+
       CZTop::Config.from_ffi_delegate(ptr)
     end
+
   end
 
+
   # Accesses the direct children of a given {Config} item.
   class ChildrenAccessor < FamilyAccessor
+
     def first
       ptr = @config.ffi_delegate.child
       return nil if ptr.null?
+
       CZTop::Config.from_ffi_delegate(ptr)
     end
 
+
     # Adds a new Config item and yields it, so it can be configured in
     # a block.
     # @param name [String] name for new config item
@@ -129,8 +151,10 @@ module CZTop::Config::Traversing
       yield config if block_given?
       config
     end
+
   end
 
+
   # Finds a config item along a path, relative to the current item.
   # @param path [String] path (leading slash is optional and will be
   #   ignored)
@@ -139,19 +163,26 @@ module CZTop::Config::Traversing
   def locate(path)
     ptr = ffi_delegate.locate(path)
     return nil if ptr.null?
+
     from_ffi_delegate(ptr)
   end
 
+
   # Finds last item at given level (0 = root).
   # @return [Config] the last config item at given level
   # @return [nil] if there's no config item at given level
   def last_at_depth(level)
     ptr = ffi_delegate.at_depth(level)
     return nil if ptr.null?
+
     from_ffi_delegate(ptr)
   end
+
 end
 
+
 class CZTop::Config
+
   include Traversing
+
 end

data/lib/cztop/config.rb

@@ -1,11 +1,14 @@
-module CZTop
+# frozen_string_literal: true
 
+module CZTop
   # Represents a CZMQ::FFI::Zconfig item.
   # @see http://rfc.zeromq.org/spec:4/ZPL
   class Config
+
     include HasFFIDelegate
     extend CZTop::HasFFIDelegate::ClassMethods
 
+
     # Initializes a new {Config} item. Takes an optional block to initialize
     # the item further.
     # @param name [String] config item name
@@ -17,7 +20,7 @@ module CZTop
     #   {Config} object is garbage collected).
     def initialize(name = nil, value = nil, parent: nil)
       if parent
-        parent = parent.ffi_delegate if parent.is_a?(Config)
+        parent   = parent.ffi_delegate if parent.is_a?(Config)
         delegate = ::CZMQ::FFI::Zconfig.new(name, parent)
         attach_ffi_delegate(delegate)
 
@@ -42,9 +45,11 @@ module CZTop
     def name
       ptr = ffi_delegate.name
       return nil if ptr.null? # NOTE: for unnamed elements
+
       ptr.read_string
     end
 
+
     # Sets a new name.
     # @param new_name [String, #to_s]
     # @return [new_name]
@@ -52,28 +57,33 @@ module CZTop
       ffi_delegate.set_name(new_name.to_s)
     end
 
+
     # Get the value of the config item.
     # @return [String]
     # @note This returns an empty string if the value is unset.
     def value
       ptr = ffi_delegate.value
-      return "" if ptr.null? # NOTE: for root elements
+      return '' if ptr.null? # NOTE: for root elements
+
       ptr.read_string
     end
 
+
     # Set or update the value of the config item.
     # @param new_value [String, #to_s]
     # @return [new_value]
     def value=(new_value)
-      ffi_delegate.set_value("%s", :string, new_value.to_s)
+      ffi_delegate.set_value('%s', :string, new_value.to_s)
     end
 
+
     # Inspects this {Config} item.
     # @return [String] shows class, name, and value
     def inspect
       "#<#{self.class.name}: name=#{name.inspect} value=#{value.inspect}>"
     end
 
+
     # Update the value of a config item by path.
     # @param path [String, #to_s] path to config item
     # @param value [String, #to_s] path to config item
@@ -81,7 +91,7 @@ module CZTop
     def []=(path, value)
       ffi_delegate.put(path.to_s, value.to_s)
     end
-    alias_method :put, :[]=
+    alias put []=
 
     # Get the value of the current config item.
     # @param path [String, #to_s] path to config item
@@ -92,30 +102,34 @@ module CZTop
     # @note The default value is not returned when the config item exists but
     #   just doesn't have a value. In that case, it'll return the empty
     #   string.
-    def [](path, default = "")
+    def [](path, default = '')
       ptr = ffi_delegate.get(path, default)
       return nil if ptr.null?
+
       ptr.read_string
     end
-    alias_method :get, :[]
+    alias get []
 
     # @!endgroup
 
+
     # Compares this config item to another. Only the name and value are
     # considered. If you need to compare a config tree, use {#tree_equal?}.
     # @param other [Config] the other config item
     # @return [Boolean] whether they're equal
     def ==(other)
       name == other.name &&
-      value == other.value
+        value == other.value
     end
 
+
     # Compares this config tree to another tree or subtree. Names, values, and
     # children are considered.
     # @param other [Config] the other config tree
     # @return [Boolean] whether they're equal
     def tree_equal?(other)
-      self == other && self.children == other.children
+      self == other && children == other.children
     end
+
   end
 end

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