unmagic-component-partial 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fee998ec6fa5aaa504dbb90e3a3a13f772fb09fe6fbc3f62615548a955ff54ec
+  data.tar.gz: a981dfd0bef005c9c26d74354c4ec183dd7feef4380d7704a9a9791ad2ebfd47
+SHA512:
+  metadata.gz: d98c0a37483bd3dd1738313d1aba3eb8a7b1c4596a8478acde7a7f2ab423ce7a6bcf3760660650c962e0eaa588238e53b7282ca93f7b0e88319bd9c0dd38b956
+  data.tar.gz: 14ab985618ec009ad9c75b43177cc7678ffb8c1b7fffc3615c6679d92844ad984bb534f6120d75097191e15f50123c290e670511213c97554bc46d31dfb3cbfd

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0]
+
+### Added
+- `component_partial` view helper and the `Partial` slot handle — render a
+  partial as a layout, yield it a handle, and fill named slots the partial reads
+  back wherever it likes (a card footer, a header actions row).
+- Rails integration: a railtie mixes the helper into ActionView, so every
+  template can call `component_partial` with no setup.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Keith Pitt
+
+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,72 @@
+# unmagic-component-partial
+
+Named slots for Rails partials rendered as layouts.
+
+Rails partials have one body (the block you pass to `render layout:`). That's
+fine until a component needs content in more than one place — a card with a body
+*and* a footer, a panel with a header actions row *and* a body. The usual
+workarounds (a second partial, a `content_for` global, a pile of locals carrying
+pre-rendered HTML) all leak the component's structure to the caller.
+
+This gem gives a partial **named slots**, after Dom Christie's
+[Component partials](https://domchristie.co.uk/posts/component-partials/). The
+caller fills slots inline; the partial reads them back wherever it likes.
+
+## Install
+
+```ruby
+# Gemfile
+gem "unmagic-component-partial"
+```
+
+The railtie mixes the `component_partial` helper into ActionView automatically —
+no initializer.
+
+## Usage
+
+Render the partial as a layout. The block is the body, and is yielded a handle
+you fill slots on:
+
+```erb
+<%= render layout: "shared/card", locals: { title: "Profile" } do |card| %>
+  ...the card body...
+
+  <% card.content_for :footer do %>
+    <%= form.submit "Save" %>
+  <% end %>
+<% end %>
+```
+
+Inside the partial, grab a handle with `component_partial`, render the body with
+`yield`, and read slots back where they belong:
+
+```erb
+<%# app/views/shared/_card.html.erb %>
+<% partial = component_partial %>
+<section class="card">
+  <div class="card__body">
+    <%= yield partial %>
+  </div>
+
+  <% if partial.content_for(:footer) %>
+    <footer class="card__footer">
+      <%= partial.content_for(:footer) %>
+    </footer>
+  <% end %>
+</section>
+```
+
+The body block and the slot blocks are the *same* block, so the slots see the
+caller's locals and helpers exactly as the body does.
+
+## API
+
+- `component_partial` — returns a fresh `Partial` bound to the current view.
+- `Partial#content_for(name, content = nil, &block)`:
+  - with a string or block, **writes** the slot (successive writes to the same
+    slot append), and returns `nil`;
+  - with no content, **reads** the slot back, or `nil` if it was never set.
+
+## License
+
+MIT

data/lib/unmagic/component_partial/helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Unmagic
+  module ComponentPartial
+    # The view helper. Mixed into ActionView by the railtie, so every template
+    # can call `component_partial`.
+    module Helper
+      def component_partial
+        Partial.new(self)
+      end
+    end
+  end
+end

data/lib/unmagic/component_partial/partial.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/output_safety"
+require "active_support/core_ext/object/blank"
+
+module Unmagic
+  module ComponentPartial
+    # A handle yielded to the block of a partial rendered as a layout. The block
+    # fills named slots; the partial reads them back wherever it likes — for
+    # content that isn't the main body, e.g. a card footer.
+    class Partial
+      def initialize(view_context)
+        @view_context = view_context
+        @contents = Hash.new { |h, k| h[k] = ActiveSupport::SafeBuffer.new }
+      end
+
+      # Write a slot (string or block), or read it back when called without
+      # content. Reading an unset slot returns nil.
+      def content_for(name, content = nil, &block)
+        if content || block
+          content = @view_context.capture(&block) if block
+          @contents[name] << content.to_s
+          nil
+        else
+          @contents[name].presence
+        end
+      end
+    end
+  end
+end

data/lib/unmagic/component_partial/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Unmagic
+  module ComponentPartial
+    # Rails integration: make `component_partial` available in every template.
+    class Railtie < ::Rails::Railtie
+      initializer "unmagic.component_partial.helper" do
+        ActiveSupport.on_load(:action_view) do
+          include Unmagic::ComponentPartial::Helper
+        end
+      end
+    end
+  end
+end

data/lib/unmagic/component_partial/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Unmagic
+  module ComponentPartial
+    VERSION = "0.1.0"
+  end
+end

data/lib/unmagic/component_partial.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "component_partial/version"
+require_relative "component_partial/partial"
+require_relative "component_partial/helper"
+require_relative "component_partial/railtie" if defined?(Rails::Railtie)
+
+# Component-partial slots, after Dom Christie's "Component partials"
+# (https://domchristie.co.uk/posts/component-partials/).
+#
+# Render a partial as a layout and yield it a Partial object. The block fills
+# named slots that the partial reads back wherever it likes — handy for content
+# that isn't the main body, e.g. a card footer:
+#
+#   <%= render layout: "shared/card" do |card| %>
+#     ...body...
+#     <% card.content_for :footer do %><%= form.submit %><% end %>
+#   <% end %>
+#
+# and in the partial: `<%= partial.content_for(:footer) %>`, where
+# `partial = component_partial`.
+module Unmagic
+  module ComponentPartial
+  end
+end

data/lib/unmagic-component-partial.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "unmagic/component_partial"

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: unmagic-component-partial
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keith Pitt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Render a partial as a layout and yield it a handle whose named slots
+  the block fills and the partial reads back wherever it likes — for content that
+  isn't the main body, like a card footer or a header actions row.
+email:
+- keith@unreasonable-magic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/unmagic-component-partial.rb
+- lib/unmagic/component_partial.rb
+- lib/unmagic/component_partial/helper.rb
+- lib/unmagic/component_partial/partial.rb
+- lib/unmagic/component_partial/railtie.rb
+- lib/unmagic/component_partial/version.rb
+homepage: https://github.com/unreasonable-magic/unmagic-component-partial
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/unreasonable-magic/unmagic-component-partial
+  source_code_uri: https://github.com/unreasonable-magic/unmagic-component-partial
+  changelog_uri: https://github.com/unreasonable-magic/unmagic-component-partial/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.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Named slots for Rails partials rendered as layouts
+test_files: []