caffeinate 0.1.4 → 0.5.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,25 +28,23 @@ 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)
         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
+        alias campaign caffeinate_campaign
 
         # The defined slug or the inferred slug
         def campaign_slug
-          @_campaign_slug || name.delete_suffix('Campaign')
+          @_campaign_slug || inferred_campaign_slug
         end
       end
     end

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[:current_caffeinate_mailing] = 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

@@ -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
@@ -10,21 +10,55 @@ module Caffeinate
 
         def initialize(dripper)
           @dripper = dripper
-          @drips = []
+          @drips = {}
+        end
+
+        def for(action)
+          @drips[action.to_sym]
         end
 
         # Register the drip
         def register(action, options, &block)
-          @drips << ::Caffeinate::Drip.new(@dripper, 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 { |drip| block.call(drip) }
+          @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
 
       # :nodoc:
@@ -33,9 +67,14 @@ module Caffeinate
       end
 
       module ClassMethods
+        # A collection of Drip objects associated with a given `Caffeinate::Dripper`
+        def drip_collection
+          @drip_collection ||= DripCollection.new(self)
+        end
+
         # A collection of Drip objects associated with a given `Caffeinate::Dripper`
         def drips
-          @drips ||= DripCollection.new(self)
+          drip_collection.values
         end
 
         # Register a drip on the Dripper
@@ -47,18 +86,9 @@ 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?
-
-          drips.register(action_name, options, &block)
+          drip_collection.register(action_name, options, &block)
         end
       end
     end

data/lib/caffeinate/dripper/inferences.rb

@@ -0,0 +1,29 @@
+# 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
+      end
+
+      module ClassMethods
+        # The inferred mailer class
+        def inferred_mailer_class
+          klass_name = "#{name.delete_suffix('Dripper')}Mailer"
+          klass = klass_name.safe_constantize
+          return nil unless klass
+          return klass_name if klass < ::ActionMailer::Base
+
+          nil
+        end
+
+        # The inferred mailer class
+        def inferred_campaign_slug
+          name.delete_suffix('Dripper').to_s.underscore
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/dripper/perform.rb

@@ -2,23 +2,34 @@
 
 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.joins(:next_caffeinate_mailing).includes(:next_caffeinate_mailing).each do |subscriber|
-          subscriber.next_caffeinate_mailing.process!
+        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 do |mailing|
+            mailing.process!
+          end
         end
-        true
+        run_callbacks(:after_perform, self)
+        nil
       end
 
       module ClassMethods

data/lib/caffeinate/dripper/periodical.rb

@@ -0,0 +1,24 @@
+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/engine.rb

@@ -1,29 +1,32 @@
 # frozen_string_literal: true
 
+require 'caffeinate/helpers'
 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(Caffeinate.config.drippers_path, "**", "*.rb")).each do |dripper|
+        require dripper
+      end
+    end
+
     ActiveSupport.on_load(:action_mailer) do
       include ::Caffeinate::ActionMailer::Extension
       ::ActionMailer::Base.register_interceptor(::Caffeinate::ActionMailer::Interceptor)
       ::ActionMailer::Base.register_observer(::Caffeinate::ActionMailer::Observer)
     end
 
-    unless config.eager_load
-      config.to_prepare do
-        Dir.glob("#{Rails.root}/app/drippers/**/*.rb").each do |f|
-          require f
-        end
-      end
-    end
-
     ActiveSupport.on_load(:active_record) do
       extend ::Caffeinate::ActiveRecord::Extension
     end
+
+    ActiveSupport.on_load(:action_view) do
+      ActionView::Base.include ::Caffeinate::Helpers
+    end
   end
 end

data/lib/caffeinate/helpers.rb

@@ -0,0 +1,24 @@
+# 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)
+      Caffeinate::Engine.routes.url_helpers.unsubscribe_campaign_subscription_url(token: subscription.token, **opts)
+    end
+
+    def caffeinate_subscribe_url(subscription, **options)
+      opts = (::ActionMailer::Base.default_url_options || {}).merge(options)
+      Caffeinate::Engine.routes.url_helpers.subscribe_campaign_subscription_url(token: subscription.token, **opts)
+    end
+
+    def caffeinate_unsubscribe_path(subscription, **options)
+      Caffeinate::Engine.routes.url_helpers.unsubscribe_campaign_subscription_path(token: subscription.token, **options)
+    end
+
+    def caffeinate_subscribe_path(subscription, **options)
+      Caffeinate::Engine.routes.url_helpers.subscribe_campaign_subscription_path(token: subscription.token, **options)
+    end
+  end
+end

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

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

data/lib/caffeinate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Caffeinate
-  VERSION = '0.1.4'
+  VERSION = '0.5.0'
 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