notification-handler 1.2.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 487a429c1a9affdd1a4134cf9f25db17f959c348235c1e84030d6ae8f864d11b
-  data.tar.gz: 789a52f5f28e9eaeca91729f7780e8ce002aba23d1f717fb4ebad78cf29d557f
+  metadata.gz: f2cdb58ba8f4da880b60d9443747199aac809a9fc881c52ea6d6521b02ebb1c6
+  data.tar.gz: 2b22c562259da40608261bd742224fc6302ba678e2536ece9c01a01a01c51d82
 SHA512:
-  metadata.gz: f953fa2ea9805a60524117a04313b9b26eb2349fbe1a606d13daab4f5fd5e8e03a209b596f23f235a1c2774445c3b286494070369a3e54962f9910af426b9b26
-  data.tar.gz: c578e829f2cf2aad8d73ba459289db0c658b324a78b24217149757fd87d64a1533ebac9faada3e7756a2f45983ab408e3562af268bd8e72de3501238d759a533
+  metadata.gz: a6eb0d2c4cc82ca45ca54d08bc4bf75aaa531d793a31109c0644345e2e00d392f84bf145b414863b835225e52a2249d64ff12df872b2698657ba6ce0b7401693
+  data.tar.gz: cac446fcf48614af0346f947a181be5bfbb5a2fe9f54dd3aebd7e0b231d2550d73f851fad439cf3a07565e8daa9f7278ccc9c5ddd59395b8ee82a1d8e9d50aea

data/README.md

@@ -1,6 +1,6 @@
 # NotificationHandler
 
