activity_notification 0.0.8 → 0.0.9

data/lib/generators/activity_notification/controllers_generator.rb

@@ -3,7 +3,7 @@ require 'rails/generators/base'
 module ActivityNotification
   module Generators
     class ControllersGenerator < Rails::Generators::Base
-      CONTROLLERS = %w(notifications notifications_with_devise).freeze
+      CONTROLLERS = ['notifications', 'notifications_with_devise'].freeze
 
       desc <<-DESC.strip_heredoc
         Create inherited ActivityNotification controllers in your app/controllers folder.

data/lib/generators/activity_notification/install_generator.rb

@@ -6,7 +6,7 @@ module ActivityNotification
 
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../../templates", __FILE__)
-``
+
       desc "Creates a ActivityNotification initializer and copy locale files to your application."
       class_option :orm
 
@@ -14,7 +14,7 @@ module ActivityNotification
         
         #TODO suport other orm e.g. mongoid
         unless options[:orm] == :active_record
-          raise MissingORMError, <<-ERROR.strip_heredoc
+          raise TypeError, <<-ERROR.strip_heredoc
           Currently ActivityNotification is only supported with Active Record ORM.
 
           Be sure to have an Active Record ORM loaded in your
@@ -30,16 +30,13 @@ module ActivityNotification
       end
 
       def copy_locale
-        copy_file "../../../config/locales/en.yml", "config/locales/activity_notification.en.yml"
+        template "locales/en.yml", "config/locales/activity_notification.en.yml"
       end
 
       def show_readme
         readme "README" if behavior == :invoke
       end
 
-      def rails_4?
-        Rails::VERSION::MAJOR == 4
-      end
     end
   end
 end

data/lib/generators/activity_notification/{notification → models}/notification_generator.rb

@@ -6,11 +6,12 @@ module ActivityNotification
     class NotificationGenerator < ActiveRecord::Generators::Base
       source_root File.expand_path("../../../templates/notification", __FILE__)
 
-      argument :name, type: :string, default: 'notification'
+      argument :name, type: :string, default: 'Notification'
 
-      # Create model in project's folder
-      def generate_files
-        copy_file 'notification.rb', "app/models/#{name}.rb"
+      # Create model in application directory
+      def create_models
+        @model_name = name
+        template 'notification.rb', "app/models/#{name.underscore}.rb"
       end
     end
   end

data/lib/generators/activity_notification/views_generator.rb

@@ -3,41 +3,39 @@ require 'rails/generators/base'
 module ActivityNotification
   module Generators
     # Include this module in your generator to generate ActivityNotification views.
-    # `copy_views` is the main method and by default copies all views
-    # with forms.
+    # `copy_views` is the main method and by default copies all views of ActivityNotification.
     class ViewsGenerator < Rails::Generators::Base
+      VIEWS = [:notifications, :mailer].freeze
+
       source_root File.expand_path("../../../../app/views/activity_notification", __FILE__)
       desc "Copies default ActivityNotification views to your application."
 
       argument :target, required: false, default: nil,
-                       desc: "The target to copy views to"
-      class_option :views, aliases: "-v", type: :array, desc: "Select specific view directories to generate (notifications, mailer)"
+        desc: "The target to copy views to"
+      class_option :views, aliases: "-v", type: :array,
+        desc: "Select specific view directories to generate (notifications, mailer)"
       public_task :copy_views
 
       def copy_views
-        if options[:views]
-          options[:views].each do |directory|
-            view_directory directory.to_sym
-          end
-        else
-          view_directory :notifications
-          view_directory :mailer
+        target_views = options[:views] || VIEWS
+        target_views.each do |directory|
+          view_directory directory.to_sym
         end
       end
 
       protected
 
