nice_partials 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80f4ce71d7a0d70adfd7f7c6775178df6705bd74fc520d7d81e1f28ab2b4b831
-  data.tar.gz: 37bfd17903477aad2e7cdfc2a0eb8a42a36749851e445be88c1172a013b58fba
+  metadata.gz: 3275a33c9f1de9e8267042ab36b485297451804bb1c704082576890d800a20cd
+  data.tar.gz: 7b55dd85d2d291eb411b564819c602e039dc412ec8cbb82df7b58f8472d062e4
 SHA512:
-  metadata.gz: 44aeee28bb6aaa22fcb7f3021c49142d6c463ab7f72e083a73c0f0465a7dd96296e5a13271ea74e711ae4905d2f7deadfe89e1b12886c5af6332a3d75b8ce595
-  data.tar.gz: 90262c8cb7eafae7d7f0b88b4a36ac2e4e41acd1d3e78957e4a6016136b4f788de9d0cd274480774f0f63e9a81cc43e8b040ac980ce91bc0b343dfcd417387e2
+  metadata.gz: ef49218a25d20bb8b0446b5b0dd975fb173191ea1e236e9dfa6a700fec717ef9b24f8f06fcc114b4e1e731ddf62aed143cd225193cd6ebc64acb4fd06edb0e3b
+  data.tar.gz: 52e0f030102269996e35132ad2ff16bcb94100faca76787b13059a31450c0d65456961b71bf69d2610f46bb8f48a9b410f4a01090c96f946d2d5b1ec6ece9b8c

data/.travis.yml

@@ -2,6 +2,7 @@ sudo: false
 language: ruby
 
 rvm:
+- 3.0
 - 2.7
 - 2.6
 - 2.5

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## CHANGELOG
 
+* Rely on `ActiveSupport.on_load :action_view`
+* Add support for Ruby 3.0
+
 ### 0.1.0
 
 * Initial release

data/README.md

@@ -1,6 +1,89 @@
 # 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)
 
-TODO
+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:
+
+`app/views/components/_card.html.erb`:
+```html+erb
+<div class="card">
+  <%= p.yield :image %>
+  <div class="card-body">
+    <h5 class="card-title"><%= title %></h5>
+    <% if p.content_for? :body %>
+      <p class="card-text">
+        <%= p.yield :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:
+
+```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.
+  <% end %>
+
+  <% p.content_for :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.
+
+
+## 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)
+
+
+## Benefits of Nice Partials
+
+Compared to something more heavy-handed, 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!
+
+
+## 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">
+  <%= 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>
+```
+
+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.
+
+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.
 
 
 ## Setup
@@ -11,12 +94,61 @@ Add to your `Gemfile`:
 gem "nice_partials"
 ```
 
-
 ## Usage
 
-```ruby
+### When to use Nice Partials
+
+You only need to use Nice Partials when:
+
+ - 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.
+
+ - 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.
+
+
+### 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.
+  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
+      object.name
+    end
+  end
+
+end %>
+```
+
+Then later in the partial you can use the helper method like so:
+
+```html+erb
+<td><%= p.reference_to(user) %></td>
+```
 
 ## MIT License
 

data/lib/nice_partials/helper.rb

@@ -1,23 +1,25 @@
+require_relative "partial"
+
 module NicePartials::Helper
   def np
-    # self in this context is the context of the view partial we're being called from.
-    DecoratedViewContext.new(self)
+    NicePartials::Partial.new(self)
   end
 
-  private
-  class DecoratedViewContext
-    def initialize(view_context)
-      @view_context = view_context
-      @key = SecureRandom.uuid
-    end
+  def nice_partials_push_t_prefix(prefix)
+    @_nice_partials_t_prefixes ||= []
+    @_nice_partials_t_prefixes << prefix
+  end
 
-    def yield(name = nil)
-      raise "You can only use Nice Partial's yield method to retrieve the content of named content area blocks. If you're not trying to fetch the content of a named content area block, you don't need Nice Partials! You can just call the vanilla Rails `yield`." unless name
-      content_for(name)
-    end
+  def nice_partials_pop_t_prefix
+    @_nice_partials_t_prefixes ||= []
+    @_nice_partials_t_prefixes.pop
+  end
 
-    def content_for(name, content = nil, options = {}, &block)
-      @view_context.content_for("#{name}_#{@key}".to_sym, content, options, &block)
+  def t(key, options = {})
+    if @_nice_partials_t_prefixes&.any? && key.first == '.'
+      key = "#{@_nice_partials_t_prefixes.last}#{key}"
     end
