faw_toast 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc39d92ac6fc1ce8da21e5b03174d62fa6ab8181655a3d3b8765b64259e08a77
-  data.tar.gz: 405c14d7a313d6169ce47fac895b219bffcf152ed345c51f751ccebaa73809cf
+  metadata.gz: 20b5f4ba4431cccf4fb2e389d96eb476f6bcad0e647510b7efd45c0dc6e739b6
+  data.tar.gz: f59a37ec861743eedfa4a7a1d6eb71f681a395345c60fc34f2ed4dfbae34c5dd
 SHA512:
-  metadata.gz: 23df80b449b32f2c360c0f36141d7a19d5514e9d0e7532402b2fd74a617f873d4784eac7f8b6e0a956116b86797117c7189f1aadc27a272b6af29b8101d09f5c
-  data.tar.gz: 1147a18542a6a9b4ee15d85b9d3e9ee62a071122be40d75adc9234db2115be66083da9d743c0382b975e559f44ad069d09761e1d765b16927a7ee1b1e20566e4
+  metadata.gz: 40a6bcadcc29476e6b7c3caf40f8b06e41a48c283ba6ed28e945c2923181896da92d8169d21f90ec91ac92a41ab05395f2cd4d5d420ba2a4cdb4e00381273385
+  data.tar.gz: 777749653a1c46b020e285cd39c25767d45a7040f52d6a02dc58bdb81a852c05cbd86d261d145aed7916ebd83a72c0c78c66970be0f09e5e9074fbaf9a3fd469

data/README.md

@@ -40,16 +40,13 @@ rails generate faw_toast:install
 
 This will:
 1. Create a configuration initializer at `config/initializers/faw_toast.rb`
-2. Add the toast container to your application layout
+2. Include the following into your `application.html.erb`
+   * Add a style tag for the configurable css variables 
+   * `<%= stylesheet_link_tag "faw_toast", "data-turbo-track": "reload" %>`
+   * `<%= javascript_include_tag "faw_toast", "data-turbo-track": "reload", type: "module" %>`
+   * Add the toast container div
 
-Include the css and javascript files in your `application.html.erb` layout file.
-
-For `propshaft`
-```erb
-  <%= stylesheet_link_tag "faw_toast", "data-turbo-track": "reload" %>
-  <%= javascript_include_tag "faw_toast", "data-turbo-track": "reload", type: "module" %>
-```
-and if you are using `sprockets` include the following lines in your `config/manifest.js`
+If you are using `sprockets` you may need to add the following lines to your `app/config/manifest.js`
 ```javascript
 //= link faw_toast.js
 //= link faw_toast.css
@@ -57,6 +54,8 @@ and if you are using `sprockets` include the following lines in your `config/man
 
 ## Usage
 
+### Basic Usage
+
 FawToast works with Rails flash messages. You can use it like this
 
 ```ruby
@@ -85,6 +84,28 @@ Turbo::StreamsChannel.broadcast_append_to(
 )
 ```
 
+### With Turbo Streams
+
+For Turbo Streams applications, you can use the built-in `render_message` helper:
+
+```ruby
+# In your controller
+def create
+  # Your logic here
+  render_message(:success, :ok, "Item was successfully created!")
+end
+```
+
+The `render_message` method takes three parameters:
+- `flash_type`: The type of flash message (:success, :alert, :danger, etc.)
+- `status`: The HTTP status code to return (:ok, :created, etc.)
+- `message`: The message to display in the toast
+
+This helper automatically:
+1. Sets the flash message
+2. Renders a Turbo Stream that appends the toast to the toast container
+3. Sets the appropriate HTTP status code
+
 FawToast supports the following flash types out of the box:
 - `:success` - Green border
 - `:alert` - Red border

data/app/views/faw_toast/_toast.html.erb

@@ -1,6 +1,14 @@
-<% flash.each do |type, message| %>
+<% if local_assigns[:type] && local_assigns[:message] %>
   <div class="faw-toast <%= flash_class(type) %>">
     <%= message %>
     <div class="faw-toast-progress"></div>
   </div>
+<% else %>
+  <% flash.each do |type, message| %>
+    <div class="faw-toast <%= flash_class(type) %>">
+      <%= message %>
+      <div class="faw-toast-progress"></div>
+    </div>
+  <% end %>
 <% end %>
+

data/lib/faw_toast/toast_helper.rb

@@ -20,6 +20,11 @@ module FawToast
         render_toast
       end
     end
+    
+    def render_message(flash_type = :success, status = :ok, message = nil)
+      flash.now[flash_type] = message
+      render turbo_stream: turbo_stream.append("faw-toast-container", partial: "faw_toast/toast"), status: status
+    end
 
     def toast_css_variables
       # Generate a style tag with CSS variables based on configuration

data/lib/faw_toast/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FawToast
-  VERSION = "1.3.0"
+  VERSION = "1.4.1"
 end

data/lib/generators/faw_toast/install/install_generator.rb

@@ -15,7 +15,7 @@ module FawToast
         inject_into_file "app/views/layouts/application.html.erb", after: "<head>" do
           <<-HTML
 
-  <%= toast_css_variables %>
+    <%= toast_css_variables %>
           HTML
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faw_toast
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - alexwebgr
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-27 00:00:00.000000000 Z
+date: 2025-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails