amq-protocol 2.4.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d6619ef67f8b1e30048f898796d21854eae2a35dfdfe83286e0a5e894cbbf1c
-  data.tar.gz: 0d62824daba6da208b96b7681e4c1db4f5c32a93a7a8a7714b875b8ad8f603e2
+  metadata.gz: 7bd349803818e5eee9dbba49cdf59fad9666e8e7ed95229ed1bc7e7a4380fde5
+  data.tar.gz: b52bae3819d6fae2b2c6db5e1626ef6b98de74b0d24532b12f9a88ac75278ceb
 SHA512:
-  metadata.gz: cac00e1594a26adcb0863b6505ba789e8fce9a1dee3a38584e58cf838479661ba857a37ac3d747c69e7751549e15877a6478dd51559a8003af70c68e856badb1
-  data.tar.gz: 040e923fd9dcf5931a157007835085ec30b7ac44897c5a76ee05545f14f76cf431a3611f73fddb562e6bf9230fb82151fc808bfed24bc2244f12c85164541b6e
+  metadata.gz: 9a138a490585effe6886c7b16f4bb4c0a9d7f878358bca45ee437ae714ebcef4375b9f684651e593906db4d61dabd9468290ee3b75f1ca2810f8855f82e6942c
+  data.tar.gz: 7f64f831d2cdca5885ab08967c3700519acf90c327307e79bac757a58b56d3a02acc3bbd41731a456b52f9b92f0678a1d5c7d0c68eff94febb09bc0b45239ded

data/ChangeLog.md

@@ -1,12 +1,19 @@
-## Changes between 2.4.0 and 2.5.0 (in development)
+## Changes between 2.5.0 and 2.5.1 (Jan 1, 2026)
 
-No changes yet.
+### Windows Installation Fixes
 
-## Changes between 2.3.4 and 2.4.0 (Dec 30, 2025)
+`2.4.0` and `2.5.0` versions unintentionally included files that were
+symlinks, which caused installation on Windows to fail.
+
+
+## Changes between 2.4.0 and 2.5.0 (Dec 31, 2025)
 
-### Bug Fixes
+### Additional Consumer Hot Path Optimizations
 
- * Fixed `BadResponseError` constructor which referenced undefined variable `data` instead of `actual`
+A few more decode method optimizations for consumer delivery code paths.
+
+
+## Changes between 2.3.4 and 2.4.0 (Dec 30, 2025)
 
 ### Performance Improvements
 

data/lib/amq/protocol/client.rb

@@ -1569,30 +1569,31 @@ module AMQ
         0x0004,
       ]
 
+      # Optimized decode_properties using getbyte and unpack1
       def self.decode_properties(data)
         offset, data_length, properties = 0, data.bytesize, {}
 
-        compressed_index = data[offset, 2].unpack(PACK_UINT16)[0]
+        compressed_index = data.byteslice(offset, 2).unpack1(PACK_UINT16)
         offset += 2
         while data_length > offset
           DECODE_PROPERTIES_KEYS.each do |key|
             next unless compressed_index >= key
             compressed_index -= key
-            name = DECODE_PROPERTIES[key] || raise(RuntimeError.new("No property found for index #{index.inspect}!"))
+            name = DECODE_PROPERTIES[key] || raise(RuntimeError.new("No property found for index #{key.inspect}!"))
             case DECODE_PROPERTIES_TYPE[key]
             when :shortstr
-              size = data[offset, 1].unpack(PACK_CHAR)[0]
+              size = data.getbyte(offset)
               offset += 1
-              result = data[offset, size]
+              result = data.byteslice(offset, size)
             when :octet
               size = 1
-              result = data[offset, size].unpack(PACK_CHAR).first
+              result = data.getbyte(offset)
             when :timestamp
               size = 8
-              result = Time.at(data[offset, size].unpack(PACK_UINT64_BE).last)
+              result = Time.at(data.byteslice(offset, 8).unpack1(PACK_UINT64_BE))
             when :table
-              size = 4 + data[offset, 4].unpack(PACK_UINT32)[0]
-              result = Table.decode(data[offset, size])
+              size = 4 + data.byteslice(offset, 4).unpack1(PACK_UINT32)
+              result = Table.decode(data.byteslice(offset, size))
             end
             properties[name] = result
             offset += size
