signum 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80bcbf3b5c508331a717b1f9b17b7d14b06c88612f54635e45f87643453ddf5b
-  data.tar.gz: 5e44b69680cd000e0a048d595aa0539114b3fb1b9424a9b5812eff94d41d80fa
+  metadata.gz: 63cc9c70f252bac415cd89556051daffc3449d4175726cc272b26ba50a04d04b
+  data.tar.gz: 66eab14fd02f1cff3a5008bcaef2e9be94389e62a9a3c2f832243f2b4ac2a490
 SHA512:
-  metadata.gz: d698d607336e153b25d2dfbe5717bbdeb7338a88c77049dbfa7c40e24b3cbcdd2918baedb902e360b47b67a0bed9827b73bc9604562263c27de95279d89c9571
-  data.tar.gz: a94a9bea7fb4242fd2f9fd312ffbf2730bd4f8479244828ce977f39b54ea784c7b4048e0c66b6a04a133a1665a590d633964ade726d4af7b73414f3618bd2122
+  metadata.gz: 0d88fa165327a524271be29b1163350df04d52736c60354378f2a7ef2226d8567d58380991ac0e12e3c8f318d660be892ff504e46d7edd1a369fefdb0c405064
+  data.tar.gz: 0333cebc07d9d42445be878c069528cb09f6bd272ed450479ac4168fbfa5c0ec483f561f1896dedba65bb0e1eb31406aa538a1b403c6e0f98ad4eace747bb71e

data/.rubocop.yml

@@ -0,0 +1,14 @@
+# https://www.fastruby.io/blog/ruby/code-quality/how-we-use-rubocop-and-standardrb.html
+
+require:
+  - standard
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - node_modules/**/*
+    - public/**/*
+    - vendor/**/*

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 git_source(:entdec) { |repo_name| "git@github.com:entdec/#{repo_name}.git" }
 
@@ -17,7 +17,6 @@ gemspec
 # To use a debugger
 # gem 'byebug', group: [:development, :test]
 
-gem 'auxilium', '~> 3', entdec: 'auxilium'
+gem "auxilium", "~> 3", entdec: "auxilium"
 
-gem "ruby-lsp", "~> 0.3.2", :group => :development
-gem "sprockets-rails"
+gem "sprockets-rails"

data/Gemfile.lock

@@ -13,15 +13,16 @@ GIT
 PATH
   remote: .
   specs:
-    signum (0.3.18)
+    signum (0.6.0)
       importmap-rails
       pg
       rails (> 6.0)
       slim-rails (~> 3)
-      state_machines-activemodel
+      state_machines-activerecord
       stimulus-rails
       tailwindcss-rails
       turbo-rails
+      view_component
 
 GEM
   remote: https://rubygems.org/
@@ -100,6 +101,7 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
+    ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.6)
     builder (3.2.4)
@@ -107,6 +109,7 @@ GEM
     connection_pool (2.4.1)
     crass (1.0.6)
     date (3.3.4)
+    debug (0.2.1)
     drb (2.2.0)
       ruby2_keywords
     erubi (1.12.0)
@@ -122,7 +125,9 @@ GEM
     irb (1.11.2)
       rdoc
       reline (>= 0.4.2)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -132,6 +137,7 @@ GEM
       net-pop
       net-smtp
     marcel (1.0.4)
+    method_source (1.0.0)
     mini_mime (1.1.5)
     mini_portile2 (2.8.5)
     minitest (5.22.2)
@@ -143,14 +149,17 @@ GEM
       net-protocol
     net-protocol (0.2.2)
       timeout
-    net-smtp (0.4.0.1)
+    net-smtp (0.5.0)
       net-protocol
-    nio4r (2.7.0)
+    nio4r (2.7.1)
     nokogiri (1.16.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
     pg (1.5.6)
-    prettier_print (1.2.1)
     psych (5.1.2)
       stringio
     pundit (2.3.1)
@@ -193,19 +202,35 @@ GEM
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
+    rainbow (3.1.1)
     rake (13.1.0)
     rdoc (6.6.2)
       psych (>= 4.0.0)
+    regexp_parser (2.9.0)
     reline (0.4.3)
       io-console (~> 0.5)
     responders (3.1.1)
       actionpack (>= 5.2)
       railties (>= 5.2)
+    rexml (3.2.6)
     rolify (6.0.1)
-    ruby-lsp (0.3.8)
-      language_server-protocol (~> 3.17.0)
-      sorbet-runtime
-      syntax_tree (>= 5.0.0, < 6)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     slim (5.2.1)
       temple (~> 0.10.0)
@@ -214,7 +239,6 @@ GEM
       actionpack (>= 3.1)
       railties (>= 3.1)
       slim (>= 3.0, < 6.0, != 5.0.0)
-    sorbet-runtime (0.5.11276)
     sprockets (4.2.1)
       concurrent-ruby (~> 1.0)
       rack (>= 2.2.4, < 4)
@@ -224,16 +248,29 @@ GEM
       sprockets (>= 3.0.0)
     sqlite3 (1.7.2)
       mini_portile2 (~> 2.8.0)
+    standard (1.35.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.62.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
     state_machines (0.6.0)
     state_machines-activemodel (0.9.0)
       activemodel (>= 6.0)
       state_machines (>= 0.6.0)
+    state_machines-activerecord (0.9.0)
+      activerecord (>= 6.0)
+      state_machines-activemodel (>= 0.9.0)
     stimulus-rails (1.3.3)
       railties (>= 6.0.0)
     stringio (3.1.0)
-    syntax_tree (5.3.0)
-      prettier_print (>= 1.2.0)
-    tailwindcss-rails (2.3.0)
+    tailwindcss-rails (2.4.0)
       railties (>= 6.0.0)
     temple (0.10.3)
     thor (1.3.1)
@@ -245,6 +282,11 @@ GEM
       railties (>= 6.0.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    view_component (3.11.0)
+      activesupport (>= 5.2.0, < 8.0)
+      concurrent-ruby (~> 1.0)
+      method_source (~> 1.0)
     webrick (1.8.1)
     websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
@@ -256,10 +298,12 @@ PLATFORMS
 
 DEPENDENCIES
   auxilium (~> 3)!
-  ruby-lsp (~> 0.3.2)
+  debug (~> 0)
+  rubocop (~> 1)
   signum!
   sprockets-rails
   sqlite3
+  standard (~> 1)
 
 BUNDLED WITH
    2.3.17

data/README.md

@@ -51,14 +51,14 @@ s = Signum.signal(Current.user, text: "Hello World New", title: "Icon", icon:'fa
 
 Buttons and links:
 ```ruby
-s = Signum.success(Current.user, text: "Hello World New", title: "Link1", metadata: {buttons:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}], links:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"}]})
-s = Signum.signal(Current.user, text: "Hello World New", title: "Link2", metadata: {buttons:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}], links:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"}]}, icon: 'fa-regular fa-t-rex')
-s = Signum.signal(Current.user, text: "Hello World New", title: "Link2", metadata: {buttons:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}], links:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"},{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"},{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"}]})
+s = Signum.success(Current.user, text: "Hello World New", title: "Link1", buttons:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}], links:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"}])
+s = Signum.signal(Current.user, text: "Hello World New", title: "Link2", buttons:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}], links:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"}], icon: 'fa-regular fa-t-rex')
+s = Signum.signal(Current.user, text: "Hello World New", title: "Link2", buttons:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}], links:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"},{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"},{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"}])
 ```
 
 You can also show a progressbar, this is based on count and total. Setting the count to total completes the progressbar.
 ```ruby
-s = Signum.success(Current.user, text: "Hello World New", title: "this is test title", metadata: {buttons:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}], links:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"}]}, count: 75, total: 150)
+s = Signum.success(Current.user, text: "Hello World New", title: "this is test title", buttons:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}], links:[{title: "Google", url:"http://www.google.com"}, {title: "Apple", url: "http://www.apple.com"}, {title: "Amazon", url: "http://www.amazon.com"}], count: 75, total: 150)
 ```
 
 You can also attach attachments
@@ -70,6 +70,18 @@ s = Signum.success(Current.user, text: "Hello World New", title: "this is test t
 
 Signum returns you the signal object. You can update these signals and they will be rebroadcasted again.
 
+### Keys
+
+Next to using a User (or any other model) another option is to use keys instead. You could signal all users using the following:
+```ruby
+s = Signum.signal(:all, text: "Hello World New", title: "Icon", icon:'fa-regular fa-t-rex')
+```
+
+The key all is supported out of the box, any other key needs you to pass it in the Notifications::Component, here we're using the session.id:
+```slim
+= render(Signum::Notifications::Component.new([request.session.id]))
+```
+
 ## Contributing
 
 Contribution directions go here.

data/Rakefile

@@ -1,36 +1,36 @@
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Signum'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "Signum"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
+load "rails/tasks/engine.rake"
 
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/statistics.rake"
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 
 task default: :test
 
 # Adds the Auxilium semver task
-spec = Gem::Specification.find_by_name 'auxilium'
+spec = Gem::Specification.find_by_name "auxilium"
 load "#{spec.gem_dir}/lib/tasks/semver.rake"

data/app/components/signum/notification_body/component.html.slim

@@ -11,11 +11,11 @@
         - if signal.text.present?
           p.signum-notification-body__mb__bc__mc__tx
             = sanitize signal.text
-        - if signal.metadata.present? && signal.metadata["links"].present?
+        - if signal.links.present?
           .signum-notification-body__mb__bc__mc__lkc
-            - signal.metadata["links"].each do | link |
+            - signal.links.each do | link |
               - next unless link.is_a?(Hash)
-              a.signum-notification-body__mb__bc__mc__lkc__lk*{href: link.fetch('url', '#'), target:link.fetch("target", "_blank") }.merge(link.fetch("link_attributes", {}))
+              a.signum-notification-body__mb__bc__mc__lkc__lk*{href: link.fetch('url', '#'), target:link.fetch("target", "_blank"), 'data-action': button["close"] ? "click->signum-notification-body#close" : "" }.merge(link.fetch("link_attributes", {}))
                 i.fas.fa-link
                 =< link["title"] || link["url"] || '(...)'
         - if signal.attachments.attached?
@@ -30,12 +30,12 @@
             | Close
           svg.h-5.w-5[xmlns="http://www.w3.org/2000/svg" viewbox="0 0 20 20" fill="currentColor" aria-hidden="true"]
             path[d="M6.28 5.22a.75.75 0 00-1.06 1.06L8.94 10l-3.72 3.72a.75.75 0 101.06 1.06L10 11.06l3.72 3.72a.75.75 0 101.06-1.06L11.06 10l3.72-3.72a.75.75 0 00-1.06-1.06L10 8.94 6.28 5.22z"]
-    - if signal.metadata.present? && signal.metadata["buttons"].present?
+    - if signal.buttons.present?
       .signum-notification-body__mb__bmc
-        - signal.metadata["buttons"].each do | button |
+        - signal.buttons.each do | button |
           - next unless button.is_a?(Hash)
           .signum-notification-body__mb__bmc__bc
-            a.signum-notification-body__mb__bmc__bc__b*{href: button.fetch('url', '#'), target:button.fetch("target", "_blank")}.merge(button.fetch("link_attributes", {}))
+            a.signum-notification-body__mb__bmc__bc__b*{href: button.fetch('url', '#'), target: button.fetch("target", "_blank"), 'data-action': button["close"] ? "click->signum-notification-body#close" : "" }.merge(button.fetch("link_attributes", {}))
               = button["title"]
   - if signal.count.present?
     - percentage = signal.total.present? ? signal.count.fdiv(signal.total) * 100 : signal.count

data/app/components/signum/notification_drawer/component.html.slim

@@ -1,7 +1,8 @@
-div.text-left[data-controller="signum-notification-drawer" data-action="mouseover->signum-notification-drawer#show mouseleave->signum-notification-drawer#hide"]
-  button.signum-notification-drawer-button
-    = "<i class='hidden #{Signum.config.icons[:unread_main]}' data-signum-notification-drawer-target='alertbellicon'></i>".html_safe
-    = "<i class='#{Signum.config.icons[:read_main]}' data-signum-notification-drawer-target='bellicon'></i>".html_safe
+div.text-left[data-controller="signum-notification-drawer" data-action="mouseover->signum-notification-drawer#show mouseleave->signum-notification-drawer#hide click->signum-notification-drawer#closeNotifications"]
+  button.signum-notification-drawer-button data-action="click->signum-notification-drawer#closeNotifications"
+    i class="hidden #{Signum.config.icons[:unread_main]}" data-signum-notification-drawer-target='alertBellIcon'
+    i class="#{Signum.config.icons[:read_main]}" data-signum-notification-drawer-target='bellIcon'
+    i.hidden.fas.fa-times.cross-icon.text-xs.absolute.top-5.right-15#crossIcon data-signum-notification-drawer-target="crossIcon" data-action="click->signum-notification-drawer#closeNotifications"
 
-    .signum-notification-drawer-tray.hidden[data-signum-notification-drawer-target="submenu" id="#{Signum.config.drawer_notifications_container_id.call}"]
-      = render(Signum::NotificationDrawerItem::Component.with_collection(signals))
+  .signum-notification-drawer-tray.hidden[data-signum-notification-drawer-target="submenu" id="#{Signum.config.drawer_notifications_container_id.call}"]
+    = render(Signum::NotificationDrawerItem::Component.with_collection(signals))

data/app/components/signum/notification_drawer/component_controller.js

@@ -1,7 +1,8 @@
 import ApplicationController from "signum/controllers/application_controller"
 
 export default class extends ApplicationController {
-  static targets = ["alertbellicon", "bellicon", "submenu", "item"]
+
+  static targets = ["alertBellIcon", "bellIcon", "submenu", "item", "crossIcon"]
 
   connect() {
     this.bounditemActivity = this.itemActivity.bind(this)
@@ -10,6 +11,7 @@ export default class extends ApplicationController {
     setTimeout(() => {
       this.manageBellIcon()
     }, 300)
+
   }
 
   disconnect() {
@@ -19,6 +21,7 @@ export default class extends ApplicationController {
   show(event) {
     if (this.submenuTarget.children.length > 0) {
       this.submenuTarget.classList.remove("hidden")
+      this.crossIconTarget.classList.remove("hidden")
     } else {
       this.submenuTarget.classList.add("hidden")
     }
@@ -26,6 +29,26 @@ export default class extends ApplicationController {
 
   hide(event) {
     this.submenuTarget.classList.add("hidden")
+    this.crossIconTarget.classList.add("hidden")
+    if (this.submenuTarget.children.length < 0) {
+      this.alertBellIconTarget.classList.add("hidden")
+    }
+  }
+
+  closeNotifications(event) {
+      fetch("/signal/close_all", {
+        method: "GET",
+        headers: {
+          "Content-Type": "application/json",
+        },
+      })
+        .then((res) => {})
+        .catch((err) => {
+          console.log(err)
+        })
+      this.crossIconTarget.style.display = 'none';
+      this.bellIconTarget.style.display = 'inline-block'
+      this.alertBellIconTarget.style.display = 'none';
   }
 
   itemActivity(event) {
@@ -38,11 +61,11 @@ export default class extends ApplicationController {
 
   manageBellIcon() {
     if (this.submenuTarget.children.length > 0) {
-      this.alertbelliconTarget.classList.remove("hidden")
-      this.belliconTarget.classList.add("hidden")
+      this.alertBellIconTarget.classList.remove("hidden")
+      this.bellIconTarget.classList.add("hidden")
     } else {
-      this.alertbelliconTarget.classList.add("hidden")
-      this.belliconTarget.classList.remove("hidden")
+      this.alertBellIconTarget.classList.add("hidden")
+      this.bellIconTarget.classList.remove("hidden")
     }
   }
 }

data/app/components/signum/notifications/component.html.slim

@@ -1,5 +1,8 @@
 = helpers.turbo_stream_from :signals
 
 .pointer-events-none.fixed.inset-0.flex.items-end.px-2.py-6.sm:items-start.sm:p-6.z-10 data-turbo-permanent="true" id="signum_notifications"
-  #notifications_all.flex.w-full.flex-col.items-center.space-y-2.sm:items-end
+  / #notifications_all.flex.w-full.flex-col.items-center.space-y-2.sm:items-end
   div.flex.w-full.flex-col.items-center.space-y-2.sm:items-end[id="#{Signum.config.balloon_notifications_container_id.call}"]
+  div.flex.w-full.flex-col.items-center.space-y-2.sm:items-end[id="notifications_all"]
+  - keys&.each do |key|
+    div.flex.w-full.flex-col.items-center.space-y-2.sm:items-end[id="notifications_#{key}"]

data/app/components/signum/notifications/component.rb

@@ -1,8 +1,9 @@
 module Signum
   module Notifications
     class Component < ViewComponent::Base
-
-      def initialize()
+      attr_reader :keys
+      def initialize(keys = nil)
+        @keys = keys
       end
     end
   end

data/app/controllers/signum/signal_controller.rb

@@ -3,11 +3,19 @@ module Signum
     def show
       signal = Signum::Signal.find(signal_params[:id])
       signal.show! if signal.broadcasted?
+      head :ok
     end
 
     def close
       signal = Signum::Signal.find(signal_params[:id])
       signal.close!
+      head :ok
+    end
+
+    def close_all
+      signals = current_user.signals.where.not(state: "closed")
+      signals.each(&:close!)
+      head :ok
     end
 
     private

data/app/mailers/signum/application_mailer.rb

@@ -1,6 +1,6 @@
 module Signum
   class ApplicationMailer < ActionMailer::Base
-    default from: 'from@example.com'
-    layout 'mailer'
+    default from: "from@example.com"
+    layout "mailer"
   end
 end

data/app/models/signum/signal.rb

@@ -1,8 +1,10 @@
 module Signum
   class Signal < ApplicationRecord
-    belongs_to :signalable, polymorphic: true
+    belongs_to :signalable, polymorphic: true, optional: true
     belongs_to :subjectable, polymorphic: true, optional: true
 
+    validates :signalable, presence: true, if: -> { key.blank? }
+
     has_many_attached :attachments
 
     after_create_commit :broadcast_create
@@ -11,11 +13,11 @@ module Signum
     def broadcast_create
       broadcast! if can_broadcast?
 
-      broadcast_prepend_to(:signals, target: Signum.config.balloon_notifications_container_id.call(signalable, id),
-                                     html: ApplicationController.render(Signum::Notification::Component.new(self)))
+      broadcast_prepend_to(:signals, target: Signum.config.balloon_notifications_container_id.call(key || signalable, id),
+        html: ApplicationController.render(Signum::Notification::Component.new(self)))
 
-      broadcast_prepend_to(:signals, target: Signum.config.drawer_notifications_container_id.call(signalable, id),
-                                     html: ApplicationController.render(Signum::NotificationDrawerItem::Component.new(signal: self)))
+      broadcast_prepend_to(:signals, target: Signum.config.drawer_notifications_container_id.call(key || signalable, id),
+        html: ApplicationController.render(Signum::NotificationDrawerItem::Component.new(signal: self)))
     end
 
     def broadcast_update
@@ -26,10 +28,10 @@ module Signum
         return
       end
 
-      broadcast_replace_to(:signals, target: "notification_balloon_#{signalable_id}_#{id}",
-                                     html: ApplicationController.render(Signum::NotificationBody::Component.new(self, { type: :balloon, timeout: 5 })))
-      broadcast_replace_to(:signals, target: "notification_drawer_item_#{signalable_id}_#{id}",
-                                     html: ApplicationController.render(Signum::NotificationBody::Component.new(self, { type: :drawer_item, timeout: 5 })))
+      broadcast_replace_to(:signals, target: Signum.config.balloon_notifications_container_id.call(key || signalable, id),
+        html: ApplicationController.render(Signum::NotificationBody::Component.new(self, {type: :balloon, timeout: 5})))
+      broadcast_replace_to(:signals, target: Signum.config.drawer_notifications_container_id.call(key || signalable, id),
+        html: ApplicationController.render(Signum::NotificationBody::Component.new(self, {type: :drawer_item, timeout: 5})))
     end
 
     validates :text, presence: true

data/config/routes.rb

@@ -1,5 +1,6 @@
 Signum::Engine.routes.draw do
-  post 'signal/show', to: 'signal#show'
-  post 'signal/close', to: 'signal#close'
-  post 'signal/open_stickies', to: 'signal#open_stickies'
+  post "signal/show", to: "signal#show"
+  post "signal/close", to: "signal#close"
+  get "signal/close_all", to: "signal#close_all"
+  post "signal/open_stickies", to: "signal#open_stickies"
 end

data/db/migrate/20201125175035_create_signum_signals.rb

@@ -1,10 +1,10 @@
 class CreateSignumSignals < ActiveRecord::Migration[6.0]
   def change
     create_table :signum_signals, id: :uuid do |t|
-      t.string :state, default: 'pending'
+      t.string :state, default: "pending"
       t.references :signalable, polymorphic: true, optional: false, null: false, type: :uuid
 
-      t.string :kind, default: 'notice'
+      t.string :kind, default: "notice"
       t.boolean :sticky
       t.string :icon
       t.string :title

data/db/migrate/20240405112807_add_links_and_buttons_to_signals.rb

@@ -0,0 +1,6 @@
+class AddLinksAndButtonsToSignals < ActiveRecord::Migration[7.1]
+  def change
+    add_column :signum_signals, :links, :jsonb
+    add_column :signum_signals, :buttons, :jsonb
+  end
+end

data/db/migrate/20240410100722_add_key_to_signal.rb

@@ -0,0 +1,21 @@
+class AddKeyToSignal < ActiveRecord::Migration[7.1]
+  def change
+    add_column :signum_signals, :key, :string
+    add_index :signum_signals, :key
+    # t.references :signalable, polymorphic: true, optional: false, null: false, type: :uuid
+    # t.string "signalable_type", null: false
+    # t.uuid "signalable_id", null: false
+    change_column_null :signum_signals, :signalable_type, true
+    change_column_null :signum_signals, :signalable_id, true
+  end
+
+  def down
+    remove_column :signum_signals, :key, :string
+    remove_index :signum_signals, :key
+    # t.references :signalable, polymorphic: true, optional: false, null: false, type: :uuid
+    # t.string "signalable_type", null: false
+    # t.uuid "signalable_id", null: false
+    change_column_null :signum_signals, :signalable_type, false
+    change_column_null :signum_signals, :signalable_id, false
+  end
+end

data/lib/generators/signum/tailwind_config_generator.rb

@@ -1,10 +1,10 @@
-require 'rails/generators/base'
+require "rails/generators/base"
 
 module Signum
   module Generators
     class TailwindConfigGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __dir__)
-      desc 'Configures tailwind.config.js and application.tailwindcss.css'
+      source_root File.expand_path("../templates", __dir__)
+      desc "Configures tailwind.config.js and application.tailwindcss.css"
 
       def add_content_to_tailwind_config
         inject_into_file "config/tailwind.config.js", before: "],\n  theme: {" do

data/lib/signum/active_record_helpers.rb

@@ -6,7 +6,7 @@ module Signum
 
     class_methods do
       def signalable
-        has_many :signals, as: :signalable, class_name: 'Signum::Signal'
+        has_many :signals, as: :signalable, class_name: "Signum::Signal"
 
         send :include, Signum::ActiveRecordHelpers::InstanceMethods
         extend(Signum::ActiveRecordHelpers::ClassMethods)
@@ -18,19 +18,19 @@ module Signum
 
     module InstanceMethods
       def online!
-        update(presence: 'online')
+        update(presence: "online")
       end
 
       def offline!
-        update(presence: 'offline')
+        update(presence: "offline")
       end
 
       def appeared!
-        update(presence: 'appeared')
+        update(presence: "appeared")
       end
 
       def away!
-        update(presence: 'away')
+        update(presence: "away")
       end
     end
   end

data/lib/signum/configuration.rb

@@ -16,7 +16,7 @@ module Signum
 
     def set_defaults!
       self.class.schema.each do |name, default|
-        instance_variable_set("@#{name}", default)
+        instance_variable_set(:"@#{name}", default)
       end
     end
 
@@ -29,21 +29,21 @@ module Signum
     include Options
 
     option :logger, default: Rails.logger
-    option :user_model_name, default: 'User'
+    option :user_model_name, default: "User"
     option :hide_after, default: 3000
-    option :base_controller, default: '::ApplicationController'
-    option :base_service, default: '::ApplicationService'
-    option :base_service_context, default: '::ApplicationContext'
+    option :base_controller, default: "::ApplicationController"
+    option :base_service, default: "::ApplicationService"
+    option :base_service_context, default: "::ApplicationContext"
     option :current_user, default: -> {}
     option :drawer_notifications_container_id, default: ->(signalable = nil, id = nil) {}
     option :balloon_notifications_container_id, default: ->(signalable = nil, id = nil) {}
     option :icons,
-           default: { info: 'fa-solid fa-circle-info fa-lg',
-                      error: 'fa-solid fa-square-xmark fa-lg',
-                      success: 'fa-solid fa-circle-check fa-lg',
-                      warning: 'fa-solid fa-triangle-exclamation fa-lg',
-                      unread_main: 'fa-solid fa-bell-ring',
-                      read_main: 'fa-solid fa-bell' }
+      default: {info: "fa-solid fa-circle-info fa-lg",
+                error: "fa-solid fa-square-xmark fa-lg",
+                success: "fa-solid fa-circle-check fa-lg",
+                warning: "fa-solid fa-triangle-exclamation fa-lg",
+                unread_main: "fa-solid fa-bell-ring",
+                read_main: "fa-solid fa-bell"}
 
     def initialize
       set_defaults!
@@ -60,7 +60,7 @@ module Signum
     def configure
       yield(config)
     end
-    alias setup configure
+    alias_method :setup, :configure
 
     def reset_config!
       @config = Configuration.new

data/lib/signum/engine.rb

@@ -1,21 +1,23 @@
-require 'slim'
-require 'tailwindcss-rails'
+require "slim"
+require "tailwindcss-rails"
 require "importmap-rails"
 require "turbo-rails"
 require "stimulus-rails"
+require "state_machines-activerecord"
+require "view_component"
 
 module Signum
   class Engine < ::Rails::Engine
     isolate_namespace Signum
 
-    initializer 'signum.assets' do |app|
+    initializer "signum.assets" do |app|
       app.config.assets.paths << root.join("app/javascript")
       app.config.assets.paths << root.join("app/components")
       app.config.assets.paths << root.join("vendor/javascript")
       app.config.assets.precompile += %w[signum_manifest]
     end
 
-    initializer 'signum.importmap', before: "importmap" do |app|
+    initializer "signum.importmap", before: "importmap" do |app|
       app.config.importmap.paths << root.join("config/importmap.rb")
       app.config.importmap.cache_sweepers << root.join("app/javascript")
       app.config.importmap.cache_sweepers << root.join("app/components")

data/lib/signum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Signum
-  VERSION = "0.5.1"
+  VERSION = "0.7.0"
 end

data/lib/signum.rb

@@ -1,6 +1,6 @@
-require 'signum/engine'
-require 'signum/active_record_helpers'
-require 'signum/configuration'
+require "signum/engine"
+require "signum/active_record_helpers"
+require "signum/configuration"
 
 module Signum
   class Error < StandardError
@@ -30,6 +30,8 @@ module Signum
       elsif signalable_receiver.respond_to?(:each)
         signalable_receiver.each { |signalable| signal(signalable, options) }
         nil
+      else
+        Signal.create!(options.merge(key: signalable_receiver.to_s))
       end
     end
 
@@ -37,28 +39,28 @@ module Signum
     def info(signalable, options)
       return unless signalable
 
-      signal(signalable, options.merge(kind: 'info', icon: Signum.config.icons[:info]))
+      signal(signalable, options.merge(kind: "info", icon: Signum.config.icons[:info]))
     end
 
     # Signal about an error
     def error(signalable, options)
       return unless signalable
 
-      signal(signalable, options.merge(kind: 'error', icon: Signum.config.icons[:error]))
+      signal(signalable, options.merge(kind: "error", icon: Signum.config.icons[:error]))
     end
 
     # Signal about something that went sucessfully
     def success(signalable, options)
       return unless signalable
 
-      signal(signalable, options.merge(kind: 'success', icon: Signum.config.icons[:success]))
+      signal(signalable, options.merge(kind: "success", icon: Signum.config.icons[:success]))
     end
 
     # Signal about something that could go wrong
     def warning(signalable, options)
       return unless signalable
 
-      signal(signalable, options.merge(kind: 'warning', icon: Signum.config.icons[:warning]))
+      signal(signalable, options.merge(kind: "warning", icon: Signum.config.icons[:warning]))
     end
   end
 

data/lib/tasks/signum_tasks.rake

@@ -10,4 +10,4 @@ end
 if Rake::Task.task_defined?("tailwindcss:build")
   Rake::Task["tailwindcss:build"].enhance(["signum:tailwindcss:config"])
   Rake::Task["tailwindcss:watch"].enhance(["signum:tailwindcss:config"])
-end
+end

data/signum.gemspec

@@ -1,33 +1,37 @@
-$:.push File.expand_path('lib', __dir__)
+$:.push File.expand_path("lib", __dir__)
 
 # Maintain your gem's version:
-require 'signum/version'
+require "signum/version"
 
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |spec|
-  spec.name        = 'signum'
-  spec.version     = Signum::VERSION
-  spec.authors     = ['Tom de Grunt']
-  spec.email       = ['tom@degrunt.nl']
-  spec.homepage    = 'https://github.com/entdec/signum'
-  spec.summary     = 'Replacement for flash messages, also from background jobs'
-  spec.description = 'Rails engine with replacement for flash messages, Signum allows for messages from background jobs.'
-  spec.license     = 'MIT'
+  spec.name = "signum"
+  spec.version = Signum::VERSION
+  spec.authors = ["Tom de Grunt"]
+  spec.email = ["tom@degrunt.nl"]
+  spec.homepage = "https://github.com/entdec/signum"
+  spec.summary = "Replacement for flash messages, also from background jobs"
+  spec.description = "Rails engine with replacement for flash messages, Signum allows for messages from background jobs."
+  spec.license = "MIT"
 
   spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
-  spec.add_dependency 'pg'
-  spec.add_dependency 'rails', '> 6.0'
-  spec.add_dependency 'state_machines-activerecord'
+  spec.add_dependency "pg"
+  spec.add_dependency "rails", "> 6.0"
+  spec.add_dependency "state_machines-activerecord"
 
-  spec.add_development_dependency 'auxilium', '~> 3'
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency "auxilium", "~> 3"
+  spec.add_development_dependency "sqlite3"
 
   spec.add_dependency "slim-rails", "~> 3"
-  spec.add_dependency 'tailwindcss-rails'
-  spec.add_dependency 'importmap-rails'
-  spec.add_dependency 'turbo-rails'
-  spec.add_dependency 'stimulus-rails'
+  spec.add_dependency "tailwindcss-rails"
+  spec.add_dependency "importmap-rails"
+  spec.add_dependency "turbo-rails"
+  spec.add_dependency "stimulus-rails"
+  spec.add_dependency "view_component"
+  spec.add_development_dependency "debug", "~> 0"
+  spec.add_development_dependency "rubocop", "~> 1"
+  spec.add_development_dependency "standard", "~> 1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signum
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Tom de Grunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -150,6 +150,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  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: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 description: Rails engine with replacement for flash messages, Signum allows for messages
   from background jobs.
 email:
@@ -160,6 +216,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/gem-push.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -204,6 +261,8 @@ files:
 - db/migrate/20201125175035_create_signum_signals.rb
 - db/migrate/20230317123138_add_columns_to_signum_signal.rb
 - db/migrate/20231218095011_add_subject_to_signals.rb
+- db/migrate/20240405112807_add_links_and_buttons_to_signals.rb
+- db/migrate/20240410100722_add_key_to_signal.rb
 - lib/generators/signum/install_generator.rb
 - lib/generators/signum/tailwind_config_generator.rb
 - lib/generators/signum/templates/config/initializers/signum.rb
@@ -216,7 +275,6 @@ files:
 - package.json
 - signum.gemspec
 - vendor/javascript/@hotwired--stimulus.js
-- webpack.config.js
 - yarn.lock
 homepage: https://github.com/entdec/signum
 licenses:

data/webpack.config.js

@@ -1,126 +0,0 @@
-const path = require('path');
-const CleanWebpackPlugin = require('clean-webpack-plugin')
-const MiniCssExtractPlugin = require('mini-css-extract-plugin');
-
-module.exports = {
-  entry: './frontend/src/signum.js',
-  output: {
-    path: __dirname + '/frontend/dist',
-    filename: 'signum.js',
-    library: 'Signum',
-    libraryTarget: 'umd'
-  },
-  plugins: [
-    // new CleanWebpackPlugin(['frontend/dist'],  {}),
-    new MiniCssExtractPlugin({
-      filename: 'signum.css'
-    })
-  ],
-  module: {
-    rules: [
-      {
-        test: /\.js$/,
-        exclude: /(node_modules|bower_components)/,
-        use: {
-          loader: 'babel-loader',
-          options: {
-            presets: ['env'],
-            plugins: ["transform-class-properties"]
-          }
-        }
-      },
-      {
-        test: /\.(|ttf|eot|svg|woff2?)(\?[\s\S]+)?$/,
-        use: 'file-loader',
-      },
-      {
-        test: /\.(sass|scss|css)$/,
-        use: [
-          {
-            loader: MiniCssExtractPlugin.loader,
-          },
-          'css-loader?sourceMap=false',
-          'sass-loader?sourceMap=false'
-        ]
-      }
-    ]
-  },
-  resolve: {
-    modules: [path.resolve('./node_modules'), path.resolve('./src')],
-    extensions: ['.json', '.js']
-  }
-}
-
-
-
-// const MiniCssExtractPlugin = require("mini-css-extract-plugin");
-// const path = require('path');
-
-// const devMode = process.env.NODE_ENV !== 'production'
-
-// module.exports = {
-//   mode: devMode ? "development" : "production",
-//   entry: {
-//     signum: ['./frontend/src/signum.js']
-//   },
-//   output: {
-//     path: __dirname + '/frontend/dist',
-//     filename: '[name].js',
-//   },
-
-//   module: {
-//     rules: [
-//       {
-//         test: /\.(c|sa|sc)ss$/,
-//         exclude: /(node_modules)/,
-//         // Use the following loaders from right-to-left, so it will
-//         // use sass-loader first and ending with MiniCssExtractPlugin
-//         use: [
-//           {
-//             // Extracts the CSS into a separate file and uses the
-//             // defined configurations in the 'plugins' section
-//             loader: MiniCssExtractPlugin.loader
-//           },
-//           {
-//             // Interprets CSS
-//             loader: "css-loader",
-//             options: {
-//               importLoaders: 2
-//             }
-//           },
-//           {
-//             // Adds support for Sass files, if using Less, then
-//             // use the less-loader
-//             loader: "sass-loader"
-//           }
-//         ]
-//       },
-//       {
-//         test: /\.js$/,
-//         exclude: /(node_moduldes)/,
-//         use: {
-//           loader: 'babel-loader',
-//           options: {
-//             presets: ['@babel/preset-env']
-//           }
-//         }
-//       },
-//       {
-//         test: /\.(ttf|eot|svg|woff2?)(\?[\s\S]+)?$/,
-//         use: 'file-loader',
-//       },
-//     ]
-//   },
-//   plugins: [
-//     // Configuration options for MiniCssExtractPlugin. Here I'm only
-//     // indicating what the CSS output file name should be and
-//     // the location
-//     new MiniCssExtractPlugin({
-//       filename: devMode ? "[name].css" : "[name].min.css"
-//     })
-//   ],
-//   resolve: {
-//     modules: [path.resolve('./node_modules'), path.resolve('./src')],
-//     extensions: ['.json', '.js']
-//   }
-// }