deimos-ruby 2.2.0 → 2.2.2

data/lib/deimos/logging.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Deimos
   module Logging
     class << self
@@ -33,34 +35,33 @@ module Deimos
       end
 
       def _payloads(messages)
-
       end
 
-      def payload(m)
-        return nil if m.nil?
+      def payload(msg)
+        return nil if msg.nil?
 
-        if m.respond_to?(:payload)
-          m.payload
-        elsif m[:label]
-          m.dig(:label, :original_payload)
+        if msg.respond_to?(:payload)
+          msg.payload
+        elsif msg[:label]
+          msg.dig(:label, :original_payload)
         else
-          m[:payload]
+          msg[:payload]
         end
       end
 
-      def key(m)
-        return nil if m.nil?
+      def key(msg)
+        return nil if msg.nil?
 
-        if m.respond_to?(:payload) && m.payload
-          m.key || m.payload['message_id']
-        elsif m.respond_to?(:[])
-          if m[:label]
-            m.dig(:label, :original_key)
-          elsif m[:payload].is_a?(String)
-            m[:key] || m[:payload_key]
+        if msg.respond_to?(:payload) && msg.payload
+          msg.key || msg.payload['message_id']
+        elsif msg.respond_to?(:[])
+          if msg[:label]
+            msg.dig(:label, :original_key)
+          elsif msg[:payload].is_a?(String)
+            msg[:key] || msg[:payload_key]
           else
-            payload = m[:payload]&.with_indifferent_access
-            m[:key] || m[:payload_key] || payload[:payload_key] || payload[:message_id]
+            payload = msg[:payload]&.with_indifferent_access
+            msg[:key] || msg[:payload_key] || payload[:payload_key] || payload[:message_id]
           end
         end
       end

data/lib/deimos/message.rb

@@ -74,7 +74,7 @@ module Deimos
         partition_key: @partition_key || @key,
         payload: @payload,
         metadata: {
-          decoded_payload: @payload,
+          decoded_payload: @payload
         }
       }.delete_if { |k, v| k == :headers && v.nil? }
     end

data/lib/deimos/metrics/minimal_datadog_listener.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'karafka/instrumentation/vendors/datadog/metrics_listener'
 require 'waterdrop/instrumentation/vendors/datadog/metrics_listener'
 
@@ -5,12 +7,23 @@ module Deimos
   module Metrics
     class MinimalDatadogListener < ::Karafka::Instrumentation::Vendors::Datadog::MetricsListener
       # override existing listener so we don't emit metrics we don't care about
-      def on_connection_listener_fetch_loop_received(_event); end
-      def on_consumer_revoked(_event); end
-      def on_consumer_shutdown(_event); end
-      def on_consumer_ticked(_event); end
-      def on_worker_process(_event); end
-      def on_worker_processed(_event); end
+      def on_connection_listener_fetch_loop_received(_event)
+      end
+
+      def on_consumer_revoked(_event)
+      end
+
+      def on_consumer_shutdown(_event)
+      end
+
+      def on_consumer_ticked(_event)
+      end
+
+      def on_worker_process(_event)
+      end
+
+      def on_worker_processed(_event)
+      end
     end
   end
 end

data/lib/deimos/metrics/provider.rb

@@ -8,7 +8,7 @@ module Deimos
       # @param metric_name [String] The name of the counter metric
       # @param options [Hash] Any additional options, e.g. :tags
       # @return [void]
-      def increment(metric_name, options={})
+      def increment(_metric_name, _options={})
         raise MissingImplementationError
       end
 
@@ -17,7 +17,7 @@ module Deimos
       # @param count [Integer]
       # @param options [Hash] Any additional options, e.g. :tags
       # @return [void]
-      def gauge(metric_name, count, options={})
+      def gauge(_metric_name, _count, _options={})
         raise MissingImplementationError
       end
 
@@ -26,7 +26,7 @@ module Deimos
       # @param count [Integer]
       # @param options [Hash] Any additional options, e.g. :tags
       # @return [void]
-      def histogram(metric_name, count, options={})
+      def histogram(_metric_name, _count, _options={})
         raise MissingImplementationError
       end
 
@@ -34,7 +34,7 @@ module Deimos
       # @param metric_name [String] The name of the metric
       # @param options [Hash] Any additional options, e.g. :tags
       # @return [void]
-      def time(metric_name, options={})
+      def time(_metric_name, _options={})
         raise MissingImplementationError
       end
     end

data/lib/deimos/producer.rb

