nice_partials 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0a121209bad4d81ba1702d9b34f908e90da58b27f224d78714129654a2b4a94
-  data.tar.gz: ee098d947c35bcf4cdb29d5aeb123856d6df88970686c310290c056d30502fc8
+  metadata.gz: 1a2bc1c656f72b37d7766bd5353a4320fc516dd2bfa808352f8b96217991c78b
+  data.tar.gz: fefb7742857fec22b402f714ce10e5d4e6b33279b3fe7abdb84b1408b31cb38c
 SHA512:
-  metadata.gz: 3f22e3ff0b5e24645c4f91025a02b08c2d3b018877caec5203d501483242f654364038d8f3fd7913cda2b5bceb6dc180d4d8846bd242999799146c3a68a3e37f
-  data.tar.gz: 026a3b89e7471b8e45765abbe78ec9a86b62311a9f145bd740d046be80cb1236ee1363a7e9c662008394124c4b31db1a0c39d3ecfa0c9fdf6674315b4cf9bcbc
+  metadata.gz: 40b811eb0e0231da0ed04d023af718200400880dffac5e64cb8f8c80de2f30ae187fb0e4c43235d305f1a60e74c321b370c4ff6d07a18fc975becea8c5faa975
+  data.tar.gz: 9ae278eb935fc27bb1f7ae46bb71efcdbf84d3ef0157e0897f4412208a1c8864251a8f8cec5ea9961d01c1884f451b6695c2a8862d2456c4f7ee2698a124362a

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 /pkg
+*~

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,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,
@@ -37,9 +37,20 @@ These partials can still be utilized with a standard `render` call, but you can
 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:
+Nice Partials:
 
  - is just regular Rails view partials like you're used to.
  - reduces the friction when extracting components.
@@ -50,11 +61,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 +71,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 +100,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 +124,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:
 
@@ -141,6 +150,14 @@ Then later in the partial you can use the helper method like so:
 <td><%= p.reference_to(user) %></td>
 ```
 
+## Development
+
+### Testing
+
+```sh
+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.

data/Rakefile

@@ -30,8 +30,8 @@ end
 # # #
 # Run specs
 
-desc "#{gemspec.name} | Spec"
-task :spec do
-  sh "for file in spec/*_spec.rb; do ruby $file; done"
+desc "#{gemspec.name} | Test"
+task :test do
+  sh "for file in test/*_test.rb; do ruby $file; done"
 end
-task default: :spec
+task default: :test

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,59 @@
+# 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
+
+    begin
+      result = original_render(partial, context, block)
+    rescue Exception => exception
+      # If there was some sort of exception thrown, we also need to pop the `t` prefix.
+      # This provides compatibility with other libraries that depend on catching exceptions from the view renderer.
+      context.nice_partials_pop_t_prefix
+      raise exception
+    end
+
+    # Whether there was a block or not, pop off whatever we put on the stack.
+    context.nice_partials_pop_t_prefix
+
+    return result
+  end
+
+  # This and ActionView::Template#render below are for compatibility
+  # with Ruby 3, as opposed to altering the original functionality.
+  def render_partial_template(view, locals, template, layout, block)
+    ActiveSupport::Notifications.instrument(
+      "render_partial.action_view",
+      identifier: template.identifier,
+      layout: layout && layout.virtual_path
+    ) do |payload|
+      content = template.render(view, locals, ActionView::OutputBuffer.new, {add_to_stack: !block}) do |*name|
+        view._layout_for(*name, &block)
+      end
+
+      content = layout.render(view, locals) { content } if layout
+      payload[:cache_hit] = view.view_renderer.cache_hits[template.virtual_path]
+      build_rendered_template(content, template)
+    end
+  end
+end
+
+class ActionView::Template
+  def render(view, locals, buffer = ActionView::OutputBuffer.new, flag = {add_to_stack: true}, &block)
+    instrument_render_template do
+      compile!(view)
+      view._run(method_name, self, locals, buffer, **flag, &block)
+    end
+  rescue => e
+    handle_render_error(view, e)
+  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.6"
 end

data/lib/nice_partials.rb

@@ -2,9 +2,19 @@
 
 require_relative "nice_partials/version"
 require_relative "nice_partials/helper"
