activity_notification 1.6.1 → 1.7.0

data/lib/activity_notification/roles/acts_as_notifiable.rb

@@ -115,6 +115,8 @@ module ActivityNotification
       #     Tracked notifications are disabled as default.
       #     When you set true as this :tracked option, default callbacks will be enabled for [:create, :update].
       #     You can use :only, :except and other notify options as hash for this option.
+      #     Tracked notifications are generated synchronously as default configuration.
+      #     You can use :notify_later option as notify options to make tracked notifications generated asynchronously.
       # @example Add all callbacks to generate notifications for creation and update
       #   # app/models/comment.rb
       #   class Comment < ActiveRecord::Base
@@ -133,6 +135,12 @@ module ActivityNotification
       #     belongs_to :article
       #     acts_as_notifiable :users, targets: User.all, tracked: { except: [:update], key: "comment.edited", send_later: false }
       #   end
+      # @example Add callbacks to generate notifications asynchronously for creation only
+      #   # app/models/comment.rb
+      #   class Comment < ActiveRecord::Base
+      #     belongs_to :article
+      #     acts_as_notifiable :users, targets: User.all, tracked: { only: [:create], notify_later: true }
+      #   end
       #
       # * :printable_name or :printable_notifiable_name
       #   * Printable notifiable name.

data/lib/activity_notification/version.rb

@@ -1,3 +1,3 @@
 module ActivityNotification
-  VERSION = "1.6.1"
+  VERSION = "1.7.0"
 end

data/lib/generators/templates/activity_notification.rb

@@ -41,6 +41,9 @@ ActivityNotification.configure do |config|
   # Configure the parent class responsible to send e-mails.
   # config.parent_mailer = 'ActionMailer::Base'
 
+  # Configure the parent job class for delayed notifications.
+  # config.parent_job = 'ActiveJob::Base'
+
   # Configure the parent class for activity_notification controllers.
   # config.parent_controller = 'ApplicationController'
 
@@ -50,4 +53,7 @@ ActivityNotification.configure do |config|
   # Configure default limit number of opened notifications you can get from opened* scope
   config.opened_index_limit = 10
 
+  # Configure ActiveJob queue name for delayed notifications.
+  config.active_job_queue = :activity_notification
+
 end

data/lib/generators/templates/migrations/migration.rb

@@ -1,5 +1,5 @@
 # Migration responsible for creating a table with notifications
-class <%= @migration_name %> < ActiveRecord::Migration
+class <%= @migration_name %> < ActiveRecord::Migration<%= Rails::VERSION::MAJOR >= 5 ? "[#{Rails.version.to_f}]" : "" %>
   # Create tables
   def change
     <% if @migration_tables.include?('notifications') %>create_table :notifications do |t|
@@ -12,7 +12,7 @@ class <%= @migration_name %> < ActiveRecord::Migration
       t.text       :parameters
       t.datetime   :opened_at
 
-      t.timestamps
+      t.timestamps null: false
     end<% else %># create_table :notifications do |t|
     #   t.belongs_to :target,     polymorphic: true, index: true, null: false
     #   t.belongs_to :notifiable, polymorphic: true, index: true, null: false
@@ -23,7 +23,7 @@ class <%= @migration_name %> < ActiveRecord::Migration
     #   t.text       :parameters
     #   t.datetime   :opened_at
     #
-    #   t.timestamps
+    #   t.timestamps null: false
     # end<% end %>
 
     <% if @migration_tables.include?('subscriptions') %>create_table :subscriptions do |t|
@@ -37,7 +37,7 @@ class <%= @migration_name %> < ActiveRecord::Migration
       t.datetime   :unsubscribed_to_email_at
       t.text       :optional_targets
 
-      t.timestamps
+      t.timestamps null: false
     end
     add_index :subscriptions, [:target_type, :target_id, :key], unique: true<% else %># create_table :subscriptions do |t|
     #   t.belongs_to :target,     polymorphic: true, index: true, null: false
@@ -50,7 +50,7 @@ class <%= @migration_name %> < ActiveRecord::Migration
     #   t.datetime   :unsubscribed_to_email_at
     #   t.text       :optional_targets
     #
-    #   t.timestamps
+    #   t.timestamps null: false
     # end
     # add_index :subscriptions, [:target_type, :target_id, :key], unique: true<% end %>
   end

data/spec/concerns/apis/notification_api_spec.rb

@@ -62,6 +62,23 @@ shared_examples_for :notification_api do
         end
       end
 
+      context "with notify_later true" do
+        it "generates notifications later" do
+          expect {
+            described_class.notify(:users, @comment_2, notify_later: true)
+          }.to have_enqueued_job(ActivityNotification::NotifyJob)
+        end
+
+        it "creates notification records later" do
+          perform_enqueued_jobs do
+            described_class.notify(:users, @comment_2, notify_later: true)
+          end
+          expect(@author_user.notifications.unopened_only.count).to eq(1)
+          expect(@user_1.notifications.unopened_only.count).to eq(1)
+          expect(@user_2.notifications.unopened_only.count).to eq(0)
+        end
+      end
+
       context "with send_later false" do
         it "sends notification email now" do
           described_class.notify(:users, @comment_2, send_later: false)
@@ -72,6 +89,14 @@ shared_examples_for :notification_api do
       end
 
       context "with pass_full_options" do
+        before do
+          @original_targets = Comment._notification_targets[:users]
+        end
+
+        after do
+          Comment._notification_targets[:users] = @original_targets
+        end
+
         context "as false (as default)" do
           it "accepts specified lambda with notifiable and key arguments" do
             Comment._notification_targets[:users] = ->(notifiable, key){ User.all if key == 'dummy_key' }
@@ -98,7 +123,23 @@ shared_examples_for :notification_api do
           end
         end
       end
+    end
 
+    describe ".notify_later" do
+      it "generates notifications later" do
+        expect {
+          described_class.notify_later(:users, @comment_2)
+        }.to have_enqueued_job(ActivityNotification::NotifyJob)
+      end
+
+      it "creates notification records later" do
+        perform_enqueued_jobs do
+          described_class.notify_later(:users, @comment_2)
+        end
+        expect(@author_user.notifications.unopened_only.count).to eq(1)
+        expect(@user_1.notifications.unopened_only.count).to eq(1)
+        expect(@user_2.notifications.unopened_only.count).to eq(0)
+      end
     end
 
     describe ".notify_all" do
@@ -136,6 +177,23 @@ shared_examples_for :notification_api do
         end
       end
 
+      context "with notify_later true" do
+        it "generates notifications later" do
+          expect {
+            described_class.notify_all([@author_user, @user_1], @comment_2, notify_later: true)
+          }.to have_enqueued_job(ActivityNotification::NotifyAllJob)
+        end
+
+        it "creates notification records later" do
+          perform_enqueued_jobs do
+            described_class.notify_all([@author_user, @user_1], @comment_2, notify_later: true)
+          end
+          expect(@author_user.notifications.unopened_only.count).to eq(1)
+          expect(@user_1.notifications.unopened_only.count).to eq(1)
+          expect(@user_2.notifications.unopened_only.count).to eq(0)
+        end
+      end
+
       context "with send_later false" do
         it "sends notification email now" do
           described_class.notify_all([@author_user, @user_1], @comment_2, send_later: false)
@@ -146,6 +204,23 @@ shared_examples_for :notification_api do
       end
     end
 
+    describe ".notify_all_later" do
+      it "generates notifications later" do
+        expect {
+          described_class.notify_all_later([@author_user, @user_1], @comment_2)
+        }.to have_enqueued_job(ActivityNotification::NotifyAllJob)
+      end
+
+      it "creates notification records later" do
+        perform_enqueued_jobs do
+          described_class.notify_all_later([@author_user, @user_1], @comment_2)
+        end
+        expect(@author_user.notifications.unopened_only.count).to eq(1)
+        expect(@user_1.notifications.unopened_only.count).to eq(1)
+        expect(@user_2.notifications.unopened_only.count).to eq(0)
+      end
+    end
+
     describe ".notify_to" do
       it "returns created notification" do
         notification = described_class.notify_to(@user_1, @comment_2)
@@ -176,6 +251,22 @@ shared_examples_for :notification_api do
         end
       end
 
+      context "with notify_later true" do
+        it "generates notifications later" do
+          expect {
+            described_class.notify_to(@user_1, @comment_2, notify_later: true)
+          }.to have_enqueued_job(ActivityNotification::NotifyToJob)
+        end
+
+        it "creates notification records later" do
+          perform_enqueued_jobs do
+            described_class.notify_to(@user_1, @comment_2, notify_later: true)
+          end
+          expect(@user_1.notifications.unopened_only.count).to eq(1)
+          expect(@user_2.notifications.unopened_only.count).to eq(0)
+        end
+      end
+
       context "with send_later false" do
         it "sends notification email now" do
           described_class.notify_to(@user_1, @comment_2, send_later: false)
@@ -355,6 +446,22 @@ shared_examples_for :notification_api do
       end
     end
 
+    describe ".notify_later_to" do
+      it "generates notifications later" do
+        expect {
+          described_class.notify_later_to(@user_1, @comment_2)
+        }.to have_enqueued_job(ActivityNotification::NotifyToJob)
+      end
+
+      it "creates notification records later" do
+        perform_enqueued_jobs do
+          described_class.notify_later_to(@user_1, @comment_2)
+        end
+        expect(@user_1.notifications.unopened_only.count).to eq(1)
+        expect(@user_2.notifications.unopened_only.count).to eq(0)
+      end
+    end
+
     describe ".open_all_of" do
       before do
         described_class.notify_to(@user_1, @article, group: @article, key: 'key.1')

data/spec/concerns/models/notifiable_spec.rb

@@ -607,10 +607,10 @@ shared_examples_for :notifiable do
       end
     end
 
-    describe "#notify_to" do
-      it "is an alias of ActivityNotification::Notification.notify_to" do
-        expect(ActivityNotification::Notification).to receive(:notify_to)
-        test_instance.notify_to create(:user)
+    describe "#notify_later" do
+      it "is an alias of ActivityNotification::Notification.notify_later" do
+        expect(ActivityNotification::Notification).to receive(:notify_later)
+        test_instance.notify_later :users
       end
     end
 
@@ -621,6 +621,27 @@ shared_examples_for :notifiable do
       end
     end
 
+    describe "#notify_all_later" do
+      it "is an alias of ActivityNotification::Notification.notify_all_later" do
+        expect(ActivityNotification::Notification).to receive(:notify_all_later)
+        test_instance.notify_all_later [create(:user)]
+      end
+    end
+
+    describe "#notify_to" do
+      it "is an alias of ActivityNotification::Notification.notify_to" do
+        expect(ActivityNotification::Notification).to receive(:notify_to)
+        test_instance.notify_to create(:user)
+      end
+    end
+
+    describe "#notify_later_to" do
+      it "is an alias of ActivityNotification::Notification.notify_later_to" do
+        expect(ActivityNotification::Notification).to receive(:notify_later_to)
+        test_instance.notify_later_to create(:user)
+      end
+    end
+
     describe "#default_notification_key" do
       it "returns '#to_resource_name.default'" do
         expect(test_instance.default_notification_key).to eq("#{test_instance.to_resource_name}.default")

data/spec/concerns/models/subscriber_spec.rb

@@ -338,7 +338,7 @@ shared_examples_for :subscriber do
 
     # Function test for subscriptions
 
-    describe "#notify_to" do
+    describe "#receive_notification_of" do
       before do
         @test_key = 'test_key'
         Comment.acts_as_notifiable described_class.to_s.underscore.pluralize.to_sym, targets: [], email_allowed: true
@@ -353,13 +353,13 @@ shared_examples_for :subscriber do
         end
 
         it "returns created notification" do
-          notification = test_instance.notify_to(@notifiable, key: @test_key)
+          notification = test_instance.receive_notification_of(@notifiable, key: @test_key)
           expect(notification).not_to be_nil
           expect(notification.target).to eq(test_instance)
         end
   
         it "creates notification records" do
-          test_instance.notify_to(@notifiable, key: @test_key)
+          test_instance.receive_notification_of(@notifiable, key: @test_key)
           expect(test_instance.notifications.unopened_only.count).to eq(1)
         end
       end
@@ -374,7 +374,7 @@ shared_examples_for :subscriber do
           it "sends notification email later" do
             expect {
               perform_enqueued_jobs do
-                test_instance.notify_to(@notifiable, key: @test_key)
+                test_instance.receive_notification_of(@notifiable, key: @test_key)
               end
             }.to change { ActivityNotification::Mailer.deliveries.size }.by(1)
             expect(ActivityNotification::Mailer.deliveries.size).to eq(1)
@@ -382,14 +382,14 @@ shared_examples_for :subscriber do
   
           it "sends notification email with active job queue" do
             expect {
-              test_instance.notify_to(@notifiable, key: @test_key)
+              test_instance.receive_notification_of(@notifiable, key: @test_key)
             }.to change(ActiveJob::Base.queue_adapter.enqueued_jobs, :size).by(1)
           end
         end
 
         context "with send_later false" do
           it "sends notification email now" do
-            test_instance.notify_to(@notifiable, key: @test_key, send_later: false)
+            test_instance.receive_notification_of(@notifiable, key: @test_key, send_later: false)
             expect(ActivityNotification::Mailer.deliveries.size).to eq(1)
           end
         end
@@ -402,12 +402,12 @@ shared_examples_for :subscriber do
         end
 
         it "returns nil" do
-          notification = test_instance.notify_to(@notifiable, key: @test_key)
+          notification = test_instance.receive_notification_of(@notifiable, key: @test_key)
           expect(notification).to be_nil
         end
   
         it "does not create notification records" do
-          test_instance.notify_to(@notifiable, key: @test_key)
+          test_instance.receive_notification_of(@notifiable, key: @test_key)
           expect(test_instance.notifications.unopened_only.count).to eq(0)
         end
       end
@@ -422,7 +422,7 @@ shared_examples_for :subscriber do
           it "does not send notification email later" do
             expect {
               perform_enqueued_jobs do
-                test_instance.notify_to(@notifiable, key: @test_key)
+                test_instance.receive_notification_of(@notifiable, key: @test_key)
               end
             }.to change { ActivityNotification::Mailer.deliveries.size }.by(0)
             expect(ActivityNotification::Mailer.deliveries.size).to eq(0)
@@ -430,14 +430,14 @@ shared_examples_for :subscriber do
   
           it "does not send notification email with active job queue" do
             expect {
-              test_instance.notify_to(@notifiable, key: @test_key)
+              test_instance.receive_notification_of(@notifiable, key: @test_key)
             }.to change(ActiveJob::Base.queue_adapter.enqueued_jobs, :size).by(0)
           end
         end
 
         context "with send_later false" do
           it "does not send notification email now" do
-            test_instance.notify_to(@notifiable, key: @test_key, send_later: false)
+            test_instance.receive_notification_of(@notifiable, key: @test_key, send_later: false)
             expect(ActivityNotification::Mailer.deliveries.size).to eq(0)
           end
         end

data/spec/concerns/models/target_spec.rb

@@ -778,10 +778,17 @@ shared_examples_for :target do
 
     # Wrapper methods of Notification class methods
 
-    describe "#notify_to" do
+    describe "#receive_notification_of" do
       it "is an alias of ActivityNotification::Notification.notify_to" do
         expect(ActivityNotification::Notification).to receive(:notify_to)
-        test_instance.notify_to create(:user)
+        test_instance.receive_notification_of create(:user)
+      end
+    end
+
+    describe "#receive_notification_later_of" do
+      it "is an alias of ActivityNotification::Notification.notify_later_to" do
+        expect(ActivityNotification::Notification).to receive(:notify_later_to)
+        test_instance.receive_notification_later_of create(:user)
       end
     end
 

data/spec/generators/migration/migration_generator_spec.rb

@@ -4,7 +4,17 @@ describe ActivityNotification::Generators::MigrationGenerator, type: :generator
 
   # setup_default_destination
   destination File.expand_path("../../../../tmp", __FILE__)
-  before { prepare_destination }
+
+  before do
+    prepare_destination
+  end
+
+  after do
+    if ActivityNotification.config.orm == :active_record
+      ActivityNotification::Notification.reset_column_information
+      ActivityNotification::Subscription.reset_column_information
+    end
+  end
 
   it 'runs generating migration tasks' do
     gen = generator
@@ -21,7 +31,19 @@ describe ActivityNotification::Generators::MigrationGenerator, type: :generator
       describe 'CreateNotifications migration file' do
         subject { file(Dir["tmp/db/migrate/*_create_activity_notification_tables.rb"].first.gsub!('tmp/', '')) }
         it { is_expected.to exist }
-        it { is_expected.to contain(/class CreateActivityNotificationTables < ActiveRecord::Migration/) }
+        if Rails::VERSION::MAJOR >= 5
+          it { is_expected.to contain(/class CreateActivityNotificationTables < ActiveRecord::Migration\[\d\.\d\]/) }
+        else
+          it { is_expected.to contain(/class CreateActivityNotificationTables < ActiveRecord::Migration/) }
+        end
+
+        if ActivityNotification.config.orm == :active_record
+          it 'can be executed to migrate scheme' do
+            require subject
+            CreateActivityNotificationTables.new.migrate(:down)
+            CreateActivityNotificationTables.new.migrate(:up)
+          end
+        end
       end
     end
 
@@ -33,9 +55,20 @@ describe ActivityNotification::Generators::MigrationGenerator, type: :generator
       describe 'CreateCustomNotifications migration file' do
         subject { file(Dir["tmp/db/migrate/*_create_custom_notifications.rb"].first.gsub!('tmp/', '')) }
         it { is_expected.to exist }
-        it { is_expected.to contain(/class CreateCustomNotifications < ActiveRecord::Migration/) }
+        if Rails::VERSION::MAJOR >= 5
+          it { is_expected.to contain(/class CreateCustomNotifications < ActiveRecord::Migration\[\d\.\d\]/) }
+        else
+          it { is_expected.to contain(/class CreateCustomNotifications < ActiveRecord::Migration/) }
+        end
+
+        if ActivityNotification.config.orm == :active_record
+          it 'can be executed to migrate scheme' do
+            require subject
+            CreateActivityNotificationTables.new.migrate(:down)
+            CreateActivityNotificationTables.new.migrate(:up)
+          end
+        end
       end
     end
-
   end
 end