+
+    super(key, options)
   end
 end

data/lib/nice_partials/monkey_patch.rb

@@ -0,0 +1,23 @@
+# Monkey patch required to make `t` work as expected. Is this evil?
+# TODO Do we need to monkey patch other types of renderers as well?
+class ActionView::PartialRenderer
+  alias_method :original_render, :render
+
+  # See `content_for` in `lib/nice_partials/partial.rb` for something similar.
+  def render(partial, context, block)
+    if block
+      partial_prefix = nice_partials_locale_prefix_from_view_context_and_block(context, block)
+      context.nice_partials_push_t_prefix partial_prefix
+    else
+      # Render partial calls with no block should disable any prefix magic.
+      context.nice_partials_push_t_prefix ''
+    end
+
+    result = original_render(partial, context, block)
+
+    # Whether there was a block or not, pop off whatever we put on the stack.
+    context.nice_partials_pop_t_prefix
+
+    return result
+  end
+end

data/lib/nice_partials/partial.rb

@@ -0,0 +1,39 @@
+module NicePartials
+  class Partial
+    delegate_missing_to :@view_context
+
+    def initialize(view_context)
+      @view_context = view_context
+      @key = SecureRandom.uuid
+    end
+
+    def yield(name = nil)
+      raise "You can only use Nice Partial's yield method to retrieve the content of named content area blocks. If you're not trying to fetch the content of a named content area block, you don't need Nice Partials! You can just call the vanilla Rails `yield`." unless name
+      content_for(name)
+    end
+
+    def helpers(&block)
+      class_eval &block
+    end
+
+    # See the `ActionView::PartialRenderer` monkey patch in `lib/nice_partials/monkey_patch.rb` for something similar.
+    def content_for(name, content = nil, options = {}, &block)
+      if block_given?
+        partial_prefix = nice_partials_locale_prefix_from_view_context_and_block(@view_context, block)
+        @view_context.nice_partials_push_t_prefix(partial_prefix)
+      end
+
+      result = @view_context.content_for("#{name}_#{@key}".to_sym, content, options, &block)
+
+      if block_given?
+        @view_context.nice_partials_pop_t_prefix
+      end
+
+      return result
+    end
+
+    def content_for?(name)
+      @view_context.content_for?("#{name}_#{@key}".to_sym)
+    end
+  end
+end

data/lib/nice_partials/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
 module NicePartials
-  VERSION = "0.1.0"
+  VERSION = "0.1.4"
 end
-

data/lib/nice_partials.rb

@@ -2,8 +2,20 @@
 
 require_relative "nice_partials/version"
 require_relative "nice_partials/helper"
+require_relative "nice_partials/monkey_patch"
+require_relative "partials"
 
 module NicePartials
 end
 
-ActionView::Base.send :include, NicePartials::Helper
+# TODO Is there somewhere better we can put this?
+def nice_partials_locale_prefix_from_view_context_and_block(context, block)
+  root_paths = context.view_renderer.lookup_context.view_paths.map(&:path)
+  partial_location = block.source_location.first.dup
+  root_paths.each { |path| partial_location.gsub!(/^#{path}\//, '') }
+  partial_location.split('.').first.gsub('/_', '/').gsub('/', '.')
+end
+
+ActiveSupport.on_load :action_view do
+  include NicePartials::Helper
+end

data/lib/partials.rb

@@ -0,0 +1,2 @@
+module Partials
+end

data/nice_partials.gemspec

@@ -17,5 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = "~> 2.0"
+  gem.required_ruby_version = ">= 2.0"
+
+  gem.add_dependency "actionview", '>= 4.2.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nice_partials
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Andrew Culver
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
-dependencies: []
+date: 2021-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
 description: A little bit of magic to make partials perfect for components.
 email:
 - andrew.culver@gmail.com
@@ -29,7 +43,10 @@ files:
 - Rakefile
 - lib/nice_partials.rb
 - lib/nice_partials/helper.rb
+- lib/nice_partials/monkey_patch.rb
+- lib/nice_partials/partial.rb
 - lib/nice_partials/version.rb
+- lib/partials.rb
 - nice_partials.gemspec
 - spec/nice_partials_spec.rb
 homepage: https://github.com/bullet-train-co/nice_partials
@@ -42,7 +59,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -51,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A little bit of magic to make partials perfect for components.