active_delivery 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfc96638e6c019dd1b13f57eef8ab3b9bf2a34df2b58ca7f7ea8ea167886c59e
-  data.tar.gz: b50d556edef4a01fc7d1a8af1659a05f99a821584c2d4818418401f3a03350dd
+  metadata.gz: d05087cb016af8444f7668b81681675248b7b63f41f77a1d9fdb22b65ccb6845
+  data.tar.gz: d60851ccb9d9ea6557d131289942edf57b39c79a499e37d41f8f1d06b480446f
 SHA512:
-  metadata.gz: 518d226591f5114383c2d138c163b4bac13e62666cce4f7edde7d2df5bca7e770c17576f00fee378b9a8733cc72372960efa2692839a6dc4d274d130787fcb41
-  data.tar.gz: 2bd5eed0775fd32d83ca45364d8ecdc4f28c275eb2ffbbcad768ef98d8581b1cd0e66eb72f7e012c9d4dbd0a18e8a72cb40a858f0459614e18a5ee3e24fb0420
+  metadata.gz: 5a94a2fd3e2f19d9e99c0df6494752b23649802b064b390ea50d65506b01beb57650f31f5cd140495d6befa847a65423cc141ec8c313a6a116de69a4cd5576df
+  data.tar.gz: 4febe7f49e314d27f370642fa43085c5020dae8bac7fa9a3512514a6b861d17b726d4685ed91f081eab22f4c2af68a4117d37f8f29a576c78fe323f2c73b58e2

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 1.2.0 (2024-02-05)
+
+- Add Minitest assertions (`assert_deliveries`, `assert_no_deliveries`, `assert_delivery_enqueued`). ([@palkan][])
+
 ## 1.1.0 (2023-12-01) ❄️
 
 - Support delayed delivery options (e.g, `wait_until`). ([@palkan][])

data/README.md

