overlastic 0.10.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1b527b482e60b28f554d457008dec266231ba993c12caf57d9b33047dc20abb
-  data.tar.gz: 0de5982c64a49f698aae70960470a260a4b0c85b76a611a00a4ebe89a852e87e
+  metadata.gz: b9564bcaf740459d550f4e7f0195cf4f1b1a4eb1da38dac702d71e6fcc1d972d
+  data.tar.gz: 1c5f9f6ef8eb8cac4beff8406e8d743332e3390961bb56f55d93204fdfc5ec7b
 SHA512:
-  metadata.gz: 9d97e99a7b509f0698173bc319ccbbd4cd98634e8149316666623590f0376b35eb2ab6f5ef8f22a9b221574f9778cac1a4697ea0294a3aa53d661a3428578fe9
-  data.tar.gz: 44d9dfca19da499f86ffbfb91a152f0210c54973d9f986819bd5bd6a3ea52a1b32ab3500f7a8770d20a5d6b0a527c224d122e810a2296c377fd96176cf59abc4
+  metadata.gz: 4c571017098b4cdecdfd8de6f8a28d9a2a8a4caaafdb31f656d3e6d83dc75d7efd09eb3f8d32002527607fe1e93c4304be123e34f7477f1cba0da9502d6adae2
+  data.tar.gz: fbd47da78e6fa186bcc6c55b8c58f24f07ae3db642191d3e004a91346919eaaece39f4727519db12e5b2f606af9d86a7470673a6a0285aec2248003eee5043d9

data/README.md

@@ -9,11 +9,11 @@
 <h3 align="center">Fantastically easy overlays using <a href="https://hotwired.dev/" target="_blank">Hotwire</a>.</h3>
 
 <p align="center">
-  <img alt="Build" src="https://img.shields.io/github/workflow/status/martinzamuner/overlastic/CI">
+  <img alt="Build" src="https://img.shields.io/github/actions/workflow/status/martinzamuner/overlastic/ci.yml?branch=main">
   <img alt="Gem" src="https://img.shields.io/gem/v/overlastic">
   <img alt="rails version" src="https://img.shields.io/badge/rails-%3E%3D%206.1.0-informational">
   <img alt="turbo-rails version" src="https://img.shields.io/badge/turbo--rails-%3E%3D%201.3.0-informational">
-  <img alt="License" src="https://img.shields.io/github/license/martinzamuner/overlastic">
+  <img alt="License" src="https://img.shields.io/badge/license-MIT-green">
 </p>
 
 Load any page inside an overlay (dialog modal, slide-out pane, or whatever else floats your boat). As easy as replacing `link_to` with `link_to_dialog`.
@@ -247,7 +247,15 @@ end
 
 ## UI customization
 
-Overlastic comes with default views for both the dialog and pane overlays. They are intended to provide an easy way to try the gem. For real-world usage you're expected to implement your own UI elements, or use something like [Bootstrap](https://getbootstrap.com) or [TailwindCSS Stimulus Components](https://github.com/excid3/tailwindcss-stimulus-components).
+Overlastic comes with default partials for both the dialog and pane overlays. They are intended to provide an easy way to try the gem. For real-world usage you're expected to implement your own UI elements, or use something like [Bootstrap](https://getbootstrap.com) or [TailwindCSS Stimulus Components](https://github.com/excid3/tailwindcss-stimulus-components).
+
+Keep in mind that the overlay partials will be used as layouts for the rendered content. You can access the content of your `overlay_args` as well as allowing `content_for` slots with something like:
+
+```erb
+<% title = local_assigns[:title] || content_for(:overlay_title) %>
+
+<h1><%= title %></h1>
+```
 
 <details>
   <summary>Default overlays</summary><br>

data/app/controllers/overlastic/concerns/overlay_handling.rb

@@ -4,28 +4,6 @@ module Overlastic::Concerns::OverlayHandling
   included do
     before_action :add_overlay_variant
 
-    private
-
-    def add_overlay_variant
-      request.variant = :overlay if helpers.current_overlay_name.present?
-    end
-
-    def close_overlay(key = :last, **options)
-      overlay_name = helpers.overlay_name_from(key) || :overlay1
-
-      # In case a Turbo Stream is appended which renders new overlay links, they should be generated
-      # relative to the foremost overlay still open after closing the requested overlays.
-      request.headers["Overlay-Name"] = :"overlay#{helpers.overlay_number_from(overlay_name) - 1}"
-
-      options.filter { |key, _| key.in? self.class._flash_types }.each { |key, value| flash.now[key] = value }
-
-      if block_given?
-        render overlay: overlay_name, html: helpers.overlastic_tag(id: overlay_name), append_turbo_stream: yield
-      else
-        render overlay: overlay_name, html: helpers.overlastic_tag(id: overlay_name)
-      end
-    end
-
     def render(*args, **options, &block)
       # Force render of overlays without an initiator
       request.headers["Overlay-Target"] ||= options.delete(:overlay_target)
@@ -62,13 +40,13 @@ module Overlastic::Concerns::OverlayHandling
           if block_given? || options[:html]
             stream_response = turbo_stream.replace_overlay(overlay_name, html: render_to_string(*args, **options, &block))
           else
