caffeinate 0.2.0 → 0.6.0

data/lib/caffeinate/dripper/campaign.rb

@@ -2,6 +2,7 @@
 
 module Caffeinate
   module Dripper
+    # Campaign methods for `Caffeinate::Dripper`.
     module Campaign
       # :nodoc:
       def self.included(klass)
@@ -10,7 +11,7 @@ module Caffeinate
 
       # The campaign for this Dripper
       #
-      # @return Caffeinate::Campaign
+      # @return `Caffeinate::Campaign`
       def campaign
         self.class.caffeinate_campaign
       end
@@ -18,7 +19,7 @@ module Caffeinate
       module ClassMethods
         # Sets the campaign on the Dripper and resets any existing `@caffeinate_campaign`
         #
-        #   class OrdersDripper
+        #   class OrdersDripper < ApplicationDripper
         #     campaign :order_drip
         #   end
         #
@@ -27,21 +28,32 @@ module Caffeinate
         #   self.name.delete_suffix("Campaign").underscore
         #
         # @param [Symbol] slug The slug of a persisted `Caffeinate::Campaign`.
-        def campaign(slug)
+        def campaign=(slug)
           @caffeinate_campaign = nil
           @_campaign_slug = slug.to_sym
-          Caffeinate.register_dripper(@_campaign_slug, name)
+          Caffeinate.dripper_collection.register(@_campaign_slug, name)
         end
 
-        # Returns the `Caffeinate::Campaign` object for the Campaign
+        # Returns the `Caffeinate::Campaign` object for the Dripper.
+        #
+        # If `config.implicit_campaigns` is true, this will automatically create a `Caffeinate::Campaign` if one is not
+        # found via the `campaign_slug`.
         def caffeinate_campaign
           return @caffeinate_campaign if @caffeinate_campaign.present?
 
-          @caffeinate_campaign = ::Caffeinate::Campaign.find_by(slug: campaign_slug)
-          return @caffeinate_campaign if @caffeinate_campaign
+          if ::Caffeinate.config.implicit_campaigns?
+            @caffeinate_campaign = ::Caffeinate::Campaign.find_or_initialize_by(slug: campaign_slug)
+            if @caffeinate_campaign.new_record?
+              @caffeinate_campaign.name = "#{name.delete_suffix('Dripper').titleize} Campaign"
+              @caffeinate_campaign.save!
+            end
+          else
+            @caffeinate_campaign = ::Caffeinate::Campaign[campaign_slug]
+          end
 
-          raise(::ActiveRecord::RecordNotFound, "Unable to find ::Caffeinate::Campaign with slug #{campaign_slug}.")
+          @caffeinate_campaign
         end
+        alias campaign caffeinate_campaign
 
         # The defined slug or the inferred slug
         def campaign_slug

data/lib/caffeinate/dripper/defaults.rb

@@ -2,6 +2,7 @@
 
 module Caffeinate
   module Dripper
+    # Handles the default DSL for a `Caffeinate::Dripper`.
     module Defaults
       # :nodoc:
       def self.included(klass)
@@ -11,7 +12,7 @@ module Caffeinate
       module ClassMethods
         # The defaults set in the Campaign
         def defaults
-          @defaults ||= { mailer_class: inferred_mailer_class }
+          @defaults ||= { mailer_class: inferred_mailer_class, batch_size: ::Caffeinate.config.batch_size }
         end
 
         # The default options for the Campaign
@@ -23,7 +24,8 @@ module Caffeinate
         # @param [Hash] options The options to set defaults with
         # @option options [String] :mailer_class The mailer class
         def default(options = {})
-          options.assert_valid_keys(:mailer_class, :mailer, :using)
+          options.symbolize_keys!
+          options.assert_valid_keys(:mailer_class, :mailer, :using, :batch_size)
           @defaults = options
         end
       end

data/lib/caffeinate/dripper/delivery.rb

@@ -2,7 +2,7 @@
 
 module Caffeinate
   module Dripper
-    # Handles delivery of a Caffeinate::Mailer for a Caffeinate::Dripper
+    # Handles delivery of a `Caffeinate::Mailer` for a `Caffeinate::Dripper`.
     module Delivery
       # :nodoc:
       def self.included(klass)
@@ -14,13 +14,13 @@ module Caffeinate
         #
         # @param [Caffeinate::Mailing] mailing The mailing to deliver
         def deliver!(mailing)
-          Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY] = mailing
-
-          if mailing.drip.parameterized?
-            mailing.mailer_class.constantize.with(mailing: mailing).send(mailing.mailer_action).deliver
-          else
-            mailing.mailer_class.constantize.send(mailing.mailer_action, mailing).deliver
-          end
+          message = if mailing.drip.parameterized?
+                      mailing.mailer_class.constantize.with(mailing: mailing).send(mailing.mailer_action)
+                    else
+                      mailing.mailer_class.constantize.send(mailing.mailer_action, mailing)
+                    end
+          message.caffeinate_mailing = mailing
+          message.deliver
         end
       end
     end

data/lib/caffeinate/dripper/drip.rb

@@ -1,40 +1,10 @@
 # frozen_string_literal: true
 
+require 'caffeinate/dripper/drip_collection'
 module Caffeinate
   module Dripper
-    # The Drip DSL for registering a drip
+    # The Drip DSL for registering a drip.
     module Drip
-      # A collection of Drip objects for a `Caffeinate::Dripper`
-      class DripCollection
-        include Enumerable
-
-        def initialize(dripper)
-          @dripper = dripper
-          @drips = {}
-        end
-
-        # Register the drip
-        def register(action, options, &block)
-          @drips[action.to_s] = ::Caffeinate::Drip.new(@dripper, action, options, &block)
-        end
-
-        def each(&block)
-          @drips.each { |action_name, drip| block.call(action_name, drip) }
-        end
-
-        def values
-          @drips.values
-        end
-
-        def size
-          @drips.size
-        end
-
-        def [](val)
-          @drips[val]
-        end
-      end
-
       # :nodoc:
       def self.included(klass)
         klass.extend ClassMethods
@@ -60,17 +30,8 @@ module Caffeinate
         # @option options [String] :mailer_class The mailer_class
         # @option options [Integer] :step The order in which the drip is executed
         # @option options [ActiveSupport::Duration] :delay When the drip should be ran
+        # @option options [Symbol] :using set to :parameters if the mailer action uses ActionMailer::Parameters
         def drip(action_name, options = {}, &block)
-          options.assert_valid_keys(:mailer_class, :step, :delay, :using, :mailer)
-          options[:mailer_class] ||= options[:mailer] || defaults[:mailer_class]
-          options[:using] ||= defaults[:using]
-          options[:step] ||= drips.size + 1
-
-          if options[:mailer_class].nil?
-            raise ArgumentError, "You must define :mailer_class or :mailer in the options for :#{action_name}"
-          end
-          raise ArgumentError, "You must define :delay in the options for :#{action_name}" if options[:delay].nil?
-
           drip_collection.register(action_name, options, &block)
         end
       end

data/lib/caffeinate/dripper/drip_collection.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Dripper
+    # A collection of Drip objects for a `Caffeinate::Dripper`
+    class DripCollection
+      include Enumerable
+
+      def initialize(dripper)
+        @dripper = dripper
+        @drips = {}
+      end
+
+      def for(action)
+        @drips[action.to_sym]
+      end
+
+      # Register the drip
+      def register(action, options, &block)
+        options = validate_drip_options(action, options)
+
+        @drips[action.to_sym] = ::Caffeinate::Drip.new(@dripper, action, options, &block)
+      end
+
+      def each(&block)
+        @drips.each { |action_name, drip| block.call(action_name, drip) }
+      end
+
+      def values
+        @drips.values
+      end
+
+      def size
+        @drips.size
+      end
+
+      def [](val)
+        @drips[val]
+      end
+
+      private
+
+      def validate_drip_options(action, options)
+        options.symbolize_keys!
+        options.assert_valid_keys(:mailer_class, :step, :delay, :every, :start, :using, :mailer)
+        options[:mailer_class] ||= options[:mailer] || @dripper.defaults[:mailer_class]
+        options[:using] ||= @dripper.defaults[:using]
+        options[:step] ||= @dripper.drips.size + 1
+
+        if options[:mailer_class].nil?
+          raise ArgumentError, "You must define :mailer_class or :mailer in the options for #{action.inspect} on #{@dripper.inspect}"
+        end
+
+        if options[:every].nil? && options[:delay].nil?
+          raise ArgumentError, "You must define :delay in the options for #{action.inspect} on #{@dripper.inspect}"
+        end
+
+        options
+      end
+    end
+  end
+end

data/lib/caffeinate/dripper/inferences.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Caffeinate
   module Dripper
+    # Includes the inferred methods based on a Dripper name.
     module Inferences
       def self.included(klass)
         klass.extend ClassMethods
@@ -16,9 +19,11 @@ module Caffeinate
           nil
         end
 
-        # The inferred mailer class
+        # The inferred campaign slug
+        #
+        #   MyCoolDripper => my_cool
         def inferred_campaign_slug
-          "#{name.delete_suffix('Dripper')}".underscore
+          name.delete_suffix('Dripper').to_s.underscore
         end
       end
     end

data/lib/caffeinate/dripper/perform.rb

@@ -2,25 +2,32 @@
 
 module Caffeinate
   module Dripper
-    # Handles delivering a `Caffeinate::Mailing` for the `Caffeinate::Dripper`
+    # Handles delivering a `Caffeinate::Mailing` for the `Caffeinate::Dripper`.
     module Perform
       # :nodoc:
       def self.included(klass)
         klass.extend ClassMethods
       end
 
