omq-cli 0.14.8 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 108eeb712d98cda6762591002a5a7a6e24d341b579c6f9734f5a8d78adb2e481
-  data.tar.gz: a603b8c354cb14b6cfa8aed2a13798f9e9a51ecf34c31ab83b6119a36e9a88bb
+  metadata.gz: 01d85d72c83e9ad13715a18fcf2aac262ffc3abf1940f1b4c88b4f919913b044
+  data.tar.gz: c8c44569da1411027c0b9df3ebb9280c56bc4036d55cfd7af408235ee0a2ba04
 SHA512:
-  metadata.gz: 03210f226733ee6baa9acf26fc5e37617dbe6ca8040bd73529701d60994999d1a0baa8571b10852654892e1add49333c6c8bc38c442d91a349c4c0e49a749379
-  data.tar.gz: bfd7327cb515ae2133de3ec152b3c6f7ee5c68398b74f46fbd00d4ae060569bc782d4332e043e4b9eb1f0a53dd0ba5fa33ab84a72c322708e3aceee5febaad89
+  metadata.gz: b5769bb94c0f8d6cae351aae3d0dcba2694a4abf894bc1f89479bcb4aa7d41e3058c3d4c9c8788b9d26529a846c314adb61398decc77b8528a080950302614c7
+  data.tar.gz: 5dbcde145f0fca2bdfc44084c508c902a8dfec7a58519c1e5e4f24e6e79af34dcede9dc1b2d538d31a35e7108f4b6556b9a0d3958a83c830a8b6bec47e5f90dd

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## 0.15.0 — 2026-04-14
+
+### Changed
+
+- Use omq-rfc-zstd ~> 0.2
+
+## 0.14.9 — 2026-04-14
+
+### Fixed
+
+- **Bind-mode one-shot senders now wait for a peer before firing.**
+  `omq push -b tcp://:5050 -ME '"foo"*3'` used to bind, queue the
+  message into HWM, close the socket, and exit — frequently before
+  any PULL had even connected, surfacing as a mysterious
+  linger-timeout on exit. `needs_peer_wait?` now also returns true
+  for bind-mode senders whose send plan is bounded or scheduled
+  (`-d` / `-f` / `-E` / `-i`), so the runner blocks on
+  `peer_connected.wait` before sending and then drains cleanly via
+  linger on close. Interactive stdin is unchanged — typing isn't
+  gated on a peer.
+- **`--count N` now works with `-d` / `-f` / `-E` one-shot sends.**
+  Previously only `-i` / stdin respected `--count`; a pure-generator
+  run fired exactly once regardless. The `-d`/`-f` and `-E` branches
+  in `run_send_logic` now loop `n` times (default 1).
+- **`^C` while paging `--examples` is quiet.** Hitting ^C in the
+  pager used to leak an `Interrupt` stack trace from `IO.popen`;
+  `CLI.page` now rescues `Interrupt` alongside `Errno::EPIPE`.
+
+### Changed
+
+- **`--examples` output is ASCII-only and tightened up.** Replaced
+  the two em-dashes in the Marshal section with ASCII parentheses,
+  added a note to the Pipe section explaining that `@work` /
+  `@sink` are Linux abstract-namespace unix sockets
+  (`ipc://@name`), Linux-only, and to fall back to `ipc:///tmp/…`
+  on macOS/BSD. Marshal and Compression prose trimmed from
+  paragraph form to 2-3 line summaries.
+
 ## 0.14.8 — 2026-04-14
 
 ### Changed

data/lib/omq/cli/base_runner.rb

@@ -141,7 +141,21 @@ module OMQ
 
 
       def needs_peer_wait?
-        !config.recv_only? && (config.connects.any? || config.type_name == "router")
+        return false if config.recv_only?
+        return true if config.connects.any?
+        return true if config.type_name == "router"
+
+        # Bind-mode senders with a bounded or scheduled send plan:
+        # wait for the first peer so a one-shot `-d` / `-E` doesn't
+        # just queue into HWM and then exit before anyone is
+        # listening. Interactive stdin still goes through unwaited
+        # so typing isn't gated on a peer.
+        config.binds.any? && bounded_or_scheduled_send?
+      end
+
+
+      def bounded_or_scheduled_send?
+        config.interval || config.data || config.file || @send_eval_proc
       end
 
 
@@ -205,14 +219,18 @@ module OMQ
         if config.interval
           run_interval_send(n)
         elsif config.data || config.file
+          # One-shot from -d/-f. --count N fires the same payload N times.
           parts = eval_send_expr(read_next)
-          send_msg(parts) if parts
+          (n && n > 0 ? n : 1).times { send_msg(parts) } if parts
         elsif stdin_ready?
           run_stdin_send(n)
         elsif @send_eval_proc
-          # Pure generator: -e/-E with no stdin input, fire once.
-          parts = eval_send_expr(nil)
-          send_msg(parts) if parts
+          # Pure generator: -e/-E with no stdin input. Fire once by
+          # default, --count N fires N times.
+          (n && n > 0 ? n : 1).times do
+            parts = eval_send_expr(nil)
+            send_msg(parts) if parts
+          end
         elsif config.stdin_is_tty
           # Bare interactive invocation on a terminal: read lines from
           # the tty until the user hits ^D.

data/lib/omq/cli/cli_parser.rb

@@ -75,10 +75,15 @@ module OMQ
           | PUSH |-------->| pipe |-------->| PULL |
           +------+         +------+         +------+
 
+          # @work / @sink below are Linux abstract-namespace unix
+          # sockets (ipc://@name) -- no path on disk, cleaned up
+          # automatically. Linux only. Use ipc:///tmp/work etc.
+          # on macOS/BSD.
+
           # terminal 1: producer
           echo -e "hello\nworld" | omq push -b@work
 
-          # terminal 2: worker -- uppercase each message
+          # terminal 2: worker (uppercase each message)
           omq pipe -c@work -c@sink -e 'it.map(&:upcase)'
           # terminal 3: collector
           omq pull -b@sink
@@ -89,10 +94,10 @@ module OMQ
           # exit when producer disconnects (--transient)
           omq pipe -c@work -c@sink --transient -e 'it.map(&:upcase)'
 
-          # fan-in: multiple sources -> one sink
+          # fan-in (multiple sources -> one sink)
           omq pipe --in -c@work1 -c@work2 --out -c@sink -e 'it.map(&:upcase)'
 
-          # fan-out: one source -> multiple sinks (round-robin)
+          # fan-out (one source -> multiple sinks, round-robin)
           omq pipe --in -b tcp://:5555 --out -c@sink1 -c@sink2 -e 'it'
 
         -- CLIENT / SERVER (draft) ----------------------------------
@@ -125,15 +130,13 @@ module OMQ
 
         -- Marshal (arbitrary Ruby objects) -------------------------
 
-          # With -M, each message on the wire is one Marshal-dumped
-          # Ruby object. Inside -e/-E, `it` is that raw object — not
-          # an Array of frames — so you can send/receive scalars,
-          # hashes, custom classes, whatever Marshal handles.
+          # -M: each message is one Marshal-dumped Ruby object.
+          # Inside -e/-E, `it` is the raw object (not an Array).
 
-          # send a bare string, receive a { string => encoding } hash
-          omq push -b tcp://:5557 -ME '"foo"'
-          omq pull -c tcp://:5557 -Mvvv -e '{it => it.encoding}'
-          # output: {"foo" => #<Encoding:UTF-8>}
+          # send a bare string; receiver transforms it to { string => encoding } hash
+          omq push -b tcp://:5557 -ME '"foo" * 3'
+          omq pull -c tcp://:5557 -Me '{it => it.encoding}'
+          # output: {"foofoofoo" => #<Encoding:UTF-8>}
 
           # -vvv traces render the app object, not wire bytes
           omq push -b tcp://:5557 -ME '{now: Time.now, pid: Process.pid}' -vvv
@@ -141,11 +144,9 @@ module OMQ
 
         -- Compression ----------------------------------------------
 
-          # ZMTP-Zstd is negotiated transparently during the handshake.
-          # Receive-capable sockets (pull, sub, rep, ...) advertise the
-          # profile by default in passive mode: they decode compressed
-          # frames from an active sender but never compress their own
-          # outgoing frames. Use -z / -Z on the sender to opt it in.
+          # ZMTP-Zstd is negotiated during the handshake.
+          # Recv sockets advertise it passively by default.
+          # Use -z on the sender to compress outgoing frames.
           omq pull --bind tcp://:5557 &
           echo "compressible data" | omq push --connect tcp://localhost:5557 -z
 

data/lib/omq/cli/socket_setup.rb

@@ -49,9 +49,9 @@ module OMQ
       # their push/pull ends of a single pipe.
       def self.apply_compression(sock, config, type_name)
         if config.compress
-          sock.compression = OMQ::RFC::Zstd::Compression.auto(level: config.compress_level || -3)
+          sock.compression = OMQ::Compression::Zstd.auto(level: config.compress_level || -3)
         elsif !PURE_SEND_TYPES.include?(type_name)
-          sock.compression = OMQ::RFC::Zstd::Compression.auto(passive: true)
+          sock.compression = OMQ::Compression::Zstd.auto(passive: true)
         end
       end
 

data/lib/omq/cli/version.rb

@@ -2,6 +2,6 @@
 
 module OMQ
   module CLI
-    VERSION = "0.14.8"
+    VERSION = "0.15.0"
   end
 end

data/lib/omq/cli.rb

@@ -29,20 +29,28 @@ module OMQ
   class << self
     # @return [Proc, nil] registered outgoing message transform
     attr_reader :outgoing_proc
+
+
     # @return [Proc, nil] registered incoming message transform
     attr_reader :incoming_proc
 
+
     # Registers an outgoing message transform (used by -r scripts).
     #
     # @yield [Array<String>] message parts before sending
     # @return [Proc]
-    def outgoing(&block) = @outgoing_proc = block
+    def outgoing(&block)
+      @outgoing_proc = block
+    end
+
 
     # Registers an incoming message transform (used by -r scripts).
     #
     # @yield [Array<String>] message parts after receiving
     # @return [Proc]
-    def incoming(&block) = @incoming_proc = block
+    def incoming(&block)
+      @incoming_proc = block
+    end
   end
 
 
@@ -97,8 +105,8 @@ module OMQ
       end
     rescue Errno::ENOENT
       puts text
-    rescue Errno::EPIPE
-      # user quit pager early
+    rescue Errno::EPIPE, Interrupt
+      # user quit pager early (q) or hit ^C while paging
     end
 
 
@@ -123,6 +131,7 @@ module OMQ
     def run_keygen(argv)
       crypto_name = nil
       verbose     = false
+
       while (arg = argv.shift)
         case arg
         when "--crypto"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omq-cli
 version: !ruby/object:Gem::Version
-  version: 0.14.8
+  version: 0.15.0
 platform: ruby
 authors:
 - Patrik Wenger
@@ -119,14 +119,14 @@ 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: msgpack
   requirement: !ruby/object:Gem::Requirement