omq-cli 0.15.1 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08825b7e8c6acff6b7c8847cd1966def9bfa751a06cfb0a69c36f0bdc8f71b0e'
-  data.tar.gz: 2d060c1e4bdfea82a807f053ff5457eb392d372fd73e1c4f962b4b90cbbcfa06
+  metadata.gz: f6f38a5924268358a3b48021d597248a341e3590ea36a13fc9ee8cc078d2a826
+  data.tar.gz: fc3e4b1b13cb85b9e492f6f75e4a6409e5fe2357ee1806bd68abe27954117e41
 SHA512:
-  metadata.gz: 5784667a548da85592c289fa905c70290e8e90426815a2fafbf5b833f15159c4d0bdaf1ebb561d50dfe4ed4e801f2e90ffd44c04541a2e62a59e6d17da6f44ef
-  data.tar.gz: ff42a632e0360a1b926d7833cbbeaa3331a2db0d10a47d0d4b5b5f7ef863d948a58cf5972643872566478c2ca0706b9394f75e49518887dc66ad54b67140d9bc
+  metadata.gz: c8b10c0dc4aa93ab2676c8df93cc62026fd08b17cc76d2cb3da73059e0fba443263e9200a9eb65835bd7985bf48e5409fd04dabd0574cbe1b5c1735e14ce0c88
+  data.tar.gz: 7899ea0cbfac91674f8bc750cd31faf957bcb9f6b9996261d606d6859322b7c74fdbc2311f3d7dc9ec72355add2f9734f1493d36a4eb86af3bffb6eed110a874

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.15.2 — 2026-04-15
+
+### Fixed
+
+- **`-vvv` trace output for REQ/REP/PAIR.** `recv_msg` now calls
+  `trace_recv` itself, so every runner logs received messages under
+  `-vvv` (previously only `run_recv_logic` / `recv_tick` runners did,
+  leaving REQ/REP/PAIR receive-side traces silent).
+
+### Tests
+
+- **System test for REQ/REP verbose trace order.** Asserts REQ logs
+  `>> hi` then `<< HI`, and REP (with `-e'it.first.upcase'`) logs
+  `<< hi` then `>> HI`.
+- **Test suite aborts on background-thread exceptions.**
+  `Thread.abort_on_exception = true` in `test_helper.rb` — a raising
+  spawned thread now re-raises in the main thread immediately instead
+  of leaving the test hanging on a receive from a dead peer.
+- **`connect_before_bind_test`**: drop `linger: 1` from
+  `OMQ::PULL.new` — PULL is read-only and doesn't accept `linger`.
+
 ## 0.15.0 — 2026-04-14
 
 ### Changed

data/README.md

