notification-renderer 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cd8ff29aaeda72cef91cd077b82d33b388c0ade6560db4eb5ff16d39cb89354
-  data.tar.gz: 1b93f84fac881b91e3d4e9ef41fb317d03cbd3bba3bcfa1fe49588482aeb1132
+  metadata.gz: 712f319a90e8085272bd6e7e2064a1b1f5e736a9235703640ccc9f7dcad23335
+  data.tar.gz: fff7dc09ad9e69bfc29ccdf8c85a6fb60dae9c18dbfc6d82ee84648ea44c4beb
 SHA512:
-  metadata.gz: 5be66082f05cc424b0aec23a13a2f057ac11ed270368305df73a0ab77fae97a413e1a883662d57bdf9ee4f7ac4bd6a99703a9de17dbec6022b0e0aaa4d05d1ec
-  data.tar.gz: 7c03ff84089edfb9bac28a939e3d30731e8fb7dd401cda18bb5d7086fe4713e9b46b5517247d2f79f68a916c684b1f57eb12e3deffc65cd9c2c7b2bd6becd9bc
+  metadata.gz: 84df50521bd7d113bd023ac9b1f58603f87ae0c2378d89e7250742043fb8506cc593acf030ecd287dac39bf0b5500b25c502b0349f4991fb8aba9a2b7646cac1
+  data.tar.gz: e52ea677458828dcd1fb9d0a812e2b6d10fc7e5ba166f41afbb588f82937b4d5c467bd57f8eccd74bc8745a8ee99db04c63f04c5ae015f76c2f5e533fb545641

data/README.md