-      def view_directory(name, _target_path = nil)
-        directory "#{name.to_s}/default", _target_path || "#{target_path}/#{name}/#{plural_target || :default}"
-      end
-
-      def target_path
-        @target_path ||= "app/views/activity_notification"
-      end
-
-      def plural_target
-        @plural_target ||= target.presence && target.to_s.underscore.pluralize
-      end
+        def view_directory(name, _target_path = nil)
+          directory "#{name.to_s}/default", _target_path || "#{target_path}/#{name}/#{plural_target || :default}"
+        end
+  
+        def target_path
+          @target_path ||= "app/views/activity_notification"
+        end
+  
+        def plural_target
+          @plural_target ||= target.presence && target.to_s.underscore.pluralize
+        end
     end
 
   end

data/lib/generators/templates/active_record/migration.rb

@@ -1,5 +1,5 @@
 # Migration responsible for creating a table with notifications
-class CreateNotifications < ActiveRecord::Migration
+class <%= @migration_name %> < ActiveRecord::Migration
   # Create table
   def change
     create_table :notifications do |t|

data/lib/generators/templates/activity_notification.rb

@@ -1,9 +1,17 @@
 ActivityNotification.configure do |config|
 
-  # Table name to store notification data
+  # Configure if all activity notifications are enabled
+  # Set false when you want to turn off activity notifications
+  config.enabled = true
+
+  # Configure table name to store notification data
   config.table_name = "notifications"
 
-  # ==> Mailer Configuration
+  # Configure if email notification is enabled as default
+  # Note that you can configure them for each model by acts_as roles.
+  # Set true when you want to turn on email notifications as default
+  config.email_enabled = false
+
   # Configure the e-mail address which will be shown in ActivityNotification::Mailer,
   # note that it will be overwritten if you use your own mailer class with default "from" parameter.
   config.mailer_sender = 'please-change-me-at-config-initializers-activity_notification@example.com'
@@ -13,6 +21,8 @@ ActivityNotification.configure do |config|
 
   # Configure the parent class responsible to send e-mails.
   # config.parent_mailer = 'ActionMailer::Base'
-    
+
+  # Configure default limit number of opened notifications you can get from opened* scope
   config.opened_limit = 10
+
 end

data/lib/generators/templates/notification/notification.rb

@@ -1,3 +1,6 @@
 # Notification model for customisation & custom methods
-class Notification < ActivityNotification::Notification
+class <%= @model_name %> < ActivityNotification::Notification
+
+  # Write custom methods or override methods here
+
 end

data/spec/concerns/{notification_api_spec.rb → apis/notification_api_spec.rb}

@@ -1,7 +1,7 @@
 shared_examples_for :notification_api do
   include ActiveJob::TestHelper
   let(:test_class_name) { described_class.to_s.underscore.split('/').last.to_sym }
-  let(:test_instance) { create(test_class_name, target: create(:user, confirmed_at: DateTime.now)) }
+  let(:test_instance) { create(test_class_name) }
   before do
     ActiveJob::Base.queue_adapter = :test
     ActivityNotification::Mailer.deliveries.clear
@@ -11,9 +11,9 @@ shared_examples_for :notification_api do
   describe "as public class methods" do
     before do
       described_class.delete_all
-      @author_user = create(:user, confirmed_at: DateTime.now)
-      @user_1      = create(:user, confirmed_at: DateTime.now)
-      @user_2      = create(:user, confirmed_at: DateTime.now)
+      @author_user = create(:confirmed_user)
+      @user_1      = create(:confirmed_user)
+      @user_2      = create(:confirmed_user)
       @article     = create(:article, user: @author_user)
       @comment_1   = create(:comment, article: @article, user: @user_1)
       @comment_2   = create(:comment, article: @article, user: @user_2)
@@ -22,9 +22,22 @@ shared_examples_for :notification_api do
       expect(@user_2.notifications.count).to eq(0)
     end
 