@@ -1688,13 +1689,11 @@ module AMQ
         @index = 0x003C0015 # 60, 21, 3932181
         @packed_indexes = [60, 21].pack(PACK_UINT16_X2).freeze
 
+        # Optimized decode using getbyte
         # @return
         def self.decode(data)
-          offset = offset = 0 # self-assigning offset to eliminate "assigned but unused variable" warning even if offset is not used in this method
-          length = data[offset, 1].unpack(PACK_CHAR).first
-          offset += 1
-          consumer_tag = data[offset, length]
-          offset += length
+          length = data.getbyte(0)
+          consumer_tag = data.byteslice(1, length)
           self.new(consumer_tag)
         end
 
@@ -1866,26 +1865,25 @@ module AMQ
         @index = 0x003C003C # 60, 60, 3932220
         @packed_indexes = [60, 60].pack(PACK_UINT16_X2).freeze
 
+        # Optimized decode using getbyte and unpack1 for better performance
         # @return
         def self.decode(data)
-          offset = offset = 0 # self-assigning offset to eliminate "assigned but unused variable" warning even if offset is not used in this method
-          length = data[offset, 1].unpack(PACK_CHAR).first
+          offset = 0
+          length = data.getbyte(offset)
           offset += 1
-          consumer_tag = data[offset, length]
+          consumer_tag = data.byteslice(offset, length)
           offset += length
-          delivery_tag = AMQ::Pack.unpack_uint64_big_endian(data[offset, 8]).first
+          delivery_tag = data.byteslice(offset, 8).unpack1(PACK_UINT64_BE)
           offset += 8
-          bit_buffer = data[offset, 1].unpack(PACK_CHAR).first
+          redelivered = (data.getbyte(offset) & 1) != 0
           offset += 1
-          redelivered = (bit_buffer & (1 << 0)) != 0
-          length = data[offset, 1].unpack(PACK_CHAR).first
+          length = data.getbyte(offset)
           offset += 1
-          exchange = data[offset, length]
+          exchange = data.byteslice(offset, length)
           offset += length
-          length = data[offset, 1].unpack(PACK_CHAR).first
+          length = data.getbyte(offset)
           offset += 1
-          routing_key = data[offset, length]
-          offset += length
+          routing_key = data.byteslice(offset, length)
           self.new(consumer_tag, delivery_tag, redelivered, exchange, routing_key)
         end
 
@@ -2009,14 +2007,11 @@ module AMQ
         @index = 0x003C0050 # 60, 80, 3932240
         @packed_indexes = [60, 80].pack(PACK_UINT16_X2).freeze
 
+        # Optimized decode using unpack1 and getbyte
         # @return
         def self.decode(data)
-          offset = offset = 0 # self-assigning offset to eliminate "assigned but unused variable" warning even if offset is not used in this method
-          delivery_tag = AMQ::Pack.unpack_uint64_big_endian(data[offset, 8]).first
-          offset += 8
-          bit_buffer = data[offset, 1].unpack(PACK_CHAR).first
-          offset += 1
-          multiple = (bit_buffer & (1 << 0)) != 0
+          delivery_tag = data.byteslice(0, 8).unpack1(PACK_UINT64_BE)
+          multiple = (data.getbyte(8) & 1) != 0
           self.new(delivery_tag, multiple)
         end
 
@@ -2141,15 +2136,13 @@ module AMQ
         @index = 0x003C0078 # 60, 120, 3932280
         @packed_indexes = [60, 120].pack(PACK_UINT16_X2).freeze
 
+        # Optimized decode using unpack1 and getbyte
         # @return
         def self.decode(data)
-          offset = offset = 0 # self-assigning offset to eliminate "assigned but unused variable" warning even if offset is not used in this method
-          delivery_tag = AMQ::Pack.unpack_uint64_big_endian(data[offset, 8]).first
-          offset += 8
-          bit_buffer = data[offset, 1].unpack(PACK_CHAR).first
-          offset += 1
-          multiple = (bit_buffer & (1 << 0)) != 0
-          requeue = (bit_buffer & (1 << 1)) != 0
+          delivery_tag = data.byteslice(0, 8).unpack1(PACK_UINT64_BE)
+          bit_buffer = data.getbyte(8)
+          multiple = (bit_buffer & 1) != 0
+          requeue = (bit_buffer & 2) != 0
           self.new(delivery_tag, multiple, requeue)
         end
 

data/lib/amq/protocol/frame.rb

