activity_notification 0.0.10 → 1.0.0

data/app/views/activity_notification/notifications/default/open.js.erb

@@ -1,2 +1,2 @@
-$("#notification_count").html("<%= @target.unopened_notification_count %>");
-$("#notifications").html("<%= escape_javascript( render_notification(@notifications, fallback: "default") ) %>");
+$(".notification_count").html("<span class=\"<%= 'unopened' if @target.has_unopened_notifications? %>\"><%= @target.unopened_notification_count %></span>");
+$("<%= ".notification_#{@notification.id}" %>").html("<%= escape_javascript( render_notification(@notification, fallback: :default) ) %>");

data/app/views/activity_notification/notifications/default/open_all.js.erb

@@ -1,2 +1,2 @@
-$("#notification_count").html("<%= @target.unopened_notification_count %>");
-$("#notifications").html("<%= escape_javascript( render_notification(@notifications, fallback: "default") ) %>");
+$(".notification_count").html("<span class=\"<%= 'unopened' if @target.has_unopened_notifications? %>\"><%= @target.unopened_notification_count %></span>");
+$(".notifications").html("<%= escape_javascript( render_notification(@notifications, fallback: :default) ) %>");

data/app/views/activity_notification/notifications/default/show.html.erb

@@ -1,2 +1,2 @@
 <h1>Notification for <%= "#{@target.class.to_s.underscore} (#{@target.id})" %></h1>
-<%= render_notification(@notification, fallback: "default") %>
+<%= render_notification(@notification, fallback: :default) %>

data/gemfiles/Gemfile.rails-4.2

@@ -3,8 +3,6 @@ source 'https://rubygems.org'
 gemspec path: '../'
 
 gem 'rails', '~> 4.2.0'
-gem 'sqlite3'
-gem 'jquery-rails'
 
 group :test do
   gem 'ammeter'

data/gemfiles/Gemfile.rails-4.2.lock

@@ -1,9 +1,10 @@
 PATH
   remote: ../
   specs:
-    activity_notification (0.0.9)
+    activity_notification (1.0.0)
       activerecord (>= 4.2.0)
       i18n (>= 0.5.0)
+      jquery-rails (>= 3.1.1)
       railties (>= 4.2.0, < 5.1)
 
 GEM
@@ -177,11 +178,10 @@ DEPENDENCIES
   coveralls
   devise (~> 4.2.0)
   factory_girl_rails (~> 4.7.0)
-  jquery-rails
   rails (~> 4.2.0)
   rspec-rails (~> 3.5.1)
   simplecov (~> 0.12.0)
-  sqlite3
+  sqlite3 (~> 1.3.11)
   timecop
   yard (~> 0.9.5)
   yard-activesupport-concern (~> 0.0.1)

data/gemfiles/Gemfile.rails-5.0

@@ -3,12 +3,10 @@ source 'https://rubygems.org'
 gemspec path: '../'
 
 gem 'rails', '~> 5.0.0'
-gem 'sqlite3'
-gem 'jquery-rails'
 
 group :test do
-  gem 'ammeter'
   gem 'rails-controller-testing'
+  gem 'ammeter'
   gem 'timecop'
   gem 'coveralls', require: false
 end

data/lib/activity_notification.rb

@@ -11,7 +11,7 @@ module ActivityNotification
   autoload :Target,           'activity_notification/models/concerns/target'
   autoload :Notifiable,       'activity_notification/models/concerns/notifiable'
   autoload :Notifier,         'activity_notification/models/concerns/notifier'
-  autoload :StoreController,  'activity_notification/controllers/store_controller'
+  autoload :Group,            'activity_notification/models/concerns/group'
   autoload :Common
   autoload :Config
   autoload :Renderable
@@ -31,14 +31,14 @@ module ActivityNotification
   # All available options and their defaults are in the example below:
   # @example Initializer for Rails
   #   ActivityNotification.configure do |config|
-  #     config.enabled           = true
-  #     config.table_name        = "notifications"
-  #     config.email_enabled     = false
-  #     config.mailer_sender     = nil
-  #     config.mailer            = 'ActivityNotification::Mailer'
-  #     config.parent_mailer     = 'ActionMailer::Base'
-  #     config.parent_controller = 'ApplicationController'
-  #     config.opened_limit      = 10
+  #     config.enabled            = true
+  #     config.table_name         = "notifications"
+  #     config.email_enabled      = false
+  #     config.mailer_sender      = nil
+  #     config.mailer             = 'ActivityNotification::Mailer'
+  #     config.parent_mailer      = 'ActionMailer::Base'
+  #     config.parent_controller  = 'ApplicationController'
+  #     config.opened_index_limit = 10
   #   end
   def self.configure(&block)
     yield(config) if block_given?
@@ -49,6 +49,7 @@ end
 # Load ActivityNotification helpers
 require 'activity_notification/helpers/polymorphic_helpers'
 require 'activity_notification/helpers/view_helpers'
+require 'activity_notification/controllers/store_controller'
 
 # Load role for models
 require 'activity_notification/models'

data/lib/activity_notification/apis/notification_api.rb

@@ -78,7 +78,7 @@ module ActivityNotification
         # Store notification
         notification = store_notification(target, notifiable, options)
         # Send notification email
-        notification.send_notification_email(send_later) if send_email
+        notification.send_notification_email({ send_later: send_later }) if send_email
         # Return created notification
         notification
       end
@@ -92,7 +92,7 @@ module ActivityNotification
       # @option options [Object]   :filtered_by_group      (nil) Group instance for filter
       # @option options [String]   :filtered_by_group_type (nil) Group type for filter, valid with :filtered_by_group_id
       # @option options [String]   :filtered_by_group_id   (nil) Group instance id for filter, valid with :filtered_by_group_type
-      # @option options [String]   :filtered_by_key        (nil) Key of the notification for filter 
+      # @option options [String]   :filtered_by_key        (nil) Key of the notification for filter
       # @return [Integer] Number of opened notification records
       # @todo Add filter option
       def open_all_of(target, options = {})
@@ -106,7 +106,7 @@ module ActivityNotification
       # @param [Array<Notificaion> | ActiveRecord_AssociationRelation<Notificaion>] notifications Array or database query of the notifications to test member exists
       # @return [Boolean] If group member of the notifications exists
       def group_member_exists?(notifications)
-        notifications.present? && where(group_owner_id: notifications.map(&:id)).exists?
+        notifications.present? and where(group_owner_id: notifications.map(&:id)).exists?
       end
 
       # Returns available options for kinds of notify methods.
@@ -142,13 +142,16 @@ module ActivityNotification
 
     # Sends notification email to the target.
     #
-    # @param [Boolean] send_later If it sends notification email asynchronously
+    # @param [Hash] options Options for notification email
+    # @option send_later [Boolean] :send_later If it sends notification email asynchronously
+    # @option options [String, Symbol] :fallback (:default) Fallback template to use when MissingTemplate is raised
     # @return [Mail::Message, ActionMailer::DeliveryJob] Email message or its delivery job
-    def send_notification_email(send_later = true)
+    def send_notification_email(options = {})
+      send_later = options.has_key?(:send_later) ? options[:send_later] : true
       if send_later
-        Mailer.send_notification_email(self).deliver_later
+        Mailer.send_notification_email(self, options).deliver_later
       else
-        Mailer.send_notification_email(self).deliver_now
+        Mailer.send_notification_email(self, options).deliver_now
       end
     end
 
@@ -198,26 +201,66 @@ module ActivityNotification
     #
     # @param [Integer] limit Limit to query for opened notifications
     # @return [Boolean] If group member of the notification exists
-    def group_member_exists?(limit = ActivityNotification.config.opened_limit)
+    def group_member_exists?(limit = ActivityNotification.config.opened_index_limit)
       group_member_count(limit) > 0
     end
 
+    # Returns if group member notifier except group owner notifier exists.
+    # It always returns false if group owner notifier is blank.
+    # It counts only the member notifier of the same type with group owner notifier.
+    # This method is designed to cache group by query result to avoid N+1 call.
+    #
+    # @param [Integer] limit Limit to query for opened notifications
+    # @return [Boolean] If group member of the notification exists
+    def group_member_notifier_exists?(limit = ActivityNotification.config.opened_index_limit)
+      group_member_notifier_count(limit) > 0
+    end
+
     # Returns count of group members of the notification.
     # This method is designed to cache group by query result to avoid N+1 call.
     #
     # @param [Integer] limit Limit to query for opened notifications
     # @return [Integer] Count of group members of the notification
-    def group_member_count(limit = ActivityNotification.config.opened_limit)
+    def group_member_count(limit = ActivityNotification.config.opened_index_limit)
+      meta_group_member_count(:opened_group_member_count, :unopened_group_member_count, limit)
+    end
+
+    # Returns count of group notifications including owner and members.
+    # This method is designed to cache group by query result to avoid N+1 call.
+    #
+    # @param [Integer] limit Limit to query for opened notifications
+    # @return [Integer] Count of group notifications including owner and members
+    def group_notification_count(limit = ActivityNotification.config.opened_index_limit)
+      group_member_count(limit) + 1
+    end
+
+    # Returns count of group member notifiers of the notification not including group owner notifier.
+    # It always returns 0 if group owner notifier is blank.
+    # It counts only the member notifier of the same type with group owner notifier.
+    # This method is designed to cache group by query result to avoid N+1 call.
+    #
+    # @param [Integer] limit Limit to query for opened notifications
+    # @return [Integer] Count of group member notifiers of the notification
+    def group_member_notifier_count(limit = ActivityNotification.config.opened_index_limit)
+      meta_group_member_count(:opened_group_member_notifier_count, :unopened_group_member_notifier_count, limit)
+    end
+
+    # Returns count of group member notifiers including group owner notifier.
+    # It always returns 0 if group owner notifier is blank.
+    # This method is designed to cache group by query result to avoid N+1 call.
+    #
+    # @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.opened? ?
-        notification.opened_group_member_count(limit) :
-        notification.unopened_group_member_count
+      notification.notifier.present? ? group_member_notifier_count(limit) + 1 : 0
     end
 
     # Returns notifiable_path to move after opening notification with notifiable.notifiable_path.
     #
     # @return [String] Notifiable path URL to move after opening notification
     def notifiable_path
+      notifiable.present? or raise ActiveRecord::RecordNotFound.new("Couldn't find notifiable #{notifiable_type}")
       notifiable.notifiable_path(target_type, key)
     end
 
@@ -237,13 +280,13 @@ module ActivityNotification
                                              .count
         unopened_group_member_counts[id] || 0
       end
-    
+
       # Returns count of group members of the opened notification.
       # This method is designed to cache group by query result to avoid N+1 call.
       # @api protected
       #
       # @return [Integer] Count of group members of the opened notification
-      def opened_group_member_count(limit = ActivityNotification.config.opened_limit)
+      def opened_group_member_count(limit = ActivityNotification.config.opened_index_limit)
         # Cache group by query result to avoid N+1 call
         opened_group_member_counts   = target.notifications
                                              .opened_index_group_members_only(limit)
@@ -252,5 +295,56 @@ module ActivityNotification
         opened_group_member_counts[id] || 0
       end
 
+      # Returns count of group member notifiers of the unopened notification not including group owner notifier.
+      # This method is designed to cache group by query result to avoid N+1 call.
+      # @api protected
+      #
+      # @return [Integer] Count of group member notifiers of the unopened notification
+      def unopened_group_member_notifier_count
+        # Cache group by query result to avoid N+1 call
+        unopened_group_member_notifier_counts = target.notifications
+                                                      .unopened_index_group_members_only
+                                                      .includes(:group_owner)
+                                                      .where('group_owners_notifications.notifier_type = notifications.notifier_type')
+                                                      .where.not('group_owners_notifications.notifier_id = notifications.notifier_id')
+                                                      .references(:group_owner)
+                                                      .group(:group_owner_id, :notifier_type)
+                                                      .count('distinct notifications.notifier_id')
+        unopened_group_member_notifier_counts[[id, notifier_type]] || 0
+      end
+
+      # Returns count of group member notifiers of the opened notification not including group owner notifier.
+      # This method is designed to cache group by query result to avoid N+1 call.
+      # @api protected
+      #
+      # @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
+        opened_group_member_notifier_counts   = target.notifications
+                                                      .opened_index_group_members_only(limit)
+                                                      .includes(:group_owner)
+                                                      .where('group_owners_notifications.notifier_type = notifications.notifier_type')
+                                                      .where.not('group_owners_notifications.notifier_id = notifications.notifier_id')
+                                                      .references(:group_owner)
+                                                      .group(:group_owner_id, :notifier_type)
+                                                      .count('distinct notifications.notifier_id')
+        opened_group_member_notifier_counts[[id, notifier_type]] || 0
+      end
+
+      # Returns count of various members of the notification.
+      # This method is designed to cache group by query result to avoid N+1 call.
+      # @api protected
+      #
+      # @param [Symbol] opened_member_count_method_name Method name to count members of unopened index
+      # @param [Symbol] unopened_member_count_method_name Method name to count members of opened index
+      # @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.opened? ?
+          notification.send(opened_member_count_method_name, limit) :
+          notification.send(unopened_member_count_method_name)
+      end
+
   end
 end

data/lib/activity_notification/common.rb

@@ -41,6 +41,17 @@ module ActivityNotification
     end
   end
 
+  # Casts to indifferent hash
+  # @param [ActionController::Parameters, Hash] new_hash
+  # @return [HashWithIndifferentAccess] Converted indifferent hash
+  def self.cast_to_indifferent_hash(hash = {})
+    # This is the typical (not-ActionView::TestCase) code path.
+    hash = hash.to_unsafe_h if hash.respond_to?(:to_unsafe_h)
+    # In Rails 5 to_unsafe_h returns a HashWithIndifferentAccess, in Rails 4 it returns Hash
+    hash = hash.with_indifferent_access if hash.instance_of? Hash
+    hash
+  end
+
   # Common module included in target and notifiable model.
   # Provides methods to resolve parameters from configured field or defined method.
   # Also provides methods to convert into resource name or class name as string.
@@ -109,10 +120,8 @@ module ActivityNotification
 
     # Convets to printable model name to show in view or email.
     # @return [String] Printable model name
-    # @todo Is this the best to make readable?
     def printable_name
       "#{self.printable_type} (#{id})"
     end
-
   end
 end

data/lib/activity_notification/config.rb

@@ -57,26 +57,26 @@ module ActivityNotification
     #   @return [String] Base controller class for notifications_controller.
     attr_accessor :parent_controller
 
-    # @overload opened_limit
+    # @overload opened_index_limit
     #   @return [Integer] Default limit to query for opened notifications.
-    # @overload opened_limit=(value)
-    #   Sets the opened_limit
-    #   @param [Integer] opened_limit The new opened_limit
+    # @overload opened_index_limit=(value)
+    #   Sets the opened_index_limit
+    #   @param [Integer] opened_index_limit The new opened_index_limit
     #   @return [Integer] Default limit to query for opened notifications.
-    attr_accessor :opened_limit
+    attr_accessor :opened_index_limit
 
     # Initialize configuration for ActivityNotification.
     # These configuration can be overriden in initializer.
     # @return [Config] A new instance of Config
     def initialize
-      @enabled           = true
-      @table_name        = 'notifications'
-      @email_enabled     = false
-      @mailer_sender     = nil
-      @mailer            = 'ActivityNotification::Mailer'
-      @parent_mailer     = 'ActionMailer::Base'
-      @parent_controller = 'ApplicationController'
-      @opened_limit      = 10
+      @enabled            = true
+      @table_name         = 'notifications'
+      @email_enabled      = false
+      @mailer_sender      = nil
+      @mailer             = 'ActivityNotification::Mailer'
+      @parent_mailer      = 'ActionMailer::Base'
+      @parent_controller  = 'ApplicationController'
+      @opened_index_limit = 10
     end
 
   end

data/lib/activity_notification/helpers/view_helpers.rb

@@ -12,7 +12,7 @@ module ActivityNotification
     # @option options [String]         :partial_root (self.key.gsub('.', '/')) Root path of partial template
     # @option options [String]         :layout       (nil)                     Layout template name
     # @option options [String]         :layout_root  ('layouts')               Root path of layout template
-    # @option options [String]         :fallback     (nil)                     Fallback template to use when MissingTemplate is raised. Set :text to use i18n text as fallback.
+    # @option options [String, Symbol] :fallback     (nil)                     Fallback template to use when MissingTemplate is raised. Set :text to use i18n text as fallback.
     # @return [String] Rendered view or text as string
     def render_notification(notifications, options = {})
       if notifications.is_a? ActivityNotification::Notification
@@ -50,7 +50,7 @@ module ActivityNotification
       notification_index =
         case options[:index_content]
         when :simple then target.notification_index
-        when :none   then target.notifications.none
+        when :none   then []
         else              target.notification_index_with_attributes
         end
       prepare_content_for(target, notification_index, notification_options)
@@ -60,6 +60,17 @@ module ActivityNotification
     end
     alias_method :render_notifications_of, :render_notification_of
 
+    # Returns notifications_path for the target
+    #
+    # @param [Object] target Target instance
+    # @param [Hash] params Request parameters
+    # @return [String] notifications_path for the target
+    # @todo Needs any other better implementation
+    # @todo Must handle devise namespace
+    def notifications_path_for(target, params = {})
+      send("#{target.to_resource_name}_notifications_path", target, params)
+    end
+
     # Returns notification_path for the notification
     #
     # @param [Notification] notification Notification instance
@@ -93,9 +104,9 @@ module ActivityNotification
       send("open_#{notification.target.to_resource_name}_notification_path", notification.target, notification, params)
     end
 
-    # Returns open_all_notifications_path for the target of specified notification
+    # Returns open_all_notifications_path for the target
     #
-    # @param [Notification] notification Notification instance
+    # @param [Object] target Target instance
     # @param [Hash] params Request parameters
     # @return [String] open_all_notifications_path for the target
     # @todo Needs any other better implementation
@@ -104,6 +115,17 @@ module ActivityNotification
       send("open_all_#{target.to_resource_name}_notifications_path", target, params)
     end
 
+    # Returns notifications_url for the target
+    #
+    # @param [Object] target Target instance
+    # @param [Hash] params Request parameters
+    # @return [String] notifications_url for the target
+    # @todo Needs any other better implementation
+    # @todo Must handle devise namespace
+    def notifications_url_for(target, params = {})
+      send("#{target.to_resource_name}_notifications_url", target, params)
+    end
+
     # Returns notification_url for the target of specified notification
     #
     # @param [Notification] notification Notification instance

data/lib/activity_notification/mailers/helpers.rb

@@ -17,8 +17,12 @@ module ActivityNotification
           headers = headers_for(notification.key, options)
           begin
             mail headers
-          rescue ActionView::MissingTemplate
-            mail headers.merge(template_name: 'default')
+          rescue ActionView::MissingTemplate => e
+            if options[:fallback].present?
+              mail headers.merge(template_name: options[:fallback])
+            else
+              raise e
+            end
           end
         end
   
@@ -117,7 +121,7 @@ module ActivityNotification
         #           mail_subject: '...'
         #
         # If one does not exist, it fallbacks to default:
-        #   Notification for #{notification.printable_type}
+        #   Notification for #{notification.printable_notifiable_type}
         #
         # @param [String] key Key of the notification
         # @return [String] Subject of notification email
@@ -127,7 +131,7 @@ module ActivityNotification
           k.insert(1, @target.to_resource_name)
           k = k.join('.')
           I18n.t(:mail_subject, scope: k,
-            default: ["Notification of #{@notifiable.printable_type}"])
+            default: ["Notification of #{@notifiable.printable_type.downcase}"])
         end
 
     end