-    describe "notify" do
+    describe "#notify" do
+      it "returns array of created notifications" do
+        notifications = described_class.notify(:users, @comment_2)
+        expect(notifications).to be_a Array
+        expect(notifications.size).to eq(2)
+        if notifications[0].target == @author_user
+          validate_expected_notification(notifications[0], @author_user, @comment_2)
+          validate_expected_notification(notifications[1], @user_1, @comment_2)
+        else
+          validate_expected_notification(notifications[0], @user_1, @comment_2)
+          validate_expected_notification(notifications[1], @author_user, @comment_2)
+        end
+      end
+
       it "creates notification records" do
-        described_class.notify(User, @comment_2)
+        described_class.notify(:users, @comment_2)
         expect(@author_user.notifications.unopened_only.count).to eq(1)
         expect(@user_1.notifications.unopened_only.count).to eq(1)
         expect(@user_2.notifications.unopened_only.count).to eq(0)
@@ -34,7 +47,7 @@ shared_examples_for :notification_api do
         it "sends notification email later" do
           expect {
             perform_enqueued_jobs do
-              described_class.notify(User, @comment_2)
+              described_class.notify(:users, @comment_2)
             end
           }.to change { ActivityNotification::Mailer.deliveries.size }.by(2)
           expect(ActivityNotification::Mailer.deliveries.size).to eq(2)
@@ -44,14 +57,14 @@ shared_examples_for :notification_api do
   
         it "sends notification email with active job queue" do
           expect {
-            described_class.notify(User, @comment_2)
+            described_class.notify(:users, @comment_2)
           }.to change(ActiveJob::Base.queue_adapter.enqueued_jobs, :size).by(2)
         end
       end
 
       context "with send_later false" do
         it "sends notification email now" do
-          described_class.notify(User, @comment_2, send_later: false)
+          described_class.notify(:users, @comment_2, send_later: false)
           expect(ActivityNotification::Mailer.deliveries.size).to eq(2)
           expect(ActivityNotification::Mailer.deliveries.first.to[0]).to eq(@user_1.email)
           expect(ActivityNotification::Mailer.deliveries.last.to[0]).to eq(@author_user.email)
@@ -59,7 +72,15 @@ shared_examples_for :notification_api do
       end
     end
 
-    describe "notify_all" do
+    describe "#notify_all" do
+      it "returns array of created notifications" do
+        notifications = described_class.notify_all([@author_user, @user_1], @comment_2)
+        expect(notifications).to be_a Array
+        expect(notifications.size).to eq(2)
+        validate_expected_notification(notifications[0], @author_user, @comment_2)
+        validate_expected_notification(notifications[1], @user_1, @comment_2)
+      end
+
       it "creates notification records" do
         described_class.notify_all([@author_user, @user_1], @comment_2)
         expect(@author_user.notifications.unopened_only.count).to eq(1)
@@ -96,7 +117,12 @@ shared_examples_for :notification_api do
       end
     end
 
-    describe "notify_to" do
+    describe "#notify_to" do
+      it "returns reated notification" do
+        notification = described_class.notify_to(@user_1, @comment_2)
+        validate_expected_notification(notification, @user_1, @comment_2)
+      end
+
       it "creates notification records" do
         described_class.notify_to(@user_1, @comment_2)
         expect(@user_1.notifications.unopened_only.count).to eq(1)
@@ -276,7 +302,7 @@ shared_examples_for :notification_api do
       end
     end
 
-    describe "open_all_of" do
+    describe "#open_all_of" do
       before do
         described_class.notify_to(@user_1, @comment_2)
         described_class.notify_to(@user_1, @comment_2)
@@ -284,6 +310,10 @@ shared_examples_for :notification_api do
         expect(@user_1.notifications.opened_only!.count).to eq(0)
       end
 
+      it "returns the number of opened notification records" do
+        expect(described_class.open_all_of(@user_1)).to eq(2)
+      end
+
       it "opens all notifications of the target" do
         described_class.open_all_of(@user_1)
         expect(@user_1.notifications.unopened_only.count).to eq(0)
@@ -297,10 +327,10 @@ shared_examples_for :notification_api do
       end
     end
 
-    describe "group_member_exists?" do
+    describe "#group_member_exists?" do
       context "when specified notifications have any group members" do
         let(:owner_notifications) do
