notifications 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6c1411a1372418b519675ff4778fc9b6ce5667e
-  data.tar.gz: 5d88e4b9ed4a7abd5ea0dc5af06a72df5e1ec196
+  metadata.gz: da3d093b0b1103eaf30087ae164dffd0c081ab08
+  data.tar.gz: f87db9bac406ca6547a5a24e7eb5580b3d4bc97f
 SHA512:
-  metadata.gz: be0439a6e8a0dcc21cc045a67719f51038b2d8964d7800fc146c811f5ef3d5d12e45e502e98606d1bc22d7ee4b53fe5786ccc8e680cd73aa23569295256b8fe9
-  data.tar.gz: 335956df1f27ed9f3cf279735ff9ad94eb0b883cc89b9968299f6daa8ef6e3b3c0178f845a92784ebaa6e8156695165f74f8f7e1b3da05818d463c410abb17d3
+  metadata.gz: b09f5e76bc019607928a8360810f4da6fbd3730aa29adf9dc9fb344d5ae9cbf120bc454bb803064c5ebd71fc947fadd28f834093e59190da8c246d803680b2e8
+  data.tar.gz: d99136bd5ccd35afc9771beec8d342c75ba6423e53ebcffc5ef3456c8dfa0939f5fe7ad8d6476534277daa8f625e7a41d3fe9e6112da37fb4b72dca840681ee2

data/README.md

@@ -2,6 +2,75 @@
 
 Rails mountable Notification for any applications.
 
