caffeinate 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3032e43fad1742429e8961a3bfca1e522c9fcf19714c8cc998d6dea629c30a6e
-  data.tar.gz: a51f59c2d0767d18002051827590d31a7ab0b96ae570a1c048d0a37ab4446007
+  metadata.gz: 3241ca7ca0c6e31220511ad04172105d97058fa84f1de1e6ac442052823a91e0
+  data.tar.gz: 5b0bda6f08ae89f79cbd64df4c75f48fcb0dacf7471155aae779290b6a1b2e41
 SHA512:
-  metadata.gz: ede225ce8d0fbb71214411d38366ea43992da7b95428734af5c4134f496c04d2dbf2b4a940f19ffbbf24dde9c4536834b96051bd493ec3476897f6f376b2324a
-  data.tar.gz: acc6124e88a4d8e6beced5afc80e7774de78b60858940e579f821ed172ad14f6a033e7b0419c105c233806f94005f98d4dab73f25bbb53e40175d7dca289c9f2
+  metadata.gz: d43a0030851c7fa107fed83fcc05c9cfa8596be068a8327d01f597a0a45fc84aa403d1a95990e8a4c45013fb44bc899215778d36ce8a8f5cc770db50b33cd0df
+  data.tar.gz: 6f9e399cc7e0a00bbb544b668d80e0438f4482013f3163a819b9f2ab8ea502f3c8535aacb91d57eb80efc5f12c22bd03a2bdfd36c2216544bb9aa1fd6928e797

data/README.md

@@ -1,81 +1,89 @@
 # Caffeinate
 
-Ruby on Rails drip campaign engine. 
+Caffeinate is a drip campaign engine for Ruby on Rails applications.
 
