deimos-ruby 1.16.3 → 1.16.4

data/lib/deimos/producer.rb

@@ -11,7 +11,8 @@ module Deimos
     # Run a block without allowing any messages to be produced to Kafka.
     # Optionally add a list of producer classes to limit the disabling to those
     # classes.
-    # @param producer_classes [Array<Class>|Class]
+    # @param producer_classes [Array<Class>, Class]
+    # @return [void]
     def disable_producers(*producer_classes, &block)
       if producer_classes.any?
         _disable_producer_classes(producer_classes, &block)
@@ -31,7 +32,7 @@ module Deimos
       end
     end
 
-    # :nodoc:
+    # @!visibility private
     def _disable_producer_classes(producer_classes)
       Thread.current[:frk_disabled_producers] ||= Set.new
       producers_to_disable = producer_classes -
@@ -43,6 +44,7 @@ module Deimos
 
     # Are producers disabled? If a class is passed in, check only that class.
     # Otherwise check if the global disable flag is set.
+    # @param producer_class [Class]
     # @return [Boolean]
     def producers_disabled?(producer_class=nil)
       Thread.current[:frk_disable_all_producers] ||
@@ -54,6 +56,7 @@ module Deimos
   class Producer
     include SharedConfig
 
+    # @return [Integer]
     MAX_BATCH_SIZE = 500
 
     class << self
@@ -87,19 +90,21 @@ module Deimos
       end
 
       # Publish the payload to the topic.
-      # @param payload [Hash|SchemaClass::Record] with an optional payload_key hash key.
+      # @param payload [Hash, SchemaClass::Record] with an optional payload_key hash key.
       # @param topic [String] if specifying the topic
+      # @return [void]
       def publish(payload, topic: self.topic)
         publish_list([payload], topic: topic)
       end
 
       # Publish a list of messages.
-      # @param payloads [Array<Hash|SchemaClass::Record>] with optional payload_key hash key.
+      # @param payloads [Array<Hash, SchemaClass::Record>] with optional payload_key hash key.
       # @param sync [Boolean] if given, override the default setting of
       # whether to publish synchronously.
       # @param force_send [Boolean] if true, ignore the configured backend
       # and send immediately to Kafka.
       # @param topic [String] if specifying the topic
+      # @return [void]
       def publish_list(payloads, sync: nil, force_send: false, topic: self.topic)
         return if Deimos.config.kafka.seed_brokers.blank? ||
                   Deimos.config.producers.disabled ||
@@ -124,7 +129,7 @@ module Deimos
 
       # @param sync [Boolean]
       # @param force_send [Boolean]
-      # @return [Class < Deimos::Backend]
+      # @return [Class<Deimos::Backends::Base>]
       def determine_backend_class(sync, force_send)
         backend = if force_send
                     :kafka
@@ -140,8 +145,9 @@ module Deimos
       end
 
       # Send a batch to the backend.
-      # @param backend [Class < Deimos::Backend]
+      # @param backend [Class<Deimos::Backends::Base>]
       # @param batch [Array<Deimos::Message>]
+      # @return [void]
       def produce_batch(backend, batch)
         backend.publish(producer_class: self, messages: batch)
       end

data/lib/deimos/schema_backends/base.rb

@@ -3,11 +3,19 @@
 module Deimos
   # Represents a field in the schema.
   class SchemaField
-    attr_accessor :name, :type, :enum_values, :default
+    # @return [String]
+    attr_accessor :name
+    # @return [String]
+    attr_accessor :type
+    # @return [Array<String>]
+    attr_accessor :enum_values
+    # @return [Object]
+    attr_accessor :default
 
     # @param name [String]
     # @param type [Object]
     # @param enum_values [Array<String>]
+    # @param default [Object]
     def initialize(name, type, enum_values=[], default=:no_default)
       @name = name
       @type = type
@@ -19,9 +27,14 @@ module Deimos
   module SchemaBackends
     # Base class for encoding / decoding.
     class Base
-      attr_accessor :schema, :namespace, :key_schema
+      # @return [String]
+      attr_accessor :schema
+      # @return [String]
+      attr_accessor :namespace
+      # @return [String]
+      attr_accessor :key_schema
 
