activity_notification 0.0.10 → 1.0.0

data/spec/concerns/common_spec.rb

@@ -145,6 +145,42 @@ shared_examples_for :common do
         end
       end
     end
+
+    describe "#to_class_name" do
+      it "returns resource name" do
+        expect(create(:user).to_class_name).to eq 'User'
+        expect(test_instance.to_class_name).to eq test_instance.class.name
+      end
+    end
+
+    describe "#to_resource_name" do
+      it "returns singularized model name (resource name)" do
+        expect(create(:user).to_resource_name).to eq 'user'
+        expect(test_instance.to_resource_name).to eq test_instance.class.name.demodulize.singularize.underscore
+      end
+    end
+
+    describe "#to_resources_name" do
+      it "returns pluralized model name (resources name)" do
+        expect(create(:user).to_resources_name).to eq 'users'
+        expect(test_instance.to_resources_name).to eq test_instance.class.name.demodulize.pluralize.underscore
+      end
+    end
+
+    describe "#printable_type" do
+      it "returns printable model type name to be humanized" do
+        expect(create(:user).printable_type).to eq 'User'
+        expect(test_instance.printable_type).to eq test_instance.class.name.demodulize.humanize
+      end
+    end
+
+    describe "#printable_name" do
+      it "returns printable model name to show in view or email" do
+        user = create(:user)
+        expect(user.printable_name).to eq "User (#{user.id})"
+        expect(test_instance.printable_name).to eq "#{test_instance.printable_type} (#{test_instance.id})"
+      end
+    end
   end
 
 end

data/spec/concerns/models/group_spec.rb

@@ -0,0 +1,61 @@
+shared_examples_for :group do
+  let(:test_class_name) { described_class.to_s.underscore.split('/').last.to_sym }
+  let(:test_instance) { create(test_class_name) }
+
+  describe "as public class methods" do
+    describe ".available_as_group?" do
+      it "returns true" do
+        expect(described_class.available_as_group?).to be_truthy
+      end
+    end
+
+    describe ".set_group_class_defaults" do
+      it "set parameter fields as default" do
+        described_class.set_group_class_defaults
+        expect(described_class._printable_notification_group_name).to eq(:printable_name)
+      end
+    end    
+  end
+
+  describe "as public instance methods" do
+    before do
+      described_class.set_group_class_defaults
+    end
+
+    describe "#printable_group_name" do
+      context "without any configuration" do
+        it "returns ActivityNotification::Common.printable_name" do
+          expect(test_instance.printable_group_name).to eq(test_instance.printable_name)
+        end
+      end
+
+      context "configured with a field" do
+        it "returns specified value" do
+          described_class._printable_notification_group_name = 'test_printable_name'
+          expect(test_instance.printable_group_name).to eq('test_printable_name')
+        end
+
+        it "returns specified symbol of field" do
+          described_class._printable_notification_group_name = :title
+          expect(test_instance.printable_group_name).to eq(test_instance.title)
+        end
+
+        it "returns specified symbol of method" do
+          module AdditionalMethods
+            def custom_printable_name
+              'test_printable_name'
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._printable_notification_group_name = :custom_printable_name
+          expect(test_instance.printable_group_name).to eq('test_printable_name')
+        end
+
+        it "returns specified lambda with single target argument" do
+          described_class._printable_notification_group_name = ->(target){ 'test_printable_name' }
+          expect(test_instance.printable_group_name).to eq('test_printable_name')
+        end
+      end
+    end
+  end
+end

data/spec/concerns/models/notifiable_spec.rb

@@ -21,6 +21,7 @@ shared_examples_for :notifiable do
         expect(described_class._notification_parameters).to    eq({})
         expect(described_class._notification_email_allowed).to eq({})
         expect(described_class._notifiable_path).to            eq({})
+        expect(described_class._printable_notifiable_name).to  eq({})
       end
     end    
   end
@@ -403,6 +404,42 @@ shared_examples_for :notifiable do
       end
     end
 
+    describe "#printable_notifiable_name" do
+      context "without any configuration" do
+        it "returns ActivityNotification::Common.printable_name" do
+          expect(test_instance.printable_notifiable_name(test_target, 'dummy_key')).to eq(test_instance.printable_name)
+        end
+      end
+
+      context "configured with a field" do
+        it "returns specified value" do
+          described_class._printable_notifiable_name[:users] = 'test_printable_name'
+          expect(test_instance.printable_notifiable_name(test_target, 'dummy_key')).to eq('test_printable_name')
+        end
+
+        it "returns specified symbol of field" do
+          described_class._printable_notifiable_name[:users] = :title
+          expect(test_instance.printable_notifiable_name(test_target, 'dummy_key')).to eq(test_instance.title)
+        end
+
+        it "returns specified symbol of method" do
+          module AdditionalMethods
+            def custom_printable_name
+              'test_printable_name'
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._printable_notifiable_name[:users] = :custom_printable_name
+          expect(test_instance.printable_notifiable_name(test_target, 'dummy_key')).to eq('test_printable_name')
+        end
+
+        it "returns specified lambda with single target argument" do
+          described_class._printable_notifiable_name[:users] = ->(target){ 'test_printable_name' }
+          expect(test_instance.printable_notifiable_name(test_target, 'dummy_key')).to eq('test_printable_name')
+        end
+      end
+    end
+
     describe "#notify" do
       it "is an alias of ActivityNotification::Notification.notify" do
         expect(ActivityNotification::Notification).to receive(:notify)

data/spec/concerns/models/notifier_spec.rb

@@ -18,6 +18,54 @@ shared_examples_for :notifier do
         expect(described_class.available_as_notifier?).to be_truthy
       end
     end
+
+    describe ".set_notifier_class_defaults" do
+      it "set parameter fields as default" do
+        described_class.set_notifier_class_defaults
+        expect(described_class._printable_notifier_name).to eq(:printable_name)
+      end
+    end
   end
 
+  describe "as public instance methods" do
+    before do
+      described_class.set_notifier_class_defaults
+    end
+
+    describe "#printable_notifier_name" do
+      context "without any configuration" do
+        it "returns ActivityNotification::Common.printable_name" do
+          expect(test_instance.printable_notifier_name).to eq(test_instance.printable_name)
+        end
+      end
+
+      context "configured with a field" do
+        it "returns specified value" do
+          described_class._printable_notifier_name = 'test_printable_name'
+          expect(test_instance.printable_notifier_name).to eq('test_printable_name')
+        end
+
+        it "returns specified symbol of field" do
+          described_class._printable_notifier_name = :name
+          expect(test_instance.printable_notifier_name).to eq(test_instance.name)
+        end
+
+        it "returns specified symbol of method" do
+          module AdditionalMethods
+            def custom_printable_name
+              'test_printable_name'
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._printable_notifier_name = :custom_printable_name
+          expect(test_instance.printable_notifier_name).to eq('test_printable_name')
+        end
+
+        it "returns specified lambda with single target argument" do
+          described_class._printable_notifier_name = ->(target){ 'test_printable_name' }
+          expect(test_instance.printable_notifier_name).to eq('test_printable_name')
+        end
+      end
+    end
+  end
 end

data/spec/concerns/models/target_spec.rb

@@ -24,8 +24,10 @@ shared_examples_for :target do
     describe ".set_target_class_defaults" do
       it "set parameter fields as default" do
         described_class.set_target_class_defaults
-        expect(described_class._notification_email).to         eq(nil)
-        expect(described_class._notification_email_allowed).to eq(ActivityNotification.config.email_enabled)
+        expect(described_class._notification_email).to                 eq(nil)
+        expect(described_class._notification_email_allowed).to         eq(ActivityNotification.config.email_enabled)
+        expect(described_class._notification_devise_resource).to       be_a_kind_of(Proc)
+        expect(described_class._printable_notification_target_name).to eq(:printable_name)
       end
     end    
   end
@@ -65,7 +67,7 @@ shared_examples_for :target do
           expect(test_instance.mailer_to).to eq('test@example.com')
         end
 
-        it "returns specified lambda with single notifiable argument" do
+        it "returns specified lambda with single target argument" do
           described_class._notification_email = ->(target){ 'test@example.com' }
           expect(test_instance.mailer_to).to eq('test@example.com')
         end
@@ -171,6 +173,42 @@ shared_examples_for :target do
       end
     end
 
