notification-settings 1.2.4 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e04f156290180375a425aa9bb5ec24343d140d3f3da0738afac84308ac5423a9
-  data.tar.gz: a566023d327da74423ebbae8869e6a5ef18375ca813f1c310260513c86924cc4
+  metadata.gz: 81f51d7d4a8dca20f5f20c248b34ea9f9290e8844285dfd93b93111d3f1c27cd
+  data.tar.gz: bd923e061018cffba1249a8f728db477acad1a3eea9879f7965bc786245c54ac
 SHA512:
-  metadata.gz: 9f020420a9e5816fe16588b5a69e54dd04c30be28fcf11af35b80387bfc4f5a5b96dc16b630a8dc445e618cc545ce27789a8f28d85aa559063ace87c56b15a12
-  data.tar.gz: 5ca29397dc91a858f97e97b3b283ee5323a989273dc95b0e8cddbf0beaf05cfed5253099114b201b500a33d39856003a619274a75b23058ad3569194328d3f82
+  metadata.gz: b4f50488e3f1d1b4df6f290e02fedbe56a544cbd870e7f7d59b22787da3464663258abe3b4e12ce2c38478cf0753a6973556d0b3fd3e7f73ce7b1facedb097b0
+  data.tar.gz: 1c55207dc022117e228e7f39753ae322999d6dae499e53b78cfb3bdf4830eb8404b6b035e9ab19dbb096489430ed9e0abeb3adc6e50b074ba60c8d3ada3bab71

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,271 +1,84 @@
-# NotificationSettings
-
-[![Gem Version](https://badge.fury.io/rb/notification-settings.svg)](https://badge.fury.io/rb/notification-settings) <img src="https://travis-ci.org/jonhue/notifications-rails.svg?branch=master" />
-
-Integrates with your authentication solution to craft a personalized user notification platform.
-
----
-
-## Table of Contents
-
-* [Installation](#installation)
-* [Usage](#usage)
-    * [Categories](#categories)
-    * [Settings](#settings)
-        * [Category specific settings](#category-specific-settings)
-        * [Pusher specific settings](#pusher-specific-settings)
-        * [Updating settings](#updating-settings)
-    * [Subscriptions](#subscriptions)
-    * [Status](#status)
-* [Configuration](#configuration)
-    * [Status](#status)
-* [To Do](#to-do)
-* [Contributing](#contributing)
-    * [Contributors](#contributors)
-    * [Semantic versioning](#semantic-versioning)
-* [License](#license)
-
----
-
-## Installation
-
-NotificationSettings works with Rails 5 onwards. You can add it to your `Gemfile` with:
-
-```ruby
-gem 'notification-settings'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install notification-settings
-
-If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
-
-```ruby
-gem 'notification-settings', github: 'jonhue/notifications-rails'
-```
-
-Now run the generator:
-
-    $ rails g notification_settings:install
-
-To wrap things up, migrate the changes to your database:
-
-    $ rails db:migrate
-
----
-
-## Usage
-
-NotificationSettings will create a `NotificationSettings::Setting` record for every newly created `notification_target`-object. It is accessible by calling:
-
-```ruby
-User.first.notification_setting
-```
-
-### Categories
-
-NotificationSettings uses categories to allow your notification targets to define specific preferences. This is how you are able to specify the `category` of a `Notification` record:
-
-```ruby
-notification = Notification.create target: User.first, object: Recipe.first, category: 'notification'
-```
-
-**Note:** The `category` attribute of any new `Notification` record will default to the [`default_category` configuration](#configuration).
-
-You can also scope records by their category:
-
-```ruby
-# Return records with `'notification'` as category
-Notification.notification_category
-
-# Return records with `'follow'` as category
-Notification.follow_category
-```
-
-### Settings
-
-You can disable notifications for a given notification target:
-
-```ruby
-s = User.first.notification_setting
-s.settings[:enabled] = false
-```
-
-This will prevent you from creating any new notifications with this user as target.
-
-#### Category specific settings
-
-A user can also have category specific settings:
-
-```ruby
-s.category_settings[:category] = { enabled: false }
-```
-
-#### Pusher specific settings
-
-He can have global or category specific pusher settings:
-
-```ruby
-s.settings[:ActionMailer] = false
-s.category_settings[:category] = { ActionMailer: false }
-```
-
-#### Updating settings
-
-...
-
-### Subscriptions
-
-Subscriptions are a way to better handle settings for notifications from different objects to one notification target.
-
-This is how to subscribe/unsubscribe a target to an object:
-
-```ruby
-User.first.subscribe Recipe.first
-User.first.unsubscribe Recipe.first
-```
-
-Now you can easily notify all subscribers from the subscribable object:
-
-```ruby
-Recipe.first.notify_subscribers push: :ActionMailer
-```
-
-Let's assume that we have a group which has multiple chats. When sending notifications to subscribers of a given chat, we only want them to get notified. But when sending notifications about the group, we want to have everyone notified, that is either subscribed to the group or subscribed to one of its chats. To do that you have to add the `private` method `notification_dependents` to your model (in this case `Group`) and return an array of ActiveRecord objects whose subscribers should receive notifications for objects of this class.
-
-```ruby
-has_many :chats
-has_many :talks
-
-private
-
-def notification_dependents
-    self.chats
-end
-```
-
-It is possible to override that behavior when notifying subscribers:
-
-```ruby
-# Disable notification dependents
-Group.first.notify_subscribers dependents: nil
-
-# Override notification dependents
-Group.first.notify_subscribers dependents: Group.first.chats + Group.first.talks
-```
-
-You can customize settings for a single subscription just as you would for a notification target:
-
-```ruby
-s = User.first.notification_subscriptions.first.notification_setting
-s.settings[:enabled] = false
-```
-
-[Learn more](#settings)
-
-### Status
-
-NotificationSettings comes with a handy feature called Status. The status of a record can temporarily disable the ability to create notifications for or to push notifications of a target.
-
-This is how to define a status:
-
-```ruby
-User.first.notification_setting.status = 'do not disturb'
-User.first.notification_setting.save
-```
-
-**Note:** You can set `status` to any string you like.
-
-`status` has three possible values that are being used as defaults. Normally it defaults to `'online'`. If the `last_seen` [configuration](#configuration) option has been set, it can also default to `'idle'` or `'offline'` depending on the `idle_after` and `offline_after` [configuration](#configuration) options.
-
-If you have set `status` to a custom value, you can get back to using the defaults by setting it back to `nil`.
-
-You can define statuses that prevent creating new notifications for a target and statuses that just prevent pushing them:
-
-```ruby
-NotificationSettings.configure do |config|
-    config.do_not_notify_statuses = ['do not notify']
-    config.do_not_push_statuses = ['do not disturb']
-end
-```
-
----
-
-## Configuration
-
-You can configure NotificationSettings by passing a block to `configure`. This can be done in `config/initializers/notification-settings.rb`:
-
-```ruby
-NotificationSettings.configure do |config|
-    config.default_category = 'notification'
-end
-```
-
-**`default_category`** Choose your default notification category. Takes a string. Defaults to `'notification'`.
-
-### Status
-
-**`idle_after`** Time duration without activity after which the status defaults to `'idle'`. Takes a time. Defaults to `10.minutes`.
-
-**`offline_after`** Time duration without activity after which the status defaults to `'offline'`. Takes a time. Defaults to `3.hours`.
-
-**`last_seen`** Stringified datetime attribute name of `object` that defines the time of the last activity. Takes a string. Defaults to `'last_seen'`.
-
-**`do_not_notify_statuses`** Array of possible statuses that will prevent creating notifications for a target. Takes an array of strings. Defaults to `[]`.
-
-**`do_not_push_statuses`** Array of possible statuses that will prevent pushing notifications of a target. Takes an array of strings. Defaults to `['do not disturb']`
-
----
-
-## To Do
-
-[Here](https://github.com/jonhue/notifications-rails/projects/4) 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 NotificationSettings. 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
-
-NotificationSettings 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-settings
 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: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,78 +52,167 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: notification-handler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: 3.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  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: pry
+  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: '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'
+        version: '0'
 description: Integrates with your authentication solution to craft a personalized
   user notification platform.
-email: me@jonhue.me
+email: jonas.huebotter@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE
 - README.md
-- app/models/notification_settings/setting.rb
-- app/models/notification_settings/subscription.rb
-- lib/generators/notification_settings/install_generator.rb
-- lib/generators/templates/install/README.md
-- lib/generators/templates/install/initializer.rb
-- lib/generators/templates/install/notifications_migration.rb.erb
-- lib/notification-settings.rb
-- lib/notification_settings/configuration.rb
-- lib/notification_settings/engine.rb
-- lib/notification_settings/notification_library.rb
-- lib/notification_settings/notification_scopes.rb
-- lib/notification_settings/setting_library.rb
-- lib/notification_settings/subscribable.rb
-- lib/notification_settings/subscriber.rb
-- lib/notification_settings/subscription_library.rb
-- lib/notification_settings/target.rb
+- lib/notifications-rails.rb
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-settings
 licenses:
 - MIT
-metadata: {}
+metadata:
+  github_repo: ssh://github.com/jonhue/notifications-rails
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -132,15 +221,14 @@ 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: Integrates with your authentication solution to craft a personalized user

data/CHANGELOG.md

@@ -1,59 +0,0 @@
-# Changelog
-
-### master
-
-* nothing yet
-
-### 1.2.2 - 2018/01/02
-
-* bugfixes
-    * fixed `subscribe' method
-
-### 1.2.1 - 2018/01/02
-
-* bugfixes
-    * fixed `undefined method 'create!' for nil:NilClass` when creating `notification_target` objects
-
-### 1.2.0 - 2018/01/02
-
-* features
-    * added dependents functionality to subscribers feature
-* bugfixes
-    * fixed `uninitialized constant NotificationSettings::Object`
-
-### 1.1.2 - 2018/01/01
-
-* bugfixes
-    * fixed length of indexes in generated migration files
-
-### 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 settings functionality
-    * add `category` attribute to `Notification` instances
-    * add subscription functonality
-
-### 1.0.0.beta3 - 2017/12/25
-
-* features
-    * add `Setting` ActiveRecord model
-
-### 1.0.0.beta1 - 2017/12/22
-
-* initial release

data/app/models/notification_settings/setting.rb

@@ -1,13 +0,0 @@
-class NotificationSettings::Setting < ActiveRecord::Base
-
-    self.table_name = 'notification_settings_settings'
-
-    include NotificationSettings::SettingLibrary
-
-    serialize :settings, Hash
-    serialize :category_settings, Hash
-
-    belongs_to :object, polymorphic: true, optional: true
-    belongs_to :subscription, optional: true
-
-end

data/app/models/notification_settings/subscription.rb

@@ -1,13 +0,0 @@
-class NotificationSettings::Subscription < ActiveRecord::Base
-
-    self.table_name = 'notification_settings_subscriptions'
-
-    include NotificationSettings::SubscriptionLibrary
-
-    belongs_to :subscriber, polymorphic: true
-    belongs_to :subscribable, polymorphic: true
-
-    has_many :notifications, class_name: '::Notification'
-    has_one :notification_setting, class_name: 'Setting'
-
-end

data/lib/generators/notification_settings/install_generator.rb

@@ -1,43 +0,0 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-
-module NotificationSettings
-
-    class InstallGenerator < Rails::Generators::Base
-
-        include Rails::Generators::Migration
-
-        source_root File.join File.dirname(__FILE__), '../templates/install'
-        desc 'Install NotificationSettings'
-
-        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-settings.rb'
-        end
-
-        def create_notifications_migration_file
-            migration_template 'notifications_migration.rb.erb', 'db/migrate/notification_settings_migration.rb', migration_version: migration_version
-        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/templates/install/README.md

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

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

@@ -1,24 +0,0 @@
-NotificationSettings.configure do |config|
-
-    # Choose your default notification category. Takes a string.
-    # config.default_category = 'notification'
-
-
-    ### STATUS ###
-
-    # Time duration without activity after which the status defaults to `'idle'`. Takes a time.
-    # config.idle_after = 10.minutes
-
-    # Time duration without activity after which the status defaults to `'offline'`. Takes a time.
-    # config.offline_after = 3.hours
-
-    # Stringified datetime attribute name of `object` that defines the time of the last activity. Takes a string.
-    # config.last_seen = 'last_seen'
-
-    # Array of possible statuses that will prevent creating notifications for a target. Takes an array of strings.
-    # config.do_not_notify_statuses = []
-
-    # Array of possible statuses that will prevent pushing notifications of a target. Takes an array of strings.
-    # config.do_not_push_statuses = ['do not disturb']
-
-end

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

@@ -1,29 +0,0 @@
-class NotificationSettingsMigration < ActiveRecord::Migration<%= migration_version %>
-    def change
-        add_column :notifications, :subscription_id, :bigint, index: true
-        add_column :notifications, :category, :string, index: true
-
-        create_table :notification_settings_settings do |t|
-
-            t.references :object, polymorphic: true, index: { name: 'idx_settings_object_type_object_id' }
-            t.references :subscription, index: true
-
-            t.string :status
-
-            t.text :settings
-            t.text :category_settings
-
-            t.timestamps
-
-        end
-
-        create_table :notification_settings_subscriptions do |t|
-
-            t.references :subscriber, polymorphic: true, index: { name: 'idx_subscriptions_subscriber_type_subscriber_id' }
-            t.references :subscribable, polymorphic: true, index: { name: 'idx_subscriptions_subscribable_type_subscribable_id' }
-
-            t.timestamps
-
-        end
-    end
-end

data/lib/notification-settings.rb

@@ -1,15 +0,0 @@
-module NotificationSettings
-
-    require 'notification_settings/configuration'
-
-    require 'notification_settings/engine'
-
-    autoload :Target, 'notification_settings/target'
-    autoload :Subscriber, 'notification_settings/subscriber'
-    autoload :Subscribable, 'notification_settings/subscribable'
-    autoload :SettingLibrary, 'notification_settings/setting_library'
-    autoload :SubscriptionLibrary, 'notification_settings/subscription_library'
-    autoload :NotificationLibrary, 'notification_settings/notification_library'
-    autoload :NotificationScopes, 'notification_settings/notification_scopes'
-
-end

data/lib/notification_settings/configuration.rb

@@ -1,32 +0,0 @@
-module NotificationSettings
-
-    class << self
-        attr_accessor :configuration
-    end
-
-    def self.configure
-        self.configuration ||= Configuration.new
-        yield configuration
-    end
-
-    class Configuration
-
-        attr_accessor :default_category
-        attr_accessor :last_seen
-        attr_accessor :idle_after
-        attr_accessor :offline_after
-        attr_accessor :do_not_notify_statuses
-        attr_accessor :do_not_push_statuses
-
-        def initialize
-            @default_category = 'notification'
-            @last_seen = 'last_seen'
-            @idle_after = 10.minutes
-            @offline_after = 3.hours
-            @do_not_notify_statuses = []
-            @do_not_push_statuses = ['do not disturb']
-        end
-
-    end
-
-end

data/lib/notification_settings/engine.rb

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

data/lib/notification_settings/notification_library.rb

@@ -1,72 +0,0 @@
-require 'notification-handler'
-require 'active_support'
-
-module NotificationSettings
-    module NotificationLibrary
-
-        extend ActiveSupport::Concern
-
-        included do
-            before_create :validate_create
-            belongs_to :subscription, class_name: 'NotificationSettings::Subscription', optional: true
-
-            include NotificationSettings::NotificationLibrary::InstanceMethods
-        end
-
-        module InstanceMethods
-
-            def category
-                self[:category] || NotificationRenderer.configuration.default_category
-            end
-
-            private
-
-            def validate_create
-                valid = true
-
-                if self.target.notification_setting.present?
-                    # Status
-                    valid = false if NotificationSettings.configuration.do_not_notify_statuses.include?(self.target.notification_setting.status)
-
-                    # Settings
-                    valid = false if !self.target.notification_setting.settings.dig(:enabled)
-                    ## Category
-                    valid = false if !self.target.notification_setting.category_settings.dig(self.category.to_sym, :enabled)
-                end
-
-                valid
-            end
-
-            def validate_push
-                valid = true
-
-                if self.target.notification_setting.present?
-                    # Status
-                    valid = false if NotificationSettings.configuration.do_not_push_statuses.include?(self.target.notification_setting.status)
-
-                    # Settings
-                    if self.push.kind_of?(Array)
-                        self.push.each do |pusher|
-                            valid = false if !self.target.notification_setting.settings.dig(pusher.to_sym) || ( !self.target.notification_setting.settings.dig(:index) && self.target.notification_setting.settings.dig(pusher.to_sym).nil? )
-                            ## Category
-                            valid = false if !self.target.notification_setting.category_settings.dig(self.category.to_sym, pusher.to_sym) || ( !self.target.notification_setting.category_settings.dig(self.category.to_sym, :index) && self.target.notification_setting.category_settings.dig(self.category.to_sym, pusher.to_sym).nil? )
-                        end
-                    else
-                        valid = false if !self.target.notification_setting.settings.dig(self.push.to_sym) || ( !self.target.notification_setting.settings.dig(:index) && self.target.notification_setting.settings.dig(self.push.to_sym).nil? )
-                        ## Category
-                        valid = false if !self.target.notification_setting.category_settings.dig(self.category.to_sym, self.push.to_sym) || ( !self.target.notification_setting.category_settings.dig(self.category.to_sym, :index) && self.target.notification_setting.category_settings.dig(self.category.to_sym, self.push.to_sym).nil? )
-                    end
-                end
-
-                valid
-            end
-
-            def initialize_pusher
-                return unless validate_push
-                super
-            end
-
-        end
-
-    end
-end

data/lib/notification_settings/notification_scopes.rb

@@ -1,30 +0,0 @@
-require 'notification-handler'
-require 'active_support'
-
-module NotificationSettings
-    module NotificationScopes
-
-        extend ActiveSupport::Concern
-
-        included do
-            include NotificationSettings::NotificationScopes::InstanceMethods
-        end
-
-        module InstanceMethods
-
-            def method_missing m, *args
-                if m.to_s[/(.+)_category/]
-                    where category: $1.singularize.classify
-                else
-                    super
-                end
-            end
-
-            def respond_to? m, include_private = false
-                super || m.to_s[/(.+)_category/]
-            end
-
-        end
-
-    end
-end

data/lib/notification_settings/setting_library.rb

@@ -1,28 +0,0 @@
-require 'active_support'
-
-module NotificationSettings
-    module SettingLibrary
-
-        extend ActiveSupport::Concern
-
-        included do
-            include NotificationSettings::SettingLibrary::InstanceMethods
-        end
-
-        module InstanceMethods
-
-            def status
-                if self.object.respond_to?(NotificationSettings.configuration.last_seen) && ( Time.now - self.object.send(NotificationSettings.configuration.last_seen) ).round >= NotificationSettings.configuration.idle_after && ( Time.now - self.object.send(NotificationSettings.configuration.last_seen) ).round < NotificationSettings.configuration.offline_after
-                    default = 'idle'
-                elsif self.object.respond_to?(NotificationSettings.configuration.last_seen) && ( Time.now - self.object.send(NotificationSettings.configuration.last_seen) ).round >= NotificationSettings.configuration.offline_after
-                    default = 'offline'
-                else
-                    'online'
-                end
-                self[:status] || default
-            end
-
-        end
-
-    end
-end

data/lib/notification_settings/subscribable.rb

@@ -1,42 +0,0 @@
-require 'active_support'
-
-module NotificationSettings
-    module Subscribable
-
-        extend ActiveSupport::Concern
-
-        included do
-            has_many :notification_subscriptions, as: :subscribable, class_name: 'NotificationSettings::Subscription', dependent: :destroy
-            has_many :notification_subscribers, through: :notification_subscriptions, source: :subscriber
-
-            include NotificationSettings::Subscribable::InstanceMethods
-        end
-
-        module InstanceMethods
-
-            def notify_subscribers options = {}
-                options[:object] = self
-                subscribers = notify_dependents options.delete(:dependents)
-                self.notification_subscribers&.each { |subscriber| subscribers << subscriber }
-                subscribers.to_a.uniq&.each do |subscriber|
-                    subscriber.notify options
-                end
-            end
-
-            def notify_dependents dependents
-                subscribers = []
-                dependents ||= self.notification_dependents
-                dependents&.each { |dependent| dependent.notification_subscribers&.each { |subscriber| subscribers << subscriber } }
-                subscribers
-            end
-
-            private
-
-            def notification_dependents
-                []
-            end
-
-        end
-
-    end
-end

data/lib/notification_settings/subscriber.rb

@@ -1,30 +0,0 @@
-require 'active_support'
-
-module NotificationSettings
-    module Subscriber
-
-        extend ActiveSupport::Concern
-
-        included do
-            has_many :notification_subscriptions, as: :subscriber, class_name: 'NotificationSettings::Subscription', dependent: :destroy
-            has_many :notification_subscribables, through: :notification_subscriptions, source: :subscribable
-
-            include NotificationSettings::Subscriber::InstanceMethods
-        end
-
-        module InstanceMethods
-
-            def subscribe subscribable, options = {}
-                options[:subscribable] = subscribable
-                self.notification_subscriptions.create options
-            end
-
-            def unsubscribe subscribable
-                subscription = self.notification_subscriptions.find_by subscribable_id: subscribable.id, subscribable_type: subscribable.class.name
-                subscription.destroy
-            end
-
-        end
-
-    end
-end

data/lib/notification_settings/subscription_library.rb

@@ -1,25 +0,0 @@
-require 'active_support'
-
-module NotificationSettings
-    module SubscriptionLibrary
-
-        extend ActiveSupport::Concern
-
-        included do
-            after_create_commit :create_notification_setting
-
-            include NotificationSettings::SubscriptionLibrary::InstanceMethods
-        end
-
-        module InstanceMethods
-
-            private
-
-            def create_notification_setting
-                self.notification_setting.create!
-            end
-
-        end
-
-    end
-end

data/lib/notification_settings/target.rb

@@ -1,26 +0,0 @@
-require 'active_support'
-
-module NotificationSettings
-    module Target
-
-        extend ActiveSupport::Concern
-
-        included do
-            has_one :notification_setting, as: :object, class_name: 'NotificationSettings::Setting', dependent: :destroy
-            before_create :create_notification_setting
-
-            include NotificationSettings::Target::InstanceMethods
-        end
-
-        module InstanceMethods
-
-            private
-
-            def create_notification_setting
-                self.build_notification_setting
-            end
-
-        end
-
-    end
-end