activity_notification 0.0.10 → 1.0.0

data/lib/activity_notification/models/notification.rb

@@ -5,7 +5,7 @@ module ActivityNotification
     include Common
     include NotificationApi
     self.table_name = ActivityNotification.config.table_name
-  
+
     # Belongs to target instance of this notification as polymorphic association.
     # @scope instance
     # @return [Object] Target instance of this notification
@@ -32,7 +32,7 @@ module ActivityNotification
     # Only group owner instance has :group_members value.
     # Group member instance has nil as :group_members association.
     # @scope instance
-    # @return [Array<Notificaion>] Array or database query of the group member notification instances of this notification
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of the group member notification instances of this notification
     has_many   :group_members, class_name: :Notification, foreign_key: :group_owner_id
 
     # Belongs to :otifier instance of this notification.
@@ -49,17 +49,17 @@ module ActivityNotification
 
     # Selects group owner notifications only.
     # @scope class
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :group_owners_only,                 ->        { where(group_owner_id: nil) }
 
     # Selects group member notifications only.
     # @scope class
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :group_members_only,                ->        { where.not(group_owner_id: nil) }
 
     # Selects unopened notifications only.
     # @scope class
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :unopened_only,                     ->        { where(opened_at: nil) }
 
     # Selects unopened notification index.
@@ -67,37 +67,37 @@ module ActivityNotification
     # @example Get unopened notificaton index of the @user
     #   @notifications = @user.unopened_index
     # @scope class
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :unopened_index,                    ->        { unopened_only.group_owners_only.latest_order }
 
     # Selects opened notifications only without limit.
     # Be careful to get too many records with this method.
     # @scope class
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :opened_only!,                      ->        { where.not(opened_at: nil) }
 
     # Selects opened notifications only with limit.
     # @scope class
     # @param [Integer] limit Limit to query for opened notifications
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :opened_only,                       ->(limit) { opened_only!.limit(limit) }
 
     # Selects unopened notification index.
     # Defined same as `opened_only(limit).group_owners_only.latest_order`.
     # @scope class
     # @param [Integer] limit Limit to query for opened notifications
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :opened_index,                      ->(limit) { opened_only(limit).group_owners_only.latest_order }
 
     # Selects group member notifications in unopened_index.
     # @scope class
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
-    scope :unopened_index_group_members_only, ->        { where(group_owner_id: unopened_index.pluck(:id)) }
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    scope :unopened_index_group_members_only, ->        { where(group_owner_id: unopened_index.map(&:id)) }
 
     # Selects group member notifications in opened_index.
     # @scope class
     # @param [Integer] limit Limit to query for opened notifications
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :opened_index_group_members_only,   ->(limit) { where(group_owner_id: opened_index(limit).map(&:id)) }
 
     # Selects filtered notifications by target instance.
@@ -106,7 +106,7 @@ module ActivityNotification
     #   @user.notifications
     # @scope class
     # @param [Object] target Target instance for filter
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :filtered_by_target,   ->(target)             { where(target: target) }
 
     # Selects filtered notifications by notifiable instance.
@@ -114,7 +114,7 @@ module ActivityNotification
     #   @notifications = @user.notifications.unopened_only.filtered_by_instance(@comment)
     # @scope class
     # @param [Object] notifiable Notifiable instance for filter
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :filtered_by_instance, ->(notifiable)         { where(notifiable: notifiable) }
 
     # Selects filtered notifications by notifiable_type.
@@ -122,7 +122,7 @@ module ActivityNotification
     #   @notifications = @user.notifications.unopened_only.filtered_by_type('Comment')
     # @scope class
     # @param [String] notifiable_type Notifiable type for filter
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :filtered_by_type,     ->(notifiable_type)    { where(notifiable_type: notifiable_type) }
 
     # Selects filtered notifications by group instance.
@@ -130,7 +130,7 @@ module ActivityNotification
     #   @notifications = @user.notifications.unopened_only.filtered_by_group(@article)
     # @scope class
     # @param [Object] group Group instance for filter
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :filtered_by_group,    ->(group)              { where(group: group) }
 
     # Selects filtered notifications by key.