@@ -18,6 +18,8 @@ Render your notifications on multiple platforms by specifying notification types
         * [`render_notification`](#render_notification)
         * [`render_notifications`](#render_notifications)
     * [Grouping](#grouping)
+        * [Grouping by notification types](#grouping-by-notification-types)
+        * [Grouping by notification dates](#grouping-by-notification-dates)
 * [Configuration](#configuration)
 * [To Do](#to-do)
 * [Contributing](#contributing)
@@ -167,27 +169,29 @@ It wraps the rendered notifications in a `div`:
 You can group any ActiveRecord array of `Notification` records by an attribute value:
 
 ```ruby
-Notification.grouping('object.article')
-Notification.grouping('metadata[:title]')
+Notification.all.grouping(['object.article'])
+Notification.all.grouping(['object.article', 'metadata[:title]'])
 ```
 
+**Note:** Notifications will be grouped in order.
+
 When rendering notifications you often want to group them by the object they belong to. This is how to group notifications by the associated object:
 
 ```erb
-<%= render_notifications_grouped Notification.all, 'object', 'feed' %>
+<%= render_notifications_grouped Notification.all, ['object'], renderer: 'feed' %>
 ```
 
 You can also group notifications by nested attributes:
 
 ```erb
-<%= render_notifications_grouped Notification.all, 'object.article' %>
-<%= render_notifications_grouped Notification.all, 'metadata[:title]' %>
+<%= render_notifications_grouped Notification.all, ['object.article'] %>
+<%= render_notifications_grouped Notification.all, ['metadata[:title]'] %>
 ```
 
 It is also possible to group notifications for just one object:
 
 ```erb
-<%= render_notifications_grouped Notification.where(object_id: 1, object_type: 'Comment'), 'object' %>
+<%= render_notifications_grouped Notification.where(object_id: 1, object_type: 'Comment'), ['object'] %>
 ```
 
 This will render the last notification for every group and pass the attributes value grouped by to your renderer:
@@ -195,13 +199,14 @@ This will render the last notification for every group and pass the attributes v
 ```erb
 <!-- View -->
 
-<%= render_notifications_grouped Notification.all, 'object.article' %>
-
+<%= render_notifications_grouped Notification.notification_type, ['object.article'] %>
+```
 
+```erb
 <!-- Renderer -->
 
 <% if notification_grouped? %>
-    <%= notification.target.name %> and <%= (notification_count - 1).to_s %> others commented on <%= attribute.title %>.
+    <%= notification.target.name %> and <%= (notifications.count - 1).to_s %> others commented on <%= attributes['object.article'].title %>.
 <% else %>
     <%= notification.target.name %> commented on <%= notification.object.article.title %>.
 <% end %>
@@ -209,12 +214,51 @@ This will render the last notification for every group and pass the attributes v
 
 Grouping makes the following two methods available in your renderer:
 
-**`attribute`** The value of the attribute used for grouping.
+**`attributes`** Hash of attributes grouped by and their values.
 
-**`notification_count`** The notification count for the group of the current notification.
+**`notifications`** The ActiveRecord array of notifications including the currently rendered notification.
 
 You may check whether a template is being used for grouping by using the `notification_grouped?` helper method.
 
+#### Grouping by notification types
+
+It is common, if rendering multiple notification types at once, to group the notifications by their type:
+
+```erb
+<%= render_notifications_grouped Notification.all, ['object.article'], group_by_type: true %>
+```
+
+This is identical to the following:
+
+```erb
+<%= render_notifications_grouped Notification.all, [:type, 'object.article'] %>
+```
+
+#### Grouping by notification dates
+
+It is also often required to group notifications by their date of creation:
+
+```erb
+<%= render_notifications_grouped Notification.all, ['object.article'], group_by_date: :month %>
+```
+
+This is identical to the following:
+
+```erb
+<%= render_notifications_grouped Notification.all, ['created_at.beginning_of_month', 'object.article'] %>
+```
+
+Accepted values are:
+
+* `:minute`
+* `:hour`
+* `:day`
+* `:week`
+* `:month`
+* `:year`
+
+**Note:** If used together with `group_by_type`, notifications will be grouped first by creation date and then by `:type`.
+
 ---
 
 ## Configuration

data/app/helpers/notification_renderer_helper.rb

@@ -1,28 +1,63 @@
 module NotificationRendererHelper
 
-    def render_notification notification, renderer = NotificationRenderer.configuration.default_renderer, attribute = nil, notifications_count = nil
+    def render_notification notification, options = {}
+        defaults = {
+            renderer: NotificationRenderer.configuration.default_renderer,
+            attributes: nil,
+            notifications: nil
+        }
+        options = defaults.merge options
+
         notification.update_attributes read: true if NotificationRenderer.configuration.auto_read
-        render "notifications/#{notification.type}/#{renderer}", notification: notification, attribute: attribute, notifications_count: notifications_count
+        render "notifications/#{notification.type}/#{options[:renderer]}", notification: notification, attributes: options[:attributes], notifications: options[:notifications]
     end
 
-    def render_notifications notifications, renderer = NotificationRenderer.configuration.default_renderer
+    def render_notifications notifications, options = {}
+        defaults = {
+            renderer: NotificationRenderer.configuration.default_renderer
+        }
+        options = defaults.merge options
+
         content_tag :div, class: 'notification-renderer notifications' do
             notifications.each do |notification|
-                render_notification notification, renderer
+                render_notification notification, renderer: options[:renderer]
             end
         end
     end
 
-    def render_notifications_grouped notifications, group_by, renderer = NotificationRenderer.configuration.default_renderer
+    def render_notifications_grouped notifications, group_by, options = {}
+        defaults = {
+            renderer: NotificationRenderer.configuration.default_renderer,
+            group_by_date: false,
+            group_by_type: false
+        }
+        options = defaults.merge options
+
+        group_by.unshift :type if options[:group_by_type]
+        group_by.unshift "created_at.beginning_of_#{options[:group_by_date]}" if options[:group_by_date]
+
         content_tag :div, class: 'notification-renderer notifications' do
-            notifications.grouping(group_by)&.each do |attribute, notifications|
-                render_notification notifications.last, renderer, attribute, notifications.count
-            end
+            recursive_render_notifications_grouped notifications.grouping(options[:group_by]), options
         end
     end
 
     def notification_grouped?
-        local_assigns[:attribute]
+        local_assigns[:attributes] && local_assigns[:notifications]
+    end
+
+    private
+
+    def recursive_render_notifications_grouped notifications, i = 0, options = {}
+        options[:attributes] = {} unless options.has_key? :attributes
+        notifications.each_pair do |k, v|
+            options[:attributes][options[:group_by][i]] = k
+            i += 1
+            if v.is_a? Hash
+                recursive_render_notifications_grouped v, options
+            else
+                render_notification v.last, renderer: options[:renderer], attributes: options[:attributes], notifications: v
+            end
+        end
     end
 
 end

data/lib/notification_renderer/notification_library.rb

@@ -6,21 +6,40 @@ module NotificationRenderer
 
         extend ActiveSupport::Concern
 
-        included do
-            include NotificationRenderer::NotificationLibrary::InstanceMethods
-        end
-
-        module InstanceMethods
+        module ClassMethods
+
+            def grouping group_by
+                notifications = all
+                group_by.each do |method|
+                    notifications = recursive_grouping notifications, method
+                end
+                notifications
+            end
 
-            def self.grouping group_by
-                group_by{ |notification| notification.send(group_by) }
+            def grouping_by group_by
+                all.group_by{ |notification| notification.send(group_by) }
             end
 
-            def type
-                self[:type] || NotificationRenderer.configuration.default_type
+            def recursive_grouping notifications, group_by
+                if notifications.is_a? Hash
+                    notifications.each_pair do |k, v|
+                        if v.is_a? Hash
+                            recursive_grouping v, group_by
+                        else
+                            k = v.grouping_by group_by
+                        end
+                    end
+                else
+                    notifications.grouping_by group_by
+                end
+                notifications
             end
 
         end
 
+        def type
+            self[:type] || NotificationRenderer.configuration.default_type
+        end
+
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notification-renderer
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: 1.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: 1.2.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement