nice_partials 0.1.6 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a2bc1c656f72b37d7766bd5353a4320fc516dd2bfa808352f8b96217991c78b
-  data.tar.gz: fefb7742857fec22b402f714ce10e5d4e6b33279b3fe7abdb84b1408b31cb38c
+  metadata.gz: b3b70755595cff02588aa600004e44ec9f20847a4fdd026e0326876a2cad7f52
+  data.tar.gz: 24e42267606eb6a56ed481d2b82d137210618dff3282f6586036aa68bfad71c0
 SHA512:
-  metadata.gz: 40b811eb0e0231da0ed04d023af718200400880dffac5e64cb8f8c80de2f30ae187fb0e4c43235d305f1a60e74c321b370c4ff6d07a18fc975becea8c5faa975
-  data.tar.gz: 9ae278eb935fc27bb1f7ae46bb71efcdbf84d3ef0157e0897f4412208a1c8864251a8f8cec5ea9961d01c1884f451b6695c2a8862d2456c4f7ee2698a124362a
+  metadata.gz: de339636e922f606a268eb0a9888686e3f0c6b3bdd0f874c8c50998a55437dfc8dff7f4a1c4293d4814277f75a49a959aa47ba9318ad9d9898d651c87d5fc6f8
+  data.tar.gz: ed7d3ff442df563d12aba16982a7a3ecae8a5f5b3022255e733bd2b5fd816c828064ddb659162839ef234fc26b22bd3f3a3a6be175e918a5518688a5cfe8bde2

data/CHANGELOG.md

@@ -1,9 +1,221 @@
 ## CHANGELOG
 