@@ -138,7 +138,7 @@ module ActivityNotification
     #   @notifications = @user.notifications.unopened_only.filtered_by_key('comment.reply')
     # @scope class
     # @param [String] key Key of the notification for filter
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :filtered_by_key,      ->(key)                { where(key: key) }
 
     # Selects filtered notifications by notifiable_type, group or key with filter options.
@@ -159,9 +159,9 @@ module ActivityNotification
     # @option options [String] :filtered_by_group_type (nil) Group type for filter, valid with :filtered_by_group_id
     # @option options [String] :filtered_by_group_id   (nil) Group instance id for filter, valid with :filtered_by_group_type
     # @option options [String] :filtered_by_key        (nil) Key of the notification for filter 
-    # @return [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Array or database query of filtered notifications
     scope :filtered_by_options,  ->(options = {})       {
-      options = options.with_indifferent_access
+      options = ActivityNotification.cast_to_indifferent_hash(options)
       filtered_notifications = all
       if options.has_key?(:filtered_by_type)
         filtered_notifications = filtered_notifications.filtered_by_type(options[:filtered_by_type])
@@ -180,27 +180,27 @@ module ActivityNotification
     }
 
     # Includes target instance with query for notifications.
-    # @return [ActiveRecord_AssociationRelation] Database query of notifications with target
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Database query of notifications with target
     scope :with_target,                       ->        { includes(:target) }
 
     # Includes notifiable instance with query for notifications.
-    # @return [ActiveRecord_AssociationRelation] Database query of notifications with notifiable
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Database query of notifications with notifiable
     scope :with_notifiable,                   ->        { includes(:notifiable) }
 
     # Includes group instance with query for notifications.
-    # @return [ActiveRecord_AssociationRelation] Database query of notifications with group
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Database query of notifications with group
     scope :with_group,                        ->        { includes(:group) }
 
     # Includes notifier instance with query for notifications.
-    # @return [ActiveRecord_AssociationRelation] Database query of notifications with notifier
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Database query of notifications with notifier
     scope :with_notifier,                     ->        { includes(:notifier) }
 
     # Orders by latest (newest) first as created_at: :desc.
-    # @return [ActiveRecord_AssociationRelation] Database query of notifications ordered by latest first
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Database query of notifications ordered by latest first
     scope :latest_order,                      ->        { order(created_at: :desc) }
 
     # Orders by earliest (older) first as created_at: :asc.
-    # @return [ActiveRecord_AssociationRelation] Database query of notifications ordered by earliest first
+    # @return [ActiveRecord_AssociationRelation<Notificaion>] Database query of notifications ordered by earliest first
     scope :earliest_order,                    ->        { order(created_at: :asc) }
 
     # Returns latest notification instance.
@@ -210,5 +210,6 @@ module ActivityNotification
     # Returns earliest notification instance.
     # @return [Notification] Earliest notification instance
     scope :earliest,                          ->        { earliest_order.first }
+
   end
 end

data/lib/activity_notification/rails.rb

@@ -2,5 +2,6 @@ require 'activity_notification/rails/routes'
 
 module ActivityNotification #:nodoc:
   class Engine < ::Rails::Engine #:nodoc:
+    require 'jquery-rails'
   end
 end

data/lib/activity_notification/renderable.rb

@@ -21,7 +21,12 @@ module ActivityNotification
       k.push('text')
       k = k.join('.')
 
-      I18n.t(k, (parameters.merge(params) || {}).merge(group_member_count: group_member_count))
+      I18n.t(k, (parameters.merge(params) || {}).merge(
+        group_member_count:          group_member_count,
+        group_notification_count:    group_notification_count,
+        group_member_notifier_count: group_member_notifier_count,
+        group_notifier_count:        group_notifier_count
+      ))
     end
 
     # Renders notification from views.
@@ -134,7 +139,7 @@ module ActivityNotification
     # @option params [String]         :partial      (self.key.gsub('.', '/')) Root path of partial template
     # @option params [String]         :layout       (nil)                     Layout template name
     # @option params [String]         :layout_root  ('layouts')               Root path of layout template
-    # @option params [String]         :fallback     (nil)                     Fallback template to use when MissingTemplate is raised. Set :text to use i18n text as fallback.
+    # @option params [String, Symbol] :fallback     (nil)                     Fallback template to use when MissingTemplate is raised. Set :text to use i18n text as fallback.
     # @option params [Hash]           others                                  Parameters to be set as locals
     # @return [String] Rendered view or text as string
     def render(context, params = {})
@@ -207,7 +212,7 @@ module ActivityNotification
     # @param [Hash] params Parameters to prepare
     # @return [Hash] Prepared parameters
     def prepare_parameters(params)
-      @prepared_params ||= self.parameters.with_indifferent_access.merge(params)
+      @prepared_params ||= ActivityNotification.cast_to_indifferent_hash(parameters).merge(params)
     end
 
 

data/lib/activity_notification/roles/acts_as_common.rb

@@ -0,0 +1,28 @@
+module ActivityNotification
+  # Common module included in acts_as module.
+  # Provides methods to extract parameters.
+  module ActsAsCommon
+    extend ActiveSupport::Concern
+
+    class_methods do
+      protected
+        # Sets acts_as parameters.
+        # @api protected
+        def set_acts_as_parameters(option_list, options, field_prefix = "")
+          option_list.map { |key|
+            options[key] ?
+              [key, self.send("_#{field_prefix}#{key}=".to_sym, options.delete(key))] : [nil, nil]
+          }.to_h.delete_if { |k, _| k.nil? }
+        end
+  
+        # Sets acts_as parameters for target.
+        # @api protected
+        def set_acts_as_parameters_for_target(target_type, option_list, options, field_prefix = "")
+          option_list.map { |key|
+            options[key] ?
+              [key, self.send("_#{field_prefix}#{key}".to_sym).store(target_type.to_sym, options.delete(key))] : [nil, nil]
+          }.to_h.delete_if { |k, _| k.nil? }
+        end
+    end
+  end
+end

data/lib/activity_notification/roles/acts_as_group.rb

@@ -0,0 +1,38 @@
+module ActivityNotification
+  # Manages to add all required configurations to group models of notification.
+  module ActsAsGroup
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Adds required configurations to group models.
+      #
+      # == Parameters:
+      # * :printable_name or :printable_notification_group_name
+      #   * Printable notification group 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_group_name
+      # @example Define printable name with article title
+      #   # app/models/article.rb
+      #   class Article < ActiveRecord::Base
+      #     acts_as_notification_group printable_name: ->(article) { "article \"#{article.title}\"" }
+      #   end
+      #
+      # @param [Hash] options Options for notifier model configuration
+      # @option options [Symbol, Proc, String]  :printable_name  (ActivityNotification::Common.printable_name) Printable notifier target name
+      # @return [Hash] Configured parameters as notifier model
+      def acts_as_group(options = {})
+        include Group
+
+        options[:printable_notification_group_name] ||= options.delete(:printable_name)
+        set_acts_as_parameters([:printable_notification_group_name], options)
+      end
+      alias_method :acts_as_notification_group, :acts_as_group
+
+      # Returns array of available notification group options in acts_as_group.
+      # @return [Array<Symbol>] Array of available notification group options
+      def available_group_options
+        [:printable_notification_group_name, :printable_name].freeze
+      end
+    end
+  end
+end

data/lib/activity_notification/roles/acts_as_notifiable.rb

@@ -18,6 +18,7 @@ module ActivityNotification
       #     acts_as_notifiable :users, targets: User.all
       #   end
       # @example Notify to author and users commented to the article, except comment owner self
+      #   # app/models/comment.rb
       #   class Comment < ActiveRecord::Base
       #     belongs_to :article
       #     belongs_to :user
@@ -32,6 +33,7 @@ module ActivityNotification
       #     Notifications will be bundled by this group (and target, notifiable_type, key).
       #     This parameter is a optional.
       # @example All *unopened* notifications to the same target will be grouped by `article`
+      #   # app/models/comment.rb
       #   class Comment < ActiveRecord::Base
       #     belongs_to :article
       #     acts_as_notifiable :users, targets: User.all, group: :article
@@ -42,6 +44,7 @@ module ActivityNotification
       #     This will be stored as notifier with notification record.
       #     This parameter is a optional.
       # @example Set comment owner self as notifier
+      #   # app/models/comment.rb
       #   class Comment < ActiveRecord::Base
       #     belongs_to :article
       #     belongs_to :user
@@ -54,10 +57,12 @@ module ActivityNotification
       #     You can use these additional parameters in your notification view or i18n text.
       #     This parameter is a optional.
       # @example Set constant values as additional parameter
+      #   # app/models/comment.rb
       #   class Comment < ActiveRecord::Base
       #     acts_as_notifiable :users, targets: User.all, parameters: { default_param: '1' }
       #   end
       # @example Set comment body as additional parameter
+      #   # app/models/comment.rb
       #   class Comment < ActiveRecord::Base
       #     acts_as_notifiable :users, targets: User.all, parameters: ->(comment, key) { body: comment.body }
       #   end
@@ -69,6 +74,7 @@ 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 Enable email notification for this notifiable model
+      #   # app/models/comment.rb
       #   class Comment < ActiveRecord::Base
       #     acts_as_notifiable :users, targets: User.all, email_allowed: true
       #   end
@@ -78,6 +84,7 @@ module ActivityNotification
       #     You can also use this notifiable_path as notifiable link in notification view.
       #     This parameter is a optional since polymorphic_path is used as default value.
       # @example Redirect to parent article page from comment notifications
+      #   # app/models/comment.rb
       #   class Comment < ActiveRecord::Base
       #     belongs_to :article
       #     acts_as_notifiable :users, targets: User.all, notifiable_path: :article_notifiable_path
@@ -87,39 +94,66 @@ module ActivityNotification
       #     end
       #   end
       #
+      # * :printable_name or :printable_notifiable_name
+      #   * Printable notifiable name.
+      #     This parameter is a optional since `ActivityNotification::Common.printable_name` is used as default value.
+      #     :printable_name is the same option as :printable_notifiable_name
+      # @example Define printable name with comment body
+      #   # app/models/comment.rb
+      #   class Comment < ActiveRecord::Base
+      #     acts_as_notifiable :users, targets: User.all, printable_name: ->(comment) { "comment \"#{comment.body}\"" }
+      #   end
+      #
+      # * :dependent_notifications
+      #   * Dependency for notifications to delete generated notifications with this notifiable.
+      #     This option is used to configure generated_notifications_as_notifiable association.
+      #     You can use :delete_all, :destroy, or :nullify for this option.
+      #     This parameter is a optional since no dependent option is used as default.
+      # @example Define :delete_all dependency to generated notifications
+      #   # app/models/comment.rb
+      #   class Comment < ActiveRecord::Base
+      #     acts_as_notifiable :users, targets: User.all, dependent_notifications: :delete_all
+      #   end
+      #
       # @param [Symbol] target_type Type of notification target as symbol
       # @param [Hash] options Options for notifiable model configuration
-      # @option options [Symbol, Proc, Array]   :targets         (nil)                    Targets to send notifications
-      # @option options [Symbol, Proc, Object]  :group           (nil)                    Group unit of the notifications
-      # @option options [Symbol, Proc, Object]  :notifier        (nil)                    Notifier of the notifications
-      # @option options [Symbol, Proc, Hash]    :parameters      ({})                     Additional parameters of the notifications
-      # @option options [Symbol, Proc, Boolean] :email_allowed   (ActivityNotification.config.email_enabled) Whether activity_notification sends notification email
-      # @option options [Symbol, Proc, String]  :notifiable_path (polymorphic_path(self)) Path to redirect from open or move action of notification controller
+      # @option options [Symbol, Proc, Array]   :targets                 (nil)                    Targets to send notifications
+      # @option options [Symbol, Proc, Object]  :group                   (nil)                    Group unit of the notifications
+      # @option options [Symbol, Proc, Object]  :notifier                (nil)                    Notifier of the notifications
+      # @option options [Symbol, Proc, Hash]    :parameters              ({})                     Additional parameters of the notifications
+      # @option options [Symbol, Proc, Boolean] :email_allowed           (ActivityNotification.config.email_enabled) Whether activity_notification sends notification email
+      # @option options [Symbol, Proc, String]  :notifiable_path         (polymorphic_path(self)) Path to redirect from open or move action of notification controller
+      # @option options [Symbol, Proc, String]  :printable_name          (ActivityNotification::Common.printable_name) Printable notifiable name
+      # @option options [Symbol, Proc]          :dependent_notifications (nil)                    Dependency for notifications to delete generated notifications with this notifiable
       # @return [Hash] Configured parameters as notifiable model
       def acts_as_notifiable(target_type, options = {})
         include Notifiable
-        (
-          [:targets, :group, :parameters, :email_allowed].map { |key|
-            assign_parameter(target_type, key, "_notification_#{key}", options)
-          }.to_h.merge [:notifier, :notifiable_path].map { |key|
-            assign_parameter(target_type, key, "_#{key}", options)
-          }.to_h
-        ).delete_if { |k, _| k.nil? }
+
+        if [:delete_all, :destroy, :nullify].include? options[:dependent_notifications] 
+          has_many :generated_notifications_as_notifiable,
+            class_name: "::ActivityNotification::Notification",
+            as: :notifiable,
+            dependent: options[:dependent_notifications]
+        end
+
+        options[:printable_notifiable_name] ||= options.delete(:printable_name)
+        set_acts_as_parameters_for_target(target_type, [:targets, :group, :parameters, :email_allowed], options, "notification_")
+          .merge set_acts_as_parameters_for_target(target_type, [:notifier, :notifiable_path, :printable_notifiable_name], options)
       end
 
       # Returns array of available notifiable options in acts_as_notifiable.
       # @return [Array<Symbol>] Array of available notifiable options
       def available_notifiable_options
-        [:targets, :group, :notifier, :parameters, :email_allowed, :notifiable_path].freeze
+        [ :targets,
+          :group,
+          :notifier,
+          :parameters,
+          :email_allowed,
+          :notifiable_path,
+          :printable_notifiable_name, :printable_name,
+          :dependent_notifications
+        ].freeze
       end
-
-      private
-
-        def assign_parameter(target_type, key, field_name, options)
-          options[key] ?
-            [key, self.send(field_name.to_sym).store(target_type.to_sym, options.delete(key))] :
-            [nil, nil]
-        end
     end
   end
 end

data/lib/activity_notification/roles/acts_as_notifier.rb

@@ -5,9 +5,32 @@ module ActivityNotification
 
     class_methods do
       # Adds required configurations to notifier models.
-      # @return [nil] nil
-      def acts_as_notifier
+      #
+      # == Parameters:
+      # * :printable_name or :printable_notifier_name
+      #   * Printable notifier name.
+      #     This parameter is a optional since `ActivityNotification::Common.printable_name` is used as default value.
+      #     :printable_name is the same option as :printable_notifier_name
+      # @example Define printable name with user name of name field
+      #   # app/models/user.rb
+      #   class User < ActiveRecord::Base
+      #     acts_as_notifier printable_name: :name
+      #   end
+      #
+      # @param [Hash] options Options for notifier model configuration
+      # @option options [Symbol, Proc, String]  :printable_name  (ActivityNotification::Common.printable_name) Printable notifier target name
+      # @return [Hash] Configured parameters as notifier model
+      def acts_as_notifier(options = {})
         include Notifier
+
+        options[:printable_notifier_name] ||= options.delete(:printable_name)
+        set_acts_as_parameters([:printable_notifier_name], options)
+      end
+
+      # Returns array of available notifier options in acts_as_notifier.
+      # @return [Array<Symbol>] Array of available notifier options
+      def available_notifier_options
+        [:printable_notifier_name, :printable_name].freeze
       end
     end
   end