activity_notification 1.0.2 → 1.1.0

data/spec/concerns/models/target_spec.rb

@@ -10,7 +10,7 @@ shared_examples_for :target do
       expect(test_instance.notifications.count).to    eq(2)
       expect(test_instance.notifications.earliest).to eq(notification_1)
       expect(test_instance.notifications.latest).to   eq(notification_2)
-      expect(test_instance.notifications).to          eq (ActivityNotification::Notification.filtered_by_target(test_instance))
+      expect(test_instance.notifications).to          eq(ActivityNotification::Notification.filtered_by_target(test_instance))
     end
   end    
 
@@ -43,34 +43,103 @@ shared_examples_for :target do
         notification_5 = create(:notification, target: target_2)
         notification_6 = create(:notification, target: test_notifiable)
 
-        expect(described_class.notification_index_map.size).to eq(2)
-        expect(described_class.notification_index_map[target_1].size).to eq(3)
+        index_map = described_class.notification_index_map
+        expect(index_map.size).to eq(2)
+        expect(index_map[target_1].size).to eq(3)
         expect(described_class.notification_index_map[target_2].size).to eq(2)
       end
-    end
 
-    describe ".unopened_notification_index_map" do
-      it "returns unopened notifications of this target type group by target" do
-        ActivityNotification::Notification.delete_all
-        target_1 = create(test_class_name)
-        target_2 = create(test_class_name)
-        target_3 = create(test_class_name)
-        notification_1 = create(:notification, target: target_1)
-        notification_2 = create(:notification, target: target_1)
-        notification_3 = create(:notification, target: target_1)
-        notification_3.open!
-        notification_4 = create(:notification, target: target_2)
-        notification_5 = create(:notification, target: target_2)
-        notification_5.open!
-        notification_6 = create(:notification, target: target_3)
-        notification_6.open!
-        notification_7 = create(:notification, target: test_notifiable)
+      context "with :filtered_by_status" do
+        context "as :opened" do
+          it "returns opened notifications of this target type group by target" do
+            ActivityNotification::Notification.delete_all
+            target_1 = create(test_class_name)
+            target_2 = create(test_class_name)
+            target_3 = create(test_class_name)
+            notification_1 = create(:notification, target: target_1)
+            notification_2 = create(:notification, target: target_1)
+            notification_2.open!
+            notification_3 = create(:notification, target: target_1)
+            notification_3.open!
+            notification_4 = create(:notification, target: target_2)
+            notification_5 = create(:notification, target: target_2)
+            notification_5.open!
+            notification_6 = create(:notification, target: target_3)
+            notification_7 = create(:notification, target: test_notifiable)
+    
+            index_map = described_class.notification_index_map(filtered_by_status: :opened)
+            expect(index_map.size).to eq(2)
+            expect(index_map[target_1].size).to eq(2)
+            expect(index_map[target_2].size).to eq(1)
+            expect(index_map.has_key?(target_3)).to be_falsey
+          end
+        end
 
-        index_map = described_class.unopened_notification_index_map
-        expect(index_map.size).to eq(2)
-        expect(index_map[target_1].size).to eq(2)
-        expect(index_map[target_2].size).to eq(1)
-        expect(index_map.has_key?(target_3)).to be_falsey
+        context "as :unopened" do
+          it "returns unopened notifications of this target type group by target" do
+            ActivityNotification::Notification.delete_all
+            target_1 = create(test_class_name)
+            target_2 = create(test_class_name)
+            target_3 = create(test_class_name)
+            notification_1 = create(:notification, target: target_1)
+            notification_2 = create(:notification, target: target_1)
+            notification_3 = create(:notification, target: target_1)
+            notification_3.open!
+            notification_4 = create(:notification, target: target_2)
+            notification_5 = create(:notification, target: target_2)
+            notification_5.open!
+            notification_6 = create(:notification, target: target_3)
+            notification_6.open!
+            notification_7 = create(:notification, target: test_notifiable)
+    
+            index_map = described_class.notification_index_map(filtered_by_status: :unopened)
+            expect(index_map.size).to eq(2)
+            expect(index_map[target_1].size).to eq(2)
+            expect(index_map[target_2].size).to eq(1)
+            expect(index_map.has_key?(target_3)).to be_falsey
+          end
+        end
+      end
+
+      context "with :as_latest_group_member" do
+        before do
+          ActivityNotification::Notification.delete_all
+          @target_1 = create(test_class_name)
+          @target_2 = create(test_class_name)
+          @target_3 = create(test_class_name)
+          notification_1  = create(:notification, target: @target_1)
+          @notification_2 = create(:notification, target: @target_1)
+          notification_3  = create(:notification, target: @target_1, group_owner: @notification_2)
+          @notification_4 = create(:notification, target: @target_1, group_owner: @notification_2)
+          notification_5  = create(:notification, target: @target_2)
+          notification_6  = create(:notification, target: @target_2)
+          notification_6.open!
+          notification_7  = create(:notification, target: @target_3)
+          notification_7.open!
+          notification_8  = create(:notification, target: test_notifiable)
+        end
+
+        context "as default" do
+          it "returns earliest group members" do
+            index_map = described_class.notification_index_map(filtered_by_status: :unopened)
+            expect(index_map.size).to eq(2)
+            expect(index_map[@target_1].size).to eq(2)
+            expect(index_map[@target_1].first).to eq(@notification_2)
+            expect(index_map[@target_2].size).to eq(1)
+            expect(index_map.has_key?(@target_3)).to be_falsey
+          end
+        end
+
+        context "as true" do
+          it "returns latest group members" do
+            index_map = described_class.notification_index_map(filtered_by_status: :unopened, as_latest_group_member: true)
+            expect(index_map.size).to eq(2)
+            expect(index_map[@target_1].size).to eq(2)
+            expect(index_map[@target_1].first).to eq(@notification_4)
+            expect(index_map[@target_2].size).to eq(1)
+            expect(index_map.has_key?(@target_3)).to be_falsey
+          end
+        end
       end
     end
 
