activity_notification 0.0.10 → 1.0.0

data/lib/activity_notification/roles/acts_as_target.rb

@@ -11,6 +11,7 @@ module ActivityNotification
       #   * Email address to send notification email.
       #     This is a necessary option when you enables email notification.
       # @example Simply use :email field
+      #   # app/models/user.rb
       #   class User < ActiveRecord::Base
       #     validates :email, presence: true
       #     acts_as_target email: :email
@@ -23,10 +24,12 @@ module ActivityNotification
       #     To use notification email, email_allowed option must return true (not nil) in both of notifiable and target model.
       #     This can be also configured default option in initializer.
       # @example Always enable email notification for this target
+      #   # app/models/user.rb
       #   class User < ActiveRecord::Base
       #     acts_as_target email: :email, email_allowed: true
       #   end
       # @example Use confirmed_at of devise field to decide whether activity_notification sends notification email to this user
+      #   # app/models/user.rb
       #   class User < ActiveRecord::Base
       #     acts_as_target email: :email, email_allowed: :confirmed_at
       #   end
@@ -65,26 +68,41 @@ module ActivityNotification
       #       devise_resource: :user
       #   end
       #
-      # @param [Symbol] target_type Type of notification target as symbol
+      # * :printable_name or :printable_notification_target_name
+      #   * Printable notification target name.
+      #     This parameter is a optional since `ActivityNotification::Common.printable_name` is used as default value.
+      #     :printable_name is the same option as :printable_notification_target_name
+      # @example Define printable name with user name of name field
+      #   # app/models/user.rb
+      #   class User < ActiveRecord::Base
+      #     acts_as_target printable_name: :name
+      #   end
+      #
+      # @example Define printable name with associated user name
+      #   # app/models/admin.rb
+      #   class Admin < ActiveRecord::Base
+      #     acts_as_target printable_notification_target_name: ->(admin) { "admin (#{admin.user.name})" }
+      #   end
+      #
       # @param [Hash] options Options for notifiable model configuration
-      # @option options [Symbol, Proc, Array]   :email           (nil) Email address to send notification email
-      # @option options [Symbol, Proc, Object]  :email_allowed   (ActivityNotification.config.email_enabled) Whether activity_notification sends notification email to this target
+      # @option options [Symbol, Proc, String]  :email           (nil) Email address to send notification email
+      # @option options [Symbol, Proc, Boolean] :email_allowed   (ActivityNotification.config.email_enabled) Whether activity_notification sends notification email to this target
       # @option options [Symbol, Proc, Object]  :devise_resource (nil) Integrated resource with devise authentication
+      # @option options [Symbol, Proc, String]  :printable_name  (ActivityNotification::Common.printable_name) Printable notification target name
       # @return [Hash] Configured parameters as target model
       def acts_as_target(options = {})
         include Target
-        available_target_options.map { |key|
-          options[key] ?
-            [key, self.send("_notification_#{key}=".to_sym, options.delete(key))] :
-            [nil, nil]
-        }.to_h.delete_if { |k, v| k.nil? }
+
+        options[:printable_notification_target_name] ||= options.delete(:printable_name)
+        set_acts_as_parameters([:email, :email_allowed, :devise_resource], options, "notification_")
+          .merge set_acts_as_parameters([:printable_notification_target_name], options)
       end
       alias_method :acts_as_notification_target, :acts_as_target
 
       # Returns array of available target options in acts_as_target.
       # @return [Array<Symbol>] Array of available target options
       def available_target_options
-        [:email, :email_allowed, :devise_resource].freeze
+        [:email, :email_allowed, :devise_resource, :printable_notification_target_name, :printable_name].freeze
       end
     end
   end

data/lib/activity_notification/version.rb

@@ -1,3 +1,3 @@
 module ActivityNotification
-  VERSION = "0.0.10"
+  VERSION = "1.0.0"
 end

data/lib/generators/templates/activity_notification.rb

@@ -23,6 +23,6 @@ ActivityNotification.configure do |config|
   # config.parent_mailer = 'ActionMailer::Base'
 
   # Configure default limit number of opened notifications you can get from opened* scope
-  config.opened_limit = 10
+  config.opened_index_limit = 10
 
 end

data/spec/concerns/apis/notification_api_spec.rb

@@ -453,7 +453,7 @@ shared_examples_for :notification_api do
       context "with send_later false" do
         it "sends notification email now" do
           expect(ActivityNotification::Mailer.deliveries.size).to eq(0)
