hot_flash 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1064d37097d0d1e1a3e2425ab5d6281d37f5f22cc5d3b2a560d7eb5b1483ee83
+  data.tar.gz: 30e970f56bae0f5bd33949f44f4597d399a6e70f528cc3fb1a23ef4ec155715f
+SHA512:
+  metadata.gz: a654e05d1f161ecd25a550cd0dec69045d4c600c50ab407e9f34ca3cfa8e3abf87578322b3cb6e13ac3cbf9d35bebd64fe73867fd1a192a2e5584a6c4bd82794
+  data.tar.gz: 014fe81e8df010bb28be02d22f5ed0e43b91e4ef30b6c63af6ac4720af7279c50630a5507fc80a21ca43db94e26faeda50b97ccbef550b1be9d47f6a6c793ec5

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog 
+
+## Unreleased
+
+Nothing, yet. 
+
+## Version 1.0.0 (Aug 18, 2023)
+
+Nothing, yet. 
+
+## Version 1.0.0 (Aug 18, 2023)
+
+Nothing, yet.
+
+## Version 1.0.0 (Aug 18, 2023)
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Partytray
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,139 @@
+# <img src="./logo.png" style="max-height:100px;" /> HotFlash
+
+Automagically inject flash messages into Ruby on Rails TurboStream responses using [Hotwire](https://github.com/hotwired/turbo-rails).
+
+<img src="./demo.gif" alt="Example of automatically injecting flash messages into Ruby on Rails TurboStream responses using Hotwire." />
+
+## Why
+
+Because it's weird? I don't know.
+
+I originally developed [TurboFlash](https://github.com/joshmn/turbo_flash) as a proof of concept, but people ended up using it, and, even scarier, contributing back to it. This terrified me because...
+
+I truthfully hate the implementation. It felt like one big hack. I knew a better way to do it. So, here it is, in all its glory, "better", but I still don't like it.
+
+Granted, this implementation is arguably just as "bad" because it intercepts `render`, but it's clean, _should_ be relatively safe, and works.
+
+## How it works 
+
+HotFlash is about 100 lines of code, mostly of convenience methods and developer happiness code. It's not scary. This code effectively does the following, so you don't have to:
+
+```ruby
+def create
+  @post = Post.new(post_params)
+  if @post.save 
+    redirect_to @post 
+  else
+    render turbo_stream: [
+      turbo_stream.replace(:form, "form", locals: { post: @post }),
+      turbo_stream.replace(:flashes, "shared/flashes") # <-- this 
+    ]
+  end
+end
+```
+
+## Usage
+
+### 1. Add it to your application:
+
+```shell 
+bundle add hot_flash
+```
+
+### 2. Install it 
+
+```shell 
+rails g hot_flash:install
+```
+
+Will copy over an initializer. 
+
+### 3. Make it work with your application
+
+It's not enabled out-of-the-box, so you'll need to enable it:
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :enable_hotflash
+end
+```
+
+HotFlashes expects you to have a target of `#flashes` available, and a method called `#render_flash` available as a helper.
+
+```ruby
+module ApplicationHelper
+  def render_flash
+    return if @_flash_rendered
+    
+    render partial: "shared/flash"
+  end
+end
+```
+
+Where `app/views/shared/flash.html.erb` renders the flash contents and includes the target selector:
+
+```html
+<div id="flashes">
+  <% flash.each do |key, value| %>
+    <div><%= key %>: <%= value %></div>
+  <% end %> 
+</div>
+```
+
+### 4. Get on with your day because you're done
+
+All flashes are rendered just like they would be in the default request/response cycle; no need to do any of the hack-y junk that TurboFlash did.
+
+### 5. But you can get more granular:
+
+#### Disable or enable:
+
+```ruby
+class PostsController < ApplicationController
+  disable_hotflash
+end
+```
+
+or,
+
+```ruby
+class PostsController < ApplicationController
+  disable_hotflash only: [:new]
+end
+```
+
+or,
+
+```ruby
+class PostsController < ApplicationController
+  enable_hotflash only: [:new]
+end
+```
+
+#### Fiddle with HotFlashes on yourself
+
+HotFlashes has a `hotflash` method that you can interact with if you want:
+
+```ruby
+class PostsController < ApplicationController
+  before_action :disable_hotflash
+  before_action :interact_with_hotflash
+  
+  private 
+  
+  def interact_with_hotflash
+    hotflash.enable!
+    hotflash.turbo_action = "update"
+    hotflash.flash_message = :some_other_way_to_show_the_message
+    hotflash.turbo_target = '#some_other_target'
+  end
+end
+```
+
+## Contributing
+
+`flash_method` could probably use some options.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/generators/hot_flash/install_generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators"
+
+module HotFlash
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.join(__dir__, "templates")
+
+      def copy_templates
+        template "config.rb", "config/initializers/hotflash.rb"
+      end
+    end
+  end
+end

data/lib/generators/hot_flash/templates/config.rb.tt

@@ -0,0 +1,13 @@
+HotFlash.configure do |config|
+  # ==> Turbo Target
+  # config.turbo_target = "#flashes"
+  #
+  # ==> Turbo Action
+  # config.turbo_action = "replace"
+  #
+  # ==> Flash Method
+  # This should be exposed either on the controller-level, either via an instance method on the controller or exposed
+  # to the controller via a traditional helper module
+  #
+  # config.flash_method = :render_flash
+end

data/lib/hot_flash/action.rb

@@ -0,0 +1,59 @@
+module HotFlash
+  class Action
+    def initialize(controller)
+      @controller = controller
+      @enabled = false
+      @turbo_action = HotFlash.config.turbo_action
+      @turbo_target = HotFlash.config.turbo_target
+      @flash_method = HotFlash.config.flash_method
+    end
+
+    def enable!
+      @enabled = true
+    end
+
+    def disable!
+      @enabled = false
+    end
+
+    def enabled?
+      @enabled
+    end
+
+    def render
+      @controller.view_context.turbo_stream_action_tag(turbo_action, targets: turbo_target, template: content)
+    end
+
+    def turbo_action
+      @turbo_action
+    end
+
+    def turbo_target
+      @turbo_target
+    end
+
+    def render_into(render_args)
+      return render_args unless render?(render_args)
+
+      render_args[0][:turbo_stream] << render
+      render_args
+    end
+
+    def render?(render_args)
+      return false unless enabled?
+      return false unless render_args[0] && render_args[0][:turbo_stream]
+
+      true
+    end
+
+    def content
+      if @controller.respond_to?(@flash_method)
+        return @controller.send(@flash_method)
+      elsif @controller.helpers.respond_to?(@flash_method)
+        return @controller.helpers.send(@flash_method)
+      else
+        raise NoMethodError, "#{@controller.class.name} doesn't respond to #{@flash_method}"
+      end
+    end
+  end
+end

data/lib/hot_flash/controller.rb

@@ -0,0 +1,42 @@
+require 'hot_flash/action'
+
+module HotFlash
+  module Controller
+    extend ActiveSupport::Concern
+
+    private
+
+    def render(*args)
+      args = hotflash.render_into(args)
+
+      super(*args)
+    end
+
+    class_methods do
+      private
+
+      def disable_hotflash(**options)
+        before_action :disable_hotflash, **options
+      end
+
+      def enable_hotflash(**options)
+        before_action :enable_hotflash, **options
+      end
+    end
+
+    private
+
+    def enable_hotflash
+      hotflash.enable!
+    end
+
+    def disable_hotflash
+      hotflash.disable!
+    end
+
+    def hotflash
+      @hotflash ||= HotFlash::Action.new(self)
+    end
+  end
+end
+

data/lib/hot_flash/railtie.rb

@@ -0,0 +1,10 @@
+module HotFlash
+  class Railtie < ::Rails::Railtie
+    initializer "hotflash.initialize" do
+      ActiveSupport.on_load(:action_controller_base) do
+        ActionController::Base.send(:include, HotFlash::Controller)
+      end
+    end
+  end
+end
+

data/lib/hot_flash/version.rb

@@ -0,0 +1,3 @@
+module HotFlash
+  VERSION = "1.0.0"
+end

data/lib/hot_flash.rb

@@ -0,0 +1,25 @@
+require "hot_flash/version"
+require "hot_flash/railtie"
+require 'hot_flash/controller'
+
+module HotFlash
+  class Configuration
+    attr_accessor :turbo_action
+    attr_accessor :turbo_target
+    attr_accessor :flash_method
+
+    def initialize
+      @turbo_action = "replace"
+      @turbo_target = "#flashes"
+      @flash_method = :render_flash
+    end
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield config
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: hot_flash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- joshmn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+description: Automatically inject flash messages into TurboStream responses.
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/hot_flash/install_generator.rb
+- lib/generators/hot_flash/templates/config.rb.tt
+- lib/hot_flash.rb
+- lib/hot_flash/action.rb
+- lib/hot_flash/controller.rb
+- lib/hot_flash/railtie.rb
+- lib/hot_flash/version.rb
+homepage: https://github.com/joshmn/hot_flashes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joshmn/hot_flashes
+  source_code_uri: https://github.com/joshmn/hot_flashes
+  changelog_uri: https://github.com/joshmn/hot_flashes
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Automatically inject flash messages into TurboStream responses.
+test_files: []