active_delivery 1.1.0 → 1.2.0

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

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+module AbstractNotifier
+  # NotificationDelivery payload wrapper which contains
+  # information about the current notifier class
+  # and knows how to trigger the delivery
+  class NotificationDelivery
+    attr_reader :action_name, :notifier_class
+
+    def initialize(notifier_class, action_name, params: {}, args: [], kwargs: {})
+      @notifier_class = notifier_class
+      @action_name = action_name
+      @params = params
+      @args = args
+      @kwargs = kwargs
+    end
+
+    def processed
+      return @processed if instance_variable_defined?(:@processed)
+
+      @processed = notifier.process_action(action_name, *args, **kwargs) || Notification.new(nil)
+    end
+
+    alias_method :notification, :processed
+
+    def notify_later(**__kwrest__)
+      if notifier_class.async_adapter.respond_to?(:enqueue_delivery)
+        notifier_class.async_adapter.enqueue_delivery(self, **__kwrest__)
+      else
+        notifier_class.async_adapter.enqueue(notifier_class.name, action_name, params:, args:, kwargs:)
+      end
+    end
+
+    def notify_now
+      return unless notification.payload
+
+      notifier.deliver!(notification)
+    end
+
+    def delivery_params = {params:, args:, kwargs:}
+
+    private
+
+    attr_reader :params, :args, :kwargs
+
+    def notifier
+      @notifier ||= notifier_class.new(action_name, **params)
+    end
+  end
+
+  # Notification object contains the compiled payload to be delivered
+  class Notification
+    attr_reader :payload
+
+    def initialize(payload)
+      @payload = payload
+    end
+  end
+
+  # Base class for notifiers
+  class Base
+    class ParamsProxy
+      attr_reader :notifier_class, :params
+
+      def initialize(notifier_class, params)
+        @notifier_class = notifier_class
+        @params = params
+      end
+
+      # rubocop:disable Style/MethodMissingSuper
+      def method_missing(method_name, *args, **kwargs)
+        NotificationDelivery.new(notifier_class, method_name, params:, args:, kwargs:)
+      end
+      # rubocop:enable Style/MethodMissingSuper
+
+      def respond_to_missing?(*__rest__)
+        notifier_class.respond_to_missing?(*__rest__)
+      end
+    end
+
+    class << self
+      attr_writer :driver
+
+      def driver
+        return @driver if instance_variable_defined?(:@driver)
+
+        @driver =
+          if superclass.respond_to?(:driver)
+            superclass.driver
+          else
+            raise "Driver not found for #{name}. " \
+                  "Please, specify driver via `self.driver = MyDriver`"
+          end
+      end
+
+      def async_adapter=(args)
+        adapter, options = Array(args)
+        @async_adapter = AsyncAdapters.lookup(adapter, options)
+      end
+
+      def async_adapter
+        return @async_adapter if instance_variable_defined?(:@async_adapter)
+
+        @async_adapter =
+          if superclass.respond_to?(:async_adapter)
+            superclass.async_adapter
+          else
+            AbstractNotifier.async_adapter
+          end
+      end
+
+      def default(method_name = nil, **hargs, &block)
+        return @defaults_generator = block if block
+
+        return @defaults_generator = proc { send(method_name) } unless method_name.nil?
+
+        @default_params =
+          if superclass.respond_to?(:default_params)
+            superclass.default_params.merge(hargs).freeze
+          else
+            hargs.freeze
+          end
+      end
+
+      def defaults_generator
+        return @defaults_generator if instance_variable_defined?(:@defaults_generator)
+
+        @defaults_generator =
+          if superclass.respond_to?(:defaults_generator)
+            superclass.defaults_generator
+          end
+      end
+
+      def default_params
+        return @default_params if instance_variable_defined?(:@default_params)
+
+        @default_params =
+          if superclass.respond_to?(:default_params)
+            superclass.default_params.dup
+          else
+            {}
+          end
+      end
+
+      def method_missing(method_name, *args, **kwargs)
+        if action_methods.include?(method_name.to_s)
+          NotificationDelivery.new(self, method_name, args:, kwargs:)
+        else
+          super
+        end
+      end
+
+      def with(params)
+        ParamsProxy.new(self, params)
+      end
+
+      def respond_to_missing?(method_name, _include_private = false)
+        action_methods.include?(method_name.to_s) || super
+      end
+
+      # See https://github.com/rails/rails/blob/b13a5cb83ea00d6a3d71320fd276ca21049c2544/actionpack/lib/abstract_controller/base.rb#L74
+      def action_methods
+        @action_methods ||= begin
+          # All public instance methods of this class, including ancestors
+          methods = (public_instance_methods(true) -
+            # Except for public instance methods of Base and its ancestors
+            Base.public_instance_methods(true) +
+            # Be sure to include shadowed public instance methods of this class
+            public_instance_methods(false))
+
+          methods.map!(&:to_s)
+
+          methods.to_set
+        end
+      end
+    end
+
+    attr_reader :params, :notification_name
+
+    def initialize(notification_name, **params)
+      @notification_name = notification_name
+      @params = params.freeze
+    end
+
+    def process_action(...)
+      public_send(...)
+    end
+
+    def deliver!(notification)
+      self.class.driver.call(notification.payload)
+    end
+
+    def notification(**payload)
+      merge_defaults!(payload)
+
+      payload[:body] = implicit_payload_body unless payload.key?(:body)
+
+      raise ArgumentError, "Notification body must be present" if
+        payload[:body].nil? || payload[:body].empty?
+
+      @notification = Notification.new(payload)
+    end
+
+    private
+
+    def implicit_payload_body
+      # no-op — override to provide custom logic
+    end
+
+    def merge_defaults!(payload)
+      defaults =
+        if self.class.defaults_generator
+          instance_exec(&self.class.defaults_generator)
+        else
+          self.class.default_params
+        end
+
+      defaults.each do |k, v|
+        payload[k] = v unless payload.key?(k)
+      end
+    end
+  end
+end

