activity_notification 0.0.8 → 0.0.9

data/spec/concerns/renderable_spec.rb

@@ -0,0 +1,110 @@
+shared_examples_for :renderable do
+  let(:test_class_name) { described_class.to_s.underscore.split('/').last.to_sym }
+  let(:test_target) { create(:user) }
+  let(:test_instance) { create(test_class_name, target: test_target) }
+  let(:target_type_key) { 'user' }
+
+  let(:notifier_name)        { 'foo' }
+  let(:article_title)        { 'bar' }
+  let(:group_member_count)   { 3 }
+  let(:simple_text_key)      { 'article.create' }
+  let(:params_text_key)      { 'comment.post' }
+  let(:group_text_key)       { 'comment.reply' }
+  let(:simple_text_original) { 'Article has been created' }
+  let(:params_text_original) { "<p>%{notifier_name} posted comments to your article %{article_title}</p>" }
+  let(:group_text_original)  { "<p>%{notifier_name} and %{group_member_count} people replied for your comments</p>" }
+  let(:params_text_embedded) { "<p>foo posted comments to your article bar</p>" }
+  let(:group_text_embedded)  { "<p>foo and 3 people replied for your comments</p>" }
+
+  describe "i18n configuration" do
+    it "has key configured for simple text" do
+      expect(I18n.t("notification.#{target_type_key}.#{simple_text_key}.text"))
+        .to eq(simple_text_original)
+    end
+
+    it "has key configured with embedded params" do
+      expect(I18n.t("notification.#{target_type_key}.#{params_text_key}.text"))
+        .to eq(params_text_original)
+      expect(I18n.t("notification.#{target_type_key}.#{params_text_key}.text",
+        {notifier_name: notifier_name, article_title: article_title}))
+        .to eq(params_text_embedded)
+    end
+
+    it "has key configured with embedded params including group_member_count" do
+      expect(I18n.t("notification.#{target_type_key}.#{group_text_key}.text"))
+        .to eq(group_text_original)
+      expect(I18n.t("notification.#{target_type_key}.#{group_text_key}.text",
+        {notifier_name: notifier_name, group_member_count: group_member_count}))
+        .to eq(group_text_embedded)
+    end
+  end
+
+  describe "as public instance methods" do
+    describe "#text" do
+      context "without params argument" do
+        context "with target type of test instance" do
+          it "uses text from key" do
+            test_instance.key = simple_text_key
+            expect(test_instance.text).to eq(simple_text_original)
+          end
+
+          it "uses text from key with notification namespace" do
+            test_instance.key = "notification.#{simple_text_key}"
+            expect(test_instance.text).to eq(simple_text_original)
+          end
+
+          context "when the text is missing for the target type" do
+            it "returns translation missing text" do
+              test_instance.target = create(:admin)
+              test_instance.key = "notification.#{simple_text_key}"
+              expect(test_instance.text)
+                .to eq("translation missing: en.notification.admin.#{simple_text_key}.text")
+            end
+          end
+
+          context "when the text has embedded parameters" do
+            it "raises MissingInterpolationArgument without embedded parameters" do
+              test_instance.key = params_text_key
+              expect { test_instance.text }
+                .to raise_error(I18n::MissingInterpolationArgument)
+            end
+          end
+        end
+      end
+
+      context "with params argument" do
+        context "with target type of target parameter" do
+          it "uses text from key" do
+            test_instance.target = create(:admin)
+            test_instance.key = simple_text_key
+            expect(test_instance.text({target: :user})).to eq(simple_text_original)
+          end
+
+          context "when the text has embedded parameters" do
+            it "uses text with embedded parameters" do
+              test_instance.key = params_text_key
+              expect(test_instance.text({notifier_name: notifier_name, article_title: article_title}))
+                .to eq(params_text_embedded)
+            end
+
+            it "uses text with automatically embedded group_member_count" do
+              # Create 3 group members
+              create(test_class_name, target: test_instance.target, group_owner: test_instance)
+              create(test_class_name, target: test_instance.target, group_owner: test_instance)
+              create(test_class_name, target: test_instance.target, group_owner: test_instance)
+              test_instance.key = group_text_key
+              expect(test_instance.text({notifier_name: notifier_name}))
+                .to eq(group_text_embedded)
+            end
+          end
+        end
+      end
+    end
+
+    # Test with view_helper for the following methods
+    # #render
+    # #partial_path
+    # #layout_path
+
+  end
+end

