nice_partials 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ace03ad5f6583df5b8545c3045f72c606a1cfbef879913633d9e2ef4f38a3fb0
-  data.tar.gz: e7284461cae24a294fb95b5517f0b639793e4802307903dea3a8014a9c1f6ebc
+  metadata.gz: d0a121209bad4d81ba1702d9b34f908e90da58b27f224d78714129654a2b4a94
+  data.tar.gz: ee098d947c35bcf4cdb29d5aeb123856d6df88970686c310290c056d30502fc8
 SHA512:
-  metadata.gz: 60b93b1de86b5031f2b91f7d9c2f9461bba4511ebf7a33fb6d6b6d7f32f07d49793b1e6aa55543013fb3fb2ad88a8e5d915797e25605609560b409b9786cb9e1
-  data.tar.gz: 93a6f1a3db7ed2221fdf0f343e612872c3dda91de4115210d67352fd216fd7eb404b9daa5c34ee398cc6c332b4f173c5d6803be07b8696e0df4250358340f28f
+  metadata.gz: 3f22e3ff0b5e24645c4f91025a02b08c2d3b018877caec5203d501483242f654364038d8f3fd7913cda2b5bceb6dc180d4d8846bd242999799146c3a68a3e37f
+  data.tar.gz: 026a3b89e7471b8e45765abbe78ec9a86b62311a9f145bd740d046be80cb1236ee1363a7e9c662008394124c4b31db1a0c39d3ecfa0c9fdf6674315b4cf9bcbc

data/README.md

@@ -1,82 +1,130 @@
 # 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 provides a light layer of magic on top of traditional Rails view partials to try and make them an even better fit for extracting and reusing components in your views. Nice Partials is specifically designed to be a lightweight and more Rails-native alternative to [ViewComponent](http://viewcomponent.org) that hopefully provides many of the same benefits while requiring less ceremony. This specific approach originated with [Bullet Train](https://bullettrain.co)'s "Field Partials" and was later reimagined and reimplemented by Dom Christie.
+Nice Partials provides a light layer of magic on top of traditional Rails view partials to try and make them an even better fit for extracting and reusing components in your views. 
 
+It allows your partials to define named content areas like this:
 
-## Benefits
+`app/views/partials/_card.html.erb`:
+```html+erb
+<div class="card">
+  <%= p.yield :image %>
+  <div class="card-body">
+    <h5 class="card-title"><%= title %></h5>
+    <p class="card-text">
+      <%= p.yield :body %>
+    </p>
+  </div>
+</div>
+```
 
- - They're just partials like you're used to, with a few extra features.
- - Less context switching. Your components are all just rendering in the standard view context.
- - You don't have to upgrade your existing partials. You can still nest them in a Nice Partials content area.
- - Less ceremony. You _can_ spin up a custom class to back your partial if you want to, but you don't have to by default, and we don't suggest it.
- - Instead, skip the component class entirely! You can define appropriately scoped helpers right inline with your partial.
- - It's still testable. There's no reason why these can't be as testable as ViewComponents.
+These partials can still be utilized with a standard `render` call, but you can specify how to populate the content areas like so:
 
+```html+erb
+<%= render 'partials/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.
+  <% end %>
 
-## Setup
+  <% p.content_for :image do %>
+    <%= image_tag image_path('example.jpg'), alt: 'An example image' %>
+  <% end %>
+<% end %>
+```
 
-Add to your `Gemfile`:
+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.
 
-```ruby
-gem "nice_partials"
-```
 
+## Benefits of Nice Partials
 
-## Usage
+Compared to something more heavy-handed, Nice Partials:
 
-### Defining a Nice Partial
+ - 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!
 
-We'll define an example Nice Partial in `app/views/partials/card`. We start by invoking Nice Partials like so:
 
-```
-<% yield p = np %>
-```
+## How does it work?
 
-We can explain what each thing is doing there later, but just trust us that it's the minimum viable invocation that we're aware of at the moment.
+Nice Partials slightly extends the concept of [`content_for` blocks and `yield`](https://guides.rubyonrails.org/layouts_and_rendering.html#using-the-content-for-method) so they can be properly used to define and utilize "content areas" or "slots" in simple ERB partials.
 
-After that, you can define your partial content and define your content areas:
+### Can't I do the same thing without Nice Partials?
 
-```
+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:
+
+```html+erb
 <div class="card">
-  <%= p.yield :image %>
+  <%= yield :image %>
+  <% content_for :image, flush: true do '' end %>
   <div class="card-body">
     <h5 class="card-title"><%= title %></h5>
     <p class="card-text">
-      <%= p.yield :body %>
+      <%= yield :body %>
+      <% content_for :body, flush: true do '' end %>
     </p>
   </div>
 </div>
 ```
 
-That's it!
+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.
 
-### Utilizing a Nice Partial
+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.
 
-To use a Nice Partial, just render it like you would any other partial, but also pass a block that accepts a parameter:
 
-```ruby
-<%= render 'partials/card', title: 'Some Title' do |p| %>
-  <% p.content_for :body %>
-    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.
-  <% end %>
+## Setup
 
-  <% p.content_for :image %>
-    <%= image_tag image_path('example.jpg'), alt: 'An example image' %>
-  <% end %>
-<% end %>
+Add to your `Gemfile`:
+
+```ruby
+gem "nice_partials"
 ```
 
-### Defining and Using Well Isolated Helper Methods
+## Usage
+
+### When to use Nice Partials
 
-To minimize the amount of pollution in the global helper namespace, you can define helper methods specifically for your partials _within your partial_ like so:
+You only need to use Nice Partials when:
 
+ - you want to define multiple 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.
+
+ - you want to specifically isolate your helper methods for a specific partial.
+
+### Use Nice Partials in a partial
+
+To invoke nice partials, start your partial file with the following:
+
+```html+erb
+<% yield p = np %>
 ```
+
+Here's what is happening here:
+
+  - `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.
+
+(This is, [as far as we know](https://github.com/bullet-train-co/nice_partials/issues/1), the minimum viable invocation.)
+
+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.
+
+
+### Extra Credit: Defining and Using Well Isolated Helper Methods
+
+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:
+
+```html+erb
 <% p.helpers do
 
   # references should be a link if the user can drill down, otherwise just a text label.
-  # (this method has access to the scope of the entire view context and all the other helpers that come with it.)
   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!
     if can? :show, user
       link_to user.name, user
     else
@@ -89,7 +137,7 @@ end %>
 
 Then later in the partial you can use the helper method like so:
 
-```
+```html+erb
 <td><%= p.reference_to(user) %></td>
 ```
 

data/lib/nice_partials/partial.rb

@@ -17,5 +17,9 @@ module NicePartials
     def content_for(name, content = nil, options = {}, &block)
       @view_context.content_for("#{name}_#{@key}".to_sym, content, options, &block)
     end
+
+    def content_for?(name)
+      @view_context.content_for?("#{name}_#{@key}".to_sym)
+    end
   end
 end

data/lib/nice_partials/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NicePartials
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nice_partials
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Culver