-      # Delivers the next_caffeinate_mailer for the campaign's subscribers.
+      # Delivers the next_caffeinate_mailer for the campaign's subscribers. Handles with batches based on `batch_size`.
       #
       #   OrderDripper.new.perform!
       #
       # @return nil
       def perform!
-        campaign.caffeinate_campaign_subscriptions.active.includes(:next_caffeinate_mailing).each do |subscriber|
-          if subscriber.next_caffeinate_mailing
-           subscriber.next_caffeinate_mailing.process!
-          end
+        run_callbacks(:before_perform, self)
+        Caffeinate::Mailing
+          .upcoming
+          .unsent
+          .joins(:caffeinate_campaign_subscription)
+          .merge(Caffeinate::CampaignSubscription.active)
+          .in_batches(of: self.class.batch_size)
+          .each do |batch|
+          run_callbacks(:on_perform, self, batch)
+          batch.each(&:process!)
         end
-        true
+        run_callbacks(:after_perform, self)
+        nil
       end
 
       module ClassMethods

data/lib/caffeinate/dripper/periodical.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Dripper
+    module Periodical
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def periodical(action_name, every:, start: -> { ::Caffeinate.config.time_now }, **options, &block)
+          options[:start] = start
+          options[:every] = every
+          drip(action_name, options, &block)
+          after_send do |mailing, _message|
+            if mailing.drip.action == action_name
+              next_mailing = mailing.dup
+              next_mailing.send_at = mailing.drip.send_at(mailing)
+              next_mailing.save!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/dripper/subscriber.rb

@@ -18,8 +18,8 @@ module Caffeinate
         end
 
         # Returns the campaign's `Caffeinate::CampaignSubscriber`
-        def subscribers
-          caffeinate_campaign.caffeinate_campaign_subscribers
+        def subscriptions
+          caffeinate_campaign.caffeinate_campaign_subscriptions
         end
 
         # Subscribes to the campaign.
@@ -34,6 +34,18 @@ module Caffeinate
           caffeinate_campaign.subscribe(subscriber, **args)
         end
 
+        # Unsubscribes from the campaign.
+        #
+        #   OrderDripper.unsubscribe(order, user: order.user)
+        #
+        # @param [ActiveRecord::Base] subscriber The object subscribing
+        # @option [ActiveRecord::Base] :user The associated user (optional)
+        #
+        # @return [Caffeinate::CampaignSubscriber] the CampaignSubscriber
+        def unsubscribe(subscriber, **args)
+          caffeinate_campaign.unsubscribe(subscriber, **args)
+        end
+
         # :nodoc:
         def subscribes_block
           raise(NotImplementedError, 'Define subscribes') unless @subscribes_block

data/lib/caffeinate/dripper_collection.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  class DripperCollection
+    def initialize
+      @registry = {}
+    end
+
+    def register(name, klass)
+      @registry[name.to_sym] = klass
+    end
+
+    def resolve(campaign)
+      @registry[campaign.slug.to_sym].constantize
+    end
+  end
+end

data/lib/caffeinate/engine.rb

@@ -5,15 +5,17 @@ require 'caffeinate/action_mailer'
 require 'caffeinate/active_record/extension'
 
 module Caffeinate
-  # :nodoc:
+  # Adds Caffeinate to Rails
   class Engine < ::Rails::Engine
     isolate_namespace Caffeinate
 
+    # :nocov:
     config.to_prepare do
-      Dir.glob(Rails.root.join("app/drippers/**/*.rb")).each do |file|
-        require file
+      Dir.glob(Rails.root.join(Caffeinate.config.drippers_path, '**', '*.rb')).sort.each do |dripper|
+        require dripper
       end
     end
+    # :nocov:
 
     ActiveSupport.on_load(:action_mailer) do
       include ::Caffeinate::ActionMailer::Extension
@@ -26,7 +28,7 @@ module Caffeinate
     end
 
     ActiveSupport.on_load(:action_view) do
-      ApplicationHelper.send(:include, ::Caffeinate::Helpers)
+      ActionView::Base.include ::Caffeinate::Helpers
     end
   end
 end

data/lib/caffeinate/helpers.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Caffeinate
+  # URL helpers for accessing the mounted Caffeinate instance.
   module Helpers
     def caffeinate_unsubscribe_url(subscription, **options)
       opts = (::ActionMailer::Base.default_url_options || {}).merge(options)

data/lib/caffeinate/mail_ext.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mail
+  # Extend Mail::Message to account for a Caffeinate::Mailing
+  class Message
+    attr_accessor :caffeinate_mailing
+
+    def caffeinate?
+      caffeinate_mailing.present?
+    end
+  end
+end

data/lib/caffeinate/url_helpers.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'caffeinate/helpers'
 
 module Caffeinate
+  # Convenience class for the URL helpers.
   class UrlHelpers
     extend Helpers
   end