data/spec/controllers/notifications_controller_shared_examples.rb

@@ -0,0 +1,457 @@
+shared_examples_for :notification_controller do
+  let(:target_params) { { target_type: target_type }.merge(extra_params || {}) }
+
+  describe "GET #index" do
+    context "with target_type and target_id parameters" do
+      before do
+        @notification = create(:notification, target: test_target)
+        get :index, target_params.merge({ target_id: test_target, typed_target_param => 'dummy' }), valid_session
+      end
+
+      it "returns 200 as http status code" do
+        expect(response.status).to eq(200)
+      end
+
+      it "assigns notification index as @notifications" do
+        expect(assigns(:notifications)).to eq([@notification])
+      end
+
+      it "renders the :index template" do
+        expect(response).to render_template :index
+      end
+    end
+
+    context "with target_type and (typed_target)_id parameters" do
+      before do
+        @notification = create(:notification, target: test_target)
+        get :index, target_params.merge({ typed_target_param => test_target }), valid_session
+      end
+  
+      it "returns 200 as http status code" do
+        expect(response.status).to eq(200)
+      end
+
+      it "assigns notification index as @notifications" do
+        expect(assigns(:notifications)).to eq([@notification])
+      end
+
+      it "renders the :index template" do
+        expect(response).to render_template :index
+      end
+    end
+
+    context "without target_type parameters" do
+      before do
+        @notification = create(:notification, target: test_target)
+        get :index, { typed_target_param => test_target }, valid_session
+      end
+
+      it "returns 400 as http status code" do
+        expect(response.status).to eq(400)
+      end
+    end
+
+    context "with not found (typed_target)_id parameter" do
+      before do
+        @notification = create(:notification, target: test_target)
+      end
+
+      it "raises ActiveRecord::RecordNotFound" do
+        expect {
+          get :index, target_params.merge({ typed_target_param => 0 }), valid_session
+        }.to raise_error(ActiveRecord::RecordNotFound)
+      end
+    end
+
+    context "with json as format parameter" do
+      before do
+        @notification = create(:notification, target: test_target)
+        get :index, target_params.merge({ typed_target_param => test_target, format: :json }), valid_session
+      end
+
+      it "returns 200 as http status code" do
+        expect(response.status).to eq(200)
+      end
+
+      it "returns json format" do
+        expect(JSON.parse(response.body).first)
+        .to include("target_id" => test_target.id, "target_type" => test_target.to_class_name)
+      end
+    end
+
+    context "with filter parameter" do
+      context "with unopened as filter" do
+        before do
+          @notification = create(:notification, target: test_target)
+          get :index, target_params.merge({ typed_target_param => test_target, filter: 'unopened' }), valid_session
+        end
+
+        it "assigns unopened notification index as @notifications" do
+          expect(assigns(:notifications)).to eq([@notification])
+        end
+      end
+
+      context "with opened as filter" do
+        before do
+          @notification = create(:notification, target: test_target)
+          get :index, target_params.merge({ typed_target_param => test_target, filter: 'opened' }), valid_session
+        end
+
+        it "assigns unopened notification index as @notifications" do
+          expect(assigns(:notifications)).to eq([])
+        end
+      end
+    end
+
+    context "with limit parameter" do
+      before do
+        create(:notification, target: test_target)
+        create(:notification, target: test_target)
+      end
+      context "with 2 as limit" do
+        before do
+          get :index, target_params.merge({ typed_target_param => test_target, limit: 2 }), valid_session
+        end
+
+        it "assigns notification index of size 2 as @notifications" do
+          expect(assigns(:notifications).size).to eq(2)
+        end
+      end
+
+      context "with 1 as limit" do
+        before do
+          get :index, target_params.merge({ typed_target_param => test_target, limit: 1 }), valid_session
+        end
+
+        it "assigns notification index of size 1 as @notifications" do
+          expect(assigns(:notifications).size).to eq(1)
+        end
+      end
+    end
+
+    context "with reload parameter" do
+      context "with false as reload" do
+        before do
+          @notification = create(:notification, target: test_target)
+          get :index, target_params.merge({ typed_target_param => test_target, reload: false }), valid_session
+        end
+    
+        it "returns 200 as http status code" do
+          expect(response.status).to eq(200)
+        end
+  
+        it "does not assign notification index as @notifications" do
+          expect(assigns(:notifications)).to be_nil
+        end
+  
+        it "renders the :index template" do
+          expect(response).to render_template :index
+        end
+      end
+    end
+  end
+
+  describe "POST #open_all" do
+    context "http direct POST request" do
+      before do
+        @notification = create(:notification, target: test_target)
+        expect(@notification.opened?).to be_falsey
+        post :open_all, target_params.merge({ typed_target_param => test_target }), valid_session
+      end
+
+      it "returns 302 as http status code" 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
+      end
+
+      it "redirects to :index" do
+        expect(response).to redirect_to action: :index
+      end
+    end
+
+    context "http POST request from root_path" do
+      before do
+        @notification = create(:notification, target: test_target)
+        expect(@notification.opened?).to be_falsey
+        request.env["HTTP_REFERER"] = root_path
+        post :open_all, target_params.merge({ typed_target_param => test_target }), valid_session
+      end
+
+      it "returns 302 as http status code" do
+        expect(response.status).to eq(302)
+      end
+
+      it "opens all notifications of the target" do
+        expect(assigns(:notifications).first.opened?).to be_truthy
+      end
+
+      it "redirects to root_path as request.referer" do
+        expect(response).to redirect_to root_path
+      end
+    end
+
+    context "Ajax POST request" do
+      before do
+        @notification = create(:notification, target: test_target)
+        expect(@notification.opened?).to be_falsey
+        xhr :post, :open_all, target_params.merge({ typed_target_param => test_target }), valid_session
+      end
+
+      it "returns 200 as http status code" do
+        expect(response.status).to eq(200)
+      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
+      end
+
+      it "renders the :open_all template as format js" do
+        expect(response).to render_template :open_all, format: :js
+      end
+    end
+  end
+
+  describe "GET #show" do
+    context "with id, target_type and (typed_target)_id parameters" do
+      before do
+        @notification = create(:notification, target: test_target)
+        get :show, target_params.merge({ id: @notification, typed_target_param => test_target }), valid_session
+      end
+
+      it "returns 200 as http status code" do
+        expect(response.status).to eq(200)
+      end
+
+      it "assigns the requested notification as @notification" do
+        expect(assigns(:notification)).to eq(@notification)
+      end
+
+      it "renders the :index template" do
+        expect(response).to render_template :show
+      end
+    end
+
+    context "with wrong id and (typed_target)_id parameters" do
+      before do
+        @notification = create(:notification, target: create(:user))
+        get :show, target_params.merge({ id: @notification, typed_target_param => test_target }), valid_session
+      end
+
+      it "returns 403 as http status code" do
+        expect(response.status).to eq(403)
+      end
+    end
+  end
+
+  describe "DELETE #destroy" do
+    context "http direct DELETE request" do
+      before do
+        @notification = create(:notification, target: test_target)
+        delete :destroy, target_params.merge({ id: @notification, typed_target_param => test_target }), valid_session
+      end
+
+      it "returns 302 as http status code" do
+        expect(response.status).to eq(302)
+      end
+
+      it "deletes the notification" do
+        expect(assigns(test_target.notifications.where(id: @notification.id).exists?)).to be_falsey
+      end
+
+      it "redirects to :index" do
+        expect(response).to redirect_to action: :index
+      end
+    end
+
+    context "http DELETE request from root_path" do
+      before do
+        @notification = create(:notification, target: test_target)
+        request.env["HTTP_REFERER"] = root_path
+        delete :destroy, target_params.merge({ id: @notification, typed_target_param => test_target }), valid_session
+      end
+
+      it "returns 302 as http status code" do
+        expect(response.status).to eq(302)
+      end
+
+      it "deletes the notification" do
+        expect(assigns(test_target.notifications.where(id: @notification.id).exists?)).to be_falsey
+      end
+
+      it "redirects to root_path as request.referer" do
+        expect(response).to redirect_to root_path
+      end
+    end
+
+    context "Ajax DELETE request" do
+      before do
+        @notification = create(:notification, target: test_target)
+        xhr :delete, :destroy, target_params.merge({ id: @notification, typed_target_param => test_target }), valid_session
+      end
+
+      it "returns 200 as http status code" do
+        expect(response.status).to eq(200)
+      end
+
+      it "assigns notification index as @notifications" do
+        expect(assigns(:notifications)).to eq([])
+      end
+
+      it "deletes the notification" do
+        expect(assigns(test_target.notifications.where(id: @notification.id).exists?)).to be_falsey
+      end
+
+      it "renders the :destroy template as format js" do
+        expect(response).to render_template :destroy, format: :js
+      end
+    end
+  end
+
+  describe "POST #open" do
+    context "without move parameter" do
+      context "http direct POST request" do
+        before do
+          @notification = create(:notification, target: test_target)
+          expect(@notification.opened?).to be_falsey
+          post :open, target_params.merge({ id: @notification, typed_target_param => test_target }), valid_session
+        end
+
+        it "returns 302 as http status code" do
+          expect(response.status).to eq(302)
+        end
+
+        it "opens the notification" do
+          expect(@notification.reload.opened?).to be_truthy
+        end
+
+        it "redirects to :index" do
+          expect(response).to redirect_to action: :index
+        end
+      end
+
+      context "http POST request from root_path" do
+        before do
+          @notification = create(:notification, target: test_target)
+          expect(@notification.opened?).to be_falsey
+          request.env["HTTP_REFERER"] = root_path
+          post :open, target_params.merge({ id: @notification, typed_target_param => test_target }), valid_session
+        end
+
+        it "returns 302 as http status code" do
+          expect(response.status).to eq(302)
+        end
+
+        it "opens the notification" do
+          expect(@notification.reload.opened?).to be_truthy
+        end
+
+        it "redirects to root_path as request.referer" do
+          expect(response).to redirect_to root_path
+        end
+      end
+
+      context "Ajax POST request" do
+        before do
+          @notification = create(:notification, target: test_target)
+          expect(@notification.opened?).to be_falsey
+          request.env["HTTP_REFERER"] = root_path
+          xhr :post, :open, target_params.merge({ id: @notification, typed_target_param => test_target }), valid_session
+        end
+    
+        it "returns 200 as http status code" do
+          expect(response.status).to eq(200)
+        end
+    
+        it "assigns notification index as @notifications" do
+          expect(assigns(:notifications)).to eq([@notification])
+        end
+  
+        it "opens the notification" do
+          expect(@notification.reload.opened?).to be_truthy
+        end
+  
+        it "renders the :open template as format js" do
+          expect(response).to render_template :open, format: :js
+        end
+      end
+    end
+
+    context "with true as move parameter" do
+      context "http direct POST request" do
+        before do
+          @notification = create(:notification, target: test_target)
+          expect(@notification.opened?).to be_falsey
+          post :open, target_params.merge({ id: @notification, typed_target_param => test_target, move: true }), valid_session
+        end
+
+        it "returns 302 as http status code" do
+          expect(response.status).to eq(302)
+        end
+
+        it "assigns notification index as @notifications" do
+          expect(assigns(:notifications)).to eq([@notification])
+        end
+
+        it "opens the notification" do
+          expect(@notification.reload.opened?).to be_truthy
+        end
+
+        it "redirects to notifiable_path" do
+          expect(response).to redirect_to @notification.notifiable_path
+        end
+      end
+    end
+  end
+
+  describe "GET #move" do
+    context "without open parameter" do
+      context "http direct GET request" do
+        before do
+          @notification = create(:notification, target: test_target)
+          get :move, target_params.merge({ id: @notification, typed_target_param => test_target }), valid_session
+        end
+
+        it "returns 302 as http status code" do
+          expect(response.status).to eq(302)
+        end
+
+        it "redirects to notifiable_path" do
+          expect(response).to redirect_to @notification.notifiable_path
+        end
+      end
+    end
+
+    context "with true as open parameter" do
+      context "http direct GET request" do
+        before do
+          @notification = create(:notification, target: test_target)
+          expect(@notification.opened?).to be_falsey
+          get :move, target_params.merge({ id: @notification, typed_target_param => test_target, open: true }), valid_session
+        end
+
+        it "returns 302 as http status code" do
+          expect(response.status).to eq(302)
+        end
+
+        it "opens the notification" do
+          expect(@notification.reload.opened?).to be_truthy
+        end
+
+        it "redirects to notifiable_path" do
+          expect(response).to redirect_to @notification.notifiable_path
+        end
+      end
+    end
+  end
+end