YARD order and funding reference (#350)

* update readme

* align yard tags order and add funding reference

Author: mensfeld

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ['https://karafka.io/#become-pro']

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Rdkafka Changelog
 
 ## 0.15.0 (Unreleased)
+- **[Feature]** Add Create and Delete ACL Feature To Admin Functions (vgnanasekaran)
 - [Enhancement] Bump librdkafka to 2.3.0 (mensfeld)
 - [Enhancement] Increase the `#lag` and `#query_watermark_offsets` default timeouts from 100ms to 1000ms. This will compensate for network glitches and remote clusters operations (mensfeld)
 

lib/rdkafka/admin.rb

@@ -195,9 +195,10 @@ def delete_topic(topic_name)
     #        valid values are:
     #           RD_KAFKA_ACL_PERMISSION_TYPE_DENY  = 2
     #           RD_KAFKA_ACL_PERMISSION_TYPE_ALLOW = 3
-    # @raise [RdkafkaError]
     #
     # @return [CreateAclHandle] Create acl handle that can be used to wait for the result of creating the acl
+    #
+    # @raise [RdkafkaError]
     def create_acl(resource_type:, resource_name:, resource_pattern_type:, principal:, host:, operation:, permission_type:)
       closed_admin_check(__method__)
 
@@ -300,9 +301,9 @@ def create_acl(resource_type:, resource_name:, resource_pattern_type:, principal
     #        valid values are:
     #           RD_KAFKA_ACL_PERMISSION_TYPE_DENY  = 2
     #           RD_KAFKA_ACL_PERMISSION_TYPE_ALLOW = 3
-    # @raise [RdkafkaError]
-    #
     # @return [DeleteAclHandle] Delete acl handle that can be used to wait for the result of deleting the acl
+    #
+    # @raise [RdkafkaError]
     def delete_acl(resource_type:, resource_name:, resource_pattern_type:, principal:, host:, operation:, permission_type:)
       closed_admin_check(__method__)
 
@@ -407,9 +408,9 @@ def delete_acl(resource_type:, resource_name:, resource_pattern_type:, principal
     #        valid values are:
     #           RD_KAFKA_ACL_PERMISSION_TYPE_DENY  = 2
     #           RD_KAFKA_ACL_PERMISSION_TYPE_ALLOW = 3
-    # @raise [RdkafkaError]
-    #
     # @return [DescribeAclHandle] Describe acl handle that can be used to wait for the result of fetching acls
+    #
+    # @raise [RdkafkaError]
     def describe_acl(resource_type:, resource_name:, resource_pattern_type:, principal:, host:, operation:, permission_type:)
       closed_admin_check(__method__)
 

lib/rdkafka/consumer.rb

@@ -259,9 +259,9 @@ def committed(list=nil, timeout_ms=1200)
     #
     # @param list [TopicPartitionList, nil] The topic with partitions to get the offsets for or nil to use the current subscription.
     #
-    # @raise [RdkafkaError] When getting the positions fails.
-    #
     # @return [TopicPartitionList]
+    #
+    # @raise [RdkafkaError] When getting the positions fails.
     def position(list=nil)
       if list.nil?
         list = assignment
@@ -438,9 +438,9 @@ def seek(message)
     #
     # @param list [TopicPartitionList] The TopicPartitionList with timestamps instead of offsets
     #
-    # @raise [RdKafkaError] When the OffsetForTimes lookup fails
-    #
     # @return [TopicPartitionList]
+    #
+    # @raise [RdKafkaError] When the OffsetForTimes lookup fails
     def offsets_for_times(list, timeout_ms = 1000)
       closed_consumer_check(__method__)
 
@@ -537,9 +537,9 @@ def poll(timeout_ms)
     # If `enable.partition.eof` is turned on in the config this will raise an error when an eof is
     # reached, so you probably want to disable that when using this method of iteration.
     #
-    # @raise [RdkafkaError] When polling fails
     # @yieldparam message [Message] Received message
     # @return [nil]
+    # @raise [RdkafkaError] When polling fails
     def each
       loop do
         message = poll(250)
@@ -594,14 +594,15 @@ def each
     # @param bytes_threshold [Integer] Threshold number of total message bytes in the yielded array of messages
     # @param timeout_ms [Integer] max time to wait for up to max_items
     #
-    # @raise [RdkafkaError] When polling fails
-    #
-    # @yield [messages, pending_exception]
     # @yieldparam messages [Array] An array of received Message
     # @yieldparam pending_exception [Exception] normally nil, or an exception
+    #
+    # @yield [messages, pending_exception]
     # which will be propagated after processing of the partial batch is complete.
     #
     # @return [nil]
+    #
+    # @raise [RdkafkaError] When polling fails
     def each_batch(max_items: 100, bytes_threshold: Float::INFINITY, timeout_ms: 250, yield_on_error: false, &block)
       closed_consumer_check(__method__)
       slice = []

lib/rdkafka/consumer/headers.rb

@@ -20,7 +20,7 @@ def [](key)
       #
       # @private
       #
-      # @param [librdkakfa message] native_message
+      # @param [Rdkafka::Bindings::Message] native_message
       # @return [Hash<String, String>] headers Hash for the native_message
       # @raise [Rdkafka::RdkafkaError] when fail to read headers
       def self.from_native(native_message)

lib/rdkafka/consumer/topic_partition_list.rb

@@ -36,6 +36,11 @@ def empty?
       # Add a topic with optionally partitions to the list.
       # Calling this method multiple times for the same topic will overwrite the previous configuraton.
       #
+      # @param topic [String] The topic's name
+      # @param partitions [Array<Integer>, Range<Integer>, Integer] The topic's partitions or partition count
+      #
+      # @return [nil]
+      #
       # @example Add a topic with unassigned partitions
       #   tpl.add_topic("topic")
       #
@@ -45,10 +50,6 @@ def empty?
       # @example Add a topic with all topics up to a count
       #   tpl.add_topic("topic", 9)
       #
-      # @param topic [String] The topic's name
-      # @param partitions [Array<Integer>, Range<Integer>, Integer] The topic's partitions or partition count
-      #
-      # @return [nil]
       def add_topic(topic, partitions=nil)
         if partitions.nil?
           @data[topic.to_s] = nil
@@ -90,11 +91,11 @@ def ==(other)
 
       # Create a new topic partition list based of a native one.
       #
+      # @private
+      #
       # @param pointer [FFI::Pointer] Optional pointer to an existing native list. Its contents will be copied.
       #
       # @return [TopicPartitionList]
-      #
-      # @private
       def self.from_native_tpl(pointer)
         # Data to be moved into the tpl
         data = {}
@@ -127,8 +128,8 @@ def self.from_native_tpl(pointer)
       #
       # The pointer will be cleaned by `rd_kafka_topic_partition_list_destroy` when GC releases it.
       #
-      # @return [FFI::Pointer]
       # @private
+      # @return [FFI::Pointer]
       def to_native_tpl
         tpl = Rdkafka::Bindings.rd_kafka_topic_partition_list_new(count)
 

lib/rdkafka/producer.rb

@@ -165,9 +165,9 @@ def partition_count(topic)
     # @param timestamp [Time,Integer,nil] Optional timestamp of this message. Integer timestamp is in milliseconds since Jan 1 1970.
     # @param headers [Hash<String,String>] Optional message headers
     #
-    # @raise [RdkafkaError] When adding the message to rdkafka's queue failed
-    #
     # @return [DeliveryHandle] Delivery handle that can be used to wait for the result of producing this message
+    #
+    # @raise [RdkafkaError] When adding the message to rdkafka's queue failed
     def produce(topic:, payload: nil, key: nil, partition: nil, partition_key: nil, timestamp: nil, headers: nil)
       closed_producer_check(__method__)