@@ -99,6 +168,29 @@ shared_examples_for :target do
         expect(sent_email_map.has_key?(target_3)).to be_falsey
       end
     end
+
+    describe "subscription_enabled?" do
+      context "with true as _notification_subscription_allowed" do
+        it "returns true" do
+          described_class._notification_subscription_allowed = true
+          expect(described_class.subscription_enabled?).to eq(true)
+        end
+      end
+
+      context "with false as _notification_subscription_allowed" do
+        it "returns false" do
+          described_class._notification_subscription_allowed = false
+          expect(described_class.subscription_enabled?).to eq(false)
+        end
+      end
+
+      context "with lambda configuration as _notification_subscription_allowed" do
+        it "returns true (even if configured lambda function returns false)" do
+          described_class._notification_subscription_allowed = ->(target, key){ false }
+          expect(described_class.subscription_enabled?).to eq(true)
+        end
+      end
+    end
   end
 
   describe "as public instance methods" do
@@ -195,6 +287,110 @@ shared_examples_for :target do
       end
     end
 
+    describe "#batch_notification_email_allowed?" do
+      context "without any configuration" do
+        it "returns ActivityNotification.config.email_enabled" do
+          expect(test_instance.batch_notification_email_allowed?('dummy_key'))
+            .to eq(ActivityNotification.config.email_enabled)
+        end
+
+        it "returns false as default" do
+          expect(test_instance.batch_notification_email_allowed?('dummy_key')).to be_falsey
+        end
+      end
+
+      context "configured with a field" do
+        it "returns specified value" do
+          described_class._batch_notification_email_allowed = true
+          expect(test_instance.batch_notification_email_allowed?('dummy_key')).to eq(true)
+        end
+
+        it "returns specified symbol without argument" do
+          module AdditionalMethods
+            def custom_batch_notification_email_allowed?
+              true
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._batch_notification_email_allowed = :custom_batch_notification_email_allowed?
+          expect(test_instance.batch_notification_email_allowed?('dummy_key')).to eq(true)
+        end
+
+        it "returns specified symbol with target and key arguments" do
+          module AdditionalMethods
+            def custom_batch_notification_email_allowed?(key)
+              true
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._batch_notification_email_allowed = :custom_batch_notification_email_allowed?
+          expect(test_instance.batch_notification_email_allowed?('dummy_key')).to eq(true)
+        end
+
+        it "returns specified lambda with single target argument" do
+          described_class._batch_notification_email_allowed = ->(target){ true }
+          expect(test_instance.batch_notification_email_allowed?('dummy_key')).to eq(true)
+        end
+
+        it "returns specified lambda with target and key arguments" do
+          described_class._batch_notification_email_allowed = ->(target, key){ true }
+          expect(test_instance.batch_notification_email_allowed?('dummy_key')).to eq(true)
+        end
+      end
+    end
+
+    describe "#subscription_allowed?" do
+      context "without any configuration" do
+        it "returns ActivityNotification.config.subscription_enabled" do
+          expect(test_instance.subscription_allowed?('dummy_key'))
+            .to eq(ActivityNotification.config.subscription_enabled)
+        end
+
+        it "returns false as default" do
+          expect(test_instance.subscription_allowed?('dummy_key')).to be_falsey
+        end
+      end
+
+      context "configured with a field" do
+        it "returns specified value" do
+          described_class._notification_subscription_allowed = true
+          expect(test_instance.subscription_allowed?('dummy_key')).to eq(true)
+        end
+
+        it "returns specified symbol without argument" do
+          module AdditionalMethods
+            def custom_subscription_allowed?
+              true
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._notification_subscription_allowed = :custom_subscription_allowed?
+          expect(test_instance.subscription_allowed?('dummy_key')).to eq(true)
+        end
+
+        it "returns specified symbol with key argument" do
+          module AdditionalMethods
+            def custom_subscription_allowed?(key)
+              true
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._notification_subscription_allowed = :custom_subscription_allowed?
+          expect(test_instance.subscription_allowed?('dummy_key')).to eq(true)
+        end
+
+        it "returns specified lambda with single target argument" do
+          described_class._notification_subscription_allowed = ->(target){ true }
+          expect(test_instance.subscription_allowed?('dummy_key')).to eq(true)
+        end
+
+        it "returns specified lambda with target and key arguments" do
+          described_class._notification_subscription_allowed = ->(target, key){ true }
+          expect(test_instance.subscription_allowed?('dummy_key')).to eq(true)
+        end
+      end
+    end
+
     describe "#authenticated_with_devise?" do
       context "without any configuration" do
         context "when the current devise resource and called target are defferent class instance" do
@@ -431,8 +627,8 @@ shared_examples_for :target do
 
       context "when the target has no unopened notifications" do
         before do
-          create(:notification, target: test_instance, opened_at: DateTime.now)
-          create(:notification, target: test_instance, opened_at: DateTime.now)
+          create(:notification, target: test_instance, opened_at: Time.current)
+          create(:notification, target: test_instance, opened_at: Time.current)
         end
 
         it "calls unopened_notification_index" do
@@ -485,7 +681,7 @@ shared_examples_for :target do
           end
 
           it "returns unopened notification index (unopened only)" do
-            notification_3 = create(:notification, target: test_instance, opened_at: DateTime.now)
+            notification_3 = create(:notification, target: test_instance, opened_at: Time.current)
             expect(test_instance.unopened_notification_index.size).to eq(2)
             expect(test_instance.unopened_notification_index.last).to  eq(@notification_1)
             expect(test_instance.unopened_notification_index.first).to eq(@notification_2)
@@ -503,8 +699,8 @@ shared_examples_for :target do
 
       context "when the target has no unopened notifications" do
         before do
-          create(:notification, target: test_instance, group_owner: nil, opened_at: DateTime.now)
-          create(:notification, target: test_instance, group_owner: nil, opened_at: DateTime.now)
+          create(:notification, target: test_instance, group_owner: nil, opened_at: Time.current)
+          create(:notification, target: test_instance, group_owner: nil, opened_at: Time.current)
         end
 
         it "returns empty records" do
@@ -522,8 +718,8 @@ shared_examples_for :target do
 
       context "when the target has opened notifications" do
         before do
-          @notification_1 = create(:notification, target: test_instance, opened_at: DateTime.now)
-          @notification_2 = create(:notification, target: test_instance, opened_at: DateTime.now)
+          @notification_1 = create(:notification, target: test_instance, opened_at: Time.current)
+          @notification_2 = create(:notification, target: test_instance, opened_at: Time.current)
         end
 
         context "without limit" do
@@ -542,7 +738,7 @@ shared_examples_for :target do
           end
 
           it "returns opened notification index (owner only)" do
-            group_member   = create(:notification, target: test_instance, group_owner: @notification_1, opened_at: DateTime.now)
+            group_member   = create(:notification, target: test_instance, group_owner: @notification_1, opened_at: Time.current)
             expect(test_instance.opened_notification_index.size).to eq(2)
             expect(test_instance.opened_notification_index.last).to  eq(@notification_1)
             expect(test_instance.opened_notification_index.first).to eq(@notification_2)
@@ -686,8 +882,8 @@ shared_examples_for :target do
 
       context "when the target has no unopened notifications" do
         before do
-          create(:notification, target: test_instance, opened_at: DateTime.now)
-          create(:notification, target: test_instance, opened_at: DateTime.now)
+          create(:notification, target: test_instance, opened_at: Time.current)
+          create(:notification, target: test_instance, opened_at: Time.current)
         end
 
         it "calls unopened_notification_index_with_attributes" do
@@ -760,8 +956,8 @@ shared_examples_for :target do
 
       context "when the target has no unopened notifications" do
         before do
-          create(:notification, target: test_instance, opened_at: DateTime.now)
-          create(:notification, target: test_instance, opened_at: DateTime.now)
+          create(:notification, target: test_instance, opened_at: Time.current)
+          create(:notification, target: test_instance, opened_at: Time.current)
         end
 
         it "returns empty records" do
