activity_notification 1.4.4 → 2.2.4

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
+        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
+        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
+        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,9 +140,27 @@ 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.
+        # @example Get filtered unopened notificatons 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
+        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
+        #   @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
+        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
         scope :with_target,                       -> { }
@@ -170,26 +188,6 @@ module ActivityNotification
         # Dummy reload method for test of notifications.
         scope :reload,                            -> { }
 
-        # Returns latest notification instance.
-        # @return [Notification] Latest notification instance
-        def self.latest
-          latest_order.first
-        end
-
-        # Returns earliest notification instance.
-        # @return [Notification] Earliest notification instance
-        def self.earliest
-          earliest_order.first
-        end
-
-        # Selects unique keys from query for notifications.
-        # @return [Array<String>] Array of notification unique keys
-        def self.uniq_keys
-          # distinct method cannot keep original sort
-          # distinct(:key)
-          pluck(:key).uniq
-        end
-
         # Returns if the notification is group owner.
         # Calls NotificationApi#group_owner? as super method.
         # @return [Boolean] If the notification is group owner
@@ -197,9 +195,12 @@ module ActivityNotification
           super
         end
 
-        # Raise DeleteRestrictionError for notifications.
+        # Raise ActivityNotification::DeleteRestrictionError for notifications.
+        # @param [String] error_text Error text for raised exception
+        # @raise [ActivityNotification::DeleteRestrictionError] DeleteRestrictionError from used ORM
+        # @return [void]
         def self.raise_delete_restriction_error(error_text)
-          raise error_text
+          raise ActivityNotification::DeleteRestrictionError, error_text
         end
 
         protected

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

@@ -20,15 +20,15 @@ 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
         field :unsubscribed_to_email_at,  type: DateTime
         field :optional_targets,          type: Hash,    default: {}
-    
+
         validates  :target,               presence: true
-        validates  :key,                  presence: true
+        validates  :key,                  presence: true, uniqueness: { scope: [:target_type, :target_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

data/lib/activity_notification/orm/mongoid.rb

@@ -8,7 +8,7 @@ module ActivityNotification
       # @param [String] name     Association name
       # @param [Object] instance Associated instance
       # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
-      scope :filtered_by_association, ->(name, instance) { instance.present? ? where({ "#{name}_id" => instance.id, "#{name}_type" => instance.class.name }) : none }
+      scope :filtered_by_association, ->(name, instance) { where("#{name}_id" => instance.present? ? instance.id : nil, "#{name}_type" => instance.present? ? instance.class.name : nil) }
     end
 
     class_methods do
@@ -24,6 +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 = "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|
@@ -41,6 +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)
+            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
@@ -69,5 +79,27 @@ module ActivityNotification
   end
 end
 
+# Monkey patching for Mongoid::Document as_json
+module Mongoid
+  # Monkey patching for Mongoid::Document as_json
+  module Document
+    # Monkey patching for Mongoid::Document as_json
+    # @param [Hash] options Options parameter
+    # @return [Hash] Hash representing the model
+    def as_json(options = {})
+      json = super(options)
+      json["id"] = json["_id"].to_s.start_with?("{\"$oid\"=>") ? self.id.to_s : json["_id"].to_s
+      if options.has_key?(:include)
+        case options[:include]
+        when Symbol then json[options[:include].to_s] = self.send(options[:include]).as_json
+        when Array  then options[:include].each {|model| json[model.to_s] = self.send(model).as_json }
+        when Hash   then options[:include].each {|model, options| json[model.to_s] = self.send(model).as_json(options) }
+        end
+      end
+      json
+    end
+  end
+end
+
 require_relative 'mongoid/notification.rb'
 require_relative 'mongoid/subscription.rb'