unmagic-component-partial 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fee998ec6fa5aaa504dbb90e3a3a13f772fb09fe6fbc3f62615548a955ff54ec
-  data.tar.gz: a981dfd0bef005c9c26d74354c4ec183dd7feef4380d7704a9a9791ad2ebfd47
+  metadata.gz: 529eef7a5ff2d79dd21a4b688f5cece6e3a90ffc93dc1300cfba899d91c70868
+  data.tar.gz: 8d35fb97bf0bfeb954cabac8a8bb8008cc602c261858aecb78f8c0ef1c78c44d
 SHA512:
-  metadata.gz: d98c0a37483bd3dd1738313d1aba3eb8a7b1c4596a8478acde7a7f2ab423ce7a6bcf3760660650c962e0eaa588238e53b7282ca93f7b0e88319bd9c0dd38b956
-  data.tar.gz: 14ab985618ec009ad9c75b43177cc7678ffb8c1b7fffc3615c6679d92844ad984bb534f6120d75097191e15f50123c290e670511213c97554bc46d31dfb3cbfd
+  metadata.gz: 4a467474e28eb41b2dd0aae1197aac4c68f63ea0cf1a71b6d2ab4c2990952cf35fe5a8073ee35ab41e902e677978c0107ce6837debfd77213674d3066db446dc
+  data.tar.gz: 24134491954e79fb9e9e325df051f6b752df5274fd4c3b2658e4008f81b81adb5b1579fd72a504c742332dcf95f419e24889bf79326670b5eb07431f171fbc8a

data/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0]
+
+### Added
+- Props on slots: `content_for` accepts keyword arguments
+  (`content_for :footer, align: :right do … end`) and the partial reads them
+  back with `props_for(:footer)`. Props merge across successive writes and may
+  be passed on their own to attach data without content. Existing `content_for`
+  read/write behaviour is unchanged.
+
 ## [0.1.0]
 
 ### Added

data/README.md

@@ -59,13 +59,42 @@ Inside the partial, grab a handle with `component_partial`, render the body with
 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.
 
+## Props
+
+A slot can carry **props** — structured data the partial reads back to decide
+*how* to render the slot. Pass them as keyword arguments when filling the slot:
+
+```erb
+<% card.content_for :footer, align: :right do %>
+  <%= form.submit "Save" %>
+<% end %>
+```
+
+Read them back with `props_for`:
+
+```erb
+<% if card.content_for(:footer) %>
+  <footer class="card__footer card__footer--<%= card.props_for(:footer)[:align] %>">
+    <%= card.content_for(:footer) %>
+  </footer>
+<% end %>
+```
+
+`props_for` returns an empty hash for a slot that has no props, so indexing into
+it is always safe.
+
 ## API
 
 - `component_partial` — returns a fresh `Partial` bound to the current view.
-- `Partial#content_for(name, content = nil, &block)`:
+- `Partial#content_for(name, content = nil, **props, &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.
+  - `props` attach data to the slot (successive writes merge, last key winning),
+    and may be passed on their own to write props without content;
+  - with no content, block, or props, **reads** the slot back, or `nil` if it was
+    never set.
+- `Partial#props_for(name)` — reads the props attached to a slot, or `{}` if none
+  were set.
 
 ## License
 

data/lib/unmagic/component_partial/partial.rb

@@ -7,24 +7,32 @@ 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.
+    # content that isn't the main body, e.g. a card footer. A slot can also
+    # carry props: structured data the partial reads back with #props_for.
     class Partial
       def initialize(view_context)
         @view_context = view_context
         @contents = Hash.new { |h, k| h[k] = ActiveSupport::SafeBuffer.new }
+        @props = {}
       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
+      # Write a slot (string or block, with optional props), or read it back
+      # when called with nothing. Reading an unset slot returns nil.
+      def content_for(name, content = nil, **props, &block)
+        if content || block || props.any?
           content = @view_context.capture(&block) if block
           @contents[name] << content.to_s
+          (@props[name] ||= {}).merge!(props) if props.any?
           nil
         else
           @contents[name].presence
         end
       end
+
+      # Read the props attached to a slot, or an empty hash when none were set.
+      def props_for(name)
+        @props[name] || {}
+      end
     end
   end
 end

data/lib/unmagic/component_partial/version.rb

@@ -2,6 +2,6 @@
 
 module Unmagic
   module ComponentPartial
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unmagic-component-partial
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Keith Pitt