cztop 1.0.0 → 1.1.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0099b49a3147e57b4e29b8ca7288370f56e06694230c2f390e36308ac1f0cb1e'
-  data.tar.gz: d4431ae33cc4c35f9911d755d4377913f502156c26317b04a720c598f1f3eb3b
+  metadata.gz: 149778ca201f323611fe23b4b1107c4cb4bde8ea7364bbe7370cea39daf5ab02
+  data.tar.gz: 195be179654f5b1c286f4859a012a093bed587f644306ee63642a7e300b261f6
 SHA512:
-  metadata.gz: 48f93f12b32aaed87a7cdbdf3f83ff064e69f1fef3e27e4dfaee21a7d721698bd8e7e1675d6fa1110b7597ae7651d971d4502b631a5505345cbb0dbf8ecc19e8
-  data.tar.gz: 90540f6ccab41b27361fc1372feb5198351a725b20a69509285ed459073f438a149a7e5e11043a1936b978610c664a0f7096bbb27c6801054cb85ff6fcd6a0b4
+  metadata.gz: c2a65ca5f02e39cfc9ca2695fefd6b02c0e898878041a662d0af1361235fa1ec091c4024d0a9d68b793173f191ce81350e21cc98b0a2320d3d6c9d9617f35d50
+  data.tar.gz: bae808f502e3f8b3ced7872d76a6377578bd37d332bf12ba96aaa126ea7571abbbfe363426c9578c30ecd6abbc126198e470d3d378de0bd0b1960384ab9d17b7

data/.github/workflows/coverage.yml

@@ -0,0 +1,20 @@
+name: Coverage
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1
+    - name: Install CZMQ
+      run: sudo apt-get install libczmq-dev
+    - name: Run the default task
+      run: |
+        gem install bundler
+        bundle install
+        env REPORT_COVERAGE=true bundle exec rake

data/.github/workflows/draft_api.yml

@@ -0,0 +1,27 @@
+name: DRAFT API
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    timeout-minutes: 15
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1
+    - name: Install ZMQ and CZMQ
+      run: |
+        export PKG_CONFIG_PATH=$HOME/lib/pkgconfig # custom libs (for linking)
+        env
+        env ZMQ_VERSION=HEAD ci/install-libzmq
+        env CZMQ_VERSION=HEAD ci/install-libczmq
+    - name: Run the default task
+      run: |
+        export LD_LIBRARY_PATH=$HOME/lib # custom libs (for execution)
+        env
+        gem install bundler
+        bundle install
+        bundle exec rake

data/.github/workflows/{main.yml → stable_api.yml}

@@ -1,4 +1,4 @@
-name: Specs
+name: STABLE API
 
 on: [push,pull_request]
 
@@ -8,9 +8,9 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - "2.6"
-          - "2.7"
-          - "3.0"
+          - 2.7
+          - 3.0
+          - 3.1
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby ${{ matrix.ruby }}
@@ -18,9 +18,9 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: Install CZMQ
-      run: sudo apt install libczmq-dev
+      run: sudo apt-get install libczmq-dev
     - name: Run the default task
       run: |
-        gem install bundler -v 2.2.3
+        gem install bundler
         bundle install
         bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,175 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+Layout/EmptyLines:
+  Enabled: false
+Layout/EmptyLineBetweenDefs:
+  NumberOfEmptyLines: 2
+Layout/MultilineOperationIndentation:
+  Enabled: true
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: false
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/AndOr:
+  EnforcedStyle: conditionals
+Style/InfiniteLoop:
+  Enabled: false
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always_true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/StringConcatenation:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Style/YodaCondition:
+  Enabled: false
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+Style/WordArray:
+  Enabled: false
+Style/Semicolon:
+  Enabled: false
+Naming/MethodName:
+  Enabled: false
+Style/EmptyMethod:
+  Enabled: false
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+  EnforcedStyle: empty_lines_except_namespace
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+  EnforcedStyle: empty_lines_except_namespace

data/CHANGES.md

@@ -1,5 +1,12 @@
+1.1.0.pre1 (10/17/2022)
+-----
+* modernize syntax using Rubocop
+* use czmq-ffi-gen 1.1.0.pre1
+* require Ruby >= 2.7.x
+
 1.0.0 (01/08/2021)
 -----
+* use czmq-ffi-gen 1.0.x
 * modernized project
 
 0.13.1 (03/04/2018)
@@ -132,7 +139,7 @@
 
 0.3.0 (04/13/2016)
 -----
-* port CZTop::Poller to zmq_poller_*() functions so it supports thread-safe
+* port CZTop::Poller to `zmq_poller_*()` functions so it supports thread-safe
   sockets as well
 * extract niche features to CZTop::Poller::Aggregated
 * fix taxi system example

data/Gemfile

@@ -3,3 +3,8 @@ gemspec
 
 # useful when working on czmq-ffi-gen in parallel
 # gem "czmq-ffi-gen", path: "../czmq-ffi-gen"
+
+group :development do
+  gem 'codecov', require: false
+  gem 'simplecov', require: false
+end

data/README.md

@@ -1,4 +1,6 @@
-![Specs status](https://github.com/paddor/cztop/workflows/Specs/badge.svg)
+![Specs status](https://github.com/paddor/cztop/workflows/STABLE%20API/badge.svg)
+![Specs status](https://github.com/paddor/cztop/workflows/DRAFT%20API/badge.svg)
+[![codecov](https://codecov.io/gh/paddor/cztop/branch/master/graph/badge.svg?token=TnjOba97R7)](https://codecov.io/gh/paddor/cztop)
 
 # CZTop
 

data/ci/install-libczmq

@@ -0,0 +1,22 @@
+#!/bin/sh -x
+# vim: ft=sh
+set -e
+mkdir -p ~/src
+cd ~/src
+
+case "$CZMQ_VERSION" in
+HEAD)
+	echo "Using HEAD and compiling with --enable-drafts ..."
+	git clone https://github.com/zeromq/czmq czmq
+	CONFIGURE_OPTS="--enable-drafts=yes"
+	;;
+*)
+	echo '$CZMQ_VERSION not set.'
+	exit 1
+esac
+
+cd czmq
+./autogen.sh
+./configure --prefix=$HOME $CONFIGURE_OPTS
+make
+make install

data/ci/install-libzmq

@@ -0,0 +1,22 @@
+#!/bin/sh -x
+# vim: ft=sh
+set -e
+mkdir -p ~/src
+cd ~/src
+
+case "$ZMQ_VERSION" in
+HEAD)
+	echo "Using HEAD and compiling with --enable-drafts ..."
+	git clone https://github.com/zeromq/libzmq libzmq
+	CONFIGURE_OPTS="--enable-drafts=yes"
+	;;
+*)
+	echo '$ZMQ_VERSION not set.'
+	exit 1
+esac
+
+cd libzmq
+./autogen.sh
+./configure --prefix=$HOME $CONFIGURE_OPTS
+make
+make install

data/cztop.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{CZMQ Ruby binding based on the generated low-level FFI bindings of CZMQ}
   spec.homepage      = "https://rubygems.org/gems/cztop"
   spec.license       = "ISC"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"]    = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/paddor/cztop"
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "czmq-ffi-gen", "~> 1.0"
+  spec.add_runtime_dependency "czmq-ffi-gen", "~> 1.1.0.pre1"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-given", "~> 3.8.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "yard"
+  spec.add_development_dependency "rubocop", "~> 1.36.0"
 end

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