data/lib/.rbnext/3.2/abstract_notifier/testing/rspec.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module AbstractNotifier
+  class HaveSentNotification < RSpec::Matchers::BuiltIn::BaseMatcher
+    attr_reader :payload
+
+    def initialize(payload = nil)
+      @payload = payload
+      set_expected_number(:exactly, 1)
+    end
+
+    def exactly(count)
+      set_expected_number(:exactly, count)
+      self
+    end
+
+    def at_least(count)
+      set_expected_number(:at_least, count)
+      self
+    end
+
+    def at_most(count)
+      set_expected_number(:at_most, count)
+      self
+    end
+
+    def times
+      self
+    end
+
+    def once
+      exactly(:once)
+    end
+
+    def twice
+      exactly(:twice)
+    end
+
+    def thrice
+      exactly(:thrice)
+    end
+
+    def supports_block_expectations?
+      true
+    end
+
+    def matches?(proc)
+      raise ArgumentError, "have_sent_notification only supports block expectations" unless Proc === proc
+
+      raise "You can only use have_sent_notification matcher in :test delivery mode" unless AbstractNotifier.test?
+
+      original_deliveries_count = deliveries.count
+      proc.call
+      in_block_deliveries = deliveries.drop(original_deliveries_count)
+
+      @matching_deliveries, @unmatching_deliveries =
+        in_block_deliveries.partition do |actual_payload|
+          next true if payload.nil?
+
+          if payload.is_a?(::Hash) && !payload[:via]
+            actual_payload = actual_payload.dup
+            actual_payload.delete(:via)
+          end
+
+          payload === actual_payload
+        end
+
+      @matching_count = @matching_deliveries.size
+
+      case @expectation_type
+      when :exactly then @expected_number == @matching_count
+      when :at_most then @expected_number >= @matching_count
+      when :at_least then @expected_number <= @matching_count
+      end
+    end
+
+    def deliveries
+      AbstractNotifier::Testing::Driver.deliveries
+    end
+
+    def set_expected_number(relativity, count)
+      @expectation_type = relativity
+      @expected_number =
+        case count
+        when :once then 1
+        when :twice then 2
+        when :thrice then 3
+        else Integer(count)
+        end
+    end
+
+    def failure_message
+      (+"expected to #{verb_present} notification: #{payload_description}").tap do |msg|
+        msg << " #{message_expectation_modifier}, but"
+
+        if @unmatching_deliveries.any?
+          msg << " #{verb_past} the following notifications:"
+          @unmatching_deliveries.each do |unmatching_payload|
+            msg << "\n  #{unmatching_payload}"
+          end
+        else
+          msg << " haven't #{verb_past} anything"
+        end
+      end
+    end
+
+    def failure_message_when_negated
+      "expected not to #{verb_present} #{payload}"
+    end
+
+    def message_expectation_modifier
+      number_modifier = (@expected_number == 1) ? "once" : "#{@expected_number} times"
+      case @expectation_type
+      when :exactly then "exactly #{number_modifier}"
+      when :at_most then "at most #{number_modifier}"
+      when :at_least then "at least #{number_modifier}"
+      end
+    end
+
+    def payload_description
+      if payload.is_a?(RSpec::Matchers::Composable)
+        payload.description
+      else
+        payload
+      end
+    end
+
+    def verb_past
+      "sent"
+    end
+
+    def verb_present
+      "send"
+    end
+  end
+
+  class HaveEnqueuedNotification < HaveSentNotification
+    private
+
+    def deliveries
+      AbstractNotifier::Testing::Driver.enqueued_deliveries
+    end
+
+    def verb_past
+      "enqueued"
+    end
+
+    def verb_present
+      "enqueue"
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(Module.new do
+    def have_sent_notification(*__rest__)
+      AbstractNotifier::HaveSentNotification.new(*__rest__)
+    end
+
+    def have_enqueued_notification(*__rest__)
+      AbstractNotifier::HaveEnqueuedNotification.new(*__rest__)
+    end
+  end)
+end