-      # @param schema [String|Symbol]
+      # @param schema [String,Symbol]
       # @param namespace [String]
       def initialize(schema:, namespace: nil)
         @schema = schema
@@ -30,7 +43,7 @@ module Deimos
 
       # Encode a payload with a schema. Public method.
       # @param payload [Hash]
-      # @param schema [Symbol|String]
+      # @param schema [String,Symbol]
       # @param topic [String]
       # @return [String]
       def encode(payload, schema: nil, topic: nil)
@@ -40,7 +53,7 @@ module Deimos
 
       # Decode a payload with a schema. Public method.
       # @param payload [String]
-      # @param schema [Symbol|String]
+      # @param schema [String,Symbol]
       # @return [Hash,nil]
       def decode(payload, schema: nil)
         return nil if payload.nil?
@@ -90,25 +103,26 @@ module Deimos
 
       # Encode a payload. To be defined by subclass.
       # @param payload [Hash]
-      # @param schema [Symbol|String]
+      # @param schema [String,Symbol]
       # @param topic [String]
       # @return [String]
-      def encode_payload(_payload, schema:, topic: nil)
+      def encode_payload(payload, schema:, topic: nil)
         raise NotImplementedError
       end
 
       # Decode a payload. To be defined by subclass.
       # @param payload [String]
-      # @param schema [String|Symbol]
+      # @param schema [String,Symbol]
       # @return [Hash]
-      def decode_payload(_payload, schema:)
+      def decode_payload(payload, schema:)
         raise NotImplementedError
       end
 
       # Validate that a payload matches the schema. To be defined by subclass.
       # @param payload [Hash]
-      # @param schema [String|Symbol]
-      def validate(_payload, schema:)
+      # @param schema [String,Symbol]
+      # @return [void]
+      def validate(payload, schema:)
         raise NotImplementedError
       end
 
@@ -124,7 +138,7 @@ module Deimos
       # @param field [SchemaField]
       # @param value [Object]
       # @return [Object]
-      def coerce_field(_field, _value)
+      def coerce_field(field, value)
         raise NotImplementedError
       end
 
@@ -140,19 +154,19 @@ module Deimos
       end
 
       # Encode a message key. To be defined by subclass.
-      # @param key [String|Hash] the value to use as the key.
-      # @param key_id [Symbol|String] the field name of the key.
+      # @param key [String,Hash] the value to use as the key.
+      # @param key_id [String,Symbol] the field name of the key.
       # @param topic [String]
       # @return [String]
-      def encode_key(_key, _key_id, topic: nil)
+      def encode_key(key, key_id, topic: nil)
         raise NotImplementedError
       end
 
       # Decode a message key. To be defined by subclass.
       # @param payload [Hash] the message itself.
-      # @param key_id [Symbol|String] the field in the message to decode.
+      # @param key_id [String,Symbol] the field in the message to decode.
       # @return [String]
-      def decode_key(_payload, _key_id)
+      def decode_key(payload, key_id)
         raise NotImplementedError
       end
 

data/lib/deimos/schema_backends/mock.rb

@@ -15,7 +15,7 @@ module Deimos
       end
 
       # @override
-      def validate(_payload, schema:)
+      def validate(payload, schema:)
       end
 
       # @override
@@ -24,7 +24,7 @@ module Deimos
       end
 
       # @override
-      def coerce_field(_type, value)
+      def coerce_field(field, value)
         value
       end
 

data/lib/deimos/schema_class/base.rb

@@ -7,23 +7,26 @@ module Deimos
     # Base Class for Schema Classes generated from Avro.
     class Base
 
-      # :nodoc:
+      # @param _args [Array<Object>]
       def initialize(*_args)
       end
 
       # Converts the object to a hash which can be used for debugging or comparing objects.
+      # @param _opts [Hash]
       # @return [Hash] a hash representation of the payload
       def as_json(_opts={})
         raise NotImplementedError
       end
 
-      # @param key [String|Symbol]
+      # @param key [String,Symbol]
       # @param val [Object]
+      # @return [void]
       def []=(key, val)
         self.send("#{key}=", val)
       end
 
-      # :nodoc:
+      # @param other [SchemaClass::Base]
+      # @return [Boolean]
       def ==(other)
         comparison = other
         if other.class == self.class
