notification-renderer 1.2.4 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 712f319a90e8085272bd6e7e2064a1b1f5e736a9235703640ccc9f7dcad23335
-  data.tar.gz: fff7dc09ad9e69bfc29ccdf8c85a6fb60dae9c18dbfc6d82ee84648ea44c4beb
+  metadata.gz: 36bf41fe2085e87d8719b4bf164cfd9620b65a048f3c784274f912abafb86853
+  data.tar.gz: cf6006fb927acdea8edaf91fc3b0c1c65efc9d60b3ac24cb643f0b4e23a5af3b
 SHA512:
-  metadata.gz: 84df50521bd7d113bd023ac9b1f58603f87ae0c2378d89e7250742043fb8506cc593acf030ecd287dac39bf0b5500b25c502b0349f4991fb8aba9a2b7646cac1
-  data.tar.gz: e52ea677458828dcd1fb9d0a812e2b6d10fc7e5ba166f41afbb588f82937b4d5c467bd57f8eccd74bc8745a8ee99db04c63f04c5ae015f76c2f5e533fb545641
+  metadata.gz: 3b91805d98abf2485e2d41548196f1aa7244d627b238a4935833b6a0365ed7625062fd0752c6892f9b5bfe14af73c6c688735c1690182016bccc3c4003c6e998
+  data.tar.gz: c0d168c97b8570c04a56c8bc6e8a47aecff54ca051c47da3472128251aec578aee32387c1136076043d6bdff42a509dbac87a3875e7b6f10c185e258165082d4

data/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2017 Jonas Hübotter
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2017 Jonas Hübotter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,328 +1,84 @@
-# NotificationRenderer
-
-[![Gem Version](https://badge.fury.io/rb/notification-renderer.svg)](https://badge.fury.io/rb/notification-renderer) <img src="https://travis-ci.org/jonhue/notifications-rails.svg?branch=master" />
-
-Render your notifications on multiple platforms by specifying notification types.
-
----
-
-## Table of Contents
-
-* [Installation](#installation)
-* [Usage](#usage)
-    * [Types](#types)
-        * [Generating a new type](#generating-a-new-type)
-        * [Using a type](#using-a-type)
-    * [Renderers](#renderers)
-    * [View helpers](#view-helpers)
-        * [`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)
-    * [Contributors](#contributors)
-    * [Semantic versioning](#semantic-versioning)
-* [License](#license)
-
----
-
-## Installation
-
-NotificationRenderer works with Rails 5 onwards. You can add it to your `Gemfile` with:
-
-```ruby
-gem 'notification-renderer'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install notification-renderer
-
-If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
-
-```ruby
-gem 'notification-renderer', github: 'jonhue/notifications-rails'
-```
-
-Now run the generator:
-
-    $ rails g notification_renderer:install
-
-To wrap things up, migrate the changes to your database:
-
-    $ rails db:migrate
-
----
-
-## Usage
-
-### Types
-
-NotificationRenderer uses templates to render your notifications.
-
-The `type` of a notification determines which template gets utilized for rendering. Each notification type has multiple templates each of which responsible for rendering a notification in another scenario. The default template for a given type is `index`.
-
-#### Generating a new type
-
-This gem comes with a generator to make adding new types a whole lot easier. Run in your terminal:
-
-    $ rails g notification_renderer:type -t notification
-
-This will create the following structure in your application:
-
-* `views`
-    * `notifications`
-        * `notification`
-            * `_index.html.erb`
-
-You can also customize the generated templates (renderers):
-
-    $ rails g notification_renderer:type -t notification -r index feed
-
-This command will also create a custom renderer called `feed` for the notification type `notification`:
-
-* `views`
-    * `notifications`
-        * `notification`
-            * `_feed.html.erb`
-            * `_index.html.erb`
-
-#### Using a type
-
-You are able to specify the `type` of a `Notification` record:
-
-```ruby
-notification = Notification.create target: User.first, object: Recipe.first, type: 'notification'
-```
-
-**Note:** The `type` attribute of any new `Notification` record will default to the [`default_type` configuration](#configuration).
-
-You can also scope records by their type:
-
-```ruby
-# Return records with `'notification'` as type
-Notification.notification_type
-
-# Return records with `'follow'` as type
-Notification.follow_type
-```
-
-### Renderers
-
-In your renderers you can access the `Notification` record through the `notification` variable. This is how a renderer could look like:
-
-```erb
-<%= notification.target.name %> commented on <%= notification.object.article.title %>.
-```
-
-### View helpers
-
-NotificationRenderer introduces some view helpers to assist you in embedding notifications.
-
-#### `render_notification`
-
-`render_notification` renders a single `Notification` record:
-
-```erb
-<%= render_notification Notification.first %>
-```
-
-Rendering a notification will set its `read` attribute to `true`. This behavior can be [configured](#configuration).
-
-You can also specify a renderer. It defaults to `'index'`.
-
-```erb
-<%= render_notification Notification.first, 'feed' %>
-```
-
-#### `render_notifications`
-
-`render_notifications` takes an ActiveRecord array of `Notification` records and renders each of them in order:
-
-```erb
-<%= render_notifications Notification.all %>
-```
-
-You can also specify a renderer. It defaults to `'index'`.
-
-```erb
-<%= render_notifications Notification.all, 'feed' %>
-```
-
-It wraps the rendered notifications in a `div`:
-
-```html
-<div class="notification-renderer notifications">
-    <!-- ... -->
-</div>
-```
-
-### Grouping
-
-You can group any ActiveRecord array of `Notification` records by an attribute value:
-
-```ruby
-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'], 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]'] %>
-```
-
-It is also possible to group notifications for just one object:
-
-```erb
-<%= 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:
-
-```erb
-<!-- View -->
-
-<%= render_notifications_grouped Notification.notification_type, ['object.article'] %>
-```
-
-```erb
-<!-- Renderer -->
-
-<% if notification_grouped? %>
-    <%= 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 %>
-```
-
-Grouping makes the following two methods available in your renderer:
-
-**`attributes`** Hash of attributes grouped by and their values.
-
-**`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
-
-You can configure NotificationRenderer by passing a block to `configure`. This can be done in `config/initializers/notification-renderer.rb`:
-
-```ruby
-NotificationRenderer.configure do |config|
-    config.default_type = 'notification'
-end
-```
-
-**`default_type`** Choose your default notification type. Takes a string. Defaults to `'notification'`.
-
-**`default_renderer`** Choose your default renderer. Takes a string. Defaults to `'index'`.
-
-**`auto_read`** Automatically mark rendered notifications as read. Takes a boolean. Defaults to `true`.
-
----
-
-## To Do
-
-[Here](https://github.com/jonhue/notifications-rails/projects/7) is the full list of current projects.
-
-To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
-
----
-
-## Contributing
-
-We hope that you will consider contributing to NotificationRenderer. Please read this short overview for some information about how to get started:
-
-[Learn more about contributing to this repository](https://github.com/jonhue/notifications-rails/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/jonhue/notifications-rails/blob/master/CODE_OF_CONDUCT.md)
-
-### Contributors
-
-Give the people some :heart: who are working on this project. See them all at:
-
-https://github.com/jonhue/notifications-rails/graphs/contributors
-
-### Semantic Versioning
-
-NotificationRenderer follows Semantic Versioning 2.0 as defined at http://semver.org.
-
-## License
-
-MIT License
-
-Copyright (c) 2017 Jonas Hübotter
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+# notifications-rails
+
+notifications-rails is the most powerful notification library for Rails. It offers not only simple APIs to create and render notifications but also supports user-integration and cross-platform delivery of notifications.
+
+## Philosophy
+
+notifications-rails has been built with modularity in mind. It currently consists of four components each of which bringing one essential functionality to the integration of notifications in your Rails app.
+
+**[notification-handler](notification-handler):** Create and modify your notifications through a simple API.
+
+**[notification-renderer](notification-renderer):** Render your notifications in various contexts.
+
+**[notification-pusher](notification-pusher):** Deliver your notifications to various services, including [Email](notification-pusher/notification-pusher-actionmailer) and [OneSignal](notification-pusher/notification-pusher-onesignal).
+
+**[notification-settings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
+
+You may just use the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
+
+## Installation
+
+You can add notifications-rails to your `Gemfile` with:
+
+```ruby
+gem 'notifications-rails'
+```
+
+And then run:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install notifications-rails
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'notifications-rails', github: 'jonhue/notifications-rails'
+```
+
+## Usage
+
+Details on usage are provided in the [documentation](#philosophy) of the specific modules.
+
+## Development
+
+To start development you first have to fork this repository and locally clone your fork.
+
+Install the projects dependencies by running:
+
+    $ bundle install
+
+### Testing
+
+Tests are written with RSpec. Integration tests are located in `/spec`, unit tests can be found in `<module>/spec`.
+
+To run all tests:
+
+    $ ./rspec
+
+To run RuboCop:
+
+    $ bundle exec rubocop
+
+You can find all commands run by the CI workflow in `.github/workflows/ci.yml`.
+
+## Contributing
+
+We warmly welcome everyone who is intersted in contributing. Please reference our [contributing guidelines](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Releases
+
+[Here](https://github.com/jonhue/notifications-rails/releases) you can find details on all past releases. Unreleased breaking changes that are on the current master can be found [here](CHANGELOG.md).
+
+notifications-rails follows Semantic Versioning 2.0 as defined at http://semver.org. Reference our [security policy](SECURITY.md).
+
+### Publishing
+
+1. Review breaking changes and deprecations in `CHANGELOG.md`.
+1. Change the gem version in `VERSION`.
+1. Reset `CHANGELOG.md`.
+1. Create a pull request to merge the changes into `master`.
+1. After the pull request was merged, create a new release listing the breaking changes and commits on `master` since the last release.
+1. The release workflow will publish the gems to RubyGems.

data/lib/notifications-rails.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'notification-handler'
+require 'notification-renderer'
+require 'notification-pusher'
+require 'notification-settings'

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: notification-renderer
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 3.0.3
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-17 00:00:00.000000000 Z
+date: 2020-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: actionview
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: notification-handler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,73 +67,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: notification-handler
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.4
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
 - !ruby/object:Gem::Dependency
   name: rubocop
   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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.52'
-description: Render your notifications on multiple platforms by specifying notification
-  types.
-email: me@jonhue.me
+        version: '0'
+description: Render your notifications in various contexts.
+email: jonas.huebotter@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE
 - README.md
-- app/helpers/notification_renderer_helper.rb
-- lib/generators/notification_renderer/install_generator.rb
-- lib/generators/notification_renderer/type_generator.rb
-- lib/generators/templates/install/README.md
-- lib/generators/templates/install/initializer.rb
-- lib/generators/templates/install/notifications_migration.rb.erb
-- lib/generators/templates/type/_template.html
-- lib/notification-renderer.rb
-- lib/notification_renderer/configuration.rb
-- lib/notification_renderer/engine.rb
-- lib/notification_renderer/notification_library.rb
-- lib/notification_renderer/notification_scopes.rb
+- lib/notifications-rails.rb
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-renderer
 licenses:
 - MIT
-metadata: {}
+metadata:
+  github_repo: ssh://github.com/jonhue/notifications-rails
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -128,17 +186,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Render your notifications on multiple platforms by specifying notification
-  types
+summary: Render your notifications in various contexts
 test_files: []

data/CHANGELOG.md

@@ -1,46 +0,0 @@
-# Changelog
-
-### master
-
-* nothing yet
-
-### 1.2.3 - 2018/01/23
-
-* enhancements
-    * made `attribute` & `notifications_count` parameters optional for `render_notification` method
-* bugfixes
-    * fixed magic type scopes
-
-### 1.0.0 - 2017/12/28
-
-* bugfixes
-
-### 1.0.0.beta6 - 2017/12/28
-
-* bugfixes
-    * fix lib loading problems
-
-### 1.0.0.beta5 - 2017/12/28
-
-* bugfixes
-    * fix generators
-    * fix lib loading problems
-    * fix syntax errors
-
-### 1.0.0.beta4 - 2017/12/27
-
-* features
-    * add helpers
-    * add `default_renderer` and `auto_read` configuration options
-    * add grouping functionality
-* enhancements
-    * allow defining renderers for `type` generator
-
-### 1.0.0.beta3 - 2017/12/25
-
-* features
-    * introduce `type` generator
-
-### 1.0.0.beta2 - 2017/12/23
-
-* initial release

data/app/helpers/notification_renderer_helper.rb

@@ -1,63 +0,0 @@
-module NotificationRendererHelper
-
-    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}/#{options[:renderer]}", notification: notification, attributes: options[:attributes], notifications: options[:notifications]
-    end
-
-    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: options[:renderer]
-            end
-        end
-    end
-
-    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
-            recursive_render_notifications_grouped notifications.grouping(options[:group_by]), options
-        end
-    end
-
-    def notification_grouped?
-        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/generators/notification_renderer/install_generator.rb

@@ -1,47 +0,0 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-
-module NotificationRenderer
-
-    class InstallGenerator < Rails::Generators::Base
-
-        include Rails::Generators::Migration
-
-        source_root File.join File.dirname(__FILE__), '../templates/install'
-        desc 'Install NotificationRenderer'
-
-        def self.next_migration_number dirname
-            if ActiveRecord::Base.timestamped_migrations
-                Time.now.utc.strftime '%Y%m%d%H%M%S'
-            else
-                "%.3d" % ( current_migration_number(dirname) + 1 )
-            end
-        end
-
-        def create_initializer
-            template 'initializer.rb', 'config/initializers/notification-renderer.rb'
-        end
-
-        def create_notifications_migration_file
-            migration_template 'notifications_migration.rb.erb', 'db/migrate/notification_renderer_migration.rb', migration_version: migration_version
-        end
-
-        def create_templates
-            system 'rails g notification_renderer:type -t notification'
-        end
-
-        def show_readme
-            readme 'README.md'
-        end
-
-        private
-
-        def migration_version
-            if Rails.version >= '5.0.0'
-                "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-            end
-        end
-
-    end
-
-end

data/lib/generators/notification_renderer/type_generator.rb

@@ -1,21 +0,0 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-
-module NotificationRenderer
-
-    class TypeGenerator < Rails::Generators::Base
-
-        source_root File.join File.dirname(__FILE__), '../templates/type'
-        desc 'Create a new notification type'
-        class_option :type, desc: 'Specify the notification type', type: :string, default: NotificationRenderer.configuration.default_type, aliases: '-t'
-        class_option :renderers, desc: 'Specify the renderer templates', type: :string, default: NotificationRenderer.configuration.default_renderer, aliases: '-r'
-
-        def create_templates
-            options[:renderers].split(' ')&.each do |template|
-                template '_template.html', "app/views/notifications/#{options[:type]}/_#{template}.html.erb"
-            end
-        end
-
-    end
-
-end

data/lib/generators/templates/install/README.md

@@ -1 +0,0 @@
-Now run `rails db:migrate` to add NotificationRenderer to your database.

data/lib/generators/templates/install/initializer.rb

@@ -1,12 +0,0 @@
-NotificationRenderer.configure do |config|
-
-    # Choose your default notification type. Takes a string.
-    # config.default_type = 'notification'
-
-    # Choose your default renderer. Takes a string.
-    # config.default_renderer = 'index'
-
-    # Automatically mark rendered notifications as read. Takes a boolean.
-    # config.auto_read = true
-
-end

data/lib/generators/templates/install/notifications_migration.rb.erb

@@ -1,5 +0,0 @@
-class NotificationRendererMigration < ActiveRecord::Migration<%= migration_version %>
-    def change
-        add_column :notifications, :type, :string, index: true
-    end
-end

data/lib/generators/templates/type/_template.html

@@ -1,7 +0,0 @@
-<!--
-In your renderers you can access the `Notification` record through the `notification` variable. This is how a renderer could look like:
-
-<%#= notification.target.name %> commented on <%#= notification.object.article.title %>
-
-Learn more: https://github.com/jonhue/notifications-rails/tree/master/notification-renderer#renderers
--->

data/lib/notification-renderer.rb

@@ -1,10 +0,0 @@
-module NotificationRenderer
-
-    require 'notification_renderer/configuration'
-
-    require 'notification_renderer/engine'
-
-    autoload :NotificationLibrary, 'notification_renderer/notification_library'
-    autoload :NotificationScopes, 'notification_renderer/notification_scopes'
-
-end

data/lib/notification_renderer/configuration.rb

@@ -1,26 +0,0 @@
-module NotificationRenderer
-
-    class << self
-        attr_accessor :configuration
-    end
-
-    def self.configure
-        self.configuration ||= Configuration.new
-        yield configuration
-    end
-
-    class Configuration
-
-        attr_accessor :default_type
-        attr_accessor :default_renderer
-        attr_accessor :auto_read
-
-        def initialize
-            @default_type = 'notification'
-            @default_renderer = 'index'
-            @auto_read = true
-        end
-
-    end
-
-end

data/lib/notification_renderer/engine.rb

@@ -1,7 +0,0 @@
-require 'rails/railtie'
-require 'action_view'
-
-module NotificationRenderer
-    class Engine < ::Rails::Engine
-    end
-end

data/lib/notification_renderer/notification_library.rb

@@ -1,45 +0,0 @@
-require 'notification-handler'
-require 'active_support'
-
-module NotificationRenderer
-    module NotificationLibrary
-
-        extend ActiveSupport::Concern
-
-        module ClassMethods
-
-            def grouping group_by
-                notifications = all
-                group_by.each do |method|
-                    notifications = recursive_grouping notifications, method
-                end
-                notifications
-            end
-
-            def grouping_by group_by
-                all.group_by{ |notification| notification.send(group_by) }
-            end
-
-            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

data/lib/notification_renderer/notification_scopes.rb

@@ -1,26 +0,0 @@
-require 'notification-handler'
-require 'active_support'
-
-module NotificationRenderer
-    module NotificationScopes
-
-        extend ActiveSupport::Concern
-
-        module ClassMethods
-
-            def method_missing m, *args
-                if m.to_s[/(.+)_type/]
-                    where type: $1.singularize.classify
-                else
-                    super
-                end
-            end
-
-            def respond_to? m, include_private = false
-                super || m.to_s[/(.+)_type/]
-            end
-
-        end
-
-    end
-end