signum 0.3.12 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd53f73e635b3003fe096e759fab32eecf11150eaf860c3e26e49b6d19850a6b
-  data.tar.gz: 7f483ba2ac476e62ac4bcfa664e95f734ac95d3c49c914fe3d936157520f50c8
+  metadata.gz: 8c2d2692c406747889b91ad03f134e452024ef67230a300a58560a89c290de1a
+  data.tar.gz: 73032778b0e3195f582924477b1b0ba8c03fd1d9bb1c3a8cbdcf852e0085c42b
 SHA512:
-  metadata.gz: 61f04881271d2d6225144e60703f075c6b8f12265105b25f763f330edae371ee7e07d8edbe742fea57171a5d952fa3e3d6b9b5c2944b4c51305d234d5076abd4
-  data.tar.gz: 30284aaec38f11795f56635d9863c5220ab1b455ee554372521660746b1c685fd3d45737cce933c8e7821ce619e32dd6b12d5660b1bfae01b17647c8226bc416
+  metadata.gz: 657c09d536f1ae32e2b0646b195bbbf17153a060a9028f4b3f8eb254607af721df7974edea70fa81384e128f986d91dfa6ff246da327095956b947e60853f315
+  data.tar.gz: e9678d8723c59a0d82c652481d7d55e899932ab8417393c68588e7d63ab1a0b831b20d67bf36eb5dc7eba26e3590cfb71e33ef924bdb5aa78566be3432d5ccbd

data/README.md