-## Are there docs?
-
-[Since you asked](https://rubydoc.info/github/joshmn/caffeinate).
+Caffeinate tries to make creating and managing timed and scheduled email sequences fun. It works alongside ActionMailer 
+and has everything you need to get started and to successfully manage campaigns. It's only dependency is the stack you're
+already familiar with: Ruby on Rails.
 
 ## Usage
 
-Given a mailer like this:
+You can probably imagine seeing a Mailer like this:
 
 ```ruby 
-class AbandonedCartMailer < ActionMailer::Base 
-  def you_forgot_something(cart)
-    mail(to: cart.user.email, subject: "You forgot something!")
+class OnboardingMailer < ActionMailer::Base 
+  # Send on account creation
+  def welcome_to_my_cool_app(user)
+    mail(to: user.email, subject: "You forgot something!")
   end
 
-  def selling_out_soon(cart)
-    mail(to: cart.user.email, subject: "Selling out soon!")
+  # Send 2 days after the user signs up
+  def some_cool_tips(user)
+    mail(to: user.email, subject: "Here are some cool tips for MyCoolApp")
+  end 
+
+  # Sends 3 days after the user signs up and hasn't added a company profile yet
+  def help_getting_started(user)
+    return if user.company.present?
+
+    mail(to: user.email, subject: "Did you know...")
   end 
 end 
 ```
 
+With background jobs running, checking, and everything else. That's messy. Why are we checking state in the Mailer? Ugh.
+
+We can clean this up with Caffeinate. Here's how we'd do it.
+
 ### Create a Campaign
 
 ```ruby 
-Caffeinate::Campaign.create!(name: "Abandoned Cart", slug: "abandoned_cart") 
+Caffeinate::Campaign.create!(name: "Onboarding Campaign", slug: "onboarding") 
 ```
 
 ### Create a Caffeinate::Dripper
 
+Place the contents below in `app/drippers/onboarding_dripper.rb`:
+
 ```ruby 
-class AbandonedCartDripper < Caffeinate::Dripper::Base
-  # This should match a Caffeinate::Campaign#slug
-  campaign :abandoned_cart 
-  
-  # A block to subscribe your users automatically 
-  # You can invoke this by calling `AbandonedCartDripper.subscribe!`,
-  # probably in a background process, run at a given interval 
-  subscribes do 
-    Cart.left_joins(:cart_items)
-        .includes(:user)
-        .where(completed_at: nil)
-        .where(updated_at: 1.day.ago..2.days.ago)
-        .having('count(cart_items.id) = 0').each do |cart|
-      subscribe(cart, user: cart.user)
-    end 
-  end 
-  
-  # Register your drips! Syntax is
-  # drip <mailer_action_name>, mailer: <MailerClass>, delay: <ActiveSupport::Interval>
-  drip :you_forgot_something, mailer: "AbandonedCartMailer", delay: 1.hour 
-  drip :selling_out_soon, mailer: "AbandonedCartMailer", delay: 8.hours do 
-    cart = mailing.subscriber
-    if cart.completed?
-      end! # you can also invoke `unsubscribe!` to cancel this mailing and all future mailings
+class OnboardingDripper < ApplicationDripper
+  drip :welcome_to_my_cool_app, delay: 0.hours
+  drip :some_cool_tips, delay: 2.days
+  drip :help_getting_started, delay: 3.days do 
+    if mailing.user.company.present?
+      mailing.unsubscribe!
       return false
-    end 
-  end 
+    end
+  end
 end 
 ```
 
-Automatically subscribe eligible carts to it by running:
+### Add a subscriber to the Campaign
 
 ```ruby 
-AbandonedCartDripper.subscribe!
+class User < ApplicationRecord
+  after_create_commit do 
+    Caffeinate::Campaign.find_by(slug: "onboarding").subscribe(self)
+  end 
+end
 ```
 
-This would typically run in a background job, queued up at a given interval.
+### Run the Dripper
 
-And then, once it's done, start your engines!
+You'd normally want to do this in a cron/whenever/scheduled Sidekiq/etc job.
 
-```ruby 
-AbandonedCartDripper.perform!
+```ruby
+OnboardingDripper.perform!
 ```
 
-This, too, would typically run in a background job, queued up at a given interval.
+### Spend more time building
+
+Now you can spend more time building your app and less time managing your marketing campaigns.
+* Centralized logic makes it easy to understand the flow
+* Subscription management, timings, send history all built-in
+* Built on the stack you're already familiar with
+
+There's a lot more than what you just saw, too! Caffeinate almost makes managing timed email sequences fun. 
 
 ## Installation
 
@@ -103,6 +111,11 @@ Followed by a migrate:
 $ rails db:migrate
 ```
 
+## Documentation
+
+* [Getting started, tips and tricks](https://github.com/joshmn/caffeinate/blob/master/docs/README.md) 
+* [Better-than-average code documentation](https://rubydoc.info/github/joshmn/caffeinate)
+
 ## Upcoming features/todo
 
 * Ability to optionally use relative start time when creating a step 

data/app/models/caffeinate/campaign.rb

@@ -22,9 +22,38 @@ module Caffeinate
       Caffeinate.dripper_to_campaign_class[slug.to_sym].constantize
     end
 
+    # Convenience method for find_by!(slug: value)
+    #
+    #   ::Caffeinate::Campaign[:onboarding]
+    #   # is the same as
+    #   ::Caffeinate::Campaign.find_by(slug: :onboarding)
+    def self.[](val)
+      find_by!(slug: val)
+    end
+
+    # Checks to see if the subscriber exists.
+    #
+    # Use `find_by` so that we don't have to load the record twice. Often used with `subscribes?`
+    def subscriber(record, **args)
+      @subscriber ||= caffeinate_campaign_subscriptions.find_by(subscriber: record, **args)
+    end
+
+    # Check if the subscriber exists
+    def subscribes?(record, **args)
+      subscriber(record, **args).present?
+    end
+
     # Subscribes an object to a campaign.
     def subscribe(subscriber, **args)
       caffeinate_campaign_subscriptions.find_or_create_by(subscriber: subscriber, **args)
     end
+
+    # Subscribes an object to a campaign.
+    def subscribe!(subscriber, **args)
+      subscription = subscribe(subscriber, **args)
+      return subscription if subscribe.persisted?
+
+      raise ActiveRecord::RecordInvalid, subscription
+    end
   end
 end

data/app/models/caffeinate/campaign_subscription.rb

@@ -22,8 +22,8 @@ module Caffeinate
   class CampaignSubscription < ApplicationRecord
     self.table_name = 'caffeinate_campaign_subscriptions'
 
-    has_many :caffeinate_mailings, class_name: 'Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
-    has_one :next_caffeinate_mailing, -> { upcoming.unsent.limit(1).first }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
+    has_many :caffeinate_mailings, class_name: 'Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id, dependent: :destroy
+    has_one :next_caffeinate_mailing, -> { upcoming.unsent }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
     belongs_to :caffeinate_campaign, class_name: 'Caffeinate::Campaign', foreign_key: :caffeinate_campaign_id
     belongs_to :subscriber, polymorphic: true
     belongs_to :user, polymorphic: true, optional: true
@@ -78,6 +78,13 @@ module Caffeinate
       caffeinate_campaign.to_dripper.run_callbacks(:on_unsubscribe, self)
     end
 
+    # Updates `unsubscribed_at` to nil and runs `on_subscribe` callbacks
+    def resubscribe!
+      update!(unsubscribed_at: nil, resubscribed_at: ::Caffeinate.config.time_now)
+
+      caffeinate_campaign.to_dripper.run_callbacks(:on_resubscribe, self)
+    end
+
     private
 
     # Create mailings according to the drips registered in the Campaign

data/app/models/caffeinate/mailing.rb

@@ -17,7 +17,7 @@
 module Caffeinate
   # Records of the mails sent and to be sent for a given `::Caffeinate::CampaignSubscriber`
   class Mailing < ApplicationRecord
-    CURRENT_THREAD_KEY = :current_caffeinate_mailing.freeze
+    CURRENT_THREAD_KEY = :current_caffeinate_mailing
 
     self.table_name = 'caffeinate_mailings'
 

data/db/migrate/20201124183303_create_caffeinate_campaign_subscriptions.rb

@@ -12,6 +12,7 @@ class CreateCaffeinateCampaignSubscriptions < ActiveRecord::Migration[6.0]
       t.string :user_id
       t.string :token, null: false
       t.datetime :ended_at
+      t.datetime :resubscribed_at
       t.datetime :unsubscribed_at
 
       t.timestamps

data/lib/caffeinate.rb

@@ -28,4 +28,14 @@ module Caffeinate
   def self.setup
     yield config
   end
+
+  # The current mailing
+  def self.current_mailing=(val)
+    Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY] = val
+  end
+
+  # The current mailing
+  def self.current_mailing
+    Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY]
+  end
 end

data/lib/caffeinate/action_mailer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'caffeinate/action_mailer/extension'
-require 'caffeinate/action_mailer/helpers'
-require 'caffeinate/action_mailer/interceptor'
-require 'caffeinate/action_mailer/observer'
+require 'mail'
+
+# Includes all files in `caffeinate/action_mailer`
+Dir["#{__dir__}/action_mailer/*"].each { |path| require "caffeinate/action_mailer/#{File.basename(path)}" }

data/lib/caffeinate/action_mailer/extension.rb

@@ -2,21 +2,27 @@
 
 module Caffeinate
   module ActionMailer
+    # Convenience for setting `@mailing`, and convenience methods for inferred `caffeinate_unsubscribe_url` and
+    # `caffeinate_subscribe_url`.
     module Extension
       def self.included(klass)
         klass.before_action do
-          @mailing = Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY] if Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY]
+          @mailing = Caffeinate.current_mailing if Caffeinate.current_mailing
         end
 
         klass.helper_method :caffeinate_unsubscribe_url, :caffeinate_subscribe_url
       end
 
