omq 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cda9b6329a0fdeef3ad3f7bf23522de62917ed6652209c2f39169cb62366b9e
-  data.tar.gz: 2e86fe3f178c7959e2cc79488770c20a72522bb279909f2f85189ae56d0fe4c9
+  metadata.gz: 27a1d700594261a36d3212b00ff84e15be3053a32db07a04a48aa0eb52fec902
+  data.tar.gz: 2797e4863af5cfcde9fe446c79929705e6ab17656ba016532b54d6c6b57564b9
 SHA512:
-  metadata.gz: 7b3287cc83b47ec7721011aa08cfb5dbc11c1e58affd9c75b708cfd6112f7d78870aa3831f017811bdd06c98e8969283e598b4ad2f62ecb6356675a61b2b124e
-  data.tar.gz: 2d2c118209e4a4d8306359aa76eb33e3d1512a02736c2a57b484139afa3c5de726abc770280321fa5f42e02b1900d4bdc0c48cd4f5792eb48c9221cd77694d17
+  metadata.gz: a116b039dc996a0099bbb86e8c138fd71f03051bd23c142b653e1c8e932e541245476bed51a47183ecb3723f9f86b30f36b6e3956b77494f8d77c924354f39ad
+  data.tar.gz: bdd7a62bb68390c942ebb1517981ca69d0efab007f3be7d3149fcccb525ad9b2cb279689ba2ec640db0f6057d6d7219e804074bb5ba4eb4d8339517bf6de5805

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.3.2 — 2026-03-26
+
+### Improved
+
+- Hide the warning about the experimental `IO::Buffer` (used by io-stream)
+
+## 0.3.1 — 2026-03-26
+
+### Improved
+
+- `omqcat --help` responds in ~90ms (was ~470ms) — defer heavy gem loading
+  until after option parsing
+
 ## 0.3.0 — 2026-03-26
 
 ### Added

data/README.md

@@ -137,6 +137,52 @@ Benchmarked with benchmark-ips on Linux x86_64 (Ruby 4.0.1 +YJIT):
 
 See [`bench/`](bench/) for full results and scripts.
 
+## omqcat — CLI tool
+
+`omqcat` is a command-line tool for sending and receiving messages on any OMQ socket. Like `nngcat` from libnng, but with Ruby superpowers.
+
+```sh
+# Echo server in one line
+omqcat rep -b tcp://:5555 -e '$F.map(&:upcase)'
+
+# Client
+echo "hello" | omqcat req -c tcp://localhost:5555
+# => HELLO
+
+# PUB/SUB
+omqcat sub -b tcp://:5556 -s "weather."  &
+echo "weather.nyc 72F" | omqcat pub -c tcp://localhost:5556 -d 0.3
+
+# Pipeline with filtering
+tail -f /var/log/syslog | omqcat push -c tcp://collector:5557
+omqcat pull -b tcp://:5557 -e '$F.first.include?("error") ? $F : nil'
+
+# Multipart messages via tabs
+printf "routing-key\tpayload data" | omqcat push -c tcp://localhost:5557
+omqcat pull -b tcp://:5557
+# => routing-key	payload data
+
+# JSONL for structured data
+echo '["key","value"]' | omqcat push -c tcp://localhost:5557 -J
+omqcat pull -b tcp://:5557 -J
+
+# Zstandard compression
+omqcat push -c tcp://remote:5557 -z < data.txt
+omqcat pull -b tcp://:5557 -z
+
+# CURVE encryption (auto-detected from env vars)
+SERVER_KEY=... omqcat req -c tcp://secure:5555 -D "secret"
+```
+
+The `-e` flag runs Ruby inside the socket instance — the full socket API (`self <<`, `send`, `subscribe`, ...) is available. Use `-r` to require gems:
+
+```sh
+omqcat sub -c tcp://localhost:5556 -s "" -r json \
+  -e 'JSON.parse($F.first)["temperature"]'
+```
+
+Formats: `--ascii` (default, tab-separated), `--quoted`, `--raw`, `--jsonl`, `--msgpack`. See `omqcat --help` for all options.
+
 ## Interop with native ZMQ
 
 OMQ speaks ZMTP 3.1 on the wire and interoperates with libzmq, CZMQ, pyzmq, etc. over **tcp** and **ipc**. The `inproc://` transport is OMQ-internal (in-process Ruby queues) and is not visible to native ZMQ running in the same process — use `ipc://` to talk across library boundaries.

data/exe/omqcat

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+Warning[:experimental] = false
 
 #
 # omqcat — command-line access to OMQ (ZeroMQ) sockets.
@@ -12,29 +13,9 @@
 #   omqcat sub -c tcp://localhost:5556 -s "weather."
 #
 
-require "omq"
-require "async"
 require "optparse"
-require "json"
-require "console"
 
-HAS_MSGPACK = begin; require "msgpack"; true; rescue LoadError; false; end
-HAS_ZSTD    = begin; require "zstd-ruby"; true; rescue LoadError; false; end
-
-SOCKET_TYPES = {
-  "req"    => OMQ::REQ,
-  "rep"    => OMQ::REP,
-  "pub"    => OMQ::PUB,
-  "sub"    => OMQ::SUB,
-  "push"   => OMQ::PUSH,
-  "pull"   => OMQ::PULL,
-  "pair"   => OMQ::PAIR,
-  "dealer" => OMQ::DEALER,
-  "router" => OMQ::ROUTER,
-}.freeze
-
-SEND_ONLY = [OMQ::PUB, OMQ::PUSH].freeze
-RECV_ONLY = [OMQ::SUB, OMQ::PULL].freeze
+SOCKET_TYPE_NAMES = %w[req rep pub sub push pull pair dealer router].freeze
 
 
 # ── Option parsing ──────────────────────────────────────────────────