@@ -10,6 +10,8 @@ Since v1.0, Active Delivery is bundled with [Abstract Notifier](https://github.c
 
 📖 Read the introduction post: ["Crafting user notifications in Rails with Active Delivery"](https://evilmartians.com/chronicles/crafting-user-notifications-in-rails-with-active-delivery)
 
+📖 Read more about designing notifications layer in Ruby on Rails applications in the [Layered design for Ruby on Rails applications](https://www.packtpub.com/product/layered-design-for-ruby-on-rails-applications/9781801813785) book.
+
 <a href="https://evilmartians.com/?utm_source=action_policy">
 <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
 
@@ -56,7 +58,7 @@ end
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "active_delivery", "1.0.0.rc2"
+gem "active_delivery", "~> 1.0"
 ```
 
 And then execute:
@@ -291,17 +293,36 @@ MyDeliver.notify(:something_wicked_this_way_comes)
 
 ## Testing
 
-**NOTE:** Currently, only RSpec matchers are provided.
+### Setup
+
+Test mode is activated automatically if `RAILS_ENV` or `RACK_ENV` env variable is equal to "test". Otherwise, add `require "active_delivery/testing/rspec"` to your `spec_helper.rb` / `rails_helper.rb` manually or `require "active_delivery/testing/minitest"`. This is also required if you're using Spring in the test environment (e.g. with help of [spring-commands-rspec](https://github.com/jonleighton/spring-commands-rspec)).
+
+For Minitest, you also MUST include the test helper into your test class. For example:
+
+```ruby
+class ActiveSupport::TestCase
+  # ...
+  include ActiveDelivery::TestHelper
+end
+```
 
 ### Deliveries
 
-Active Delivery provides an elegant way to test deliveries in your code (i.e., when you want to check whether a notification has been sent) through a `have_delivered_to` matcher:
+Active Delivery provides an elegant way to test deliveries in your code (i.e., when you want to check whether a notification has been sent) through a `have_delivered_to` RSpec matcher or `assert_delivery_enqueued` Minitest assertion:
 
 ```ruby
+# RSpec
 it "delivers notification" do
   expect { subject }.to have_delivered_to(Community::EventsDelivery, :modified, event)
     .with(profile: profile)
 end
+
+# Minitest
+def test_delivers_notification
+  assert_delivery_enqueued(Community::EventsDelivery, :modified, with: [event]) do
+    some_action
+  end
+end
 ```
 
 You can also use such RSpec features as compound expectations and composed matchers:
@@ -320,14 +341,27 @@ end
 If you want to test that no notification is delivered you can use negation
 
 ```ruby
+# RSpec
 specify "when event is not found" do
   expect do
     described_class.perform_now(profile.id, "123", "one_hour_before")
   end.not_to have_delivered_to(Community::EventsDelivery)
 end
+
+# Minitest
+def test_no_notification_if_event_is_not_found
+  assert_no_deliveries do
+    some_action
+  end
+
+  # Alternatively, you can use the positive assertion
+  assert_deliveries(0) do
+    some_action
+  end
+end
 ```
 
-or use the `#have_not_delivered_to` matcher:
+With RSpec, you can also use the `#have_not_delivered_to` matcher:
 
 ```ruby
 specify "when event is not found" do
@@ -360,7 +394,7 @@ describe PostsDelivery do
 end
 ```
 
-You can also use the `#deliver_via` matchers as follows:
+You can also use the `#deliver_via` RSpec matcher as follows:
 
 ```ruby
 describe PostsDelivery, type: :delivery do
@@ -387,8 +421,6 @@ describe PostsDelivery, type: :delivery do
 end
 ```
 
-**NOTE:** test mode activated automatically if `RAILS_ENV` or `RACK_ENV` env variable is equal to "test". Otherwise, add `require "active_delivery/testing/rspec"` to your `spec_helper.rb` / `rails_helper.rb` manually. This is also required if you're using Spring in the test environment (e.g. with help of [spring-commands-rspec](https://github.com/jonleighton/spring-commands-rspec)).
-
 ## Custom "lines"
 
 The _Line_ class describes the way you want to _transfer_ your deliveries.
@@ -410,8 +442,8 @@ class EventPigeon
     alias_method :with, :new
 
     # delegate delivery action to the instance
-    def message_arrived(*args)
-      new.message_arrived(*args)
+    def message_arrived(*)
+      new.message_arrived(*)
     end
   end
 
@@ -447,17 +479,17 @@ class PigeonLine < ActiveDelivery::Lines::Base
   # Called when we want to send message synchronously
   # `sender` here either `sender_class` or `sender_class.with(params)`
   # if params passed.
-  def notify_now(sender, delivery_action, *args, **kwargs)
+  def notify_now(sender, delivery_action, *, **)
     # For example, our EventPigeon class returns some `Pigeon` object
-    pigeon = sender.public_send(delivery_action, *args, **kwargs)
+    pigeon = sender.public_send(delivery_action, *, **)
     # PigeonLaunchService do all the sending job
     PigeonService.launch pigeon
   end
 
   # Called when we want to send a message asynchronously.
   # For example, you can use a background job here.
-  def notify_later(sender, delivery_action, *args, **kwargs)
-    pigeon = sender.public_send(delivery_action, *args, **kwargs)
+  def notify_later(sender, delivery_action, *, **)
+    pigeon = sender.public_send(delivery_action, *, **)
     # PigeonLaunchService do all the sending job
     PigeonLaunchJob.perform_later pigeon
   end
@@ -475,8 +507,8 @@ class EventPigeon
     alias_method :with, :new
 
     # delegate delivery action to the instance
-    def message_arrived(*args)
-      new.message_arrived(*args)
+    def message_arrived(*)
+      new.message_arrived(*)
     end
   end
 
@@ -491,18 +523,18 @@ class EventPigeon
 end
 
 class PigeonLine < ActiveDelivery::Lines::Base
-  def notify_later(sender, delivery_action, *args, **kwargs)
+  def notify_later(sender, delivery_action, *, **kwargs)
     # `to_s` is important for serialization. Unless you might have error
-    PigeonLaunchJob.perform_later sender.class.to_s, delivery_action, *args, **kwargs.merge(params: line.params)
+    PigeonLaunchJob.perform_later(sender.class.to_s, delivery_action, *, **kwargs.merge(params: line.params))
   end
 end
 
 class PigeonLaunchJob < ActiveJob::Base
-  def perform(sender, delivery_action, *args, params: nil, **kwargs)
+  def perform(sender, delivery_action, *, params: nil, **)
     klass = sender.safe_constantize
     handler = params ? klass.with(**params) : klass.new
 
-    handler.public_send(delivery_action, *args, **kwargs)
+    handler.public_send(delivery_action, *, **)
   end
 end
 ```
@@ -591,12 +623,12 @@ class ActionCableDeliveryLine < ActiveDelivery::Line::Base
   # We want to broadcast all notifications
   def notify?(...) = true
 
-  def notify_now(context, delivery_action, *args, **kwargs)
+  def notify_now(context, delivery_action, *, **)
     # Skip if no user provided
     return unless context.user
 
     payload = {event: [context.scope, delivery_action].join(".")}
-    payload.merge!(serialized_args(*args, **kwargs))
+    payload.merge!(serialized_args(*, **))
 
     DeliveryChannel.broadcast_to context.user, payload
   end

data/lib/.rbnext/3.0/abstract_notifier/async_adapters/active_job.rb

@@ -22,8 +22,8 @@ module AbstractNotifier
         job.set(queue: queue).perform_later(...)
       end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :enqueue)
 
-      def enqueue_delivery(delivery, **opts)
-        job.set(queue: queue, **opts).perform_later(
+      def enqueue_delivery(delivery, **__kwrest__)
+        job.set(queue: queue, **__kwrest__).perform_later(
           delivery.notifier_class.name,
           delivery.action_name,
           **delivery.delivery_params

data/lib/.rbnext/3.0/abstract_notifier/base.rb

@@ -23,9 +23,9 @@ module AbstractNotifier
 
     alias_method :notification, :processed
 
-    def notify_later(**opts)
+    def notify_later(**__kwrest__)
       if notifier_class.async_adapter.respond_to?(:enqueue_delivery)
-        notifier_class.async_adapter.enqueue_delivery(self, **opts)
+        notifier_class.async_adapter.enqueue_delivery(self, **__kwrest__)
       else
         notifier_class.async_adapter.enqueue(notifier_class.name, action_name, params: params, args: args, kwargs: kwargs)
       end
@@ -73,8 +73,8 @@ module AbstractNotifier
       end
       # rubocop:enable Style/MethodMissingSuper
 
-      def respond_to_missing?(*args)
-        notifier_class.respond_to_missing?(*args)
+      def respond_to_missing?(*__rest__)
+        notifier_class.respond_to_missing?(*__rest__)
       end
     end
 

data/lib/.rbnext/3.0/active_delivery/base.rb

@@ -77,8 +77,8 @@ module ActiveDelivery
 
       # The same as .notify but delivers synchronously
       # (i.e. #deliver_now for mailers)
-      def notify!(mid, *args, **hargs)
-        notify(mid, *args, **hargs, sync: true)
+      def notify!(mid, *__rest__, **hargs)
+        notify(mid, *__rest__, **hargs, sync: true)
       end
 
       alias_method :notify_now, :notify!
@@ -93,7 +93,7 @@ module ActiveDelivery
         end
       end
 
-      def register_line(line_id, line_class = nil, notifier: nil, **options)
+      def register_line(line_id, line_class = nil, notifier: nil, **__kwrest__)
         raise ArgumentError, "A line class or notifier configuration must be provided" if line_class.nil? && notifier.nil?
 
         # Configure Notifier
@@ -101,7 +101,7 @@ module ActiveDelivery
           line_class = ActiveDelivery::Lines::Notifier
         end
 
-        delivery_lines[line_id] = line_class.new(id: line_id, owner: self, **options)
+        delivery_lines[line_id] = line_class.new(id: line_id, owner: self, **__kwrest__)
 
         instance_eval <<~CODE, __FILE__, __LINE__ + 1
           def #{line_id}(val)
@@ -152,13 +152,13 @@ module ActiveDelivery
         super
       end
 
-      def method_missing(mid, *args, **kwargs)
+      def method_missing(mid, *__rest__, **__kwrest__)
         return super unless respond_to_missing?(mid)
 
         # Lazily define a class method to avoid lookups
         delivers(mid)
 
-        public_send(mid, *args, **kwargs)
+        public_send(mid, *__rest__, **__kwrest__)
       end
     end
 
@@ -197,7 +197,7 @@ module ActiveDelivery
       super
     end
 
-    def method_missing(mid, *args, **kwargs)
+    def method_missing(mid, *__rest__, **__kwrest__)
       return super unless respond_to_missing?(mid)
 
       # Lazily define a method to avoid future lookups
@@ -211,7 +211,7 @@ module ActiveDelivery
         end
       CODE
 
-      public_send(mid, *args, **kwargs)
+      public_send(mid, *__rest__, **__kwrest__)
     end
 
     protected

data/lib/.rbnext/3.0/active_delivery/lines/base.rb

@@ -41,16 +41,16 @@ module ActiveDelivery
         notify_later(handler, mid, *__rest__, &__block__)
       end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :notify_later_with_options)
 
-      def notify(mid, *args, params:, sync:, enqueue_options:, **kwargs)
+      def notify(mid, *__rest__, params:, sync:, enqueue_options:, **__kwrest__)
         clazz = params.empty? ? handler_class : handler_class.with(**params)
         if sync
-          return notify_now(clazz, mid, *args, **kwargs)
+          return notify_now(clazz, mid, *__rest__, **__kwrest__)
         end
 
         if enqueue_options.empty?
-          notify_later(clazz, mid, *args, **kwargs)
+          notify_later(clazz, mid, *__rest__, **__kwrest__)
         else
-          notify_later_with_options(clazz, enqueue_options, mid, *args, **kwargs)
+          notify_later_with_options(clazz, enqueue_options, mid, *__rest__, **__kwrest__)
         end
       end
 

data/lib/.rbnext/3.0/active_delivery/testing/minitest.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ActiveDelivery
+  module TestHelper
+    def assert_deliveries(count)
+      TestDelivery.enable { yield }
+
+      assert_equal TestDelivery.store.count, count, "Expected #{count} deliveries, got #{TestDelivery.store.count}"
+    end
+
+    def assert_no_deliveries(&__block__) ;  assert_deliveries(0, &__block__); end
+
+    def assert_delivery_enqueued(delivery_class, event, count: 1, params: nil, with: nil)
+      TestDelivery.enable { yield }
+
+      deliveries = TestDelivery.store
+
+      if with
+        args = with
+        kwargs = args.pop if args.last.is_a?(Hash)
+      end
+
+      matching_deliveries, _unmatching_deliveries =
+        deliveries.partition do |(delivery, options)|
+          next false if delivery_class != delivery.owner.class
+
+          next false if event != delivery.notification
+
+          next false if params && !hash_include?(delivery.owner.params, params)
+
+          next true unless with
+
+          actual_args = delivery.params
+          actual_kwargs = delivery.options
+
+          next false unless args.each.with_index.all? do |arg, i|
+            arg === actual_args[i]
+          end
+
+          next false unless kwargs.all? do |k, v|
+            v === actual_kwargs[k]
+          end
+
+          true
+        end
+
+      assert_equal count, matching_deliveries.count, "Expected #{count} deliveries, got #{deliveries.count}"
+    end
+
+    private
+
+    def hash_include?(haystack, needle)
+      needle.all? do |k, v|
+        haystack.key?(k) && haystack[k] == v
+      end
+    end
+  end
+end

data/lib/.rbnext/3.0/active_delivery/testing.rb

@@ -60,3 +60,4 @@ end
 ActiveDelivery::Base.prepend ActiveDelivery::TestDelivery
 
 require "active_delivery/testing/rspec" if defined?(RSpec::Core)
+require "active_delivery/testing/minitest" if defined?(Minitest::Assertions)

data/lib/.rbnext/3.1/abstract_notifier/async_adapters/active_job.rb

@@ -22,8 +22,8 @@ module AbstractNotifier
         job.set(queue: queue).perform_later(...)
       end
 
-      def enqueue_delivery(delivery, **opts)
-        job.set(queue: queue, **opts).perform_later(
+      def enqueue_delivery(delivery, **__kwrest__)
+        job.set(queue: queue, **__kwrest__).perform_later(
           delivery.notifier_class.name,
           delivery.action_name,
           **delivery.delivery_params

data/lib/.rbnext/3.1/abstract_notifier/base.rb

@@ -23,9 +23,9 @@ module AbstractNotifier
 
     alias_method :notification, :processed
 
-    def notify_later(**opts)
+    def notify_later(**__kwrest__)
       if notifier_class.async_adapter.respond_to?(:enqueue_delivery)
-        notifier_class.async_adapter.enqueue_delivery(self, **opts)
+        notifier_class.async_adapter.enqueue_delivery(self, **__kwrest__)
       else
         notifier_class.async_adapter.enqueue(notifier_class.name, action_name, params: params, args: args, kwargs: kwargs)
       end
@@ -73,8 +73,8 @@ module AbstractNotifier
       end
       # rubocop:enable Style/MethodMissingSuper
 
-      def respond_to_missing?(*args)
-        notifier_class.respond_to_missing?(*args)
+      def respond_to_missing?(*__rest__)
+        notifier_class.respond_to_missing?(*__rest__)
       end
     end
 

data/lib/.rbnext/3.1/active_delivery/base.rb

@@ -77,8 +77,8 @@ module ActiveDelivery
 
       # The same as .notify but delivers synchronously
       # (i.e. #deliver_now for mailers)
-      def notify!(mid, *args, **hargs)
-        notify(mid, *args, **hargs, sync: true)
+      def notify!(mid, *__rest__, **hargs)
+        notify(mid, *__rest__, **hargs, sync: true)
       end
 
       alias_method :notify_now, :notify!
@@ -93,7 +93,7 @@ module ActiveDelivery
         end
       end
 
-      def register_line(line_id, line_class = nil, notifier: nil, **options)
+      def register_line(line_id, line_class = nil, notifier: nil, **__kwrest__)
         raise ArgumentError, "A line class or notifier configuration must be provided" if line_class.nil? && notifier.nil?
 
         # Configure Notifier
@@ -101,7 +101,7 @@ module ActiveDelivery
           line_class = ActiveDelivery::Lines::Notifier
         end
 
-        delivery_lines[line_id] = line_class.new(id: line_id, owner: self, **options)
+        delivery_lines[line_id] = line_class.new(id: line_id, owner: self, **__kwrest__)
 
         instance_eval <<~CODE, __FILE__, __LINE__ + 1
           def #{line_id}(val)
@@ -152,13 +152,13 @@ module ActiveDelivery
         super
       end
 
-      def method_missing(mid, *args, **kwargs)
+      def method_missing(mid, *__rest__, **__kwrest__)
         return super unless respond_to_missing?(mid)
 
         # Lazily define a class method to avoid lookups
         delivers(mid)
 
-        public_send(mid, *args, **kwargs)
+        public_send(mid, *__rest__, **__kwrest__)
       end
     end
 
@@ -197,7 +197,7 @@ module ActiveDelivery
       super
     end
 
-    def method_missing(mid, *args, **kwargs)
+    def method_missing(mid, *__rest__, **__kwrest__)
       return super unless respond_to_missing?(mid)
 
       # Lazily define a method to avoid future lookups
@@ -211,7 +211,7 @@ module ActiveDelivery
         end
       CODE
 
-      public_send(mid, *args, **kwargs)
+      public_send(mid, *__rest__, **__kwrest__)
     end
 
     protected

data/lib/.rbnext/3.1/active_delivery/lines/base.rb

@@ -41,16 +41,16 @@ module ActiveDelivery
         notify_later(handler, mid, ...)
       end
 
-      def notify(mid, *args, params:, sync:, enqueue_options:, **kwargs)
+      def notify(mid, *__rest__, params:, sync:, enqueue_options:, **__kwrest__)
         clazz = params.empty? ? handler_class : handler_class.with(**params)
         if sync
-          return notify_now(clazz, mid, *args, **kwargs)
+          return notify_now(clazz, mid, *__rest__, **__kwrest__)
         end
 
         if enqueue_options.empty?
-          notify_later(clazz, mid, *args, **kwargs)
+          notify_later(clazz, mid, *__rest__, **__kwrest__)
         else
-          notify_later_with_options(clazz, enqueue_options, mid, *args, **kwargs)
+          notify_later_with_options(clazz, enqueue_options, mid, *__rest__, **__kwrest__)
         end
       end
 

data/lib/.rbnext/3.1/active_delivery/testing/minitest.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ActiveDelivery
+  module TestHelper
+    def assert_deliveries(count)
+      TestDelivery.enable { yield }
+
+      assert_equal TestDelivery.store.count, count, "Expected #{count} deliveries, got #{TestDelivery.store.count}"
+    end
+
+    def assert_no_deliveries(&__block__) = assert_deliveries(0, &__block__)
+
+    def assert_delivery_enqueued(delivery_class, event, count: 1, params: nil, with: nil)
+      TestDelivery.enable { yield }
+
+      deliveries = TestDelivery.store
+
+      if with
+        args = with
+        kwargs = args.pop if args.last.is_a?(Hash)
+      end
+
+      matching_deliveries, _unmatching_deliveries =
+        deliveries.partition do |(delivery, options)|
+          next false if delivery_class != delivery.owner.class
+
+          next false if event != delivery.notification
+
+          next false if params && !hash_include?(delivery.owner.params, params)
+
+          next true unless with
+
+          actual_args = delivery.params
+          actual_kwargs = delivery.options
+
+          next false unless args.each.with_index.all? do |arg, i|
+            arg === actual_args[i]
+          end
+
+          next false unless kwargs.all? do |k, v|
+            v === actual_kwargs[k]
+          end
+
+          true
+        end
+
+      assert_equal count, matching_deliveries.count, "Expected #{count} deliveries, got #{deliveries.count}"
+    end
+
+    private
+
+    def hash_include?(haystack, needle)
+      needle.all? do |k, v|
+        haystack.key?(k) && haystack[k] == v
+      end
+    end
+  end
+end

data/lib/.rbnext/3.2/abstract_notifier/async_adapters/active_job.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module AbstractNotifier
+  module AsyncAdapters
+    class ActiveJob
+      class DeliveryJob < ::ActiveJob::Base
+        def perform(notifier_class, ...)
+          AbstractNotifier::NotificationDelivery.new(notifier_class.constantize, ...).notify_now
+        end
+      end
+
+      DEFAULT_QUEUE = "notifiers"
+
+      attr_reader :job, :queue
+
+      def initialize(queue: DEFAULT_QUEUE, job: DeliveryJob)
+        @job = job
+        @queue = queue
+      end
+
+      def enqueue(...)
+        job.set(queue:).perform_later(...)
+      end
+
+      def enqueue_delivery(delivery, **__kwrest__)
+        job.set(queue:, **__kwrest__).perform_later(
+          delivery.notifier_class.name,
+          delivery.action_name,
+          **delivery.delivery_params
+        )
+      end
+    end
+  end
+end
+
+AbstractNotifier.async_adapter ||= :active_job