rdkafka 0.24.2-aarch64-linux-gnu → 0.25.1-aarch64-linux-gnu

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc0c11225b1bfbd6973f5996df200d4a005c6ab8a30e603e8e703cb41c254a59
-  data.tar.gz: 186086ab53ab1153aee63fbdb54aaf8bfc020afe9eec351b13664c61910234d5
+  metadata.gz: cb4d5531f159f367ce708bf7f673ac532f3abc4b252cb27cc8c8048ee40f5469
+  data.tar.gz: d7470b6f2eb99a44750dcd9703e39d7f978764e4ab281c1ed4090c9d7834a6c0
 SHA512:
-  metadata.gz: 62f9c4c201c116572a40593c144cb33691808c60990832af4b30610a7ad3798d9405f207ef2bf308ebbab82dbfd32560f4142a524c01b7a71bf167b7eef5bf48
-  data.tar.gz: 643c4132f91354fba5e1e07504b93ee451b18efd90318582629fcea7d9ea1e3642b4fc15e5cf67e1c8cdbe596b01c9fc4443a7bc37b805b51c63898673073555
+  metadata.gz: 8c767c43a9bb81d866423289f79695d46f78e4e4afc85f5d5e8ae8444a2835ddb7381455463fccfcb60ec3759b0bdc9c8abcc974bfd26d440ba1ddee35cbec7a
+  data.tar.gz: 2721303ffa4c4bdcdd1a9c11ec13153003202e91968fd22fc882c24cd4efbc6c75ba093d1c43ba0047d0d3bb9aaca6f858a45177895516186db4bc35087d4685

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Rdkafka Changelog
 
+## 0.25.1 (2026-02-26)
+- [Enhancement] Use native ARM64 runners instead of QEMU emulation for Alpine musl aarch64 builds, improving build performance and reliability.
+- [Enhancement] Enable parallel compilation (`make -j$(nproc)`) for ARM64 Alpine musl builds.
+- [Enhancement] Add file descriptor API for fiber scheduler integration. Expose `enable_queue_io_events` and `enable_background_queue_io_events` on `Consumer`, `Producer`, and `Admin` to enable non-blocking monitoring with select/poll/epoll for integration with Ruby fiber schedulers (Falcon, Async) and custom event loops.
+- [Enhancement] Add non-blocking poll methods (`poll_nb`, `events_poll_nb`) on `Consumer` that skip GVL release for efficient fiber scheduler integration when using `poll(0)`.
+- [Enhancement] Add `events_poll_nb_each` method on `Producer`, `Consumer`, and `Admin` for polling events in a single GVL/mutex session. Yields count after each iteration, caller returns `:stop` to break.
+- [Enhancement] Add `poll_nb_each` method on `Consumer` for non-blocking message polling with proper resource cleanup, yielding each message and supporting early termination via `:stop` return value.
+
+## 0.25.0 (2026-01-20)
+- **[Deprecation]** `AbstractHandle#wait` parameter `max_wait_timeout:` (seconds) is deprecated in favor of `max_wait_timeout_ms:` (milliseconds). The old parameter still works but will be removed in v1.0.0.
+- **[Deprecation]** `PartitionsCountCache` constructor parameter `ttl` (seconds) is deprecated in favor of `ttl_ms:` (milliseconds). The old parameter still works but will be removed in v1.0.0.
+- [Enhancement] Extract all timeout defaults to `Rdkafka::Defaults` module for discoverability and per-call overrides (#310). All time-related values are now in milliseconds for consistency.
+- [Enhancement] Add `timeout_ms` parameter to `Consumer#each` for configurable poll timeout.
+- [Enhancement] Extract non-time configuration values (`METADATA_MAX_RETRIES`, `PARTITIONS_COUNT_CACHE_TTL_MS`) to `Rdkafka::Defaults` module.
+- [Enhancement] Bump librdkafka to `2.12.1`
+- [Enhancement] Add descriptive error messages for glibc compatibility issues with instructions for resolution (#654)
+- [Enhancement] Replace magic numbers with named constants throughout codebase for improved readability and maintainability
+
 ## 0.24.2 (2025-10-31)
 - [Enhancement] Force lock FFI to 1.17.1 or higher to include critical bug fixes around GCC, write barriers, and thread restarts for forks.
 - [Fix] Fix for Core dump when providing extensions to oauthbearer_set_token (dssjoblom)

data/Gemfile

@@ -3,3 +3,11 @@
 source "https://rubygems.org"
 
 gemspec
+
+group :development do
+  gem "ostruct"
+  gem "pry"
+  gem "rspec"
+  gem "simplecov"
+  gem "warning"
+end

data/Gemfile.lint

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Documentation linting
+gem "yard-lint"
+
+# Code style (StandardRB via RuboCop)
+gem "standard"
+gem "standard-performance"
+gem "rubocop-performance"
+gem "rubocop-rspec"
+gem "standard-rspec"
+gem "rubocop-thread_safety"

data/Gemfile.lint.lock

@@ -0,0 +1,123 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    json (2.18.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.10.1)
+      ast (~> 2.4.1)
+      racc
+    prism (1.8.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    regexp_parser (2.11.3)
+    rubocop (1.82.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-capybara (2.22.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-factory_bot (2.28.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rspec (3.9.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
+    rubocop-rspec_rails (2.32.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+      rubocop-rspec (~> 3.5)
+    rubocop-thread_safety (0.7.3)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.53.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.82.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.9.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.26.0)
+    standard-rspec (0.3.1)
+      lint_roller (>= 1.0)
+      rubocop-capybara (~> 2.22)
+      rubocop-factory_bot (~> 2.27)
+      rubocop-rspec (~> 3.5)
+      rubocop-rspec_rails (~> 2.31)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    yard (0.9.38)
+    yard-lint (1.4.0)
+      yard (~> 0.9)
+      zeitwerk (~> 2.6)
+    zeitwerk (2.7.4)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  rubocop-performance
+  rubocop-rspec
+  rubocop-thread_safety
+  standard
+  standard-performance
+  standard-rspec
+  yard-lint
+
+CHECKSUMS
+  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  json (2.18.0) sha256=b10506aee4183f5cf49e0efc48073d7b75843ce3782c68dbeb763351c08fd505
+  language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
+  lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  parallel (1.27.0) sha256=4ac151e1806b755fb4e2dc2332cbf0e54f2e24ba821ff2d3dcf86bf6dc4ae130
+  parser (3.3.10.1) sha256=06f6a725d2cd91e5e7f2b7c32ba143631e1f7c8ae2fb918fc4cebec187e6a688
+  prism (1.8.0) sha256=84453a16ef5530ea62c5f03ec16b52a459575ad4e7b9c2b360fd8ce2c39c1254
+  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
+  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
+  regexp_parser (2.11.3) sha256=ca13f381a173b7a93450e53459075c9b76a10433caadcb2f1180f2c741fc55a4
+  rubocop (1.82.1) sha256=09f1a6a654a960eda767aebea33e47603080f8e9c9a3f019bf9b94c9cab5e273
+  rubocop-ast (1.49.0) sha256=49c3676d3123a0923d333e20c6c2dbaaae2d2287b475273fddee0c61da9f71fd
+  rubocop-capybara (2.22.1) sha256=ced88caef23efea53f46e098ff352f8fc1068c649606ca75cb74650970f51c0c
+  rubocop-factory_bot (2.28.0) sha256=4b17fc02124444173317e131759d195b0d762844a71a29fe8139c1105d92f0cb
+  rubocop-performance (1.26.1) sha256=cd19b936ff196df85829d264b522fd4f98b6c89ad271fa52744a8c11b8f71834
+  rubocop-rspec (3.9.0) sha256=8fa70a3619408237d789aeecfb9beef40576acc855173e60939d63332fdb55e2
+  rubocop-rspec_rails (2.32.0) sha256=4a0d641c72f6ebb957534f539d9d0a62c47abd8ce0d0aeee1ef4701e892a9100
+  rubocop-thread_safety (0.7.3) sha256=067cdd52fbf5deffc18995437e45b5194236eaff4f71de3375a1f6052e48f431
+  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  standard (1.53.0) sha256=f3c9493385db7079d0abce6f7582f553122156997b81258cd361d3480eeacf9c
+  standard-custom (1.0.2) sha256=424adc84179a074f1a2a309bb9cf7cd6bfdb2b6541f20c6bf9436c0ba22a652b
+  standard-performance (1.9.0) sha256=49483d31be448292951d80e5e67cdcb576c2502103c7b40aec6f1b6e9c88e3f2
+  standard-rspec (0.3.1) sha256=67bc957281cacf24f0d88235ca1bf28a8995265b1a60eb519cd0451858b56a22
+  unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42
+  unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f
+  yard (0.9.38) sha256=721fb82afb10532aa49860655f6cc2eaa7130889df291b052e1e6b268283010f
+  yard-lint (1.4.0) sha256=7dd88fbb08fd77cb840bea899d58812817b36d92291b5693dd0eeb3af9f91f0f
+  zeitwerk (2.7.4) sha256=2bef90f356bdafe9a6c2bd32bcd804f83a4f9b8bc27f3600fff051eb3edcec8b
+
+BUNDLED WITH
+  4.0.3

data/README.md

@@ -163,7 +163,8 @@ bundle exec rake produce_messages
 
 | rdkafka-ruby | librdkafka | patches |
 |-|-|-|
-| 0.24.x (Unreleased) | 2.11.1 (2025-08-08) | yes |
+| 0.25.x (2026-01-21) | 2.12.1 (2025-10-21) | yes |
+| 0.24.x (2025-10-10) | 2.11.1 (2025-08-18) | yes |
 | 0.23.x (2025-09-04) | 2.11.0 (2025-07-03) | yes |
 | 0.22.x (2025-07-17) | 2.8.0 (2025-01-07)  | yes |
 | 0.21.x (2025-02-13) | 2.8.0 (2025-01-07)  | yes |

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 require "./lib/rdkafka"
 
-desc 'Generate some message traffic'
+desc "Generate some message traffic"
 task :produce_messages do
-  config = {:"bootstrap.servers" => "localhost:9092"}
+  config = { "bootstrap.servers": "localhost:9092" }
   if ENV["DEBUG"]
     config[:debug] = "broker,topic,msg"
   end
@@ -15,24 +15,24 @@ task :produce_messages do
   100.times do |i|
     puts "Producing message #{i}"
     delivery_handles << producer.produce(
-        topic:   "rake_test_topic",
-        payload: "Payload #{i} from Rake",
-        key:     "Key #{i} from Rake"
+      topic: "rake_test_topic",
+      payload: "Payload #{i} from Rake",
+      key: "Key #{i} from Rake"
     )
   end
-  puts 'Waiting for delivery'
+  puts "Waiting for delivery"
   delivery_handles.each(&:wait)
-  puts 'Done'
+  puts "Done"
 end
 
-desc 'Consume some messages'
+desc "Consume some messages"
 task :consume_messages do
   config = {
-    :"bootstrap.servers" => "localhost:9092",
-    :"group.id" => "rake_test",
-    :"enable.partition.eof" => false,
-    :"auto.offset.reset" => "earliest",
-    :"statistics.interval.ms" => 10_000
+    "bootstrap.servers": "localhost:9092",
+    "group.id": "rake_test",
+    "enable.partition.eof": false,
+    "auto.offset.reset": "earliest",
+    "statistics.interval.ms": 10_000
   }
   if ENV["DEBUG"]
     config[:debug] = "cgrp,topic,fetch"
@@ -40,7 +40,7 @@ task :consume_messages do
   Rdkafka::Config.statistics_callback = lambda do |stats|
     puts stats
   end
-  consumer = Rdkafka::Config.new(config).consumer
+  Rdkafka::Config.new(config).consumer
   consumer = Rdkafka::Config.new(config).consumer
   consumer.subscribe("rake_test_topic")
   consumer.each do |message|
@@ -48,14 +48,14 @@ task :consume_messages do
   end
 end
 
-desc 'Hammer down'
+desc "Hammer down"
 task :load_test do
   puts "Starting load test"
 
   config = Rdkafka::Config.new(
-    :"bootstrap.servers" => "localhost:9092",
-    :"group.id" => "load-test",
-    :"enable.partition.eof" => false
+    "bootstrap.servers": "localhost:9092",
+    "group.id": "load-test",
+    "enable.partition.eof": false
   )
 
   # Create a producer in a thread
@@ -65,9 +65,9 @@ task :load_test do
       handles = []
       1000.times do |i|
         handles.push(producer.produce(
-          topic:   "load_test_topic",
+          topic: "load_test_topic",
           payload: "Payload #{i}",
-          key:     "Key #{i}"
+          key: "Key #{i}"
         ))
       end
       handles.each(&:wait)

data/docker-compose-ssl.yml

@@ -1,7 +1,7 @@
 services:
   kafka:
     container_name: kafka
-    image: confluentinc/cp-kafka:8.1.0
+    image: confluentinc/cp-kafka:8.1.1
     ports:
       - 9092:9092 # Support PLAINTEXT so we can run one docker setup for SSL and PLAINTEXT
       - 9093:9093

data/docker-compose.yml

@@ -1,7 +1,7 @@
 services:
   kafka:
     container_name: kafka
-    image: confluentinc/cp-kafka:8.1.0
+    image: confluentinc/cp-kafka:8.1.1
 
     ports:
       - 9092:9092

data/lib/rdkafka/abstract_handle.rb

@@ -54,16 +54,34 @@ module Rdkafka
     # If there is a timeout this does not mean the operation failed, rdkafka might still be working
     # on the operation. In this case it is possible to call wait again.
     #
-    # @param max_wait_timeout [Numeric, nil] Amount of time to wait before timing out.
-    #   If this is nil we will wait forever
+    # @param max_wait_timeout [Numeric, nil] DEPRECATED: Use max_wait_timeout_ms instead.
+    #   Amount of time in seconds to wait before timing out. Will be removed in v1.0.0.
+    # @param max_wait_timeout_ms [Numeric, nil] Amount of time in milliseconds to wait before
+    #   timing out. If this is nil we will wait forever. Defaults to 60,000ms (60 seconds).
     # @param raise_response_error [Boolean] should we raise error when waiting finishes
     #
     # @return [Object] Operation-specific result
     #
     # @raise [RdkafkaError] When the operation failed
     # @raise [WaitTimeoutError] When the timeout has been reached and the handle is still pending
-    def wait(max_wait_timeout: 60, raise_response_error: true)
-      timeout = max_wait_timeout ? monotonic_now + max_wait_timeout : MAX_WAIT_TIMEOUT_FOREVER
+    def wait(max_wait_timeout: :not_provided, max_wait_timeout_ms: :not_provided, raise_response_error: true)
+      # Determine which timeout value to use
+      if max_wait_timeout != :not_provided && max_wait_timeout_ms != :not_provided
+        warn "DEPRECATION WARNING: Both max_wait_timeout and max_wait_timeout_ms were provided. " \
+             "Using max_wait_timeout_ms. The max_wait_timeout parameter is deprecated and will be removed in v1.0.0."
+        timeout_ms = max_wait_timeout_ms
+      elsif max_wait_timeout != :not_provided
+        warn "DEPRECATION WARNING: max_wait_timeout (seconds) is deprecated. " \
+             "Use max_wait_timeout_ms (milliseconds) instead. This parameter will be removed in v1.0.0."
+        timeout_ms = max_wait_timeout ? (max_wait_timeout * 1000).to_i : nil
+      elsif max_wait_timeout_ms == :not_provided
+        timeout_ms = Defaults::HANDLE_WAIT_TIMEOUT_MS
+      else
+        timeout_ms = max_wait_timeout_ms
+      end
+
+      timeout_s = timeout_ms ? timeout_ms / 1000.0 : nil
+      timeout = timeout_s ? monotonic_now + timeout_s : MAX_WAIT_TIMEOUT_FOREVER
 
       @mutex.synchronize do
         loop do
@@ -74,7 +92,7 @@ module Rdkafka
               @resource.wait(@mutex, to_wait)
             else
               raise WaitTimeoutError.new(
-                "Waiting for #{operation_name} timed out after #{max_wait_timeout} seconds"
+                "Waiting for #{operation_name} timed out after #{timeout_ms} ms"
               )
             end
           elsif self[:response] != 0 && raise_response_error

data/lib/rdkafka/admin/acl_binding_result.rb

@@ -3,17 +3,17 @@
 module Rdkafka
   class Admin
     # Extracts attributes of rd_kafka_AclBinding_t
-    #
     class AclBindingResult
       attr_reader :result_error, :error_string, :matching_acl_resource_type,
-                  :matching_acl_resource_name, :matching_acl_resource_pattern_type,
-                  :matching_acl_principal, :matching_acl_host, :matching_acl_operation,
-                  :matching_acl_permission_type
+        :matching_acl_resource_name, :matching_acl_resource_pattern_type,
+        :matching_acl_principal, :matching_acl_host, :matching_acl_operation,
+        :matching_acl_permission_type
 
       # This attribute was initially released under the name that is now an alias
       # We keep it for backwards compatibility but it was changed for the consistency
-      alias matching_acl_pattern_type matching_acl_resource_pattern_type
+      alias_method :matching_acl_pattern_type, :matching_acl_resource_pattern_type
 
+      # @param matching_acl [FFI::Pointer] pointer to the ACL binding struct
       def initialize(matching_acl)
         rd_kafka_error_pointer = Rdkafka::Bindings.rd_kafka_AclBinding_error(matching_acl)
         @result_error = Rdkafka::Bindings.rd_kafka_error_code(rd_kafka_error_pointer)

data/lib/rdkafka/admin/config_resource_binding_result.rb

@@ -6,6 +6,7 @@ module Rdkafka
     class ConfigResourceBindingResult
       attr_reader :name, :type, :configs, :configs_count
 
+      # @param config_resource_ptr [FFI::Pointer] pointer to the config resource struct
       def initialize(config_resource_ptr)
         ffi_binding = Bindings::ConfigResource.new(config_resource_ptr)
 

data/lib/rdkafka/admin/create_acl_handle.rb

@@ -2,10 +2,11 @@
 
 module Rdkafka
   class Admin
+    # Handle for create ACL operation
     class CreateAclHandle < AbstractHandle
       layout :pending, :bool,
-             :response, :int,
-             :response_string, :pointer
+        :response, :int,
+        :response_string, :pointer
 
       # @return [String] the name of the operation
       def operation_name
@@ -17,10 +18,12 @@ module Rdkafka
         CreateAclReport.new(rdkafka_response: self[:response], rdkafka_response_string: self[:response_string])
       end
 
+      # Raises an error if the operation failed
+      # @raise [RdkafkaError]
       def raise_error
         raise RdkafkaError.new(
-            self[:response],
-            broker_message: self[:response_string].read_string
+          self[:response],
+          broker_message: self[:response_string].read_string
         )
       end
     end

data/lib/rdkafka/admin/create_acl_report.rb

@@ -2,17 +2,18 @@
 
 module Rdkafka
   class Admin
+    # Report for create ACL operation result
     class CreateAclReport
-
       # Upon successful creation of Acl RD_KAFKA_RESP_ERR_NO_ERROR - 0 is returned as rdkafka_response
       # @return [Integer]
       attr_reader :rdkafka_response
 
-
       # Upon successful creation of Acl empty string will be returned as rdkafka_response_string
       # @return [String]
       attr_reader :rdkafka_response_string
 
+      # @param rdkafka_response [Integer] response code from librdkafka
+      # @param rdkafka_response_string [FFI::Pointer] pointer to response string
       def initialize(rdkafka_response:, rdkafka_response_string:)
         @rdkafka_response = rdkafka_response
         if rdkafka_response_string != FFI::Pointer::NULL

data/lib/rdkafka/admin/create_partitions_handle.rb

@@ -1,10 +1,11 @@
 module Rdkafka
   class Admin
+    # Handle for create partitions operation
     class CreatePartitionsHandle < AbstractHandle
       layout :pending, :bool,
-             :response, :int,
-             :error_string, :pointer,
-             :result_name, :pointer
+        :response, :int,
+        :error_string, :pointer,
+        :result_name, :pointer
 
       # @return [String] the name of the operation
       def operation_name
@@ -16,10 +17,12 @@ module Rdkafka
         CreatePartitionsReport.new(self[:error_string], self[:result_name])
       end
 
+      # Raises an error if the operation failed
+      # @raise [RdkafkaError]
       def raise_error
         raise RdkafkaError.new(
-            self[:response],
-            broker_message: CreateTopicReport.new(self[:error_string], self[:result_name]).error_string
+          self[:response],
+          broker_message: CreateTopicReport.new(self[:error_string], self[:result_name]).error_string
         )
       end
     end

data/lib/rdkafka/admin/create_partitions_report.rb

@@ -1,5 +1,6 @@
 module Rdkafka
   class Admin
+    # Report for create partitions operation result
     class CreatePartitionsReport < CreateTopicReport
     end
   end

data/lib/rdkafka/admin/create_topic_handle.rb

@@ -2,11 +2,12 @@
 
 module Rdkafka
   class Admin
+    # Handle for create topic operation
     class CreateTopicHandle < AbstractHandle
       layout :pending, :bool,
-             :response, :int,
-             :error_string, :pointer,
-             :result_name, :pointer
+        :response, :int,
+        :error_string, :pointer,
+        :result_name, :pointer
 
       # @return [String] the name of the operation
       def operation_name
@@ -18,10 +19,12 @@ module Rdkafka
         CreateTopicReport.new(self[:error_string], self[:result_name])
       end
 
+      # Raises an error if the operation failed
+      # @raise [RdkafkaError]
       def raise_error
         raise RdkafkaError.new(
-            self[:response],
-            broker_message: CreateTopicReport.new(self[:error_string], self[:result_name]).error_string
+          self[:response],
+          broker_message: CreateTopicReport.new(self[:error_string], self[:result_name]).error_string
         )
       end
     end

data/lib/rdkafka/admin/create_topic_report.rb

@@ -2,6 +2,7 @@
 
 module Rdkafka
   class Admin
+    # Report for create topic operation result
     class CreateTopicReport
       # Any error message generated from the CreateTopic
       # @return [String]
@@ -11,6 +12,8 @@ module Rdkafka
       # @return [String]
       attr_reader :result_name
 
+      # @param error_string [FFI::Pointer] pointer to error string
+      # @param result_name [FFI::Pointer] pointer to topic name
       def initialize(error_string, result_name)
         if error_string != FFI::Pointer::NULL
           @error_string = error_string.read_string

data/lib/rdkafka/admin/delete_acl_handle.rb

@@ -2,12 +2,13 @@
 
 module Rdkafka
   class Admin
+    # Handle for delete ACL operation
     class DeleteAclHandle < AbstractHandle
       layout :pending, :bool,
-             :response, :int,
-             :response_string, :pointer,
-             :matching_acls, :pointer,
-             :matching_acls_count, :int
+        :response, :int,
+        :response_string, :pointer,
+        :matching_acls, :pointer,
+        :matching_acls_count, :int
 
       # @return [String] the name of the operation
       def operation_name
@@ -19,10 +20,12 @@ module Rdkafka
         DeleteAclReport.new(matching_acls: self[:matching_acls], matching_acls_count: self[:matching_acls_count])
       end
 
+      # Raises an error if the operation failed
+      # @raise [RdkafkaError]
       def raise_error
         raise RdkafkaError.new(
-            self[:response],
-            broker_message: self[:response_string].read_string
+          self[:response],
+          broker_message: self[:response_string].read_string
         )
       end
     end

data/lib/rdkafka/admin/delete_acl_report.rb

@@ -2,16 +2,18 @@
 
 module Rdkafka
   class Admin
+    # Report for delete ACL operation result
     class DeleteAclReport
-
       # deleted acls
       # @return [Rdkafka::Bindings::AclBindingResult]
       attr_reader :deleted_acls
 
+      # @param matching_acls [FFI::Pointer] pointer to matching ACLs array
+      # @param matching_acls_count [Integer] number of matching ACLs
       def initialize(matching_acls:, matching_acls_count:)
-        @deleted_acls=[]
+        @deleted_acls = []
         if matching_acls != FFI::Pointer::NULL
-          acl_binding_result_pointers  = matching_acls.read_array_of_pointer(matching_acls_count)
+          acl_binding_result_pointers = matching_acls.read_array_of_pointer(matching_acls_count)
           (1..matching_acls_count).map do |matching_acl_index|
             acl_binding_result = AclBindingResult.new(acl_binding_result_pointers[matching_acl_index - 1])
             @deleted_acls << acl_binding_result

data/lib/rdkafka/admin/delete_groups_handle.rb

@@ -2,25 +2,30 @@
 
 module Rdkafka
   class Admin
+    # Handle for delete groups operation
     class DeleteGroupsHandle < AbstractHandle
       layout :pending, :bool, # TODO: ???
-             :response, :int,
-             :error_string, :pointer,
-             :result_name, :pointer
+        :response, :int,
+        :error_string, :pointer,
+        :result_name, :pointer
 
       # @return [String] the name of the operation
       def operation_name
         "delete groups"
       end
 
+      # Creates the result report
+      # @return [DeleteGroupsReport]
       def create_result
         DeleteGroupsReport.new(self[:error_string], self[:result_name])
       end
 
+      # Raises an error if the operation failed
+      # @raise [RdkafkaError]
       def raise_error
         raise RdkafkaError.new(
-            self[:response],
-            broker_message: create_result.error_string
+          self[:response],
+          broker_message: create_result.error_string
         )
       end
     end

data/lib/rdkafka/admin/delete_groups_report.rb

@@ -2,6 +2,7 @@
 
 module Rdkafka
   class Admin
+    # Report for delete groups operation result
     class DeleteGroupsReport
       # Any error message generated from the DeleteTopic
       # @return [String]
@@ -11,6 +12,8 @@ module Rdkafka
       # @return [String]
       attr_reader :result_name
 
+      # @param error_string [FFI::Pointer] pointer to error string
+      # @param result_name [FFI::Pointer] pointer to group name
       def initialize(error_string, result_name)
         if error_string != FFI::Pointer::NULL
           @error_string = error_string.read_string