-      def caffeinate_unsubscribe_url(**options)
-        Caffeinate::UrlHelpers.caffeinate_unsubscribe_url(@mailing.caffeinate_campaign_subscription, **options)
+      # Assumes `@mailing` is set
+      def caffeinate_unsubscribe_url(mailing: nil, **options)
+        mailing ||= @mailing
+        Caffeinate::UrlHelpers.caffeinate_unsubscribe_url(mailing.caffeinate_campaign_subscription, **options)
       end
 
-      def caffeinate_subscribe_url
-        Caffeinate::UrlHelpers.caffeinate_subscribe_url(@mailing.caffeinate_campaign_subscription, **options)
+      # Assumes `@mailing` is set
+      def caffeinate_subscribe_url(mailing: nil, **options)
+        mailing ||= @mailing
+        Caffeinate::UrlHelpers.caffeinate_subscribe_url(mailing.caffeinate_campaign_subscription, **options)
       end
     end
   end

data/lib/caffeinate/action_mailer/interceptor.rb

@@ -2,10 +2,12 @@
 
 module Caffeinate
   module ActionMailer
+    # Handles the evaluation of a drip against a mailing to determine if it ultimately gets delivered.
+    # Also invokes the `before_send` callbacks.
     class Interceptor
       # Handles `before_send` callbacks for a `Caffeinate::Dripper`
       def self.delivering_email(message)