-[![Gem Version](https://badge.fury.io/rb/notification-handler.svg)](https://badge.fury.io/rb/notification-handler) <img src="https://travis-ci.org/jonhue/notifications-rails.svg?branch=master" />
+[![Gem Version](https://badge.fury.io/rb/notification-handler.svg)](https://badge.fury.io/rb/notification-handler) ![Travis](https://travis-ci.com/jonhue/notifications-rails.svg?branch=master)
 
 Create and modify your notifications through a simple API.
 
@@ -10,19 +10,17 @@ Create and modify your notifications through a simple API.
 
 * [Installation](#installation)
 * [Usage](#usage)
-    * [`Notification` API](#notification-api)
-    * [`notification_target`](#notification_target)
-    * [`notification_object`](#notification_object)
-    * [Groups](#groups)
-        * [Defining a group](#defining-a-group)
-        * [Using a group](#using-a-group)
-    * [Caching](#caching)
+  * [`Notification` API](#notification-api)
+  * [`notification_target`](#notification_target)
+  * [`notification_object`](#notification_object)
+  * [Groups](#groups)
+    * [Defining a group](#defining-a-group)
+    * [Using a group](#using-a-group)
+  * [Caching](#caching)
 * [Configuration](#configuration)
 * [To Do](#to-do)
 * [Contributing](#contributing)
-    * [Contributors](#contributors)
-    * [Semantic versioning](#semantic-versioning)
-* [License](#license)
+  * [Semantic versioning](#semantic-versioning)
 
 ---
 
@@ -42,12 +40,6 @@ Or install it yourself as:
 
     $ gem install notification-handler
 
-If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
-
-```ruby
-gem 'notification-handler', github: 'jonhue/notifications-rails'
-```
-
 Now run the generator:
 
     $ rails g notification_handler:install
@@ -78,8 +70,8 @@ To store information in your `Notification` record you can use the `metadata` at
 
 ```ruby
 notification.metadata = {
-    title: 'My first notification',
-    content: "It looks great, doesn't it?"
+  title: 'My first notification',
+  content: "It looks great, doesn't it?"
 }
 ```
 
@@ -116,7 +108,7 @@ To use records of an ActiveRecord class as notification targets, add the followi
 
 ```ruby
 class User < ApplicationRecord
-    notification_target
+  notification_target
 end
 ```
 
@@ -129,7 +121,7 @@ notifications = User.first.notifications
 You can create a notification from a `target`:
 
 ```ruby
-User.first.notify object: Recipe.first
+User.first.notify(object: Recipe.first)
 ```
 
 ...
@@ -140,7 +132,7 @@ When using records of an ActiveRecord class as notification objects, add this to
 
 ```ruby
 class Recipe < ApplicationRecord
-    notification_object
+  notification_object
 end
 ```
 
@@ -162,7 +154,7 @@ You define groups in your `NotificationHandler` configuration:
 
 ```ruby
 NotificationHandler.configure do |config|
-    config.define_group :subscribers, User.where(subscriber: true)
+  config.define_group :subscribers, -> { User.where(subscriber: true) }
 end
 ```
 
@@ -170,16 +162,22 @@ When creating a notification for the group `:subscribers`, one notification will
 
 ```ruby
 NotificationHandler.configure do |config|
-    config.define_group :subscribers, User.where(subscriber: true) + Admin.all
+  config.define_group :subscribers,     -> { User.where(subscriber: true) + Admin.all }
+  config.define_group :company_members, lambda { |company_id|
+    User.with_role(:member, Company.find(company_id)
+  }
 end
 ```
 
+The only requirement is that the result of evaluating the proc be Enumerable.
+
 #### Using a group
 
 Bulk-creation of notifications for a certain group is fairly simple:
 
 ```ruby
-notification = Notification.create object: Recipe.first, group: :subscribers
+notification = Notification.create(object: Recipe.first, group: :subscribers)
+notification = Notification.create(object: Recipe.first, group: :company_members, group_args: 4)
 ```
 
 **Note:** You are not able to set the `target` attribute when a `group` has been specified.
@@ -203,7 +201,7 @@ You can configure NotificationHandler by passing a block to `configure`. This ca
 
 ```ruby
 NotificationHandler.configure do |config|
-    config.cache = true
+  config.cache = true
 end
 ```
 
@@ -213,7 +211,7 @@ end
 
 ## To Do
 
-[Here](https://github.com/jonhue/notifications-rails/projects/2) is the full list of current projects.
+We use [GitHub projects](https://github.com/jonhue/notifications-rails/projects/2) to coordinate the work on this project.
 
 To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
 
@@ -225,36 +223,6 @@ We hope that you will consider contributing to NotificationHandler. Please read
 
 [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
 
 NotificationHandler 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.

data/app/models/notification_handler/notification.rb

@@ -2,7 +2,7 @@
 
 module NotificationHandler
   class Notification < ApplicationRecord
-    include NotificationHandler::NotificationLibrary
+    include NotificationHandler::NotificationLib
     include NotificationHandler::NotificationScopes
   end
 end

data/lib/generators/notification_handler/install_generator.rb

@@ -19,7 +19,7 @@ module NotificationHandler
     end
 
     def create_initializer
-      template 'initializer.rb', 'config/initializers/notification-handler.rb'
+      template 'initializer.rb', 'config/initializers/notification_handler.rb'
     end
 
     def create_notifications_migration_file

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

@@ -8,5 +8,5 @@ NotificationHandler.configure do |config|
   # Groups are a powerful way to bulk-create notifications for multiple objects
   # that don't necessarily have a common class.
   # Learn more: https://github.com/jonhue/notifications-rails/tree/master/notification-handler#groups
-  # config.define_group :subscribers, User.where(subscriber: true)
+  # config.define_group :subscribers, -> { User.where(subscriber: true) }
 end

data/lib/notification-handler.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
 module NotificationHandler
-  require 'notification_handler/configuration'
+  require_relative 'notification_handler/configuration'
 
-  require 'notification_handler/engine'
+  require_relative 'notification_handler/engine'
 
   autoload :Group, 'notification_handler/group'
 
   autoload :Target, 'notification_handler/target'
   autoload :Object, 'notification_handler/object'
-  autoload :NotificationLibrary, 'notification_handler/notification_library'
+  autoload :NotificationLib, 'notification_handler/notification_lib'
   autoload :NotificationScopes, 'notification_handler/notification_scopes'
-
-  require 'notification_handler/railtie'
 end

data/lib/notification_handler/configuration.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
+require_relative 'group'
+
 module NotificationHandler
   class << self
-    attr_accessor :configuration
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
   end
 
   def self.configure
-    self.configuration ||= Configuration.new
     yield configuration
   end
 
@@ -15,12 +20,12 @@ module NotificationHandler
     attr_accessor :cache
 
     def initialize
-      @groups = []
+      @groups = {}
       @cache = false
     end
 
     def define_group(name, target_scope)
-      groups << ::NotificationHandler::Group.new(name.to_sym, target_scope)
+      groups[name.to_sym] = ::NotificationHandler::Group.new(target_scope)
     end
   end
 end

data/lib/notification_handler/engine.rb

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 
-require 'rails/railtie'
+require 'rails/engine'
 require 'active_record'
 
 module NotificationHandler
   class Engine < ::Rails::Engine
+    initializer 'notification-handler.active_record' do
+      ActiveSupport.on_load :active_record do
+        include NotificationHandler::Target
+        include NotificationHandler::Object
+      end
+    end
   end
 end

data/lib/notification_handler/group.rb

@@ -2,18 +2,21 @@
 
 module NotificationHandler
   class Group
-    attr_accessor :name
-    attr_accessor :target_scope
+    attr_reader :target_scope
 
-    def initialize(name, target_scope)
-      @name = name
+    def initialize(target_scope)
       @target_scope = target_scope
     end
 
     def self.find_by_name(name)
-      NotificationHandler.configuration.groups.select do |group|
-        group.name == name.to_sym
-      end
+      NotificationHandler.configuration.groups[name]
+    end
+
+    def self.find_by_name!(name)
+      find_by_name(name) ||
+        raise(ArgumentError,
+              "Could not find a registered group for #{name}. " \
+              "Make sure you register it with config.define_group :#{name}")
     end
   end
 end

data/lib/notification_handler/{notification_library.rb → notification_lib.rb}

@@ -3,7 +3,7 @@
 require 'active_support'
 
 module NotificationHandler
-  module NotificationLibrary
+  module NotificationLib
     extend ActiveSupport::Concern
 
     included do
@@ -14,20 +14,21 @@ module NotificationHandler
 
       serialize :metadata, Hash
       attr_accessor :group
+      attr_accessor :group_args
 
       belongs_to :target, polymorphic: true
       belongs_to :object, polymorphic: true, optional: true
 
-      include NotificationHandler::NotificationLibrary::InstanceMethods
+      include NotificationHandler::NotificationLib::InstanceMethods
 
       if defined?(NotificationRenderer)
-        include NotificationRenderer::NotificationLibrary
+        include NotificationRenderer::NotificationLib
       end
       if defined?(NotificationPusher)
-        include NotificationPusher::NotificationLibrary
+        include NotificationPusher::NotificationLib
       end
       if defined?(NotificationSettings)
-        include NotificationSettings::NotificationLibrary
+        include NotificationSettings::NotificationLib
       end
     end
 
@@ -45,15 +46,14 @@ module NotificationHandler
       def create_for_group
         return if group.nil?
 
-        target_scope = NotificationHandler::Group.find_by_name(group)
-                                                 .last.target_scope
-        target_scope&.each do |target|
-          notification = dup
+        target_scope = NotificationHandler::Group.find_by_name!(group)
+                                                 .target_scope
+        target_scope.call(*group_args)&.each_with_index do |target, index|
+          notification = index.zero? ? self : dup
           notification.target = target
           notification.group = nil
-          notification.save
+          notification.save!
         end
-        false
       end
 
       def cache

data/lib/notification_handler/object.rb

@@ -13,6 +13,7 @@ module NotificationHandler
         include NotificationHandler::Object::InstanceMethods
 
         return unless defined?(NotificationSettings)
+
         include NotificationSettings::Subscribable
       end
     end

data/lib/notification_handler/target.rb

@@ -13,6 +13,7 @@ module NotificationHandler
 
         include NotificationSettings::Target if defined?(NotificationSettings)
         return unless defined?(NotificationSettings)
+
         include NotificationSettings::Subscriber
       end
     end

metadata

@@ -1,59 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: notification-handler
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-22 00:00:00.000000000 Z
+date: 2019-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        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: '5.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  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:
     - - ">="
@@ -94,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
 description: Create and modify your notifications through a simple API.
 email: me@jonhue.me
 executables: []
@@ -111,10 +167,9 @@ files:
 - lib/notification_handler/configuration.rb
 - lib/notification_handler/engine.rb
 - lib/notification_handler/group.rb
-- lib/notification_handler/notification_library.rb
+- lib/notification_handler/notification_lib.rb
 - lib/notification_handler/notification_scopes.rb
 - lib/notification_handler/object.rb
-- lib/notification_handler/railtie.rb
 - lib/notification_handler/target.rb
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-handler
 licenses:
@@ -135,8 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Create and modify your notifications through a simple API

data/lib/notification_handler/railtie.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/railtie'
-require 'active_record'
-require 'active_support'
-
-module NotificationHandler
-  class Railtie < Rails::Railtie
-    initializer 'notification-handler.active_record' do
-      ActiveSupport.on_load :active_record do
-        include NotificationHandler::Target
-        include NotificationHandler::Object
-      end
-    end
-  end
-end