notifications 0.4.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 55c8e18fe2e682eaf7a45ef6fb104d0a8d7446d6
-  data.tar.gz: 74a390763224f92a43807c2dbd31f86c2e04c75f
+SHA256:
+  metadata.gz: 9cf008411221f8643f6272a4f492d6567f7e4c2e0391ee64aab731a3895c7e74
+  data.tar.gz: 75455d8f4aafd04a1d2ec0b57fd4e50e61518b54a8e27667d8e694be5210747d
 SHA512:
-  metadata.gz: 314ca88887751450405a13e24f6ed4c8a093e670e24efd688c4bb040fb08a0c2394f339487497cdc28d77ccfe4fcc88138dc409dcb1949e4a96b9777499c9f62
-  data.tar.gz: cc94c073af15fdb5bc721d99e9a057d331ec9654980422ec6de19d0ad2f64eccfc0585b07d10ab4705717f53256d7522b70b3b3a0caff00362aa7dd1da2584f5
+  metadata.gz: 1dbee55f530440d4c1ed3000857ffdc4abcbb25825c06164b658fa67b7f19e29a872fc851cfa64b7477db7da491a4f25ab6e5cda6bf461942251220f7c1c687b
+  data.tar.gz: 1feea3486d23c7e3e6598cdf012cd7f947cc017189b2258503c07236b8d1f71854cff20645d0e9df94bd6c548df8b6d4955d7e012407baba3eeafb6c6a842f7e

data/README.md

@@ -1,8 +1,8 @@
 # Notifications
 
-Rails mountable Notification for any applications.
+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:
 
@@ -11,19 +11,21 @@ Rails mountable Notification for any applications.
 ## Installation
 
 ```ruby
-# Gemfile
-gem 'notifications'
+# Gemfile Rails ~> 5
+gem 'notifications', '~> 0.6.0'
+# Gemfile for Rails ~> 4.2
+gem 'notifications', '~> 0.5.0'
 ```
 
 And then run `bundle install`.
 
-Now you have notifications generator in Rails application:
+You now have a notifications generator in your Rails application:
 
 ```bash
 $ rails g notifications:install
 ```
 
-And, you can generate views, controller if you need custom them:
+You can generate views, controllers if you need to customize them:
 
 ```bash
 $ rails g notifications:views
@@ -43,7 +45,7 @@ end
 
 class Comment
   belongs_to :post
-  belongs_user :user
+  belongs_to :user
 
   after_commit :create_notifications, on: [:create]
   def create_notifications
@@ -56,15 +58,51 @@ class Comment
 end
 ```
 
-Get user unread count:
+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:
 
-If you create a notify_type, you need add a partial view in `app/views/notifications/` path, for example:
+If you create a notify_type, you need to add a partial view in `app/views/notifications/` path, for example:
 
 ```rb
 # There have two notify_type
@@ -72,7 +110,7 @@ Notification.create(notify_type: 'follow' ....)
 Notification.create(notify_type: 'mention', target: @reply, second_target: @topic, ....)
 ```
 
-You app must be have:
+Your app must have:
 
 - app/views/notifications/_follow.html.erb
 - app/views/notifications/_mention.html.erb
@@ -80,28 +118,36 @@ You app must be 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 mention 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
 
-Suggest you to use [second_level_cache](https://github.com/hooopo/second_level_cache) for solve N+1 performance issue.
+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

@@ -4,7 +4,7 @@ rescue LoadError
   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'

data/app/controllers/notifications/notifications_controller.rb

@@ -17,7 +17,7 @@ module Notifications
     private
 
     def notifications
-      raise "You need reqiure user login for /notifications page." unless current_user
+      raise 'You need reqiure user login for /notifications page.' unless current_user
       Notification.where(user_id: current_user.id)
     end
   end

data/db/migrate/20160328045436_create_notifications.rb

@@ -1,21 +1,23 @@
-class CreateNotifications < ActiveRecord::Migration[4.2]
+# 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

@@ -2,11 +2,11 @@ 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

@@ -3,10 +3,10 @@ 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

@@ -3,7 +3,7 @@ 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"

data/lib/generators/notifications/views_generator.rb

@@ -2,7 +2,7 @@ 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

data/lib/notifications/model.rb

@@ -5,7 +5,7 @@ module Notifications
     DEFAULT_AVATAR = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAADwCAMAAAAJixmgAAAAFVBMVEWkpKSnp6eqqqq3t7fS0tLV1dXZ2dmshcKEAAAAtklEQVR4Ae3XsRGAAAjAQFRk/5HtqaTz5H+DlInvAQAAAAAAAAAAAAAAAAAAAACymiveO6o7BQsWLFiwYMGCBS8PFixYsGDBggULFixYsGDBggULFixYsGDBggULFixYsGDBc4IFCxYsWLBgwYIFC14ZfOeAPRQ8IliwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQsWLFiwYMGCBQv+JQAAAAAAAAAAAAAAAAAAAOAB4KJfdHmj+kwAAAAASUVORK5CYII='
 
     included do
-      belongs_to :actor, class_name: Notifications.config.user_class
+      belongs_to :actor, class_name: Notifications.config.user_class, optional: true
       belongs_to :user, class_name: Notifications.config.user_class
 
       belongs_to :target, polymorphic: true, optional: true
@@ -13,6 +13,8 @@ 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?
@@ -45,6 +47,10 @@ module Notifications
       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.3'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: notifications
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-16 00:00:00.000000000 Z
+date: 2020-06-03 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
@@ -88,8 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Rails mountable Notification for any applications.