activity_notification 1.0.2 → 1.1.0

data/lib/generators/activity_notification/install_generator.rb

@@ -1,5 +1,4 @@
 require 'rails/generators/base'
-require 'securerandom'
 
 module ActivityNotification
   module Generators #:nodoc:

data/lib/generators/activity_notification/migration/migration_generator.rb

@@ -6,13 +6,19 @@ module ActivityNotification
     # @example Run migration generator
     #   rails generate activity_notification:migration
     class MigrationGenerator < ActiveRecord::Generators::Base
-      source_root File.expand_path("../../../templates/active_record", __FILE__)
+      MIGRATION_TABLES = ['notifications', 'subscriptions'].freeze
 
-      argument :name, type: :string, default: 'CreateNotifications'
+      source_root File.expand_path("../../../templates/migrations", __FILE__)
+
+      argument :name, type: :string, default: 'CreateActivityNotificationTables',
+        desc: "The migration name to create tables"
+      class_option :tables, aliases: "-t", type: :array,
+        desc: "Select specific tables to generate (#{MIGRATION_TABLES.join(', ')})"
 
       # Create migration files in application directory
       def create_migrations
         @migration_name = name
+        @migration_tables = options[:tables] || MIGRATION_TABLES
         migration_template 'migration.rb', "db/migrate/#{name.underscore}.rb"
       end
     end

data/lib/generators/activity_notification/models_generator.rb

@@ -0,0 +1,53 @@
+require 'rails/generators/base'
+
+module ActivityNotification
+  module Generators
+    # Notification generator to create customizable notification model from templates.
+    # @example Run notification generator to create customizable notification model
+    #   rails generate activity_notification:models users
+    class ModelsGenerator < Rails::Generators::Base
+      MODELS = ['notification', 'subscription'].freeze
+
+      desc <<-DESC.strip_heredoc
+        Create inherited ActivityNotification models in your app/models folder.
+
+        Use -m to specify which model you want to overwrite.
+        If you do no specify a model, all models will be created.
+        For example:
+
+          rails generate activity_notification:models users -m notification
+
+        This will create a model class at app/models/users/notification.rb like this:
+
+          class Users::Notification < ActivityNotification::Notification
+            content...
+          end
+      DESC
+
+      source_root File.expand_path("../../templates/models", __FILE__)
+      argument :target, required: true,
+        desc: "The target to create models in, e.g. users, admins"
+      class_option :models, aliases: "-m", type: :array,
+        desc: "Select specific models to generate (#{MODELS.join(', ')})"
+      class_option :names, aliases: "-n", type: :array,
+        desc: "Select model names to generate (#{MODELS.join(', ')})"
+
+      # Create notification model in application directory
+      def create_models
+        @target_prefix = target.blank? ? '' : (target.camelize + '::')
+        models      = options[:models] || MODELS
+        model_names = options[:names]  || MODELS
+        models.zip(model_names).each do |original_name, new_name|
+          @model_name = new_name.camelize
+          template "#{original_name}.rb",
+                   "app/models/#{target}/#{@model_name.underscore}.rb"
+        end
+      end
+
+      # Shows readme to console
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/activity_notification/views_generator.rb

@@ -14,7 +14,7 @@ module ActivityNotification
     # @example Run view generator to create only notification email views
     #   rails generate activity_notification:views -v mailer
     class ViewsGenerator < Rails::Generators::Base
-      VIEWS = [:notifications, :mailer].freeze
+      VIEWS = [:notifications, :mailer, :subscriptions].freeze
 
       source_root File.expand_path("../../../../app/views/activity_notification", __FILE__)
       desc "Copies default ActivityNotification views to your application."
@@ -22,7 +22,7 @@ module ActivityNotification
       argument :target, required: false, default: nil,
         desc: "The target to copy views to"
       class_option :views, aliases: "-v", type: :array,
-        desc: "Select specific view directories to generate (notifications, mailer)"
+        desc: "Select specific view directories to generate (notifications, mailer, subscriptions)"
       public_task :copy_views
 
       # Copies view files in application directory
@@ -37,15 +37,15 @@ module ActivityNotification
 
         # Copies view files to target directory
         # @api protected
