phobos 1.9.0 → 2.0.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23fbfe423e018ef76aa8fafaf4a5a4c09f5fef66a65a1a86dcc6a692fe95db46
-  data.tar.gz: e866cff9d6e8f8a8780b30b570343a9cd64bb4e25df9b5b632e82b21cb4c443e
+  metadata.gz: 646f966d9d307346090b88a3ef52f784da42f07a7f8fd3369131a4d1149fc293
+  data.tar.gz: 3631aef66014166e318f24b8b282265e0d3663ed006b915c49762301e8f02b89
 SHA512:
-  metadata.gz: 1ded112795f6f3b55e1a39d6c4b38b54aba09ad7e98b6421f31c11fc7e731b2ee9eaac7c08e8423cfbbc56a3f165904b83c7e6a5e16597498b734043ae6ecda6
-  data.tar.gz: 6169e4b4f2826de4afa43c80bd3ac9f8c24cbf9c00db5988a92075bbe3834579b7f0739fea0e679f4c54631a137c9ced2304dd2bd9316a38637d93281f026478
+  metadata.gz: c19eedfd196604f55ea659d501323cecfca50c4c53a03ae1193457f344e4a1e580bbd7ca2b33559b20ab2c1418143b48b6d9e4942986f71b369f4a9e261ccfeb
+  data.tar.gz: cdbd2146b341d91bb7131eb986e24055bf73054ed12eb542e09c9d2a56b4b462bd4d3015e5ee3a00934e4e125658e5438987b402aa2edb0ca2fac2172b098f58

data/CHANGELOG.md

@@ -6,13 +6,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ``
 ## UNRELEASED
 
+## [2.0.0-beta1] - 2020-5-04
+
+- Remove deprecated patterns:
+-- `before_consume` method
+-- `around_consume` as a class method or without yielding values
+-- `publish` and `async_publish` with positional arguments
+
 ## [1.9.0] - 2020-03-05
 - Bumped version to 1.9.0.
 
 ## [1.9.0-beta3] - 2020-02-05
+
 - Fix bug where deprecation errors would be shown when receiving nil payloads
   even if `around_consume` was updated to yield them.
 
+
 ## [1.9.0-beta2] - 2020-01-09
 
 - Allow `around_consume` to yield payload and metadata, and deprecate

data/README.md

