activity_notification 0.0.8

data/lib/activity_notification/roles/acts_as_target.rb

@@ -0,0 +1,30 @@
+module ActivityNotification
+  module ActsAsTarget
+    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
+      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
+      end
+    end
+  end
+end

data/lib/activity_notification/version.rb

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

data/lib/generators/activity_notification/controllers_generator.rb

@@ -0,0 +1,44 @@
+require 'rails/generators/base'
+
+module ActivityNotification
+  module Generators
+    class ControllersGenerator < Rails::Generators::Base
+      CONTROLLERS = %w(notifications notifications_with_devise).freeze
+
+      desc <<-DESC.strip_heredoc
+        Create inherited ActivityNotification controllers in your app/controllers folder.
+
+        Use -c to specify which controller you want to overwrite.
+        If you do no specify a controller, all controllers will be created.
+        For example:
+
+          rails generate activity_notification:controllers users -c=notifications
+
+        This will create a controller class at app/controllers/users/notifications_controller.rb like this:
+
+          class Users::NotificationsController < ActivityNotification::NotificationsController
+            content...
+          end
+      DESC
+
+      source_root File.expand_path("../../templates/controllers", __FILE__)
+      argument :target, required: true,
+        desc: "The target to create controllers in, e.g. users, admins"
+      class_option :controllers, aliases: "-c", type: :array,
+        desc: "Select specific controllers to generate (#{CONTROLLERS.join(', ')})"
+
+      def create_controllers
+        @target_prefix = target.blank? ? '' : (target.camelize + '::')
+        controllers = options[:controllers] || CONTROLLERS
+        controllers.each do |name|
+          template "#{name}_controller.rb",
+                   "app/controllers/#{target}/#{name}_controller.rb"
+        end
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/activity_notification/install_generator.rb

@@ -0,0 +1,45 @@
+require 'rails/generators/base'
+require 'securerandom'
+
+module ActivityNotification
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+``
+      desc "Creates a ActivityNotification initializer and copy locale files to your application."
+      class_option :orm
+
+      def copy_initializer
+        
+        #TODO suport other orm e.g. mongoid
+        unless options[:orm] == :active_record
+          raise MissingORMError, <<-ERROR.strip_heredoc
+          Currently ActivityNotification is only supported with Active Record ORM.
+
+          Be sure to have an Active Record ORM loaded in your
+          app or configure your own at `config/application.rb`.
+
+            config.generators do |g|
+              g.orm :active_record
+            end
+          ERROR
+        end
+
+        template "activity_notification.rb", "config/initializers/activity_notification.rb"
+      end
+
+      def copy_locale
+        copy_file "../../../config/locales/en.yml", "config/locales/activity_notification.en.yml"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+
+      def rails_4?
+        Rails::VERSION::MAJOR == 4
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'rails/generators/active_record'
+
+module ActivityNotification
+  module Generators
+    # Migration generator that creates migration file from template
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../../../templates/active_record", __FILE__)
+
+      argument :name, type: :string, default: 'create_notifications'
+
+      # Create migration in project's folder
+      def generate_files
+        migration_template 'migration.rb', "db/migrate/#{name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/activity_notification/notification/notification_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/active_record'
+
+module ActivityNotification
+  module Generators
+    # Notification generator that creates notification model file from template
+    class NotificationGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../../../templates/notification", __FILE__)
+
+      argument :name, type: :string, default: 'notification'
+
+      # Create model in project's folder
+      def generate_files
+        copy_file 'notification.rb', "app/models/#{name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/activity_notification/views_generator.rb

@@ -0,0 +1,44 @@
+require 'rails/generators/base'
+
+module ActivityNotification
+  module Generators
+    # Include this module in your generator to generate ActivityNotification views.
+    # `copy_views` is the main method and by default copies all views
+    # with forms.
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../app/views/activity_notification", __FILE__)
+      desc "Copies default ActivityNotification views to your application."
+
+      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)"
+      public_task :copy_views
+
+      def copy_views
+        if options[:views]
+          options[:views].each do |directory|
+            view_directory directory.to_sym
+          end
+        else
+          view_directory :notifications
+          view_directory :mailer
+        end
+      end
+
+      protected
+
+      def view_directory(name, _target_path = nil)
+        directory "#{name.to_s}/default", _target_path || "#{target_path}/#{name}/#{plural_target || :default}"
+      end
+
+      def target_path
+        @target_path ||= "app/views/activity_notification"
+      end
+
+      def plural_target
+        @plural_target ||= target.presence && target.to_s.underscore.pluralize
+      end
+    end
+
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,53 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Ensure you have defined default url options in your environments files. Here
+     is an example of default_url_options appropriate for a development environment
+     in config/environments/development.rb:
+
+       config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+
+     In production, :host should be set to the actual host of your application.
+
+  2. Setup your target model (e.g. app/models/user.rb)
+
+   - Add including statement and acts_as_target definition to your target model
+
+       include ActivityNotification::Target
+       acts_as_target email: :email, email_allowed: :confirmed_at
+
+   - Add notification routing to config/routes.rb
+
+       (simply)      notify_to :users
+       (with devise) notify_to :users, with_devise: :users
+
+   - You can override several methods in your target model
+
+       e.g. notification_index, notification_email_allowed?
+
+  3. Setup your notifiable model (e.g. app/models/comment.rb)
+
+    - Add including statement and acts_as_notifiable definition to your notifiable model
+     
+       include ActivityNotification::Notifiable
+       acts_as_notifiable :users,
+         targets: :custom_notification_users,
+         group: :article,
+         notifier: :user,
+         email_allowed: :custom_notification_email_to_users_allowed?,
+         notifiable_path: :custom_notifiable_path
+
+   - You can override several methods in your notifiable model
+
+       e.g. notifiable_path, notification_email_allowed?
+
+  4. You can copy ActivityNotification views (for customization) to your app by running:
+
+       rails g activity_notification:views
+
+  5. You can customize locale file which is generated as following file:
+
+       config/locals/activity_notification.en.yml
+
+===============================================================================

data/lib/generators/templates/active_record/migration.rb

@@ -0,0 +1,18 @@
+# Migration responsible for creating a table with notifications
+class CreateNotifications < ActiveRecord::Migration
+  # Create table
+  def change
+    create_table :notifications do |t|
+      t.belongs_to :target,     polymorphic: true, index: true, null: false
+      t.belongs_to :notifiable, polymorphic: true, index: true, null: false
+      t.string     :key                                       , null: false
+      t.belongs_to :group,      polymorphic: true, index: true
+      t.integer    :group_owner_id               , index: true
+      t.belongs_to :notifier,   polymorphic: true, index: true
+      t.text       :parameters
+      t.datetime   :opened_at
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/templates/activity_notification.rb

@@ -0,0 +1,18 @@
+ActivityNotification.configure do |config|
+
+  # Table name to store notification data
+  config.table_name = "notifications"
+
+  # ==> Mailer Configuration
+  # 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'
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = "ActivityNotification::Mailer"
+
+  # Configure the parent class responsible to send e-mails.
+  # config.parent_mailer = 'ActionMailer::Base'
+    
+  config.opened_limit = 10
+end

data/lib/generators/templates/controllers/README

@@ -0,0 +1,13 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  Ensure you have overridden routes for generated controllers in your routes.rb.
+  For example:
+
+    Rails.application.routes.draw do
+      notify_to :users,                       controllers: 'users/notifications'
+      notify_to :admins, with_devise: :users, controllers: 'admins/notifications_with_devise'
+    end
+
+===============================================================================

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

@@ -0,0 +1,66 @@
+class <%= @target_prefix %>NotificationsController < ActivityNotification::NotificationsController
+  # GET /:target_type/:target_id/notifcations
+  # def index
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/notifcations/open_all
+  # def open_all
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/notifcations/:id
+  # def show
+  #   super
+  # end
+
+  # DELETE /:target_type/:target_id/notifcations/:id
+  # def destroy
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/notifcations/:id/open
+  # def open
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/notifcations/: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
+  #   super
+  # end
+
+  # protected
+
+  # def set_target
+  #   super
+  # end
+
+  # def set_notification
+  #   super
+  # end
+
+  # def load_notification_index(filter, limit)
+  #   super(filter, limit)
+  # end
+
+  # def set_view_prefixes
+  #   super
+  # end
+
+  # def return_back_or_ajax(filter, limit)
+  #   super(filter, limit)
+  # end
+end

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

@@ -0,0 +1,74 @@
+class <%= @target_prefix %>NotificationsWithDeviseController < ActivityNotification::NotificationsWithDeviseController
+  # GET /:target_type/:target_id/notifcations
+  # def index
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/notifcations/open_all
+  # def open_all
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/notifcations/:id
+  # def show
+  #   super
+  # end
+
+  # DELETE /:target_type/:target_id/notifcations/:id
+  # def destroy
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/notifcations/:id/open
+  # def open
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/notifcations/: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
+  #   super
+  # end
+
+  # protected
+
+  # def set_target
+  #   super
+  # end
+
+  # def set_notification
+  #   super
+  # end
+
+  # def load_notification_index(filter, limit)
+  #   super(filter, limit)
+  # end
+
+  # def set_view_prefixes
+  #   super
+  # end
+
+  # def return_back_or_ajax(filter, limit)
+  #   super(filter, limit)
+  # end
+
+  # def authenticate_devise_resource!
+  #   super
+  # end
+
+  # def authenticate_target!
+  #   super
+  # end
+end