caffeinate 2.4 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f6b0a68bbf6e8ec71e469224fb7d466833ea4506e40798536b77b6af7bcb128
-  data.tar.gz: 72ebe49b84468147f0455cdcd9986e582a75df9b2b2f7114ef3e76f453a18b94
+  metadata.gz: 80b37c2c81ad72352314b1515575b4b5d91c78356d8d534075eff1a9bc161881
+  data.tar.gz: de05a62c92be2eec505bf3beabda4488f4a8292c12285745c4eb34c880b8ac1a
 SHA512:
-  metadata.gz: e1d315dab19b59edf7601f43b862648d09867c06218bdb2ff269f49c690087161d195dbd3bbeb465027e46fe1146d4c53a7e820253c11a90f825eba6e027bd3e
-  data.tar.gz: f06087e9f499f8550438113d907741d8c8164637b09a18acc1412135813a8227dde96a57fb23d3febfa499111d6a2daaa337fbfac0d5e9ee0429cb3bbdb03a9f
+  metadata.gz: 2bca9ae1ca715af5abdedb012610a6ff397fbe109176798fcc87e8de8e9b1f24e1282d525289baad168be41c11c8401eca740b09430f843cdeacdb07aefff439
+  data.tar.gz: 5fb91cdf1517ffe52c1cd474ddb53dbf2b912fd49975307697ff6ed43bc7660da2946feb770e2cb6cb5ce49615dee5bce2bd7b10b68a90dd5781ef53fb20ef75

data/README.md

@@ -152,6 +152,19 @@ $ rails g caffeinate:install
 $ rake db:migrate
 ```
 
+Optionally, use different flags for supporting `bigint` or `uuid`:
+
+```bash
+# UUID with pgcrypto (PostgreSQL < 13)                                                                                                         
+rails g caffeinate:install --uuid                                                                                                              
+                                                                                                                                               
+# UUID without pgcrypto (PostgreSQL 13+)                                                                                                       
+rails g caffeinate:install --uuid --skip-pgcrypto                                                                                              
+                                                                                                                                               
+# Or via primary-key-type                                                                                                                      
+rails g caffeinate:install --primary-key-type=uuid --skip-pgcrypto                                                                             
+```
+
 ### Clean up the business logic
 
 Assuming you intend to use Caffeinate to handle emails using ActionMailer, mailers should be responsible for receiving context and creating a `mail` object. Nothing more. (If you are looking for examples that don't use ActionMailer, see [Without ActionMailer](docs/6-without-action-mailer.md).)
@@ -255,7 +268,7 @@ Caffeinate also...
 * ✅ Tested against large databases at AngelList and is performant as hell
 * ✅ Effortlessly handles complex workflows
     - Need to skip a certain mailing? You can!
- 
+
 ## Documentation
 
 * [Getting started, tips and tricks](https://github.com/joshmn/caffeinate/blob/master/docs/README.md)

data/app/models/caffeinate/campaign_subscription.rb

@@ -27,8 +27,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, dependent: :destroy
-    has_many :mailings, class_name: 'Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id, dependent: :destroy
+    has_many :caffeinate_mailings, -> { order(send_at: :asc) }, class_name: 'Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id, dependent: :destroy
+    has_many :mailings, -> { order(send_at: :asc) }, class_name: 'Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id, dependent: :destroy
     has_many :future_mailings, -> { upcoming.unsent }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
 
     has_one :next_caffeinate_mailing, -> { joins(:caffeinate_campaign_subscription).where(caffeinate_campaign_subscriptions: { ended_at: nil, unsubscribed_at: nil }).upcoming.unsent.order(send_at: :asc) }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
@@ -38,7 +38,8 @@ module Caffeinate
     has_one :previous_mailing, -> { sent.order(sent_at: :desc) }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
 
     belongs_to :caffeinate_campaign, class_name: 'Caffeinate::Campaign', foreign_key: :caffeinate_campaign_id
-    alias_attribute :campaign, :caffeinate_campaign
+    alias_method :campaign, :caffeinate_campaign
+    alias_method :campaign=, :caffeinate_campaign=
 
     belongs_to :subscriber, polymorphic: true
     belongs_to :user, polymorphic: true, optional: true

data/app/models/caffeinate/mailing.rb

@@ -20,9 +20,10 @@ module Caffeinate
     self.table_name = 'caffeinate_mailings'
 
     belongs_to :caffeinate_campaign_subscription, class_name: 'Caffeinate::CampaignSubscription'
-    alias_attribute :subscription, :caffeinate_campaign_subscription
+    alias_method :subscription, :caffeinate_campaign_subscription
+    alias_method :subscription=, :caffeinate_campaign_subscription=
     has_one :caffeinate_campaign, through: :caffeinate_campaign_subscription
-    alias_attribute :campaign, :caffeinate_campaign
+    alias_method :campaign, :caffeinate_campaign
 
     scope :upcoming, -> { joins(:caffeinate_campaign_subscription).where(caffeinate_campaign_subscription: ::Caffeinate::CampaignSubscription.active).unsent.unskipped.where('send_at < ?', ::Caffeinate.config.time_now).order('send_at asc') }
     scope :unsent, -> { unskipped.where(sent_at: nil) }
@@ -131,7 +132,7 @@ module Caffeinate
     end
 
     def end_if_no_mailings!
-      end! if future_mailings.empty?
+      caffeinate_campaign_subscription.end! if caffeinate_campaign_subscription.future_mailings.empty?
     end
   end
 end

data/lib/caffeinate/dripper_collection.rb

@@ -20,6 +20,15 @@ module Caffeinate
       @registry.values
     end
 
+    # Caffeinate maintains a couple of class-variables under the hood
+    # that don't get reset between specs (while the db records they cache do
+    # get truncated). This resets the appropriate class-variables between specs
+    def clear_cache!
+      drippers.each do |dripper|
+        dripper.safe_constantize&.instance_variable_set(:@caffeinate_campaign, nil)
+      end
+    end
+
     def clear!
       @registry = {}
     end

data/lib/caffeinate/rspec/helpers.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before(:each) do
+    Caffeinate.dripper_collection.clear_cache!
+  end
+end

data/lib/caffeinate/version.rb

@@ -1,3 +1,3 @@
 module Caffeinate
-  VERSION = "2.4"
+  VERSION = "2.6.0"
 end

data/lib/caffeinate.rb

@@ -39,4 +39,8 @@ module Caffeinate
   def self.setup
     yield config
   end
+
+  def self.test_mode!
+
+  end
 end

data/lib/generators/caffeinate/install_generator.rb

@@ -8,6 +8,43 @@ module Caffeinate
 
       desc 'Creates a Caffeinate initializer and copies migrations to your application.'
 
+      class_option :uuid, type: :boolean, default: false,
+        desc: 'Use UUID primary keys'
+
+      class_option :primary_key_type, type: :string, default: nil,
+        desc: 'Primary key type: uuid, bigint, or integer (default)'
+
+      class_option :skip_pgcrypto, type: :boolean, default: false,
+        desc: 'Skip pgcrypto extension (PostgreSQL 13+ has gen_random_uuid built-in)'
+
+      def primary_key_type
+        return :uuid if options[:uuid]
+        return options[:primary_key_type].to_sym if options[:primary_key_type]
+        nil
+      end
+
+      def primary_key_option
+        return '' unless primary_key_type
+        ", id: :#{primary_key_type}"
+      end
+
+      def foreign_key_type
+        return '' unless primary_key_type
+        ", type: :#{primary_key_type}"
+      end
+
+      def column_type_for_polymorphic
+        case primary_key_type
+        when :uuid then :uuid
+        when :bigint then :bigint
+        else :integer
+        end
+      end
+
+      def enable_pgcrypto?
+        primary_key_type == :uuid && !options[:skip_pgcrypto]
+      end
+
       # :nodoc:
       def copy_initializer
         template 'caffeinate.rb', 'config/initializers/caffeinate.rb'

data/lib/generators/caffeinate/templates/migrations/create_caffeinate_campaign_subscriptions.rb.tt

@@ -4,12 +4,12 @@ class CreateCaffeinateCampaignSubscriptions < ActiveRecord::Migration<%= migrati
   def change
     drop_table :caffeinate_campaign_subscriptions if table_exists?(:caffeinate_campaign_subscriptions)
 
-    create_table :caffeinate_campaign_subscriptions do |t|
-      t.references :caffeinate_campaign, null: false, index: { name: :caffeineate_campaign_subscriptions_on_campaign }, foreign_key: true
+    create_table :caffeinate_campaign_subscriptions<%= primary_key_option %> do |t|
+      t.references :caffeinate_campaign, null: false, index: { name: :caffeineate_campaign_subscriptions_on_campaign }, foreign_key: true<%= foreign_key_type %>
       t.string :subscriber_type, null: false
-      t.integer :subscriber_id, null: false
+      t.<%= column_type_for_polymorphic %> :subscriber_id, null: false
       t.string :user_type
-      t.integer :user_id
+      t.<%= column_type_for_polymorphic %> :user_id
       t.string :token, null: false
       t.datetime :ended_at
       t.string :ended_reason

data/lib/generators/caffeinate/templates/migrations/create_caffeinate_campaigns.rb.tt

@@ -2,7 +2,11 @@
 
 class CreateCaffeinateCampaigns < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :caffeinate_campaigns do |t|
+<% if enable_pgcrypto? -%>
+    enable_extension 'pgcrypto' unless extension_enabled?('pgcrypto')
+
+<% end -%>
+    create_table :caffeinate_campaigns<%= primary_key_option %> do |t|
       t.string :name, null: false
       t.string :slug, null: false
       t.boolean :active, default: true, null: false

data/lib/generators/caffeinate/templates/migrations/create_caffeinate_mailings.rb.tt

@@ -2,8 +2,8 @@
 
 class CreateCaffeinateMailings < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :caffeinate_mailings do |t|
-      t.references :caffeinate_campaign_subscription, null: false, foreign_key: true, index: { name: 'index_caffeinate_mailings_on_campaign_subscription' }
+    create_table :caffeinate_mailings<%= primary_key_option %> do |t|
+      t.references :caffeinate_campaign_subscription, null: false, foreign_key: true, index: { name: 'index_caffeinate_mailings_on_campaign_subscription' }<%= foreign_key_type %>
       t.datetime :send_at, null: false
       t.datetime :sent_at
       t.datetime :skipped_at

metadata

@@ -1,17 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: caffeinate
 version: !ruby/object:Gem::Version
-  version: '2.4'
+  version: 2.6.0
 platform: ruby
 authors:
 - Josh Brody
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,6 +135,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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
@@ -108,6 +163,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  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: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +260,7 @@ files:
 - lib/caffeinate/perform.rb
 - lib/caffeinate/periodical_drip.rb
 - lib/caffeinate/rspec.rb
+- lib/caffeinate/rspec/helpers.rb
 - lib/caffeinate/rspec/matchers.rb
 - lib/caffeinate/rspec/matchers/be_subscribed_to_caffeinate_campaign.rb
 - lib/caffeinate/rspec/matchers/end_caffeinate_campaign_subscription.rb
@@ -212,7 +282,6 @@ homepage: https://github.com/joshmn/caffeinate
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -227,8 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 4.0.1
 specification_version: 4
 summary: Create, manage, and send scheduled email sequences and drip campaigns from
   your Rails app.