-          target       = create(:user)
+          target       = create(:confirmed_user)
           group_owner  = create(:notification, target: target, group_owner: nil)
                          create(:notification, target: target, group_owner: nil)
           group_member = create(:notification, target: target, group_owner: group_owner)
@@ -315,7 +345,7 @@ shared_examples_for :notification_api do
 
       context "when specified notifications have no group members" do
         let(:owner_notifications) do
-          target       = create(:user)
+          target       = create(:confirmed_user)
           group_owner  = create(:notification, target: target, group_owner: nil)
                          create(:notification, target: target, group_owner: nil)
           target.notifications.group_owners_only
@@ -328,8 +358,8 @@ shared_examples_for :notification_api do
       end
     end
 
-    describe "available_options" do
-      it "returns list of available_options" do
+    describe "#available_options" do
+      it "returns list of available options in notify api" do
         expect(described_class.available_options)
           .to eq([:key, :group, :parameters, :notifier, :send_email, :send_later])
       end
@@ -337,7 +367,7 @@ shared_examples_for :notification_api do
   end
 
   describe "as private class methods" do
-    describe "store_notification" do
+    describe "#store_notification" do
       it "is defined as private method" do
         expect(described_class.respond_to?(:store_notification)).to       be_falsey
         expect(described_class.respond_to?(:store_notification, true)).to be_truthy
@@ -346,7 +376,7 @@ shared_examples_for :notification_api do
   end
 
   describe "as public instance methods" do
-    describe "send_notification_email" do
+    describe "#send_notification_email" do
       context "as default" do
         it "sends notification email later" do
           expect(ActivityNotification::Mailer.deliveries.size).to eq(0)
@@ -376,7 +406,20 @@ shared_examples_for :notification_api do
       end
     end
 
-    describe "open!" do
+    describe "#open!" do
+      before do
+        described_class.delete_all
+      end
+
+      it "returns the number of opened notification records" do
+        expect(test_instance.open!).to eq(1)
+      end
+
+      it "returns the number of opened notification records including group members" do
+        create(test_class_name, group_owner: test_instance, opened_at: nil)
+        expect(test_instance.open!).to eq(2)
+      end
+
       context "as default" do
         it "open notification with current time" do
           expect(test_instance.opened_at.blank?).to be_truthy
@@ -386,6 +429,18 @@ shared_examples_for :notification_api do
           expect(test_instance.opened_at).to        eq(DateTime.now)
           Timecop.return
         end
+
+        #TODO
+        # it "open group member notifications with current time" do
+          # group_member = create(test_class_name, group_owner: test_instance)
+          # expect(group_member.opened_at.blank?).to be_truthy
+          # Timecop.freeze(DateTime.now)
+          # test_instance.open!
+          # group_member = group_member.reload
+          # expect(group_member.opened_at.blank?).to be_falsey
+          # expect(group_member.opened_at).to        eq(DateTime.now)
+          # Timecop.return
+        # end
       end
 
       context "with an argument" do
@@ -396,10 +451,21 @@ shared_examples_for :notification_api do
           expect(test_instance.opened_at.blank?).to be_falsey
           expect(test_instance.opened_at).to        eq(datetime)
         end
+
+        #TODO
+        # it "open group member notifications with current time" do
+          # group_member = create(test_class_name, group_owner: test_instance)
+          # expect(group_member.opened_at.blank?).to be_truthy
+          # datetime = DateTime.now - 1.months
+          # test_instance.open!(datetime)
+          # group_member = group_member.reload
+          # expect(group_member.opened_at.blank?).to be_falsey
+          # expect(group_member.opened_at).to        eq(datetime)
+        # end
       end
     end
 
-    describe "unopened?" do
+    describe "#unopened?" do
       context "when opened_at is blank" do
         it "returns true" do
           expect(test_instance.unopened?).to be_truthy
@@ -414,7 +480,7 @@ shared_examples_for :notification_api do
       end
     end
       