@@ -60,9 +60,11 @@ This functionality is part of the https://github.com/ruby-amqp/amq-client librar
         EOF
       end
 
+      # Optimized header decode using unpack1 for single values where appropriate
       def self.decode_header(header)
         raise EmptyResponseError if header == nil || header.empty?
 
+        # Use unpack for multiple values - this is the optimal approach
         type_id, channel, size = header.unpack(PACK_CHAR_UINT16_UINT32)
         type = TYPES_REVERSE[type_id]
         raise FrameTypeError.new(TYPES_OPTIONS) unless type

data/lib/amq/protocol/version.rb

@@ -1,5 +1,5 @@
 module AMQ
   module Protocol
-    VERSION = "2.4.0"
+    VERSION = "2.5.1"
   end # Protocol
 end # AMQ

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amq-protocol
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Jakub Stastny
@@ -10,7 +10,7 @@ authors:
 - Mark Abramov
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-01-20 00:00:00.000000000 Z
 dependencies: []
 description: |2
     amq-protocol is an AMQP 0.9.1 serialization library for Ruby. It is not a
@@ -22,32 +22,9 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".gitmodules"
-- ".rspec"
-- ".travis.yml"
 - ChangeLog.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- amq-protocol.gemspec
-- benchmarks/frame_encoding.rb
-- benchmarks/int_allocator.rb
-- benchmarks/method_encoding.rb
-- benchmarks/pack_unpack.rb
-- benchmarks/pure/body_framing_with_256k_payload.rb
-- benchmarks/pure/body_framing_with_2k_payload.rb
-- benchmarks/run_all.rb
-- benchmarks/table_encoding.rb
-- codegen/__init__.py
-- codegen/amqp_0.9.1_changes.json
-- codegen/codegen.py
-- codegen/codegen_helpers.py
-- codegen/protocol.rb.pytemplate
-- generate.rb
 - lib/amq/bit_set.rb
 - lib/amq/endianness.rb
 - lib/amq/int_allocator.rb
@@ -65,32 +42,6 @@ files:
 - lib/amq/protocol/version.rb
 - lib/amq/settings.rb
 - lib/amq/uri.rb
-- profiling/README.md
-- profiling/stackprof/body_framing_with_2k_payload.rb
-- spec/amq/bit_set_spec.rb
-- spec/amq/endianness_spec.rb
-- spec/amq/int_allocator_spec.rb
-- spec/amq/pack_spec.rb
-- spec/amq/protocol/basic_spec.rb
-- spec/amq/protocol/blank_body_encoding_spec.rb
-- spec/amq/protocol/channel_spec.rb
-- spec/amq/protocol/confirm_spec.rb
-- spec/amq/protocol/connection_spec.rb
-- spec/amq/protocol/constants_spec.rb
-- spec/amq/protocol/exceptions_spec.rb
-- spec/amq/protocol/exchange_spec.rb
-- spec/amq/protocol/float_32bit_spec.rb
-- spec/amq/protocol/frame_spec.rb
-- spec/amq/protocol/method_spec.rb
-- spec/amq/protocol/queue_spec.rb
-- spec/amq/protocol/table_spec.rb
-- spec/amq/protocol/tx_spec.rb
-- spec/amq/protocol/value_decoder_spec.rb
-- spec/amq/protocol/value_encoder_spec.rb
-- spec/amq/protocol_spec.rb
-- spec/amq/settings_spec.rb
-- spec/amq/uri_parsing_spec.rb
-- spec/spec_helper.rb
 homepage: http://github.com/ruby-amqp/amq-protocol
 licenses:
 - MIT
@@ -109,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.6.2
 specification_version: 4
 summary: AMQP 0.9.1 encoding & decoding library.
 test_files: []

data/.github/ISSUE_TEMPLATE.md

