activity_notification 2.1.4 → 2.2.3

data/spec/channels/notification_channel_spec.rb

@@ -1,50 +1,48 @@
-if Rails::VERSION::MAJOR >= 5
-  require 'channels/notification_channel_shared_examples'
-
-  # @See https://github.com/palkan/action-cable-testing
-  describe ActivityNotification::NotificationChannel, type: :channel do
-    let(:test_target)        { create(:user) }
-    let(:target_type)        { "User" }
-    let(:typed_target_param) { "user_id" }
-    let(:extra_params)       { {} }
-
-    context "when target.notification_action_cable_with_devise? returns true" do
-      before do
-        @user_notification_action_cable_with_devise = User._notification_action_cable_with_devise
-        User._notification_action_cable_with_devise = true
-      end
-
-      after do
-        User._notification_action_cable_with_devise = @user_notification_action_cable_with_devise
-      end
-
-      it "rejects subscription even if target_type and target_id parameters are passed" do
-        subscribe({ target_type: target_type, target_id: test_target.id })
-        expect(subscription).to be_rejected
-        expect {
-          expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
-        }.to raise_error(/Must be subscribed!/)
-      end
+require 'channels/notification_channel_shared_examples'
+
+# @See https://github.com/palkan/action-cable-testing
+describe ActivityNotification::NotificationChannel, type: :channel do
+  let(:test_target)        { create(:user) }
+  let(:target_type)        { "User" }
+  let(:typed_target_param) { "user_id" }
+  let(:extra_params)       { {} }
+
+  context "when target.notification_action_cable_with_devise? returns true" do
+    before do
+      @user_notification_action_cable_with_devise = User._notification_action_cable_with_devise
+      User._notification_action_cable_with_devise = true
     end
 
-    context "when target.notification_action_cable_with_devise? returns false" do
-      before do
-        @user_notification_action_cable_with_devise = User._notification_action_cable_with_devise
-        User._notification_action_cable_with_devise = false
-      end
-
-      after do
-        User._notification_action_cable_with_devise = @user_notification_action_cable_with_devise
-      end
+    after do
+      User._notification_action_cable_with_devise = @user_notification_action_cable_with_devise
+    end
 
-      it "successfully subscribes with target_type and target_id parameters" do
-        subscribe({ target_type: target_type, target_id: test_target.id })
-        expect(subscription).to be_confirmed
+    it "rejects subscription even if target_type and target_id parameters are passed" do
+      subscribe({ target_type: target_type, target_id: test_target.id })
+      expect(subscription).to be_rejected
+      expect {
         expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
-        expect(subscription).to have_stream_from("activity_notification_channel_User##{test_target.id}")
-      end
+      }.to raise_error(/Must be subscribed!/)
+    end
+  end
 
-      it_behaves_like :notification_channel
+  context "when target.notification_action_cable_with_devise? returns false" do
+    before do
+      @user_notification_action_cable_with_devise = User._notification_action_cable_with_devise
+      User._notification_action_cable_with_devise = false
     end
+
+    after do
+      User._notification_action_cable_with_devise = @user_notification_action_cable_with_devise
+    end
+
+    it "successfully subscribes with target_type and target_id parameters" do
+      subscribe({ target_type: target_type, target_id: test_target.id })
+      expect(subscription).to be_confirmed
+      expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+      expect(subscription).to have_stream_from("activity_notification_channel_User##{test_target.id}")
+    end
+
+    it_behaves_like :notification_channel
   end
-end
+end

data/spec/channels/notification_with_devise_channel_spec.rb

@@ -1,99 +1,97 @@
-if Rails::VERSION::MAJOR >= 5
-  require 'channels/notification_channel_shared_examples'
+require 'channels/notification_channel_shared_examples'
 