@@ -21,7 +21,6 @@ With Phobos by your side, all this becomes smooth sailing.
 ## Table of Contents
 
 1. [Installation](#installation)
-  1. [Upgrade Notes](#upgrade-notes)
 1. [Usage](#usage)
   1. [Standalone apps](#usage-standalone-apps)
   1. [Consuming messages from Kafka](#usage-consuming-messages-from-kafka)
@@ -32,6 +31,7 @@ With Phobos by your side, all this becomes smooth sailing.
 1. [Plugins](#plugins)
 1. [Development](#development)
 1. [Test](#test)
+1. [Upgrade Notes](#upgrade-notes)
 
 ## <a name="installation"></a> Installation
 
@@ -53,10 +53,6 @@ Or install it yourself as:
 $ gem install phobos
 ```
 
-### <a name="upgrade-notes"></a> Upgrade Notes
-
-Version 1.8.2 introduced a new `persistent_connections` setting for regular producers. This reduces the number of connections used to produce messages and you should consider setting it to true. This does require a manual shutdown call -  please see [Producers with persistent connections](#persistent-connection).
-
 ## <a name="usage"></a> Usage
 
 Phobos can be used in two ways: as a standalone application or to support Kafka features in your existing project - including Rails apps. It provides a CLI tool to run it.
@@ -197,8 +193,6 @@ class MyHandler
 end
 ```
 
-Note: Previous versions used a `before_consume` method to pre-process the payload. This is still supported, but deprecated. Going forward, `around_consume` should yield the payload and metadata back to the calling code, allowing it to act as a pre-processor, e.g. by decoding Avro messages into Ruby hashes.
-
 Take a look at the examples folder for some ideas.
 
 The hander life cycle can be illustrated as:
@@ -287,8 +281,6 @@ my = MyProducer.new
 my.producer.publish(topic: 'topic', payload: 'message-payload', key: 'partition and message key', headers: { header_1: 'value 1' })
 ```
 
-Older versions of Phobos provided a `publish` method that accepted positional arguments. That version is still supported but it's soon to be deprecated in favour of the keyword arguments version.
-
 It is also possible to publish several messages at once:
 
 ```ruby
@@ -619,6 +611,57 @@ describe MyConsumer do
 end
 ```
 
+## <a name="upgrade-notes"></a> Upgrade Notes
+
+Version 2.0 removes deprecated ways of defining producers and consumers:
+* The `before_consume` method has been removed. You can have this behavior in the first part of an `around_consume` method.
+* `around_consume` is now only available as an instance method, and it must yield the values to pass to the `consume` method.
+* `publish` and `async_publish` now only accept keyword arguments, not positional arguments.
+
+Example pre-2.0:
+```ruby
+class MyHandler
+  include Phobos::Handler
+
+  def before_consume(payload, metadata)
+    payload[:id] = 1
+  end
+
+  def self.around_consume(payload, metadata)
+    metadata[:key] = 5
+    yield
+  end
+end
+```
+
+In 2.0:
+```ruby
+class MyHandler
+  include Phobos::Handler
+
+  def around_consume(payload, metadata)
+    new_payload = payload.dup
+    new_metadata = metadata.dup
+    new_payload[:id] = 1
+    new_metadata[:key] = 5
+    yield new_payload, new_metadata
+  end
+end
+```
+
+Producer, 1.9:
+```ruby
+  producer.publish('my-topic', { payload_value: 1}, 5, 3, {header_val: 5})
+```
+
+Producer 2.0:
+```ruby
+  producer.publish(topic: 'my-topic', payload: { payload_value: 1}, key: 5, 
+     partition_key: 3, headers: { header_val: 5})
+```
+
+Version 1.8.2 introduced a new `persistent_connections` setting for regular producers. This reduces the number of connections used to produce messages and you should consider setting it to true. This does require a manual shutdown call -  please see [Producers with persistent connections](#persistent-connection).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/klarna/phobos.

data/lib/phobos/actions/process_batch_inline.rb

@@ -47,32 +47,13 @@ module Phobos
         )
       end
 
-      def preprocess(batch, handler)
-        if handler.respond_to?(:before_consume_batch)
-          Phobos.deprecate('before_consume_batch is deprecated and will be removed in 2.0. \
-                            Use around_consume_batch and yield payloads and metadata objects.')
-          handler.before_consume_batch(batch, @metadata)
-        else
-          batch
-        end
-      end
-
       def process_batch(batch)
         instrument('listener.process_batch_inline', @metadata) do |_metadata|
           handler = @listener.handler_class.new
 
-          preprocessed_batch = preprocess(batch, handler)
-          consume_block = proc { |around_batch, around_metadata|
-            if around_batch
-              handler.consume_batch(around_batch, around_metadata)
-            else
-              Phobos.deprecate('Calling around_consume_batch without yielding payloads \
-                                and metadata is deprecated and will be removed in 2.0.')
-              handler.consume_batch(preprocessed_batch, @metadata)
-            end
-          }
-
-          handler.around_consume_batch(preprocessed_batch, @metadata, &consume_block)
+          handler.around_consume_batch(batch, @metadata) do |around_batch, around_metadata|
+            handler.consume_batch(around_batch, around_metadata)
+          end
         end
       end
     end

data/lib/phobos/actions/process_message.rb

@@ -35,47 +35,12 @@ module Phobos
 
       private
 
-      def preprocess(payload, handler)
-        if handler.respond_to?(:before_consume)
-          Phobos.deprecate('before_consume is deprecated and will be removed in 2.0. \
-                            Use around_consume and yield payload and metadata objects.')
-          begin
-            handler.before_consume(payload, @metadata)
-          rescue ArgumentError
-            handler.before_consume(payload)
-          end
-        else
-          payload
-        end
-      end
-
-      def consume_block(payload, handler)
-        proc { |around_payload, around_metadata|
-          if around_metadata
-            handler.consume(around_payload, around_metadata)
-          else
-            Phobos.deprecate('Calling around_consume without yielding payload and metadata \
-                              is deprecated and will be removed in 2.0.')
-            handler.consume(payload, @metadata)
-          end
-        }
-      end
-
       def process_message(payload)
         instrument('listener.process_message', @metadata) do
           handler = @listener.handler_class.new
 
-          preprocessed_payload = preprocess(payload, handler)
-          block = consume_block(preprocessed_payload, handler)
-
-          if @listener.handler_class.respond_to?(:around_consume)
-            # around_consume class method implementation
-            Phobos.deprecate('around_consume has been moved to instance method, please update '\
-                             'your consumer. This will not be backwards compatible in the future.')
-            @listener.handler_class.around_consume(preprocessed_payload, @metadata, &block)
-          else
-            # around_consume instance method implementation
-            handler.around_consume(preprocessed_payload, @metadata, &block)
+          handler.around_consume(payload, @metadata) do |around_payload, around_metadata|
+            handler.consume(around_payload, around_metadata)
           end
         end
       end

data/lib/phobos/producer.rb

@@ -11,28 +11,24 @@ module Phobos
     end
 
     class PublicAPI
-      MissingRequiredArgumentsError = Class.new(StandardError) do
-        def initialize
-          super('You need to provide a topic name and a payload')
-        end
-      end
-
       def initialize(host_obj)
         @host_obj = host_obj
       end
 
-      def publish(*args, **kwargs)
-        Phobos.deprecate(deprecate_positional_args_message('publish')) if kwargs.empty?
-
-        args = normalize_arguments(*args, **kwargs)
-        class_producer.publish(**args)
+      def publish(topic:, payload:, key: nil, partition_key: nil, headers: nil)
+        class_producer.publish(topic: topic,
+                               payload: payload,
+                               key: key,
+                               partition_key: partition_key,
+                               headers: headers)
       end
 
-      def async_publish(*args, **kwargs)
-        Phobos.deprecate(deprecate_positional_args_message('async_publish')) if kwargs.empty?
-
-        args = normalize_arguments(*args, **kwargs)
-        class_producer.async_publish(**args)
+      def async_publish(topic:, payload:, key: nil, partition_key: nil, headers: nil)
+        class_producer.async_publish(topic: topic,
+                                     payload: payload,
+                                     key: key,
+                                     partition_key: partition_key,
+                                     headers: headers)
       end
 
       # @param messages [Array(Hash(:topic, :payload, :key, :headers))]
@@ -54,36 +50,6 @@ module Phobos
       def class_producer
         @host_obj.class.producer
       end
-
-      # rubocop:disable Metrics/ParameterLists
-      def normalize_arguments(p_topic = nil, p_payload = nil, p_key = nil,
-                              p_partition_key = nil, p_headers = {},
-                              **kwargs)
-        {}.tap do |args|
-          {
-            topic: p_topic,
-            payload: p_payload,
-            key: p_key,
-            partition_key: p_partition_key,
-            headers: p_headers
-          }.each { |k, v| args[k] = kwargs[k] || v }
-
-          raise MissingRequiredArgumentsError if [:topic, :payload].any? { |k| args[k].nil? }
-
-          kwargs.each do |k, v|
-            next if args.key?(k)
-
-            args[:headers][k] = v
-          end
-        end
-      end
-      # rubocop:enable Metrics/ParameterLists
-
-      def deprecate_positional_args_message(method_name)
-        "The `#{method_name}` method should now receive keyword arguments " \
-          'rather than positional ones. Please update your publishers. This will ' \
-          'not be backwards compatible in the future.'
-      end
     end
 
     module ClassMethods

data/lib/phobos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Phobos
-  VERSION = '1.9.0'
+  VERSION = '2.0.0-beta1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phobos
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 2.0.0.pre.beta1
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-05 00:00:00.000000000 Z
+date: 2020-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -310,9 +310,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: