nice_partials 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8c2fc27ad0c01eda3e489191c6ba385498ec49580f38400f8447600ee8d0488
-  data.tar.gz: e138bd379b7f805e0be27054d6a689e31d58169e27ad118bec43a3538b24c9f9
+  metadata.gz: dc5dac27b668f89801b376053aa1c335623c160f7787763a7ea116d2c536a47d
+  data.tar.gz: e51012246b8ddebf3dab57e3d4c5b20df1f3d5d0c400fc8a3244269c0ee4a761
 SHA512:
-  metadata.gz: 24aa6946079c6663a907b6e7eb2c6158b07105bc3cf0273a9907c2a7732fc6ba030e3b733b8beacd1221288e32c995067a0af6b30649e8a6c8ec7960e8adcd22
-  data.tar.gz: 70548909852322e987e7a11aafb81f927b9652ac03bef500f1ddf3b3daca915bc37d22270a537a37580ac67e0fa76ef158bc7a783bf8327c603ad108cc275a5b
+  metadata.gz: fe1ac04c91971f99d3f25fc72409ae48747d8341f341a479e79f96115fdc495cccf858824951cc7124c4d68e2eeec8e2c65d04c1a2af9ecee7da685cd281f46a
+  data.tar.gz: 786ae831e3d51b59fba639bf0e7185ccf853f54c1dec14e5bb97fede30d46ef912f17b81e4a0651b59a246431e9e7a1919557f9d0bbac517c1c7cb4484c25d51

data/CHANGELOG.md

@@ -1,5 +1,87 @@
 ## CHANGELOG
 
+* Feature: partial's expose `local_assigns` + `locals` alias
+
+  ```html+erb
+  <%# app/views/articles/show.html.erb %>
+  <%= render "section", id: "an_article" %>
+
+  <%# app/views/application/_section.html.erb %>
+  <%# We can access the passed `id:` like this: %>
+  <% partial.local_assigns[:id] %>
+  <% partial.locals[:id] %>
+  ```
+
+  Note: this is equal to the default partial local variable of `local_assigns`, but it becomes more useful with the next feature below.
+
+* Feature: partial helpers can access `partial`
+
+  ```html+erb
+  <%# app/views/articles/show.html.erb %>
+  <% render "section", id: "an_article" do |section| %>
+    <%= tag.h1 "An Article", id: section.labelledby %>
+  <% end %>
+
+  <%# app/views/application/_section.html.erb %>
+  <%
+    partial.helpers do
+      def aria
+        partial.locals.fetch(:aria, {}).with_defaults(labelledby:)
+      end
+
+      def labelledby
+        id = partial.locals[:id] and "#{id}_label"
+      end
+    end
+  %>
+
+  <%= tag.section partial.yield, id:, aria: partial.aria %>
+  ```
+
+### 0.9.4
+
+* Feature: declare contents via `required` and `optional`
+
+  ```html+erb
+  <% if partial.title? %>
+    <h1 class="text-xl">
+      <%= partial.title %>
+    </h1>
+  <% end %>
+
+  <div><%= partial.body %></div>
+  ```
+
+  Can now become:
+
+  ```html+erb
+  <%= partial.title.optional.h1 class: "text-xl" %><%# Will not output any HTML element if no content has been provided. %>
+
+  <div><%= partial.body.required %></div> <%# Raises when this line is hit if no content has been provided %>
+  ```
+
+  See the README for more.
+
+### 0.9.3
+
+* Fixed: section predicates not respecting `local_assigns` content
+
+  Previously, when doing something like this:
+
+  ```erb
+  <%= render "card", title: "Hello there" %>
+  ```
+
+  If the inner card partial had this,
+
+  ```erb
+  <% if partial.title? %>
+    <%= partial.title %>
+  <% end %>
+  ```
+
+  The `title?` predicate would fail, because it didn't look up content from the passed `local_assigns`. Now it does.
+
 ### 0.9.2
 
 * Changed: view methods don't clobber section names

data/Gemfile.lock

