activity_notification 1.4.0 → 1.4.1

data/gemfiles/Gemfile.rails-5.1.lock

@@ -1,20 +1,7 @@
-GIT
-  remote: git://github.com/plataformatec/devise.git
-  revision: 83002017ea4761e30796f3b288be9c7d9b870fcd
-  ref: 83002017
-  specs:
-    devise (4.2.1)
-      bcrypt (~> 3.0)
-      orm_adapter (~> 0.1)
-      railties (>= 4.1.0, < 5.2)
-      responders
-      warden (~> 1.2.3)
-
 PATH
   remote: ..
   specs:
-    activity_notification (1.4.0)
-      activerecord (>= 4.2.0)
+    activity_notification (1.4.1)
       i18n (>= 0.5.0)
       jquery-rails (>= 3.1.1)
       railties (>= 4.2.0, < 5.2)
@@ -22,39 +9,39 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.1.0)
-      actionpack (= 5.1.0)
+    actioncable (5.1.1)
+      actionpack (= 5.1.1)
       nio4r (~> 2.0)
       websocket-driver (~> 0.6.1)
-    actionmailer (5.1.0)
-      actionpack (= 5.1.0)
-      actionview (= 5.1.0)
-      activejob (= 5.1.0)
+    actionmailer (5.1.1)
+      actionpack (= 5.1.1)
+      actionview (= 5.1.1)
+      activejob (= 5.1.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.1.0)
-      actionview (= 5.1.0)
-      activesupport (= 5.1.0)
+    actionpack (5.1.1)
+      actionview (= 5.1.1)
+      activesupport (= 5.1.1)
       rack (~> 2.0)
       rack-test (~> 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.0)
-      activesupport (= 5.1.0)
+    actionview (5.1.1)
+      activesupport (= 5.1.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.1.0)
-      activesupport (= 5.1.0)
+    activejob (5.1.1)
+      activesupport (= 5.1.1)
       globalid (>= 0.3.6)
-    activemodel (5.1.0)
-      activesupport (= 5.1.0)
-    activerecord (5.1.0)
-      activemodel (= 5.1.0)
-      activesupport (= 5.1.0)
+    activemodel (5.1.1)
+      activesupport (= 5.1.1)
+    activerecord (5.1.1)
+      activemodel (= 5.1.1)
+      activesupport (= 5.1.1)
       arel (~> 8.0)
-    activesupport (5.1.0)
+    activesupport (5.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -64,17 +51,20 @@ GEM
       railties (>= 3.0)
       rspec-rails (>= 2.2)
     arel (8.0.0)
-    aws-sdk (2.9.16)
-      aws-sdk-resources (= 2.9.16)
-    aws-sdk-core (2.9.16)
+    aws-sdk (2.9.19)
+      aws-sdk-resources (= 2.9.19)
+    aws-sdk-core (2.9.19)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-resources (2.9.16)
-      aws-sdk-core (= 2.9.16)
+    aws-sdk-resources (2.9.19)
+      aws-sdk-core (= 2.9.19)
     aws-sigv4 (1.0.0)
     bcrypt (3.1.11)
     bson (4.2.1)
     builder (3.2.3)
+    bullet (5.5.1)
+      activesupport (>= 3.0.0)
+      uniform_notifier (~> 1.10.0)
     concurrent-ruby (1.0.5)
     coveralls (0.8.21)
       json (>= 1.8, < 3)
@@ -82,8 +72,18 @@ GEM
       term-ansicolor (~> 1.3)
       thor (~> 0.19.4)
       tins (~> 1.6)
+    devise (4.3.0)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0, < 5.2)
+      responders
+      warden (~> 1.2.3)
     diff-lcs (1.3)
     docile (1.1.5)
+    dotenv (2.2.1)
+    dotenv-rails (2.2.1)
+      dotenv (= 2.2.1)
+      railties (>= 3.2, < 5.2)
     erubi (1.6.0)
     factory_girl (4.8.0)
       activesupport (>= 3.0.0)
@@ -120,33 +120,33 @@ GEM
       mini_portile2 (~> 2.1.0)
     orm_adapter (0.5.0)
     pg (0.20.0)
