notifications 0.4.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79db559c211b2011d5615a2ac349e6d36abf5ec76c61bb2fcb08db013d5ced50
-  data.tar.gz: cffba71597d27b35f00357c9a743645a9c276b673acc618214084110f0f46c75
+  metadata.gz: 60fefd52121d61d6beb17f2ddc27a829b78147ded2c816e643d691c89ceb583d
+  data.tar.gz: 67eb1c905055995f9f7c15563e0e45c83a90654765ba1201296f1f3426590182
 SHA512:
-  metadata.gz: '0998a62dd596d90afcdc6289d4a54195f00ad39c782ef31e503f4263cd94309c5ce1660651f48a6686bf50749449f71cda01b6902bd1a8d0a2c2224f211385eb'
-  data.tar.gz: 754e36beeb1b439e4acaa89f7c651e36f21f884cac0a628ba3b081691abe92e9c23bac0955b787e2d60be463efa586f454162c44a14bb346af5b854988b617da
+  metadata.gz: db8c63d042a9f10e5e30931dd710ff98d1fe46cd2885b918a2cedc5c868a0accf021ae4fea485d98436b9f384aa1d43965b97e88285ffd3f1fddfd59c3e0e711
+  data.tar.gz: d198158df36b375edd8e474d132be772666d24e3a3afaaeeb074cfcae31eff3a810c86ab91fd96ef86e8b46efb4e8440bcb5de28f262aeecbbe81af30d956d8c

data/README.md

@@ -2,7 +2,7 @@
 
 Mountable notifications for any Rails 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)
