cztop 1.1.1 → 1.2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: czmq-ffi-gen
@@ -122,20 +122,6 @@ 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
 - !ruby/object:Gem::Dependency
   name: async
   requirement: !ruby/object:Gem::Requirement
@@ -150,20 +136,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
-- !ruby/object:Gem::Dependency
-  name: async-io
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: CZMQ binding based on the generated low-level FFI bindings of CZMQ
 email:
 - paddor@gmail.com
@@ -173,48 +145,18 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/coverage.yml"
-- ".github/workflows/draft_api.yml"
-- ".github/workflows/stable_api.yml"
-- ".gitignore"
-- ".projections.json"
-- ".rspec"
-- ".rubocop.yml"
-- ".yardopts"
 - AUTHORS
 - CHANGES.md
 - Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - bin/console
 - bin/setup
-- ci/install-libczmq
-- ci/install-libzmq
 - cztop.gemspec
-- examples/async/.gitignore
-- examples/async/Gemfile
-- examples/async/README.md
-- examples/async/async.rb
-- examples/ruby_actor/actor.rb
-- examples/simple_req_rep/rep.rb
-- examples/simple_req_rep/req.rb
-- examples/taxi_system/.gitignore
-- examples/taxi_system/Makefile
-- examples/taxi_system/README.gsl
-- examples/taxi_system/README.md
-- examples/taxi_system/broker.rb
-- examples/taxi_system/client.rb
-- examples/taxi_system/generate_keys.rb
-- examples/taxi_system/start_broker.sh
-- examples/taxi_system/start_clients.sh
-- examples/weather_pub_sub/pub.rb
-- examples/weather_pub_sub/sub.rb
 - exe/z85decode
 - exe/z85encode
 - lib/cztop.rb
 - lib/cztop/actor.rb
-- lib/cztop/async.rb
 - lib/cztop/authenticator.rb
 - lib/cztop/beacon.rb
 - lib/cztop/cert_store.rb
@@ -244,11 +186,6 @@ files:
 - lib/cztop/z85/pipe.rb
 - lib/cztop/zap.rb
 - lib/cztop/zsock_options.rb
-- perf/README.md
-- perf/inproc_lat.rb
-- perf/inproc_thru.rb
-- perf/local_lat.rb
-- perf/remote_lat.rb
 homepage: https://rubygems.org/gems/cztop
 licenses:
 - ISC
@@ -264,7 +201,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/workflows/coverage.yml

@@ -1,20 +0,0 @@
-name: Coverage
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-22.04
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.3
-    - 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

@@ -1,27 +0,0 @@
-name: DRAFT API
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-22.04
-    timeout-minutes: 15
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: '3.3'
-    - 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/stable_api.yml

@@ -1,26 +0,0 @@
-name: STABLE API
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        ruby:
-          - '3.1'
-          - '3.2'
-          - '3.3'
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby ${{ matrix.ruby }}
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Install CZMQ
-      run: sudo apt-get install libczmq-dev
-    - name: Run the default task
-      run: |
-        gem install bundler
-        bundle install
-        bundle exec rake

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/*.vimsession

data/.projections.json

@@ -1,4 +0,0 @@
-{
-  "lib/*.rb": { "alternate": "spec/{}_spec.rb" },
-  "spec/*_spec.rb": { "alternate": "lib/{}.rb", "dispatch": "bundle exec rspec -ff {file}" }
-}

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.rubocop.yml

@@ -1,175 +0,0 @@
-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/.yardopts

@@ -1 +0,0 @@
---private lib/**/*.rb - README.md LICENSE

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/ci/install-libczmq

@@ -1,22 +0,0 @@
-#!/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

@@ -1,22 +0,0 @@
-#!/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/examples/async/.gitignore

@@ -1 +0,0 @@
-/Gemfile.lock

data/examples/async/Gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'async'
-gem 'cztop', path: '../../'
-gem 'async-io'

data/examples/async/README.md

@@ -1 +0,0 @@
-Run: `bundle exec ./async.rb`

data/examples/async/async.rb

@@ -1,35 +0,0 @@
-#! /usr/bin/env ruby
-
-require 'cztop/async'
-
-Async do |task|
-  task.async do |t|
-    socket = CZTop::Socket::REP.new("inproc://req_rep_example")
-    io     = Async::IO.try_convert socket
-
-    socket.options.rcvtimeo = 50 # ms
-
-    loop do
-      msg = io.receive
-      puts "<<< #{msg.to_a.inspect}"
-      io << msg.to_a.map(&:upcase)
-    rescue IO::TimeoutError
-      break
-    end
-
-    puts "REP done."
-  end
-
-  task.async do
-    socket = CZTop::Socket::REQ.new("inproc://req_rep_example")
-    io     = Async::IO.try_convert socket
-
-    10.times do |i|
-      io << "foobar ##{i}"
-      msg = io.receive
-      puts ">>> #{msg.to_a.inspect}"
-    end
-
-    puts "REQ done."
-  end
-end