-        mailing = Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY]
+        mailing = Caffeinate.current_mailing
         return unless mailing
 
         mailing.caffeinate_campaign.to_dripper.run_callbacks(:before_send, mailing.caffeinate_campaign_subscription, mailing, message)

data/lib/caffeinate/action_mailer/observer.rb

@@ -2,11 +2,11 @@
 
 module Caffeinate
   module ActionMailer
-    # Handles updating the Caffeinate::Message if it's available in Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY]
+    # Handles updating the Caffeinate::Message if it's available in Caffeinate.current_mailing
     # and runs any associated callbacks
     class Observer
       def self.delivered_email(message)
-        mailing = Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY]
+        mailing = Caffeinate.current_mailing
         return unless mailing
 
         mailing.update!(sent_at: Caffeinate.config.time_now, skipped_at: nil) if message.perform_deliveries

data/lib/caffeinate/active_record/extension.rb

@@ -2,10 +2,11 @@
 
 module Caffeinate
   module ActiveRecord
+    # Includes the ActiveRecord association and relevant scopes for an ActiveRecord-backed model
     module Extension
       # Adds the associations for a subscriber
       def caffeinate_subscriber
-        has_many :caffeinate_campaign_subscriptions, as: :subscriber, class_name: '::Caffeinate::CampaignSubscription'
+        has_many :caffeinate_campaign_subscriptions, as: :subscriber, class_name: '::Caffeinate::CampaignSubscription', dependent: :destroy
         has_many :caffeinate_campaigns, through: :caffeinate_campaign_subscriptions, class_name: '::Caffeinate::Campaign'
         has_many :caffeinate_mailings, through: :caffeinate_campaign_subscriptions, class_name: '::Caffeinate::Mailing'
 

data/lib/caffeinate/configuration.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 module Caffeinate
+  # Global configuration
   class Configuration
-    attr_accessor :now, :async_delivery, :mailing_job
+    attr_accessor :now, :async_delivery, :mailing_job, :batch_size
 
     def initialize
       @now = -> { Time.current }
       @async_delivery = false
       @mailing_job = nil
+      @batch_size = 1_000
     end
 
     def now=(val)

data/lib/caffeinate/drip_evaluator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Caffeinate
   # Handles evaluating the `drip` block and provides convenience methods for handling the mailing or its campaign.
   class DripEvaluator

data/lib/caffeinate/dripper/base.rb

@@ -1,17 +1,20 @@
 # frozen_string_literal: true
 
-require 'caffeinate/dripper/drip'
-require 'caffeinate/dripper/inferences'
+require 'caffeinate/dripper/batching'
 require 'caffeinate/dripper/callbacks'
-require 'caffeinate/dripper/defaults'
-require 'caffeinate/dripper/subscriber'
 require 'caffeinate/dripper/campaign'
-require 'caffeinate/dripper/perform'
+require 'caffeinate/dripper/defaults'
 require 'caffeinate/dripper/delivery'
+require 'caffeinate/dripper/drip'
+require 'caffeinate/dripper/inferences'
+require 'caffeinate/dripper/perform'
+require 'caffeinate/dripper/subscriber'
 
 module Caffeinate
   module Dripper
+    # Base class
     class Base
+      include Batching
       include Callbacks
       include Campaign
       include Defaults

data/lib/caffeinate/dripper/batching.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  # Includes batch support for setting the batch size for Perform
+  module Batching
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def batch_size(num)
+        @_batch_size = num
+      end
+
+      def _batch_size
+        @_batch_size || ::Caffeinate.config.batch_size
+      end
+    end
+  end
+end