-  #TODO Make it more smart test method
-  module ActivityNotification
-    module Test
-      class NotificationWithDeviseChannel < ::ActivityNotification::NotificationWithDeviseChannel
-        @@custom_current_target = nil
-
-        def set_custom_current_target(custom_current_target)
-          @@custom_current_target = custom_current_target
-        end
-
-        def find_current_target(devise_type = nil)
-          super(devise_type)
-        rescue NoMethodError
-          devise_type = (devise_type || @target.notification_devise_resource.class.name).to_s
-          @@custom_current_target.is_a?(devise_type.to_model_class) ? @@custom_current_target : nil
-        end
+#TODO Make it more smart test method
+module ActivityNotification
+  module Test
+    class NotificationWithDeviseChannel < ::ActivityNotification::NotificationWithDeviseChannel
+      @@custom_current_target = nil
+
+      def set_custom_current_target(custom_current_target)
+        @@custom_current_target = custom_current_target
+      end
+
+      def find_current_target(devise_type = nil)
+        super(devise_type)
+      rescue NoMethodError
+        devise_type = (devise_type || @target.notification_devise_resource.class.name).to_s
+        @@custom_current_target.is_a?(devise_type.to_model_class) ? @@custom_current_target : nil
       end
     end
   end
+end
 
-  # @See https://github.com/palkan/action-cable-testing
-  describe ActivityNotification::Test::NotificationWithDeviseChannel, type: :channel do
-    let(:test_user)            { create(:confirmed_user) }
-    let(:unauthenticated_user) { create(:confirmed_user) }
-    let(:test_target)          { create(:admin, user: test_user) }
-    let(:target_type)          { "Admin" }
-    let(:typed_target_param)   { "admin_id" }
-    let(:extra_params)         { { devise_type: :users } }
-    let(:valid_session)        {}
-
-    #TODO Make it more smart test method
-    #include Devise::Test::IntegrationHelpers
-    def sign_in(current_target)
-      described_class.new(ActionCable::Channel::ConnectionStub.new, {}).set_custom_current_target(current_target)
-    end
+# @See https://github.com/palkan/action-cable-testing
+describe ActivityNotification::Test::NotificationWithDeviseChannel, type: :channel do
+  let(:test_user)            { create(:confirmed_user) }
+  let(:unauthenticated_user) { create(:confirmed_user) }
+  let(:test_target)          { create(:admin, user: test_user) }
+  let(:target_type)          { "Admin" }
+  let(:typed_target_param)   { "admin_id" }
+  let(:extra_params)         { { devise_type: :users } }
+  let(:valid_session)        {}
 
-    before do
-      @user_notification_action_cable_with_devise = User._notification_action_cable_with_devise
-      User._notification_action_cable_with_devise = true
-    end
+  #TODO Make it more smart test method
+  #include Devise::Test::IntegrationHelpers
+  def sign_in(current_target)
+    described_class.new(ActionCable::Channel::ConnectionStub.new, {}).set_custom_current_target(current_target)
+  end
 
-    after do
-      User._notification_action_cable_with_devise = @user_notification_action_cable_with_devise
-    end
+  before do
+    @user_notification_action_cable_with_devise = User._notification_action_cable_with_devise
+    User._notification_action_cable_with_devise = true
+  end
 
-    context "signed in with devise as authenticated user" do
-      before do
-        sign_in test_user
-      end
-    
-      it_behaves_like :notification_channel
+  after do
+    User._notification_action_cable_with_devise = @user_notification_action_cable_with_devise
+  end
+
+  context "signed in with devise as authenticated user" do
+    before do
+      sign_in test_user
     end
+  
+    it_behaves_like :notification_channel
+  end
 
-    context "signed in with devise as unauthenticated user" do
-      let(:target_params) { { target_type: target_type, devise_type: :users } }
+  context "signed in with devise as unauthenticated user" do
+    let(:target_params) { { target_type: target_type, devise_type: :users } }
 
-      before do
-        sign_in unauthenticated_user
-      end
+    before do
+      sign_in unauthenticated_user
+    end
 