+    describe "#printable_target_name" do
+      context "without any configuration" do
+        it "returns ActivityNotification::Common.printable_name" do
+          expect(test_instance.printable_target_name).to eq(test_instance.printable_name)
+        end
+      end
+
+      context "configured with a field" do
+        it "returns specified value" do
+          described_class._printable_notification_target_name = 'test_printable_name'
+          expect(test_instance.printable_target_name).to eq('test_printable_name')
+        end
+
+        it "returns specified symbol of field" do
+          described_class._printable_notification_target_name = :name
+          expect(test_instance.printable_target_name).to eq(test_instance.name)
+        end
+
+        it "returns specified symbol of method" do
+          module AdditionalMethods
+            def custom_printable_name
+              'test_printable_name'
+            end
+          end
+          test_instance.extend(AdditionalMethods)
+          described_class._printable_notification_target_name = :custom_printable_name
+          expect(test_instance.printable_target_name).to eq('test_printable_name')
+        end
+
+        it "returns specified lambda with single target argument" do
+          described_class._printable_notification_target_name = ->(target){ 'test_printable_name' }
+          expect(test_instance.printable_target_name).to eq('test_printable_name')
+        end
+      end
+    end
+
     describe "#unopened_notification_count" do
       it "returns count of unopened notification index" do
         create(:notification, target: test_instance)
@@ -212,24 +250,28 @@ shared_examples_for :target do
         before do
           create(:notification, target: test_instance)
           create(:notification, target: test_instance)
+          create(:notification, target: test_instance).open!
         end
 
         it "calls unopened_notification_index" do
-          expect(test_instance).to receive(:unopened_notification_index)
+          expect(test_instance).to receive(:unopened_notification_index).at_least(:once)
           test_instance.notification_index
         end
 
         context "without limit" do
-          it "returns the same as unopened_notification_index" do
-            expect(test_instance.notification_index).to eq(test_instance.unopened_notification_index)
-            expect(test_instance.notification_index.size).to eq(2)
+          it "returns the combined array of unopened_notification_index and opened_notification_index" do
+            expect(test_instance.notification_index[0]).to eq(test_instance.unopened_notification_index[0])
+            expect(test_instance.notification_index[1]).to eq(test_instance.unopened_notification_index[1])
+            expect(test_instance.notification_index[2]).to eq(test_instance.opened_notification_index[0])
+            expect(test_instance.notification_index.size).to eq(3)
           end
         end
 
         context "with limit" do
           it "returns the same as unopened_notification_index with limit" do
-            expect(test_instance.notification_index(1)).to eq(test_instance.unopened_notification_index(1))
-            expect(test_instance.notification_index(1).size).to eq(1)
+            options = { limit: 1 }
+            expect(test_instance.notification_index(options)).to eq(test_instance.unopened_notification_index(options))
+            expect(test_instance.notification_index(options).size).to eq(1)
           end
         end
       end
@@ -241,7 +283,7 @@ shared_examples_for :target do
         end
 
         it "calls unopened_notification_index" do
-          expect(test_instance).to receive(:opened_notification_index)
+          expect(test_instance).to receive(:opened_notification_index).at_least(:once)
           test_instance.notification_index
         end
 
@@ -254,8 +296,9 @@ shared_examples_for :target do
 
         context "with limit" do
           it "returns the same as opened_notification_index with limit" do
-            expect(test_instance.notification_index(1)).to eq(test_instance.opened_notification_index(1))
-            expect(test_instance.notification_index(1).size).to eq(1)
+            options = { limit: 1 }
+            expect(test_instance.notification_index(options)).to eq(test_instance.opened_notification_index(options))
+            expect(test_instance.notification_index(options).size).to eq(1)
           end
         end
       end
@@ -298,8 +341,9 @@ shared_examples_for :target do
 
         context "with limit" do
           it "returns unopened notification index with limit" do
-            expect(test_instance.unopened_notification_index(1).size).to eq(1)
-            expect(test_instance.unopened_notification_index(1).first).to eq(@notification_2)
+            options = { limit: 1 }
+            expect(test_instance.unopened_notification_index(options).size).to eq(1)
+            expect(test_instance.unopened_notification_index(options).first).to eq(@notification_2)
           end
         end
       end
@@ -319,7 +363,7 @@ shared_examples_for :target do
     describe "#opened_notification_index" do
       context "when the target has no notifications" do
         it "returns empty records" do
-          expect(test_instance.opened_notification_index(1)).to be_empty
+          expect(test_instance.opened_notification_index).to be_empty
         end
       end
 
@@ -330,12 +374,12 @@ shared_examples_for :target do
         end
 
         context "without limit" do