+[![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) [![codecov.io](https://codecov.io/github/rails-engine/notifications/coverage.svg?branch=master)](https://codecov.io/github/rails-engine/notifications?branch=master)
 
 ## Example:
 
@@ -10,13 +10,10 @@ Mountable notifications for any Rails applications.
 
 ## Installation
 
-```ruby
-# Gemfile
-gem 'notifications'
+```bash
+$ bundle add notifications
 ```
 
-And then run `bundle install`.
-
 You now have a notifications generator in your Rails application:
 
 ```bash
@@ -43,7 +40,7 @@ end
 
 class Comment
   belongs_to :post
-  belongs_user :user
+  belongs_to :user
 
   after_commit :create_notifications, on: [:create]
   def create_notifications
@@ -59,7 +56,43 @@ end
 Get unread notifications count for a user:
 
 ```rb
-count = Notification.unread_count(current_user)
+# unread count
+unread_count = Notification.unread_count(current_user)
+
+# read count
+read_count = Notification.read_count(current_user)
+
+```
+
+```rb initialize/**.rb
+# for non-user class
+Notifications.config.user_class = 'Member'
+
+#or change
+
+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: nil
+  # self.user_profile_url_method = 'profile_url'
+
+  # authenticate_user method in your Controller, default: nil
+  # 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
+
+
 ```
 
 ### Write your custom Notification partial view for notify_types:
@@ -72,7 +105,7 @@ Notification.create(notify_type: 'follow' ....)
 Notification.create(notify_type: 'mention', target: @reply, second_target: @topic, ....)
 ```
 
-You app must have:
+Your app must have:
 
 - app/views/notifications/_follow.html.erb
 - app/views/notifications/_mention.html.erb
@@ -80,28 +113,36 @@ You app must have:
 ```erb
 # app/views/notifications/_follow.html.erb
 <div class="media-heading">
-  <%= link_to notification.actor.title, notification.actor %> just followed you.
+  <%= link_to notification.actor.title, main_app.user_path(notification.actor) %> just followed you.
 </div>
 ```
 
 ```erb
 # app/views/notifications/_mention.html.erb
 <div class="media-heading">
-  <%= link_to notification.actor.title, notification.actor %> has mentioned you in
-  <%= link_to notification.second_target.title, topic_path(notification.second_target) %>
+  <%= link_to notification.actor.title, main_app.user_path(notification.actor) %> has mentioned you in
+  <%= link_to notification.second_target.title, main_app.topic_path(notification.second_target) %>
 </div>
 <div class="media-content">
   <%= notification.target.body %>
 </div>
 ```
 
+> NOTE: When you want use Rails route path name in notification views, you must use [main_app](http://api.rubyonrails.org/classes/Rails/Engine.html#class-Rails::Engine-label-Using+Engine-27s+routes+outside+Engine) prefix. etc: `main_app.user_path(user)`
+
 ### About Notification template N+1 performance
 
 It is recommended that you use [second_level_cache](https://github.com/hooopo/second_level_cache) for solving N+1 performance issues.
 
 ## Contributing
 
-Contribution directions go here.
+Testing for multiple Rails versions:
+
+```bash
+make test_51
+# or test all
+make test
+```
 
 ## Site Used
 

data/Rakefile

@@ -1,24 +1,24 @@
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
 
-load 'rails/tasks/engine.rake'
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
 
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 
-task 'assets:precompile' => 'app:assets:precompile'
+task "assets:precompile" => "app:assets:precompile"
 task default: :test

data/app/controllers/notifications/notifications_controller.rb

@@ -1,24 +1,28 @@
 module Notifications
   class NotificationsController < Notifications::ApplicationController
     def index
-      @notifications = notifications.includes(:actor).order('id desc').page(params[:page])
+      @notifications = notifications.includes(:actor).order("id desc").page(params[:page])
 
       unread_ids = @notifications.reject(&:read?).select(&:id)
-      Notification.read!(unread_ids)
+      Notification.read!(current_user, unread_ids)
 
       @notification_groups = @notifications.group_by { |note| note.created_at.to_date }
     end
 
+    def read
+      Notification.read!(current_user, params[:ids])
+      render json: { ok: 1 }
+    end
+
     def clean
       notifications.delete_all
       redirect_to notifications_path
     end
 
     private
-
-    def notifications
-      raise "You need reqiure user login for /notifications page." unless current_user
-      Notification.where(user_id: current_user.id)
-    end
+      def notifications
+        raise "You need reqiure user login for /notifications page." unless current_user
+        Notification.where(user_id: current_user.id)
+      end
   end
 end

data/config/routes.rb

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

data/db/migrate/20160328045436_create_notifications.rb

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

data/lib/generators/notifications/controllers_generator.rb

@@ -1,12 +1,12 @@
-require 'rails/generators'
+require "rails/generators"
 module Notifications
   module Generators
     class ControllersGenerator < Rails::Generators::Base #:nodoc:
-      source_root File.expand_path('../../../../app/controllers', __FILE__)
+      source_root File.expand_path("../../../app/controllers", __dir__)
       desc "Used to copy Notifications's controllers to your application's controllers."
 
       def copy_controllers
-        %w(notifications).each do |fname|
+        %w[notifications].each do |fname|
           path = "#{Rails.root}/app/controllers/notifications/#{fname}_controller.rb"
           if File.exist?(path)
             puts "Skipping notifications/#{fname}_controller.rb creation, as file already exists!"

data/lib/generators/notifications/i18n_generator.rb

@@ -1,12 +1,12 @@
-require 'rails/generators'
+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__)
+      source_root File.expand_path("../../..", __dir__)
 
       def add_locales
-        %w(en.yml zh-CN.yml).each do |fname|
+        %w[en.yml zh-CN.yml].each do |fname|
           path = "#{Rails.root}/config/locales/notifications.#{fname}"
           if File.exist?(path)
             puts "Skipping config/locales/notifications.#{fname} creation, as file already exists!"

data/lib/generators/notifications/install_generator.rb

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

data/lib/generators/notifications/views_generator.rb

@@ -1,13 +1,13 @@
-require 'rails/generators'
+require "rails/generators"
 module Notifications
   module Generators
     class ViewsGenerator < Rails::Generators::Base #:nodoc:
-      source_root File.expand_path('../../../../', __FILE__)
+      source_root File.expand_path("../../..", __dir__)
       desc "Used to copy Notifications's views to your application's views."
 
       def copy_views
-        directory 'app/views/notifications', 'app/views/notifications'
-        template 'app/assets/stylesheets/notifications.scss', 'app/assets/stylesheets/notifications.scss'
+        directory "app/views/notifications", "app/views/notifications"
+        template "app/assets/stylesheets/notifications.scss", "app/assets/stylesheets/notifications.scss"
       end
     end
   end

data/lib/notifications.rb

@@ -1,20 +1,20 @@
-require 'notifications/model'
-require 'notifications/engine'
-require 'notifications/configuration'
-require 'notifications/version'
-require 'kaminari'
+require "notifications/model"
+require "notifications/engine"
+require "notifications/configuration"
+require "notifications/version"
+require "kaminari"
 
 module Notifications
   class << self
     def config
       return @config if defined?(@config)
       @config = Configuration.new
-      @config.user_class               = 'User'
-      @config.user_name_method         = 'name'
+      @config.user_class               = "User"
+      @config.user_name_method         = "name"
       @config.user_avatar_url_method   = nil
       @config.user_profile_url_method  = nil
       @config.authenticate_user_method = nil
-      @config.current_user_method      = 'current_user'
+      @config.current_user_method      = "current_user"
       @config
     end
 

data/lib/notifications/base.rb

@@ -0,0 +1,12 @@
+module Notifications
+  class Base
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    class_methods do
+      def
+    end
+  end
+end

data/lib/notifications/model.rb

@@ -2,7 +2,7 @@ module Notifications
   module Model
     extend ActiveSupport::Concern
 
-    DEFAULT_AVATAR = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAADwCAMAAAAJixmgAAAAFVBMVEWkpKSnp6eqqqq3t7fS0tLV1dXZ2dmshcKEAAAAtklEQVR4Ae3XsRGAAAjAQFRk/5HtqaTz5H+DlInvAQAAAAAAAAAAAAAAAAAAAACymiveO6o7BQsWLFiwYMGCBS8PFixYsGDBggULFixYsGDBggULFixYsGDBggULFixYsGDBc4IFCxYsWLBgwYIFC14ZfOeAPRQ8IliwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQv+JQAAAAAAAAAAAAAAAAAAAOAB4KJfdHmj+kwAAAAASUVORK5CYII='
+    DEFAULT_AVATAR = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAADwCAMAAAAJixmgAAAAFVBMVEWkpKSnp6eqqqq3t7fS0tLV1dXZ2dmshcKEAAAAtklEQVR4Ae3XsRGAAAjAQFRk/5HtqaTz5H+DlInvAQAAAAAAAAAAAAAAAAAAAACymiveO6o7BQsWLFiwYMGCBS8PFixYsGDBggULFixYsGDBggULFixYsGDBggULFixYsGDBc4IFCxYsWLBgwYIFC14ZfOeAPRQ8IliwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQv+JQAAAAAAAAAAAAAAAAAAAOAB4KJfdHmj+kwAAAAASUVORK5CYII="
 
     included do
       belongs_to :actor, class_name: Notifications.config.user_class, optional: true
@@ -13,6 +13,7 @@ module Notifications
       belongs_to :third_target, polymorphic: true, optional: true
 
       scope :unread, -> { where(read_at: nil) }
+      scope :read, -> { where.not(read_at: nil) }
     end
 
     def read?
@@ -20,7 +21,7 @@ module Notifications
     end
 
     def actor_name
-      return '' if self.actor.blank?
+      return "" if self.actor.blank?
       self.actor.send(Notifications.config.user_name_method)
     end
 
@@ -37,14 +38,18 @@ module Notifications
     end
 
     module ClassMethods
-      def read!(ids = [])
+      def read!(user, ids = [])
         return if ids.blank?
-        Notification.where(id: ids).update_all(read_at: Time.now)
+        Notification.where(user: user, id: ids).update_all(read_at: Time.now)
       end
 
       def unread_count(user)
         Notification.where(user: user).unread.count
       end
+
+      def read_count(user)
+        Notification.where(user: user).read.count
+      end
     end
   end
 end

data/lib/notifications/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Notifications
-  VERSION = '0.4.4'
+  VERSION = "1.1.0"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: notifications
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Jason Lee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2020-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: kaminari
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '5.2'
 description: Rails mountable Notification for any applications.
 email:
 - huacnlee@gmail.com
@@ -64,6 +64,7 @@ files:
 - lib/generators/notifications/install_generator.rb
 - lib/generators/notifications/views_generator.rb
 - lib/notifications.rb
+- lib/notifications/base.rb
 - lib/notifications/configuration.rb
 - lib/notifications/engine.rb
 - lib/notifications/model.rb
@@ -73,7 +74,7 @@ homepage: https://github.com/rails-engine/notifications
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,9 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Rails mountable Notification for any applications.
 test_files: []