notification-settings 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1e7e1a607828b135d54de95b1ece9e33e82203958bd5333a1c47543312517d2
-  data.tar.gz: c4c11125679498057707fdb4ff232ccd7003b8490e818890b74a060da5b5baee
+  metadata.gz: 81f51d7d4a8dca20f5f20c248b34ea9f9290e8844285dfd93b93111d3f1c27cd
+  data.tar.gz: bd923e061018cffba1249a8f728db477acad1a3eea9879f7965bc786245c54ac
 SHA512:
-  metadata.gz: eddc817ec775d4a8c7eab2cc99f80390c0461d10cb8b78b61358498b936abada0e4946b79157972f964421de895fee8b6771cdcec88ea110ede32872a5eca08b
-  data.tar.gz: b456e6e377efd47c3b8397952c4f56773284766961f45103369b21cbb1df0709149f998fdd67c6ee5923d70c2306c9082f8cd547e624abdce87410601e60ccd0
+  metadata.gz: b4f50488e3f1d1b4df6f290e02fedbe56a544cbd870e7f7d59b22787da3464663258abe3b4e12ce2c38478cf0753a6973556d0b3fd3e7f73ce7b1facedb097b0
+  data.tar.gz: 1c55207dc022117e228e7f39753ae322999d6dae499e53b78cfb3bdf4830eb8404b6b035e9ab19dbb096489430ed9e0abeb3adc6e50b074ba60c8d3ada3bab71

data/README.md

@@ -1,316 +1,84 @@
-# NotificationSettings
+# notifications-rails
 
-[![Gem Version](https://badge.fury.io/rb/notification-settings.svg)](https://badge.fury.io/rb/notification-settings) ![Travis](https://travis-ci.com/jonhue/notifications-rails.svg?branch=master)
+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.
 
-Integrates with your authentication solution to craft a personalized user notification platform.
+## 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.
 
-## Table of Contents
+**[notification-handler](notification-handler):** Create and modify your notifications through a simple API.
 
-* [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)
-  * [Semantic versioning](#semantic-versioning)
+**[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).
 
-## 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
-
-Now run the generator:
-
-    $ rails g notification_handler:install
-    $ rails g notification_settings:install
-
-To wrap things up, migrate the changes to your database:
-
-    $ rails db:migrate
-
----
-
-## Usage
-
-First, you have to add some attributes to every model that acts as a `notification_target`:
-
-```ruby
-class User
-  # ...
-
-  notification_target
-end
-```
-
-```ruby
-# A Hashie::Mash object that stores all the settings of a notification target.
-add_column :users, :settings, :text
-
-# A string that describes a notification-relevant state of a notification target.
-add_column :users, :status, :string
-```
-
-### 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 completely disable notifications for a given notification target:
-
-```ruby
-settings = User.first.settings
-
-settings.enabled = false
-```
-
-This will prevent you from creating any new notifications with this user as target.
-
-The default is `true` (enabled) for this setting and the other settings.
-
-#### Category-specific settings
-
-A user can also have category-specific settings:
-
-```ruby
-settings.categories!.send("#{category}!").enabled = false
-```
-
-#### Delivery-method-specific settings
-
-He can have global or category-specific delivery method settings:
-
-```ruby
-settings.delivery_methods!.enabled = false                              # Prevent delivering via *any* delivery method
-settings.delivery_methods!.email!.enabled = false                       # Prevent delivering via the :email delivery method
-settings.categories!.category!.delivery_methods!.email!.enabled = false # Prevent delivering via the :email delivery method for :category
-```
-
-#### Form objects
-
-NotificationSettings comes with three form objects that simplify building forms for updating settings.
-
-##### PreferencesForm
-
-The preferences form has just one attribute: `enabled`. It can be used to update the global notification setting.
+**[notification-settings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
 
-```ruby
-user = User.first
-
-form = NotificationSettings::PreferencesForm.new(enabled: user.settings.enabled)
-form.valid?
-
-user.settings.enabled = form.enabled
-```
-
-##### CategoryPreferencesForm
-
-The category preferences form has one attribute per category. It can be used to update category-specific settings.
-
-```ruby
-user = User.first
-
-form = NotificationSettings::CategoryPreferencesForm.new(user.settings.categories_.to_h)
-form.valid?
-
-form.changed_attributes.each do |category|
-  user.settings.categories!.send(category, form.send(category))
-end
-```
-
-##### DeliveryMethodPreferencesForm
-
-The delivery method preferences form has one attribute per category and a general `enabled` attribute. It can be used to update delivery-method-specific settings or to disable all delivery methods.
-
-```ruby
-user = User.first
+You may just use the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
 
-form = NotificationSettings::DeliveryMethodPreferencesForm.new(user.settings.delivery_methods_.to_h)
-form.valid?
-
-form.changed_attributes.each do |delivery_method|
-  user.settings.delivery_methods!.send(delivery_method, form.send(delivery_method))
-end
-```
-
-### 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(delivery_method: :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 & status for a single subscription just as you would for a notification target:
-
-```ruby
-user = User.first
-subscription = user.notification_subscriptions.first
-
-subscription.settings.enabled = false
-subscription.status = 'online'
-subscription.save
-```
-
-[Learn more](#settings)
+## Installation
 
-You can add associations to your subscriber/subscribable classes if you need easy access to all their subscriptions:
+You can add notifications-rails to your `Gemfile` with:
 
 ```ruby
-# For subscribers:
-# List all subscriptions of a subscriber
-subscriber.notification_subscribables
-# List all subscribables of a specific type a subscriber subscribed to
-has_many :subscribed_products, through: :notification_subscribables, source: :subscribable, source_type: 'Product'
-
-# For subscribables:
-# List all subscriptions of a subscriber
-subscribable.notification_subscribers
-# List all subscribers of a specific type that subscribed to a subscribable
-has_many :subscribed_users, through: :notification_subscribers, source: :subscriber, source_type: 'User'
+gem 'notifications-rails'
 ```
 
-### Status
+And then run:
 
-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.
+    $ bundle install
 
-This is how to define a status:
-
-```ruby
-User.first.update(status: 'do not disturb')
-```
-
-**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.
+Or install it yourself as:
 
-If you have set `status` to a custom value, you can get back to using the defaults by setting it back to `nil`.
+    $ gem install notifications-rails
 
-You can define statuses that prevent creating new notifications for a target and statuses that just prevent delivering them:
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
 
 ```ruby
-NotificationSettings.configure do |config|
-  config.do_not_notify_statuses  = ['do not notify']
-  config.do_not_deliver_statuses = ['do not disturb']
-end
+gem 'notifications-rails', github: 'jonhue/notifications-rails'
 ```
 
----
-
-## 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.categories = [:notification]
-end
-```
+## Usage
 
-**`categories`** Choose your default notification category. Takes an array of symbols. Defaults to `[:notification]`.
+Details on usage are provided in the [documentation](#philosophy) of the specific modules.
 
-**`default_category`** Choose your default notification category. Takes a symbol. Defaults to `:notification`.
+## Development
 
-### Status
+To start development you first have to fork this repository and locally clone your fork.
 
-**`idle_after`** Time duration without activity after which the status defaults to `'idle'`. Takes a time. Defaults to `10.minutes`.
+Install the projects dependencies by running:
 
-**`offline_after`** Time duration without activity after which the status defaults to `'offline'`. Takes a time. Defaults to `3.hours`.
+    $ bundle install
 
-**`last_seen`** Stringified datetime attribute name of `object` that defines the time of the last activity. Takes a symbol. Defaults to `:last_seen`.
+### Testing
 
-**`statuses`** Array of all possible statuses. Takes an array of strings. Defaults to `['online', 'idle', 'offline', 'do not notify', 'do not disturb']`.
+Tests are written with RSpec. Integration tests are located in `/spec`, unit tests can be found in `<module>/spec`.
 
-**`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 notify']`.
+To run all tests:
 
-**`do_not_deliver_statuses`** Array of possible statuses that will prevent delivering notifications of a target. Takes an array of strings. Defaults to `['do not disturb']`
+    $ ./rspec
 
----
+To run RuboCop:
 
-## To Do
+    $ bundle exec rubocop
 
-We use [GitHub projects](https://github.com/jonhue/notifications-rails/projects/4) to coordinate the work on this project.
+You can find all commands run by the CI workflow in `.github/workflows/ci.yml`.
 
-To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
+## 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).
 
-## Contributing
+## Releases
 
-We hope that you will consider contributing to NotificationSettings. Please read this short overview for some information about how to get started:
+[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).
 
-[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)
+notifications-rails follows Semantic Versioning 2.0 as defined at http://semver.org. Reference our [security policy](SECURITY.md).
 
-### Semantic Versioning
+### Publishing
 
-NotificationSettings follows Semantic Versioning 2.0 as defined at http://semver.org.
+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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notification-settings
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2020-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -56,30 +56,36 @@ dependencies:
   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: 3.0.2
+        version: 3.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -194,30 +200,14 @@ dependencies:
         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:
 - LICENSE
 - README.md
-- app/models/notification_settings/subscription.rb
-- lib/generators/notification_settings/install_generator.rb
-- lib/generators/templates/install/initializer.rb
-- lib/generators/templates/install/notifications_migration.rb.erb
-- lib/notification-settings.rb
-- lib/notification_settings/category_preferences_form.rb
-- lib/notification_settings/configuration.rb
-- lib/notification_settings/delivery_method_preferences_form.rb
-- lib/notification_settings/engine.rb
-- lib/notification_settings/notification_lib.rb
-- lib/notification_settings/notification_scopes.rb
-- lib/notification_settings/preferences_form.rb
-- lib/notification_settings/settings.rb
-- lib/notification_settings/status.rb
-- lib/notification_settings/subscribable.rb
-- lib/notification_settings/subscriber.rb
-- lib/notification_settings/target.rb
+- lib/notifications-rails.rb
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-settings
 licenses:
 - MIT
@@ -238,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Integrates with your authentication solution to craft a personalized user

data/app/models/notification_settings/subscription.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module NotificationSettings
-  class Subscription < ActiveRecord::Base
-    self.table_name = 'notification_settings_subscriptions'
-
-    include NotificationSettings::Settings
-
-    belongs_to :subscriber, polymorphic: true
-    belongs_to :subscribable, polymorphic: true
-
-    has_many :notifications, class_name: '::Notification'
-  end
-end

data/lib/generators/notification_settings/install_generator.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-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
-        format('%<migration_number>.3d',
-               migration_number: 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
-
-    private
-
-    def migration_version
-      return unless Rails.version >= '5.0.0'
-
-      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-NotificationSettings.configure do |config|
-  # An array of all notification categories. Takes an array of symbols.
-  # config.categories = [:notification]
-
-  # Choose your default notification category. Takes a symbol.
-  # 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 symbol.
-  # config.last_seen = :last_seen
-
-  # Array of all possible statuses. Takes an array of strings.
-  # config.statuses = [
-  #   'online',
-  #   'idle',
-  #   'offline',
-  #   'do not notify',
-  #   'do not disturb'
-  # ]
-
-  # Array of possible statuses that will prevent creating notifications for a
-  # target. Takes an array of strings.
-  # config.do_not_notify_statuses = ['do not notify']
-
-  # Array of possible statuses that will prevent pushing notifications of a
-  # target. Takes an array of strings.
-  # config.do_not_deliver_statuses = ['do not disturb']
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-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_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.text :settings
-
-      t.timestamps
-    end
-  end
-end

data/lib/notification-settings.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module NotificationSettings
-  require_relative 'notification_settings/configuration'
-
-  require_relative 'notification_settings/engine'
-
-  autoload :Target, 'notification_settings/target'
-  autoload :Subscriber, 'notification_settings/subscriber'
-  autoload :Subscribable, 'notification_settings/subscribable'
-  autoload :Settings, 'notification_settings/settings'
-  autoload :Status, 'notification_settings/status'
-  autoload :NotificationLib, 'notification_settings/notification_lib'
-  autoload :NotificationScopes, 'notification_settings/notification_scopes'
-  autoload :CategoryPreferencesForm,
-           'notification_settings/category_preferences_form'
-  autoload :DeliveryMethodPreferencesForm,
-           'notification_settings/delivery_method_preferences_form'
-  autoload :PreferencesForm, 'notification_settings/preferences_form'
-end

data/lib/notification_settings/category_preferences_form.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_model'
-
-module NotificationSettings
-  class CategoryPreferencesForm
-    include ActiveModel::Model
-
-    NotificationSettings.configuration.categories.each do |category|
-      attribute category, :boolean, default: true
-    end
-  end
-end

data/lib/notification_settings/configuration.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module NotificationSettings
-  class << self
-    attr_writer :configuration
-
-    def configuration
-      @configuration ||= Configuration.new
-    end
-  end
-
-  def self.configure
-    yield configuration
-  end
-
-  class Configuration
-    attr_accessor :categories
-    attr_accessor :default_category
-    attr_accessor :last_seen
-    attr_accessor :idle_after
-    attr_accessor :offline_after
-    attr_accessor :statuses
-    attr_accessor :do_not_notify_statuses
-    attr_accessor :do_not_deliver_statuses
-
-    def initialize
-      @categories = [:notification]
-      @default_category = :notification
-      @last_seen = :last_seen
-      @idle_after = 10.minutes
-      @offline_after = 3.hours
-      @statuses = ['online', 'idle', 'offline', 'do not notify',
-                   'do not disturb']
-      @do_not_notify_statuses = ['do not notify']
-      @do_not_deliver_statuses = ['do not disturb']
-    end
-  end
-end

data/lib/notification_settings/delivery_method_preferences_form.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_model'
-
-module NotificationSettings
-  class DeliveryMethodPreferencesForm
-    include ActiveModel::Model
-
-    attribute :enabled, :boolean, default: true
-    NotificationPusher.configuration.delivery_methods
-                      .each do |delivery_method, _|
-      attribute delivery_method, :boolean, default: true
-    end
-  end
-end

data/lib/notification_settings/engine.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/engine'
-require 'active_record'
-
-module NotificationSettings
-  class Engine < ::Rails::Engine
-  end
-end

data/lib/notification_settings/notification_lib.rb

@@ -1,168 +0,0 @@
-# frozen_string_literal: true
-
-require 'notification-handler'
-require 'active_support'
-
-module NotificationSettings
-  module NotificationLib
-    extend ActiveSupport::Concern
-
-    included do
-      before_create :validate_create
-
-      validates :category, inclusion: {
-        in: NotificationSettings.configuration.categories + [nil]
-      }
-
-      belongs_to :subscription,
-                 class_name: 'NotificationSettings::Subscription',
-                 optional: true
-
-      include NotificationSettings::NotificationLib::InstanceMethods
-    end
-
-    # rubocop:disable Metrics/ModuleLength
-    module InstanceMethods
-      def category
-        self[:category] || NotificationSettings.configuration.default_category
-      end
-
-      def deliver(delivery_methods, delivery_options = {})
-        return false unless delivery_allowed?(delivery_methods)
-
-        super
-      end
-
-      def creation_allowed?
-        status_allows_creation? &&
-          settings_allow_creation? &&
-          category_settings_allow_creation?
-      end
-
-      # delivery_methods may be an array or a single value
-      def delivery_allowed?(delivery_methods)
-        creation_allowed? &&
-          status_allows_delivery? &&
-          delivery_methods_allowed?(Array(delivery_methods))
-      end
-
-      private
-
-      def validate_create
-        throw(:abort) unless creation_allowed?
-      end
-
-      def status_allows_creation?
-        !do_not_notify_statuses.include?(target.status)
-      end
-
-      def settings_allow_creation?
-        target.settings.fetch(:enabled, true) &&
-          (subscription.nil? || subscription.settings.fetch(:enabled, true))
-      end
-
-      def category_settings_allow_creation?
-        category_settings(target, category).fetch(:enabled, true) &&
-          (subscription.nil? ||
-            category_settings(subscription, category).fetch(:enabled, true))
-      end
-
-      def delivery_methods_allowed?(delivery_methods)
-        delivery_methods.any? do |delivery_method|
-          delivery_method_allowed?(delivery_method)
-        end
-      end
-
-      def delivery_method_allowed?(delivery_method)
-        settings_allow_delivery?(delivery_method) &&
-          category_settings_allow_delivery?(delivery_method)
-      end
-
-      def status_allows_delivery?
-        !do_not_deliver_statuses.include?(target.status)
-      end
-
-      def settings_allow_delivery?(delivery_method)
-        if local_delivery_method_setting?(delivery_method)
-          local_settings_allow_delivery?(delivery_method)
-        else
-          global_settings_allow_delivery?
-        end
-      end
-
-      def local_delivery_method_setting?(delivery_method)
-        !local_delivery_method_setting(delivery_method).nil?
-      end
-
-      def local_settings_allow_delivery?(delivery_method)
-        local_delivery_method_setting(delivery_method, true)
-      end
-
-      def local_delivery_method_setting(delivery_method, default = nil)
-        delivery_method_setting(target, delivery_method, default) &&
-          (subscription.nil? ||
-            delivery_method_setting(subscription, delivery_method, default))
-      end
-
-      def global_settings_allow_delivery?
-        delivery_method_setting(target, :enabled, true) &&
-          (subscription.nil? ||
-            delivery_method_setting(subscription, :enabled, true))
-      end
-
-      def category_settings_allow_delivery?(delivery_method)
-        if local_delivery_method_category_setting?(delivery_method)
-          local_category_settings_allow_delivery?(delivery_method)
-        else
-          global_category_settings_allow_delivery?
-        end
-      end
-
-      def local_delivery_method_category_setting?(delivery_method)
-        !local_delivery_method_category_setting(delivery_method).nil?
-      end
-
-      def local_category_settings_allow_delivery?(delivery_method)
-        local_delivery_method_category_setting(delivery_method, true)
-      end
-
-      def local_delivery_method_category_setting(delivery_method, default = nil)
-        category_delivery_method_setting(target, category, delivery_method,
-                                         default) &&
-          (subscription.nil? ||
-            category_delivery_method_setting(subscription, category,
-                                             delivery_method, default))
-      end
-
-      def global_category_settings_allow_delivery?
-        category_delivery_method_setting(target, category, :enabled, true) &&
-          (subscription.nil? ||
-            category_delivery_method_setting(subscription, category, :enabled,
-                                             true))
-      end
-
-      def delivery_method_setting(object, delivery_method, default)
-        object.settings.delivery_methods_.fetch(delivery_method.to_s, default)
-      end
-
-      def category_settings(object, category)
-        object.settings.categories_.send("#{category}_")
-      end
-
-      def category_delivery_method_setting(object, category, delivery_method,
-                                           default)
-        category_settings(object, category).delivery_methods_
-                                           .fetch(delivery_method.to_s, default)
-      end
-
-      def do_not_notify_statuses
-        NotificationSettings.configuration.do_not_notify_statuses
-      end
-
-      def do_not_deliver_statuses
-        NotificationSettings.configuration.do_not_deliver_statuses
-      end
-    end
-    # rubocop:enable Metrics/ModuleLength
-  end
-end

data/lib/notification_settings/notification_scopes.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'notification-handler'
-require 'active_support'
-
-module NotificationSettings
-  module NotificationScopes
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      def method_missing(method, *args)
-        if method.to_s[/(.+)_category/]
-          where(category: $1.singularize.classify)
-        else
-          super
-        end
-      end
-
-      def respond_to_missing?(method, include_private = false)
-        super || method.to_s[/(.+)_category/]
-      end
-    end
-  end
-end

data/lib/notification_settings/preferences_form.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_model'
-
-module NotificationSettings
-  class PreferencesForm
-    include ActiveModel::Model
-
-    attribute :enabled, :boolean, default: true
-  end
-end

data/lib/notification_settings/settings.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support'
-require 'hashie'
-
-module NotificationSettings
-  module Settings
-    extend ActiveSupport::Concern
-
-    included do
-      before_validation :build_settings
-
-      serialize :settings, Hashie::Mash
-
-      include NotificationSettings::Settings::InstanceMethods
-    end
-
-    module InstanceMethods
-      private
-
-      def build_settings
-        return if settings.present? && settings.is_a?(Hashie::Mash)
-
-        self.settings = Hashie::Mash.new
-      end
-    end
-  end
-end

data/lib/notification_settings/status.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support'
-
-module NotificationSettings
-  module Status
-    extend ActiveSupport::Concern
-
-    included do
-      validates :status,
-                inclusion: { in: NotificationSettings.configuration.statuses }
-
-      include NotificationSettings::Status::InstanceMethods
-    end
-
-    module InstanceMethods
-      def status
-        self[:status] || default_status
-      end
-
-      private
-
-      def default_status
-        if idle? && !offline?
-          'idle'
-        elsif offline?
-          'offline'
-        else
-          'online'
-        end
-      end
-
-      def idle?
-        return unless time_since_last_seen_round
-
-        time_since_last_seen_round >= idle_after
-      end
-
-      def offline?
-        return unless time_since_last_seen_round
-
-        time_since_last_seen_round >= offline_after
-      end
-
-      def time_since_last_seen_round
-        time_since_last_seen&.round
-      end
-
-      def time_since_last_seen
-        return unless respond_to?(NotificationSettings.configuration.last_seen)
-
-        Time.now - send(NotificationSettings.configuration.last_seen)
-      end
-
-      def idle_after
-        NotificationSettings.configuration.idle_after
-      end
-
-      def offline_after
-        NotificationSettings.configuration.offline_after
-      end
-    end
-  end
-end

data/lib/notification_settings/subscribable.rb

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

data/lib/notification_settings/subscriber.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support'
-
-module NotificationSettings
-  module Subscriber
-    extend ActiveSupport::Concern
-
-    included do
-      has_many :notification_subscribables,
-               as: :subscriber,
-               class_name: 'NotificationSettings::Subscription',
-               dependent: :destroy
-
-      include NotificationSettings::Subscriber::InstanceMethods
-    end
-
-    module InstanceMethods
-      def subscribe(subscribable, options = {})
-        notification_subscribables.create(
-          options.merge(subscribable: subscribable)
-        )
-      end
-
-      def unsubscribe(subscribable)
-        subscription = notification_subscribables.find_by(
-          subscribable_id: subscribable.id,
-          subscribable_type: subscribable.class.name
-        )
-        subscription&.destroy
-      end
-    end
-  end
-end

data/lib/notification_settings/target.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support'
-
-module NotificationSettings
-  module Target
-    extend ActiveSupport::Concern
-
-    included do
-      include NotificationSettings::Settings
-      include NotificationSettings::Status
-    end
-  end
-end