@@ -33,7 +36,7 @@ module Deimos
         comparison == self.as_json
       end
 
-      # :nodoc:
+      # @return [String]
       def inspect
         klass = self.class
         "#{klass}(#{self.as_json})"
@@ -41,13 +44,14 @@ module Deimos
 
       # Initializes this class from a given value
       # @param value [Object]
+      # @return [SchemaClass::Base]
       def self.initialize_from_value(value)
         raise NotImplementedError
       end
 
     protected
 
-      # :nodoc:
+      # @return [Integer]
       def hash
         as_json.hash
       end

data/lib/deimos/schema_class/enum.rb

@@ -8,9 +8,11 @@ module Deimos
     # Base Class for Enum Classes generated from Avro.
     class Enum < Base
 
+      # @return [String]
       attr_accessor :value
 
       # @param other [Deimos::SchemaClass::Enum]
+      # @return [Boolean]
       def ==(other)
         other.is_a?(self.class) ? other.value == @value : other == @value
       end
@@ -31,12 +33,12 @@ module Deimos
         raise NotImplementedError
       end
 
-      # :nodoc:
+      # @return [String]
       def as_json(_opts={})
         @value
       end
 
-      # :nodoc:
+      # @return [SchemaClass::Enum]
       def self.initialize_from_value(value)
         return nil if value.nil?
 

data/lib/deimos/schema_class/record.rb

@@ -21,8 +21,8 @@ module Deimos
       end
 
       # Merge a hash or an identical schema object with this one and return a new object.
-      # @param other_hash [Hash|SchemaClasses::Base]
-      # @return [SchemaClasses::Base]
+      # @param other_hash [Hash,SchemaClass::Base]
+      # @return [SchemaClass::Base]
       def merge(other_hash)
         obj = self.class.new(**self.to_h.symbolize_keys)
         other_hash.to_h.each do |k, v|
@@ -32,13 +32,13 @@ module Deimos
       end
 
       # Element access method as if this Object were a hash
-      # @param key[String||Symbol]
+      # @param key[String,Symbol]
       # @return [Object] The value of the attribute if exists, nil otherwise
       def [](key)
         self.try(key.to_sym)
       end
 
-      # :nodoc
+      # @return [SchemaClass::Record]
       def with_indifferent_access
         self
       end
@@ -72,7 +72,7 @@ module Deimos
         validator.schema_fields.map(&:name)
       end
 
-      # :nodoc:
+      # @return [SchemaClass::Record]
       def self.initialize_from_value(value)
         return nil if value.nil?
 

data/lib/deimos/shared_config.rb

@@ -35,12 +35,14 @@ module Deimos
 
       # Set the schema.
       # @param schema [String]
+      # @return [void]
       def schema(schema)
         config[:schema] = schema
       end
 
       # Set the namespace.
       # @param namespace [String]
+      # @return [void]
       def namespace(namespace)
         config[:namespace] = namespace
       end
@@ -48,9 +50,10 @@ module Deimos
       # Set key configuration.
       # @param field [Symbol] the name of a field to use in the value schema as
       #   a generated key schema
-      # @param schema [String|Symbol] the name of a schema to use for the key
+      # @param schema [String, Symbol] the name of a schema to use for the key
       # @param plain [Boolean] if true, do not encode keys at all
       # @param none [Boolean] if true, do not use keys at all
+      # @return [void]
       def key_config(plain: nil, field: nil, schema: nil, none: nil)
         config[:key_configured] = true
         config[:no_keys] = none
@@ -59,7 +62,8 @@ module Deimos
         config[:key_schema] = schema
       end
 
-      # @param enabled [Boolean]
+      # @param use_schema_classes [Boolean]
+      # @return [void]
       def schema_class_config(use_schema_classes)
         config[:use_schema_classes] = use_schema_classes
       end

data/lib/deimos/test_helpers.rb

@@ -20,6 +20,7 @@ module Deimos
       end
 
       # Set the config to the right settings for a unit test
+      # @return [void]
       def unit_test!
         Deimos.configure do |deimos_config|
           deimos_config.logger = Logger.new(STDOUT)
@@ -31,6 +32,7 @@ module Deimos
       end
 
       # Kafka test config with avro schema registry
+      # @return [void]
       def full_integration_test!
         Deimos.configure do |deimos_config|
           deimos_config.producers.backend = :kafka