-          test_instance.send_notification_email false
+          test_instance.send_notification_email send_later: false
           expect(ActivityNotification::Mailer.deliveries.size).to eq(1)
           expect(ActivityNotification::Mailer.deliveries.first.to[0]).to eq(test_instance.target.email)
         end
@@ -615,11 +615,97 @@ shared_examples_for :notification_api do
       end
     end
 
-    describe "#group_member_count" do
+    # Returns if group member notifier except group owner notifier exists.
+    # It always returns false if group owner notifier is blank.
+    # It counts only the member notifier of the same type with group owner notifier.
+    describe "#group_member_notifier_exists?" do
+      context "with notifier" do
+        before do
+          test_instance.update(notifier: create(:user))
+        end
+
+        context "when the notification is group owner and has no group members" do
+          it "returns false" do
+            expect(test_instance.group_member_notifier_exists?).to be_falsey
+          end
+        end
+
+        context "when the notification is group owner and has group members with the same notifier with the owner's" do
+          it "returns false" do
+            create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+            expect(test_instance.group_member_notifier_exists?).to be_falsey
+          end
+        end
+
+        context "when the notification is group owner and has group members with different notifier from the owner's" do
+          it "returns true" do
+            create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+            expect(test_instance.group_member_notifier_exists?).to be_truthy
+          end
+        end
+
+        context "when the notification belongs to group and has group members with the same notifier with the owner's" do
+          it "returns false" do
+            group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+            expect(group_member.group_member_notifier_exists?).to be_falsey
+          end
+        end
+
+        context "when the notification belongs to group and has group members with different notifier from the owner's" do
+          it "returns true" do
+            group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+            expect(group_member.group_member_notifier_exists?).to be_truthy
+          end
+        end
+      end
+
+      context "without notifier" do
+        before do
+          test_instance.update(notifier: nil)
+        end
+
+        context "when the notification is group owner and has no group members" do
+          it "returns false" do
+            expect(test_instance.group_member_notifier_exists?).to be_falsey
+          end
+        end
+
+        context "when the notification is group owner and has group members without notifier" do
+          it "returns false" do
+            create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: nil)
+            expect(test_instance.group_member_notifier_exists?).to be_falsey
+          end
+        end
+
+        context "when the notification is group owner and has group members with notifier" do
+          it "returns false" do
+            create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+            expect(test_instance.group_member_notifier_exists?).to be_falsey
+          end
+        end
+
+        context "when the notification belongs to group and has group members without notifier" do
+          it "returns false" do
+            group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: nil)
+            expect(group_member.group_member_notifier_exists?).to be_falsey
+          end
+        end
+
+        context "when the notification belongs to group and has group members with notifier" do
+          it "returns false" do
+            group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+            expect(group_member.group_member_notifier_exists?).to be_falsey
+          end
+        end
+      end
+    end
+
+    describe "#group_member_count (with #group_notification_count)" do
       context "for unopened notification" do
         context "when the notification is group owner and has no group members" do
           it "returns 0" do
             expect(test_instance.group_member_count).to eq(0)
+            expect(test_instance.group_notification_count).to eq(1)
           end
         end
 
@@ -628,6 +714,7 @@ shared_examples_for :notification_api do
             create(test_class_name, target: test_instance.target, group_owner: test_instance)
             create(test_class_name, target: test_instance.target, group_owner: test_instance)
             expect(test_instance.group_member_count).to eq(2)
+            expect(test_instance.group_notification_count).to eq(3)
           end
         end
 
@@ -636,6 +723,7 @@ shared_examples_for :notification_api do
             group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance)
                            create(test_class_name, target: test_instance.target, group_owner: test_instance)
             expect(group_member.group_member_count).to eq(2)
+            expect(group_member.group_notification_count).to eq(3)
           end
         end
       end
@@ -645,6 +733,7 @@ shared_examples_for :notification_api do
           it "returns 0" do
             test_instance.open!
             expect(test_instance.group_member_count).to eq(0)
+            expect(test_instance.group_notification_count).to eq(1)
           end
         end
 
@@ -655,6 +744,7 @@ shared_examples_for :notification_api do
               create(test_class_name, target: test_instance.target, group_owner: test_instance)
               test_instance.open!
               expect(test_instance.group_member_count).to eq(2)
+              expect(test_instance.group_notification_count).to eq(3)
             end
           end
 
@@ -664,6 +754,7 @@ shared_examples_for :notification_api do
                              create(test_class_name, target: test_instance.target, group_owner: test_instance)
               test_instance.open!
               expect(group_member.group_member_count).to eq(2)