-    rack (2.0.2)
+    rack (2.0.3)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (5.1.0)
-      actioncable (= 5.1.0)
-      actionmailer (= 5.1.0)
-      actionpack (= 5.1.0)
-      actionview (= 5.1.0)
-      activejob (= 5.1.0)
-      activemodel (= 5.1.0)
-      activerecord (= 5.1.0)
-      activesupport (= 5.1.0)
+    rails (5.1.1)
+      actioncable (= 5.1.1)
+      actionmailer (= 5.1.1)
+      actionpack (= 5.1.1)
+      actionview (= 5.1.1)
+      activejob (= 5.1.1)
+      activemodel (= 5.1.1)
+      activerecord (= 5.1.1)
+      activesupport (= 5.1.1)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 5.1.0)
+      railties (= 5.1.1)
       sprockets-rails (>= 2.0.0)
-    rails-controller-testing (1.0.1)
-      actionpack (~> 5.x)
-      actionview (~> 5.x)
+    rails-controller-testing (1.0.2)
+      actionpack (~> 5.x, >= 5.0.1)
+      actionview (~> 5.x, >= 5.0.1)
       activesupport (~> 5.x)
-    rails-dom-testing (2.0.2)
-      activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.1.0)
-      actionpack (= 5.1.0)
-      activesupport (= 5.1.0)
+    railties (5.1.1)
+      actionpack (= 5.1.1)
+      activesupport (= 5.1.1)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
@@ -154,23 +154,23 @@ GEM
     responders (2.4.0)
       actionpack (>= 4.2.0, < 5.3)
       railties (>= 4.2.0, < 5.3)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-rails (3.5.2)