@@ -39,7 +39,36 @@ Signum.error(Current.user, text: "Houston, we have a problem!")
 Signum.success(Current.user, text: "The Eagle has landed!")
 ```
 
-Above we used the `Current.user` as the user to signal to.
+You can make a signal sticky, keeping it on the screen until you click it away:
+```ruby
+s = Signum.signal(Current.user, text: "Hello World New", sticky: true, title: "Sticky")
+```
+
+You can add icons:
+```ruby
+s = Signum.signal(Current.user, text: "Hello World New", title: "Icon", icon:'fa-regular fa-t-rex')
+```
+
+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"}]})
+```
+
+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)
+```
+
+You can also attach attachments
+```ruby
+attachment = {io: File.open("notes.txt"),
+              content_type: "text/plain", filename: "notes.txt"}
+s = Signum.success(Current.user, text: "Hello World New", title: "this is test title", attachments: [attachment])
+```
+
+Signum returns you the signal object. You can update these signals and they will be rebroadcasted again.
 
 ## Contributing
 

data/app/assets/config/signum_manifest.js

@@ -0,0 +1,5 @@
+//= link_tree ../images
+//= link_directory ../../javascript/signum .js
+//= link_directory ../../javascript/signum/controllers .js
+//= link_tree ../../components .js
+//= link_tree ../../../vendor/javascript .js

data/app/assets/stylesheets/signum/application.css

@@ -0,0 +1,4 @@
+@import '../../../components/signum/notification/component.css';
+@import '../../../components/signum/notification_body/component.css';
+@import '../../../components/signum/notification_drawer/component.css';
+@import '../../../components/signum/notification_drawer_item/component.css';

data/app/components/signum/notification/component.css

@@ -0,0 +1,3 @@
+.signum-notification {
+    @apply pointer-events-auto flex flex-wrap w-full divide-x divide-y divide-gray-200 max-w-sm overflow-hidden rounded-lg bg-white shadow-lg ring-1 ring-black ring-opacity-5;
+}

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

@@ -1,24 +1,2 @@
-.signum-notification.hidden data-notification-timeout=@data[:timeout] data-controller="notification"
-  .p-4
-    .flex.items-start
-      .flex-shrink-0
-        - if @signal.kind == "success"
-          svg.signum-notification-icon-success[xmlns="http://www.w3.org/2000/svg" fill="none" viewbox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true"]
-            path[stroke-linecap="round" stroke-linejoin="round" d="M9 12.75L11.25 15 15 9.75M21 12a9 9 0 11-18 0 9 9 0 0118 0z"]
-        - elsif @signal.kind == "error"
-          svg.signum-notification-icon-error[xmlns="http://www.w3.org/2000/svg" fill="none" viewbox="0 0 24 24" stroke-width="1.5" stroke="currentColor"]
-            path[stroke-linecap="round" stroke-linejoin="round" d="M9.75 9.75l4.5 4.5m0-4.5l-4.5 4.5M21 12a9 9 0 11-18 0 9 9 0 0118 0z"]
-        - else
-          svg.svg.signum-notification-icon-info[xmlns="http://www.w3.org/2000/svg" fill="none" viewbox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true"]
-            path[stroke-linecap="round" stroke-linejoin="round" d="M11.25 11.25l.041-.02a.75.75 0 011.063.852l-.708 2.836a.75.75 0 001.063.853l.041-.021M21 12a9 9 0 11-18 0 9 9 0 0118 0zm-9-3.75h.008v.008H12V8.25z"]
-      .ml-3.w-0.flex-1.pt-0.5
-        p.signum-notification-title
-          = sanitize @signal.title
-        p.signum-notification-body
-          = sanitize @signal.text
-      .ml-4.flex.flex-shrink-0
-        button.signum-notification-button-close[type="button" data-action="notification#close"]
-          span.sr-only
-            | 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"]
+.signum-notification
+  = render(Signum::NotificationBody::Component.new(signal, data))

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

@@ -7,10 +7,14 @@
 module Signum
   module Notification
     class Component < ViewComponent::Base
+      attr_reader :signal, :data
+
       def initialize(signal, data: nil)
         @signal = signal
         @data = data.nil? ? {} : data.deep_symbolize_keys
+
         @data[:timeout] ||= 5
+        @data[:type] ||= :balloon
       end
     end
   end

data/app/components/signum/notification_body/component.css

@@ -0,0 +1,104 @@
+.signum-notification-body {
+  @apply flex flex-col w-full divide-y;
+
+  &__mb {
+    // main body
+    @apply flex basis-full divide-x;
+
+    &__bc {
+      //body container
+      @apply flex grow py-4 px-2 overflow-hidden;
+
+      &__ic {
+        //icon container
+        @apply grow-0 pl-2 pr-3;
+      
+      svg.info
+      {
+        //icon info
+        @apply text-sky-400;
+      }
+
+      svg.success{
+        //icon success
+        @apply text-green-400;
+      }
+
+      svg.error{
+        //icon error
+        @apply text-red-400;
+      }
+
+      svg.warning{
+        //icon warning
+        @apply text-orange-400;
+      }
+    }
+
+      &__mc {
+        //main container
+        @apply grow text-left break-words overflow-hidden;
+
+        &__ti {
+          // title
+          @apply text-[0.81rem] font-medium text-gray-900;
+        }
+
+        &__tx {
+          //text
+          @apply text-xs text-gray-500 mt-1;
+        }
+
+        &__lkc {
+          //links container
+          @apply flex flex-wrap mt-3;
+
+          &__lk {
+            //link
+            @apply rounded-md text-xs font-medium text-gray-700 hover:text-gray-500 focus:outline-none mr-2;
+          }
+        }
+
+        &__attc {
+          //attachments links container
+          @apply flex flex-wrap mt-3;
+
+          &__att {
+            //attachment link
+            @apply rounded-md text-xs font-medium text-gray-700 hover:text-gray-500 focus:outline-none mr-2;
+          }
+        }
+      }
+
+      &__bcc {
+        //close button container
+        @apply grow-0 m-1;
+
+        &__b {
+          //button
+          @apply text-gray-400 hover:text-gray-500 cursor-pointer;
+        }
+      }
+    }
+
+    &__bmc {
+      //buttons main container
+      @apply flex grow-0 flex-col divide-y divide-gray-200;
+
+      &__bc {
+        //buttons container
+        @apply flex flex-1;
+
+        &__b {
+          //button
+          @apply flex w-full items-center justify-center text-xs font-medium text-gray-700 hover:text-gray-500 focus:outline-none px-4 py-3;
+        }
+      }
+    }
+  }
+
+  &__pbc {
+    //progress bar container
+    @apply basis-full p-1;
+  }
+}

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

@@ -0,0 +1,41 @@
+.signum-notification-body data-controller="signum-notification-body" data-signum-notification-body-type-value=data[:type] data-signum-notification-body-timeout-value=data[:timeout] data-signum-notification-body-sticky-value="#{signal.sticky.present? ? signal.sticky.to_s : 'false'}" data-signum-notification-body-signal-state-value="#{signal.state}" data-signum-notification-body-signal-id-value="#{signal.id}" id="notification_#{data[:type]}_#{signal.signalable_id}_#{signal.id}"
+  .signum-notification-body__mb
+    .signum-notification-body__mb__bc
+      .signum-notification-body__mb__bc__ic
+        - if signal.icon.present?
+          = "<i class='#{signal.kind} #{signal.icon}' ></i>".html_safe
+      .signum-notification-body__mb__bc__mc
+        - if signal.title.present?
+          p.signum-notification-body__mb__bc__mc__ti
+            = sanitize signal.title
+        - if signal.text.present?
+          p.signum-notification-body__mb__bc__mc__tx
+            = sanitize signal.text
+        - if signal.metadata.present? && signal.metadata["links"].present?
+          .signum-notification-body__mb__bc__mc__lkc
+            - signal.metadata["links"].each do | link |
+              a.signum-notification-body__mb__bc__mc__lkc__lk href="#{link["url"]}" target="_blank"
+                i.fas.fa-link
+                =< link["title"]
+        - if signal.attachments.attached?
+          .signum-notification-body__mb__bc__mc__attc
+            - signal.attachments.each do | attachment |
+              a.signum-notification-body__mb__bc__mc__attc__att href="#{url_for(attachment)}" target="_blank"
+                i.fas.fa-paperclip-vertical
+                =< attachment.blob.filename
+      .signum-notification-body__mb__bc__bcc
+        a.signum-notification-body__mb__bc__bcc__b[data-action="signum-notification-body#close"]
+          span.sr-only
+            | 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?
+      .signum-notification-body__mb__bmc
+        - signal.metadata["buttons"].each do | button |
+          .signum-notification-body__mb__bmc__bc
+            a.signum-notification-body__mb__bmc__bc__b href="#{button["url"]}" target="_blank"
+              = button["title"]
+  - if signal.count.present?
+    - percentage = signal.total.present? ? signal.count.fdiv(signal.total) * 100 : signal.count
+    .signum-notification-body__pbc
+      = sts.progress_bar percentage, size: :small, label: false

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# @param type [String] Classic notification type `error`, `alert` and `info` + custom `success`
+# @param data [String, Hash] `String` for backward compatibility,
+#   `Hash` for the new functionality `{title: '', body: '', timeout: 5, countdown: false, action: { url: '', method: '', name: ''}}`.
+#   The `title` attribute for `Hash` is mandatory.
+module Signum
+  module NotificationBody
+    class Component < ViewComponent::Base
+      attr_reader :signal, :data
+
+      def initialize(signal, data)
+        @signal = signal
+        @data = data.nil? ? {} : data.deep_symbolize_keys
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+import ApplicationController from "signum/controllers/application_controller"
+
+export default class extends ApplicationController {
+  static values = { type: String, timeout: Number, sticky: Boolean, signalId: String, signalState: String }
+  connect() {
+    if (this.typeValue == "balloon" && !this.stickyValue) {
+      this.timeoutId = setTimeout(() => {
+        this.close()
+      }, this.timeoutValue * 1000 + 500)
+    }
+  }
+
+  close(event) {
+    setTimeout(() => {
+      this.element?.parentElement?.remove()
+      if (event) {
+        this.markClose()
+      }
+    }, 300)
+  }
+
+  markClose() {
+    fetch("/signal/close", {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify({ id: this.signalIdValue }),
+    })
+      .then((res) => {
+        const niE = new CustomEvent("nd-item-activity", {
+          bubbles: true,
+          detail: "closed",
+        })
+        window.dispatchEvent(niE)
+      })
+      .catch((err) => {
+        console.log(err)
+      })
+  }
+}

data/app/components/signum/notification_drawer/component.css

@@ -0,0 +1,7 @@
+.signum-notification-drawer-button {
+  @apply w-8 h-8 bg-white m-0 rounded-full text-gray-400 hover:text-gray-500 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-primary-500 dark:bg-gray-900 dark:border-gray-700;
+}
+
+.signum-notification-drawer-tray {
+  @apply bg-gray-50 w-full max-w-sm absolute right-0 z-10 mx-1 w-1/3 origin-top-right divide-y divide-gray-100 rounded-md bg-white shadow-lg ring-1 ring-black ring-opacity-5 overflow-y-auto max-h-[75vh];
+}

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

@@ -1,12 +1,7 @@
-div.text-left[data-controller="notification-drawer" data-action="mouseover->notification-drawer#show mouseleave->notification-drawer#hide"]
-    button.signum-notification-drawer-button
-        svg.w-6.h-6.hidden[xmlns="http://www.w3.org/2000/svg" fill="none" viewbox="0 0 24 24" stroke-width="1.5" stroke="currentColor" data-notification-drawer-target="alertbellicon"]
-            path[stroke-linecap="round" stroke-linejoin="round" d="M14.857 17.082a23.848 23.848 0 005.454-1.31A8.967 8.967 0 0118 9.75v-.7V9A6 6 0 006 9v.75a8.967 8.967 0 01-2.312 6.022c1.733.64 3.56 1.085 5.455 1.31m5.714 0a24.255 24.255 0 01-5.714 0m5.714 0a3 3 0 11-5.714 0M3.124 7.5A8.969 8.969 0 015.292 3m13.416 0a8.969 8.969 0 012.168 4.5"]
+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
 
-        svg.w-6.h-6[xmlns="http://www.w3.org/2000/svg" fill="none" viewbox="0 0 24 24" stroke-width="1.5" stroke="currentColor" data-notification-drawer-target="bellicon"]
-            path[stroke-linecap="round" stroke-linejoin="round" d="M14.857 17.082a23.848 23.848 0 005.454-1.31A8.967 8.967 0 0118 9.75v-.7V9A6 6 0 006 9v.75a8.967 8.967 0 01-2.312 6.022c1.733.64 3.56 1.085 5.455 1.31m5.714 0a24.255 24.255 0 01-5.714 0m5.714 0a3 3 0 11-5.714 0"]
-
-    .signum-notification-drawer-tray.hidden[data-notification-drawer-target="submenu" id="#{@notification_container_id}"]
-        - if @signals.present?
-            - @signals.each do |signal|
-                = render(Signum::NotificationDrawerItem::Component.new(signal))
+    .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.rb

@@ -1,9 +1,10 @@
 module Signum
   module NotificationDrawer
     class Component < ViewComponent::Base
-      def initialize(signals, notification_container_id)
+      attr_reader :signals
+
+      def initialize(signals)
         @signals = signals
-        @notification_container_id = notification_container_id
       end
     end
   end

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

@@ -0,0 +1,48 @@
+import ApplicationController from "signum/controllers/application_controller"
+
+export default class extends ApplicationController {
+  static targets = ["alertbellicon", "bellicon", "submenu", "item"]
+
+  connect() {
+    this.bounditemActivity = this.itemActivity.bind(this)
+    window.addEventListener("nd-item-activity", this.bounditemActivity)
+
+    setTimeout(() => {
+      this.manageBellIcon()
+    }, 300)
+  }
+
+  disconnect() {
+    window.removeEventListener("nd-item-activity", this.bounditemActivity)
+  }
+
+  show(event) {
+    if (this.submenuTarget.children.length > 0) {
+      this.submenuTarget.classList.remove("hidden")
+    } else {
+      this.submenuTarget.classList.add("hidden")
+    }
+  }
+
+  hide(event) {
+    this.submenuTarget.classList.add("hidden")
+  }
+
+  itemActivity(event) {
+    this.manageBellIcon()
+
+    if (this.submenuTarget.children.length == 0) {
+      this.hide(event)
+    }
+  }
+
+  manageBellIcon() {
+    if (this.submenuTarget.children.length > 0) {
+      this.alertbelliconTarget.classList.remove("hidden")
+      this.belliconTarget.classList.add("hidden")
+    } else {
+      this.alertbelliconTarget.classList.add("hidden")
+      this.belliconTarget.classList.remove("hidden")
+    }
+  }
+}

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

@@ -1,14 +1,2 @@
-.py-1.hover:bg-gray-50[data-controller="notification-drawer-item" data-action="click->notification-drawer-item#markRead" data-notification-drawer-target="item" class=('font-bold' if @signal.state != 'closed') data-notification-drawer-item-signal-state-value="#{@signal.state}" data-notification-drawer-item-signal-id-value="#{@signal.id}"]
-    .flex.items-center.px-4.py-2.text-sm.text-gray-500
-        .w-6.h-6.mr-1
-            - if @signal.kind == "success"
-                svg.signum-notification-icon-success[xmlns="http://www.w3.org/2000/svg" fill="none" viewbox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true"]
-                    path[stroke-linecap="round" stroke-linejoin="round" d="M9 12.75L11.25 15 15 9.75M21 12a9 9 0 11-18 0 9 9 0 0118 0z"]
-            - elsif @signal.kind == "error"
-                svg.signum-notification-icon-error[xmlns="http://www.w3.org/2000/svg" fill="none" viewbox="0 0 24 24" stroke-width="1.5" stroke="currentColor"]
-                    path[stroke-linecap="round" stroke-linejoin="round" d="M9.75 9.75l4.5 4.5m0-4.5l-4.5 4.5M21 12a9 9 0 11-18 0 9 9 0 0118 0z"]
-            - else
-                svg.signum-notification-icon-info[xmlns="http://www.w3.org/2000/svg" fill="none" viewbox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true"]
-                    path[stroke-linecap="round" stroke-linejoin="round" d="M11.25 11.25l.041-.02a.75.75 0 011.063.852l-.708 2.836a.75.75 0 001.063.853l.041-.021M21 12a9 9 0 11-18 0 9 9 0 0118 0zm-9-3.75h.008v.008H12V8.25z"]
-        p
-            = sanitize @signal.text
+.hover:bg-gray-50 data-controller="signum-notification-drawer-item" data-signum-notification-drawer-target="item" data-signum-notification-drawer-item-signal-state-value="#{signal.state}" data-signum-notification-drawer-item-signal-id-value="#{signal.id}" id="notification_#{data[:type]}_parent_#{signal.signalable_id}_#{signal.id}"
+  = render(Signum::NotificationBody::Component.new(signal, data))

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

@@ -1,8 +1,16 @@
 module Signum
   module NotificationDrawerItem
     class Component < ViewComponent::Base
-      def initialize(signal)
+      attr_reader :signal, :data
+
+      with_collection_parameter :signal
+
+      def initialize(signal:, data: nil)
         @signal = signal
+        @data = data.nil? ? {} : data.deep_symbolize_keys
+
+        @data[:timeout] ||= 5
+        @data[:type] ||= :drawer_item
       end
     end
   end

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

@@ -0,0 +1,30 @@
+import ApplicationController from "signum/controllers/application_controller"
+
+export default class extends ApplicationController {
+  static targets = []
+  static values = {
+    signalId: String,
+    signalState: String,
+  }
+
+  connect() {
+    const niE = new CustomEvent("nd-item-activity", {
+      bubbles: true,
+      detail: "added",
+    })
+    window.dispatchEvent(niE)
+    if (this.signalStateValue == "broadcasted") {
+      fetch("/signal/show", {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify({ id: this.signalIdValue }),
+      })
+        .then((res) => {})
+        .catch((err) => {
+          console.log(err)
+        })
+    }
+  }
+}

data/app/javascript/signum/application.js

@@ -0,0 +1 @@
+import "signum/controllers"

data/app/javascript/signum/controllers/application.js

@@ -0,0 +1,12 @@
+import { Application } from '@hotwired/stimulus'
+
+let application
+if (window.Stimulus) {
+  application = window.Stimulus
+} else {
+  application = Application.start()
+  application.debug = false
+  window.Stimulus = application
+}
+
+export { application }

data/app/javascript/signum/controllers/application_controller.js

@@ -0,0 +1,4 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class ApplicationController extends Controller {
+}

data/app/javascript/signum/controllers/index.js

@@ -0,0 +1,14 @@
+import { application } from "signum/controllers/application"
+
+// Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!)
+// import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading"
+// lazyLoadControllersFrom("signum/controllers", application)
+
+import NotificationBodyController from "signum/components/notification_body/component_controller";
+application.register("signum-notification-body", NotificationBodyController);
+
+import NotificationDrawerController from "signum/components/notification_drawer/component_controller";
+application.register("signum-notification-drawer", NotificationDrawerController);
+
+import NotificationDrawerItemController from "signum/components/notification_drawer_item/component_controller";
+application.register("signum-notification-drawer-item", NotificationDrawerItemController);

data/app/models/signum/signal.rb

@@ -1,13 +1,43 @@
 module Signum
   class Signal < ApplicationRecord
     belongs_to :signalable, polymorphic: true
-    after_commit :signal
+    belongs_to :subjectable, polymorphic: true, optional: true
+
+    has_many_attached :attachments
+
+    after_create_commit :broadcast_create
+    after_update_commit :broadcast_update
+
+    def broadcast_create
+      broadcast! if can_broadcast?
+
+      broadcast_prepend_to(:signals, target: Signum.config.balloon_notifications_container_id.call,
+                                     html: ApplicationController.render(Signum::Notification::Component.new(self)))
+
+      broadcast_prepend_to(:signals, target: Signum.config.drawer_notifications_container_id.call,
+                                     html: ApplicationController.render(Signum::NotificationDrawerItem::Component.new(signal: self)))
+    end
+
+    def broadcast_update
+      return if saved_change_to_state? && (broadcasted? || shown?)
+
+      if saved_change_to_state? && closed?
+        broadcast_remove_to(:signals, target: "notification_drawer_item_parent_#{signalable_id}_#{id}")
+        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 })))
+    end
 
     validates :text, presence: true
 
     scope :pending, -> { with_state(:pending) }
     scope :shown, -> { with_state(:shown) }
     scope :closed, -> { with_state(:closed) }
+    scope :unclosed_sticky, ->(signalable) { without_state(:closed).where(signalable: signalable, sticky: true) }
 
     state_machine initial: :pending do
       state :pending
@@ -28,11 +58,5 @@ module Signum
         transition any => :closed
       end
     end
-
-    private
-
-    def signal
-      Signum::SendSignalsJob.perform_later(self) if pending?
-    end
   end
 end

data/config/importmap.rb

@@ -0,0 +1,6 @@
+pin "@hotwired/stimulus", to: "@hotwired--stimulus.js" # @3.2.2
+
+pin "signum", to: "signum/application.js"
+
+pin_all_from Signum::Engine.root.join("app/javascript/signum/controllers"), under: "signum/controllers", to: "signum/controllers"
+pin_all_from Signum::Engine.root.join("app/components/signum"), under: "signum/components", to: "signum"

data/config/routes.rb

@@ -1,4 +1,5 @@
 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'
 end

data/db/migrate/20230317123138_add_columns_to_signum_signal.rb

@@ -0,0 +1,7 @@
+class AddColumnsToSignumSignal < ActiveRecord::Migration[6.1]
+  def change
+    add_column :signum_signals, :metadata, :jsonb
+    add_column :signum_signals, :total, :integer
+    add_column :signum_signals, :count, :integer
+  end
+end

data/db/migrate/20231218095011_add_subject_to_signals.rb

@@ -0,0 +1,5 @@
+class AddSubjectToSignals < ActiveRecord::Migration[6.1]
+  def change
+    add_reference :signum_signals, :subjectable, type: :uuid, polymorphic: true, null: true
+  end
+end

data/lib/generators/signum/install_generator.rb

@@ -0,0 +1,22 @@
+module Signum
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_initializer_file
+      template "config/initializers/signum.rb"
+    end
+
+    def add_route
+      return if Rails.application.routes.routes.detect { |route| route.app.app == Signum::Engine }
+      route %(mount Signum::Engine => "/signum")
+    end
+
+    def copy_migrations
+      rake "signum:install:migrations"
+    end
+
+    def tailwindcss_config
+      rake "signum:tailwindcss:config"
+    end
+  end
+end

data/lib/generators/signum/tailwind_config_generator.rb

@@ -0,0 +1,24 @@
+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'
+
+      def add_content_to_tailwind_config
+        inject_into_file "config/tailwind.config.js", before: "],\n  theme: {" do
+          "  // Signum content\n" +
+            %w[/app/views/**/* /app/helpers/**/* /app/controllers/**/* /app/components/**/* /app/javascript/**/*.js /app/assets/**/*.css].map { |path| "    \"#{Signum::Engine.root}#{path}\"" }.join(",\n") +
+            ",\n  "
+        end
+      end
+
+      def add_content_application_tailwind_css
+        inject_into_file "app/assets/stylesheets/application.tailwind.css", before: "@tailwind base;" do
+          "@import '#{Signum::Engine.root}/app/assets/stylesheets/signum/application.css';\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/signum/templates/config/initializers/signum.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+Signum.setup do |config|
+  config.hide_after = 60_000 if Rails.env.test?
+  config.current_user = -> { Current.user }
+  config.drawer_notifications_container_id = -> { "drawer_notifications_#{Current.user.id}" }
+  config.balloon_notifications_container_id = -> { "notifications_#{Current.user.id}" }
+end

data/lib/signum/configuration.rb

@@ -1,13 +1,69 @@
 # frozen_string_literal: true
 
 module Signum
+  module Options
+    module ClassMethods
+      def option(name, default: nil)
+        attr_accessor(name)
+
+        schema[name] = default
+      end
+
+      def schema
+        @schema ||= {}
+      end
+    end
+
+    def set_defaults!
+      self.class.schema.each do |name, default|
+        instance_variable_set("@#{name}", default)
+      end
+    end
+
+    def self.included(cls)
+      cls.extend(ClassMethods)
+    end
+  end
+
   class Configuration
-    attr_accessor :hide_after
-    attr_accessor :user_model_name
+    include Options
+
+    option :logger, default: Rails.logger
+    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 :current_user, default: -> {}
+    option :drawer_notifications_container_id, default: -> {}
+    option :balloon_notifications_container_id, default: -> {}
+    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' }
 
     def initialize
-      @user_model_name = "User"
-      @hide_after = 3000
+      set_defaults!
+    end
+  end
+
+  module Configurable
+    attr_writer :config
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield(config)
+    end
+    alias setup configure
+
+    def reset_config!
+      @config = Configuration.new
     end
   end
 end

data/lib/signum/engine.rb

@@ -1,13 +1,25 @@
+require 'slim'
+require 'tailwindcss-rails'
+require "importmap-rails"
+require "turbo-rails"
+require "stimulus-rails"
+
 module Signum
   class Engine < ::Rails::Engine
     isolate_namespace Signum
 
-    initializer :append_migrations do |app|
-      unless app.root.to_s.match? root.to_s
-        config.paths['db/migrate'].expanded.each do |expanded_path|
-          app.config.paths['db/migrate'] << expanded_path
-        end
-      end
+    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|
+      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")
+      app.config.importmap.cache_sweepers << root.join("vendor/javascript")
     end
   end
 end

data/lib/signum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Signum
-  VERSION = '0.3.12'
+  VERSION = "0.4.8"
 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
@@ -26,8 +26,10 @@ module Signum
 
       if signalable_receiver.is_a?(Signum.config.user_model_name.constantize)
         signalable_receiver.signals.create!(options)
+
       elsif signalable_receiver.respond_to?(:each)
         signalable_receiver.each { |signalable| signal(signalable, options) }
+        nil
       end
     end
 
@@ -35,21 +37,28 @@ module Signum
     def info(signalable, options)
       return unless signalable
 
-      signal(signalable, options.merge(kind: "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"))
+      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"))
+      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]))
     end
   end
 

data/lib/tasks/signum_tasks.rake

@@ -0,0 +1,13 @@
+namespace :signum do
+  namespace :tailwindcss do
+    desc "Configure your Tailwind CSS"
+    task :config do
+      Rails::Generators.invoke("signum:tailwind_config", ["--force"])
+    end
+  end
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signum
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.4.8
 platform: ruby
 authors:
 - Tom de Grunt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -80,6 +80,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: tailwindcss-rails
+  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: importmap-rails
+  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: turbo-rails
+  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: stimulus-rails
+  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'
 description: Rails engine with replacement for flash messages, Signum allows for messages
   from background jobs.
 email:
@@ -91,33 +161,49 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/channels/signum/application_cable/channel.rb
-- app/channels/signum/application_cable/connection.rb
+- app/assets/config/signum_manifest.js
+- app/assets/stylesheets/signum/application.css
+- app/components/signum/notification/component.css
 - app/components/signum/notification/component.html.slim
 - app/components/signum/notification/component.rb
-- app/components/signum/notification/component.scss
+- app/components/signum/notification_body/component.css
+- app/components/signum/notification_body/component.html.slim
+- app/components/signum/notification_body/component.rb
+- app/components/signum/notification_body/component_controller.js
+- app/components/signum/notification_drawer/component.css
 - app/components/signum/notification_drawer/component.html.slim
 - app/components/signum/notification_drawer/component.rb
-- app/components/signum/notification_drawer/component.scss
+- app/components/signum/notification_drawer/component_controller.js
+- app/components/signum/notification_drawer_item/component.css
 - app/components/signum/notification_drawer_item/component.html.slim
 - app/components/signum/notification_drawer_item/component.rb
-- app/components/signum/notification_drawer_item/component.scss
+- app/components/signum/notification_drawer_item/component_controller.js
 - app/controllers/signum/api_controller.rb
 - app/controllers/signum/application_controller.rb
 - app/controllers/signum/signal_controller.rb
 - app/helpers/signum/application_helper.rb
+- app/javascript/signum/application.js
+- app/javascript/signum/controllers/application.js
+- app/javascript/signum/controllers/application_controller.js
+- app/javascript/signum/controllers/index.js
 - app/jobs/signum/application_job.rb
-- app/jobs/signum/send_signals_job.rb
 - app/mailers/signum/application_mailer.rb
 - app/models/signum/application_record.rb
 - app/models/signum/signal.rb
+- config/importmap.rb
 - config/routes.rb
 - db/migrate/20201125175035_create_signum_signals.rb
+- db/migrate/20230317123138_add_columns_to_signum_signal.rb
+- db/migrate/20231218095011_add_subject_to_signals.rb
+- lib/generators/signum/install_generator.rb
+- lib/generators/signum/tailwind_config_generator.rb
+- lib/generators/signum/templates/config/initializers/signum.rb
 - lib/signum.rb
 - lib/signum/active_record_helpers.rb
 - lib/signum/configuration.rb
 - lib/signum/engine.rb
 - lib/signum/version.rb
+- lib/tasks/signum_tasks.rake
 homepage: https://github.com/entdec/signum
 licenses:
 - MIT

data/app/channels/signum/application_cable/channel.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Signum
-  module ApplicationCable
-    class Channel < ActionCable::Channel::Base
-    end
-  end
-end

data/app/channels/signum/application_cable/connection.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Signum
-  module ApplicationCable
-    class Connection < ActionCable::Connection::Base
-      identified_by :current_user
-
-      def connect
-        self.current_user = find_verified_user
-        logger.add_tags 'ActionCable', current_user.name
-      end
-
-      private
-
-      def find_verified_user
-        if verified_user = env['warden'].user
-          verified_user
-        else
-          reject_unauthorized_connection
-        end
-      end
-    end
-  end
-end

data/app/components/signum/notification/component.scss

@@ -1,34 +0,0 @@
-.signum-notification{
-    @apply pointer-events-auto w-full max-w-sm overflow-hidden rounded-lg bg-white shadow-lg ring-1 ring-black ring-opacity-5 mt-1;
-}
-
-.signum-notification-icon{
-    @apply h-6 w-6;
-}
-
-.signum-notification-icon-success{
-    @extend .signum-notification-icon;
-    @apply text-green-400;
-}
-
-.signum-notification-icon-error{
-    @extend .signum-notification-icon;
-    @apply text-red-400;
-}
-
-.signum-notification-icon-info{
-    @extend .signum-notification-icon;
-    @apply text-sky-400;
-}
-
-.signum-notification-title{
-    @apply text-sm font-medium text-gray-900;
-}
-
-.signum-notification-body{
-    @apply mt-1 text-sm text-gray-500;
-}
-
-.signum-notification-button-close{
-    @apply inline-flex rounded-md bg-white text-gray-400 hover:text-gray-500 focus:outline-none focus:ring-2 focus:ring-indigo-500 focus:ring-offset-2;
-}

data/app/components/signum/notification_drawer/component.scss

@@ -1,7 +0,0 @@
- .signum-notification-drawer-button{
-    @apply w-8 h-8 bg-white m-0 rounded-full text-gray-400 hover:text-gray-500 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-primary-500 dark:bg-gray-900 dark:border-gray-700
-}
-
-.signum-notification-drawer-tray{
-    @apply  absolute right-0 z-10 mx-1 w-1/3 origin-top-right divide-y divide-gray-100 rounded-md bg-white shadow-lg ring-1 ring-black ring-opacity-5 overflow-y-auto max-h-screen
-}

data/app/jobs/signum/send_signals_job.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Signum
-  class SendSignalsJob < ApplicationJob
-    def perform(signal)
-      signal.broadcast!
-      Turbo::StreamsChannel.broadcast_prepend_to(:signals, target: "notifications_#{signal.signalable_id}",
-                                                           html: ApplicationController.render(Signum::Notification::Component.new(signal)))
-      Turbo::StreamsChannel.broadcast_prepend_to(:signals, target: "drawer_notifications_#{signal.signalable_id}",
-                                                           html: ApplicationController.render(Signum::NotificationDrawerItem::Component.new(signal)))
-    end
-  end
-end