-    describe "opened?" do
+    describe "#opened?" do
       context "when opened_at is blank" do
         it "returns false" do
           expect(test_instance.opened?).to be_falsey
@@ -429,7 +495,7 @@ shared_examples_for :notification_api do
       end
     end
 
-    describe "group_owner?" do
+    describe "#group_owner?" do
       context "when the notification is group owner" do
         it "returns true" do
           expect(test_instance.group_owner?).to be_truthy
@@ -444,7 +510,7 @@ shared_examples_for :notification_api do
       end
     end
 
-    describe "group_member?" do
+    describe "#group_member?" do
       context "when the notification is group owner" do
         it "returns false" do
           expect(test_instance.group_member?).to be_falsey
@@ -459,7 +525,7 @@ shared_examples_for :notification_api do
       end
     end
 
-    describe "group_member_exists?" do
+    describe "#group_member_exists?" do
       context "when the notification is group owner and has no group members" do
         it "returns false" do
           expect(test_instance.group_member_exists?).to be_falsey
@@ -481,46 +547,97 @@ shared_examples_for :notification_api do
       end
     end
 
-    describe "group_member_count" 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)
+    describe "#group_member_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)
+          end
         end
-      end
 
-      context "when the notification is group owner and has group members" do
-        it "returns member count" 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)
+        context "when the notification is group owner and has group members" do
+          it "returns member count" 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)
+          end
+        end
+
+        context "when the notification belongs to group" do
+          it "returns member count" 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)
+          end
         end
       end
 
-      context "when the notification belongs to group" do
-        it "returns member count" 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)
+      context "for opened notification" do
+        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_count).to eq(0)
+          end
+        end
+
+        context "as default" do
+          context "when the notification is group owner and has group members" do
+            it "returns member count" 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)
+              test_instance.open!
+              expect(test_instance.group_member_count).to eq(2)
+            end
+          end
+
+          context "when the notification belongs to group" do
+            it "returns member count" 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)
+              test_instance.open!
+              expect(group_member.group_member_count).to eq(2)
+            end
+          end
+        end
+
+        context "with limit" do
+          context "when the notification is group owner and has group members" do
+            it "returns member count by limit" 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)
+              test_instance.open!
+              expect(test_instance.group_member_count(0)).to eq(0)
+            end
+          end
+
+          context "when the notification belongs to group" do
+            it "returns member count by limit" 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)
+              test_instance.open!
+              expect(group_member.group_member_count(0)).to eq(0)
+            end
+          end
         end
       end
     end
 
-    describe "notifiale_path" do
+    describe "#notifiable_path" do
       it "returns notifiable.notifiable_path" do
-        expect(test_instance.notifiale_path).to eq(test_instance.notifiable.notifiable_path(test_instance.target_type))
+        expect(test_instance.notifiable_path).to eq(test_instance.notifiable.notifiable_path(test_instance.target_type))
       end
     end
   end
 
-  describe "with protected instance methods" do
-    describe "unopened_group_member_count" do
+  describe "as protected instance methods" do
+    describe "#unopened_group_member_count" do
       it "is defined as protected method" do
         expect(test_instance.respond_to?(:unopened_group_member_count)).to       be_falsey
         expect(test_instance.respond_to?(:unopened_group_member_count, true)).to be_truthy
       end
     end
 
-    describe "opened_group_member_count" do
+    describe "#opened_group_member_count" do
       it "is defined as protected method" do
         expect(test_instance.respond_to?(:opened_group_member_count)).to       be_falsey
         expect(test_instance.respond_to?(:opened_group_member_count, true)).to be_truthy
@@ -528,4 +645,11 @@ shared_examples_for :notification_api do
     end
   end
 
+  private
+    def validate_expected_notification(notification, target, notifiable)
+      expect(notification).to be_a described_class
+      expect(notification.target).to eq(target)
+      expect(notification.notifiable).to eq(notifiable)
+    end
+
 end