+      rspec-support (~> 3.6.0)
+    rspec-rails (3.6.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -190,9 +190,10 @@ GEM
     thor (0.19.4)
     thread_safe (0.3.6)
     timecop (0.8.1)
-    tins (1.13.2)
+    tins (1.14.0)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
+    uniform_notifier (1.10.0)
     warden (1.2.7)
       rack (>= 1.0)
     websocket-driver (0.6.5)
@@ -209,15 +210,17 @@ DEPENDENCIES
   activity_notification!
   ammeter
   aws-sdk (~> 2)
+  bullet
   coveralls
-  devise!
+  devise (~> 4.3.0)
+  dotenv-rails
   factory_girl_rails (~> 4.8.0)
   mongoid (>= 4.0.0)
   mysql2 (~> 0.4.6)
   pg (~> 0.20.0)
-  rails (~> 5.1)
+  rails (~> 5.1.0)
   rails-controller-testing
-  rspec-rails (~> 3.5.2)
+  rspec-rails (~> 3.6.0)
   simplecov (~> 0.14.1)
   slack-notifier (>= 1.5.1)
   sqlite3 (~> 1.3.13)

data/lib/activity_notification/apis/notification_api.rb

@@ -455,7 +455,7 @@ module ActivityNotification
     # @param [Integer] limit Limit to query for opened notifications
     # @return [Integer] Count of group notifications including owner and members
     def group_notifier_count(limit = ActivityNotification.config.opened_index_limit)
-      notification = group_member? ? group_owner : self
+      notification = group_member? && group_owner.present? ? group_owner : self
       notification.notifier.present? ? group_member_notifier_count(limit) + 1 : 0
     end
 
@@ -464,7 +464,7 @@ module ActivityNotification
     #
     # @return [Notificaion] Notification instance of the latest group member notification
     def latest_group_member
-      notification = group_member? ? group_owner : self
+      notification = group_member? && group_owner.present? ? group_owner : self
       notification.group_member_exists? ? notification.group_members.latest : self
     end
 
@@ -530,7 +530,7 @@ module ActivityNotification
       # @param [Integer] limit Limit to query for opened notifications
       # @return [Integer] Count of various members of the notification
       def meta_group_member_count(opened_member_count_method_name, unopened_member_count_method_name, limit)
-        notification = group_member? ? group_owner : self
+        notification = group_member? && group_owner.present? ? group_owner : self
         notification.opened? ?
           notification.send(opened_member_count_method_name, limit) :
           notification.send(unopened_member_count_method_name)

data/lib/activity_notification/models.rb

@@ -17,4 +17,4 @@ module ActivityNotification
   end
 end
 
-ActiveRecord::Base.class_eval { include ActivityNotification::Models }
+ActiveRecord::Base.class_eval { include ActivityNotification::Models } if defined?(ActiveRecord::Base)

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

@@ -348,7 +348,7 @@ module ActivityNotification
         generated_notifications = generated_notifications_as_notifiable_for(target_type)
         case dependent
         when :restrict_with_exception
-          raise ActiveRecord::DeleteRestrictionError.new("generated_notifications_as_notifiable_for_#{target_type.to_s.pluralize.underscore}") unless generated_notifications.empty?
+          ActivityNotification::Notification.raise_delete_restriction_error("generated_notifications_as_notifiable_for_#{target_type.to_s.pluralize.underscore}") unless generated_notifications.empty?
         when :restrict_with_error
           unless generated_notifications.empty?
             record = self.class.human_attribute_name("generated_notifications_as_notifiable_for_#{target_type.to_s.pluralize.underscore}").downcase

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

@@ -96,7 +96,7 @@ module ActivityNotification
       # @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
       # @option options [Array|Hash] :custom_filter          (nil)   Custom notification filter (e.g. ["created_at >= ?", time.hour.ago])
-      # @return [Array<Notificaion>] All notifications for this target type grouped by targets
+      # @return [Hash<Target, Notificaion>] All notifications for this target type grouped by targets
       def notification_index_map(options = {})
         all_notifications(options).group_by(&:target)
       end

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

@@ -180,6 +180,11 @@ module ActivityNotification
           pluck(:key).uniq
         end
 
+        # Raise DeleteRestrictionError for notifications.
+        def self.raise_delete_restriction_error(error_text)
+          raise ::ActiveRecord::DeleteRestrictionError.new(error_text)
+        end
+
         protected
 
           # Returns count of group members of the unopened notification.
@@ -200,6 +205,7 @@ module ActivityNotification
           # This method is designed to cache group by query result to avoid N+1 call.
           # @api protected
           #
+          # @param [Integer] limit Limit to query for opened notifications
           # @return [Integer] Count of group members of the opened notification
           def opened_group_member_count(limit = ActivityNotification.config.opened_index_limit)
             # Cache group by query result to avoid N+1 call
@@ -233,6 +239,7 @@ module ActivityNotification
           # This method is designed to cache group by query result to avoid N+1 call.
           # @api protected
           #
+          # @param [Integer] limit Limit to query for opened notifications
           # @return [Integer] Count of group member notifiers of the opened notification
           def opened_group_member_notifier_count(limit = ActivityNotification.config.opened_index_limit)
             # Cache group by query result to avoid N+1 call

data/lib/activity_notification/orm/mongoid.rb

@@ -2,6 +2,15 @@ module ActivityNotification
   module Association
     extend ActiveSupport::Concern
 
+    included do
+      # Selects filtered notifications by associated instance.
+      # @scope class
+      # @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 }
+    end
+
     class_methods do
       # Defines has_many association with ActivityNotification models.
       # @return [Mongoid::Criteria<Object>] Database query of associated model instances
@@ -49,7 +58,8 @@ module ActivityNotification
           define_method(name) do |reload = false|
             reload and self.instance_variable_set("@#{name}", nil)
             if self.instance_variable_get("@#{name}").blank?
-              self.instance_variable_set("@#{name}", object_class.where(id_field => self.id, type_field => self.class.name))
+              new_value = object_class.where(id_field => self.id, type_field => self.class.name)
+              self.instance_variable_set("@#{name}", new_value)
             end
             self.instance_variable_get("@#{name}")
           end

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

@@ -121,7 +121,7 @@ module ActivityNotification
         # @scope class
         # @param [Object] target Target instance for filter
         # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
-        scope :filtered_by_target,                ->(target) { target.present? ? where(target_id: target.id, target_type: target.class.name) : none }
+        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
@@ -129,7 +129,7 @@ module ActivityNotification
         # @scope class
         # @param [Object] notifiable Notifiable instance for filter
         # @return [Mongoid::Criteria<Notificaion>] Database query of filtered notifications
-        scope :filtered_by_instance,              ->(notifiable) { notifiable.present? ? where(notifiable_id: notifiable.id, notifiable_type: notifiable.class.name) : none }
+        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
@@ -197,6 +197,11 @@ module ActivityNotification
           super
         end
 
+        # Raise DeleteRestrictionError for notifications.
+        def self.raise_delete_restriction_error(error_text)
+          raise error_text
+        end
+
         protected
 
           # Returns count of group members of the unopened notification.
@@ -214,6 +219,7 @@ module ActivityNotification
           # @api protected
           # @todo Avoid N+1 call
           #
+          # @param [Integer] limit Limit to query for opened notifications
           # @return [Integer] Count of group members of the opened notification
           def opened_group_member_count(limit = ActivityNotification.config.opened_index_limit)
             limit == 0 and return 0
@@ -239,6 +245,7 @@ module ActivityNotification
           # @api protected
           # @todo Avoid N+1 call
           #
+          # @param [Integer] limit Limit to query for opened notifications
           # @return [Integer] Count of group member notifiers of the opened notification
           def opened_group_member_notifier_count(limit = ActivityNotification.config.opened_index_limit)
             limit == 0 and return 0

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

@@ -50,7 +50,7 @@ module ActivityNotification
         # @scope class
         # @param [Object] target Target instance for filter
         # @return [Mongoid::Criteria<Subscription>] Database query of filtered subscriptions
-        scope :filtered_by_target,  ->(target) { target.present? ? where(target_id: target.id, target_type: target.class.name) : none }
+        scope :filtered_by_target,  ->(target) { filtered_by_association("target", target) }
 
         # Includes target instance with query for subscriptions.
         # @return [Mongoid::Criteria<Subscription>] Database query of subscriptions with target

data/lib/activity_notification/roles/acts_as_notifiable.rb

@@ -3,6 +3,11 @@ module ActivityNotification
   module ActsAsNotifiable
     extend ActiveSupport::Concern
 
+    included do
+      # Defines private clas methods
+      private_class_method :add_tracked_callbacks, :add_tracked_callback, :add_destroy_dependency, :arrange_optional_targets_option
+    end
+
     class_methods do
       # Adds required configurations to notifiable models.
       #
@@ -107,8 +112,9 @@ module ActivityNotification
       #
       # * :tracked
       #   * Adds required callbacks to generate notifications for creation and update of the notifiable model.
-      #     Default callbacks are enabled for [:create, :update].
-      #     You can use :only and :except options as hash for this option.
+      #     Tracked notifications are disabled as default.
+      #     When you set true as this :tracked option, default callbacks will be enabled for [:create, :update].
+      #     You can use :only, :except and other notify options as hash for this option.
       # @example Add all callbacks to generate notifications for creation and update
       #   # app/models/comment.rb
       #   class Comment < ActiveRecord::Base
@@ -125,7 +131,7 @@ module ActivityNotification
       #   # app/models/comment.rb
       #   class Comment < ActiveRecord::Base
       #     belongs_to :article
-      #     acts_as_notifiable :users, targets: User.all, tracked: { except: [:update] }
+      #     acts_as_notifiable :users, targets: User.all, tracked: { except: [:update], key: "comment.edited", send_later: false }
       #   end
       #
       # * :printable_name or :printable_notifiable_name
@@ -183,6 +189,7 @@ module ActivityNotification
       # @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 [Boolean, Hash]         :tracked                 (nil)                    Flag or parameters for automatic tracked notifications
       # @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, [:delete_all, :destroy, :restrict_with_error, :restrict_with_exception, :update_group_and_delete_all, :update_group_and_destroy] are available
       # @option options [Hash<Class, Hash>]     :optional_targets        (nil)                    Optional target configurations with hash of `OptionalTarget` implementation class as key and initializing option parameter as value
@@ -248,21 +255,29 @@ module ActivityNotification
         elsif tracked_option[:only]
           tracked_callbacks &= tracked_option.delete(:only)
         end
-        if tracked_callbacks.include? :create
-          if tracked_option.has_key?(:key)
-            after_create -> { notify target_type, tracked_option }
-          else
-            after_create -> { notify target_type, *tracked_option, key: notification_key_for_tracked_creation }
-          end
+        if tracked_option.has_key?(:key)
+          add_tracked_callback(tracked_callbacks, :create, ->{ notify target_type, tracked_option })
+          add_tracked_callback(tracked_callbacks, :update, ->{ notify target_type, tracked_option })
+        else
+          add_tracked_callback(tracked_callbacks, :create, ->{ notify target_type, *tracked_option, key: notification_key_for_tracked_creation })
+          add_tracked_callback(tracked_callbacks, :update, ->{ notify target_type, *tracked_option, key: notification_key_for_tracked_update })
         end
-        if tracked_callbacks.include? :update
-          if tracked_option.has_key?(:key)
-            after_update -> { notify target_type, tracked_option }
-          else
-            after_update -> { notify target_type, *tracked_option, key: notification_key_for_tracked_update }
+        { tracked: tracked_callbacks }
+      end
+
+      # Adds tracked callback.
+      # @param [Array<Symbol>] tracked_callbacks Array of tracked callbacks (Array of [:create or :update])
+      # @param [Symbol]        tracked_action    Tracked action (:create or :update)
+      # @param [Proc]          tracked_proc      Proc or lambda function to execute
+      def add_tracked_callback(tracked_callbacks, tracked_action, tracked_proc)
+        if tracked_callbacks.include? tracked_action
+          case tracked_action
+          when :create
+            after_create tracked_proc
+          when :update
+            after_update tracked_proc
           end
         end
-        { tracked: tracked_callbacks }
       end
 
       # Adds destroy dependency.