nice_partials 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0a121209bad4d81ba1702d9b34f908e90da58b27f224d78714129654a2b4a94
-  data.tar.gz: ee098d947c35bcf4cdb29d5aeb123856d6df88970686c310290c056d30502fc8
+  metadata.gz: af46913e68f4ca3d87579e5491ce53f040f11878d4671df03cfd7fc89723b66d
+  data.tar.gz: 1b4938352c280f79aed63af5caea1899737d4b8f8961e13cf0013c1790aeb88d
 SHA512:
-  metadata.gz: 3f22e3ff0b5e24645c4f91025a02b08c2d3b018877caec5203d501483242f654364038d8f3fd7913cda2b5bceb6dc180d4d8846bd242999799146c3a68a3e37f
-  data.tar.gz: 026a3b89e7471b8e45765abbe78ec9a86b62311a9f145bd740d046be80cb1236ee1363a7e9c662008394124c4b31db1a0c39d3ecfa0c9fdf6674315b4cf9bcbc
+  metadata.gz: 966d51762add5e871895c3eca4b8860fe3aff73a35e144095566b996ec7763a9df34e419cc4a1aa2d97078f3411e9ac0aeb6ac3da0c24f3b38db4ba08b6a5a2d
+  data.tar.gz: 2fedb3928eaa838b754d6bb7fe84638e0588a6dab2574200ad49c810bad1bbf360b872e535b5d62516ee02e468adfe801b6e90c136d899d8792cab18eb5b8ac5

data/README.md

@@ -1,18 +1,18 @@
 # 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 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:
 
-It allows your partials to define named content areas like this:
-
-`app/views/partials/_card.html.erb`:
+`app/views/components/_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>
+    <% if p.content_for? :body %>
+      <p class="card-text">
+        <%= p.yield :body %>
+      </p>
+    <% end %>
   </div>
 </div>
 ```
@@ -20,7 +20,7 @@ It allows your partials to define named content areas like this:
 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| %>
+<%= 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,
@@ -50,11 +50,7 @@ Compared to something more heavy-handed, Nice Partials:
  - are still testable!
 
 
-## How does it work?
-
-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.
-
-### Can't I do the same thing without Nice Partials?
+## 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:
 
@@ -64,10 +60,12 @@ You can almost accomplish the same thing without Nice Partials, but in practice
   <% content_for :image, flush: true do '' end %>
   <div class="card-body">
     <h5 class="card-title"><%= title %></h5>
-    <p class="card-text">
-      <%= yield :body %>
-      <% content_for :body, flush: true do '' end %>
-    </p>
+    <% if content_for? :body %>
+      <p class="card-text">
+        <%= yield :body %>
+        <% content_for :body, flush: true do '' end %>
+      </p>
+    <% end %>
   </div>
 </div>
 ```
@@ -91,7 +89,7 @@ gem "nice_partials"
 
 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 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.
 
@@ -115,7 +113,7 @@ Here's what is happening here:
 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
+### 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:
 

data/lib/nice_partials.rb

@@ -2,9 +2,18 @@
 
 require_relative "nice_partials/version"
 require_relative "nice_partials/helper"
+require_relative "nice_partials/monkey_patch"
 require_relative "partials"
 
 module NicePartials
 end
 
+# 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
+
 ActionView::Base.send :include, NicePartials::Helper

data/lib/nice_partials/helper.rb

@@ -4,4 +4,22 @@ module NicePartials::Helper
   def np
     NicePartials::Partial.new(self)
   end
+
+  def nice_partials_push_t_prefix(prefix)
+    @_nice_partials_t_prefixes ||= []
+    @_nice_partials_t_prefixes << prefix
+  end
+
+  def nice_partials_pop_t_prefix
+    @_nice_partials_t_prefixes ||= []
+    @_nice_partials_t_prefixes.pop
+  end
+
+  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

@@ -1,5 +1,7 @@
 module NicePartials
   class Partial
+    delegate_missing_to :@view_context
+
     def initialize(view_context)
       @view_context = view_context
       @key = SecureRandom.uuid
@@ -14,8 +16,20 @@ module NicePartials
       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)
-      @view_context.content_for("#{name}_#{@key}".to_sym, content, 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)

data/lib/nice_partials/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nice_partials
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Andrew Culver
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies: []
 description: A little bit of magic to make partials perfect for components.
 email:
@@ -29,6 +29,7 @@ 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
@@ -53,7 +54,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.