-require_relative "partials"
+require_relative "nice_partials/monkey_patch"
 
 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/nice_partials.gemspec

@@ -17,5 +17,9 @@ 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'
+
+  gem.add_development_dependency "rails"
 end

data/test/fixtures/_basic.html.erb

@@ -0,0 +1,2 @@
+<% yield p = np %>
+<%= p.yield :message %>

data/test/fixtures/_card.html.erb

@@ -0,0 +1,13 @@
+<% yield p = np %>
+
+<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.content_for :body %>
+      </p>
+    <% end %>
+  </div>
+</div>

data/test/fixtures/card_test.html.erb

@@ -0,0 +1,9 @@
+<%= render "card", title: "Some Title" do |p| %>
+  <% p.content_for :body do %>
+    Lorem Ipsum
+  <% end %>
+
+  <% p.content_for :image do %>
+    <img src="https://example.com/image.jpg" />
+  <% end %>
+<% end %>

data/test/renderer_test.rb

@@ -0,0 +1,57 @@
+require_relative "./test_helper"
+
+class RendererTest < ActiveSupport::TestCase
+  # from actionview/render_test
+  class TestController < ActionController::Base
+  end
+ 
+  def setup_view(paths)
+    ActionView::Base.include(NicePartials::Helper)
+
+    @assigns = { secret: "in the sauce" }
+
+    @view = Class.new(ActionView::Base.with_empty_template_cache) do
+      def view_cache_dependencies; []; end
+
+      def combined_fragment_cache_key(key)
+        [:views, key]
+      end
+    end.with_view_paths(paths, @assigns)
+
+    controller = TestController.new
+    controller.perform_caching = true
+    controller.cache_store = :memory_store
+    @view.controller = controller
+
+    @controller_view = controller.view_context_class.with_empty_template_cache.new(
+      controller.lookup_context,
+      controller.view_assigns,
+      controller)
+  end
+
+  def setup
+    ActionView::LookupContext::DetailsKey.clear
+    path = ActionView::FileSystemResolver.new(FIXTURE_LOAD_PATH)
+    view_paths = ActionView::PathSet.new([path])
+    assert_equal ActionView::FileSystemResolver.new(FIXTURE_LOAD_PATH), view_paths.first
+    setup_view(view_paths)
+  end
+
+  def teardown
+    ActionController::Base.view_paths.map(&:clear_cache)
+  end
+
+  test "render basic nice partial" do
+    rendered = @view.render("basic") { |p| p.content_for :message, "hello from nice partials" }.squish
+
+    assert_equal "hello from nice partials", rendered
+  end
+
+  test "render nice partial in card template" do
+    rendered = @view.render(template: "card_test").squish
+
+    assert_match "Some Title", rendered
+    assert_match "Lorem Ipsum", rendered
+    assert_match "https://example.com/image.jpg", rendered
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require "active_support"
+require "active_support/testing/autorun"
+require "action_controller"
+require "action_view"
+require "nice_partials"
+
+FIXTURE_LOAD_PATH = File.expand_path("fixtures", __dir__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nice_partials
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
 platform: ruby
 authors:
 - Andrew Culver
@@ -9,8 +9,36 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
-dependencies: []
+date: 2022-02-10 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
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A little bit of magic to make partials perfect for components.
 email:
 - andrew.culver@gmail.com
@@ -29,11 +57,15 @@ 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
+- test/fixtures/_basic.html.erb
+- test/fixtures/_card.html.erb
+- test/fixtures/card_test.html.erb
+- test/renderer_test.rb
+- test/test_helper.rb
 homepage: https://github.com/bullet-train-co/nice_partials
 licenses:
 - MIT
@@ -44,7 +76,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
@@ -53,9 +85,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A little bit of magic to make partials perfect for components.
 test_files:
-- spec/nice_partials_spec.rb
+- test/fixtures/_basic.html.erb
+- test/fixtures/_card.html.erb
+- test/fixtures/card_test.html.erb
+- test/renderer_test.rb
+- test/test_helper.rb

data/lib/partials.rb

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

data/spec/nice_partials_spec.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../lib/nice_partials"
-require "minitest/autorun"
-
-describe NicePartials do
-  it "works" do
-    assert_equal true, false
-  end
-end
-