-          it "uses ActivityNotification.config.opened_limit as limit" do
-            configured_opened_limit = ActivityNotification.config.opened_limit
-            ActivityNotification.config.opened_limit = 1
-            expect(test_instance.opened_notification_index(1).size).to eq(1)
-            expect(test_instance.opened_notification_index(1).first).to eq(@notification_2)
-            ActivityNotification.config.opened_limit = configured_opened_limit
+          it "uses ActivityNotification.config.opened_index_limit as limit" do
+            configured_opened_index_limit = ActivityNotification.config.opened_index_limit
+            ActivityNotification.config.opened_index_limit = 1
+            expect(test_instance.opened_notification_index.size).to eq(1)
+            expect(test_instance.opened_notification_index.first).to eq(@notification_2)
+            ActivityNotification.config.opened_index_limit = configured_opened_index_limit
           end
 
           it "returns opened notification index" do
@@ -361,8 +405,9 @@ shared_examples_for :target do
 
         context "with limit" do
           it "returns opened notification index with limit" do
-            expect(test_instance.opened_notification_index(1).size).to eq(1)
-            expect(test_instance.opened_notification_index(1).first).to eq(@notification_2)
+            options = { limit: 1 }
+            expect(test_instance.opened_notification_index(options).size).to eq(1)
+            expect(test_instance.opened_notification_index(options).first).to eq(@notification_2)
           end
         end
       end
@@ -410,24 +455,28 @@ shared_examples_for :target do
         before do
           create(:notification, target: test_instance)
           create(:notification, target: test_instance)
+          create(:notification, target: test_instance).open!
         end
 
         it "calls unopened_notification_index_with_attributes" do
-          expect(test_instance).to receive(:unopened_notification_index_with_attributes)
+          expect(test_instance).to receive(:unopened_notification_index_with_attributes).at_least(:once)
           test_instance.notification_index_with_attributes
         end
 
         context "without limit" do
-          it "returns the same as unopened_notification_index_with_attributes" do
-            expect(test_instance.notification_index_with_attributes).to eq(test_instance.unopened_notification_index_with_attributes)
-            expect(test_instance.notification_index_with_attributes.size).to eq(2)
+          it "returns the combined array of unopened_notification_index and opened_notification_index" do
+            expect(test_instance.notification_index_with_attributes[0]).to eq(test_instance.unopened_notification_index[0])
+            expect(test_instance.notification_index_with_attributes[1]).to eq(test_instance.unopened_notification_index[1])
+            expect(test_instance.notification_index_with_attributes[2]).to eq(test_instance.opened_notification_index[0])
+            expect(test_instance.notification_index.size).to eq(3)
           end
         end
 
         context "with limit" do
           it "returns the same as unopened_notification_index_with_attributes with limit" do
-            expect(test_instance.notification_index_with_attributes(1)).to eq(test_instance.unopened_notification_index_with_attributes(1))
-            expect(test_instance.notification_index_with_attributes(1).size).to eq(1)
+            options = { limit: 1 }
+            expect(test_instance.notification_index_with_attributes(options)).to eq(test_instance.unopened_notification_index_with_attributes(options))
+            expect(test_instance.notification_index_with_attributes(options).size).to eq(1)
           end
         end
       end
@@ -452,8 +501,9 @@ shared_examples_for :target do
 
         context "with limit" do
           it "returns the same as opened_notification_index_with_attributes with limit" do
-            expect(test_instance.notification_index_with_attributes(1)).to eq(test_instance.opened_notification_index_with_attributes(1))
-            expect(test_instance.notification_index_with_attributes(1).size).to eq(1)
+            options = { limit: 1 }
+            expect(test_instance.notification_index_with_attributes(options)).to eq(test_instance.opened_notification_index_with_attributes(options))
+            expect(test_instance.notification_index_with_attributes(options).size).to eq(1)
           end
         end
       end

data/spec/factories/dummy/dummy_group.rb

@@ -0,0 +1,4 @@
+FactoryGirl.define do
+  factory :dummy_group, class: Dummy::DummyGroup do
+  end
+end

data/spec/helpers/view_helpers_spec.rb

@@ -198,6 +198,12 @@ describe ActivityNotification::ViewHelpers, type: :helper do
     end
   end
 
+  describe '#notifications_path_for' do
+    it "returns path for the notification target" do
+      expect(notifications_path_for(target_user))
+        .to eq(user_notifications_path(target_user))
+    end
+  end
 
   describe '#notification_path_for' do
     it "returns path for the notification target" do
@@ -227,6 +233,13 @@ describe ActivityNotification::ViewHelpers, type: :helper do
     end
   end
 
+  describe '#notifications_url_for' do
+    it "returns url for the notification target" do
+      expect(notifications_url_for(target_user))
+        .to eq(user_notifications_url(target_user))
+    end
+  end
+
   describe '#notification_url_for' do
     it "returns url for the notification target" do
       expect(notification_url_for(notification))