-      it "rejects subscription" do
-        subscribe(target_params.merge({ typed_target_param => test_target }))
-        expect(subscription).to be_rejected
-        expect {
-          expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
-        }.to raise_error(/Must be subscribed!/)
-      end
+    it "rejects subscription" do
+      subscribe(target_params.merge({ typed_target_param => test_target }))
+      expect(subscription).to be_rejected
+      expect {
+        expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+      }.to raise_error(/Must be subscribed!/)
     end
+  end
 
-    context "unsigned in with devise" do
-      let(:target_params) { { target_type: target_type, devise_type: :users } }
+  context "unsigned in with devise" do
+    let(:target_params) { { target_type: target_type, devise_type: :users } }
 
-      it "rejects subscription" do
-        subscribe(target_params.merge({ typed_target_param => test_target }))
-        expect(subscription).to be_rejected
-        expect {
-          expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
-        }.to raise_error(/Must be subscribed!/)
-      end
+    it "rejects subscription" do
+      subscribe(target_params.merge({ typed_target_param => test_target }))
+      expect(subscription).to be_rejected
+      expect {
+        expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+      }.to raise_error(/Must be subscribed!/)
     end
+  end
 
-    context "without target_id and (typed_target)_id parameters for devise integrated channel with devise_type option" do
-      let(:target_params) { { target_type: target_type, devise_type: :users } }
+  context "without target_id and (typed_target)_id parameters for devise integrated channel with devise_type option" do
+    let(:target_params) { { target_type: target_type, devise_type: :users } }
 
-      before do
-        sign_in test_target.user
-      end
+    before do
+      sign_in test_target.user
+    end
 
-      it "successfully subscribes" do
-        subscribe(target_params)
-        expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
-        expect(subscription).to have_stream_from("activity_notification_channel_Admin##{test_target.id}")
-      end
+    it "successfully subscribes" do
+      subscribe(target_params)
+      expect(subscription).to have_stream_from("#{ActivityNotification.config.notification_channel_prefix}_#{test_target.to_class_name}#{ActivityNotification.config.composite_key_delimiter}#{test_target.id}")
+      expect(subscription).to have_stream_from("activity_notification_channel_Admin##{test_target.id}")
     end
   end
 end

data/spec/concerns/apis/notification_api_spec.rb

@@ -136,9 +136,32 @@ shared_examples_for :notification_api do
           Comment._optional_targets[:users] = @current_optional_target
         end
 
-        it "generates notifications even if some optional targets raise error" do
-          notifications = described_class.notify(:users, @comment_2)
-          expect(notifications.size).to eq(2)  
+        context "with true as ActivityNotification.config.rescue_optional_target_errors" do
+          it "generates notifications even if some optional targets raise error" do
+            rescue_optional_target_errors = ActivityNotification.config.rescue_optional_target_errors
+            ActivityNotification.config.rescue_optional_target_errors = true
+            notifications = described_class.notify(:users, @comment_2)
+            expect(notifications.size).to eq(2)
+            ActivityNotification.config.rescue_optional_target_errors = rescue_optional_target_errors
+          end
+        end
+
+        context "with false as ActivityNotification.config.rescue_optional_target_errors" do
+          it "raises an capturable exception" do
+            rescue_optional_target_errors = ActivityNotification.config.rescue_optional_target_errors
+            ActivityNotification.config.rescue_optional_target_errors = false
+            expect { described_class.notify(:users, @comment_2) }.to raise_error(RuntimeError)
+            ActivityNotification.config.rescue_optional_target_errors = rescue_optional_target_errors
+          end
+        end
+
+        it "allows an exception to be captured to continue" do
+          begin
+            notifications = described_class.notify(:users, @comment_2)
+            expect(notifications.size).to eq(2)
+          rescue => e
+            next
+          end
         end
       end
     end

data/spec/concerns/apis/subscription_api_spec.rb