-        # @param [String] name Set name of views (notifications or mailer)
-        # @param [String] _target_path Target path to create views
-        def view_directory(name, _target_path = nil)
-          directory "#{name.to_s}/default", _target_path || "#{target_path}/#{name}/#{plural_target || :default}"
+        # @param [String] name             Set name of views (notifications or mailer)
+        # @param [String] view_target_path Target path to create views
+        def view_directory(name, view_target_path = nil)
+          directory "#{name}/default", view_target_path || "#{target_path}/#{name}/#{plural_target || :default}"
         end
   
         # Gets target_path from an argument or default value
         # @api protected
-        # @return [String ] target_path from an argument or default value
+        # @return [String] target_path from an argument or default value
         def target_path
           @target_path ||= "app/views/activity_notification"
         end

data/lib/generators/templates/activity_notification.rb

@@ -5,13 +5,27 @@ ActivityNotification.configure do |config|
   config.enabled = true
 
   # Configure table name to store notification data
-  config.table_name = "notifications"
+  config.notification_table_name = "notifications"
 
-  # Configure if email notification is enabled as default
+  # Configure table name to store subscription data
+  config.subscription_table_name = "subscriptions"
+
+  # Configure if email notification is enabled as default.
   # Note that you can configure them for each model by acts_as roles.
-  # Set true when you want to turn on email notifications as default
+  # Set true when you want to turn on email notifications as default.
   config.email_enabled = false
 
+  # Configure if subscription is managed.
+  # Note that this parameter must be true when you want use subscription management.
+  # However, you can also configure them for each model by acts_as roles.
+  # Set true when you want to turn on subscription management as default.
+  config.subscription_enabled = false
+
+  # Configure default subscription value to use when the subscription record does not configured.
+  # Note that you can configure them for each method calling as default argument.
+  # Set false when you want to unsubscribe to any notifications as default.
+  config.subscribe_as_default = true
+
   # Configure the e-mail address which will be shown in ActivityNotification::Mailer,
   # note that it will be overwritten if you use your own mailer class with default "from" parameter.
   config.mailer_sender = 'please-change-me-at-config-initializers-activity_notification@example.com'

data/lib/generators/templates/controllers/notifications_controller.rb

@@ -1,41 +1,34 @@
 class <%= @target_prefix %>NotificationsController < ActivityNotification::NotificationsController
-  # GET /:target_type/:target_id/notifcations
+  # GET /:target_type/:target_id/notifications
   # def index
   #   super
   # end
 
-  # POST /:target_type/:target_id/notifcations/open_all
+  # POST /:target_type/:target_id/notifications/open_all
   # def open_all
   #   super
   # end
 
-  # GET /:target_type/:target_id/notifcations/:id
+  # GET /:target_type/:target_id/notifications/:id
   # def show
   #   super
   # end
 
-  # DELETE /:target_type/:target_id/notifcations/:id
+  # DELETE /:target_type/:target_id/notifications/:id
   # def destroy
   #   super
   # end
 
-  # POST /:target_type/:target_id/notifcations/:id/open
+  # POST /:target_type/:target_id/notifications/:id/open
   # def open
   #   super
   # end
 
-  # GET /:target_type/:target_id/notifcations/:id/move
+  # GET /:target_type/:target_id/notifications/:id/move
   # def move
   #   super
   # end
 
-  # No action routing
-  # This method is called from target_view_path method
-  # This method can be overriden
-  # def controller_path
-  #   super
-  # end
-
   # No action routing
   # This method needs to be public since it is called from view helper
   # def target_view_path
@@ -52,15 +45,23 @@ class <%= @target_prefix %>NotificationsController < ActivityNotification::Notif
   #   super
   # end
 
-  # def load_notification_index(filter, limit)
-  #   super(filter, limit)
+  # def set_index_options
+  #   super
+  # end
+
+  # def load_index
+  #   super
+  # end
+
+  # def controller_path
+  #   super
   # end
 
   # def set_view_prefixes
   #   super
   # end
 
-  # def return_back_or_ajax(filter, limit)
-  #   super(filter, limit)
+  # def return_back_or_ajax
+  #   super
   # end
 end

data/lib/generators/templates/controllers/notifications_with_devise_controller.rb

@@ -1,41 +1,34 @@
 class <%= @target_prefix %>NotificationsWithDeviseController < ActivityNotification::NotificationsWithDeviseController
-  # GET /:target_type/:target_id/notifcations
+  # GET /:target_type/:target_id/notifications
   # def index
   #   super
   # end
 
