noticed 1.5.9 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 367ce1b20a44bfc15ebf8aeaa0328ef90ad0673edd076e977d0e647a3a1b13b7
-  data.tar.gz: 437627e876b7e42243626bab168b9fd37d7da49c54309e2f8f9ef91dfb5e541b
+  metadata.gz: dec51920d13ba117cce592dc0545e22d5618528033e736b267238a8456cf8341
+  data.tar.gz: 503d20af8d1640173e066e99fe3c8794155666d1f84456731253de6524f1d8e0
 SHA512:
-  metadata.gz: 5991aa837054391b01f5614617db15951279d4015c96eab52194ad7a0ab05cf3d586353cb5968bb04584246b23682c75365858464062c852b70f9553f0be8ad5
-  data.tar.gz: ff4adba6ae61a08bf8dab9a4b27899c3e5dd3dea8e1475fa7f1da589db85ce17b264d02ed523ea38d905bd53016f2e1d483cf4a7c18ea9461e1b12ef056868e6
+  metadata.gz: 3d05f0f58b8d10e06782472cca617de0ba0140e42ffa0a7995adf80467fa88ae49f7656e0dd3c52d4e3130e9c3908543e5b72d05884431940422b092c50b7258
+  data.tar.gz: 602e15164492cf2de75d6b3b43a33d67312fdd18fa0cd42fd1b3a6d4f3397ab5d283b2346a3b019dfb9dd7f79b265387b927e135fb41e560fb3fa13ba0d99d7a

data/README.md

@@ -194,6 +194,8 @@ deliver_by :slack, debug: true
 
 ## ✅ Best Practices
 
+### Creating a notification from an Active Record callback
+
 A common use case is to trigger a notification when a record is created. For example,
 
 ```ruby
@@ -217,6 +219,23 @@ A common symptom of this problem is undelivered notifications and the following
 
 > `Discarded Noticed::DeliveryMethods::Email due to a ActiveJob::DeserializationError.`
 
+### Renaming notifications
+
+If you rename the class of a notification object your existing queries can break. This is because Noticed serializes the class name and sets it to the `type` column on the `Notification` record.
+
+You can catch these errors at runtime by using `YourNotificationClassName.name` instead of hardcoding the string when performing a query.
+
+```ruby
+Notification.where(type: YourNotificationClassName.name) # good
+Notification.where(type: "YourNotificationClassName") # bad
+```
+
+When renaming a notification class you will need to backfill existing notifications to reference the new name.
+
+```ruby
+Notification.where(type: "OldNotificationClassName").update_all(type: NewNotificationClassName.name)
+```
+
 ## 🚛 Delivery Methods
 
 The delivery methods are designed to be modular so you can customize the way each type gets delivered.
@@ -351,22 +370,6 @@ class DeliveryMethods::Discord < Noticed::DeliveryMethods::Base
 end
 ```
 
-#### Limitations
-
-Rails 6.1+ can serialize Class and Module objects as arguments to ActiveJob. The following syntax should work for Rails 6.1+:
-
-```ruby
-  deliver_by DeliveryMethods::Discord
-```
-
-For Rails 5.2 and 6.0, you must pass strings of the class names in the `deliver_by` options.
-
-```ruby
-  deliver_by :discord, class: "DeliveryMethods::Discord"
-```
-
-We recommend using a string in order to prevent confusion.
-
 ### 📦 Database Model
 
 The Notification database model includes several helpful features to make working with database notifications easier.

data/lib/generators/noticed/model/base_generator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+
+module Noticed
+  module Generators
+    module Model
+      class BaseGenerator < Rails::Generators::NamedBase
+        include Rails::Generators::ResourceHelpers
+
+        source_root File.expand_path("../templates", __FILE__)
+
+        desc "Generates a Notification model for storing notifications."
+
+        argument :name, type: :string, default: "Notification", banner: "Notification"
+        argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+        def generate_notification
+          binding.irb
+          generate :model, name, "recipient:references{polymorphic}", "type", "params:#{json_column_type}", "read_at:datetime:index", *attributes
+        end
+
+        def add_noticed_model
+          inject_into_class model_path, class_name, "  include Noticed::Model\n"
+        end
+
+        def add_not_nullable
+          migration_path = Dir.glob(Rails.root.join("db/migrate/*")).max_by { |f| File.mtime(f) }
+
+          # Force is required because null: false already exists in the file and Thor isn't smart enough to tell the difference
+          insert_into_file migration_path, after: "t.string :type", force: true do
+            ", null: false"
+          end
+        end
+
+        def done
+          readme "README" if behavior == :invoke
+        end
+
+        private
+
+        def model_path
+          @model_path ||= File.join("app", "models", "#{file_path}.rb")
+        end
+      end
+    end
+  end
+end

data/lib/generators/noticed/model/mysql_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+require_relative "base_generator"
+
+module Noticed
+  module Generators
+    module Model
+      class MysqlGenerator < BaseGenerator
+        private
+
+        def json_column_type
+          "json"
+        end
+      end
+    end
+  end
+end

data/lib/generators/noticed/model/postgresql_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+require_relative "base_generator"
+
+module Noticed
+  module Generators
+    module Model
+      class PostgresqlGenerator < BaseGenerator
+        private
+
+        def json_column_type
+          "jsonb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/noticed/model/sqlite3_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+require_relative "base_generator"
+
+module Noticed
+  module Generators
+    module Model
+      class Sqlite3Generator < BaseGenerator
+        private
+
+        def json_column_type
+          "json"
+        end
+      end
+    end
+  end
+end

data/lib/generators/noticed/templates/README

@@ -3,5 +3,5 @@
 
 Next steps:
 1. Run "rails db:migrate"
-2. Add "has_many :notifications, as: :recipient" to your User model(s).
+2. Add "has_many :notifications, as: :recipient, dependent: :destroy" to your User model(s).
 3. Generate notifications with "rails g noticed:notification"

data/lib/noticed/base.rb

@@ -75,6 +75,10 @@ module Noticed
       @params || {}
     end
 
+    def clear_recipient
+      self.recipient = nil
+    end
+
     private
 
     # Runs all delivery methods for a notification

data/lib/noticed/coder.rb

@@ -3,6 +3,8 @@ module Noticed
     def self.load(data)
       return if data.nil?
       ActiveJob::Arguments.send(:deserialize_argument, data)
+    rescue ActiveRecord::RecordNotFound => error
+      {noticed_error: error.message, original_params: data}
     end
 
     def self.dump(data)

data/lib/noticed/delivery_methods/email.rb

@@ -5,9 +5,9 @@ module Noticed
 
       def deliver
         if options[:enqueue]
-          mailer.with(format).send(method.to_sym).deliver_later
+          mailer.with(format).send(mailer_method.to_sym).deliver_later
         else
-          mailer.with(format).send(method.to_sym).deliver_now
+          mailer.with(format).send(mailer_method.to_sym).deliver_now
         end
       end
 
@@ -33,7 +33,7 @@ module Noticed
       # If notification responds to symbol, call that method and use return value
       # If notification does not respond to symbol, use the symbol for the mailer method
       # Otherwise, use the underscored notification class name as the mailer method
-      def method
+      def mailer_method
         method_name = options[:method]&.to_sym
         if method_name.present?
           notification.respond_to?(method_name) ? notification.send(method_name) : method_name

data/lib/noticed/model.rb

@@ -13,7 +13,11 @@ module Noticed
     included do
       self.inheritance_column = nil
 
-      serialize :params, noticed_coder
+      if Rails.gem_version >= Gem::Version.new("7.1")
+        serialize :params, coder: noticed_coder
+      else
+        serialize :params, noticed_coder
+      end
 
       belongs_to :recipient, polymorphic: true
 
@@ -72,5 +76,10 @@ module Noticed
     def read?
       read_at?
     end
+
+    # If a GlobalID record in params is no longer found, the params will default with a noticed_error key
+    def deserialize_error?
+      !!params[:noticed_error]
+    end
   end
 end

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "1.5.9"
+  VERSION = "1.6.1"
 end

data/lib/noticed.rb

@@ -16,22 +16,13 @@ module Noticed
     autoload :Base, "noticed/delivery_methods/base"
     autoload :Database, "noticed/delivery_methods/database"
     autoload :Email, "noticed/delivery_methods/email"
+    autoload :Fcm, "noticed/delivery_methods/fcm"
     autoload :Ios, "noticed/delivery_methods/ios"
     autoload :MicrosoftTeams, "noticed/delivery_methods/microsoft_teams"
     autoload :Slack, "noticed/delivery_methods/slack"
     autoload :Test, "noticed/delivery_methods/test"
     autoload :Twilio, "noticed/delivery_methods/twilio"
     autoload :Vonage, "noticed/delivery_methods/vonage"
-    autoload :Fcm, "noticed/delivery_methods/fcm"
-  end
-
-  def self.notify(recipients:, notification:)
-    recipients.each do |recipient|
-      notification.notify(recipient)
-    end
-
-    # Clear the recipient after sending to the group
-    notification.recipient = nil
   end
 
   mattr_accessor :parent_class

data/lib/rails_6_polyfills/actioncable/test_helper.rb

@@ -5,7 +5,7 @@ module ActionCable
   module Server
     class Configuration
       def pubsub_adapter
-        cable["adapter"] == "test" ? ActionCable::SubscriptionAdapter::Test : super
+        (cable["adapter"] == "test") ? ActionCable::SubscriptionAdapter::Test : super
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.6.1
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2023-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,76 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
-- !ruby/object:Gem::Dependency
-  name: pg
-  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: standard
-  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: webmock
-  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: mysql2
-  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'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Database, browser, realtime ActionCable, Email, SMS, Slack notifications,
   and more for Rails apps
 email:
@@ -120,6 +50,10 @@ files:
 - README.md
 - Rakefile
 - lib/generators/noticed/delivery_method_generator.rb
+- lib/generators/noticed/model/base_generator.rb
+- lib/generators/noticed/model/mysql_generator.rb
+- lib/generators/noticed/model/postgresql_generator.rb
+- lib/generators/noticed/model/sqlite3_generator.rb
 - lib/generators/noticed/model_generator.rb
 - lib/generators/noticed/notification_generator.rb
 - lib/generators/noticed/templates/README
@@ -170,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: Notifications for Ruby on Rails applications