@@ -0,0 +1,221 @@
+PATH
+  remote: .
+  specs:
+    nice_partials (0.10.0)
+      actionview (>= 4.2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activejob (= 7.0.4.2)
+      activerecord (= 7.0.4.2)
+      activestorage (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      actionview (= 7.0.4.2)
+      activejob (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.4.2)
+      actionview (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activerecord (= 7.0.4.2)
+      activestorage (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.4.2)
+      activesupport (= 7.0.4.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.4.2)
+      activesupport (= 7.0.4.2)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4.2)
+      activesupport (= 7.0.4.2)
+    activerecord (7.0.4.2)
+      activemodel (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+    activestorage (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activejob (= 7.0.4.2)
+      activerecord (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    capybara (3.38.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    date (3.3.3)
+    erubi (1.12.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.6.3)
+      reline (>= 0.3.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    loofah (2.19.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    matrix (0.4.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.18.0)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.8)
+    nokogiri (1.14.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rack (2.2.6.3)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (7.0.4.2)
+      actioncable (= 7.0.4.2)
+      actionmailbox (= 7.0.4.2)
+      actionmailer (= 7.0.4.2)
+      actionpack (= 7.0.4.2)
+      actiontext (= 7.0.4.2)
+      actionview (= 7.0.4.2)
+      activejob (= 7.0.4.2)
+      activemodel (= 7.0.4.2)
+      activerecord (= 7.0.4.2)
+      activestorage (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      bundler (>= 1.15.0)
+      railties (= 7.0.4.2)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.4.2)
+      actionpack (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    reline (0.3.2)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.24.3)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.44.1)
+      rubocop-performance (= 1.15.2)
+    thor (1.2.1)
+    timeout (0.3.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    view_component (2.82.0)
+      activesupport (>= 5.2.0, < 8.0)
+      concurrent-ruby (~> 1.0)
+      method_source (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.6.7)
+
+PLATFORMS
+  arm64-darwin-20
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  capybara
+  irb
+  minitest
+  nice_partials!
+  rails
+  rake
+  standard
+  view_component
+
+BUNDLED WITH
+   2.4.8

data/README.md

@@ -24,7 +24,7 @@ See, here we're outputting the `image`, `title`, and `body` sections:
 Then in `render` we populate them:
 
 ```html+erb
-<%= render "components/card", title: "Some Title" do |partial| %>
+<%= render "components/card" do |partial| %>
   <% partial.title t(".title") %> # Same as `partial.content_for :title, t(".title")`
 
   <% partial.body do %>
@@ -116,6 +116,40 @@ You can also use `slice` to pass on content from an outer partial:
 <%= render "components/card", partial.slice(:title, :byline) %>
 ```
 
+### Declaring content as optional or required
+
+In traditional Rails partials, you'll see lots of checks for whether or not we have content to then output an element.
+
+With Nice Partials, it would look like this:
+
+```html+erb
+<% if partial.title? %>
+  <h1 class="text-xl"><%= partial.title %></h1>
+<% end %>
+```
+
+However, we can remove the conditional using `optional`:
+
+```html+erb
+<%= partial.title.optional.then do |title| %>
+  <h1 class="text-xl"><%= title %></h1>
+<% end %>
+```
+
+This will avoid outputting an empty tag, which could mess with your markup, in case there's no content provided for `title`.
+
+Note: with Nice Partials tag helpers support, this example could also be shortened to `<%= partial.title.optional.h1 class: "text-xl" %>`.
+
+#### Required
+
+Alternatively, if `title` is a section that we require to be provided, we can do:
+
+```html+erb
+<h1 class="text-xl"><%= partial.title.required %></h1>
+```
+
+Here, `required` will raise in case there's been no `title` content provided by that point.
+
 ### 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.
@@ -182,24 +216,6 @@ But the partial can also prepare tag builders that the rendering block can then
 <% partial.title.yield tag.with_options(class: "text-m4", data: { controller: "title" }) %> # => <h1 class="text-m4" data-controller="title">Title content</h1>
 ```
 
-### Smoother conditional rendering
-
-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
-<% if partial.title? %>
-  <% partial.title.h1 %>
-<% end %>
-```
-
-But since sections respond to and leverage `present?`, we can shorten the above to:
-
-```html+erb
-<% partial.title.presence&.h1 %>
-```
-
-This way no empty h1 element is rendered.
-
 ### 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.

data/lib/nice_partials/monkey_patch.rb

@@ -1,28 +1,41 @@
+# frozen_string_literal: true
+
 # 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?
 module NicePartials::RenderingWithLocalePrefix
-  ActionView::Base.prepend self
+  module BaseIntegration
+    ::ActionView::Base.prepend self
 
-  def capture(*, &block)
-    with_nice_partials_t_prefix(lookup_context, block) { super }
-  end
+    def t(key, options = {})
+      if (template = @_nice_partials_translate_template) && key&.start_with?(".")
+        key = "#{virtual_path_translate_key_prefix(template.virtual_path)}#{key}"
+      end
+
+      super(key, **options)
+    end
 
-  def t(key, options = {})
-    if (prefix = @_nice_partials_t_prefix) && key.first == '.'
-      key = "#{prefix}#{key}"
+    def with_nice_partials_t_prefix(block)
+      old_nice_partials_translate_template = @_nice_partials_translate_template
+      @_nice_partials_translate_template = block ? @current_template : nil
+      yield
+    ensure
+      @_nice_partials_translate_template = old_nice_partials_translate_template
     end
 
-    super(key, **options)
+    private
+
+    def virtual_path_translate_key_prefix(virtual_path)
+      @_scope_key_by_partial_cache ||= {} # Reuses Rails' existing `t` cache.
+      @_scope_key_by_partial_cache[virtual_path] ||= virtual_path.gsub(%r{/_?}, ".")
+    end
   end
 
-  private
+  module PartialRendererIntegration
+    ActionView::PartialRenderer.prepend self
 
-  def with_nice_partials_t_prefix(lookup_context, block)
-    _nice_partials_t_prefix = @_nice_partials_t_prefix
-    @_nice_partials_t_prefix = block ? NicePartials.locale_prefix_from(lookup_context, block) : nil
-    yield
-  ensure
-    @_nice_partials_t_prefix = _nice_partials_t_prefix
+    def render(partial, view, block)
+      view.with_nice_partials_t_prefix(block) { super }
+    end
   end
 end
 

data/lib/nice_partials/partial/section.rb

@@ -1,4 +1,39 @@
+# frozen_string_literal: true
+
 class NicePartials::Partial::Section < NicePartials::Partial::Content
+  class RequiredError < ArgumentError; end
+
+  class Empty < BasicObject
+    def initialize(section)
+      @section = section
+    end
+    delegate :blank?, :present?, :presence, to: :@section
+
+    def nil?
+      true
+    end
+
+    def method_missing(...)
+      present? ? super : ""
+    end
+  end
+
+  # Returns self if `present?`, or raises.
+  # Useful to declare content that you require to be supplied during a `render` call.
+  #
+  #   <%= partial.title.required.div class: "text-xl" %>
+  def required
+    present? ? self : raise(RequiredError, "Section expected to have content, but wasn't supplied during render")
+  end
+
+  # Returns self if `present?`, or returns a Null object that won't output any content.
+  # Useful to declare optional content sections, that you also don't want to print any HTML elements for.
+  #
+  #   <%= partial.title.optional.div class: "text-xl" %> # => "" # Won't output an empty `<div>` that can mess with HTML markups.
+  def optional
+    present? ? self : Empty.new(self)
+  end
+
   def yield(*arguments)
     chunks.each { append @view_context.capture(*arguments, &_1) }
     self

data/lib/nice_partials/partial.rb

@@ -4,6 +4,9 @@ module NicePartials
     autoload :Section, "nice_partials/partial/section"
     autoload :Stack, "nice_partials/partial/stack"
 
+    attr_reader :local_assigns
+    alias_method :locals, :local_assigns
+
     def initialize(view_context, local_assigns = nil)
       @view_context, @local_assigns = view_context, local_assigns
     end
@@ -70,7 +73,7 @@ module NicePartials
     end
 
     def section?(name)
-      @sections&.dig(name).present?
+      section_from(name).present?
     end
     alias content_for? section?
 
@@ -107,13 +110,23 @@ module NicePartials
     end
 
     def helpers_context
-      @helpers_context ||= Helpers.new(@view_context)
+      @helpers_context ||= Helpers.new(@view_context, self)
     end
 
     class Helpers < SimpleDelegator
       def self.method_added(name)
         super
-        NicePartials::Partial.delegate name, to: :helpers_context
+
+        unless name == :initialize || name == :partial
+          NicePartials::Partial.delegate name, to: :helpers_context
+        end
+      end
+
+      attr_reader :partial
+
+      def initialize(view_context, partial)
+        super(view_context)
+        @partial = partial
       end
     end
   end

data/lib/nice_partials/version.rb

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

data/lib/nice_partials.rb

@@ -3,11 +3,6 @@
 require_relative "nice_partials/version"
 
 module NicePartials
-  def self.locale_prefix_from(lookup_context, block)
-    partial_location = block.source_location.first.dup
-    lookup_context.view_paths.each { partial_location.delete_prefix!(_1.path)&.delete_prefix!("/") }
-    partial_location.split('.').first.gsub('/_', '/').gsub('/', '.')
-  end
 end
 
 ActiveSupport.on_load :action_view do

data/nice_partials.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+require File.dirname(__FILE__) + "/lib/nice_partials/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "nice_partials"
+  gem.version       = NicePartials::VERSION
+  gem.summary       = "A little bit of magic to make partials perfect for components."
+  gem.description   = "A little bit of magic to make partials perfect for components."
+  gem.authors       = ["Andrew Culver", "Dom Christie"]
+  gem.email         = ["andrew.culver@gmail.com", "christiedom@gmail.com"]
+  gem.homepage      = "https://github.com/bullet-train-co/nice_partials"
+  gem.license       = "MIT"
+
+    # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  gem.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  gem.bindir = "exe"
+  gem.executables = gem.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 2.0"
+
+  gem.add_dependency "actionview", '>= 4.2.6'
+
+  gem.add_development_dependency "rails"
+  gem.add_development_dependency "standard"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nice_partials
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Andrew Culver
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -64,6 +64,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - MIT-LICENSE.txt
 - README.md
 - Rakefile
@@ -75,6 +76,7 @@ files:
 - lib/nice_partials/partial/section.rb
 - lib/nice_partials/partial/stack.rb
 - lib/nice_partials/version.rb
+- nice_partials.gemspec
 homepage: https://github.com/bullet-train-co/nice_partials
 licenses:
 - MIT
@@ -94,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A little bit of magic to make partials perfect for components.