+* Fix rendering with special characters in a view path.
+
+  Ref: https://github.com/bullet-train-co/nice_partials/pull/70
+
+* Seed Nice Partials content from `local_assigns`
+
+  Previously, the only way to assign content to a Nice Partial was through passing a block:
+
+  ```erb
+  # app/views/posts/show.html.erb
+  <%= render "posts/post", byline: "Some guy" %>
+
+  # app/views/posts/_post.html.erb
+  <%= render "card" do |partial| %>
+    <% partial.title "Hello there" %>
+    <% partial.byline byline %> <%# `byline` comes from the outer `render` call above. %>
+  <% end %>
+
+  Now, Nice Partials will automatically use Rails' `local_assigns`, which contain any `locals:` passed to `render`, as the seed for content. So this works:
+
+  ```erb
+  <%= render "card", title: "Hello there", byline: byline %>
+  ```
+
+  And the `card` partial is now oblivious to whether its `title` or `byline` were passed as render `locals:` or through the usual assignments in a block.
+
+  ```erb
+  # app/views/_card.html.erb
+  <%= partial.title %> written by <%= partial.byline %>
+  ```
+
+  Previously to get this behavior you'd need to write:
+
+  ```erb
+  # app/views/_card.html.erb
+  <%= partial.title.presence || local_assigns[:title] %> written by <%= partial.byline.presence || local_assigns[:byline] %>
+  ```
+
+  Passing extra content via a block appends:
+
+  ```erb
+  <%= render "card", title: "Hello there" do |partial| %>
+    <% partial.title ", and welcome!" %> # Calling `partial.title` outputs `"Hello there, and welcome!"`
+  <% end %>
+  ```
+
+* Add `NicePartials::Partial#slice`
+
+  Returns a Hash of the passed keys with their contents, useful for passing to other render calls:
+
+  ```erb
+  <%= render "card", partial.slice(:title, :byline) %>
+  ```
+
+* Fix `partial.helpers` accidentally adding methods to `ActionView::Base`
+
+  When using `partial.helpers {}`, internally `class_eval` would be called on the Partial instance, and through `delegate_missing_to` passed on to the view context and thus we'd effectively have a global method, exactly as if we'd just used regular Rails view helpers.
+
+* Let partials respond to named content sections
+
+  ```erb
+  <% partial.content_for :title, "Title content" %> # Before
+  <% partial.title "Title content" %> # After
+
+  # Which can then be output
+  <% partial.title %> # => "Title content"
+  <% partial.title? %> # => true
+  ```
+
+  Note, `title` responds to `present?` so rendering could also be made conditional with:
+
+  ```erb
+  <% partial.title if partial.title? %> # Instead of this…
+  <% partial.title.presence %> # …you can do this
+  ```
+
+  #### Passing procs or components
+
+  Procs and objects that implement `render_in`, like ViewComponents, can also be appended as content:
+
+  ```erb
+  <% partial.title { "some content" } %>
+  <% partial.title TitleComponent.new(Current.user) %>
+  ```
+
+  #### Capturing `options`
+
+  Options can also be captured and output:
+
+  ```erb
+  <% partial.title class: "text-m4" %> # partial.title.options # => { class: "text-m4" }
+
+  # When output `to_s` is called and options automatically pipe through `tag.attributes`:
+  <h1 <% partial.title.options %>> # => <h1 class="text-m4">
+  ```
+
+  #### Proxying to the view context and appending content
+
+  A content section appends to its content when calling any view context method on it, e.g.:
+
+  ```erb
+  <% partial.title.t ".title" %>
+  <% partial.title.link_to @document.name, @document %>
+  <% partial.title.render "title", user: Current.user %>
+  <% partial.title.render TitleComponent.new(Current.user) do |component| %>
+    <% … %>
+  <% end %>
+  ```
+
+  #### Building elements with `tag` proxy
+
+  These `tag` calls let you generate elements based on the stored content and options:
+
+  ```erb
+  <% partial.title "content", class: "post-title" %> # Adding some content and options…
+  <% partial.title.h2 %> # => <h2 class="post-title">content</h2>
+  <% partial.title.h2 "more" %> # => <h2 class="post-title">contentmore</h2>
+  ```
+
+* Add `NicePartials#t` to aid I18n.
+
+  When using NicePartials with I18n you end up with lots of calls that look like:
+
+  ```erb
+  <% partial.title       t(".title") %>
+  <% partial.description t(".header") %>
+  <% partial.byline      t("custom.key") %>
+  ```
+
+  With NicePartials' `t` method, you can write the above as:
+
+  ```erb
+  <% partial.t :title, description: :header, byline: "custom.key" %>
+  ```
+
+  Clarifying what keys get converted to what content sections on the partial rather than the syntax heavy `partial.… t(".…")`.
+
+  Like the Rails built-in `t` method, it's just a shorthand alias for `translate` so that's available too.
+
+* Add `Partial#content_from`
+
+  `content_from` lets a partial extract contents from another partial.
+  Additionally, contents can be renamed by passing a hash:
+
+  ```erb
+  <% partial.title "Hello there" %>
+  <% partial.byline "Somebody" %>
+
+  <%= render "shared/title" do |cp| %>
+    # Here the inner partial `cp` accesses the outer partial through `partial`
+    # extracting the `title` and `byline` contents.
+    # `byline` is renamed to `name` in `cp`.
+    <% cp.content_from partial, :title, byline: :name %>
+  <% end %>
+  ```
+
+### 0.1.9
+
+* Remove need to insert `<% yield p = np %>` in partials.
+
+  Nice Partials now automatically captures blocks passed to `render`.
+  Instead of `p`, a `partial` method has been added to access the
+  current `NicePartials::Partial` object.
+
+  Here's a script to help update your view code:
+
+  ```ruby
+  files_to_inspect = []
+
+  Dir["app/views/**/*.html.erb"].each do |path|
+    if contents = File.read(path).match(/(<%=? yield\(?.*? = np\)? %>\n+)/m)&.post_match
+      files_to_inspect << path if contents.match?(/render.*?do \|/)
+
+      contents.gsub! /\bp\.(?=yield|helpers|content_for|content_for\?)/, "partial."
+      File.write path, contents
+    end
+  end
+
+  if files_to_inspect.any?
+    puts "These files had render calls with a block parameter and likely require some manual edits:"
+    puts files_to_inspect
+  else
+    puts "No files with render calls with a block parameter found, you're likely all set"
+  end
+  ```
+
+* Support manual `yield`s in partials.
+
+  Due to the automatic yield support above, support has also been added for manual `yield some_object` calls.
+
+  Nice Partials automatically appends the `partial` to the yielded arguments, so you can
+  change `render … do |some_object|` to `render … do |some_object, partial|`.
+
+* Deprecate `p` as the partial object access. Use `partial` instead.
+
+* Expose `partial.yield` to access the captured output buffer.
+
+  Lets you access what a `<%= yield %>` call returned, like this:
+
+  ```erb
+  <%= render "card" do %>
+    This is the content of the internal output buffer
+  <% end %>
+  ```
+
+  ```erb
+  # app/views/cards/_card.html.erb
+  # This can be replaced with `partial.yield`.
+  <%= yield %> # Will output "This is the content of the internal output buffer"
+  ```
+
+### 0.1.7
+
 * Rely on `ActiveSupport.on_load :action_view`
 * Add support for Ruby 3.0
 
 ### 0.1.0
 
 * Initial release