@@ -61,7 +42,7 @@ opts = {
 
 parser = OptionParser.new do |o|
   o.banner = "Usage: omqcat TYPE [options]\n\n" \
-             "Types: #{SOCKET_TYPES.keys.join(', ')}\n\n"
+             "Types: #{SOCKET_TYPE_NAMES.join(', ')}\n\n"
 
   o.separator "Connection:"
   o.on("-c", "--connect URL", "Connect to endpoint (repeatable)")   { |v| opts[:connects] << v }
@@ -102,7 +83,7 @@ parser = OptionParser.new do |o|
   o.separator "\nOther:"
   o.on("-v", "--verbose", "Print connection events to stderr") { opts[:verbose] = true }
   o.on("-q", "--quiet",   "Suppress message output")           { opts[:quiet] = true }
-  o.on("-V", "--version")                                      { puts "omqcat #{OMQ::VERSION}"; exit }
+  o.on("-V", "--version")                                      { require "omq"; puts "omqcat #{OMQ::VERSION}"; exit }
   o.on("-h", "--help")                                         { puts o; exit }
 end
 
@@ -114,16 +95,39 @@ end
 
 type_name = ARGV.shift
 abort parser.to_s unless type_name
-klass = SOCKET_TYPES[type_name.downcase]
-abort "Unknown socket type: #{type_name}. Known: #{SOCKET_TYPES.keys.join(', ')}" unless klass
+abort "Unknown socket type: #{type_name}. Known: #{SOCKET_TYPE_NAMES.join(', ')}" unless SOCKET_TYPE_NAMES.include?(type_name.downcase)
 
-# ── Validation ──────────────────────────────────────────────────────
+# ── Validation (fast, before loading gems) ──────────────────────────
 
 abort "At least one --connect or --bind is required"   if opts[:connects].empty? && opts[:binds].empty?
 abort "--data and --file are mutually exclusive"        if opts[:data] && opts[:file]
-abort "--subscribe is only valid for SUB"               if !opts[:subscribes].empty? && klass != OMQ::SUB
-abort "--identity is only valid for DEALER/ROUTER"      if opts[:identity] && ![OMQ::DEALER, OMQ::ROUTER].include?(klass)
-abort "--target is only valid for ROUTER"               if opts[:target] && klass != OMQ::ROUTER
+abort "--subscribe is only valid for SUB"               if !opts[:subscribes].empty? && type_name.downcase != "sub"
+abort "--identity is only valid for DEALER/ROUTER"      if opts[:identity] && !%w[dealer router].include?(type_name.downcase)
+abort "--target is only valid for ROUTER"               if opts[:target] && type_name.downcase != "router"
+
+# ── Load gems ───────────────────────────────────────────────────────
+
+require "omq"
+require "async"
+require "json"
+require "console"
+
+HAS_MSGPACK = begin; require "msgpack"; true; rescue LoadError; false; end
+HAS_ZSTD    = begin; require "zstd-ruby"; true; rescue LoadError; false; end
+
+SOCKET_TYPES = {
+  "req"    => OMQ::REQ,    "rep"    => OMQ::REP,
+  "pub"    => OMQ::PUB,    "sub"    => OMQ::SUB,
+  "push"   => OMQ::PUSH,   "pull"   => OMQ::PULL,
+  "pair"   => OMQ::PAIR,
+  "dealer" => OMQ::DEALER,  "router" => OMQ::ROUTER,
+}.freeze
+
+SEND_ONLY = [OMQ::PUB, OMQ::PUSH].freeze
+RECV_ONLY = [OMQ::SUB, OMQ::PULL].freeze
+
+klass = SOCKET_TYPES[type_name.downcase]
+
 abort "--msgpack requires the msgpack gem"              if opts[:format] == :msgpack && !HAS_MSGPACK
 abort "--compress requires the zstd-ruby gem"           if opts[:compress] && !HAS_ZSTD
 

data/lib/omq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OMQ
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

data/lib/omq/zmtp/transport/ipc.rb

@@ -35,7 +35,7 @@ module OMQ
                   engine.handle_accepted(IO::Stream::Buffered.wrap(client, minimum_write_size: 0), endpoint: endpoint)
                 rescue ProtocolError, *ZMTP::CONNECTION_LOST
                   # peer disconnected during handshake
-                rescue => e
+                rescue
                   client&.close rescue nil
                   raise
                 end

data/lib/omq/zmtp/transport/tcp.rb

@@ -32,7 +32,7 @@ module OMQ
                   engine.handle_accepted(IO::Stream::Buffered.wrap(client, minimum_write_size: 0), endpoint: resolved)
                 rescue ProtocolError, *ZMTP::CONNECTION_LOST
                   # peer disconnected during handshake
-                rescue => e
+                rescue
                   client&.close rescue nil
                   raise
                 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omq
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Patrik Wenger