@@ -39,6 +41,7 @@ module Deimos
       end
 
       # Set the config to the right settings for a kafka test
+      # @return [void]
       def kafka_test!
         Deimos.configure do |deimos_config|
           deimos_config.producers.backend = :kafka
@@ -62,21 +65,25 @@ module Deimos
     end
 
     # @deprecated
+    # @!visibility private
     def stub_producers_and_consumers!
       warn('stub_producers_and_consumers! is no longer necessary and this method will be removed in 3.0')
     end
 
     # @deprecated
+    # @!visibility private
     def stub_producer(_klass)
       warn('Stubbing producers is no longer necessary and this method will be removed in 3.0')
     end
 
     # @deprecated
+    # @!visibility private
     def stub_consumer(_klass)
       warn('Stubbing consumers is no longer necessary and this method will be removed in 3.0')
     end
 
     # @deprecated
+    # @!visibility private
     def stub_batch_consumer(_klass)
       warn('Stubbing batch consumers is no longer necessary and this method will be removed in 3.0')
     end
@@ -84,6 +91,7 @@ module Deimos
     # get the difference of 2 hashes.
     # @param hash1 [Hash]
     # @param hash2 [Hash]
+    # @!visibility private
     def _hash_diff(hash1, hash2)
       if hash1.nil? || !hash1.is_a?(Hash)
         hash2
@@ -96,7 +104,7 @@ module Deimos
       end
     end
 
-    # :nodoc:
+    # @!visibility private
     def _frk_failure_message(topic, message, key=nil, partition_key=nil, was_negated=false)
       messages = Deimos::Backends::Test.sent_messages.
         select { |m| m[:topic] == topic }.
@@ -162,6 +170,7 @@ module Deimos
 
     # Clear all sent messages - e.g. if we want to check that
     # particular messages were sent or not sent after a point in time.
+    # @return [void]
     def clear_kafka_messages!
       Deimos::Backends::Test.sent_messages.clear
     end
@@ -170,15 +179,16 @@ module Deimos
     # that the schema is correct. If
     # a block is given, that block will be executed when `consume` is called.
     # Otherwise it will just confirm that `consume` is called at all.
-    # @param handler_class_or_topic [Class|String] Class which inherits from
+    # @param handler_class_or_topic [Class, String] Class which inherits from
     # Deimos::Consumer or the topic as a string
     # @param payload [Hash] the payload to consume
     # @param call_original [Boolean] if true, allow the consume handler
     # to continue as normal. Not compatible with a block.
-    # @param ignore_expectation [Boolean] Set to true to not place any
+    # @param skip_expectation [Boolean] Set to true to not place any
     # expectations on the consumer. Primarily used internally to Deimos.
     # @param key [Object] the key to use.
     # @param partition_key [Object] the partition key to use.
