activity_notification 2.5.1 → 2.6.0

data/lib/activity_notification/orm/dynamoid.rb

@@ -117,7 +117,7 @@ class ActiveModel::NullMutationTracker
   def force_change(attr_name); end if Rails::VERSION::MAJOR >= 6
 end
 
-# Entend Dynamoid to support ActivityNotification scope in Dynamoid::Criteria::Chain
+# Extend Dynamoid to support ActivityNotification scope in Dynamoid::Criteria::Chain
 # @private
 module Dynamoid # :nodoc: all
   # https://github.com/Dynamoid/dynamoid/blob/master/lib/dynamoid/criteria.rb
@@ -147,7 +147,7 @@ module Dynamoid # :nodoc: all
       # is defined same as
       #   ActivityNotification::Notification.unopened_only.group_owners_only.latest_order
       # @scope class
-      # @example Get unopened notificaton index of the @user
+      # @example Get unopened notification index of the @user
       #   @notifications = @user.notifications.unopened_index
       #   @notifications = @user.notifications.unopened_only.group_owners_only.latest_order
       # @param [Boolean] reverse If notification index will be ordered as earliest first
@@ -163,7 +163,7 @@ module Dynamoid # :nodoc: all
       # is defined same as
       #   ActivityNotification::Notification.opened_only(limit).group_owners_only.latest_order
       # @scope class
-      # @example Get unopened notificaton index of the @user with limit 10
+      # @example Get unopened notification index of the @user with limit 10
       #   @notifications = @user.notifications.opened_index(10)
       #   @notifications = @user.notifications.opened_only(10).group_owners_only.latest_order
       # @param [Integer] limit Limit to query for opened notifications
@@ -217,7 +217,7 @@ module Dynamoid # :nodoc: all
       end
 
       # Selects filtered notifications by notifiable instance.
-      # @example Get filtered unopened notificatons of the @user for @comment as notifiable
+      # @example Get filtered unopened notifications of the @user for @comment as notifiable
       #   @notifications = @user.notifications.unopened_only.filtered_by_instance(@comment)
       # @scope class
       # @param [Object] notifiable Notifiable instance for filter
@@ -227,7 +227,7 @@ module Dynamoid # :nodoc: all
       end
 
       # Selects filtered notifications by group instance.
-      # @example Get filtered unopened notificatons of the @user for @article as group
+      # @example Get filtered unopened notifications of the @user for @article as group
       #   @notifications = @user.notifications.unopened_only.filtered_by_group(@article)
       # @scope class
       # @param [Object] group Group instance for filter
@@ -237,7 +237,7 @@ module Dynamoid # :nodoc: all
       end
 
       # Selects filtered notifications or subscriptions by target_type.
-      # @example Get filtered unopened notificatons of User as target type
+      # @example Get filtered unopened notifications of User as target type
       #   @notifications = ActivityNotification.Notification.unopened_only.filtered_by_target_type('User')
       # @scope class
       # @param [String] target_type Target type for filter
@@ -247,7 +247,7 @@ module Dynamoid # :nodoc: all
       end
 
       # Selects filtered notifications by notifiable_type.
-      # @example Get filtered unopened notificatons of the @user for Comment notifiable class
+      # @example Get filtered unopened notifications of the @user for Comment notifiable class
       #   @notifications = @user.notifications.unopened_only.filtered_by_type('Comment')
       # @scope class
       # @param [String] notifiable_type Notifiable type for filter
@@ -257,7 +257,7 @@ module Dynamoid # :nodoc: all
       end
 
       # Selects filtered notifications or subscriptions by key.
-      # @example Get filtered unopened notificatons of the @user with key 'comment.reply'
+      # @example Get filtered unopened notifications of the @user with key 'comment.reply'
       #   @notifications = @user.notifications.unopened_only.filtered_by_key('comment.reply')
       # @scope class
       # @param [String] key Key of the notification for filter
@@ -267,37 +267,37 @@ module Dynamoid # :nodoc: all
       end
 
       # Selects filtered notifications later than specified time.
-      # @example Get filtered unopened notificatons of the @user later than @notification
+      # @example Get filtered unopened notifications of the @user later than @notification
       #   @notifications = @user.notifications.unopened_only.later_than(@notification.created_at)
       # @scope class
       # @param [Time] Created time of the notifications for filter
-      # @return [ActiveRecord_AssociationRelation<Notificaion>, Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+      # @return [ActiveRecord_AssociationRelation<Notification>, Mongoid::Criteria<Notification>] Database query of filtered notifications
       def later_than(created_time)
         where('created_at.gt': created_time)
       end
 
       # Selects filtered notifications earlier than specified time.
-      # @example Get filtered unopened notificatons of the @user earlier than @notification
+      # @example Get filtered unopened notifications of the @user earlier than @notification
       #   @notifications = @user.notifications.unopened_only.earlier_than(@notification.created_at)
       # @scope class
       # @param [Time] Created time of the notifications for filter
-      # @return [ActiveRecord_AssociationRelation<Notificaion>, Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+      # @return [ActiveRecord_AssociationRelation<Notification>, Mongoid::Criteria<Notification>] Database query of filtered notifications
       def earlier_than(created_time)
         where('created_at.lt': created_time)
       end
 
       # Selects filtered notifications or subscriptions by notifiable_type, group or key with filter options.
-      # @example Get filtered unopened notificatons of the @user for Comment notifiable class
+      # @example Get filtered unopened notifications of the @user for Comment notifiable class
       #   @notifications = @user.notifications.unopened_only.filtered_by_options({ filtered_by_type: 'Comment' })
-      # @example Get filtered unopened notificatons of the @user for @article as group
+      # @example Get filtered unopened notifications of the @user for @article as group
       #   @notifications = @user.notifications.unopened_only.filtered_by_options({ filtered_by_group: @article })
-      # @example Get filtered unopened notificatons of the @user for Article instance id=1 as group
+      # @example Get filtered unopened notifications of the @user for Article instance id=1 as group
       #   @notifications = @user.notifications.unopened_only.filtered_by_options({ filtered_by_group_type: 'Article', filtered_by_group_id: '1' })
-      # @example Get filtered unopened notificatons of the @user with key 'comment.reply'
+      # @example Get filtered unopened notifications of the @user with key 'comment.reply'
       #   @notifications = @user.notifications.unopened_only.filtered_by_options({ filtered_by_key: 'comment.reply' })
-      # @example Get filtered unopened notificatons of the @user for Comment notifiable class with key 'comment.reply'
+      # @example Get filtered unopened notifications of the @user for Comment notifiable class with key 'comment.reply'
       #   @notifications = @user.notifications.unopened_only.filtered_by_options({ filtered_by_type: 'Comment', filtered_by_key: 'comment.reply' })
-      # @example Get custom filtered notificatons of the @user
+      # @example Get custom filtered notifications of the @user
       #   @notifications = @user.notifications.unopened_only.filtered_by_options({ custom_filter: ["created_at >= ?", time.hour.ago] })
       # @scope class
       # @param [Hash] options Options for filter

data/lib/activity_notification/orm/mongoid/notification.rb

@@ -47,7 +47,7 @@ module ActivityNotification
         # Only group owner instance has :group_members value.
         # Group member instance has nil as :group_members association.
         # @scope instance
-        # @return [Mongoid::Criteria<Notificaion>] Database query of the group member notification instances of this notification
+        # @return [Mongoid::Criteria<Notification>] Database query of the group member notification instances of this notification
         has_many   :group_members, class_name: "ActivityNotification::Notification", foreign_key: :group_owner_id
 
         # Belongs to :otifier instance of this notification.
@@ -66,52 +66,52 @@ module ActivityNotification
 
         # Selects group owner notifications only.
         # @scope class
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :group_owners_only,                 -> { where(:group_owner_id.exists => false) }
 
         # Selects group member notifications only.
         # @scope class
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :group_members_only,                -> { where(:group_owner_id.exists => true) }
 
         # Selects unopened notifications only.
         # @scope class
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :unopened_only,                     -> { where(:opened_at.exists => false) }
 
         # Selects opened notifications only without limit.
         # Be careful to get too many records with this method.
         # @scope class
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :opened_only!,                      -> { where(:opened_at.exists => true) }
 
         # Selects opened notifications only with limit.
         # @scope class
         # @param [Integer] limit Limit to query for opened notifications
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :opened_only,                       ->(limit) { limit == 0 ? none : opened_only!.limit(limit) }
 
         # Selects group member notifications in unopened_index.
         # @scope class
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :unopened_index_group_members_only, -> { where(:group_owner_id.in => unopened_index.map(&:id)) }
 
         # Selects group member notifications in opened_index.
         # @scope class
         # @param [Integer] limit Limit to query for opened notifications
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :opened_index_group_members_only,   ->(limit) { where(:group_owner_id.in => opened_index(limit).map(&:id)) }
 
         # Selects notifications within expiration.
         # @scope class
         # @param [ActiveSupport::Duration] expiry_delay Expiry period of notifications
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :within_expiration_only,            ->(expiry_delay) { where(:created_at.gt => expiry_delay.ago) }
 
         # Selects group member notifications with specified group owner ids.
         # @scope class
         # @param [Array<String>] owner_ids Array of group owner ids
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :group_members_of_owner_ids_only,   ->(owner_ids) { where(:group_owner_id.in => owner_ids) }
 
         # Selects filtered notifications by target instance.
@@ -120,69 +120,67 @@ module ActivityNotification
         #   @user.notifications
         # @scope class
         # @param [Object] target Target instance for filter
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :filtered_by_target,                ->(target) { filtered_by_association("target", target) }
 
         # Selects filtered notifications by notifiable instance.
-        # @example Get filtered unopened notificatons of the @user for @comment as notifiable
+        # @example Get filtered unopened notifications of the @user for @comment as notifiable
         #   @notifications = @user.notifications.unopened_only.filtered_by_instance(@comment)
         # @scope class
         # @param [Object] notifiable Notifiable instance for filter
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :filtered_by_instance,              ->(notifiable) { filtered_by_association("notifiable", notifiable) }
 
         # Selects filtered notifications by group instance.
-        # @example Get filtered unopened notificatons of the @user for @article as group
+        # @example Get filtered unopened notifications of the @user for @article as group
         #   @notifications = @user.notifications.unopened_only.filtered_by_group(@article)
         # @scope class
         # @param [Object] group Group instance for filter
-        # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :filtered_by_group,                 ->(group) {
           group.present? ?
             where(group_id: group.id, group_type: group.class.name) :
-            Gem::Version.new(::Mongoid::VERSION) >= Gem::Version.new('7.1.0') ?
-              where(:group_id.exists => false, :group_type.exists => false).or(group_id: nil, group_type: nil) :
-              any_of({ :group_id.exists => false, :group_type.exists => false }, { group_id: nil, group_type: nil })
+            Gem::Version.new(::Mongoid::VERSION) >= Gem::Version.new('7.1.0') ? where(:group_id.exists => false, :group_type.exists => false).or(group_id: nil, group_type: nil) : any_of({ :group_id.exists => false, :group_type.exists => false }, { group_id: nil, group_type: nil })
         }
 
         # Selects filtered notifications later than specified time.
-        # @example Get filtered unopened notificatons of the @user later than @notification
+        # @example Get filtered unopened notifications of the @user later than @notification
         #   @notifications = @user.notifications.unopened_only.later_than(@notification.created_at)
         # @scope class
         # @param [Time] Created time of the notifications for filter
-        # @return [ActiveRecord_AssociationRelation<Notificaion>, Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [ActiveRecord_AssociationRelation<Notification>, Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :later_than,                        ->(created_time) { where(:created_at.gt => created_time) }
 
         # Selects filtered notifications earlier than specified time.
-        # @example Get filtered unopened notificatons of the @user earlier than @notification
+        # @example Get filtered unopened notifications of the @user earlier than @notification
         #   @notifications = @user.notifications.unopened_only.earlier_than(@notification.created_at)
         # @scope class
         # @param [Time] Created time of the notifications for filter
-        # @return [ActiveRecord_AssociationRelation<Notificaion>, Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+        # @return [ActiveRecord_AssociationRelation<Notification>, Mongoid::Criteria<Notification>] Database query of filtered notifications
         scope :earlier_than,                      ->(created_time) { where(:created_at.lt => created_time) }
 
         # Includes target instance with query for notifications.
-        # @return [Mongoid::Criteria<Notificaion>] Database query of notifications with target
+        # @return [Mongoid::Criteria<Notification>] Database query of notifications with target
         scope :with_target,                       -> { }
 
         # Includes notifiable instance with query for notifications.
-        # @return [Mongoid::Criteria<Notificaion>] Database query of notifications with notifiable
+        # @return [Mongoid::Criteria<Notification>] Database query of notifications with notifiable
         scope :with_notifiable,                   -> { }
 
         # Includes group instance with query for notifications.
-        # @return [Mongoid::Criteria<Notificaion>] Database query of notifications with group
+        # @return [Mongoid::Criteria<Notification>] Database query of notifications with group
         scope :with_group,                        -> { }
 
         # Includes group owner instances with query for notifications.
-        # @return [Mongoid::Criteria<Notificaion>] Database query of notifications with group owner
+        # @return [Mongoid::Criteria<Notification>] Database query of notifications with group owner
         scope :with_group_owner,                  -> { }
 
         # Includes group member instances with query for notifications.
-        # @return [Mongoid::Criteria<Notificaion>] Database query of notifications with group members
+        # @return [Mongoid::Criteria<Notification>] Database query of notifications with group members
         scope :with_group_members,                -> { }
 
         # Includes notifier instance with query for notifications.
-        # @return [Mongoid::Criteria<Notificaion>] Database query of notifications with notifier
+        # @return [Mongoid::Criteria<Notification>] Database query of notifications with notifier
         scope :with_notifier,                     -> { }
 
         # Dummy reload method for test of notifications.

data/lib/activity_notification/orm/mongoid/subscription.rb

@@ -18,6 +18,13 @@ module ActivityNotification
         # @return [Object] Target instance of this subscription
         belongs_to_polymorphic_xdb_record :target
 
+        # Belongs to notifiable instance of this subscription as polymorphic association (optional).
+        # When present, this subscription is scoped to a specific notifiable instance.
+        # When nil, this is a key-level subscription that applies globally.
+        # @scope instance
+        # @return [Object, nil] Notifiable instance of this subscription
+        belongs_to_polymorphic_xdb_record :notifiable, optional: true
+
         field :key,                       type: String
         field :subscribing,               type: Boolean, default: ActivityNotification.config.subscribe_as_default
         field :subscribing_to_email,      type: Boolean, default: ActivityNotification.config.subscribe_to_email_as_default
@@ -28,7 +35,7 @@ module ActivityNotification
         field :optional_targets,          type: Hash,    default: {}
 
         validates  :target,               presence: true
-        validates  :key,                  presence: true, uniqueness: { scope: [:target_type, :target_id] }
+        validates  :key,                  presence: true, uniqueness: { scope: [:target_type, :target_id, :notifiable_type, :notifiable_id] }
         validates_inclusion_of :subscribing,          in: [true, false]
         validates_inclusion_of :subscribing_to_email, in: [true, false]
         validate   :subscribing_to_email_cannot_be_true_when_subscribing_is_false
@@ -59,6 +66,19 @@ module ActivityNotification
         # Dummy reload method for test of subscriptions.
         scope :reload,                    -> { }
 
+        # Selects key-level subscriptions only (where notifiable is nil).
+        # @return [Mongoid::Criteria<Subscription>] Database query of key-level subscriptions
+        scope :key_level_only,            -> { where(notifiable_type: nil) }
+
+        # Selects instance-level subscriptions only (where notifiable is present).
+        # @return [Mongoid::Criteria<Subscription>] Database query of instance-level subscriptions
+        scope :instance_level_only,       -> { where(:notifiable_type.ne => nil) }
+
+        # Selects subscriptions for a specific notifiable instance.
+        # @param [Object] notifiable Notifiable instance for filter
+        # @return [Mongoid::Criteria<Subscription>] Database query of filtered subscriptions
+        scope :for_notifiable,            ->(notifiable) { where(notifiable_type: notifiable.class.name, notifiable_id: notifiable.id) }
+
         # Selects unique keys from query for subscriptions.
         # @return [Array<String>] Array of subscription unique keys
         def self.uniq_keys

data/lib/activity_notification/orm/mongoid.rb

@@ -7,7 +7,7 @@ module ActivityNotification
       # @scope class
       # @param [String] name     Association name
       # @param [Object] instance Associated instance
-      # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
+      # @return [Mongoid::Criteria<Notification>] Database query of filtered notifications
       scope :filtered_by_association, ->(name, instance) { where("#{name}_id" => instance.present? ? instance.id : nil, "#{name}_type" => instance.present? ? instance.class.name : nil) }
     end
 

data/lib/activity_notification/rails/routes.rb

@@ -45,10 +45,10 @@ module ActionDispatch::Routing
     #     open_myscope_user_notification      PUT    /myscope/users/:user_id/notifications/:id/open(.:format)
     #       { controller:"activity_notification/notifications", action:"open", target_type:"users", routing_scope: :myscope }
     #
-    # When you use devise authentication and you want make notification targets assciated with devise,
+    # When you use devise authentication and you want to make notification targets associated with devise,
     # you can create as follows in your routes:
     #   notify_to :users, with_devise: :users
-    # This with_devise option creates the needed routes assciated with devise authentication:
+    # This with_devise option creates the needed routes associated with devise authentication:
     #   # Notification with devise routes
     #     user_notifications          GET    /users/:user_id/notifications(.:format)
     #       { controller:"activity_notification/notifications_with_devise", action:"index", target_type:"users", devise_type:"users" }
@@ -65,7 +65,7 @@ module ActionDispatch::Routing
     #
     # When you use with_devise option and you want to make simple default routes as follows, you can use devise_default_routes option:
     #   notify_to :users, with_devise: :users, devise_default_routes: true
-    # These with_devise and devise_default_routes options create the needed routes assciated with authenticated devise resource as the default target
+    # These with_devise and devise_default_routes options create the needed routes associated with authenticated devise resource as the default target
     #   # Notification with default devise routes
     #     user_notifications          GET    /notifications(.:format)
     #       { controller:"activity_notification/notifications_with_devise", action:"index", target_type:"users", devise_type:"users" }
@@ -135,7 +135,7 @@ module ActionDispatch::Routing
     #   @param          [Symbol]       resources Resources to notify
     #   @option options [String]       :routing_scope         (nil)            Routing scope for notification routes
     #   @option options [Symbol]       :with_devise           (false)          Devise resources name for devise integration. Devise integration will be enabled by this option.
-    #   @option options [Boolean]      :devise_default_routes (false)          Whether you will create routes as device default routes assciated with authenticated devise resource as the default target
+    #   @option options [Boolean]      :devise_default_routes (false)          Whether you will create routes as device default routes associated with authenticated devise resource as the default target
     #   @option options [Boolean]      :api_mode              (false)          Whether you will use activity_notification controllers as REST API mode
     #   @option options [Hash|Boolean] :with_subscription     (false)          Subscription path options to define subscription management paths with notification paths. Calls subscribed_by routing when truthy value is passed as this option.
     #   @option options [String]       :model                 (:notifications) Model name of notifications
@@ -168,7 +168,7 @@ module ActionDispatch::Routing
 
     # Includes subscribed_by method for routes, which is responsible to generate all necessary routes for subscriptions of activity_notification.
     #
-    # When you have an User model configured as a target (e.g. defined acts_as_target),
+    # When you have a User model configured as a target (e.g. defined acts_as_target),
     # you can create as follows in your routes:
     #   subscribed_by :users
     # This method creates the needed routes:
@@ -225,10 +225,10 @@ module ActionDispatch::Routing
     #     unsubscribe_to_optional_target_myscope_user_subscription  PUT    /myscope/users/:user_id/subscriptions/:id/unsubscribe_to_optional_target(.:format)
     #       { controller:"activity_notification/subscriptions", action:"unsubscribe_to_optional_target", target_type:"users", routing_scope: :myscope }
     #
-    # When you use devise authentication and you want make subscription targets assciated with devise,
+    # When you use devise authentication and you want to make subscription targets associated with devise,
     # you can create as follows in your routes:
     #   subscribed_by :users, with_devise: :users
-    # This with_devise option creates the needed routes assciated with devise authentication:
+    # This with_devise option creates the needed routes associated with devise authentication:
     #   # Subscription with devise routes
     #     user_subscriptions                                GET    /users/:user_id/subscriptions(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"index", target_type:"users", devise_type:"users" }
@@ -255,7 +255,7 @@ module ActionDispatch::Routing
     #
     # When you use with_devise option and you want to make simple default routes as follows, you can use devise_default_routes option:
     #   subscribed_by :users, with_devise: :users, devise_default_routes: true
-    # These with_devise and devise_default_routes options create the needed routes assciated with authenticated devise resource as the default target
+    # These with_devise and devise_default_routes options create the needed routes associated with authenticated devise resource as the default target
     #   # Subscription with devise routes
     #     user_subscriptions                                GET    /subscriptions(.:format)
     #       { controller:"activity_notification/subscriptions_with_devise", action:"index", target_type:"users", devise_type:"users" }
@@ -331,7 +331,7 @@ module ActionDispatch::Routing
     #   @param          [Symbol]       resources Resources to notify
     #   @option options [String]       :routing_scope         (nil)            Routing scope for subscription routes
     #   @option options [Symbol]       :with_devise           (false)          Devise resources name for devise integration. Devise integration will be enabled by this option.
-    #   @option options [Boolean]      :devise_default_routes (false)          Whether you will create routes as device default routes assciated with authenticated devise resource as the default target
+    #   @option options [Boolean]      :devise_default_routes (false)          Whether you will create routes as device default routes associated with authenticated devise resource as the default target
     #   @option options [Boolean]      :api_mode              (false)          Whether you will use activity_notification controllers as REST API mode
     #   @option options [String]       :model                 (:subscriptions) Model name of subscriptions
     #   @option options [String]       :controller            ("activity_notification/subscriptions" | activity_notification/subscriptions_with_devise") :controller option as resources routing
@@ -411,7 +411,7 @@ module ActionDispatch::Routing
       # @param [Hash] options Passed options from notify_to
       # @param [Hash] resources_options Options to send resources method
       def create_notification_routes(options = {}, resources_options = [])
-        self.resources options[:model], resources_options do
+        self.resources options[:model], **resources_options do
           collection do
             post :open_all unless ignore_path?(:open_all, options)
             post :destroy_all unless ignore_path?(:destroy_all, options)
@@ -430,7 +430,7 @@ module ActionDispatch::Routing
       # @param [Hash] options Passed options from subscribed_by
       # @param [Hash] resources_options Options to send resources method
       def create_subscription_routes(options = {}, resources_options = [])
-        self.resources options[:model], resources_options do
+        self.resources options[:model], **resources_options do
           collection do
             get :find                           unless ignore_path?(:find, options)
             get :optional_target_names          if options[:api_mode] && !ignore_path?(:optional_target_names, options)

data/lib/activity_notification/roles/acts_as_group.rb

@@ -9,7 +9,7 @@ module ActivityNotification
       # == 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.
+      #     This parameter is 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

data/lib/activity_notification/roles/acts_as_notifiable.rb

@@ -14,8 +14,8 @@ module ActivityNotification
       # == Parameters:
       # * :targets
       #   * Targets to send notifications.
-      #     It it set as ActiveRecord records or array of models.
-      #     This is a only necessary option.
+      #     It is set as ActiveRecord records or array of models.
+      #     This is the only necessary option.
       #     If you do not specify this option, you have to override notification_targets
       #     or notification_[plural target type] (e.g. notification_users) method.
       # @example Notify to all users
@@ -189,10 +189,10 @@ module ActivityNotification
       #   end
       #
       # * :optional_targets
-      #   * Optional targets to integrate external notification serveces like Amazon SNS or Slack.
+      #   * Optional targets to integrate external notification services like Amazon SNS or Slack.
       #     You can use hash of optional target implementation class as key and initializing parameters as value for this parameter.
       #     When the hash parameter is passed, acts_as_notifiable will create new instance of optional target class and call initialize_target method with initializing parameters, then configure them as optional_targets for this notifiable and target.
-      #     You can also use symbol of method name or lambda function which returns array of initialized optional target intstances.
+      #     You can also use symbol of method name or lambda function which returns array of initialized optional target instances.
       #     All optional target class must extends ActivityNotification::OptionalTarget::Base.
       #     This parameter is completely optional.
       # @example Define to integrate with Amazon SNS, Slack and your custom ConsoleOutput targets
@@ -203,7 +203,7 @@ module ActivityNotification
       #     require 'custom_optional_targets/console_output'
       #     acts_as_notifiable :admins, targets: Admin.all,
       #       optional_targets: {
-      #         ActivityNotification::OptionalTarget::AmazonSNS => { topic_arn: '<Topin ARN of yours>' },
+      #         ActivityNotification::OptionalTarget::AmazonSNS => { topic_arn: '<Topic ARN of yours>' },
       #         ActivityNotification::OptionalTarget::Slack  => {
       #           webhook_url: '<Slack Webhook URL>',
       #           slack_name: :slack_name, channel: 'activity_notification', username: 'ActivityNotification', icon_emoji: ":ghost:"

data/lib/activity_notification/roles/acts_as_notifier.rb

@@ -9,7 +9,7 @@ module ActivityNotification
       # == 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.
+      #     This parameter is 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

data/lib/activity_notification/roles/acts_as_target.rb

@@ -9,7 +9,7 @@ module ActivityNotification
       # == Parameters:
       # * :email
       #   * Email address to send notification email.
-      #     This is a necessary option when you enables email notification.
+      #     This is a necessary option when you enable email notification.
       # @example Simply use :email field
       #   # app/models/user.rb
       #   class User < ActiveRecord::Base

data/lib/activity_notification/version.rb

@@ -1,3 +1,3 @@
 module ActivityNotification
-  VERSION = "2.5.1"
+  VERSION = "2.6.0"
 end

data/lib/generators/activity_notification/add_notifiable_to_subscriptions/add_notifiable_to_subscriptions_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators/active_record'
+
+module ActivityNotification
+  module Generators
+    # Migration generator to add notifiable columns to subscriptions table
+    # for instance-level subscription support.
+    # @example Run migration generator
+    #   rails generate activity_notification:add_notifiable_to_subscriptions
+    class AddNotifiableToSubscriptionsGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      argument :name, type: :string, default: 'AddNotifiableToSubscriptions',
+        desc: "The migration name"
+
+      # Create migration file in application directory
+      def create_migration_file
+        @migration_name = name
+        migration_template 'add_notifiable_to_subscriptions.rb',
+                           "db/migrate/#{name.underscore}.rb"
+      end
+    end
+  end
+end

data/lib/generators/activity_notification/add_notifiable_to_subscriptions/templates/add_notifiable_to_subscriptions.rb

@@ -0,0 +1,13 @@
+# Migration to add notifiable polymorphic columns to subscriptions table
+# for instance-level subscription support.
+class <%= @migration_name %> < ActiveRecord::Migration<%= "[#{Rails.version.to_f}]" %>
+  def change
+    add_reference :subscriptions, :notifiable, polymorphic: true, index: true
+
+    # Replace the old unique index with one that includes notifiable columns
+    remove_index :subscriptions, [:target_type, :target_id, :key]
+    add_index :subscriptions, [:target_type, :target_id, :key, :notifiable_type, :notifiable_id],
+              unique: true, name: 'index_subscriptions_uniqueness',
+              length: { target_type: 191, key: 191, notifiable_type: 191 }
+  end
+end

data/lib/generators/templates/activity_notification.rb

@@ -38,7 +38,7 @@ ActivityNotification.configure do |config|
 
   # Configure default optional target subscription value to use when the subscription record does not configured.
   # Note that you can configure them for each method calling as default argument.
-  # Set false when you want to unsubscribe to optinal target notifications as default.
+  # Set false when you want to unsubscribe to optional target notifications as default.
   # config.subscribe_to_optional_targets_as_default = true
 
   # Configure the e-mail address which will be shown in ActivityNotification::Mailer,
@@ -53,6 +53,18 @@ ActivityNotification.configure do |config|
   # config.mailer_cc = ['admin@example.com', 'support@example.com']
   # config.mailer_cc = ->(key){ key.include?('urgent') ? 'urgent@example.com' : nil }
 
+  # Configure default attachment(s) for notification emails.
+  # Attachments are specified as Hash with :filename and :content (binary) or :path (file path).
+  # Optional :mime_type is inferred from filename if not provided.
+  # Can be overridden per target by defining a mailer_attachments method in the target model,
+  # or per notification by defining overriding_notification_email_attachments in the notifiable model.
+  # config.mailer_attachments = { filename: 'terms.pdf', path: Rails.root.join('public', 'terms.pdf') }
+  # config.mailer_attachments = [
+  #   { filename: 'logo.png', path: Rails.root.join('app/assets/images/logo.png') },
+  #   { filename: 'terms.pdf', content: File.read(Rails.root.join('public', 'terms.pdf')) }
+  # ]
+  # config.mailer_attachments = ->(key) { key.include?('invoice') ? { filename: 'invoice.pdf', content: generate_pdf } : nil }
+
   # Configure the class responsible to send e-mails.
   # config.mailer = "ActivityNotification::Mailer"
 
@@ -80,7 +92,7 @@ ActivityNotification.configure do |config|
   # Configure delimiter of composite key for DynamoDB.
   # config.composite_key_delimiter = '#'
 
-  # Configure if activity_notification stores notificaion records including associated records like target and notifiable..
+  # Configure if activity_notification stores notification records including associated records like target and notifiable..
   # This store_with_associated_records option can be set true only when you use mongoid or dynamoid ORM.
   config.store_with_associated_records = false
 

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

@@ -28,6 +28,7 @@ class <%= @migration_name %> < ActiveRecord::Migration<%= "[#{Rails.version.to_f
 
     <% if @migration_tables.include?('subscriptions') %>create_table :subscriptions do |t|
       t.belongs_to :target,     polymorphic: true, index: true, null: false
+      t.belongs_to :notifiable, polymorphic: true, index: true
       t.string     :key,                           index: true, null: false
       t.boolean    :subscribing,                                null: false, default: true
       t.boolean    :subscribing_to_email,                       null: false, default: true
@@ -39,8 +40,9 @@ class <%= @migration_name %> < ActiveRecord::Migration<%= "[#{Rails.version.to_f
 
       t.timestamps null: false
     end
-    add_index :subscriptions, [:target_type, :target_id, :key], unique: true<% else %># create_table :subscriptions do |t|
+    add_index :subscriptions, [:target_type, :target_id, :key, :notifiable_type, :notifiable_id], unique: true, name: 'index_subscriptions_uniqueness', length: { target_type: 191, key: 191, notifiable_type: 191 }<% else %># create_table :subscriptions do |t|
     #   t.belongs_to :target,     polymorphic: true, index: true, null: false
+    #   t.belongs_to :notifiable, polymorphic: true, index: true
     #   t.string     :key,                           index: true, null: false
     #   t.boolean    :subscribing,                                null: false, default: true
     #   t.boolean    :subscribing_to_email,                       null: false, default: true
@@ -52,6 +54,6 @@ class <%= @migration_name %> < ActiveRecord::Migration<%= "[#{Rails.version.to_f
     #
     #   t.timestamps null: false
     # end
-    # add_index :subscriptions, [:target_type, :target_id, :key], unique: true<% end %>
+    # add_index :subscriptions, [:target_type, :target_id, :key, :notifiable_type, :notifiable_id], unique: true, name: 'index_subscriptions_uniqueness', length: { target_type: 191, key: 191, notifiable_type: 191 }<% end %>
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activity_notification
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Shota Yamazaki
@@ -371,6 +371,7 @@ files:
 - docs/Functions.md
 - docs/Setup.md
 - docs/Testing.md
+- docs/Upgrade-to-2.6.md
 - lib/activity_notification.rb
 - lib/activity_notification/apis/cascading_notification_api.rb
 - lib/activity_notification/apis/notification_api.rb
@@ -428,6 +429,8 @@ files:
 - lib/activity_notification/roles/acts_as_notifier.rb
 - lib/activity_notification/roles/acts_as_target.rb
 - lib/activity_notification/version.rb
+- lib/generators/activity_notification/add_notifiable_to_subscriptions/add_notifiable_to_subscriptions_generator.rb
+- lib/generators/activity_notification/add_notifiable_to_subscriptions/templates/add_notifiable_to_subscriptions.rb
 - lib/generators/activity_notification/controllers_generator.rb
 - lib/generators/activity_notification/install_generator.rb
 - lib/generators/activity_notification/migration/migration_generator.rb
@@ -461,7 +464,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="