phobos 1.8.3.pre.beta2 → 1.9.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d9c3d6d826d8865116eeeef7183e1d3eb60862d4673fb10c0464577707e1a8a
-  data.tar.gz: 7317cdfb2c8516cfa837f52c41d14181987ccdd12698eccfb8119def24c24ab1
+  metadata.gz: 9ac51b2a5d3cdaa995dc2f8dfca3d8597c225c0b311724655712bb1ba7060991
+  data.tar.gz: d58bf202dced7bf24c483b0cd2067e4e13e2a43e8f1cfa756377ccf1cf4861dc
 SHA512:
-  metadata.gz: 8f4eb5b010f7c628db69ddbf4c5cc4237d1afff4f8a42b462e9e47cf835a2bbf2950c827865640bb3456009a7fcdd2b900df3d1d758206e82ddb774ffef5c202
-  data.tar.gz: 5b3a4b2ac5755a296097c52ded7e5ead4fc866250ff24c16ca75e620dd056c315dbeba1055fee1c4f509d88619b1bb0aaea7c8b6cf61861ac72ed1fab6aa1ad7
+  metadata.gz: 4b41e84f671b6f59d94bced995a491818468b1932fe22309e55bff1236d5f165c624d65647bc24ce054f5ab41e8ed20a53ffdb04ab21d755a3fa46cc52e9ba24
+  data.tar.gz: 69651f14500c3c0126b55429f0c5fd8bc2118845a6eac07147cd4c7cd87aa12d7f101a79f250cd428747c322ad469121af8a10fe94af3bc1f5fa67c70d0666a6

data/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ``
 ## UNRELEASED
 
+## [1.9.0-beta1] - 2019-12-18
+- Update `publish` and `async_publish` to use keyword arguments
+  instead of positional ones. Deprecate positional arguments
+  in anticipation of removing them with 2.0.
+
 ## [1.8.3-beta2] - 2019-11-15
 - Add support for message headers in both produced and consumed
   messages and batches.

data/README.md

@@ -281,25 +281,27 @@ The producer module doesn't pollute your classes with a thousand methods, it inc
 
 ```ruby
 my = MyProducer.new
-my.producer.publish('topic', 'message-payload', 'partition and message key')
+my.producer.publish(topic: 'topic', payload: 'message-payload', key: 'partition and message key')
 
 # The code above has the same effect of this code:
-MyProducer.producer.publish('topic', 'message-payload', 'partition and message key')
+MyProducer.producer.publish(topic: 'topic', payload: 'message-payload', key: 'partition and message key')
 ```
 
 The signature for the `publish` method is as follows:
 
 ```ruby
-def publish(topic, payload, key = nil, partition_key = nil, headers = nil)
+def publish(topic: topic, payload: payload, key: nil, partition_key: nil, headers: nil)
 ```
 
-To produce messages with headers, 5 arguments will have to be passed to `publish`:
+When publishing a message with headers, the `headers` argument must be a hash:
 
 ```ruby
 my = MyProducer.new
-my.producer.publish('topic', 'message-payload', 'partition and message key', nil, { header_1: 'value 1' })
+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
@@ -328,7 +330,7 @@ class MyHandler
   PUBLISH_TO = 'topic2'
 
   def consume(payload, metadata)
-    producer.async_publish(PUBLISH_TO, {key: 'value'}.to_json)
+    producer.async_publish(topic: PUBLISH_TO, payload: {key: 'value'}.to_json)
   end
 end
 ```

data/examples/publishing_messages_without_consumer.rb

@@ -45,7 +45,7 @@ Thread.new do
         #
         MyProducer
           .producer
-          .async_publish(TOPIC, payload, key)
+          .async_publish(topic: TOPIC, payload: payload, key: key)
 
         puts "produced #{key}, total: #{total}"
 

data/lib/phobos.rb

@@ -78,7 +78,8 @@ module Phobos
     end
 
     def deprecate(message)
-      warn "DEPRECATION WARNING: #{message} #{Kernel.caller.first}"
+      location = caller.find { |line| line !~ %r{/phobos/} }
+      warn "DEPRECATION WARNING: #{message}: #{location}"
     end
 
     # :nodoc:

data/lib/phobos/actions/process_message.rb

@@ -44,8 +44,8 @@ module Phobos
 
           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.')
+            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, &consume_block)
           else
             # around_consume instance method implementation
@@ -57,8 +57,9 @@ module Phobos
       def before_consume(handler, payload)
         handler.before_consume(payload, @metadata)
       rescue ArgumentError
-        Phobos.deprecate('before_consume now expects metadata as second argument, '\
-          'please update your consumer. This will not be backwards compatible in the future.')
+        Phobos.deprecate('before_consume now expects metadata as second argument, please update '\
+                         'your consumer. This will not be backwards compatible in the future.')
+
         handler.before_consume(payload)
       end
     end

data/lib/phobos/producer.rb

@@ -11,16 +11,28 @@ 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(topic, payload, key = nil, partition_key = nil, headers = nil)
-        class_producer.publish(topic, payload, key, partition_key, headers)
+      def publish(*args, **kwargs)
+        Phobos.deprecate(deprecate_positional_args_message('publish')) if kwargs.empty?
+
+        args = normalize_arguments(*args, **kwargs)
+        class_producer.publish(**args)
       end
 
-      def async_publish(topic, payload, key = nil, partition_key = nil, headers = nil)
-        class_producer.async_publish(topic, payload, key, partition_key, headers)
+      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)
       end
 
       # @param messages [Array(Hash(:topic, :payload, :key, :headers))]
@@ -42,6 +54,36 @@ 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
@@ -86,7 +128,7 @@ module Phobos
           producer_store[:sync_producer] = nil
         end
 
-        def publish(topic, payload, key = nil, partition_key = nil, headers = nil)
+        def publish(topic:, payload:, key: nil, partition_key: nil, headers: nil)
           publish_list([{ topic: topic, payload: payload, key: key,
                           partition_key: partition_key, headers: headers }])
         end
@@ -109,7 +151,7 @@ module Phobos
           producer_store[:async_producer]
         end
 
-        def async_publish(topic, payload, key = nil, partition_key = nil, headers = nil)
+        def async_publish(topic:, payload:, key: nil, partition_key: nil, headers: nil)
           async_publish_list([{ topic: topic, payload: payload, key: key,
                                 partition_key: partition_key, headers: headers }])
         end

data/lib/phobos/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phobos
 version: !ruby/object:Gem::Version
-  version: 1.8.3.pre.beta2
+  version: 1.9.0.pre.beta1
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2019-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler