Add `content_from` to let partials relay contents #53

kaspth · 2022-08-21T18:23:38Z

Fixes #11

Sometimes there's a partial that'd like the named contents of another.

content_from lets a partial sift the content, and pass a hash to rename sections,
from the outer partial:

<% partial.content_for :title, "Hello there" %>
<% partial.content_for :byline, "Somebody" %>

<%= render "shared/title" do |cp| %>
  <% cp.content_from partial, :title, byline: :name %>
<% end %>

Sprung out of the discussion in #38, though I didn't feel the need to add parent tracking and flipped the call order, so the inner partial extracts from the outer and that feels clearer what context we're currently in.

lib/nice_partials/partial.rb

kaspth · 2022-08-22T17:26:56Z

Ok, got my naming concerns resolved and went with cp.content_from partial, :title, byline: :name.

If we're starting to layer on more complex behavior to Section and exposing them, it's nice to have an alternate implementation that's easier to maintain for our content_for inter-op with Rails.

@document

It's possible we may want a general method_missing hook that delegates to @view_context and concatenates the result and returns self for chaining. Would allow for something like this too: ```ruby <% partial.title.link_to(@document.name, @document) %> ```

This lets you generate different elements with overrides without appending to the content/options for the next invocation. Additionally, `tag#method_missing` responds to everything so we'll never reach super.

Various explicit nil returns were inserted to prevent things like <%= partial.title.t ".title" %> # <% %> should have been used here. But the more extensions we add the more we have to be careful of it, and it prevents other potentially interesting directions like chaining.

…and then we can expose `write`, with some potential for chaining.

Removes need for the old test task in the Rakefile.

When we fixed the view context stubbing, `capture` didn't just `yield` anymore but also processed the returned value as a string https://github.com/rails/rails/blob/06e9fbd954ab113108a7982357553fdef285bff1/actionview/lib/action_view/helpers/capture_helper.rb#L47 So our expectation that `partial.body { NameComponent.new(:plain) }` works, won't work in practice. But `partial.body { render NameComponent.new(:plain) }` is what's needed.

…if they want an object

Sometimes there's a partial that'd like the named contents of another. `content_from` lets a partial sift the content, and pass a hash to rename sections, from the outer partial: ```erb <% partial.title "Hello there" %> <% partial.byline "Somebody" %> <%= render "shared/title" do |cp| %> <% cp.content_from partial, :title, byline: :name %> <% end %> ```