+              expect(group_member.group_notification_count).to eq(3)
             end
           end
         end
@@ -675,6 +766,7 @@ shared_examples_for :notification_api do
               create(test_class_name, target: test_instance.target, group_owner: test_instance)
               test_instance.open!
               expect(test_instance.group_member_count(0)).to eq(0)
+              expect(test_instance.group_notification_count(0)).to eq(1)
             end
           end
 
@@ -684,6 +776,259 @@ shared_examples_for :notification_api do
                              create(test_class_name, target: test_instance.target, group_owner: test_instance)
               test_instance.open!
               expect(group_member.group_member_count(0)).to eq(0)
+              expect(group_member.group_notification_count(0)).to eq(1)
+            end
+          end
+        end
+      end
+    end
+
+    # Returns count of group member notifiers of the notification not including group owner notifier.
+    # It always returns 0 if group owner notifier is blank.
+    # It counts only the member notifier of the same type with group owner notifier.
+    describe "#group_member_notifier_count (with #group_notifier_count)" do
+      context "for unopened notification" do
+        context "with notifier" do
+          before do
+            test_instance.update(notifier: create(:user))
+          end
+
+          context "when the notification is group owner and has no group members" do
+            it "returns 0" do
+              expect(test_instance.group_member_notifier_count).to eq(0)
+              expect(test_instance.group_notifier_count).to eq(1)
+            end
+          end
+
+          context "when the notification is group owner and has group members with the same notifier with the owner's" do
+            it "returns 0" do
+              create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+              create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+              expect(test_instance.group_member_notifier_count).to eq(0)
+              expect(test_instance.group_notifier_count).to eq(1)
+            end
+          end
+
+          context "when the notification is group owner and has group members with different notifier from the owner's" do
+            it "returns member notifier count" do
+              create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+              create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+              expect(test_instance.group_member_notifier_count).to eq(2)
+              expect(test_instance.group_notifier_count).to eq(3)
+            end
+
+            it "returns member notifier count with selecting distinct notifier" do
+              group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                             create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: group_member.notifier)
+              expect(test_instance.group_member_notifier_count).to eq(1)
+              expect(test_instance.group_notifier_count).to eq(2)
+            end
+          end
+
+          context "when the notification belongs to group and has group members with the same notifier with the owner's" do
+            it "returns 0" do
+              group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+                             create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+              expect(group_member.group_member_notifier_count).to eq(0)
+              expect(group_member.group_notifier_count).to eq(1)
+            end
+          end
+
+          context "when the notification belongs to group and has group members with different notifier from the owner's" do
+            it "returns member notifier count" do
+              group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                             create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+              expect(group_member.group_member_notifier_count).to eq(2)
+              expect(group_member.group_notifier_count).to eq(3)
+            end
+
+            it "returns member notifier count with selecting distinct notifier" do
+              group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                             create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: group_member.notifier)
+              expect(group_member.group_member_notifier_count).to eq(1)
+              expect(group_member.group_notifier_count).to eq(2)
+            end
+          end
+        end
+
+        context "without notifier" do
+          before do
+            test_instance.update(notifier: nil)
+          end
+
+          context "when the notification is group owner and has no group members" do
+            it "returns 0" do
+              expect(test_instance.group_member_notifier_count).to eq(0)
+              expect(test_instance.group_notifier_count).to eq(0)
+            end
+          end
+
+          context "when the notification is group owner and has group members with the same notifier with the owner's" do
+            it "returns 0" do
+              create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+              create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+              expect(test_instance.group_member_notifier_count).to eq(0)
+              expect(test_instance.group_notifier_count).to eq(0)
+            end
+          end
+
+          context "when the notification is group owner and has group members with different notifier from the owner's" do
+            it "returns 0" do
+              create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+              create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+              expect(test_instance.group_member_notifier_count).to eq(0)
+              expect(test_instance.group_notifier_count).to eq(0)
+            end
+          end
+
+          context "when the notification belongs to group and has group members with the same notifier with the owner's" do
+            it "returns 0" do
+              group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+                             create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+              expect(group_member.group_member_notifier_count).to eq(0)
+              expect(group_member.group_notifier_count).to eq(0)
+            end
+          end
+
+          context "when the notification belongs to group and has group members with different notifier from the owner's" do
+            it "returns 0" do
+              group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                             create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+              expect(group_member.group_member_notifier_count).to eq(0)
+              expect(group_member.group_notifier_count).to eq(0)
+            end
+          end
+        end
+      end
+
+      context "for opened notification" do
+        context "as default" do
+          context "with notifier" do
+            before do
+              test_instance.update(notifier: create(:user))
+            end
+
+            context "when the notification is group owner and has group members with the same notifier with the owner's" do
+              it "returns 0" do
+                create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+                create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+                test_instance.open!
+                expect(test_instance.group_member_notifier_count).to eq(0)
+              end
+            end
+
+            context "when the notification is group owner and has group members with different notifier from the owner's" do
+              it "returns member notifier count" do
+                create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                test_instance.open!
+                expect(test_instance.group_member_notifier_count).to eq(2)
+              end
+
+              it "returns member notifier count with selecting distinct notifier" do
+                group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                               create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: group_member.notifier)
+                test_instance.open!
+                expect(test_instance.group_member_notifier_count).to eq(1)
+              end
+            end
+
+            context "when the notification belongs to group and has group members with the same notifier with the owner's" do
+              it "returns 0" do
+                group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+                               create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+                test_instance.open!
+                expect(group_member.group_member_notifier_count).to eq(0)
+              end
+            end
+
+            context "when the notification belongs to group and has group members with different notifier from the owner's" do
+              it "returns member notifier count" do
+                group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                               create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                test_instance.open!
+                expect(group_member.group_member_notifier_count).to eq(2)
+              end
+
+              it "returns member notifier count with selecting distinct notifier" do
+                group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                               create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: group_member.notifier)
+                test_instance.open!
+                expect(group_member.group_member_notifier_count).to eq(1)
+              end
+            end
+          end
+
+          context "without notifier" do
+            before do
+              test_instance.update(notifier: nil)
+            end
+
+            context "when the notification is group owner and has no group members" do
+              it "returns 0" do
+                test_instance.open!
+                expect(test_instance.group_member_notifier_count).to eq(0)
+              end
+            end
+
+            context "when the notification is group owner and has group members with the same notifier with the owner's" do
+              it "returns 0" do
+                create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+                create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+                test_instance.open!
+                expect(test_instance.group_member_notifier_count).to eq(0)
+              end
+            end
+
+            context "when the notification is group owner and has group members with different notifier from the owner's" do
+              it "returns 0" do
+                create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                test_instance.open!
+                expect(test_instance.group_member_notifier_count).to eq(0)
+              end
+            end
+
+            context "when the notification belongs to group and has group members with the same notifier with the owner's" do
+              it "returns 0" do
+                group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+                               create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: test_instance.notifier)
+                test_instance.open!
+                expect(group_member.group_member_notifier_count).to eq(0)
+              end
+            end
+
+            context "when the notification belongs to group and has group members with different notifier from the owner's" do
+              it "returns 0" do
+                group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                               create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                test_instance.open!
+                expect(group_member.group_member_notifier_count).to eq(0)
+              end
+            end
+          end
+        end
+
+        context "with limit" do
+          before do
+            test_instance.update(notifier: create(:user))
+          end
+
+          context "when the notification is group owner and has group members with different notifier from the owner's" do
+            it "returns member notifier count by limit" do
+              create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+              create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+              test_instance.open!
+              expect(test_instance.group_member_notifier_count(0)).to eq(0)
+            end
+          end
+
+          context "when the notification belongs to group and has group members with different notifier from the owner's" do
+            it "returns member count by limit" do
+              group_member = create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+                             create(test_class_name, target: test_instance.target, group_owner: test_instance, notifier: create(:user))
+              test_instance.open!
+              expect(group_member.group_member_notifier_count(0)).to eq(0)
             end
           end
         end
@@ -712,6 +1057,20 @@ shared_examples_for :notification_api do
         expect(test_instance.respond_to?(:opened_group_member_count, true)).to be_truthy
       end
     end
+
+    describe "#unopened_group_member_notifier_count" do
+      it "is defined as protected method" do
+        expect(test_instance.respond_to?(:unopened_group_member_notifier_count)).to       be_falsey
+        expect(test_instance.respond_to?(:unopened_group_member_notifier_count, true)).to be_truthy
+      end
+    end
+
+    describe "#opened_group_member_notifier_count" do
+      it "is defined as protected method" do
+        expect(test_instance.respond_to?(:opened_group_member_notifier_count)).to       be_falsey
+        expect(test_instance.respond_to?(:opened_group_member_notifier_count, true)).to be_truthy
+      end
+    end
   end
 
   private