+    # @return [void]
     def test_consume_message(handler_class_or_topic,
                              payload,
                              call_original: false,
@@ -225,6 +235,7 @@ module Deimos
     # Check to see that a given message will fail due to validation errors.
     # @param handler_class [Class]
     # @param payload [Hash]
+    # @return [void]
     def test_consume_invalid_message(handler_class, payload)
       expect {
         handler_class.decoder.validate(payload,
@@ -236,9 +247,14 @@ module Deimos
     # i.e. that the schema is correct. If
     # a block is given, that block will be executed when `consume` is called.
     # Otherwise it will just confirm that `consume` is called at all.
-    # @param handler_class_or_topic [Class|String] Class which inherits from
+    # @param handler_class_or_topic [Class, String] Class which inherits from
     # Deimos::Consumer or the topic as a string
     # @param payloads [Array<Hash>] the payload to consume
+    # @param keys [Array<Hash,String>]
+    # @param partition_keys [Array<Integer>]
+    # @param call_original [Boolean]
+    # @param skip_expectation [Boolean]
+    # @return [void]
     def test_consume_batch(handler_class_or_topic,
                            payloads,
                            keys: [],
@@ -297,6 +313,7 @@ module Deimos
     # Check to see that a given message will fail due to validation errors.
     # @param handler_class [Class]
     # @param payloads [Array<Hash>]
+    # @return [void]
     def test_consume_batch_invalid_message(handler_class, payloads)
       topic_name = 'my-topic'
       handler = handler_class.new

data/lib/deimos/tracing/datadog.rb

@@ -6,7 +6,7 @@ module Deimos
   module Tracing
     # Tracing wrapper class for Datadog.
     class Datadog < Tracing::Provider
-      # :nodoc:
+      # @param config [Hash]
       def initialize(config)
         raise 'Tracing config must specify service_name' if config[:service_name].nil?
 

data/lib/deimos/tracing/mock.rb

@@ -6,13 +6,14 @@ module Deimos
   module Tracing
     # Class that mocks out tracing functionality
     class Mock < Tracing::Provider
-      # :nodoc:
+      # @param logger [Logger]
       def initialize(logger=nil)
         @logger = logger || Logger.new(STDOUT)
         @logger.info('MockTracingProvider initialized')
       end
 
-      # :nodoc:
+      # @param span_name [String]
+      # @param _options [Hash]
       def start(span_name, _options={})
         @logger.info("Mock span '#{span_name}' started")
         {
@@ -35,7 +36,7 @@ module Deimos
       end
 
       # :nodoc:
-      def set_tag(name, value)
+      def set_tag(tag, value, span=nil)
         nil
       end
 

data/lib/deimos/tracing/provider.rb

@@ -14,6 +14,7 @@ module Deimos
 
       # Finishes the trace on the span object.
       # @param span [Object] The span to finish trace on
+      # @return [void]
       def finish(span)
         raise NotImplementedError
       end
@@ -21,11 +22,13 @@ module Deimos
       # Set an error on the span.
       # @param span [Object] The span to set error on
       # @param exception [Exception] The exception that occurred
+      # @return [void]
       def set_error(span, exception)
         raise NotImplementedError
       end
 
       # Get the currently activated span.
+      # @return [Object]
       def active_span
         raise NotImplementedError
       end
@@ -33,6 +36,8 @@ module Deimos
       # Set a tag to a span. Use the currently active span if not given.
       # @param tag [String]
       # @param value [String]
+      # @param span [Object]
+      # @return [void]
       def set_tag(tag, value, span=nil)
         raise NotImplementedError
       end

data/lib/deimos/utils/db_poller.rb

@@ -7,12 +7,15 @@ module Deimos
   module Utils
     # Class which continually polls the database and sends Kafka messages.
     class DbPoller
+      # @return [Integer]
       BATCH_SIZE = 1000
 
       # Needed for Executor so it can identify the worker
+      # @return [Integer]
       attr_reader :id
 
       # Begin the DB Poller process.
+      # @return [void]
       def self.start!
         if Deimos.config.db_poller_objects.empty?
           raise('No pollers configured!')
@@ -28,7 +31,7 @@ module Deimos
         signal_handler.run!
       end
 
-      # @param config [Deimos::Configuration::ConfigStruct]
+      # @param config [FigTree::ConfigStruct]
       def initialize(config)
         @config = config
         @id = SecureRandom.hex
@@ -47,6 +50,7 @@ module Deimos
       # time we ran
       # 2) On a loop, process all the recent updates between the last time
       # we ran and now.
+      # @return [void]
       def start
         # Don't send asynchronously
         if Deimos.config.producers.backend == :kafka_async
@@ -66,6 +70,7 @@ module Deimos
       end
 
       # Grab the PollInfo or create if it doesn't exist.
+      # @return [void]
       def retrieve_poll_info
         ActiveRecord::Base.connection.reconnect! unless ActiveRecord::Base.connection.open_transactions.positive?
         new_time = @config.start_from_beginning ? Time.new(0) : Time.zone.now
@@ -76,6 +81,7 @@ module Deimos
       end
 
       # Stop the poll.
+      # @return [void]
       def stop
         Deimos.config.logger.info('Received signal to stop')
         @signal_to_stop = true
@@ -95,6 +101,7 @@ module Deimos
       end
 
       # Send messages for updated data.
+      # @return [void]
       def process_updates
         return unless should_run?
 
@@ -135,6 +142,7 @@ module Deimos
       end
 
       # @param batch [Array<ActiveRecord::Base>]
+      # @return [void]
       def process_batch(batch)
         record = batch.last
         id_method = record.class.primary_key