noticed 2.7.1 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e9d45f1b942d7e3ad80d8fede7d76ab3b1c503d2e752508bf498e0779299a79
-  data.tar.gz: ac97b350124abce45eb8d7a875fd99a1252769690b50e72335efdfdb76e19bb6
+  metadata.gz: afd30437fc53aab8cee21f63530ce41e5b349037b517679a3d0fae3e2c315c3e
+  data.tar.gz: 701eba3612bdddace5ec6421c16fe66290a6f591cfa91258c6bd2397c95a56e5
 SHA512:
-  metadata.gz: 9cc04c25fad32bd8bfe44d231b0dc51c59f4f248d4125885def6867d158d18d33bd0389f69d6ced75ed8fb65096b43be22ed12ca6f1995e1d2a02860f2ce2bc5
-  data.tar.gz: c5a3baa9b0f010f9d592e3fb42b185dad515595768a451763eab62954e987989e128b7d6b1fa27abe3ab5f2d362bb13e93d464b50f022d763d4cbd28bd16e183
+  metadata.gz: 0e44bf6d5ac832e7307314f5598ecf75abeafbc9049324361c8b57e12e565e9b096c49c02487c3bc1e50a2016a8c07e83239b79bff73af7a4e36870632c03455
+  data.tar.gz: 0afb4e395bd954663fd191b136456e5d79debb9af7595a6391a20930456d2760f9db274a8b0845713bb330ada1e7e0298905b07b8f379def4dcf6a2c2b671996

data/README.md

@@ -4,9 +4,6 @@
 
 [![Build Status](https://github.com/excid3/noticed/workflows/Tests/badge.svg)](https://github.com/excid3/noticed/actions) [![Gem Version](https://badge.fury.io/rb/noticed.svg)](https://badge.fury.io/rb/noticed)
 
-> [!IMPORTANT]
-> **⚠️ Upgrading from V1? Read the [Upgrade Guide](https://github.com/excid3/noticed/blob/main/UPGRADE.md)!**
-
 Noticed is a gem that allows your application to send notifications of varying types, over various mediums, to various recipients. Be it a Slack notification to your own team when some internal event occurs or a notification to your user, sent as a text message, email, and real-time UI element in the browser, Noticed supports all of the above (at the same time)!
 
 Noticed implements two top-level types of delivery methods:
@@ -594,7 +591,9 @@ You can mix and match the options and delivery methods to suit your application
 
 If you want to build your own delivery method to deliver notifications to a specific service or medium that Noticed doesn’t (or doesn’t _yet_) support, you’re welcome to do so! To generate a custom delivery method, simply run
 
-`rails generate noticed:delivery_method Discord`
+```bash
+rails generate noticed:delivery_method Discord
+```
 
 This will generate a new `ApplicationDeliveryMethod` and `DeliveryMethods::Discord` class inside the `app/notifiers/delivery_methods` folder, which can be used to deliver notifications to Discord.
 
@@ -607,7 +606,6 @@ class DeliveryMethods::Discord < ApplicationDeliveryMethod
     # Logic for sending the notification
   end
 end
-
 ```
 
 You can use the custom delivery method thus created by adding a `deliver_by` line with a unique name and `class` option in your notification class.
@@ -618,6 +616,12 @@ class MyNotifier < Noticed::Event
 end
 ```
 
+You can also generate bulk delivery methods with the `--bulk` flag:
+
+```bash
+rails generate noticed:delivery_method Discord --bulk
+```
+
 <details>
 <summary>Turbo Stream Custom Delivery Method Example</summary>
 

data/lib/generators/noticed/delivery_method_generator.rb

@@ -11,9 +11,16 @@ module Noticed
 
       desc "Generates a class for a custom delivery method with the given NAME."
 
+      class_option :bulk, desc: "Generate as a bulk delivery method", type: :boolean, default: false
+
       def generate_notification
-        template "application_delivery_method.rb", "app/notifiers/application_delivery_method.rb"
-        template "delivery_method.rb", "app/notifiers/delivery_methods/#{singular_name}.rb"
+        if options[:bulk]
+          template "application_bulk_delivery_method.rb", "app/notifiers/application_bulk_delivery_method.rb"
+          template "bulk_delivery_method.rb", "app/notifiers/bulk_delivery_methods/#{singular_name}.rb"
+        else
+          template "application_delivery_method.rb", "app/notifiers/application_delivery_method.rb"
+          template "delivery_method.rb", "app/notifiers/delivery_methods/#{singular_name}.rb"
+        end
       end
     end
   end

data/lib/generators/noticed/templates/application_bulk_delivery_method.rb.tt

@@ -0,0 +1,2 @@
+class ApplicationBulkDeliveryMethod < Noticed::BulkDeliveryMethod
+end

data/lib/generators/noticed/templates/bulk_delivery_method.rb.tt

@@ -0,0 +1,14 @@
+class BulkDeliveryMethods::<%= class_name %> < ApplicationBulkDeliveryMethod
+  # To use this delivery method, specify the class option in your notifier.
+  #
+  #   class MyNotifer < ApplicationNotifier
+  #     bulk_deliver_by :<%= file_path %>, class: "<%= class_name %>"
+  #   end
+
+  # Specify required options for the deliver_by config block
+  # required_options :foo, :bar
+
+  def deliver
+    # Logic for sending the notification
+  end
+end

data/lib/generators/noticed/templates/delivery_method.rb.tt

@@ -1,6 +1,12 @@
 class DeliveryMethods::<%= class_name %> < ApplicationDeliveryMethod
-  # Specify the config options your delivery method requires in its config block
-  required_options # :foo, :bar
+  # To use this delivery method, specify the class option in your notifier.
+  #
+  #   class MyNotifer < ApplicationNotifier
+  #     deliver_by :<%= file_path %>, class: "<%= class_name %>"
+  #   end
+
+  # Specify required options for the deliver_by config block
+  # required_options :foo, :bar
 
   def deliver
     # Logic for sending the notification

data/lib/generators/noticed/templates/notifier.rb.tt

@@ -21,4 +21,10 @@ class <%= class_name %>Notifier < ApplicationNotifier
   # Add required params
   #
   # required_param :message
+
+  # Compute recipients without having to pass them in
+  #
+  # recipients do
+  #   params[:record].thread.all_authors
+  # end
 end

data/lib/noticed/coder.rb

@@ -11,7 +11,11 @@ module Noticed
 
     def self.dump(data)
       return if data.nil?
-      ActiveJob::Arguments.send(:serialize_argument, data)
+      if Rails.gem_version >= Gem::Version.new("8.1.0.beta1")
+        ActiveJob::Arguments.serialize(data)
+      else
+        ActiveJob::Arguments.send(:serialize_argument, data)
+      end
     end
   end
 end

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "2.7.1"
+  VERSION = "2.8.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.1
 platform: ruby
 authors:
 - Chris Oliver
@@ -50,8 +50,10 @@ files:
 - lib/generators/noticed/install_generator.rb
 - lib/generators/noticed/notifier_generator.rb
 - lib/generators/noticed/templates/README
+- lib/generators/noticed/templates/application_bulk_delivery_method.rb.tt
 - lib/generators/noticed/templates/application_delivery_method.rb.tt
 - lib/generators/noticed/templates/application_notifier.rb.tt
+- lib/generators/noticed/templates/bulk_delivery_method.rb.tt
 - lib/generators/noticed/templates/delivery_method.rb.tt
 - lib/generators/noticed/templates/notifier.rb.tt
 - lib/noticed.rb