module ActivityNotification
  # Manages to add all required configurations to target models of notification.
  module ActsAsTarget
    extend ActiveSupport::Concern

    class_methods do
      # Adds required configurations to notifiable models.
      #
      # == Parameters:
      # * :email
      #   * Email address to send notification email.
      #     This is a necessary option when you enables email notification.
      # @example Simply use :email field
      #   # app/models/user.rb
      #   class User < ActiveRecord::Base
      #     validates :email, presence: true
      #     acts_as_target email: :email
      #   end
      #
      # * :email_allowed
      #   * Whether activity_notification sends notification email to this target.
      #     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.
      # @example Always enable email notification for this target
      #   # app/models/user.rb
      #   class User < ActiveRecord::Base
      #     acts_as_target email: :email, email_allowed: true
      #   end
      # @example Use confirmed_at of devise field to decide whether activity_notification sends notification email to this user
      #   # app/models/user.rb
      #   class User < ActiveRecord::Base
      #     acts_as_target email: :email, email_allowed: :confirmed_at
      #   end
      #
      # * :devise_resource
      #   * Integrated resource with devise authentication.
      #     This parameter is a optional since `self` is used as default value.
      #     You also have to configure routing for devise inroutes.rb
      # @example No :devise_resource is needed when notification target is the same as authenticated resource
      #   # config/routes.rb
      #   devise_for :users
      #   notify_to :users
      #
      #   # app/models/user.rb
      #   class User < ActiveRecord::Base
      #     devise :database_authenticatable, :registerable, :confirmable
      #     acts_as_target email: :email, email_allowed: :confirmed_at
      #   end
      #
      # @example Send Admin model and use associated User model with devise authentication
      #   # config/routes.rb
      #   devise_for :users
      #   notify_to :admins, with_devise: :users
      #
      #   # app/models/user.rb
      #   class User < ActiveRecord::Base
      #     devise :database_authenticatable, :registerable, :confirmable
      #   end
      #
      #   # app/models/admin.rb
      #   class Admin < ActiveRecord::Base
      #     belongs_to :user
      #     validates :user, presence: true
      #     acts_as_notification_target email: :email,
      #       email_allowed: ->(admin, key) { admin.user.confirmed_at.present? },
      #       devise_resource: :user
      #   end
      #
      # * :printable_name or :printable_notification_target_name
      #   * Printable notification target name.
      #     This parameter is a optional since `ActivityNotification::Common.printable_name` is used as default value.
      #     :printable_name is the same option as :printable_notification_target_name
      # @example Define printable name with user name of name field
      #   # app/models/user.rb
      #   class User < ActiveRecord::Base
      #     acts_as_target printable_name: :name
      #   end
      #
      # @example Define printable name with associated user name
      #   # app/models/admin.rb
      #   class Admin < ActiveRecord::Base
      #     acts_as_target printable_notification_target_name: ->(admin) { "admin (#{admin.user.name})" }
      #   end
      #
      # @param [Hash] options Options for notifiable model configuration
      # @option options [Symbol, Proc, String]  :email           (nil) Email address to send notification email
      # @option options [Symbol, Proc, Boolean] :email_allowed   (ActivityNotification.config.email_enabled) Whether activity_notification sends notification email to this target
      # @option options [Symbol, Proc, Boolean] :email_allowed   (ActivityNotification.config.email_enabled) Whether activity_notification sends batch notification email to this target
      # @option options [Symbol, Proc, Object]  :devise_resource (nil) Integrated resource with devise authentication
      # @option options [Symbol, Proc, String]  :printable_name  (ActivityNotification::Common.printable_name) Printable notification target name
      # @return [Hash] Configured parameters as target model
      def acts_as_target(options = {})
        include Target

        options[:printable_notification_target_name] ||= options.delete(:printable_name)
        options[:batch_notification_email_allowed] ||= options.delete(:batch_email_allowed)
        set_acts_as_parameters([:email, :email_allowed, :devise_resource], options, "notification_")
          .merge set_acts_as_parameters([:batch_notification_email_allowed, :printable_notification_target_name], options)
      end
      alias_method :acts_as_notification_target, :acts_as_target

      # Returns array of available target options in acts_as_target.
      # @return [Array<Symbol>] Array of available target options
      def available_target_options
        [:email, :email_allowed, :batch_email_allowed, :devise_resource, :printable_notification_target_name, :printable_name].freeze
      end
    end
  end
end