-            stream_response = turbo_stream.replace_overlay(overlay_name, html: helpers.render_overlay { render_to_string(*args, **options, &block) })
+            stream_response = turbo_stream.replace_overlay(overlay_name, html: render_overlay(*args, **options, &block))
           end
         elsif request.variant.overlay?
           if initiator || error || target != "_top"
             options[:layout] = false
 
-            stream_response = turbo_stream.replace_overlay(overlay_name, html: helpers.render_overlay { render_to_string(*args, **options, &block) })
+            stream_response = turbo_stream.replace_overlay(overlay_name, html: render_overlay(*args, **options, &block))
           else
             request.headers["Overlay-Name"] = nil
             request.variant.delete :overlay
@@ -87,6 +65,20 @@ module Overlastic::Concerns::OverlayHandling
       end
     end
 
+    def render_overlay(*args, **options, &block)
+      type = request.headers["Overlay-Type"] || Overlastic.configuration.default_overlay
+      overlay_args = JSON.parse(Base64.urlsafe_decode64(request.headers["Overlay-Args"])) rescue {}
+      normalize_partial_name = ->(path) { path.sub(%r{[^/]+\z}) { |last| last.start_with?('_') ? last : "_#{last}" } }
+
+      options[:locals] ||= {}
+      options[:locals].merge! overlay_args.to_h.symbolize_keys
+      options[:layout] = proc { Overlastic.configuration.public_send(:"#{type}_overlay_view_path").yield_self(&normalize_partial_name) }
+
+      helpers.overlastic_tag do
+        helpers.concat render_to_string(*args, **options, &block)
+      end
+    end
+
     # Based on https://github.com/hotwired/turbo-rails/pull/367
     # by seanpdoyle
     def redirect_to(options = {}, response_options = {})
@@ -113,5 +105,27 @@ module Overlastic::Concerns::OverlayHandling
         super
       end
     end
+
+    private
+
+    def add_overlay_variant
+      request.variant = :overlay if helpers.current_overlay_name.present?
+    end
+
+    def close_overlay(key = :last, **options)
+      overlay_name = helpers.overlay_name_from(key) || :overlay1
+
+      # In case a Turbo Stream is appended which renders new overlay links, they should be generated
+      # relative to the foremost overlay still open after closing the requested overlays.
+      request.headers["Overlay-Name"] = :"overlay#{helpers.overlay_number_from(overlay_name) - 1}"
+
+      options.filter { |key, _| key.in? self.class._flash_types }.each { |key, value| flash.now[key] = value }
+
+      if block_given?
+        render overlay: overlay_name, html: helpers.overlastic_tag(id: overlay_name), append_turbo_stream: yield
+      else
+        render overlay: overlay_name, html: helpers.overlastic_tag(id: overlay_name)
+      end
+    end
   end
 end

data/app/helpers/overlastic/overlays_helper.rb

@@ -43,16 +43,4 @@ module Overlastic::OverlaysHelper
   def valid_overlay_name?(name)
     overlay_number_from(name).positive?
   end
-
-  def render_overlay(locals = {}, &block)
-    string = capture(&block)
-    type = request.headers["Overlay-Type"] || Overlastic.configuration.default_overlay
-    args_header = request.headers["Overlay-Args"]
-    overlay_args = JSON.parse(Base64.urlsafe_decode64(request.headers["Overlay-Args"])) if args_header.present?
-    locals.merge! overlay_args.to_h.symbolize_keys
-
-    overlastic_tag do
-      concat render(Overlastic.configuration.public_send(:"#{type}_overlay_view_path"), locals) { string }
-    end
-  end
 end

data/app/views/overlastic/inline/_dialog.html.erb

@@ -1,4 +1,4 @@
-<% title ||= "" %>
+<% title = local_assigns[:title] || content_for(:overlay_title) %>
 
 <div class="overlay" style="height:100vh;background-color:rgba(107, 114, 128, 0.5);justify-content:center;align-items:center;width: 100vw;display:flex;z-index:50;left:0px;top:0px;position:fixed;box-sizing:border-box;border-width:0px;border-style:solid;border-color:rgb(229, 231, 235);">
   <div style="width: 50%;justify-content:center;align-items:center;flex-direction:column;max-width:672px;height:662.398px;display:flex;box-sizing:border-box;border-width:0px;border-style:solid;border-color:rgb(229, 231, 235);">

data/app/views/overlastic/tailwind/_dialog.html.erb

@@ -1,4 +1,4 @@
-<% title ||= "" %>
+<% title = local_assigns[:title] || content_for(:overlay_title) %>
 
 <div class="overlay fixed top-0 left-0 z-50 flex justify-center w-screen h-screen-safe items-center bg-gray-500 bg-opacity-50">
   <div class="w-11/12 sm:w-5/6 lg:w-1/2 max-w-2xl h-[90vh] flex flex-col justify-center items-center">

data/lib/overlastic/version.rb

@@ -1,3 +1,3 @@
 module Overlastic
-  VERSION = "0.10.2"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: overlastic
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.12.0
 platform: ruby
 authors:
 - Martin Zamuner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2026-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Fantastically easy overlays using Hotwire. Bring your dialog modals and slide-out