* main: Introduce Capybara to the test suite (#55) Add `content_from` to let partials relay contents (#53)

* main: Ignore /tmp if you're running BT in tmp/starter like CI does Fix some CHANGELOG issues and refit some examples + words Skip needless CI steps (#60) We don't need to depend on sqlite3 that was for an earlier version of the ViewComponent integration Fix #54 to use new section yield syntax Mixing `yield` call styles (#54) Expose Sections as an alternative to `content_for` (#57) Introduce Capybara to the test suite (#55) Add `content_from` to let partials relay contents (#53) v0.1.9 v0.1.8 Document release 🎉 (#52) Rename `Partial#output_buffer` to `Partial#yield` (#41) Allow outer partial access when capturing (#49) Fix accessing `partial` before rendering leaks state (#47) Use load hooks for monkey_patch loading (#48)

This comment was marked as resolved.

Sign in to view

kaspth commented Aug 21, 2022

View reviewed changes

lib/nice_partials/partial.rb Outdated Show resolved Hide resolved

kaspth force-pushed the relay-partial-contents-with-extract-from branch 2 times, most recently from 5570e73 to 2c32681 Compare August 22, 2022 17:25

kaspth changed the title ~~Add extract_from to let partials relay contents~~ Add content_from to let partials relay contents Aug 22, 2022

kaspth force-pushed the relay-partial-contents-with-extract-from branch from 2c32681 to b6e25c2 Compare August 22, 2022 17:26

kaspth added this to the v1.0.0 milestone Aug 29, 2022

kaspth added 22 commits August 29, 2022 11:31

Expose Content object to separate content_for compatibility

24799d4

If we're starting to layer on more complex behavior to Section and exposing them, it's nice to have an alternate implementation that's easier to maintain for our content_for inter-op with Rails.

Defer creating contents Hash now that Section will be different storage

bc0a563

Make Section an extension of Content to simplify it for now

30cb32b

Reintroduce Sections as a new API (strip deferred contents for now)

b513668

Trial out reusing present? to indicate content

19f196c

Reintroduce deferred content blocks

25452c3

Rename internal call to process and simplify signature

49264cf

Write arguments by type and not position

81a7ae3

Expose sections through methods on the partial

8a7a3fb

Trial out write shorthand API

eebdce2

become the andthesis of syntax

e266598

Skip nils first so we spare the respond_to checks

338c3e4

These didn't turn out that different, let's slim 'em

7c327d3

Slightly nicer name

0e4420e

Hoist up the fact that we have to return nil for erroneous <%= %> calls

7d2863f

Expose store so write isn't public

272b0b7

Now write can be really simple again

19925f9

We don't have to support an endless variation of signatures

c7f11fd

Shorten concat since << returns the string and handles the truthy part

d4002d4

Inline store and reuse write as the API

dc85dc1

Allow a shorthand with just the block

af21fd8

kaspth added 11 commits August 31, 2022 08:17

Add a config point for AttributesAndTokenLists integration

1355d83

Extend tag proxy to append for the invocation only

da72a75

This lets you generate different elements with overrides without appending to the content/options for the next invocation. Additionally, `tag#method_missing` responds to everything so we'll never reach super.

Use our fancy lil t extension

43a9f74

Document proxying supports

cecb604

Use append since that's the internal API now over concat

224f07c

Add write? similar to Set#add?

fc174ac

…and then we can expose `write`, with some potential for chaining.

Simplify integration hook and just expect merge!/merge to work

b34d097

Pipe options.to_s through tag.attributes automatically

4591f01

Document all the goodies ✨

661755e

Note presence utility

c3a8d78

kaspth mentioned this pull request Sep 2, 2022

Expose Sections as an alternative to content_for #57

Merged

kaspth added 12 commits September 2, 2022 11:14

Make attributes_and_token_lists integration automatic

f268d59

Test with attributes_and_token_lists in the Gemfile

5b85215

Make testing with attributes_and_token_lists a comment/uncomment deal

f4c684e

Test with ViewComponent's render_in integration

1962c4b

Add nice bin/test from Rails plugins and use on CI

caa3cfc

Removes need for the old test task in the Rakefile.

Reuse our Test class so we don't have to stub the view context

d6f9d18

Flex an extra assertion just because it's cool that this works 😎

656fb39

content_for returns a String, have users use our section abstraction …

9d198a7

…if they want an object

Reuse defined accessors here

0bc65fd

Don't prevent accidental output, defer to users using ERB correctly

051647a

kaspth force-pushed the relay-partial-contents-with-extract-from branch from b6e25c2 to 051647a Compare September 5, 2022 07:43

andrewculver merged commit 693a58c into main Sep 5, 2022

kaspth added a commit that referenced this pull request Sep 5, 2022

Merge branch 'main' into expose-sections

ebbc206

* main: Introduce Capybara to the test suite (#55) Add `content_from` to let partials relay contents (#53)

kaspth deleted the relay-partial-contents-with-extract-from branch September 5, 2022 16:59

kaspth mentioned this pull request Sep 5, 2022

Rewrite the README #59

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `content_from` to let partials relay contents #53

Add `content_from` to let partials relay contents #53

kaspth commented Aug 21, 2022 •

edited

Loading

This comment was marked as resolved.

kaspth commented Aug 22, 2022

Add content_from to let partials relay contents #53

Add content_from to let partials relay contents #53

Conversation

kaspth commented Aug 21, 2022 • edited Loading

This comment was marked as resolved.

kaspth commented Aug 22, 2022

Add `content_from` to let partials relay contents #53

Add `content_from` to let partials relay contents #53

kaspth commented Aug 21, 2022 •

edited

Loading