@@ -1,18 +0,0 @@
-## Does This Really Belong to GitHub issues?
-
-If you find a bug you understand well, poor default, incorrect or unclear piece of documentation,
-or missing feature, please [file an
-issue](http://github.com/ruby-amqp/bunny/issues) on GitHub.
-
-Please use [Bunny's mailing list](http://groups.google.com/group/ruby-amqp) for questions,
-investigations, and discussions. GitHub issues should be used for specific, well understood, actionable
-maintainers and contributors can work on.
-
-When filing an issue, please specify
-
- * Which Bunny and RabbitMQ versions are used
- * Recent RabbitMQ log file contents
- * Full exception stack traces
- * Steps to reproduce or a failing test case
-
-This would greatly help the maintainers help you.

data/.github/workflows/ci.yml

@@ -1,31 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - "main"
-  pull_request:
-    branches:
-      - "main"
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        ruby-version:
-          - "3.4.2"
-          - "3.3.7"
-          - "3.2.7"
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby ${{ matrix.ruby-version }}
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-      - name: Install dependencies
-        run: bundle install
-      - name: Run tests
-        run: bundle exec rspec -c

data/.gitignore

@@ -1,18 +0,0 @@
-/*.gem
-/.rvmrc
-/.ruby-version
-tmp
-*.pyc
-*.iml
-.idea
-/vendor/bundle
-/vendor/amq-*
-/coverage
-Gemfile.lock
-.rbx/*
-.Apple*
-.bundle/*
-bin/*
-*.bundle
-Makefile
-profiling/dumps/*

data/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "codegen/rabbitmq-codegen"]
-	path = codegen/rabbitmq-codegen
-	url = git://github.com/rabbitmq/rabbitmq-codegen.git

data/.rspec

@@ -1 +0,0 @@
---require spec_helper

data/.travis.yml

@@ -1,17 +0,0 @@
-dist: bionic
-language: ruby
-bundler_args: --without development
-cache: bundler
-script: "bundle exec rspec spec"
-rvm:
-  - ruby-head
-  - "2.6.3"
-  - "2.5.5"
-  - "2.4.5"
-  - "2.3.8"
-notifications:
-  recipients:
-    - michael@rabbitmq.com
-matrix:
-  allow_failures:
-    - rvm: ruby-head

data/Gemfile

@@ -1,27 +0,0 @@
-# encoding: utf-8
-
-source "https://rubygems.org"
-
-
-group :development do
-  # excludes Windows, Rubinius and JRuby
-  gem "ruby-prof", :platforms => [:mri_19, :mri_20, :mri_21]
-
-  gem "rake"
-end
-
-group :benchmark do
-  gem "benchmark-ips", "~> 2.12"
-  gem "benchmark-memory", "~> 0.2"
-end
-
-group :test do
-  gem "rspec", ">= 3.8.0"
-  gem "rspec-its"
-  gem "simplecov"
-  gem 'bigdecimal'
-end
-
-group :development, :test do
-  gem "byebug"
-end

data/Rakefile

@@ -1,55 +0,0 @@
-require "bundler"
-Bundler.setup
-
-require "rake"
-require "rspec/core/rake_task"
-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "amq/protocol/version"
-
-task :gem => :build
-task :build do
-  system "gem build amq-protocol.gemspec"
-end
-
-task :install => :build do
-  system "gem install amq-protocol-#{AMQ::Protocol::VERSION}.gem"
-end
-
-def extension
-  RUBY_PLATFORM =~ /darwin/ ? "bundle" : "so"
-end
-
-def compile!
-  puts "Compiling native extensions..."
-  Dir.chdir(Pathname(__FILE__).dirname + "ext/") do
-    `bundle exec ruby extconf.rb`
-    `make`
-    `cp client.#{extension} ../lib/amq/protocol/native/`
-  end
-end
-
-RSpec::Core::RakeTask.new("spec") do |spec|
-  spec.pattern = "spec/**/*_spec.rb"
-end
-
-RSpec::Core::RakeTask.new("clean_spec") do |spec|
-  spec.pattern = "spec/**/*_spec.rb"
-end
-
-task :compile do
-  compile!
-end
-
-task :clean do
-  puts "Cleaning out native extensions..."
-  begin
-    Dir.chdir(Pathname(__FILE__).dirname + "lib/amq-protocol/native") do
-      `rm client.#{extension}`
-    end
-  rescue Exception => e
-    puts e.message
-  end
-end
-
-task :default => [:compile, :spec, :clean, :clean_spec]

data/amq-protocol.gemspec

@@ -1,27 +0,0 @@
-#!/usr/bin/env gem build
-# encoding: utf-8
-
-require "base64"
-
-require File.expand_path("../lib/amq/protocol/version", __FILE__)
-
-Gem::Specification.new do |s|
-  s.name = "amq-protocol"
-  s.version = AMQ::Protocol::VERSION
-  s.authors = ["Jakub Stastny", "Michael S. Klishin", "Theo Hultberg", "Mark Abramov"]
-  s.homepage = "http://github.com/ruby-amqp/amq-protocol"
-  s.summary = "AMQP 0.9.1 encoding & decoding library."
-  s.description = <<-DESC
-  amq-protocol is an AMQP 0.9.1 serialization library for Ruby. It is not a
-  client: the library only handles serialization and deserialization.
-  DESC
-  s.email = ["michael.s.klishin@gmail.com"]
-  s.licenses    = ["MIT"]
-  s.required_ruby_version = Gem::Requirement.new(">= 2.2")
-
-  # files
-  s.files = `git ls-files`.split("\n").reject { |file| file =~ /^vendor\// }
-  s.require_paths = ["lib"]
-
-  s.extra_rdoc_files = ["README.md"] + Dir.glob("doc/*")
-end

data/benchmarks/frame_encoding.rb

@@ -1,75 +0,0 @@
-#!/usr/bin/env ruby
-# encoding: utf-8
-# frozen_string_literal: true
-
-$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
-
-require "amq/protocol/client"
-require "benchmark/ips"
-
-puts
-puts "-" * 80
-puts "Frame Encoding Benchmarks on #{RUBY_DESCRIPTION}"
-puts "-" * 80
-
-# Test data
-SMALL_PAYLOAD = "x" * 100
-MEDIUM_PAYLOAD = "x" * 1024
-LARGE_PAYLOAD = "x" * 16384
-
-CHANNEL = 1
-
-Benchmark.ips do |x|
-  x.config(time: 5, warmup: 2)
-
-  x.report("Frame.encode(:method, small)") do
-    AMQ::Protocol::Frame.encode(:method, SMALL_PAYLOAD, CHANNEL)
-  end
-
-  x.report("Frame.encode(:method, medium)") do
-    AMQ::Protocol::Frame.encode(:method, MEDIUM_PAYLOAD, CHANNEL)
-  end
-
-  x.report("Frame.encode(:body, large)") do
-    AMQ::Protocol::Frame.encode(:body, LARGE_PAYLOAD, CHANNEL)
-  end
-
-  x.report("MethodFrame.new + encode") do
-    frame = AMQ::Protocol::MethodFrame.new(SMALL_PAYLOAD, CHANNEL)
-    frame.encode
-  end
-
-  x.report("BodyFrame.new + encode") do
-    frame = AMQ::Protocol::BodyFrame.new(MEDIUM_PAYLOAD, CHANNEL)
-    frame.encode
-  end
-
-  x.report("HeartbeatFrame.encode") do
-    AMQ::Protocol::HeartbeatFrame.encode
-  end
-
-  x.compare!
-end
-
-puts
-puts "-" * 80
-puts "Frame Header Decoding"
-puts "-" * 80
-
-# Encoded frame headers
-METHOD_HEADER = [1, 0, 1, 0, 0, 0, 100].pack("CnN")  # type=1, channel=1, size=100
-BODY_HEADER = [3, 0, 5, 0, 0, 16, 0].pack("CnN")     # type=3, channel=5, size=4096
-
-Benchmark.ips do |x|
-  x.config(time: 5, warmup: 2)
-
-  x.report("Frame.decode_header (method)") do
-    AMQ::Protocol::Frame.decode_header(METHOD_HEADER)
-  end
-
-  x.report("Frame.decode_header (body)") do
-    AMQ::Protocol::Frame.decode_header(BODY_HEADER)
-  end
-
-  x.compare!
-end

data/benchmarks/int_allocator.rb

@@ -1,34 +0,0 @@
-$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
-
-require 'amq/int_allocator'
-require "benchmark"
-
-allocator = AMQ::IntAllocator.new(1,65535)
-mutex = Mutex.new
-
-Benchmark.bm do |x|
-
-
-  x.report("allocate") do
-    allocator = AMQ::IntAllocator.new(1,65535)
-    1.upto(65534) do |i|
-      mutex.synchronize do
-        n = allocator.allocate
-        raise 'it be broke' unless n == i
-      end
-    end
-  end
-
-  x.report("allocate_with_release") do
-    allocator = AMQ::IntAllocator.new(1,65535)
-    1.upto(65534) do |i|
-      mutex.synchronize do
-        n = allocator.allocate
-        if i % 5 == 0
-          allocator.release(n)
-        end
-      end
-    end
-  end
-
-end