data/examples/ruby_actor/actor.rb

@@ -1,100 +0,0 @@
-#!/usr/bin/env ruby
-require 'cztop'
-
-##
-# This example shows how to create a simple actor using a Ruby block.
-# Of course it also supports the CZMQ-native way, passing a pointer to
-# a C function. That's how CZTop::Beacon, CZTop::Authenticator, ... are
-# implemented.
-#
-
-counter = 0
-actor = CZTop::Actor.new do |msg, pipe|
-  # This block is called once for every received message.
-
-  case command = msg[0]
-  when "UPCASE"
-    # Upcase second message frame and send back.
-    word = msg[1]
-    puts ">>> Actor converts #{word.inspect} to uppercase."
-    pipe << word.upcase
-  when "COUNT"
-    # Count up.
-    counter += 1
-    puts ">>> Actor has incremented counter to: #{counter}"
-  when "PRODUCE"
-    # Produce multiple messages.
-    num = msg[1].to_i
-    puts ">>> Actor produces #{num} messages."
-    num.times { |i| pipe << "FOO #{i+1}/#{num}" }
-  else
-    # crashes actor #=> Actor#dead? and Actor#crashed? will return true
-    # also, Actor#exception will return this exception.
-    raise "invalid command: #{command}"
-  end
-end
-puts ">>> Actor created."
-
-##
-# Let actor count.
-#
-# Actor#<< is thread-safe.
-#
-actor << "COUNT"
-actor << "COUNT"
-actor << "COUNT"
-actor << "COUNT"
-actor << "COUNT"
-actor << "COUNT"
-
-
-##
-# Request a response from actor.
-#
-# Actor#request is thread-safe and ensures that the right response gets
-# returned.
-#
-puts actor.request(["UPCASE", "foobar"]).inspect
-#=> #<CZTop::Message:0x7f98c8d96000 frames=1 content_size=6 content=["FOOBAR"]>
-
-
-##
-# Let actor produce some messages.
-#
-# Actor#receive is thread-safe, but doesn't guarantee any particular order.
-#
-actor << %w[ PRODUCE 5 ]
-puts actor.receive[0] #1
-puts actor.receive[0] #2
-puts actor.receive[0] #3
-puts actor.receive[0] #4
-puts actor.receive[0] #5
-
-##
-# Let actor die.
-#
-# Blocks until dead.
-actor.terminate
-actor.dead? #=> true
-actor.crashed? #=> false
-actor.exception #=> nil, because it didn't crash
-
-
-__END__
-Example output:
-
->>> Actor created.
->>> Actor has incremented counter to: 1
->>> Actor has incremented counter to: 2
->>> Actor has incremented counter to: 3
->>> Actor has incremented counter to: 4
->>> Actor has incremented counter to: 5
->>> Actor has incremented counter to: 6
->>> Actor converts "foobar" to uppercase.
-#<CZTop::Message:0x7f81c55bdca0 frames=1 content_size=6 content=["FOOBAR"]>
->>> Actor produces 5 messages.
-FOO 1/5
-FOO 2/5
-FOO 3/5
-FOO 4/5
-FOO 5/5

data/examples/simple_req_rep/rep.rb

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-require 'cztop'
-
-# create and bind socket
-socket = CZTop::Socket::REP.new("ipc:///tmp/req_rep_example")
-puts "<<< Socket bound to #{socket.last_endpoint.inspect}"
-
-# Simply echo every message, with every frame String#upcase'd.
-while msg = socket.receive
-  puts "<<< #{msg.to_a.inspect}"
-  socket << msg.to_a.map(&:upcase)
-end

data/examples/simple_req_rep/req.rb

@@ -1,35 +0,0 @@
-#!/usr/bin/env ruby
-require 'cztop'
-
-# connect
-socket = CZTop::Socket::REQ.new("ipc:///tmp/req_rep_example")
-puts ">>> Socket connected."
-
-# simple string
-socket << "foobar"
-msg = socket.receive
-puts ">>> #{msg.to_a.inspect}"
-
-# multi frame message as array
-socket << %w[foo bar baz]
-msg = socket.receive
-puts ">>> #{msg.to_a.inspect}"
-
-# manually instantiating a Message
-msg = CZTop::Message.new("bla")
-msg << "another frame" # append a frame
-socket << msg
-msg = socket.receive
-puts ">>> #{msg.to_a.inspect}"
-
-##
-# This will send 20 additional messages:
-#
-#   ./req.rb 20
-#
-if ARGV.first
-  ARGV.first.to_i.times do
-    socket << ["fooooooooo", "baaaaaar"]
-    puts ">>> " + socket.receive.to_a.inspect
-  end
-end

data/examples/taxi_system/.gitignore

@@ -1,2 +0,0 @@
-secret_keys/
-public_keys/

data/examples/taxi_system/Makefile

@@ -1,2 +0,0 @@
-README.md: README.gsl generate_keys.rb broker.rb client.rb start_broker.sh start_clients.sh
-	gsl README