activity_notification 0.0.8 → 0.0.9

data/lib/activity_notification/config.rb

@@ -3,6 +3,7 @@ module ActivityNotification
   class Config
     attr_accessor :enabled,
                   :table_name,
+                  :email_enabled,
                   :mailer_sender,
                   :mailer,
                   :parent_mailer,
@@ -12,6 +13,7 @@ module ActivityNotification
     def initialize
       @enabled           = true
       @table_name        = "notifications"
+      @email_enabled     = false
       @mailer_sender     = nil
       @mailer            = "ActivityNotification::Mailer"
       @parent_mailer     = 'ActionMailer::Base'

data/lib/activity_notification/helpers/view_helpers.rb

@@ -41,11 +41,12 @@ module ActivityNotification
 
       if notification_index.present?
         content_for :notification_index do
+          @target = target
           begin
-            render_notifications notification_index, notification_options
-          rescue ActionView::MissingTemplate => e
+            render_notification notification_index, notification_options
+          rescue ActionView::MissingTemplate
             notification_options.delete(:target)
-            render_notifications notification_index, notification_options
+            render_notification notification_index, notification_options
           end
         end
       end
@@ -53,7 +54,7 @@ module ActivityNotification
       # Render partial index
       begin
         render options.merge(partial: partial, layout: layout, locals: locals)
-      rescue ActionView::MissingTemplate => e
+      rescue ActionView::MissingTemplate
         partial_root = "activity_notification/notifications/default"
         partial      = select_path(partial_path, partial_root)
         render options.merge(partial: partial, layout: layout, locals: locals)

data/lib/activity_notification/mailers/helpers.rb

@@ -11,7 +11,7 @@ module ActivityNotification
         headers = headers_for(notification.key, options)
         begin
           mail headers
-        rescue ActionView::MissingTemplate => e
+        rescue ActionView::MissingTemplate
           mail headers.merge(template_name: 'default')
         end
       end
@@ -28,8 +28,8 @@ module ActivityNotification
         headers = {
           subject: subject_for(key),
           to: mailer_to(@target),
-          from: mailer_sender(@target.to_resource_name),
-          reply_to: mailer_reply_to(@target.to_resource_name),
+          from: mailer_from(@notification),
+          reply_to: mailer_reply_to(@notification),
           template_path: template_paths,
           template_name: template_name(key)
         }.merge(options)
@@ -42,20 +42,20 @@ module ActivityNotification
         target.mailer_to
       end
 
-      def mailer_reply_to(target_type)
-        mailer_sender(target_type, :reply_to)
+      def mailer_reply_to(notification)
+        mailer_sender(notification, :reply_to)
       end
 
-      def mailer_from(target_type)
-        mailer_sender(target_type, :from)
+      def mailer_from(notification)
+        mailer_sender(notification, :from)
       end
 
-      def mailer_sender(target_type, sender = :from)
+      def mailer_sender(notification, sender = :from)
         default_sender = default_params[sender]
         if default_sender.present?
           default_sender.respond_to?(:to_proc) ? instance_eval(&default_sender) : default_sender
         elsif ActivityNotification.config.mailer_sender.is_a?(Proc)
-          ActivityNotification.config.mailer_sender.call(target_type)
+          ActivityNotification.config.mailer_sender.call(notification)
         else
           ActivityNotification.config.mailer_sender
         end

data/lib/activity_notification/models.rb

@@ -0,0 +1,16 @@
+require 'activity_notification/roles/acts_as_target'
+require 'activity_notification/roles/acts_as_notifiable'
+require 'activity_notification/roles/acts_as_notifier'
+
+module ActivityNotification
+  module Models
+    extend ActiveSupport::Concern
+    included do
+      include ActivityNotification::ActsAsTarget
+      include ActivityNotification::ActsAsNotifiable
+      include ActivityNotification::ActsAsNotifier
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval { include ActivityNotification::Models }

data/lib/activity_notification/models/{notifiable.rb → concerns/notifiable.rb}

@@ -4,7 +4,6 @@ module ActivityNotification
 
     included do
       include Common
-      include ActsAsNotifiable
       include ActionDispatch::Routing::PolymorphicRoutes
       include Rails.application.routes.url_helpers
       class_attribute  :_notification_targets,
@@ -21,6 +20,10 @@ module ActivityNotification
     end
     
     class_methods do
+      def available_as_notifiable?
+        true
+      end
+
       def set_notifiable_class_defaults
         self._notification_targets        = {}
         self._notification_group          = {}
@@ -55,7 +58,7 @@ module ActivityNotification
       if respond_to?(target_typed_method_name)
         send(target_typed_method_name, key)
       else
-        resolve_value(_notification_group[plural_target_type_sym])
+        resolve_value(_notification_group[plural_target_type_sym], key)
       end
     end
 
@@ -77,16 +80,20 @@ module ActivityNotification
       if respond_to?(target_typed_method_name)
         send(target_typed_method_name, key)
       else
-        resolve_value(_notifier[plural_target_type_sym])
+        resolve_value(_notifier[plural_target_type_sym], key)
       end
     end
 
     def notification_email_allowed?(target, key)
+      plural_target_type       = target.class.to_s.underscore.pluralize
       plural_target_type_sym   = target.to_resources_name.to_sym
-      if _notification_email_allowed[plural_target_type_sym]
+      target_typed_method_name = "notification_email_allowed_for_#{plural_target_type}?"
+      if respond_to?(target_typed_method_name)
+        send(target_typed_method_name, target, key)
+      elsif _notification_email_allowed[plural_target_type_sym]
         resolve_value(_notification_email_allowed[plural_target_type_sym], target, key)
       else
-        true
+        ActivityNotification.config.email_enabled
       end
     end
 
@@ -97,13 +104,11 @@ module ActivityNotification
       if respond_to?(target_typed_method_name)
         send(target_typed_method_name, key)
       elsif _notifiable_path[plural_target_type_sym]
-        resolve_value(_notifiable_path[plural_target_type_sym])
+        resolve_value(_notifiable_path[plural_target_type_sym], key)
       else
         begin
           polymorphic_path(self)
-        rescue NoMethodError => e
-          raise NotImplementedError, "You have to implement #{self.class}##{__method__}, set :notifiable_path in acts_as_notifiable or set polymorphic_path routing for #{self.class}"
-        rescue ActionController::UrlGenerationError => e
+        rescue NoMethodError, ActionController::UrlGenerationError
           raise NotImplementedError, "You have to implement #{self.class}##{__method__}, set :notifiable_path in acts_as_notifiable or set polymorphic_path routing for #{self.class}"
         end
       end
@@ -115,7 +120,7 @@ module ActivityNotification
     # TODO docs
     # overriding_notification_email_key(target, key)
 
-    # Wrapper methods of SimpleNotify class methods
+    # Wrapper methods of Notification class methods
   
     def notify(target_type, options = {})
       Notification.notify(target_type, self, options)

data/lib/activity_notification/models/{notifier.rb → concerns/notifier.rb}

@@ -7,5 +7,11 @@ module ActivityNotification
         class_name: "::ActivityNotification::Notification",
         as: :notifier
     end
+
+    class_methods do
+      def available_as_notifier?
+        true
+      end
+    end
   end
 end

data/lib/activity_notification/models/{target.rb → concerns/target.rb}

@@ -3,18 +3,22 @@ module ActivityNotification
     extend ActiveSupport::Concern
     included do
       include Common
-      include ActsAsTarget
       has_many :notifications,
         class_name: "::ActivityNotification::Notification",
         as: :target
-      class_attribute :_notification_email, :_notification_email_allowed
+      class_attribute :_notification_email, :_notification_email_allowed, :_notification_devise_resource
       set_target_class_defaults
     end
 
     class_methods do
+      def available_as_target?
+        true
+      end
+
       def set_target_class_defaults
-        self._notification_email          = nil
-        self._notification_email_allowed  = false
+        self._notification_email            = nil
+        self._notification_email_allowed    = ActivityNotification.config.email_enabled
+        self._notification_devise_resource  = ->(model) { model }
       end
     end
 
@@ -26,6 +30,17 @@ module ActivityNotification
       resolve_value(_notification_email_allowed, notifiable, key)
     end
 