@@ -80,7 +80,7 @@ module Deimos
       # @param headers [Hash] if specifying headers
       # @return [void]
       def publish(payload, topic: self.topic, headers: nil)
-        produce([{payload: payload, topic: topic, headers: headers}])
+        produce([{ payload: payload, topic: topic, headers: headers }])
       end
 
       # Produce a list of messages in WaterDrop message hash format.
@@ -141,6 +141,7 @@ module Deimos
         karafka_config&.name
       end
 
+      # rubocop:disable Style/OptionalBooleanParameter
       # @param sync [Boolean]
       # @param force_send [Boolean]
       # @return [Class<Deimos::Backends::Base>]
@@ -157,6 +158,7 @@ module Deimos
         end
         "Deimos::Backends::#{backend.to_s.classify}".constantize
       end
+      # rubocop:enable Style/OptionalBooleanParameter
 
       # Send a batch to the backend.
       # @param backend [Class<Deimos::Backends::Base>]

data/lib/deimos/railtie.rb

@@ -3,7 +3,7 @@
 # Add rake task to Rails.
 class Deimos::Railtie < Rails::Railtie
   config.before_initialize do
-    if ARGV[0] == "deimos:v2"
+    if ARGV[0] == 'deimos:v2'
       FigTree.keep_removed_configs = true
     end
   end

data/lib/deimos/schema_backends/avro_base.rb

@@ -14,7 +14,7 @@ module Deimos
 
       # @override
       def initialize(schema:, namespace:)
-        super(schema: schema, namespace: namespace)
+        super
         @schema_store = AvroTurf::MutableSchemaStore.new(path: Deimos.config.schema.path)
       end
 

data/lib/deimos/schema_backends/avro_schema_coercer.rb

@@ -74,45 +74,64 @@ module Deimos
       val.keys.zip(record).to_h
     end
 
+    # @param type [Avro::Schema::RecordSchema]
+    # @param val [Object]
+    # @return [Integer]
+    def coerce_int(type, val)
+      int_classes = [Time, ActiveSupport::TimeWithZone]
+      if %w(timestamp-millis timestamp-micros).include?(type.logical_type)
+        val
+      elsif val.is_a?(Integer) ||
+            _is_integer_string?(val) ||
+            int_classes.any? { |klass| val.is_a?(klass) }
+        val.to_i
+      else # rubocop:disable Lint/DuplicateBranch
+        val # this will fail
+      end
+    end
+
+    # @param val [Object]
+    # @return [Float]
+    def coerce_float(val)
+      if val.is_a?(Numeric) || _is_float_string?(val)
+        val.to_f
+      else
+        val # this will fail
+      end
+    end
+
+    # @param val [Object]
+    # @return [String]
+    def coerce_string(val)
+      if val.respond_to?(:to_str) || _is_to_s_defined?(val)
+        val.to_s
+      else
+        val # this will fail
+      end
+    end
+
+    # @param val [Object]
+    # @return [Boolean]
+    def coerce_boolean(val) # rubocop:disable Naming/PredicateMethod
+      !(val.nil? || val == false)
+    end
+
     # Coerce values in a payload to match the schema.
     # @param type [Avro::Schema]
     # @param val [Object]
     # @return [Object]
     def coerce_type(type, val)
-      int_classes = [Time, ActiveSupport::TimeWithZone]
       field_type = type.type.to_sym
 
       case field_type
       when :int, :long
-        if %w(timestamp-millis timestamp-micros).include?(type.logical_type)
-          val
-        elsif val.is_a?(Integer) ||
-              _is_integer_string?(val) ||
-              int_classes.any? { |klass| val.is_a?(klass) }
-          val.to_i
-        else
-          val # this will fail
-        end
+        coerce_int(type, val)
       when :float, :double
-        if val.is_a?(Numeric) || _is_float_string?(val)
-          val.to_f
-        else
-          val # this will fail
-        end
+        coerce_float(val)
       when :string
-        if val.respond_to?(:to_str)
-          val.to_s
-        elsif _is_to_s_defined?(val)
-          val.to_s
-        else
-          val # this will fail
-        end
+        coerce_string(val)
       when :boolean
-        if val.nil? || val == false
-          false
-        else
-          true
-        end
+        coerce_boolean(val)
       when :union
         coerce_union(type, val)
       when :record

data/lib/deimos/schema_backends/avro_schema_registry.rb