-

data/Gemfile

@@ -1,7 +1,17 @@
 source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
 gem "minitest"
 gem "rake"
 gem "irb"
+
+if ENV["RAILS_MAIN"]
+  gem "rails", github: "rails/rails", branch: "main"
+else
+  gem "rails"
+end
+
+gem "view_component"
+gem "capybara"

data/README.md

@@ -1,136 +1,254 @@
-# nice_partials [![[version]](https://badge.fury.io/rb/nice_partials.svg)](https://badge.fury.io/rb/nice_partials)  [![[travis]](https://travis-ci.org/andrewculver/nice_partials.svg)](https://travis-ci.org/andrewculver/nice_partials)
+# nice_partials [![[version]](https://badge.fury.io/rb/nice_partials.svg)](https://badge.fury.io/rb/nice_partials)
 
-Nice Partials extends the concept of [`content_for` blocks and `yield`](https://guides.rubyonrails.org/layouts_and_rendering.html#using-the-content-for-method) for those times when a partial needs to provide one or more named "content areas" or "slots". This thin, optional layer of magic helps make traditional Rails view partials an even better fit for extracting components from your views, like so:
+Nice Partials adds ad-hoc named content areas, or sections, to Action View partials with a lot of extra power on top.
+
+Everything happens through a new `partial` method, which at the base of it have method shorthands for partial specific `content_for` and `content_for?`s.
+
+See, here we're outputting the `image`, `title`, and `body` sections:
 
 `app/views/components/_card.html.erb`:
 ```html+erb
 <div class="card">
-  <%= p.yield :image %>
+  <%= partial.image %> # Same as `partial.content_for :image`
   <div class="card-body">
-    <h5 class="card-title"><%= title %></h5>
-    <% if p.content_for? :body %>
+    <h5 class="card-title"><%= partial.title %></h5>
+    <% if partial.body? %>
       <p class="card-text">
-        <%= p.yield :body %>
+        <%= partial.body %>
       </p>
     <% end %>
   </div>
 </div>
 ```
 
-These partials can still be utilized with a standard `render` call, but you can specify how to populate the content areas like so:
+Then in `render` we populate them:
 
 ```html+erb
-<%= render 'components/card', title: 'Some Title' do |p| %>
-  <% p.content_for :body do %>
-    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
-    tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
-    <strong>quis nostrud exercitation ullamco laboris</strong> nisi ut aliquip
-    ex ea commodo consequat.
+<%= render "components/card", title: "Some Title" do |partial| %>
+  <% partial.title t(".title") %> # Same as `partial.content_for :title, t(".title")`
+
+  <% partial.body do %>
+    Lorem ipsum dolor sit amet, …
   <% end %>
 
-  <% p.content_for :image do %>
-    <%= image_tag image_path('example.jpg'), alt: 'An example image' %>
+  <% partial.image do %>
+    <%= image_tag image_path("example.jpg"), alt: "An example image" %>
   <% end %>
 <% end %>
 ```
 
-Nice Partials is a lightweight and hopefully more Rails-native alternative to [ViewComponent](http://viewcomponent.org). It aims to provide many of the same benefits as ViewComponent while requiring less ceremony. This specific approach originated with [Bullet Train](https://bullettrain.co)'s "Field Partials" and was later reimagined and completely reimplemented by Dom Christie.
+So far these uses are pretty similar to Rails' global `content_for` & `content_for?`, except these sections are local to the specific partial, so there's no clashing or leaking.
 
+### More-in depth compared to regular Rails partials
 
-## Sponsored By
+Consider this regular Rails partials rendering:
 
-<a href="https://bullettrain.co" target="_blank">
-  <img src="https://github.com/CanCanCommunity/cancancan/raw/develop/logo/bullet_train.png" alt="Bullet Train" width="400"/>
-</a>
-<br/>
-<br/>
+```html+erb
+<%= render "components/card" do %>
+  <% content_for :title, "Title content" %>
+<% end %>
 
-> Would you like to support Nice Partials development and have your logo featured here? [Reach out!](http://twitter.com/andrewculver)
+# app/views/components/_card.html.erb
+<%= yield :title %>
+<%= yield %>
+```
+
+There's a number of gotchas here:
 
+- The `content_for` writes to `:title` across every partial, thus leaking.
+- The rendering block isn't called until `<%= yield %>` is, so the `content_for` isn't called and `<%= yield :title %>` outputs nothing.
 
-## Benefits of Nice Partials
+With Nice Partials the yield is automatic and we can write content for just that partial without leaking:
+
+```html+erb
+<%= render "components/card" do |partial| %>
+  <% partial.title "Title content" %>
+<% end %>
+
+# app/views/components/_card.html.erb
+<%= partial.title %>
+```
+
+This happens because Nice Partials checks the partial source code for any `yield` calls that calls Rails' `capture` helper — e.g. `yield` and `yield something` but not `yield :title`. If there's no capturing yields Nice Partials calls `capture` for you.
+
+This means Nice Partials also respect existing yield calls in your partial, so you can upgrade existing partials bit by bit or not at all if you don't want to.
 
 Nice Partials:
 
- - is just regular Rails view partials like you're used to.
- - reduces the friction when extracting components.
- - only ends up in the specific partials you need its functionality in.
- - reduces context switching.
- - allows isolated helper logic alongside your partial view code.
- - doesn't require any upgrades to existing partials for interoperability.
- - are still testable!
+  - are still regular Rails view partials.
+  - reduces the friction when extracting components.
+  - only ends up in the specific partials you need the functionality.
+  - reduces context switching.
+  - allows isolated helper logic alongside your partial view code.
+  - doesn't require any upgrades to existing partials for interoperability.
+  - are still testable!
 
+Nice Partials are a lightweight and more Rails-native alternative to [ViewComponent](http://viewcomponent.org). Providing many of the same benefits as ViewComponent with less ceremony.
 
-## Can't I do the same thing without Nice Partials?
+## What extra powers does `partial` give me?
 
-You can almost accomplish the same thing without Nice Partials, but in practice you end up having to flush the content buffers after using them, leading to something like this:
+Having a `partial` object lets us add abstractions that are hard to replicate in standard Rails partials.
+
+### Passing content from the render call
+
+Nice Partials will use Action View's `local_assigns`, which stores any `locals` passed to `render`, as the basis for contents.
+
+Given a partial like
 
 ```html+erb
-<div class="card">
-  <%= yield :image %>
-  <% content_for :image, flush: true do '' end %>
-  <div class="card-body">
-    <h5 class="card-title"><%= title %></h5>
-    <% if content_for? :body %>
-      <p class="card-text">
-        <%= yield :body %>
-        <% content_for :body, flush: true do '' end %>
-      </p>
-    <% end %>
-  </div>
-</div>
+<%# app/views/components/_card.html.erb %>
+<%= partial.title %> written by <%= partial.byline %>
 ```
 
-Earlier iterations of Nice Partials aimed to simply clean up this syntax with helper methods like `flush_content_for`, but because the named content buffers were in a global namespace, it was also possible to accidentally create situations where two partials with a `:body` content area would end up interfering with each other, depending on the order they're nested and rendered.
+Can then be used like this:
 
-Nice Partials resolves the last-mile issues with standard view partials and content buffers by introducing a small, generic object that helps transparently namespace your named content buffers. This same object can also be used to define helper methods specific to your partial that are isolated from the global helper namespace.
+```html+erb
+<%= render "components/card", title: "Hello there", byline: "Some guy" do |partial| %>
+  <% partial.byline ", who writes stuff" %>
+<% end %>
+```
 
+This will then output "Hello there written by Some guy, who writes stuff"
 
-## Setup
+You can also use `slice` to pass on content from an outer partial:
 
-Add to your `Gemfile`:
+```html+erb
+<%= render "components/card", partial.slice(:title, :byline) %>
+```
 
-```ruby
-gem "nice_partials"
+### Appending content from the view into a section
+
+Nice Partials supports calling any method on `ActionView::Base`, like the helpers shown here, and then have them auto-append to the section.
+
+```html+erb
+<%= render "components/card" do |partial| %>
+  <% partial.title.t ".title" %>
+  <% partial.body.render "form", tangible_thing: @tangible_thing %>
+  <% partial.image.image_tag image_path("example.jpg"), alt: "An example image" %>
+<% end %>
+```
+
+### I18n: translating and setting multiple keys at a time
+
+`partial.t` is a shorthand to translate and assign multiple keys at once:
+
+```html+erb
+<% partial.t :title, description: :header, byline: "custom.key" %>
+
+# The above is the same as writing:
+<% partial.title t(".title") %>
+<% partial.description t(".header") %>
+<% partial.byline t("custom.key") %>
+```
+
+### Capturing options in the rendering block and building HTML tags in the partial
+
+You can pass keyword options to a writer method and they'll be auto-added to `partial.x.options`, like so:
+
+```html+erb
+<%= render "components/card" do |partial| %>
+  <% partial.title "Title content", class: "text-m4", data: { controller: "title" } %>
+<% end %>
+
+# app/views/components/_card.html.erb:
+# From the render above `title.options` now contain `{ class: "text-m4", data: { controller: "title" } }`.
+# The options can be output via `<%=` and are automatically run through `tag.attributes` to be converted to HTML attributes.
+
+<h1 <%= partial.title.options %>><%= partial.title %></h1> # => <h1 class="text-m4" data-controller="title">Title content</h1>
+```
+
+`partial` also supports auto-generating an element by calling any of Rails' `tag` methods e.g.:
+
+```html+erb
+# This shorthand gets us the same h1 element from the previous example:
+<%= partial.title.h1 %> # => <h1 class="text-m4" data-controller="title">Title content</h1>
+
+# Internally, this is similar to doing:
+<%= tag.h1 partial.title.to_s, partial.title.options %>
 ```
 
-## Usage
+### Yielding tag builders into the rendering block
 
-### When to use Nice Partials
+The above example showed sending options from the rendering block into the partial and having it construct elements.
 
-You only need to use Nice Partials when:
+But the partial can also prepare tag builders that the rendering block can then extend and finalize:
 
- - you want to define one or more named content areas in your partial. If you don't have multiple named content areas in your partial, you could just pass your content into the partial using the standard block and `yield` approach.
+```html+erb
+<% render "components/card" do |partial|
+  <% partial.title { |tag| tag.h1 "Title content" } %>
+<% end %>
 
- - you want to specifically isolate your helper methods for a specific partial.
+# app/views/components/_card.html.erb
+<% partial.title.yield tag.with_options(class: "text-m4", data: { controller: "title" }) %> # => <h1 class="text-m4" data-controller="title">Title content</h1>
+```
 
-### Use Nice Partials in a partial
+### Smoother conditional rendering
 
-To invoke nice partials, start your partial file with the following:
+In regular Rails partials it's common to see `content_for?` used to conditionally rendering something. With Nice Partials we can do this:
 
 ```html+erb
-<% yield p = np %>
+<% if partial.title? %>
+  <% partial.title.h1 %>
+<% end %>
 ```
 
-Here's what is happening here:
+But since sections respond to and leverage `present?`, we can shorten the above to:
 
-  - `yield` executes the block we receive when someone uses our partial.
-  - `np` fetches an instance of the generic class that helps isolate our content buffers and helper methods.
-  - `p = np` ensures we have a reference to that object in this partial.
-  - `yield p = np` ensures the developer using this partial also has a reference to that object, so they can define what goes in the various content buffers.
+```html+erb
+<% partial.title.presence&.h1 %>
+```
 
-(This is, [as far as we know](https://github.com/bullet-train-co/nice_partials/issues/1), the minimum viable invocation.)
+This way no empty h1 element is rendered.
 
-Once you've done this at the top of your partial file, you can then use `<%= p.yield :some_section %>` to render whatever content areas you want to be passed into your partial.
+### Accessing the content returned via `partial.yield`
 
+To access the inner content lines in the block here, partials have to manually insert a `<%= yield %>` call.
 
-### Defining and using well isolated helper methods
+```html+erb
+<%= render "components/card" do %>
+  Some content!
+  Yet more content!
+<% end %>
+```
+
+With Nice Partials, `partial.yield` returns the same content:
+
+```html+erb
+# app/views/components/_card.html.erb
+<%= partial.yield %> # => "Some content!\n\nYet more content!"
+```
+
+### Referring to the outer partial while rendering another
+
+During a rendering block `partial` refers to the outer partial, so you can compose them.
+
+```html+erb
+<% partial.title "Title content" %>
+
+<%= render "components/card" do |cp| %>
+  <% cp.title partial.title %>
+<% end %>
+```
 
-To minimize the amount of pollution in the global helper namespace, you can use the shared context object to define helper methods specifically for your partials _within your partial_ like so:
+### Passing content from one partial to the next
+
+If you need to pass content into another partial, `content_from` lets you pass the keys to extract and then a hash to rename keys.
 
 ```html+erb
-<% p.helpers do
+<%= render "components/card" do |cp| %>
+  <% cp.content_from partial, :title, byline: :header %>
+<% end %>
+```
+
+Here, we copied the `partial.title` to `cp.title` and `partial.byline` became `cp.header`.
+
+### Defining and using well isolated helper methods
+
+If you want to have helper methods that are available only within your partials, you can call `partial.helpers` directly:
 
+```html+erb
+# app/views/components/_card.html.erb
+<% partial.helpers do
   # references should be a link if the user can drill down, otherwise just a text label.
   def reference_to(user)
     # look! this method has access to the scope of the entire view context and all the other helpers that come with it!
@@ -140,17 +258,30 @@ To minimize the amount of pollution in the global helper namespace, you can use
       object.name
     end
   end
-
 end %>
+
+# Later in the partial we can use the method:
+<td><%= partial.reference_to(user) %></td>
 ```
 
-Then later in the partial you can use the helper method like so:
+## Sponsored By
+
+<a href="https://bullettrain.co" target="_blank">
+  <img src="https://github.com/CanCanCommunity/cancancan/raw/develop/logo/bullet_train.png" alt="Bullet Train" width="400"/>
+</a>
+<br/>
+<br/>
+
+> Would you like to support Nice Partials development and have your logo featured here? [Reach out!](http://twitter.com/andrewculver)
 
-```html+erb
-<td><%= p.reference_to(user) %></td>
-```
 
-## Development
+## Setup
+
+Add to your `Gemfile`:
+
+```ruby
+gem "nice_partials"
+```
 
 ### Testing
 
@@ -160,4 +291,4 @@ bundle exec rake test
 
 ## MIT License
 
-Copyright (C) 2020 Andrew Culver <https://bullettrain.co> and Dom Christie <https://domchristie.co.uk>. Released under the MIT license.
+Copyright (C) 2022 Andrew Culver <https://bullettrain.co> and Dom Christie <https://domchristie.co.uk>. Released under the MIT license.

data/Rakefile

@@ -1,6 +1,8 @@
 # # #
 # Get gemspec info
 
+require "bundler/gem_tasks"
+
 gemspec_file = Dir["*.gemspec"].first
 gemspec = eval File.read(gemspec_file), binding, gemspec_file
 info = "#{gemspec.name} | #{gemspec.version} | " \
@@ -26,12 +28,3 @@ desc "#{gemspec.name} | IRB"
 task :irb do
   sh "irb -I ./lib -r #{gemspec.name.gsub '-','/'}"
 end
-
-# # #
-# Run specs
-
-desc "#{gemspec.name} | Test"
-task :test do
-  sh "for file in test/*_test.rb; do ruby $file; done"
-end
-task default: :test