+    def authenticated_with_devise?(current_resource)
+      devise_resource = resolve_value(_notification_devise_resource)
+      unless current_resource.instance_of? devise_resource.class
+        raise TypeError,
+          "Defferent type of current resource #{current_resource.class.to_s} "\
+          "with devise resource #{devise_resource.class.to_s} has been passed to #{self.class}##{__method__}. "\
+          "You have to override #{self.class}##{__method__} method or set devise_resource in acts_as_target."
+      end
+      current_resource == devise_resource
+    end
+
     def unopened_notification_count
       unopened_notification_index.count
     end
@@ -57,7 +72,7 @@ module ActivityNotification
     end
 
 
-    # Wrapper methods of SimpleNotify class methods
+    # Wrapper methods of Notification class methods
   
     def notify_to(notifiable, options = {})
       Notification.notify_to(self, notifiable, options)
@@ -67,6 +82,7 @@ module ActivityNotification
       Notification.open_all_of(self, opened_at)
     end
 
+
     # Methods to be overriden
 
     # Typical method to get notifications index
@@ -82,22 +98,23 @@ module ActivityNotification
     end
 
     def unopened_notification_index_with_attributes(limit = nil)
-      Notification.group_member_exists?(unopened_notification_index(limit)) ?
-        unopened_notification_index(limit).with_target.with_notifiable.with_group.with_notifier :
-        unopened_notification_index(limit).with_target.with_notifiable.with_notifier
+      if unopened_notification_index(limit).present?
+        Notification.group_member_exists?(unopened_notification_index(limit)) ?
+          unopened_notification_index(limit).with_target.with_notifiable.with_group.with_notifier :
+          unopened_notification_index(limit).with_target.with_notifiable.with_notifier
+      else
+        notifications.none
+      end
     end
 
     def opened_notification_index_with_attributes(limit = ActivityNotification.config.opened_limit)
-      Notification.group_member_exists?(opened_notification_index(limit)) ?
-        opened_notification_index(limit).with_target.with_notifiable.with_group.with_notifier :
-        opened_notification_index(limit).with_target.with_notifiable.with_notifier
-    end
-
-    def authenticate_with_devise?(current_resource)
-      unless current_resource.instance_of? self.class
-        raise TypeError, "Defferent type of devise resource #{current_resource.class.to_s} has been passed to #{self.class}##{__method__}. You have to override #{self.class}##{__method__} method."
+      if opened_notification_index(limit).present?
+        Notification.group_member_exists?(opened_notification_index(limit)) ?
+          opened_notification_index(limit).with_target.with_notifiable.with_group.with_notifier :
+          opened_notification_index(limit).with_target.with_notifiable.with_notifier
+      else
+        notifications.none
       end
-      current_resource == self
     end
 
   end

data/lib/activity_notification/renderable.rb

@@ -13,9 +13,10 @@ module ActivityNotification
       else
         k.insert(1, target.to_resource_name)
       end
+      k.push('text')
       k = k.join('.')
 
-      I18n.t(k, parameters.merge(params) || {})
+      I18n.t(k, (parameters.merge(params) || {}).merge(group_member_count: group_member_count))
     end
 
     # Renders notification from views.

data/lib/activity_notification/roles/acts_as_notifiable.rb

@@ -3,35 +3,50 @@ module ActivityNotification
     extend ActiveSupport::Concern
 
     class_methods do
-      # Adds required callbacks for creating and updating
-      # notifiable models.
+      # Adds required callbacks for creating and updating notifiable models.
       #
       # == Parameters:
-      # [:targets]
-      #TODO
-      def acts_as_notifiable(target_type, opts = {})
-        options = opts.clone
-        assign_globals       target_type, options
-        nil
+      # [:targets, :group, :notifier, :parameters, :email_allowed, :notifiable_path]
+      # targets:         Targets to send notification. It it set as ActiveRecord records or array of models.
+      #                  This is a 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.
+      #
+      # group:           Group unit of notifications. Notifications will be bundled by this group (and target, notifiable_type, key).
+      #                  This parameter is a optional.
+      #
+      # notifier:        Notifier of the notification.This will be stored as notifier with notification record.
+      #                  This parameter is a optional.
+      #
+      # parameters:      Parameter to add notification data. This will be stored as parameters with notification record.
+      #                  This parameter is a optional.
+      #
+      # email_allowed:   If activity_notification sends notification email to these targets.
+      #                  Specified method or symbol is expected to return true (not nil) or false (nil).
+      #                  This parameter is a optional since default value is false.
+      #                  To use notification email, email_allowed option must return true (not nil) in both of notifiable and target model.
+      #                  This can be also configured default option in initializer.
+      #
+      # notifiable_path: Path to redirect from open or move action of notification controller.
+      #                  You can use this notifiable_path as notifiable link in notification view.
+      #                  This parameter is a optional since polymorphic_path is used as default value.
+      def acts_as_notifiable(target_type, options = {})
+        include Notifiable
+        (
+          [:targets, :group, :parameters, :email_allowed].map { |key|
+            options[key] ?
+              [key, self.send("_notification_#{key}".to_sym).store(target_type.to_sym, options.delete(key))] :
+              [nil, nil]
+          }.to_h.merge [:notifier, :notifiable_path].map { |key|
+            options[key] ?
+              [key, self.send("_#{key}".to_sym).store(target_type.to_sym, options.delete(key))] :
+              [nil, nil]
+          }.to_h
+        ).delete_if { |k, v| k.nil? }
       end
 
-      def available_options
+      def available_notifiable_options
         [:targets, :group, :notifier, :parameters, :email_allowed, :notifiable_path].freeze
       end
-
-      def assign_globals(target_type, options)
-        [:targets, :group, :parameters, :email_allowed].each do |key|
-          if options[key]
-            self.send("_notification_#{key}".to_sym).store(target_type.to_sym, options.delete(key))
-          end
-        end
-        [:notifier, :notifiable_path].each do |key|
-          if options[key]
-            self.send("_#{key}".to_sym).store(target_type.to_sym, options.delete(key))
-          end
-        end
-      end
-
     end
   end
 end

data/lib/activity_notification/roles/acts_as_notifier.rb

@@ -0,0 +1,11 @@
+module ActivityNotification
+  module ActsAsNotifier
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_notifier
+        include Notifier
+      end
+    end
+  end
+end

data/lib/activity_notification/roles/acts_as_target.rb

@@ -3,27 +3,18 @@ module ActivityNotification
     extend ActiveSupport::Concern
 
     class_methods do
-      def acts_as_target(opts = {})
-        options = opts.clone
-        if options[:skip_email] == true
-          self.send("_notification_email_allowed=".to_sym, false)
-        end
-
-        assign_globals       options
-        nil
+      def acts_as_target(options = {})
+        include Target
+        available_target_options.map { |key|
+          options[key] ?
+            [key, self.send("_notification_#{key}=".to_sym, options.delete(key))] :
+            [nil, nil]
+        }.to_h.delete_if { |k, v| k.nil? }
       end
       alias_method :acts_as_notification_target, :acts_as_target
 
-      def available_options
-        [:skip_email, :email, :email_allowed].freeze
-      end
-
-      def assign_globals(options)
-        [:email, :email_allowed].each do |key|
-          if options[key]
-            self.send("_notification_#{key}=".to_sym, options.delete(key))
-          end
-        end
+      def available_target_options
+        [:email, :email_allowed, :devise_resource].freeze
       end
     end
   end

data/lib/activity_notification/version.rb

@@ -1,3 +1,3 @@
 module ActivityNotification
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/generators/activity_notification/{migration → active_record}/migration_generator.rb

@@ -6,11 +6,12 @@ module ActivityNotification
     class MigrationGenerator < ActiveRecord::Generators::Base
       source_root File.expand_path("../../../templates/active_record", __FILE__)
 
-      argument :name, type: :string, default: 'create_notifications'
+      argument :name, type: :string, default: 'CreateNotifications'
 
-      # Create migration in project's folder
-      def generate_files
-        migration_template 'migration.rb', "db/migrate/#{name}.rb"
+      # Create migration files in application directory
+      def create_migrations
+        @migration_name = name
+        migration_template 'migration.rb', "db/migrate/#{name.underscore}.rb"
       end
     end
   end