@@ -22,14 +22,14 @@ module Deimos
       # @return [AvroTurf::Messaging]
       def avro_turf_messaging
          @avro_turf_messaging ||= AvroTurf::Messaging.new(
-          schema_store: @schema_store,
-          registry_url: Deimos.config.schema.registry_url,
-          schemas_path: Deimos.config.schema.path,
-          user: Deimos.config.schema.user,
-          password: Deimos.config.schema.password,
-          namespace: @namespace,
-          logger: Karafka.logger
-        )
+           schema_store: @schema_store,
+           registry_url: Deimos.config.schema.registry_url,
+           schemas_path: Deimos.config.schema.path,
+           user: Deimos.config.schema.user,
+           password: Deimos.config.schema.password,
+           namespace: @namespace,
+           logger: Karafka.logger
+         )
       end
     end
   end

data/lib/deimos/schema_backends/base.rb

@@ -107,7 +107,7 @@ module Deimos
       # To be defined by subclass.
       # @param schema [Object]
       # @return [String] A string representation of the Type
-      def self.field_type(schema)
+      def self.field_type(_schema)
         raise MissingImplementationError
       end
 
@@ -116,7 +116,7 @@ module Deimos
       # @param schema [String,Symbol]
       # @param topic [String]
       # @return [String]
-      def encode_payload(payload, schema:, topic: nil)
+      def encode_payload(_payload, schema:, topic: nil)
         raise MissingImplementationError
       end
 
@@ -124,7 +124,7 @@ module Deimos
       # @param payload [String]
       # @param schema [String,Symbol]
       # @return [Hash]
-      def decode_payload(payload, schema:)
+      def decode_payload(_payload, schema:)
         raise MissingImplementationError
       end
 
@@ -132,7 +132,7 @@ module Deimos
       # @param payload [Hash]
       # @param schema [String,Symbol]
       # @return [void]
-      def validate(payload, schema:)
+      def validate(_payload, schema:)
         raise MissingImplementationError
       end
 
@@ -148,7 +148,7 @@ module Deimos
       # @param field [SchemaField]
       # @param value [Object]
       # @return [Object]
-      def coerce_field(field, value)
+      def coerce_field(_field, _value)
         raise MissingImplementationError
       end
 
@@ -159,14 +159,14 @@ module Deimos
       # `:enum` is also recognized.
       # @param field [SchemaField]
       # @return [Symbol]
-      def sql_type(field)
+      def sql_type(_field)
         raise MissingImplementationError
       end
 
       # Generate a key schema from the given value schema and key ID. This
       # is used when encoding or decoding keys from an existing value schema.
       # @param field_name [Symbol]
-      def generate_key_schema(field_name)
+      def generate_key_schema(_field_name)
         raise MissingImplementationError
       end
 
@@ -175,7 +175,7 @@ module Deimos
       # @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 MissingImplementationError
       end
 
@@ -183,7 +183,7 @@ module Deimos
       # @param payload [Hash] the message itself.
       # @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 MissingImplementationError
       end
 

data/lib/deimos/schema_backends/plain.rb

@@ -34,7 +34,7 @@ module Deimos
       end
 
       # @override
-      def encode_key(key_id, key, topic: nil)
+      def encode_key(_key_id, key, topic: nil)
         key
       end
 

data/lib/deimos/schema_backends/proto_base.rb

@@ -23,7 +23,7 @@ module Deimos
         bytes: :string,
         float: :float,
         message: :record
-      }
+      }.freeze
       def proto_schema(schema=@schema)
         Google::Protobuf::DescriptorPool.generated_pool.lookup(schema)
       end
@@ -39,7 +39,11 @@ module Deimos
 
       # @override
       def decode_key(payload, key_id)
-        val = JSON.parse(payload) rescue payload
+        val = begin
+                JSON.parse(payload)
+        rescue StandardError
+                payload
+        end
         key_id ? val[key_id.to_s] : val
       end
 
@@ -81,12 +85,10 @@ module Deimos
         :mock
       end
 
-      def generate_key_schema(field_name)
+      def generate_key_schema(_field_name)
         raise 'Protobuf cannot generate key schemas! Please use field_config :plain'
       end
 
-    private
-
     end
   end
 end

data/lib/deimos/schema_backends/proto_local.rb

@@ -19,8 +19,6 @@ module Deimos
         proto_schema.msgclass.encode(msg)
       end
 
