rails_turbo_flash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0dda702d66c0f063661e512a565bbaadd341b453fd9491a1271f0931d3c0d93
+  data.tar.gz: 3cd165a8e3c4d3a76b367d00c2cbac020f269cf76ba567bf0aad3a5fb2ef0567
+SHA512:
+  metadata.gz: ff1a3ec4952f2f529a093de6e2c378f7d8853704aa5cf3bc71ee563839c693a5fc7a6c4954ecbaa612b6a4a040c3c4d399b216b511191597eb4e369a3662d11c
+  data.tar.gz: 10d2a5d755ba8c0f5330ed66538f89c320d27febed5e0e58142c8acf4568ffccdfd5ce4365c539c914acaeaa396802189b8a003ce33ed5be1eeeb48b2490f094

data/README.md

@@ -0,0 +1,73 @@
+# Rails Turbo Flash
+
+Automatic flash message injection for Ruby on Rails Turbo Stream responses.
+
+## Installation
+
+Add `rails_turbo_flash` to your Gemfile, or:
+
+```bash
+$ bundle add rails_turbo_flash
+```
+
+## Getting Started
+
+1. Include the controller helper:
+
+    ```ruby
+    class ApplicationController < ActionController::Base
+      include RailsTurboFlash::Callbacks
+    end
+    ```
+
+1. Use the view helper to render a turbo stream target into your top-level layouts. For example, in `app/views/layouts/application.html.erb`:
+
+    ```erb
+    <%= turbo_flash_tag %>
+
+    <%# Or with some additional attributes: %>
+
+    <%= turbo_flash_tag class: 'fixed flex gap-8 justify-center top-0 right-0 z-50' %>
+    ```
+
+1. Add flash messages in your controller actions with [`flash.now`](https://api.rubyonrails.org/classes/ActionDispatch/Flash/FlashHash.html#method-i-now).
+
+That's it!
+
+## Customizing
+
+To customize Rails Turbo Flash, create a file `config/initializers/rails_turbo_flash.rb`.
+
+The default values are shown below:
+
+```ruby
+RailsTurboFlash.configure do |config|
+  config.action = :prepend # The turbo stream action
+end
+```
+
+To make Rails Turbo Flash look like your app, override the bundled views by adding them to your app. You can manually copy the specific views that you need to `app/views/turbo_flash`, or copy them to your application with the included generator:
+
+```bash
+$ rails generate rails_turbo_flash:views
+```
+
+See [the bundled views](https://github.com/rnevius/rails_turbo_flash/tree/main/app/views/turbo_flash).
+
+## Why and How
+
+Unable to find an authoritative solution from the Turbo Rails team or Rails community for adding flash messages to turbo stream responses, I hacked this gem together. It aims to be [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself), simple, and unobtrusive. This solution was tailored specifically to my needs and _works for me_; I make no guarantees it's good for everyone.
+
+[Basically](https://github.com/rnevius/rails_turbo_flash/blob/main/lib/rails_turbo_flash/callbacks.rb), it checks for a `turbo_stream` request format and appends a turbo stream to the response body via an `after_action` callback. The entire implementation is only a few lines of code.
+
+## Contributing
+
+Here are a few ways you can help:
+
+- [Report bugs or suggest new features](https://github.com/rnevius/rails_turbo_flash/issues)
+- Fix bugs, add new features, and [submit pull requests](https://github.com/rnevius/rails_turbo_flash/pulls)
+- Write, clarify, or fix documentation and tests
+
+## License
+
+Open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/config/rails_turbo_flash_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/rails_turbo_flash .css

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

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/rails_turbo_flash/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsTurboFlash
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/rails_turbo_flash/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsTurboFlash
+  module ApplicationHelper
+  end
+end

data/app/jobs/rails_turbo_flash/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsTurboFlash
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/rails_turbo_flash/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module RailsTurboFlash
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/rails_turbo_flash/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RailsTurboFlash
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/rails_turbo_flash/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails turbo flash</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "rails_turbo_flash/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/turbo_flash/_flash_message.html.erb

@@ -0,0 +1,8 @@
+<% flash.each do |key, message| %>
+  <div role="dialog" aria-labelledby="<%= "turbo-flash-title-#{key}" %>" aria-describedby="<%= "turbo-flash-body-#{key}" %>">
+    <div id="<%= "turbo-flash-title-#{key}" %>"><%= message['title'] || message %></div>
+    <% if message['body'] %>
+      <div id="<%= "turbo-flash-body-#{key}" %>"><%= message['body'] %></div>
+    <% end %>
+  </div>
+<% end %>

data/app/views/turbo_flash/_flash_message.html.haml

@@ -0,0 +1,5 @@
+- flash.each do |key, message|
+  %div{"aria-describedby" => "turbo-flash-body-#{key}", "aria-labelledby" => "turbo-flash-title-#{key}", :role => "dialog"}
+    %div{:id => "turbo-flash-title-#{key}"}= message['title'] || message
+    - if message['body']
+      %div{:id => "turbo-flash-body-#{key}"}= message['body']

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+RailsTurboFlash::Engine.routes.draw do
+end

data/lib/generators/rails_turbo_flash/views_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module RailsTurboFlash
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../app/views/turbo_flash', __dir__)
+
+      def install
+        if defined?(Haml)
+          copy_file('_flash_message.html.haml', 'app/views/turbo_flash/_flash_message.html.haml')
+        else
+          copy_file('_flash_message.html.erb', 'app/views/turbo_flash/_flash_message.html.erb')
+        end
+      end
+    end
+  end
+end

data/lib/rails_turbo_flash/callbacks.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RailsTurboFlash
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      after_action :append_flash_to_turbo_stream_response
+    end
+
+    private
+
+    def append_flash_to_turbo_stream_response
+      return unless request.format.turbo_stream? && flash.any?
+
+      response.write turbo_stream.public_send(
+        RailsTurboFlash.config.action,
+        RailsTurboFlash.config.target,
+        partial: 'turbo_flash/flash_message',
+        locals: { flash: }
+      )
+    end
+  end
+end

data/lib/rails_turbo_flash/config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RailsTurboFlash
+  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
+    include Options
+
+    option :action, default: :prepend
+    option :target, default: 'turbo-flash'
+
+    def initialize
+      set_defaults!
+    end
+  end
+
+  module Configurable
+    attr_writer :config
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield(config)
+    end
+
+    def reset_config!
+      @config = Configuration.new
+    end
+  end
+end

data/lib/rails_turbo_flash/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RailsTurboFlash
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsTurboFlash
+  end
+end

data/lib/rails_turbo_flash/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails_turbo_flash/view_helpers'
+
+module RailsTurboFlash
+  class Railtie < Rails::Railtie
+    initializer 'rails_turbo_flash.view_helpers' do
+      ActiveSupport.on_load(:action_view) do
+        include RailsTurboFlash::ViewHelpers
+      end
+    end
+  end
+end

data/lib/rails_turbo_flash/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsTurboFlash
+  VERSION = '0.1.0'
+end

data/lib/rails_turbo_flash/view_helpers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RailsTurboFlash
+  module ViewHelpers
+    # Generates the HTML tag for displaying flash messages using Turbo Streams in Ruby on Rails.
+    #
+    # @param options [Hash] The options for customizing the HTML tag.
+    # @option options [String] :id The ID attribute for the HTML tag.
+    #
+    # @return [String] The HTML tag for displaying flash messages.
+    def turbo_flash_tag(options = nil)
+      options ||= {}
+      options[:id] = RailsTurboFlash.config.target
+
+      tag.div nil, **options
+    end
+  end
+end

data/lib/rails_turbo_flash.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rails_turbo_flash/callbacks'
+require 'rails_turbo_flash/config'
+require 'rails_turbo_flash/version'
+require 'rails_turbo_flash/engine'
+require 'rails_turbo_flash/railtie' if defined?(Rails)
+
+module RailsTurboFlash
+  extend Configurable
+end

data/lib/tasks/rails_turbo_flash_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :rails_turbo_flash do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rails_turbo_flash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Nevius
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Flash message injection for Ruby on Rails TurboStream responses
+email:
+- ryan@syntarsus.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/rails_turbo_flash_manifest.js
+- app/assets/stylesheets/rails_turbo_flash/application.css
+- app/controllers/rails_turbo_flash/application_controller.rb
+- app/helpers/rails_turbo_flash/application_helper.rb
+- app/jobs/rails_turbo_flash/application_job.rb
+- app/mailers/rails_turbo_flash/application_mailer.rb
+- app/models/rails_turbo_flash/application_record.rb
+- app/views/layouts/rails_turbo_flash/application.html.erb
+- app/views/turbo_flash/_flash_message.html.erb
+- app/views/turbo_flash/_flash_message.html.haml
+- config/routes.rb
+- lib/generators/rails_turbo_flash/views_generator.rb
+- lib/rails_turbo_flash.rb
+- lib/rails_turbo_flash/callbacks.rb
+- lib/rails_turbo_flash/config.rb
+- lib/rails_turbo_flash/engine.rb
+- lib/rails_turbo_flash/railtie.rb
+- lib/rails_turbo_flash/version.rb
+- lib/rails_turbo_flash/view_helpers.rb
+- lib/tasks/rails_turbo_flash_tasks.rake
+homepage: https://github.com/rnevius/rails_turbo_flash
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rnevius/rails_turbo_flash
+  source_code_uri: https://github.com/rnevius/rails_turbo_flash
+  changelog_uri: https://github.com/rnevius/rails_turbo_flash/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Turbo Stream flash messages for Rails
+test_files: []