-  # POST /:target_type/:target_id/notifcations/open_all
+  # POST /:target_type/:target_id/notifications/open_all
   # def open_all
   #   super
   # end
 
-  # GET /:target_type/:target_id/notifcations/:id
+  # GET /:target_type/:target_id/notifications/:id
   # def show
   #   super
   # end
 
-  # DELETE /:target_type/:target_id/notifcations/:id
+  # DELETE /:target_type/:target_id/notifications/:id
   # def destroy
   #   super
   # end
 
-  # POST /:target_type/:target_id/notifcations/:id/open
+  # POST /:target_type/:target_id/notifications/:id/open
   # def open
   #   super
   # end
 
-  # GET /:target_type/:target_id/notifcations/:id/move
+  # GET /:target_type/:target_id/notifications/:id/move
   # def move
   #   super
   # end
 
-  # No action routing
-  # This method is called from target_view_path method
-  # This method can be overriden
-  # def controller_path
-  #   super
-  # end
-
   # No action routing
   # This method needs to be public since it is called from view helper
   # def target_view_path
@@ -52,16 +45,24 @@ class <%= @target_prefix %>NotificationsWithDeviseController < ActivityNotificat
   #   super
   # end
 
-  # def load_notification_index(filter, limit)
-  #   super(filter, limit)
+  # def set_index_options
+  #   super
+  # end
+
+  # def load_index
+  #   super
+  # end
+
+  # def controller_path
+  #   super
   # end
 
   # def set_view_prefixes
   #   super
   # end
 
-  # def return_back_or_ajax(filter, limit)
-  #   super(filter, limit)
+  # def return_back_or_ajax
+  #   super
   # end
 
   # def authenticate_devise_resource!

data/lib/generators/templates/controllers/subscriptions_controller.rb

@@ -0,0 +1,79 @@
+class <%= @target_prefix %>SubscriptionsController < ActivityNotification::SubscriptionsController
+  # GET /:target_type/:target_id/subscriptions
+  # def index
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions
+  # def create
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/subscriptions/:id
+  # def show
+  #   super
+  # end
+
+  # DELETE /:target_type/:target_id/subscriptions/:id
+  # def destroy
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/subscribe
+  # def subscribe
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe
+  # def unsubscribe
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/subscribe_to_email
+  # def subscribe_to_email
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
+  # def unsubscribe_to_email
+  #   super
+  # end
+
+  # protected
+
+  # def set_target
+  #   super
+  # end
+
+  # def set_subscription
+  #   super
+  # end
+
+  # def subscription_params
+  #   super
+  # end
+
+  # def set_index_options
+  #   super
+  # end
+
+  # def load_index
+  #   super
+  # end
+
+  # def controller_path
+  #   super
+  # end
+
+  # def target_view_path
+  #   super
+  # end
+
+  # def set_view_prefixes
+  #   super
+  # end
+
+  # def return_back_or_ajax
+  #   super
+  # end
+end

data/lib/generators/templates/controllers/subscriptions_with_devise_controller.rb

@@ -0,0 +1,87 @@
+class <%= @target_prefix %>SubscriptionsWithDeviseController < ActivityNotification::SubscriptionsWithDeviseController
+  # GET /:target_type/:target_id/subscriptions
+  # def index
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions
+  # def create
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/subscriptions/:id
+  # def show
+  #   super
+  # end
+
+  # DELETE /:target_type/:target_id/subscriptions/:id
+  # def destroy
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/subscribe
+  # def subscribe
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe
+  # def unsubscribe
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/subscribe_to_email
+  # def subscribe_to_email
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
+  # def unsubscribe_to_email
+  #   super
+  # end
+
+  # protected
+
+  # def set_target
+  #   super
+  # end
+
+  # def set_subscription
+  #   super
+  # end
+
+  # def subscription_params
+  #   super
+  # end
+
+  # def set_index_options
+  #   super
+  # end
+
+  # def load_index
+  #   super
+  # end
+
+  # def controller_path
+  #   super
+  # end
+
+  # def target_view_path
+  #   super
+  # end
+
+  # def set_view_prefixes
+  #   super
+  # end
+
+  # def return_back_or_ajax
+  #   super
+  # end
+
+  # def authenticate_devise_resource!
+  #   super
+  # end
+
+  # def authenticate_target!
+  #   super
+  # end
+end