activity_notification 0.0.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 081985f450efdee936e92d5ad47423335fb56e64
-  data.tar.gz: 38ed7ad55624f099aabf907bebc63f32b9c46791
+  metadata.gz: 428fe6b5adf0df335cd293284bfaa4ef7edcd415
+  data.tar.gz: 10d9652b853e719fd4f50886682446fabac270a6
 SHA512:
-  metadata.gz: dbe7d56c0527df73da45b7dc006c3efd3d2871ffe0df7e50b0729ff82a6498f439ee643e24547aa7079e8ec53cc4bce8f9d48cd60478dfc9f476c65200fe0d74
-  data.tar.gz: f945b80426ee27de55a182382f36319f69bff5ba72b2c44d1df34e5ad2f05d98143303e3a9ed282013121ec08c88daac54f951497278059414bf388b04c09c02
+  metadata.gz: 974b2c19ee0e9fec32dd9853325076300c0b31c0c38c5516ae3c51a0122966bbb65ed442d2eca1fa53a2fd81d61e0372622679849fe32d77b09c983068d40c95
+  data.tar.gz: e40bc4f0b7c8570a493fd325c73937db18f7223068278ef8da5348591ffb0417bdf624c1f6ac7fda7405a2e726efcfdeedfe7599d454ba3943c6b43c91b860b9

data/.travis.yml

@@ -1,5 +1,9 @@
 language: ruby
 
+branches:
+  except:
+    - images
+
 rvm:
   - 2.1.9
   - 2.2.5
@@ -15,6 +19,8 @@ matrix:
   exclude:
     - rvm: 2.1.9
       gemfile: gemfiles/Gemfile.rails-5.0
+    - rvm: 2.1.9
+      gemfile: Gemfile
   allow_failures:
     - rvm: ruby-head
   fast_finish: true

data/Gemfile

@@ -2,11 +2,14 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rails', '~> 4.2.7'
-gem 'sqlite3'
-gem 'jquery-rails'
+gem 'rails', '~> 5.0.0'
+
+group :development do
+  gem 'bullet'
+end
 
 group :test do
+  gem 'rails-controller-testing'
   gem 'ammeter'
   gem 'timecop'
   gem 'coveralls', require: false

data/Gemfile.lock

@@ -1,56 +1,62 @@
 PATH
   remote: .
   specs:
-    activity_notification (0.0.10)
+    activity_notification (1.0.0)
       activerecord (>= 4.2.0)
       i18n (>= 0.5.0)
+      jquery-rails (>= 3.1.1)
       railties (>= 4.2.0, < 5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.2.7.1)
-      actionpack (= 4.2.7.1)
-      actionview (= 4.2.7.1)
-      activejob (= 4.2.7.1)
+    actioncable (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
       mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.7.1)
-      actionview (= 4.2.7.1)
-      activesupport (= 4.2.7.1)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.0.1)
+      actionview (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.7.1)
-      activesupport (= 4.2.7.1)
+    actionview (5.0.0.1)
+      activesupport (= 5.0.0.1)
       builder (~> 3.1)
       erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.7.1)
-      activesupport (= 4.2.7.1)
-      globalid (>= 0.3.0)
-    activemodel (4.2.7.1)
-      activesupport (= 4.2.7.1)
-      builder (~> 3.1)
-    activerecord (4.2.7.1)
-      activemodel (= 4.2.7.1)
-      activesupport (= 4.2.7.1)
-      arel (~> 6.0)
-    activesupport (4.2.7.1)
+    activejob (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    ammeter (1.1.3)
+    ammeter (1.1.4)
       activesupport (>= 3.0)
       railties (>= 3.0)
       rspec-rails (>= 2.2)
-    arel (6.0.3)
+    arel (7.1.2)
     bcrypt (3.1.11)
     builder (3.2.2)
+    bullet (5.4.2)
+      activesupport (>= 3.0.0)
+      uniform_notifier (~> 1.10.0)
     concurrent-ruby (1.0.2)
     coveralls (0.8.15)
       json (>= 1.8, < 3)
@@ -79,52 +85,57 @@ GEM
       rails-dom-testing (>= 1, < 3)
       railties (>= 4.2.0)
       thor (>= 0.14, < 2.0)
-    json (1.8.3)
+    json (2.0.2)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.4)
       mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
-    minitest (5.9.0)
+    minitest (5.9.1)
+    nio4r (1.2.1)
     nokogiri (1.6.8)
       mini_portile2 (~> 2.1.0)
       pkg-config (~> 1.1.7)
     orm_adapter (0.5.0)
     pkg-config (1.1.7)
-    rack (1.6.4)
+    rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (4.2.7.1)
-      actionmailer (= 4.2.7.1)
-      actionpack (= 4.2.7.1)
-      actionview (= 4.2.7.1)
-      activejob (= 4.2.7.1)
-      activemodel (= 4.2.7.1)
-      activerecord (= 4.2.7.1)
-      activesupport (= 4.2.7.1)
+    rails (5.0.0.1)
+      actioncable (= 5.0.0.1)
+      actionmailer (= 5.0.0.1)
+      actionpack (= 5.0.0.1)
+      actionview (= 5.0.0.1)
+      activejob (= 5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activerecord (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.7.1)
-      sprockets-rails
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.7)
-      activesupport (>= 4.2.0.beta, < 5.0)
+      railties (= 5.0.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-controller-testing (1.0.1)
+      actionpack (~> 5.x)
+      actionview (~> 5.x)
+      activesupport (~> 5.x)
+    rails-dom-testing (2.0.1)
+      activesupport (>= 4.2.0, < 6.0)
       nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (4.2.7.1)
-      actionpack (= 4.2.7.1)
-      activesupport (= 4.2.7.1)
+    railties (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (11.2.2)
+    rake (11.3.0)
     responders (2.3.0)
       railties (>= 4.2.0, < 5.1)
-    rspec-core (3.5.2)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -149,12 +160,12 @@ GEM
     sprockets (3.7.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.1.1)
+    sprockets-rails (3.2.0)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.3.11)
-    term-ansicolor (1.3.2)
+    term-ansicolor (1.4.0)
       tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.5)
@@ -162,8 +173,12 @@ GEM
     tins (1.12.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    uniform_notifier (1.10.0)
     warden (1.2.6)
       rack (>= 1.0)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
     yard (0.9.5)
     yard-activesupport-concern (0.0.1)
       yard (>= 0.8)
@@ -174,14 +189,15 @@ PLATFORMS
 DEPENDENCIES
   activity_notification!
   ammeter
+  bullet
   coveralls
   devise (~> 4.2.0)
   factory_girl_rails (~> 4.7.0)
-  jquery-rails
-  rails (~> 4.2.7)
+  rails (~> 5.0.0)
+  rails-controller-testing
   rspec-rails (~> 3.5.1)
   simplecov (~> 0.12.0)
-  sqlite3
+  sqlite3 (~> 1.3.11)
   timecop
   yard (~> 0.9.5)
   yard-activesupport-concern (~> 0.0.1)

data/README.md

@@ -3,8 +3,9 @@
 [![Build Status](https://travis-ci.org/simukappu/activity_notification.svg?branch=master)](https://travis-ci.org/simukappu/activity_notification)
 [![Coverage Status](https://coveralls.io/repos/github/simukappu/activity_notification/badge.svg?branch=master)](https://coveralls.io/github/simukappu/activity_notification?branch=master)
 [![Code Climate](https://codeclimate.com/github/simukappu/activity_notification/badges/gpa.svg)](https://codeclimate.com/github/simukappu/activity_notification)
-[![Gem Version](https://badge.fury.io/rb/activity_notification.svg)](https://badge.fury.io/rb/activity_notification)
+[![Dependency Status](https://gemnasium.com/badges/github.com/simukappu/activity_notification.svg)](https://gemnasium.com/github.com/simukappu/activity_notification)
 [![Inline docs](http://inch-ci.org/github/simukappu/activity_notification.svg?branch=master)](http://inch-ci.org/github/simukappu/activity_notification)
+[![Gem Version](https://badge.fury.io/rb/activity_notification.svg)](https://badge.fury.io/rb/activity_notification)
 [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](MIT-LICENSE)
 
 `activity_notification` provides integrated user activity notifications for Ruby on Rails. You can easily use it to configure multiple notification targets and make activity notifications with notifiable models, like adding comments, responding etc.
@@ -12,6 +13,25 @@
 `activity_notification` supports Rails 5.0 and 4.2+. Currently, it is only supported with ActiveRecord ORM.
 
 
+## About
+
+`activity_notification` provides following functions:
+* Notification API (creating notifications, query for notifications and managing notification parameters)
+* Notification controllers (managing open/unopen of notifications, link to notifiable activity page)
+* Notification views (presentation of notifications)
+* Grouping notifications (grouping like `"Kevin and 7 other users posted comments to this article"`)
+* Email notification
+* Integration with [Devise](https://github.com/plataformatec/devise) authentication
+
+### Notification index
+<kbd>![notification-index](https://raw.githubusercontent.com/simukappu/activity_notification/images/activity_notification_index.png)</kbd>
+
+### Plugin notifications
+<kbd>![plugin-notifications](https://raw.githubusercontent.com/simukappu/activity_notification/images/activity_notification_plugin_focus.png)</kbd>
+
+`activity_notification` deeply uses [PublicActivity](https://github.com/pokonski/public_activity) as reference in presentation layer.
+
+
 ## Table of contents
 
 1. [About](#about)
@@ -41,17 +61,6 @@
 5. [Documentation](#documentation)
 6. **[Common examples](#common-examples)**
 
-## About
-
-`activity_notification` provides following functions:
-* Notification API (creating notifications, query for notifications and managing notification parameters)
-* Notification controllers (managing open/unopen of notifications, link to notifiable activity page)
-* Notification views (presentation of notifications)
-* Grouping notifications (grouping like `"Tom and other 7 people posted comments to this article"`)
-* Email notification
-* Integration with [Devise](https://github.com/plataformatec/devise) authentication
-
-`activity_notification` deeply uses [PublicActivity](https://github.com/pokonski/public_activity) as reference in presentation layer.
 
 ## Setup
 
@@ -115,7 +124,7 @@ You have to define notification targets for all notifications from this notifiab
 ```ruby
 class Article < ActiveRecord::Base
   belongs_to :user
-  has_many :comments, dependent: :delete_all
+  has_many :comments, dependent: :destroy
   has_many :commented_users, through: :comments, source: :user
 end
 
@@ -319,7 +328,7 @@ Sometimes, it's desirable to pass additional local variables to partials. It can
 
 For example, if you have an notification with `:key` set to `"notification.comment.reply"` and rendered it with `:target` set to `:users`, the gem will look for a partial in `app/views/activity_notification/notifications/users/comment/_reply.html.(|erb|haml|slim|something_else)`.
 
-*Hint*: the `"notification."` prefix in `:key` is completely optional and kept for backwards compatibility, you can skip it in new projects.
+*Hint*: the `"notification."` prefix in `:key` is completely optional, you can skip it in your projects or use this prefix only to make namespace.
 
 If you would like to fallback to a partial, you can utilize the `fallback` parameter to specify the path of a partial to use when one is missing:
 
@@ -343,6 +352,13 @@ If a view file does not exist then ActionView::MisingTemplate will be raised. If
 <%= render_notification(@notification, fallback: :text) %>
 ```
 
+Default views of `activity_notification` depends on jQuery and you have to add requirements to `application.js` in your apps:
+
+```app/assets/javascripts/application.js
+//= require jquery
+//= require jquery_ujs
+```
+
 #### i18n for notifications
 
 Translations are used by the `#text` method, to which you can pass additional options in form of a hash. `#render` method uses translations when view templates have not been provided. You can render pure i18n strings by passing `{i18n: true}` to `#render_notification` or `#render`.
@@ -361,7 +377,7 @@ notification:
       post:
         text: "<p>%{notifier_name} posted comments to your article %{article_title}</p>"
       reply:
-        text: "<p>%{notifier_name} and %{group_member_count} people replied for your comments</p>"
+        text: "<p>%{notifier_name} and %{group_member_count} other users replied for your comments</p>"
   admin:
     article:
       post:
@@ -435,8 +451,8 @@ The subject of notification email can be put in your locale `.yml` files as `mai
 notification:
   user:
     comment:
-      reply:
-        text: "<p>%{notifier_name} and %{group_member_count} people replied for your comments</p>"
+      post:
+        text: "<p>Someone posted comments to your article</p>"
         mail_subject: 'New comment to your article'
 ```
 
@@ -445,7 +461,16 @@ notification:
 `activity_notification` provides the function for automatically grouping notifications. When you created a notification like this, all *unopened* notifications to the same target will be grouped by `article` set as `:group` options:
 
 ```ruby
-@comment.notify :users key: 'comment.reply', group: @comment.article
+@comment.notify :users key: 'comment.post', group: @comment.article
+```
+
+When you use default notification view, it is helpful to configure `acts_as_notification_group` (or `acts_as_group`) with `printable_name` option to render group instance.
+
+```ruby
+class Article < ActiveRecord::Base
+  belongs_to :user
+  acts_as_notification_group printable_name: ->(article) { "article \"#{article.title}\"" }
+end
 ```
 
 You can use `group_owners_only` scope to filter owner notifications representing each group:
@@ -461,27 +486,27 @@ end
 And you can render them in a view like this:
 ```erb
 <% if notification.group_member_exists? %>
-  <%= "#{notification.notifier.name} and other #{notification.group_member_count} people" %>
+  <%= "#{notification.notifier.name} and #{notification.group_member_count} other users" %>
 <% else %>
   <%= "#{notification.notifier.name}" %>
 <% end %>
 <%= "posted comments to your article \"#{notification.group.title}\"" %>
 ```
 
-This presentation will be shown to target users as `Tom and other 7 people posted comments to your article "Let's use Ruby"`.
+This presentation will be shown to target users as `Kevin and 7 other users posted comments to your article "Let's use Ruby"`.
 
-You can also use `%{group_member_count}` in i18n text as a field:
+You can also use `%{group_member_count}`, `%{group_notification_count}`, `%{group_member_notifier_count}` and `%{group_notifier_count}` in i18n text as a field:
 
 ```yaml
 notification:
   user:
     comment:
-      reply:
-        text: "<p>%{notifier_name} and %{group_member_count} people replied for your comments</p>"
+      post:
+        text: "<p>%{notifier_name} and %{group_member_notifier_count} other users posted %{group_notification_count} comments to your article</p>"
         mail_subject: 'New comment to your article'
 ```
 
-Then, you will see `Tom and 7 people replied for your comments"`.
+Then, you will see `Kevin and 7 other users replied 10 comments to your article"`.
 
 ### Integration with Devise
 
@@ -590,6 +615,8 @@ $ git pull https://github.com/simukappu/activity_notification.git
 $ cd activity_notification
 $ bundle install —path vendor/bundle
 $ bundle exec rspec
+  - or -
+$ bundle exec rake
 ```
 
 #### Dummy Rails application
@@ -620,12 +647,12 @@ Then you can see the documents at <http://localhost:8808/docs/index>.
 
 ## Common examples
 
-Under construction
+To be prepared. See dummy Rails application in `spec/rails_app`.
 
 
 ## Help
 
-Under construction
+Contact us by email of this repository.
 
 
 ## License

data/activity_notification.gemspec

@@ -23,7 +23,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'railties', '>= 4.2.0', '< 5.1'
   s.add_dependency 'i18n', '>= 0.5.0'
   s.add_dependency 'activerecord', '>= 4.2.0'
+  s.add_dependency 'jquery-rails', '>= 3.1.1'
 
+  s.add_development_dependency 'sqlite3', '~> 1.3.11'
   s.add_development_dependency 'rspec-rails', '~> 3.5.1'
   s.add_development_dependency 'factory_girl_rails', '~> 4.7.0'
   s.add_development_dependency 'simplecov', '~> 0.12.0'