Update alert attribute "description" to "message"

Author: chaimann

admin/app/components/solidus_admin/layout/flashes/alerts/component.html.erb

@@ -1,7 +1,7 @@
 <div id="flash_alerts" class="flex items-center justify-center">
   <div class="fixed w-2/3 top-3 flex flex-col gap-3 pointer-events-none" role="alert">
     <% alerts.each do |key, text| %>
-      <%= render component("ui/alert").new(title: text[:title], description: text[:description], scheme: key.to_sym) %>
+      <%= render component("ui/alert").new(title: text[:title], message: text[:message], scheme: key.to_sym) %>
     <% end %>
   </div>
 </div>

admin/app/components/solidus_admin/layout/flashes/alerts/component.rb

@@ -4,14 +4,14 @@ class SolidusAdmin::Layout::Flashes::Alerts::Component < SolidusAdmin::BaseCompo
   attr_reader :alerts
 
   # Construct alert flashes like:
-  #   flash[:alert] = { <alert_type>: { title: "", description: "" } }
+  #   flash[:alert] = { <alert_type>: { title: "", message: "" } }
   # See +SolidusAdmin::UI::Alert::Component::SCHEMES+ for available alert types.
   #
   # If a string is passed to flash[:alert], we treat it is a body of the alert message and fall back to +danger+ type
   # and default title (see +SolidusAdmin::UI::Alert::Component+).
   def initialize(alerts:)
     if alerts.is_a?(String)
-      alerts = { danger: { description: alerts } }
+      alerts = { danger: { message: alerts } }
     end
 
     @alerts = alerts.slice(*SolidusAdmin::UI::Alert::Component::SCHEMES.keys)

admin/app/components/solidus_admin/ui/alert/component.html.erb

@@ -18,7 +18,7 @@
     </div>
     <div class="flex flex-col px-2 pt-1 gap-3">
       <p class="font-semibold text-base text-black leading-none"><%= @title %></p>
-      <p class="font-normal text-sm text-black leading-none"><%= @description.html_safe %></p>
+      <p class="font-normal text-sm text-black leading-none"><%= @message.html_safe %></p>
     </div>
   </div>
   <div>

admin/app/components/solidus_admin/ui/alert/component.rb

@@ -35,9 +35,9 @@ class SolidusAdmin::UI::Alert::Component < SolidusAdmin::BaseComponent
     },
   }
 
-  def initialize(title:, description:, scheme: :success)
+  def initialize(title:, message:, scheme: :success)
     @title = title
-    @description = description
+    @message = message
     @scheme = scheme
   end
 

admin/spec/components/previews/solidus_admin/ui/alert/component_preview/overview.html.erb

@@ -5,7 +5,7 @@
     </h6>
 
     <div class="w-5/6">
-      <%= render current_component.new(scheme: :success, title: "Added Solidus T-Shirt", description: "<a href='#' class='underline'>Add another product</a> or <a href='#' class='underline'>view product in a new window</a>".html_safe) %>
+      <%= render current_component.new(scheme: :success, title: "Added Solidus T-Shirt", message: "<a href='#' class='underline'>Add another product</a> or <a href='#' class='underline'>view product in a new window</a>".html_safe) %>
     </div>
   </div>
 
@@ -15,7 +15,7 @@
     </h6>
 
     <div class="w-5/6">
-      <%= render current_component.new(scheme: :warning, title: "No active stock locations left", description: "You can assign new active stock location <a href='#' class='underline'>here</a>".html_safe) %>
+      <%= render current_component.new(scheme: :warning, title: "No active stock locations left", message: "You can assign new active stock location <a href='#' class='underline'>here</a>".html_safe) %>
     </div>
   </div>
 
@@ -25,7 +25,7 @@
     </h6>
 
     <div class="w-5/6">
-      <%= render current_component.new(scheme: :danger, title: "Request was not completed", description: "Cannot destroy default store") %>
+      <%= render current_component.new(scheme: :danger, title: "Request was not completed", message: "Cannot destroy default store") %>
     </div>
   </div>
 
@@ -35,7 +35,7 @@
     </h6>
 
     <div class="w-5/6">
-      <%= render current_component.new(scheme: :info, title: "Locales available", description: "Did you know you can update storefront locales <a href='#' class='underline'>here</a>?".html_safe) %>
+      <%= render current_component.new(scheme: :info, title: "Locales available", message: "Did you know you can update storefront locales <a href='#' class='underline'>here</a>?".html_safe) %>
     </div>
   </div>
 </div>

admin/spec/components/solidus_admin/layout/flashes/alerts/component_spec.rb

@@ -7,7 +7,7 @@
 
   context "when alerts passed as Hash" do
     let(:alerts) do
-      { warning: { title: "Be careful", description: "Something fishy going on" } }
+      { warning: { title: "Be careful", message: "Something fishy going on" } }
     end
 
     it "renders correctly" do
@@ -36,8 +36,8 @@
   describe "multiple alerts" do
     let(:alerts) do
       {
-        warning: { title: "Be careful", description: "Something fishy going on" },
-        success: { title: "It worked", description: "Nothing to worry about!" }
+        warning: { title: "Be careful", message: "Something fishy going on" },
+        success: { title: "It worked", message: "Nothing to worry about!" }
       }
     end
 

admin/spec/components/solidus_admin/ui/alert/component_spec.rb

@@ -8,9 +8,9 @@
   end
 
   describe "defaults" do
-    let(:component) { described_class.new(title:, description:, scheme:) }
+    let(:component) { described_class.new(title:, message:, scheme:) }
     let(:title) { "Title" }
-    let(:description) { "Description" }
+    let(:message) { "Message" }
     let(:scheme) { :success }
 
     context "when title is not present" do