-    private
-
       # @return [ProtoTurf]
       def self.proto_turf
         @proto_turf ||= ProtoTurf.new(

data/lib/deimos/schema_backends/proto_schema_registry.rb

@@ -19,8 +19,6 @@ module Deimos
         self.class.proto_turf.encode(msg, subject: topic)
       end
 
-    private
-
       # @return [ProtoTurf]
       def self.proto_turf
         @proto_turf ||= ProtoTurf.new(

data/lib/deimos/schema_class/base.rb

@@ -47,7 +47,7 @@ module Deimos
       # Initializes this class from a given value
       # @param value [Object]
       # @return [SchemaClass::Base]
-      def self.initialize_from_value(value)
+      def self.initialize_from_value(_value)
         raise MissingImplementationError
       end
 

data/lib/deimos/schema_class/record.rb

@@ -78,9 +78,8 @@ module Deimos
       # @return [SchemaClass::Record]
       def self.new_from_message(**kwargs)
         record = self.new
-        attrs = kwargs.select { |k, v| record.respond_to?("#{k}=") }
-        record = self.new(_from_message: true, **attrs)
-        record
+        attrs = kwargs.select { |k, _v| record.respond_to?("#{k}=") }
+        self.new(_from_message: true, **attrs)
       end
 
       # @return [SchemaClass::Record]
@@ -89,6 +88,7 @@ module Deimos
         return nil if value.nil?
 
         return value if value.is_a?(self)
+
         if from_message
           self.new_from_message(**value&.symbolize_keys || {})
         else

data/lib/deimos/test_helpers.rb

@@ -12,6 +12,7 @@ module Deimos
   # and add methods to use to test encoding/decoding.
   module TestHelpers
     extend ActiveSupport::Concern
+
     def self.included(base)
       super
       base.include Karafka::Testing::RSpec::Helpers
@@ -38,7 +39,8 @@ module Deimos
       # @return [void]
       def unit_test!
         Deimos.config.schema.backend = :avro_validation
-        warn "unit_test! is deprecated and can be replaced by setting Deimos's schema backend to `:avro_validation`. All other test behavior is provided by Karafka."
+        warn("unit_test! is deprecated and can be replaced by setting Deimos's schema backend " \
+             'to `:avro_validation`. All other test behavior is provided by Karafka.')
       end
     end
 
@@ -60,16 +62,16 @@ module Deimos
       end
     end
 
-    def self.normalize_message(m)
-      return nil if m.nil?
+    def self.normalize_message(message)
+      return nil if message.nil?
 
-      if m.respond_to?(:to_h)
-        m = m.to_h
+      if message.respond_to?(:to_h)
+        message = message.to_h
       end
-      if m.respond_to?(:with_indifferent_access)
-        m = m.with_indifferent_access
+      if message.respond_to?(:with_indifferent_access)
+        message = message.with_indifferent_access
       end
-      m
+      message
     end
 
     # @!visibility private
@@ -80,11 +82,12 @@ module Deimos
       min_hash_diff = nil
       message = Deimos::TestHelpers.normalize_message(message)
       if messages.any?
-        message_string = messages.map { |m| m[:payload].inspect}.join("\n")
+        message_string = messages.map { |m| m[:payload].inspect }.join("\n")
         min_hash_diff = messages.min_by { |m| _hash_diff(m, message)&.keys&.size }
         diff = RSpec::Expectations.differ.diff_as_object(message, min_hash_diff[:payload])
       end
-      str = "Expected #{topic} #{'not ' if was_negated}to have sent #{message.try(:to_h) || message}"
+      printed_message = message.try(:to_h) || message
+      str = "Expected #{topic} #{'not ' if was_negated}to have sent #{printed_message}"
       str += " with key #{key}" if key
       str += " with partition key #{partition_key}" if partition_key
       str += "\nClosest message received: #{min_hash_diff}" if min_hash_diff
@@ -101,7 +104,9 @@ module Deimos
           return m[:payload] == message if message.is_a?(String)
 
           message.delete(:payload_key) if message.respond_to?(:[]) && message[:payload_key].nil?
-          m[:payload].delete(:payload_key) if m.respond_to?(:[]) && m[:payload]&.respond_to?(:[]) && m[:payload][:payload_key].nil?
+          if m.respond_to?(:[]) && m[:payload].respond_to?(:[]) && m[:payload][:payload_key].nil?
+            m[:payload].delete(:payload_key)
+          end
           hash_matcher.send(:match, message, m[:payload]) &&
             topic == m[:topic] &&
             (key.present? ? message_key == m[:key] : true) &&
@@ -128,7 +133,8 @@ module Deimos
     # particular messages were sent or not sent after a point in time.
     # @return [void]
     def clear_kafka_messages!
-      puts "[Deprecated] clear_kafka_messages! can be replaced with `karafka.produced_messages.clear`"
+      puts '[Deprecated] clear_kafka_messages! can be replaced with' \
+           '`karafka.produced_messages.clear`'
       karafka.produced_messages.clear
     end
 
@@ -150,7 +156,8 @@ module Deimos
                              partition_key: nil,
                              &block)
       unless call_original.nil?
-        puts "test_consume_message(call_original: true) is deprecated and will be removed in the future. You can remove the call_original parameter."
+        puts 'test_consume_message(call_original: true) is deprecated and will be removed' \
+             'in the future. You can remove the call_original parameter.'
       end
       test_consume_batch(handler_class_or_topic,
                          [payload],
@@ -177,36 +184,34 @@ module Deimos
                            keys: [],
                            call_original: nil,
                            single: false,
-                           partition_keys: [], &block)
+                           partition_keys: [])
       unless call_original.nil?
-        puts "test_consume_batch(call_original: true) is deprecated and will be removed in the future. You can remove the call_original parameter."
+        puts 'test_consume_batch(call_original: true) is deprecated and will be removed' \
+             'in the future. You can remove the call_original parameter.'
       end
       karafka.consumer_messages.clear
-      consumer = nil
-      topic_name = nil
-      if handler_class_or_topic.is_a?(String)
-        topic_name = handler_class_or_topic
-        consumer = karafka.consumer_for(topic_name)
-      else
-        topic_name = Deimos.topic_for_consumer(handler_class_or_topic)
-        consumer = karafka.consumer_for(topic_name)
+      topic_name = if handler_class_or_topic.is_a?(String)
+        handler_class_or_topic
+                   else
+        Deimos.topic_for_consumer(handler_class_or_topic)
       end
+      consumer = karafka.consumer_for(topic_name)
 
       Deimos.karafka_config_for(topic: topic_name).each_message(single)
 
       # don't record messages sent with test_consume_batch
       original_messages = karafka.produced_messages.dup
       payloads.each_with_index do |payload, i|
-       karafka.produce(payload, {key: keys[i], partition_key: partition_keys[i], topic: consumer.topic.name})
+       karafka.produce(payload, { key: keys[i], partition_key: partition_keys[i], topic: consumer.topic.name })
       end
       if block_given?
         if single
           allow(consumer).to receive(:consume_message) do
-           yield consumer.messages.first.payload, consumer.messages.first.as_json['metadata']
+           yield(consumer.messages.first.payload, consumer.messages.first.as_json['metadata'])
           end
         else
           allow(consumer).to receive(:consume_batch) do
-           yield consumer.messages
+           yield(consumer.messages)
           end
         end
       end

data/lib/deimos/tracing/provider.rb

@@ -8,14 +8,14 @@ module Deimos
       # @param span_name [String] The name of the span/trace
       # @param options [Hash] Options for the span
       # @return [Object] The span object
-      def start(span_name, options={})
+      def start(_span_name, _options={})
         raise MissingImplementationError
       end
 
       # Finishes the trace on the span object.
       # @param span [Object] The span to finish trace on
       # @return [void]
-      def finish(span)
+      def finish(_span)
         raise MissingImplementationError
       end
 
@@ -23,7 +23,7 @@ module Deimos
       # @param span [Object] The span to set error on
       # @param exception [Exception] The exception that occurred
       # @return [void]
-      def set_error(span, exception)
+      def set_error(_span, _exception)
         raise MissingImplementationError
       end
 
@@ -38,13 +38,13 @@ module Deimos
       # @param value [String]
       # @param span [Object]
       # @return [void]
-      def set_tag(tag, value, span=nil)
+      def set_tag(_tag, _value, _span=nil)
         raise MissingImplementationError
       end
 
       # Get a tag from a span with the specified tag.
       # @param tag [String]
-      def get_tag(tag)
+      def get_tag(_tag)
         raise MissingImplementationError
       end
 

data/lib/deimos/transcoder.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module Deimos
   class Transcoder
 
-    attr_accessor :key_field, :backend, :backend_type
+    attr_accessor :key_field, :backend_type
+    # @param backend [Class<Deimos::SchemaBackends::Base>]
+    attr_writer :backend
 
     # @param schema [String]
     # @param namespace [String]
@@ -18,7 +22,7 @@ module Deimos
       @topic = topic
     end
 
-    # @return [Class < Deimos::SchemaBackends::Base]
+    # @return [Class<Deimos::SchemaBackends::Base>]
     def backend
       @backend ||= Deimos.schema_backend(schema: @schema,
                                          namespace: @namespace,