@@ -779,8 +975,8 @@ shared_examples_for :target do
       context "when the target has opened notifications with no group members" do
         context "with no group members" do
           before do
-            create(:notification, target: test_instance, opened_at: DateTime.now)
-            create(:notification, target: test_instance, opened_at: DateTime.now)
+            create(:notification, target: test_instance, opened_at: Time.current)
+            create(:notification, target: test_instance, opened_at: Time.current)
           end
   
           it "calls with_target, with_notifiable and with_notifier" do
@@ -801,9 +997,9 @@ shared_examples_for :target do
   
         context "with group members" do
           before do
-            group_owner  = create(:notification, target: test_instance, group_owner: nil, opened_at: DateTime.now)
-                           create(:notification, target: test_instance, group_owner: nil, opened_at: DateTime.now)
-            group_member = create(:notification, target: test_instance, group_owner: group_owner, opened_at: DateTime.now)
+            group_owner  = create(:notification, target: test_instance, group_owner: nil, opened_at: Time.current)
+                           create(:notification, target: test_instance, group_owner: nil, opened_at: Time.current)
+            group_member = create(:notification, target: test_instance, group_owner: group_owner, opened_at: Time.current)
           end
   
           it "calls with_group" do
@@ -884,6 +1080,39 @@ shared_examples_for :target do
       end
     end
 
+    describe "#subscribes_to_notification?" do
+      context "when the subscription is not enabled for the target" do
+        it "returns true" do
+          described_class._notification_subscription_allowed = false
+          expect(test_instance.subscribes_to_notification?('test_key')).to be_truthy
+        end
+      end
+
+      context "when the subscription is enabled for the target" do
+        it "calls Subscriber#_subscribes_to_notification?" do
+          described_class._notification_subscription_allowed = true
+          expect(test_instance).to receive(:_subscribes_to_notification?)
+          test_instance.subscribes_to_notification?('test_key')
+        end
+      end
+    end
+
+    describe "#subscribes_to_notification_email?" do
+      context "when the subscription is not enabled for the target" do
+        it "returns true" do
+          described_class._notification_subscription_allowed = false
+          expect(test_instance.subscribes_to_notification_email?('test_key')).to be_truthy
+        end
+      end
+
+      context "when the subscription is enabled for the target" do
+        it "calls Subscriber#_subscribes_to_notification_email?" do
+          described_class._notification_subscription_allowed = true
+          expect(test_instance).to receive(:_subscribes_to_notification_email?)
+          test_instance.subscribes_to_notification_email?('test_key')
+        end
+      end
+    end
   end
 
 end

data/spec/controllers/common_controller_spec.rb

@@ -0,0 +1,25 @@
+require 'controllers/dummy_common_controller'
+
+describe ActivityNotification::DummyCommonController, type: :controller do
+
+  describe "#set_index_options" do
+    it "raises NotImplementedError" do
+      expect { controller.send(:set_index_options) }
+        .to raise_error(NotImplementedError, /You have to implement .+#set_index_options/)
+    end
+  end
+
+  describe "#load_index" do
+    it "raises NotImplementedError" do
+      expect { controller.send(:load_index) }
+        .to raise_error(NotImplementedError, /You have to implement .+#load_index/)
+    end
+  end
+
+  describe "#controller_path" do
+    it "raises NotImplementedError" do
+      expect { controller.send(:controller_path) }
+        .to raise_error(NotImplementedError, /You have to implement .+#controller_path/)
+    end
+  end
+end

data/spec/controllers/dummy_common_controller.rb

@@ -0,0 +1,5 @@
+module ActivityNotification
+  class DummyCommonController < ActivityNotification.config.parent_controller.constantize
+    include CommonController
+  end
+end

data/spec/controllers/notifications_controller_shared_examples.rb

@@ -240,12 +240,8 @@ shared_examples_for :notification_controller do
         expect(response.status).to eq(302)
       end
 
-      it "assigns notification index as @notifications" do
-        expect(assigns(:notifications)).to eq([@notification])
-      end
-
       it "opens all notifications of the target" do
-        expect(assigns(:notifications).first.opened?).to be_truthy
+        expect(@notification.reload.opened?).to be_truthy
       end
 
       it "redirects to :index" do
@@ -266,7 +262,7 @@ shared_examples_for :notification_controller do
       end
 
       it "opens all notifications of the target" do
-        expect(assigns(:notifications).first.opened?).to be_truthy
+        expect(@notification.reload.opened?).to be_truthy
       end
 
       it "redirects to root_path as request.referer" do