data/lib/caffeinate/dripper/callbacks.rb

@@ -2,12 +2,17 @@
 
 module Caffeinate
   module Dripper
+    # Callbacks for a Dripper.
     module Callbacks
       # :nodoc:
       def self.included(klass)
         klass.extend ClassMethods
       end
 
+      def run_callbacks(name, *args)
+        self.class.run_callbacks(name, *args)
+      end
+
       module ClassMethods
         # :nodoc:
         def run_callbacks(name, *args)
@@ -33,6 +38,56 @@ module Caffeinate
           @on_subscribe_blocks ||= []
         end
 
+        # Callback before the mailings get processed.
+        #
+        #   before_process do |dripper|
+        #     Slack.notify(:caffeinate, "Dripper is getting ready for mailing! #{dripper.caffeinate_campaign.name}!")
+        #   end
+        #
+        # @yield Caffeinate::Dripper
+        def before_process(&block)
+          before_process_blocks << block
+        end
+
+        # :nodoc:
+        def before_process_blocks
+          @before_process_blocks ||= []
+        end
+
+        # Callback before the mailings get processed in a batch.
+        #
+        #   after_process do |dripper, mailings|
+        #     Slack.notify(:caffeinate, "Dripper #{dripper.name} sent #{mailings.size} mailings! Whoa!")
+        #   end
+        #
+        # @yield Caffeinate::Dripper
+        # @yield Caffeinate::Mailing [Array]
+        def on_process(&block)
+          on_process_blocks << block
+        end
+
+        # :nodoc:
+        def on_process_blocks
+          @on_process_blocks ||= []
+        end
+
+        # Callback after the all the mailings have been sent.
+        #
+        #   after_process do |dripper|
+        #     Slack.notify(:caffeinate, "Dripper #{dripper.name} sent #{mailings.size} mailings! Whoa!")
+        #   end
+        #
+        # @yield Caffeinate::Dripper
+        # @yield Caffeinate::Mailing [Array]
+        def after_process(&block)
+          after_process_blocks << block
+        end
+
+        # :nodoc:
+        def after_process_blocks
+          @after_process_blocks ||= []
+        end
+
         # Callback before a Drip has called the mailer.
         #
         #   before_drip do |campaign_subscription, mailing, drip|
@@ -125,8 +180,8 @@ module Caffeinate
         #     Slack.notify(:caffeinate, "#{campaign_sub.id} has unsubscribed... sad day.")
         #   end
         #
-        # @yield Caffeinate::CampaignSubscription
-        # @yield Caffeinate::Mailing
+        # @yield `Caffeinate::CampaignSubscription`
+        # @yield `Caffeinate::Mailing`
         def on_skip(&block)
           on_skip_blocks << block
         end

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
         #
@@ -33,14 +34,11 @@ module Caffeinate
           Caffeinate.register_dripper(@_campaign_slug, name)
         end
 
-        # Returns the `Caffeinate::Campaign` object for the Campaign
+        # Returns the `Caffeinate::Campaign` object for the Dripper
         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
-
-          raise(::ActiveRecord::RecordNotFound, "Unable to find ::Caffeinate::Campaign with slug #{campaign_slug}.")
+          @caffeinate_campaign = ::Caffeinate::Campaign[campaign_slug]
         end
 
         # The defined slug or the inferred 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,7 @@ 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.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,7 +14,7 @@ module Caffeinate
         #
         # @param [Caffeinate::Mailing] mailing The mailing to deliver
         def deliver!(mailing)
-          Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY] = mailing
+          Caffeinate.current_mailing = mailing
 
           if mailing.drip.parameterized?
             mailing.mailer_class.constantize.with(mailing: mailing).send(mailing.mailer_action).deliver

data/lib/caffeinate/dripper/drip.rb

@@ -2,7 +2,7 @@
 
 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

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
@@ -18,7 +21,7 @@ module Caffeinate
 
         # The inferred mailer class
         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,7 +2,7 @@
 
 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)
@@ -11,16 +11,21 @@ module Caffeinate
 
       # 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!