@@ -1,33 +1,58 @@
-# omq — ZeroMQ CLI
+# omq — Swiss army knife for ØMQ
 
 [![Gem Version](https://img.shields.io/gem/v/omq-cli?color=e9573f)](https://rubygems.org/gems/omq-cli)
 [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](LICENSE)
 [![Ruby](https://img.shields.io/badge/Ruby-%3E%3D%203.3-CC342D?logo=ruby&logoColor=white)](https://www.ruby-lang.org)
 
-Command-line tool for sending and receiving ZeroMQ messages on any socket type.
-Like `nngcat` from libnng, but with Ruby eval, Ractor parallelism, and message handlers.
-
-Built on [omq](https://github.com/zeromq/omq) — pure Ruby ZeroMQ, no C dependencies.
-
-## Install
+A command-line tool that speaks every ZeroMQ socket pattern, transforms
+messages with inline Ruby, parallelizes across Ractors, encrypts with CURVE,
+and reshapes stdin/stdout through three I/O formats on top of three
+on-the-wire formats. Built on [ØMQ](https://github.com/zeromq/omq) — pure
+Ruby, no C dependencies.
 
 ```sh
 gem install omq-cli
 ```
 
-## Quick Start
+Think of it as `nngcat` with a scripting engine bolted on. A few things it can do out of the box:
 
 ```sh
-# Echo server
+# an echo server in one line
 omq rep -b tcp://:5555 --echo
 
-# Client
-echo "hello" | omq req -c tcp://localhost:5555
-
-# Upcase server — -e evals Ruby on each incoming message
+# upcase every incoming message
 omq rep -b tcp://:5555 -e 'it.map(&:upcase)'
+
+# publish a live timestamp every second
+omq pub -c tcp://localhost:5556 -E 'Time.now.to_s' -i 1
+
+# CPU-parallel PULL → transform → PUSH pipeline across all cores
+omq pipe -c@work -c@sink -P0 -r./fib.rb -e 'fib(Integer(it.first)).to_s'
+
+# JSON over the wire, filter by field
+omq sub -c tcp://localhost:5556 -rjson -e 'JSON.parse(it.first)["temperature"]'
 ```
 
+## Highlights
+
+- **Every socket pattern** — req/rep, pub/sub, push/pull, dealer/router,
+  xpub/xsub, pair, and draft types (client/server, radio/dish, scatter/gather,
+  peer, channel)
+- **Inline Ruby transforms** — `-e` rewrites incoming messages, `-E` rewrites
+  outgoing. `next` / `break` / `nil` for flow control, `BEGIN{}` / `END{}` for
+  awk-style aggregation, `-r` to load helper scripts
+- **Ractor-parallel `pipe`** — `-P0` spawns one worker Ractor per core, each
+  with its own PULL/PUSH pair. CPU-bound transforms actually scale
+- **I/O formats** — ASCII, quoted, or JSONL for stdin/stdout (display only;
+  wire stays plain)
+- **Wire formats** — raw ZMTP, MessagePack, or Ruby Marshal shape the frame
+  payload itself, so arbitrary Ruby objects round-trip end-to-end. Optional
+  Zstandard compression (`-z`) on top
+- **CURVE encryption** — end-to-end encrypted sockets via libsodium (or nuckle,
+  pure Ruby). `omq keygen` generates a persistent keypair
+- **Transient mode** — `--transient` exits cleanly when peers disconnect,
+  perfect for pipeline workers and one-shot sinks
+
 ```
 Usage: omq TYPE [options]
 
@@ -61,7 +86,8 @@ Pipe takes two positional endpoints (input, output) or uses `--in`/`--out` for m
 | `scatter` | `gather` | Pipeline (draft, single-frame only) |
 | `radio` | `dish` | Group messaging (draft, single-frame only) |
 
-Send-only sockets read from stdin (or `--data`/`--file`) and send. Recv-only sockets receive and write to stdout.
+Send-only sockets read from stdin (or `--data`/`--file`) and send. Recv-only
+sockets receive and write to stdout.
 
 ```sh
 echo "task" | omq push -c tcp://worker:5557
@@ -96,8 +122,8 @@ echo "hello" | omq req -c tcp://localhost:5555
 | `dealer` | Like `pair` but round-robin send to multiple peers |
 | `channel` | Like `pair` (draft, single-frame) |
 
-These spawn two concurrent tasks: a receiver (prints incoming) and a sender (reads stdin).
-`-e` transforms incoming, `-E` transforms outgoing.
+These spawn two concurrent tasks: a receiver (prints incoming) and a sender
+(reads stdin). `-e` transforms incoming, `-E` transforms outgoing.
 
 ### Routing sockets
 
@@ -212,8 +238,7 @@ echo hello | omq push -c tcp://localhost:5557 -E 'it.map(&:upcase)'
 omq pull -b tcp://:5557 -e 'it.first.include?("error") ? it : nil'
 
 # REQ: different transforms per direction
-echo hello | omq req -c tcp://localhost:5555 \
-  -E 'it.map(&:upcase)' -e 'it.map(&:reverse)'
+echo hello | omq req -c tcp://localhost:5555 -E 'it.map(&:upcase)' -e 'it.map(&:reverse)'
 
 # generate messages without stdin
 omq pub -c tcp://localhost:5556 -E 'Time.now.to_s' -i 1
@@ -305,17 +330,32 @@ OMQ.outgoing { |msg| [*msg, Time.now.iso8601] }
 
 ## Formats
 
+Two distinct axes: **I/O formats** reshape how messages are read from stdin
+and printed to stdout, while **wire formats** shape the frame payload that
+actually goes over ZMTP. Pick one of each — they compose freely.
+
+### I/O formats (stdin/stdout only)
+
 | Flag | Format |
 |------|--------|
 | `-A` / `--ascii` | Tab-separated frames, non-printable → dots (default) |
 | `-Q` / `--quoted` | C-style escapes, lossless round-trip |
-| `--raw` | Raw ZMTP binary (pipe to `hexdump -C` for debugging) |
 | `-J` / `--jsonl` | JSON Lines — `["frame1","frame2"]` per line |
-| `--msgpack` | MessagePack arrays (binary stream) |
-| `-M` / `--marshal` | Ruby Marshal — one arbitrary Ruby object per message |
 
-Multipart messages: in ASCII/quoted mode, frames are tab-separated. In JSONL mode,
-each message is a JSON array.
+Display-only: the wire carries plain ZMTP frames. Multipart messages are
+tab-separated in ASCII/quoted mode and encoded as JSON arrays in JSONL.
+
+### Wire formats (on the ZMTP frame payload)
+
+| Flag | Format |
+|------|--------|
+| `--raw` | Raw ZMTP binary (pipe to `hexdump -C` for debugging) |
+| `--msgpack` | MessagePack — each frame is one packed object |
+| `-M` / `--marshal` | Ruby Marshal — each frame is one arbitrary Ruby object |
+
+Wire formats reshape the payload end-to-end: inside `-e`/`-E`, `it` is the
+decoded object (not an Array of frames), so scalars, hashes, and custom
+classes flow through transparently between peers speaking the same format.
 
 ```sh
 # send multipart via tabs
@@ -326,12 +366,8 @@ echo '["key","value"]' | omq push -c tcp://localhost:5557 -J
 omq pull -b tcp://:5557 -J
 ```
 
-Under `-M`, each wire frame is one Marshal-dumped Ruby object. Inside `-e` / `-E`,
-`it` is that raw object — not an Array of frames — so scalars, hashes, custom
-classes, or any Marshal-safe value flow through transparently:
-
 ```sh
-# send a bare String, receive a { string => encoding } Hash
+# send a bare String with Marshal, receive a { string => encoding } Hash
 omq push -b tcp://:5557 -ME '"foo"'
 omq pull -c tcp://:5557 -M -e '{it => it.encoding}'
 # => {"foo" => #<Encoding:UTF-8>}
@@ -413,8 +449,7 @@ omq rep -b tcp://:5555 --echo --curve-server --crypto nuckle
 omq rep -b tcp://:5555 --echo --curve-server
 
 # client (paste the key)
-echo "secret" | omq req -c tcp://localhost:5555 \
-  --curve-server-key '<key from server>'
+echo "secret" | omq req -c tcp://localhost:5555 --curve-server-key '<key from server>'
 ```
 
 Persistent keys via env vars: `OMQ_SERVER_PUBLIC` + `OMQ_SERVER_SECRET` (server), `OMQ_SERVER_KEY` (client).

data/lib/omq/cli/base_runner.rb

@@ -289,7 +289,6 @@ module OMQ
           loop do
             parts = recv_msg
             break if parts.nil?
-            trace_recv(parts)
             parts = eval_recv_expr(parts)
             output(parts)
             i += 1
@@ -316,7 +315,6 @@ module OMQ
           @recv_tick_eof = true
           return 0
         end
-        trace_recv(parts)
         parts = eval_recv_expr(parts)
         output(parts)
         1
@@ -405,6 +403,7 @@ module OMQ
           parts = Marshal.load(parts.first)
         end
 
+        trace_recv(parts)
         transient_ready!
         parts
       end

data/lib/omq/cli/version.rb

@@ -2,6 +2,6 @@
 
 module OMQ
   module CLI
-    VERSION = "0.15.1"
+    VERSION = "0.15.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omq-cli
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.15.2
 platform: ruby
 authors:
 - Patrik Wenger
@@ -15,20 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: '0.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: omq-ffi
   requirement: !ruby/object:Gem::Requirement
@@ -49,84 +43,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: omq-rfc-radiodish
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: omq-rfc-scattergather
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: omq-rfc-channel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: omq-rfc-p2p
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: omq-rfc-zstd
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement