activity_notification 2.1.2 → 2.2.2

data/lib/activity_notification/models/concerns/swagger/subscription_schema.rb

@@ -90,15 +90,15 @@ module ActivityNotification
                   }
                 }
                 key :example, {
-                  "action_cable_channel": {
-                    "subscribing": true,
-                    "subscribed_at": Time.current,
-                    "unsubscribed_at": nil
+                  action_cable_channel:  {
+                    subscribing:  true,
+                    subscribed_at:  Time.current,
+                    unsubscribed_at:  nil
                   },
-                  "slack": {
-                    "subscribing": false,
-                    "subscribed_at": nil,
-                    "unsubscribed_at": Time.current
+                  slack:  {
+                    subscribing:  false,
+                    subscribed_at:  nil,
+                    unsubscribed_at:  Time.current
                   }
                 }
               end
@@ -114,11 +114,11 @@ module ActivityNotification
                 key :type, :object
                 key :description, "Associated target model in your application"
                 key :example, {
-                  "id": 1,
-                  "email": "ichiro@example.com",
-                  "name": "Ichiro",
-                  "created_at": Time.current,
-                  "updated_at": Time.current
+                  id:  1,
+                  email:  "ichiro@example.com",
+                  name:  "Ichiro",
+                  created_at:  Time.current,
+                  updated_at:  Time.current
                 }
               end
             end
@@ -145,11 +145,11 @@ module ActivityNotification
                   }
                 }
                 key :example, {
-                  "action_cable_channel": {
-                    "subscribing": true
+                  action_cable_channel:  {
+                    subscribing:  true
                   },
-                  "slack": {
-                    "subscribing": false
+                  slack:  {
+                    subscribing:  false
                   }
                 }
               end

data/lib/activity_notification/models/concerns/target.rb

@@ -213,16 +213,12 @@ module ActivityNotification
       resolve_value(_notification_action_cable_with_devise)
     end
 
-    # :nocov:
-    if Rails::VERSION::MAJOR >= 5
-      # Returns notification ActionCable channel class name from action_cable_with_devise? configuration.
-      #
-      # @return [String] Notification ActionCable channel class name from action_cable_with_devise? configuration
-      def notification_action_cable_channel_class_name
-        notification_action_cable_with_devise? ? "ActivityNotification::NotificationWithDeviseChannel" : "ActivityNotification::NotificationChannel"
-      end
+    # Returns notification ActionCable channel class name from action_cable_with_devise? configuration.
+    #
+    # @return [String] Notification ActionCable channel class name from action_cable_with_devise? configuration
+    def notification_action_cable_channel_class_name
+      notification_action_cable_with_devise? ? "ActivityNotification::NotificationWithDeviseChannel" : "ActivityNotification::NotificationChannel"
     end
-    # :nocov:
 
     # Returns Devise resource model associated with this target.
     #
@@ -545,7 +541,7 @@ module ActivityNotification
     # @param [String]  key                  Key of the notification
     # @param [Boolean] subscribe_as_default Default subscription value to use when the subscription record does not configured
     # @return [Boolean] If the target subscribes the notification email or the subscription management is not allowed for the target
-    def subscribes_to_notification_email?(key, subscribe_as_default = ActivityNotification.config.subscribe_as_default)
+    def subscribes_to_notification_email?(key, subscribe_as_default = ActivityNotification.config.subscribe_to_email_as_default)
       !subscription_allowed?(key) || _subscribes_to_notification_email?(key, subscribe_as_default)
     end
     alias_method :subscribes_to_email?, :subscribes_to_notification_email?
@@ -557,7 +553,7 @@ module ActivityNotification
     # @param [String, Symbol] optional_target_name Class name of the optional target implementation (e.g. :amazon_sns, :slack)
     # @param [Boolean]        subscribe_as_default Default subscription value to use when the subscription record does not configured
     # @return [Boolean] If the target subscribes the notification email or the subscription management is not allowed for the target
-    def subscribes_to_optional_target?(key, optional_target_name, subscribe_as_default = ActivityNotification.config.subscribe_as_default)
+    def subscribes_to_optional_target?(key, optional_target_name, subscribe_as_default = ActivityNotification.config.subscribe_to_optional_targets_as_default)
       !subscription_allowed?(key) || _subscribes_to_optional_target?(key, optional_target_name, subscribe_as_default)
     end
 
@@ -693,4 +689,4 @@ module ActivityNotification
       end
 
   end
-end
+end

data/lib/activity_notification/optional_targets/action_cable_api_channel.rb

@@ -26,7 +26,7 @@ module ActivityNotification
       # @return [Boolean] Whether Action Cable notification API is allowed
       def notification_action_cable_api_allowed?(notification)
         notification.target.notification_action_cable_allowed?(notification.notifiable, notification.key) &&
-          notification.notifiable.notification_action_cable_api_allowed?(notification.target, notification.key)
+          notification.notifiable.notifiable_action_cable_api_allowed?(notification.target, notification.key)
       end
 
       # Format message to broadcast

data/lib/activity_notification/optional_targets/action_cable_channel.rb

@@ -44,7 +44,7 @@ module ActivityNotification
       # @return [Boolean] Whether Action Cable notification is allowed
       def notification_action_cable_allowed?(notification)
         notification.target.notification_action_cable_allowed?(notification.notifiable, notification.key) &&
-          notification.notifiable.notification_action_cable_allowed?(notification.target, notification.key)
+          notification.notifiable.notifiable_action_cable_allowed?(notification.target, notification.key)
       end
 
       # Format message to broadcast

data/lib/activity_notification/orm/active_record.rb

@@ -6,7 +6,7 @@ module ActivityNotification
       # Defines has_many association with ActivityNotification models.
       # @return [ActiveRecord_AssociationRelation<Object>] Database query of associated model instances
       def has_many_records(name, options = {})
-        has_many name, options
+        has_many name, **options
       end
     end
   end

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

@@ -23,14 +23,14 @@ module ActivityNotification
         # Belongs to group instance of this notification as polymorphic association.
         # @scope instance
         # @return [Object] Group instance of this notification
-        belongs_to :group,         { polymorphic: true }.merge(Rails::VERSION::MAJOR >= 5 ? { optional: true } : {})
+        belongs_to :group,         polymorphic: true, optional: true
 
         # Belongs to group owner notification instance of this notification.
         # Only group member instance has :group_owner value.
         # Group owner instance has nil as :group_owner association.
         # @scope instance
         # @return [Notification] Group owner notification instance of this notification
-        belongs_to :group_owner, { class_name: "ActivityNotification::Notification" }.merge(Rails::VERSION::MAJOR >= 5 ? { optional: true } : {})
+        belongs_to :group_owner,   class_name: "ActivityNotification::Notification", optional: true
 
         # Has many group member notification instances of this notification.
         # Only group owner instance has :group_members value.
@@ -42,7 +42,7 @@ module ActivityNotification
         # Belongs to :notifier instance of this notification.
         # @scope instance
         # @return [Object] Notifier instance of this notification
-        belongs_to :notifier,      { polymorphic: true }.merge(Rails::VERSION::MAJOR >= 5 ? { optional: true } : {})
+        belongs_to :notifier,      polymorphic: true, optional: true
 
         # Serialize parameters Hash
         serialize  :parameters, Hash

data/lib/activity_notification/orm/dynamoid.rb

@@ -22,8 +22,8 @@ module ActivityNotification
         association_name     = name.to_s.singularize.underscore
         composite_field = "#{association_name}_key".to_sym
         field composite_field, :string
-        associated_record_field = "#{association_name}_record".to_sym
-        field associated_record_field, :string if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
+        associated_record_field = "stored_#{association_name}".to_sym
+        field associated_record_field, :raw if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
 
         self.instance_eval do
           define_method(name) do |reload = false|
@@ -43,7 +43,14 @@ module ActivityNotification
               self.send("#{composite_field}=", nil)
             else
               self.send("#{composite_field}=", "#{new_instance.class.name}#{ActivityNotification.config.composite_key_delimiter}#{new_instance.id}")
-              self.send("#{associated_record_field}=", new_instance.to_json) if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
+              associated_record_json = new_instance.as_json(_options[:as_json_options] || {})
+              # Cast Time and DateTime field to String to handle Dynamoid unsupported type error
+              if associated_record_json.present?
+                associated_record_json.each do |k, v|
+                  associated_record_json[k] = v.to_s if v.is_a?(Time) || v.is_a?(DateTime)
+                end
+              end
+              self.send("#{associated_record_field}=", associated_record_json) if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
             end
             self.instance_variable_set("@#{name}", nil)
           end

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

@@ -20,17 +20,17 @@ module ActivityNotification
         # Belongs to target instance of this notification as polymorphic association using composite key.
         # @scope instance
         # @return [Object] Target instance of this notification
-        belongs_to_composite_xdb_record :target, store_with_associated_records: true
+        belongs_to_composite_xdb_record :target, store_with_associated_records: true, as_json_options: { methods: [:printable_type, :printable_target_name] }
 
         # Belongs to notifiable instance of this notification as polymorphic association using composite key.
         # @scope instance
         # @return [Object] Notifiable instance of this notification
-        belongs_to_composite_xdb_record :notifiable, store_with_associated_records: true
+        belongs_to_composite_xdb_record :notifiable, store_with_associated_records: true, as_json_options: { methods: [:printable_type] }
 
         # Belongs to group instance of this notification as polymorphic association using composite key.
         # @scope instance
         # @return [Object] Group instance of this notification
-        belongs_to_composite_xdb_record :group
+        belongs_to_composite_xdb_record :group, store_with_associated_records: true, as_json_options: { methods: [:printable_type, :printable_group_name] }
 
         field :key,            :string
         field :parameters,     :raw,      default: {}
@@ -42,7 +42,7 @@ module ActivityNotification
         # Group owner instance has nil as :group_owner association.
         # @scope instance
         # @return [Notification] Group owner notification instance of this notification
-        belongs_to :group_owner, { class_name: "ActivityNotification::Notification", foreign_key: :group_owner_id }.merge(Rails::VERSION::MAJOR >= 5 ? { optional: true } : {})
+        belongs_to :group_owner, { class_name: "ActivityNotification::Notification", foreign_key: :group_owner_id, optional: true }
 
         # Customized method that belongs to group owner notification instance of this notification.
         # @raise [Errors::RecordNotFound] Record not found error
@@ -64,14 +64,54 @@ module ActivityNotification
         # Belongs to :otifier instance of this notification.
         # @scope instance
         # @return [Object] Notifier instance of this notification
-        belongs_to_composite_xdb_record :notifier, store_with_associated_records: true
+        belongs_to_composite_xdb_record :notifier, store_with_associated_records: true, as_json_options: { methods: [:printable_type, :printable_notifier_name] }
+
+        # Additional fields to store from instance method when config.store_with_associated_records is enabled
+        if ActivityNotification.config.store_with_associated_records
+          field :stored_notifiable_path,             :string
+          field :stored_printable_notifiable_name,   :string
+          field :stored_group_member_notifier_count, :integer
+          field :stored_group_notification_count,    :integer
+          field :stored_group_members,               :array
+
+          # Returns prepared notification object to store
+          # @return [Object] prepared notification object to store
+          def prepare_to_store
+            self.stored_notifiable_path           = notifiable_path
+            self.stored_printable_notifiable_name = printable_notifiable_name
+            if group_owner?
+              self.stored_group_notification_count    = 0
+              self.stored_group_member_notifier_count = 0
+              self.stored_group_members               = []
+            end
+            self
+          end
+
+          # Call after store action with stored notification
+          def after_store
+            if group_owner?
+              self.stored_group_notification_count    = group_notification_count
+              self.stored_group_member_notifier_count = group_member_notifier_count
+              self.stored_group_members               = group_members.as_json
+              self.stored_group_members.each do |group_member|
+                # Cast Time and DateTime field to String to handle Dynamoid unsupported type error
+                group_member.each do |k, v|
+                  group_member[k] = v.to_s if v.is_a?(Time) || v.is_a?(DateTime)
+                end
+              end
+              save
+            else
+              group_owner.after_store
+            end
+          end
+        end
 
         # Mandatory global secondary index to query effectively
-        global_secondary_index hash_key: :target_key,     range_key: :created_at, projected_attributes: :all
-        global_secondary_index hash_key: :group_owner_id, range_key: :created_at, projected_attributes: :all
+        global_secondary_index name: :index_target_key_created_at,     hash_key: :target_key,     range_key: :created_at, projected_attributes: :all
+        global_secondary_index name: :index_group_owner_id_created_at, hash_key: :group_owner_id, range_key: :created_at, projected_attributes: :all
         # Optional global secondary index to sort by created_at
-        global_secondary_index hash_key: :notifier_key,   range_key: :created_at, projected_attributes: :all
-        global_secondary_index hash_key: :notifiable_key, range_key: :created_at, projected_attributes: :all
+        global_secondary_index name: :index_notifier_key_created_at,   hash_key: :notifier_key,   range_key: :created_at, projected_attributes: :all
+        global_secondary_index name: :index_notifiable_key_created_at, hash_key: :notifiable_key, range_key: :created_at, projected_attributes: :all
 
         validates  :target,     presence: true
         validates  :notifiable, presence: true
@@ -122,11 +162,6 @@ module ActivityNotification
           raise ActivityNotification::DeleteRestrictionError, error_text
         end
 
-        # Returns prepared notification object to store
-        # @return [Object] prepared notification object to store
-        # def prepare_to_store
-        # end
-
         protected
 
           # Returns count of group members of the unopened notification.

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

@@ -21,14 +21,14 @@ module ActivityNotification
 
         field :key,                       :string
         field :subscribing,               :boolean, default: ActivityNotification.config.subscribe_as_default
-        field :subscribing_to_email,      :boolean, default: ActivityNotification.config.subscribe_as_default
+        field :subscribing_to_email,      :boolean, default: ActivityNotification.config.subscribe_to_email_as_default
         field :subscribed_at,             :datetime
         field :unsubscribed_at,           :datetime
         field :subscribed_to_email_at,    :datetime
         field :unsubscribed_to_email_at,  :datetime
         field :optional_targets,          :raw,     default: {}
 
-        global_secondary_index hash_key: :target_key, range_key: :created_at, projected_attributes: :all
+        global_secondary_index name: :index_target_key_created_at, hash_key: :target_key, range_key: :created_at, projected_attributes: :all
 
         validates  :target,               presence: true
         validates  :key,                  presence: true, uniqueness: { scope: :target_key }

data/lib/activity_notification/orm/mongoid.rb

@@ -24,8 +24,8 @@ module ActivityNotification
         id_field, type_field = "#{association_name}_id", "#{association_name}_type"
         field id_field,   type: String
         field type_field, type: String
-        associated_record_field = "#{association_name}_record"
-        field associated_record_field, type: String if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
+        associated_record_field = "stored_#{association_name}"
+        field associated_record_field, type: Hash if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
 
         self.instance_eval do
           define_method(name) do |reload = false|
@@ -43,7 +43,14 @@ module ActivityNotification
             if new_instance.nil? then instance_id, instance_type = nil, nil else instance_id, instance_type = new_instance.id, new_instance.class.name end
             self.send("#{id_field}=", instance_id)
             self.send("#{type_field}=", instance_type)
-            self.send("#{associated_record_field}=", new_instance.to_json) if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
+            associated_record_json = new_instance.as_json(_options[:as_json_options] || {})
+            # Cast Hash $oid field to String id to handle BSON::String::IllegalKey
+            if associated_record_json.present?
+              associated_record_json.each do |k, v|
+                associated_record_json[k] = v['$oid'] if v.is_a?(Hash) && v.has_key?('$oid')
+              end
+            end
+            self.send("#{associated_record_field}=", associated_record_json) if ActivityNotification.config.store_with_associated_records && _options[:store_with_associated_records]
             self.instance_variable_set("@#{name}", nil)
           end
         end

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

@@ -19,17 +19,17 @@ module ActivityNotification
         # Belongs to target instance of this notification as polymorphic association.
         # @scope instance
         # @return [Object] Target instance of this notification
-        belongs_to_polymorphic_xdb_record :target, store_with_associated_records: true
+        belongs_to_polymorphic_xdb_record :target, store_with_associated_records: true, as_json_options: { methods: [:printable_type, :printable_target_name] }
 
         # Belongs to notifiable instance of this notification as polymorphic association.
         # @scope instance
         # @return [Object] Notifiable instance of this notification
-        belongs_to_polymorphic_xdb_record :notifiable, store_with_associated_records: true
+        belongs_to_polymorphic_xdb_record :notifiable, store_with_associated_records: true, as_json_options: { methods: [:printable_type] }
 
         # Belongs to group instance of this notification as polymorphic association.
         # @scope instance
         # @return [Object] Group instance of this notification
-        belongs_to_polymorphic_xdb_record :group
+        belongs_to_polymorphic_xdb_record :group, as_json_options: { methods: [:printable_type, :printable_group_name] }
 
         field :key,            type: String
         field :parameters,     type: Hash,     default: {}
@@ -41,7 +41,7 @@ module ActivityNotification
         # Group owner instance has nil as :group_owner association.
         # @scope instance
         # @return [Notification] Group owner notification instance of this notification
-        belongs_to :group_owner, { class_name: "ActivityNotification::Notification" }.merge(Rails::VERSION::MAJOR >= 5 ? { optional: true } : {})
+        belongs_to :group_owner, { class_name: "ActivityNotification::Notification", optional: true }
 
         # Has many group member notification instances of this notification.
         # Only group owner instance has :group_members value.
@@ -53,7 +53,7 @@ module ActivityNotification
         # Belongs to :otifier instance of this notification.
         # @scope instance
         # @return [Object] Notifier instance of this notification
-        belongs_to_polymorphic_xdb_record :notifier, store_with_associated_records: true
+        belongs_to_polymorphic_xdb_record :notifier, store_with_associated_records: true, as_json_options: { methods: [:printable_type, :printable_notifier_name] }
 
         validates  :target,        presence: true
         validates  :notifiable,    presence: true
@@ -140,7 +140,9 @@ module ActivityNotification
         scope :filtered_by_group,                 ->(group) {
           group.present? ?
             where(group_id: group.id, group_type: group.class.name) :
-            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.

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

@@ -20,7 +20,7 @@ module ActivityNotification
 
         field :key,                       type: String
         field :subscribing,               type: Boolean, default: ActivityNotification.config.subscribe_as_default
-        field :subscribing_to_email,      type: Boolean, default: ActivityNotification.config.subscribe_as_default
+        field :subscribing_to_email,      type: Boolean, default: ActivityNotification.config.subscribe_to_email_as_default
         field :subscribed_at,             type: DateTime
         field :unsubscribed_at,           type: DateTime
         field :subscribed_to_email_at,    type: DateTime

data/lib/activity_notification/renderable.rb

@@ -29,8 +29,8 @@ module ActivityNotification
       )
 
       # Generate the :default fallback key without using pluralization key :count
-      default = I18n.t(k, attrs)
-      I18n.t(k, attrs.merge(count: group_notification_count, default: default))
+      default = I18n.t(k, **attrs)
+      I18n.t(k, **attrs.merge(count: group_notification_count, default: default))
     end
 
     # Renders notification from views.

data/lib/activity_notification/roles/acts_as_notifiable.rb

@@ -239,25 +239,21 @@ module ActivityNotification
           configured_params.update(add_destroy_dependency(target_type, options[:dependent_notifications]))
         end
 
-        # :nocov:
-        if Rails::VERSION::MAJOR >= 5
-          if options[:action_cable_allowed] || (ActivityNotification.config.action_cable_enabled && options[:action_cable_allowed] != false)
-            options[:optional_targets] ||= {}
-            require 'activity_notification/optional_targets/action_cable_channel'
-            unless options[:optional_targets].has_key?(ActivityNotification::OptionalTarget::ActionCableChannel)
-              options[:optional_targets][ActivityNotification::OptionalTarget::ActionCableChannel] = {}
-            end
+        if options[:action_cable_allowed] || (ActivityNotification.config.action_cable_enabled && options[:action_cable_allowed] != false)
+          options[:optional_targets] ||= {}
+          require 'activity_notification/optional_targets/action_cable_channel'
+          unless options[:optional_targets].has_key?(ActivityNotification::OptionalTarget::ActionCableChannel)
+            options[:optional_targets][ActivityNotification::OptionalTarget::ActionCableChannel] = {}
           end
+        end
 
-          if options[:action_cable_api_allowed] || (ActivityNotification.config.action_cable_api_enabled && options[:action_cable_api_allowed] != false)
-            options[:optional_targets] ||= {}
-            require 'activity_notification/optional_targets/action_cable_api_channel'
-            unless options[:optional_targets].has_key?(ActivityNotification::OptionalTarget::ActionCableApiChannel)
-              options[:optional_targets][ActivityNotification::OptionalTarget::ActionCableApiChannel] = {}
-            end
+        if options[:action_cable_api_allowed] || (ActivityNotification.config.action_cable_api_enabled && options[:action_cable_api_allowed] != false)
+          options[:optional_targets] ||= {}
+          require 'activity_notification/optional_targets/action_cable_api_channel'
+          unless options[:optional_targets].has_key?(ActivityNotification::OptionalTarget::ActionCableApiChannel)
+            options[:optional_targets][ActivityNotification::OptionalTarget::ActionCableApiChannel] = {}
           end
         end
-        # :nocov:
 
         if options[:optional_targets].is_a?(Hash)
           options[:optional_targets] = arrange_optional_targets_option(options[:optional_targets])
@@ -265,7 +261,8 @@ module ActivityNotification
 
         options[:printable_notifiable_name] ||= options.delete(:printable_name)
         configured_params
-          .merge set_acts_as_parameters_for_target(target_type, [:targets, :group, :group_expiry_delay, :parameters, :email_allowed, :action_cable_allowed, :action_cable_api_allowed], options, "notification_")
+          .merge set_acts_as_parameters_for_target(target_type, [:targets, :group, :group_expiry_delay, :parameters, :email_allowed], options, "notification_")
+          .merge set_acts_as_parameters_for_target(target_type, [:action_cable_allowed, :action_cable_api_allowed], options, "notifiable_")
           .merge set_acts_as_parameters_for_target(target_type, [:notifier, :notifiable_path, :printable_notifiable_name, :optional_targets], options)
       end