caffeinate 0.2.1 → 0.7.0

data/lib/caffeinate/dripper/campaign.rb

@@ -28,18 +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 Dripper
+        # 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[campaign_slug]
+          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
+
+          @caffeinate_campaign
         end
+        alias campaign caffeinate_campaign
 
         # The defined slug or the inferred slug
         def campaign_slug

data/lib/caffeinate/dripper/defaults.rb

@@ -24,6 +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.symbolize_keys!
           options.assert_valid_keys(:mailer_class, :mailer, :using, :batch_size)
           @defaults = options
         end

data/lib/caffeinate/dripper/delivery.rb

@@ -14,13 +14,13 @@ module Caffeinate
         #
         # @param [Caffeinate::Mailing] mailing The mailing to deliver
         def deliver!(mailing)
-          Caffeinate.current_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

@@ -1,40 +1,10 @@
 # frozen_string_literal: true
 
+require 'caffeinate/dripper/drip_collection'
 module Caffeinate
   module Dripper
     # 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, :at)
+        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

@@ -19,7 +19,9 @@ module Caffeinate
           nil
         end
 
-        # The inferred mailer class
+        # The inferred campaign slug
+        #
+        #   MyCoolDripper => my_cool
         def inferred_campaign_slug
           name.delete_suffix('Dripper').to_s.underscore
         end

data/lib/caffeinate/dripper/perform.rb

@@ -9,22 +9,24 @@ module Caffeinate
         klass.extend ClassMethods
       end
 
-      # Delivers the next_caffeinate_mailer for the campaign's subscribers.
-      #
-      # Handles with batches based on batch_size.
+      # Delivers the next_caffeinate_mailer for the campaign's subscribers. Handles with batches based on `batch_size`.
       #
       #   OrderDripper.new.perform!
       #
       # @return nil
       def perform!
-        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
+        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
-        run_callbacks(:after_process, self)
+        run_callbacks(:after_perform, self)
         nil
       end
 

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

@@ -8,7 +8,14 @@ module Caffeinate
   # Adds Caffeinate to Rails
   class Engine < ::Rails::Engine
     isolate_namespace Caffeinate
-    config.eager_load_namespaces << Caffeinate
+
+    # :nocov:
+    config.to_prepare do
+      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
@@ -21,7 +28,7 @@ module Caffeinate
     end
 
     ActiveSupport.on_load(:action_view) do
-      ApplicationHelper.include ::Caffeinate::Helpers
+      ActionView::Base.include ::Caffeinate::Helpers
     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/version.rb

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

data/lib/generators/caffeinate/install_generator.rb

@@ -20,7 +20,7 @@ module Caffeinate
       end
 
       def install_routes
-        inject_into_file 'config/routes.rb', "\n  mount ::Caffeinate::Engine => '/caffeinate", after: /Rails.application.routes.draw do/
+        inject_into_file 'config/routes.rb', "\n  mount ::Caffeinate::Engine => '/caffeinate'", after: /Rails.application.routes.draw do/
       end
 
       # :nodoc:

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

@@ -31,4 +31,14 @@ Caffeinate.setup do |config|
   #   config.batch_size = 1_000
   #
   # config.batch_size = 100
+  #
+  # == Implicit Campaigns
+  #
+  # Instead of manually having to create a Campaign, you can let Caffeinate do a `find_or_create_by` at runtime.
+  # This is probably dangerous but it hasn't burned me yet so here you go:
+  #
+  # Default:
+  #   config.implicit_campaigns = true
+  #
+  # config.implicit_campaigns = false
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caffeinate
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-28 00:00:00.000000000 Z
+date: 2020-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -126,7 +140,7 @@ files:
 - app/models/caffeinate/mailing.rb
 - app/views/caffeinate/campaign_subscriptions/subscribe.html.erb
 - app/views/caffeinate/campaign_subscriptions/unsubscribe.html.erb
-- app/views/layouts/caffeinate.html.erb
+- app/views/layouts/_caffeinate.html.erb
 - config/locales/en.yml
 - config/routes.rb
 - db/migrate/20201124183102_create_caffeinate_campaigns.rb
@@ -149,11 +163,15 @@ files:
 - lib/caffeinate/dripper/defaults.rb
 - lib/caffeinate/dripper/delivery.rb
 - lib/caffeinate/dripper/drip.rb
+- lib/caffeinate/dripper/drip_collection.rb
 - lib/caffeinate/dripper/inferences.rb
 - lib/caffeinate/dripper/perform.rb
+- lib/caffeinate/dripper/periodical.rb
 - lib/caffeinate/dripper/subscriber.rb
+- lib/caffeinate/dripper_collection.rb
 - lib/caffeinate/engine.rb
 - lib/caffeinate/helpers.rb
+- lib/caffeinate/mail_ext.rb
 - lib/caffeinate/url_helpers.rb
 - lib/caffeinate/version.rb
 - lib/generators/caffeinate/install_generator.rb