@@ -45,6 +45,41 @@ shared_examples_for :subscription_api do
           expect(test_instance.subscribed_to_email_at).to         eq(Time.current)
           Timecop.return
         end
+
+        context "with true as ActivityNotification.config.subscribe_to_email_as_default" do
+          it "subscribe with current time" do
+            ActivityNotification.config.subscribe_to_email_as_default = true
+
+            expect(test_instance.subscribing?).to                   eq(false)
+            expect(test_instance.subscribing_to_email?).to          eq(false)
+            Timecop.freeze(Time.at(Time.now.to_i))
+            test_instance.subscribe
+            expect(test_instance.subscribing?).to                   eq(true)
+            expect(test_instance.subscribing_to_email?).to          eq(true)
+            expect(test_instance.subscribed_at).to                  eq(Time.current)
+            expect(test_instance.subscribed_to_email_at).to         eq(Time.current)
+            Timecop.return
+
+            ActivityNotification.config.subscribe_to_email_as_default = nil
+          end
+        end
+
+        context "with false as ActivityNotification.config.subscribe_to_email_as_default" do
+          it "subscribe with current time" do
+            ActivityNotification.config.subscribe_to_email_as_default = false
+
+            expect(test_instance.subscribing?).to                   eq(false)
+            expect(test_instance.subscribing_to_email?).to          eq(false)
+            Timecop.freeze(Time.at(Time.now.to_i))
+            test_instance.subscribe
+            expect(test_instance.subscribing?).to                   eq(true)
+            expect(test_instance.subscribing_to_email?).to          eq(false)
+            expect(test_instance.subscribed_at).to                  eq(Time.current)
+            Timecop.return
+
+            ActivityNotification.config.subscribe_to_email_as_default = nil
+          end
+        end
       end
 
       context "with subscribed_at option" do
@@ -58,6 +93,39 @@ shared_examples_for :subscription_api do
           expect(test_instance.subscribed_at.to_i).to             eq(subscribed_at.to_i)
           expect(test_instance.subscribed_to_email_at.to_i).to    eq(subscribed_at.to_i)
         end
+
+        context "with true as ActivityNotification.config.subscribe_to_email_as_default" do
+          it "subscribe with current time" do
+            ActivityNotification.config.subscribe_to_email_as_default = true
+
+            expect(test_instance.subscribing?).to                   eq(false)
+            expect(test_instance.subscribing_to_email?).to          eq(false)
+            subscribed_at = Time.current - 1.months
+            test_instance.subscribe(subscribed_at: subscribed_at)
+            expect(test_instance.subscribing?).to                   eq(true)
+            expect(test_instance.subscribing_to_email?).to          eq(true)
+            expect(test_instance.subscribed_at.to_i).to             eq(subscribed_at.to_i)
+            expect(test_instance.subscribed_to_email_at.to_i).to    eq(subscribed_at.to_i)
+
+            ActivityNotification.config.subscribe_to_email_as_default = nil
+          end
+        end
+
+        context "with false as ActivityNotification.config.subscribe_to_email_as_default" do
+          it "subscribe with current time" do
+            ActivityNotification.config.subscribe_to_email_as_default = false
+
+            expect(test_instance.subscribing?).to                   eq(false)
+            expect(test_instance.subscribing_to_email?).to          eq(false)
+            subscribed_at = Time.current - 1.months
+            test_instance.subscribe(subscribed_at: subscribed_at)
+            expect(test_instance.subscribing?).to                   eq(true)
+            expect(test_instance.subscribing_to_email?).to          eq(false)
+            expect(test_instance.subscribed_at.to_i).to             eq(subscribed_at.to_i)
+
+            ActivityNotification.config.subscribe_to_email_as_default = nil
+          end
+        end
       end
 
       context "with false as with_email_subscription" do
@@ -79,6 +147,36 @@ shared_examples_for :subscription_api do
           expect(test_instance.subscribing?).to                                     eq(true)
           expect(test_instance.subscribing_to_optional_target?(:console_output)).to eq(true)
         end