+[![Gem Version](https://badge.fury.io/rb/notifications.svg)](https://badge.fury.io/rb/notifications) [![Build Status](https://travis-ci.org/rails-engine/notifications.svg)](https://travis-ci.org/rails-engine/notifications) [![Code Climate](https://codeclimate.com/github/rails-engine/notifications/badges/gpa.svg)](https://codeclimate.com/github/rails-engine/notifications) [![codecov.io](https://codecov.io/github/rails-engine/notifications/coverage.svg?branch=master)](https://codecov.io/github/rails-engine/notifications?branch=master) [![](http://inch-ci.org/github/rails-engine/notifications.svg?branch=master)](http://inch-ci.org/github/rails-engine/notifications?branch=master)
+
+## Installation
+
+```ruby
+# Gemfile
+gem 'notifications'
+```
+
+And then run `bundle install`.
+
+Now you have notifications generator in Rails application:
+
+```bash
+$ rails g notifications:install
+```
+
+And, you can generate views, controller if you need custom them:
+
+```bash
+$ rails g notifications:views
+$ rails g notifications:controllers
+```
+
+## Usage
+
+### Create a Notification
+
+```ruby
+class User
+  def follow(user)
+    Notification.create(notify_type: 'follow', actor: self, user: user)
+  end
+end
+
+class Comment
+  belongs_to :post
+  belongs_user :user
+
+  after_commit :create_notifications, on: [:create]
+  def create_notifications
+    Notification.create(
+      notify_type: 'comment',
+      actor: self.user,
+      user: self.post.user,
+      target: self)
+  end
+end
+```
+
+Get user unread count:
+
+```rb
+count = Notification.unread_count(current_user)
+```
+
+### Write your custom Notification partial view for notify_types:
+
+TODO...
+
+### Mark notifications as read
+
+You can set multiple Notification as read by:
+
+```ruby
+notification_ids = [1, 2 ...]
+Notification.read!(current_user.id, notification_ids)
+```
+
 ## Contributing
 Contribution directions go here.
 

data/Rakefile

@@ -4,24 +4,11 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Notifications'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
 APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
 
+load 'rails/tasks/engine.rake'
 load 'rails/tasks/statistics.rake'
 
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -33,5 +20,5 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
+task 'assets:precompile' => 'app:assets:precompile'
 task default: :test

data/app/controllers/notifications/application_controller.rb

@@ -1,5 +1,18 @@
 module Notifications
-  class ApplicationController < ActionController::Base
-    protect_from_forgery with: :exception
+  class ApplicationController < ::ApplicationController
+    helper_method :current_user, :owner?, :admin?
+
+    alias_method :origin_current_user, Notifications.config.current_user_method.to_sym
+    alias_method :origin_authenticate_user!, Notifications.config.authenticate_user_method.to_sym
+
+    before_action :authenticate_user!
+
+    def current_user
+      origin_current_user
+    end
+
+    def authenticate_user!
+      origin_authenticate_user!
+    end
   end
 end

data/app/controllers/notifications/notifications_controller.rb

@@ -0,0 +1,18 @@
+module Notifications
+  class NotificationsController < Notifications::ApplicationController
+    def index
+      @notifications = current_user.notifications.includes(:actor).order('id desc')
+
+      unread_ids = []
+      @notifications.each do |n|
+        unread_ids << n.id unless n.read?
+      end
+      # Notification.read!(unread_ids)
+    end
+
+    def clean
+      Notification.where(user_id: current_user.id).delete_all
+      redirect_to notifications_path
+    end
+  end
+end

data/app/models/notification.rb

@@ -0,0 +1,6 @@
+# Auto generate with notifications gem.
+class Notification < ActiveRecord::Base
+  include Notifications::Model
+
+  # Write your custom methods...
+end

data/app/views/notifications/notifications/_notification.html.erb

@@ -0,0 +1,13 @@
+<div id="notification-<%= notification.id %>"
+     data-id="<%= notification.id %>"
+     class="media notification<%= ' unread' if !notification.read? %>">
+  <div class="media-left">
+    <%= link_to image_tag(notification.actor_avatar_url), notification.actor_profile_url, title: notification.actor_name, class: 'user-avatar' %>
+  </div>
+  <div class="media-body">
+    <%= render partial: "/notifications/#{notification.notify_type}", locals: { notification: notification } %>
+  </div>
+  <div class="media-right">
+    <%= l notification.created_at, format: :short %>
+  </div>
+</div>

data/app/views/notifications/notifications/index.html.erb

@@ -0,0 +1,12 @@
+<div class="notifications row">
+  <div class="heading clearfix">
+    <%= t('notifications.all_notifications') %>
+
+    <span class="pull-xs-right">
+      <%= link_to t('notifications.clean_all'), notifications.clean_notifications_path, class: 'btn btn-danger', method: 'delete' %>
+    </span>
+  </div>
+  <div class="list">
+    <%= render @notifications %>
+  </div>
+</div>

data/config/initializers/notifications.rb

@@ -0,0 +1,22 @@
+# notifications Config
+Notifications.configure do
+  # Class name of you User model, default: 'User'
+  # self.user_class = 'User'
+
+  # Method of user name in User model, default: 'name'
+  # self.user_name_method = 'name'
+
+  # Method of user avatar in User model, default: nil
+  # self.user_avatar_url_method = nil
+
+  # Method name of user profile page path, in User model, default: 'profile_url'
+  # self.user_profile_url_method = 'profile_url'
+
+  # authenticate_user method in your Controller, default: 'authenticate_user!'
+  # If you use Devise, authenticate_user! is correct
+  # self.authenticate_user_method = 'authenticate_user!'
+
+  # current_user method name in your Controller, default: 'current_user'
+  # If you use Devise, current_user is correct
+  # self.current_user_method = 'current_user'
+end

data/config/locales/notifications.en.yml

@@ -0,0 +1,4 @@
+en:
+  notifications:
+    all_notifications: 'All Notifications'
+    clean_all: 'Clean All'

data/config/routes.rb

@@ -1,2 +1,7 @@
 Notifications::Engine.routes.draw do
+  resources :notifications, path: '' do
+    collection do
+      delete :clean
+    end
+  end
 end

data/db/migrate/20160328045436_create_notifications.rb

@@ -0,0 +1,21 @@
+class CreateNotifications < ActiveRecord::Migration
+  def change
+    create_table :notifications do |t|
+      t.integer :user_id, null: false
+      t.integer :actor_id
+      t.string :notify_type, null: false
+      t.string :target_type
+      t.integer :target_id
+      t.string :second_target_type
+      t.integer :second_target_id
+      t.string :third_target_type
+      t.integer :third_target_id
+      t.datetime :read_at
+
+      t.timestamps null: false
+    end
+
+    add_index :notifications, [:user_id, :notify_type]
+    add_index :notifications, [:user_id]
+  end
+end

data/lib/generators/notifications/controllers_generator.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+require 'rails/generators'
+module Notifications
+  module Generators
+    class ControllersGenerator < Rails::Generators::Base #:nodoc:
+      source_root File.expand_path("../../../../app/controllers", __FILE__)
+      desc "Used to copy Notifications's controllers to your application's controllers."
+
+      def copy_controllers
+        %w(nodes replies topics).each do |fname|
+          path = "#{Rails.root}/app/controllers/notifications/#{fname}_controller.rb"
+          if File.exists?(path)
+            puts "Skipping notifications/#{fname}_controller.rb creation, as file already exists!"
+          else
+            puts "Adding controller (notifications/#{fname}_controller.rb)..."
+            template "notifications/#{fname}_controller.rb", path
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/notifications/i18n_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+module Notifications
+  module Generators
+    class I18nGenerator < Rails::Generators::Base
+      desc "Create Notifications's default I18n files"
+      source_root File.expand_path("../../../../", __FILE__)
+
+      def add_locales
+        %w(en.yml zh-CN.yml).each do |fname|
+          path = "#{Rails.root}/config/locales/notifications.#{fname}"
+          if File.exists?(path)
+            puts "Skipping config/locales/notifications.#{fname} creation, as file already exists!"
+          else
+            puts "Adding locale (config/locales/notifications.#{fname})..."
+            template "config/locales/notifications.#{fname}", path
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/notifications/install_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators'
+module Notifications
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Create Notifications's base files"
+      source_root File.expand_path("../../../../", __FILE__)
+
+      def add_initializer
+        path = "#{Rails.root}/config/initializers/notifications.rb"
+        if File.exists?(path)
+          puts "Skipping config/initializers/notifications.rb creation, as file already exists!"
+        else
+          puts "Adding Homeland initializer (config/initializers/notifications.rb)..."
+          template "config/initializers/notifications.rb", path
+        end
+      end
+
+      def add_models
+        path = "#{Rails.root}/app/models/notification.rb"
+        if File.exists?(path)
+          puts "Skipping notification.rb creation, as file already exists!"
+        else
+          puts "Adding model (notification.rb)..."
+          template "app/models/notification.rb", path
+        end
+      end
+
+      def add_migrations
+        exec("rails notifications:install:migrations")
+      end
+    end
+  end
+end

data/lib/generators/notifications/views_generator.rb

@@ -0,0 +1,15 @@
+# coding: utf-8
+require 'rails/generators'
+module Notifications
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base #:nodoc:
+      source_root File.expand_path("../../../../app/views", __FILE__)
+      desc "Used to copy Notifications's views to your application's views."
+
+      def copy_views
+        directory 'homeland', "app/views/notifications"
+        directory 'layouts/notifications', "app/views/layouts/notifications"
+      end
+    end
+  end
+end

data/lib/notifications.rb

@@ -1,5 +1,25 @@
+require "notifications/model"
 require "notifications/engine"
+require "notifications/configuration"
+require "notifications/version"
 
 module Notifications
-  # Your code goes here...
+  class << self
+    def config
+      return @config if defined?(@config)
+      @config = Configuration.new
+      @config.per_page = 32
+      @config.user_class = 'User'
+      @config.user_name_method = 'name'
+      @config.user_avatar_url_method = nil
+      @config.user_profile_url_method = 'profile_url'
+      @config.authenticate_user_method = 'authenticate_user!'
+      @config.current_user_method = 'current_user'
+      @config
+    end
+
+    def configure(&block)
+      config.instance_exec(&block)
+    end
+  end
 end

data/lib/notifications/configuration.rb

@@ -0,0 +1,46 @@
+module Notifications
+  class Configuration
+    # class name of you User model, default: 'User'
+    attr_accessor :user_class
+
+    # method of user name in User model, default: 'name'
+    attr_accessor :user_name_method
+
+    # method of user avatar in User model, default: nil
+    #
+    # We suggest you give image size more than 48x48 px.
+    #
+    # Example:
+    #
+    # class User
+    #   def avatar_url
+    #     self.avatar.url('48x48')
+    #   end
+    # end
+    #
+    # config.user_avatar_url_method = :avatar_url
+    #
+    attr_accessor :user_avatar_url_method
+
+    # method name of user profile page path, in User model, default: 'profile_url'
+    # Example:
+    #
+    # class User
+    #   def profile_url
+    #     "http://www.host.com/u/#{self.username}"
+    #   end
+    # end
+    #
+    # config.user_profile_url_method = 'profile_url'
+    attr_accessor :user_profile_url_method
+
+    # current_user method name in your Controller, default: 'current_user'
+    attr_accessor :current_user_method
+
+    # authenticate_user method in your Controller, default: 'authenticate_user!'
+    attr_accessor :authenticate_user_method
+
+    # pagination size, default: 32
+    attr_accessor :per_page
+  end
+end

data/lib/notifications/model.rb

@@ -0,0 +1,49 @@
+module Notifications
+  module Model
+    extend ActiveSupport::Concern
+
+    DEFAULT_AVATAR = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAADwCAMAAAAJixmgAAAAFVBMVEWkpKSnp6eqqqq3t7fS0tLV1dXZ2dmshcKEAAAAtklEQVR4Ae3XsRGAAAjAQFRk/5HtqaTz5H+DlInvAQAAAAAAAAAAAAAAAAAAAACymiveO6o7BQsWLFiwYMGCBS8PFixYsGDBggULFixYsGDBggULFixYsGDBggULFixYsGDBc4IFCxYsWLBgwYIFC14ZfOeAPRQ8IliwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQv+JQAAAAAAAAAAAAAAAAAAAOAB4KJfdHmj+kwAAAAASUVORK5CYII='
+
+    included do
+      belongs_to :actor, class_name: Notifications.config.user_class
+      belongs_to :user, class_name: Notifications.config.user_class
+
+      belongs_to :target, polymorphic: true
+      belongs_to :second_target, polymorphic: true
+      belongs_to :third_target, polymorphic: true
+
+      scope :unread, -> { where(read_at: nil) }
+    end
+
+    def read?
+      self.read_at.present?
+    end
+
+    def actor_name
+      return "" if self.actor.blank?
+      self.actor.send(Notifications.config.user_name_method)
+    end
+
+    def actor_avatar_url
+      return DEFAULT_AVATAR if Notifications.config.user_avatar_url_method.blank?
+      return DEFAULT_AVATAR if self.actor.blank?
+      self.actor.send(Notifications.config.user_avatar_url_method)
+    end
+
+    def actor_profile_url
+      return '#' if self.actor.blank?
+      self.actor.send(Notifications.config.user_profile_url_method)
+    end
+
+    module ClassMethods
+      def read!(ids = [])
+        return if ids.blank?
+        Notification.where(id: ids).update_all(read_at: Time.now)
+      end
+
+      def unread_count(user)
+        Notification.where(user: user).unread.count
+      end
+    end
+  end
+end

data/lib/notifications/version.rb

@@ -1,3 +1,3 @@
 module Notifications
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notifications
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Jason Lee
@@ -30,20 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Rails mountable Notification for any applications.
 email:
 - huacnlee@gmail.com
@@ -54,18 +40,23 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/notifications_manifest.js
-- app/assets/javascripts/notifications/application.js
-- app/assets/stylesheets/notifications/application.css
 - app/controllers/notifications/application_controller.rb
-- app/helpers/notifications/application_helper.rb
-- app/jobs/notifications/application_job.rb
-- app/mailers/notifications/application_mailer.rb
-- app/models/notifications/application_record.rb
-- app/views/layouts/notifications/application.html.erb
+- app/controllers/notifications/notifications_controller.rb
+- app/models/notification.rb
+- app/views/notifications/notifications/_notification.html.erb
+- app/views/notifications/notifications/index.html.erb
+- config/initializers/notifications.rb
+- config/locales/notifications.en.yml
 - config/routes.rb
+- db/migrate/20160328045436_create_notifications.rb
+- lib/generators/notifications/controllers_generator.rb
+- lib/generators/notifications/i18n_generator.rb
+- lib/generators/notifications/install_generator.rb
+- lib/generators/notifications/views_generator.rb
 - lib/notifications.rb
+- lib/notifications/configuration.rb
 - lib/notifications/engine.rb
+- lib/notifications/model.rb
 - lib/notifications/version.rb
 - lib/tasks/notifications_tasks.rake
 homepage: https://github.com/rails-engine/notifications

data/app/assets/config/notifications_manifest.js

@@ -1,2 +0,0 @@
-//= link_directory ../javascripts/notifications .js
-//= link_directory ../stylesheets/notifications .css

data/app/assets/javascripts/notifications/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .

data/app/assets/stylesheets/notifications/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/helpers/notifications/application_helper.rb

@@ -1,4 +0,0 @@
-module Notifications
-  module ApplicationHelper
-  end
-end

data/app/jobs/notifications/application_job.rb

@@ -1,4 +0,0 @@
-module Notifications
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/notifications/application_mailer.rb

@@ -1,6 +0,0 @@
-module Notifications
-  class ApplicationMailer < ActionMailer::Base
-    default from: 'from@example.com'
-    layout 'mailer'
-  end
-end

data/app/models/notifications/application_record.rb

@@ -1,5 +0,0 @@
-module Notifications
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end

data/app/views/layouts/notifications/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Notifications</title>
-  <%= stylesheet_link_tag    "notifications/application", media: "all" %>
-  <%= javascript_include_tag "notifications/application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>