data/lib/.rbnext/3.2/abstract_notifier/testing.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module AbstractNotifier
+  module Testing
+    module Driver
+      class << self
+        def deliveries
+          Thread.current[:notifier_deliveries] ||= []
+        end
+
+        def enqueued_deliveries
+          Thread.current[:notifier_enqueued_deliveries] ||= []
+        end
+
+        def clear
+          deliveries.clear
+          enqueued_deliveries.clear
+        end
+
+        def send_notification(data)
+          deliveries << data
+        end
+
+        def enqueue_notification(data)
+          enqueued_deliveries << data
+        end
+      end
+    end
+
+    module NotificationDelivery
+      def notify_now
+        return super unless AbstractNotifier.test?
+
+        payload = notification.payload
+
+        Driver.send_notification payload.merge(via: notifier.class)
+      end
+
+      def notify_later(**__kwrest__)
+        return super unless AbstractNotifier.test?
+
+        payload = notification.payload
+
+        Driver.enqueue_notification payload.merge(via: notifier.class, **__kwrest__)
+      end
+    end
+  end
+end
+
+AbstractNotifier::NotificationDelivery.prepend AbstractNotifier::Testing::NotificationDelivery
+
+require "abstract_notifier/testing/rspec" if defined?(RSpec::Core)
+require "abstract_notifier/testing/minitest" if defined?(Minitest::Assertions)

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

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+module ActiveDelivery
+  class Delivery # :nodoc:
+    attr_reader :params, :options, :metadata, :notification, :owner
+
+    def initialize(owner, notification:, params:, options:, metadata:)
+      @owner = owner
+      @notification = notification
+      @params = params.freeze
+      @options = options.freeze
+      @metadata = metadata.freeze
+    end
+
+    def deliver_later(**opts) = owner.perform_notify(self, enqueue_options: opts)
+
+    def deliver_now(**opts) = owner.perform_notify(self, sync: true)
+
+    def delivery_class = owner.class
+  end
+
+  class << self
+    # Whether to memoize resolved handler classes or not.
+    # Set to false if you're using a code reloader (e.g., Zeitwerk).
+    #
+    # Defaults to true (i.e. memoization is enabled
+    attr_accessor :cache_classes
+    # Whether to enforce specifying available delivery actions via .delivers in the
+    # delivery classes
+    attr_accessor :deliver_actions_required
+  end
+
+  self.cache_classes = true
+  self.deliver_actions_required = false
+
+  # Base class for deliveries.
+  #
+  # Delivery object describes how to notify a user about
+  # an event (e.g. via email or via push notification or both).
+  #
+  # Delivery class acts like a proxy in front of the different delivery channels
+  # (i.e. mailers, notifiers). That means that calling a method on delivery class invokes the
+  # same method on the corresponding class, e.g.:
+  #
+  #   EventsDelivery.one_hour_before(profile, event).deliver_later
+  #   # or
+  #   EventsDelivery.notify(:one_hour_before, profile, event)
+  #
+  #   # under the hood it calls
+  #   EventsMailer.one_hour_before(profile, event).deliver_later
+  #
+  #   # and
+  #   EventsNotifier.one_hour_before(profile, event).notify_later
+  #
+  # Delivery also supports _parameterized_ calling:
+  #
+  #   EventsDelivery.with(profile: profile).canceled(event).deliver_later
+  #
+  # The parameters could be accessed through `params` instance method (e.g.
+  # to implement guard-like logic).
+  #
+  # When params are presents the parametrized mailer is used, i.e.:
+  #
+  #   EventsMailer.with(profile: profile).canceled(event).deliver_later
+  #
+  # See https://api.rubyonrails.org/classes/ActionMailer/Parameterized.html
+  class Base
+    class << self
+      attr_accessor :abstract_class
+
+      alias_method :with, :new
+
+      # Enqueues delivery (i.e. uses #deliver_later for mailers)
+      def notify(...)
+        new.notify(...)
+      end
+
+      # The same as .notify but delivers synchronously
+      # (i.e. #deliver_now for mailers)
+      def notify!(mid, *__rest__, **hargs)
+        notify(mid, *__rest__, **hargs, sync: true)
+      end
+
+      alias_method :notify_now, :notify!
+
+      def delivery_lines
+        @lines ||= if superclass.respond_to?(:delivery_lines)
+          superclass.delivery_lines.each_with_object({}) do |(key, val), acc|
+            acc[key] = val.dup_for(self)
+          end
+        else
+          {}
+        end
+      end
+
+      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
+        if line_class.nil?
+          line_class = ActiveDelivery::Lines::Notifier
+        end
+
+        delivery_lines[line_id] = line_class.new(id: line_id, owner: self, **__kwrest__)
+
+        instance_eval <<~CODE, __FILE__, __LINE__ + 1
+          def #{line_id}(val)
+            delivery_lines[:#{line_id}].handler_class_name = val
+          end
+
+          def #{line_id}_class
+            delivery_lines[:#{line_id}].handler_class
+          end
+        CODE
+      end
+
+      def unregister_line(line_id)
+        removed_line = delivery_lines.delete(line_id)
+
+        return if removed_line.nil?
+
+        singleton_class.undef_method line_id
+        singleton_class.undef_method "#{line_id}_class"
+      end
+
+      def abstract_class? = abstract_class == true
+
+      # Specify explicitly which actions are supported by the delivery.
+      def delivers(*actions)
+        actions.each do |mid|
+          class_eval <<~CODE, __FILE__, __LINE__ + 1
+            def self.#{mid}(...)
+              new.#{mid}(...)
+            end
+
+            def #{mid}(*args, **kwargs)
+              delivery(
+                notification: :#{mid},
+                params: args,
+                options: kwargs
+              )
+            end
+          CODE
+        end
+      end
+
+      def respond_to_missing?(mid, include_private = false)
+        unless ActiveDelivery.deliver_actions_required
+          return true if delivery_lines.any? { |_, line| line.notify?(mid) }
+        end
+
+        super
+      end
+
+      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, *__rest__, **__kwrest__)
+      end
+    end
+
+    self.abstract_class = true
+
+    attr_reader :params, :notification_name
+
+    def initialize(**params)
+      @params = params
+      @params.freeze
+    end
+
+    # Enqueues delivery (i.e. uses #deliver_later for mailers)
+    def notify(mid, *args, **kwargs)
+      perform_notify(
+        delivery(notification: mid, params: args, options: kwargs)
+      )
+    end
+
+    # The same as .notify but delivers synchronously
+    # (i.e. #deliver_now for mailers)
+    def notify!(mid, *args, **kwargs)
+      perform_notify(
+        delivery(notification: mid, params: args, options: kwargs),
+        sync: true
+      )
+    end
+
+    alias_method :notify_now, :notify!
+
+    def respond_to_missing?(mid, include_private = false)
+      unless ActiveDelivery.deliver_actions_required
+        return true if delivery_lines.any? { |_, line| line.notify?(mid) }
+      end
+
+      super
+    end
+
+    def method_missing(mid, *__rest__, **__kwrest__)
+      return super unless respond_to_missing?(mid)
+
+      # Lazily define a method to avoid future lookups
+      self.class.class_eval <<~CODE, __FILE__, __LINE__ + 1
+        def #{mid}(*args, **kwargs)
+          delivery(
+            notification: :#{mid},
+            params: args,
+            options: kwargs
+          )
+        end
+      CODE
+
+      public_send(mid, *__rest__, **__kwrest__)
+    end
+
+    protected
+
+    def perform_notify(delivery, sync: false, enqueue_options: {})
+      delivery_lines.each do |type, line|
+        next unless line.notify?(delivery.notification)
+
+        notify_line(type, line, delivery, sync:, enqueue_options:)
+      end
+    end
+
+    private
+
+    def notify_line(type, line, delivery, sync:, enqueue_options:)
+      line.notify(
+        delivery.notification,
+        *delivery.params,
+        params:,
+        sync:,
+        enqueue_options:,
+        **delivery.options
+      )
+      true
+    end
+
+    def delivery(notification:, params: nil, options: nil, metadata: nil)
+      Delivery.new(self, notification:, params:, options:, metadata:)
+    end
+
+    def delivery_lines
+      self.class.delivery_lines
+    end
+  end
+end