+
+        context "with true as ActivityNotification.config.subscribe_to_optional_targets_as_default" do
+          it "also subscribes to optional targets" do
+            ActivityNotification.config.subscribe_to_optional_targets_as_default = true
+
+            test_instance.unsubscribe_to_optional_target(:console_output)
+            expect(test_instance.subscribing?).to                                     eq(false)
+            expect(test_instance.subscribing_to_optional_target?(:console_output)).to eq(false)
+            test_instance.subscribe
+            expect(test_instance.subscribing?).to                                     eq(true)
+            expect(test_instance.subscribing_to_optional_target?(:console_output)).to eq(true)
+
+            ActivityNotification.config.subscribe_to_optional_targets_as_default = nil
+          end
+        end
+
+        context "with false as ActivityNotification.config.subscribe_to_optional_targets_as_default" do
+          it "does not subscribe to optional targets" do
+            ActivityNotification.config.subscribe_to_optional_targets_as_default = false
+
+            test_instance.unsubscribe_to_optional_target(:console_output)
+            expect(test_instance.subscribing?).to                                     eq(false)
+            expect(test_instance.subscribing_to_optional_target?(:console_output)).to eq(false)
+            test_instance.subscribe
+            expect(test_instance.subscribing?).to                                     eq(true)
+            expect(test_instance.subscribing_to_optional_target?(:console_output)).to eq(false)
+
+            ActivityNotification.config.subscribe_to_optional_targets_as_default = nil
+          end
+        end
       end
 
       context "with false as with_optional_targets" do
@@ -210,7 +308,7 @@ shared_examples_for :subscription_api do
         test_instance.update(optional_targets: {})
       end
 
-      context "without configured optional target subscpriotion" do
+      context "without configured optional target subscription" do
         context "without subscribe_as_default argument" do
           context "with true as ActivityNotification.config.subscribe_as_default" do
             it "returns true" do
@@ -219,6 +317,28 @@ shared_examples_for :subscription_api do
               expect(test_instance.subscribing_to_optional_target?(:console_output)).to be_truthy
               ActivityNotification.config.subscribe_as_default = subscribe_as_default
             end
+
+            context "with true as ActivityNotification.config.subscribe_to_optional_targets_as_default" do
+              it "returns true" do
+                subscribe_as_default = ActivityNotification.config.subscribe_as_default
+                ActivityNotification.config.subscribe_as_default = true
+                ActivityNotification.config.subscribe_to_optional_targets_as_default = true
+                expect(test_instance.subscribing_to_optional_target?(:console_output)).to be_truthy
+                ActivityNotification.config.subscribe_as_default = subscribe_as_default
+                ActivityNotification.config.subscribe_to_optional_targets_as_default = nil
+              end
+            end
+
+            context "with false as ActivityNotification.config.subscribe_to_optional_targets_as_default" do
+              it "returns false" do
+                subscribe_as_default = ActivityNotification.config.subscribe_as_default
+                ActivityNotification.config.subscribe_as_default = true
+                ActivityNotification.config.subscribe_to_optional_targets_as_default = false
+                expect(test_instance.subscribing_to_optional_target?(:console_output)).to be_falsey
+                ActivityNotification.config.subscribe_as_default = subscribe_as_default
+                ActivityNotification.config.subscribe_to_optional_targets_as_default = nil
+              end
+            end
           end
 
           context "with false as ActivityNotification.config.subscribe_as_default" do
@@ -228,11 +348,33 @@ shared_examples_for :subscription_api do
               expect(test_instance.subscribing_to_optional_target?(:console_output)).to be_falsey
               ActivityNotification.config.subscribe_as_default = subscribe_as_default
             end
+
+            context "with true as ActivityNotification.config.subscribe_to_optional_targets_as_default" do
+              it "returns false" do
+                subscribe_as_default = ActivityNotification.config.subscribe_as_default
+                ActivityNotification.config.subscribe_as_default = false
+                ActivityNotification.config.subscribe_to_optional_targets_as_default = true
+                expect(test_instance.subscribing_to_optional_target?(:console_output)).to be_falsey
+                ActivityNotification.config.subscribe_as_default = subscribe_as_default
+                ActivityNotification.config.subscribe_to_optional_targets_as_default = nil
+              end
+            end
+
+            context "with false as ActivityNotification.config.subscribe_to_optional_targets_as_default" do
+              it "returns false" do
+                subscribe_as_default = ActivityNotification.config.subscribe_as_default
+                ActivityNotification.config.subscribe_as_default = false
+                ActivityNotification.config.subscribe_to_optional_targets_as_default = false
+                expect(test_instance.subscribing_to_optional_target?(:console_output)).to be_falsey
+                ActivityNotification.config.subscribe_as_default = subscribe_as_default
+                ActivityNotification.config.subscribe_to_optional_targets_as_default = nil
+              end
+            end
           end
         end
       end
 
-      context "with configured subscpriotion" do
+      context "with configured subscription" do
         context "subscribing to optional target" do
           it "returns true" do
             test_instance.subscribe_to_optional_target(:console_output)

data/spec/concerns/common_spec.rb

@@ -34,7 +34,7 @@ shared_examples_for :common do
           test_instance.extend(AdditionalMethods)
           expect(ActivityNotification.resolve_value(test_instance, :custom_method)).to eq(1)
         end
-  
+
         it "returns specified symbol with controller and additional arguments" do
           module AdditionalMethods
             def custom_method(controller, key)
@@ -45,6 +45,17 @@ shared_examples_for :common do
           expect(ActivityNotification.resolve_value(test_instance, :custom_method, 'test1.key')).to eq(1)
           expect(ActivityNotification.resolve_value(test_instance, :custom_method, 'test2.key')).to eq(0)
         end
+
+        it "returns specified symbol with controller and additional arguments including hash as last argument" do
+           module AdditionalMethods
+             def custom_method(controller, key, options:)
+               controller == 'StubController' and key == 'test1.key' ? 1 : 0
+             end
+           end
+           test_instance.extend(AdditionalMethods)
+           expect(ActivityNotification.resolve_value(test_instance, :custom_method, 'test1.key', options: 1)).to eq(1)
+           expect(ActivityNotification.resolve_value(test_instance, :custom_method, 'test2.key', options: 1)).to eq(0)
+         end
       end
 
       context "with Proc" do
@@ -62,7 +73,7 @@ shared_examples_for :common do
           test_proc = ->(controller, model){ controller == 'StubController' and model == test_instance ? 1 : 0 }
           expect(ActivityNotification.resolve_value(test_instance, test_proc)).to eq(1)
         end
-  
+
         it "returns specified lambda with controller, context(model) and additional arguments" do
           test_proc = ->(controller, model, key){ controller == 'StubController' and model == test_instance and key == 'test1.key' ? 1 : 0 }
           expect(ActivityNotification.resolve_value(test_instance, test_proc, 'test1.key')).to eq(1)
@@ -118,6 +129,17 @@ shared_examples_for :common do
           expect(test_instance.resolve_value(:custom_method, 'test1.key')).to eq(1)
           expect(test_instance.resolve_value(:custom_method, 'test2.key')).to eq(0)
         end
+
+        it "returns specified symbol with additional arguments including hash as last argument" do
+          module AdditionalMethods
+            def custom_method(key, options:)
+              key == 'test1.key' ? 1 : 0
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          expect(test_instance.resolve_value(:custom_method, 'test1.key', options: 1)).to eq(1)
+          expect(test_instance.resolve_value(:custom_method, 'test2.key', options: 1)).to eq(0)
+        end
       end
 
       context "with Proc" do
@@ -188,4 +210,4 @@ shared_examples_for :common do
     end
   end
 
-end
+end