+        run_callbacks(:before_process, self)
+        campaign.caffeinate_campaign_subscriptions.active.in_batches(of: self.class._batch_size).each do |batch|
+          run_callbacks(:on_process, self, batch)
+          batch.each do |subscriber|
+            subscriber.next_caffeinate_mailing&.process!
           end
         end
-        true
+        run_callbacks(:after_process, self)
+        nil
       end
 
       module ClassMethods

data/lib/caffeinate/engine.rb

@@ -5,15 +5,10 @@ require 'caffeinate/action_mailer'
 require 'caffeinate/active_record/extension'
 
 module Caffeinate
-  # :nodoc:
+  # Adds Caffeinate to Rails
   class Engine < ::Rails::Engine
     isolate_namespace Caffeinate
-
-    config.to_prepare do
-      Dir.glob(Rails.root.join("app/drippers/**/*.rb")).each do |file|
-        require file
-      end
-    end
+    config.eager_load_namespaces << Caffeinate
 
     ActiveSupport.on_load(:action_mailer) do
       include ::Caffeinate::ActionMailer::Extension
@@ -26,7 +21,7 @@ module Caffeinate
     end
 
     ActiveSupport.on_load(:action_view) do
-      ApplicationHelper.send(:include, ::Caffeinate::Helpers)
+      ApplicationHelper.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/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

data/lib/caffeinate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Caffeinate
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/generators/caffeinate/install_generator.rb

@@ -2,7 +2,7 @@
 
 module Caffeinate
   module Generators
-    # :nodoc:
+    # Installs Caffeinate
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path('templates', __dir__)
       include ::Rails::Generators::Migration
@@ -19,6 +19,10 @@ module Caffeinate
         template 'application_dripper.rb', 'app/drippers/application_dripper.rb'
       end
 
+      def install_routes
+        inject_into_file 'config/routes.rb', "\n  mount ::Caffeinate::Engine => '/caffeinate", after: /Rails.application.routes.draw do/
+      end
+
       # :nodoc:
       def self.next_migration_number(_path)
         if @prev_migration_nr

data/lib/generators/caffeinate/templates/caffeinate.rb

@@ -6,7 +6,7 @@ Caffeinate.setup do |config|
   # Used for when we set a datetime column to "now" in the database
   #
   # Default:
-  #   -> { Time.current }
+  #   config.now = -> { Time.current }
   #
   # config.now = -> { DateTime.now }
   #
@@ -21,4 +21,14 @@ Caffeinate.setup do |config|
   #
   # config.async_delivery = true
   # config.mailing_job = 'MyCustomCaffeinateJob'
+  #
+  # == Batching
+  #
+  # When a Dripper is performed and sends the mails, we use `find_in_batches`. Use `batch_size` to set the batch size.
+  # You can set this on a dripper as well for more granular control.
+  #
+  # Default:
+  #   config.batch_size = 1_000
+  #
+  # config.batch_size = 100
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caffeinate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-27 00:00:00.000000000 Z
+date: 2020-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -135,7 +135,6 @@ files:
 - lib/caffeinate.rb
 - lib/caffeinate/action_mailer.rb
 - lib/caffeinate/action_mailer/extension.rb
-- lib/caffeinate/action_mailer/helpers.rb
 - lib/caffeinate/action_mailer/interceptor.rb
 - lib/caffeinate/action_mailer/observer.rb
 - lib/caffeinate/active_record/extension.rb
@@ -144,6 +143,7 @@ files:
 - lib/caffeinate/drip.rb
 - lib/caffeinate/drip_evaluator.rb
 - lib/caffeinate/dripper/base.rb
+- lib/caffeinate/dripper/batching.rb
 - lib/caffeinate/dripper/callbacks.rb
 - lib/caffeinate/dripper/campaign.rb
 - lib/caffeinate/dripper/defaults.rb

data/lib/caffeinate/action_mailer/helpers.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Caffeinate
-  module ActionMailer
-    module Helpers
-      def caffeinate_unsubscribe_url(caffeinate_campaign_subscription, **options)
-        opts = (::ActionMailer::Base.default_url_options || {}).merge(options)
-        Caffeinate::Engine.routes.url_helpers.caffeinate_unsubscribe_url(token: caffeinate_campaign_subscription.token, **opts)
-      end
-    end
-  end
-end