view_component 2.53.0 → 2.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d505afaa4cb16810628e814c69bb2d00bc76498f6c681173d7811f44cd87c8e
-  data.tar.gz: 2bc859d6034fed19e34739cf1844679bcf83332c7e227c487ddb7364e8166f4b
+  metadata.gz: c6460c94f3bb4f2b19cd5311d957d2187e437276c0c19b657834cccba39fb36f
+  data.tar.gz: c0dfc55481d2bcfcdc2f54ea4f4bacc94780e2dce39b77eaf5828490c1d0fc52
 SHA512:
-  metadata.gz: 75dcf204fd8e3dfad8a1da18de6d96d43fd779f1c9a73ca66b76f0db1ac7be04cf04447c9eaa901d32bc674d7eb7fa79fd5572bff08652a892a7e96f5186faaa
-  data.tar.gz: 7be68adaa9de981a4fb12451ebcc19875f5754fa4798eef60f98702b1c7396bb598a1f6ae77b768bbe55e5b4f77c33f6b9db7156fa18f04c0a63075c54fdd7cc
+  metadata.gz: 6ffed42bf70668cf3dbf811f5f24e4a9e2e6cca7fdaea3674f8323c08a60b0f7c49f94c9a1d0bb1c962fb04c0c6dbdb219891116b70385bb8d3fe5f650d86f91
+  data.tar.gz: 416501060d316e680dbf7f65543aa9a57b693e13bf8a9ebd8c244794155b33702863b22723d140bb85df560e4b18d746f3d534a9a98f4698ced8435cecce3375

data/app/controllers/concerns/view_component/preview_actions.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module PreviewActions
+    extend ActiveSupport::Concern
+
+    included do
+      prepend_view_path File.expand_path("../../../views", __dir__)
+
+      around_action :set_locale, only: :previews
+      before_action :find_preview, only: :previews
+      before_action :require_local!, unless: :show_previews?
+
+      if respond_to?(:content_security_policy)
+        content_security_policy(false)
+      end
+    end
+
+    def index
+      @previews = ViewComponent::Preview.all
+      @page_title = "Component Previews"
+      render "view_components/index", **determine_layout
+    end
+
+    def previews
+      if params[:path] == @preview.preview_name
+        @page_title = "Component Previews for #{@preview.preview_name}"
+        render "view_components/previews", **determine_layout
+      else
+        prepend_application_view_paths
+        prepend_preview_examples_view_path
+        @example_name = File.basename(params[:path])
+        @render_args = @preview.render_args(@example_name, params: params.permit!)
+        layout = determine_layout(@render_args[:layout], prepend_views: false)[:layout]
+        locals = @render_args[:locals]
+        opts = {}
+        opts[:layout] = layout if layout.present? || layout == false
+        opts[:locals] = locals if locals.present?
+        render "view_components/preview", opts # rubocop:disable GitHub/RailsControllerRenderLiteral
+      end
+    end
+
+    private
+
+    def default_preview_layout # :doc:
+      ViewComponent::Base.default_preview_layout
+    end
+
+    def show_previews? # :doc:
+      ViewComponent::Base.show_previews
+    end
+
+    def find_preview # :doc:
+      candidates = []
+      params[:path].to_s.scan(%r{/|$}) { candidates << $` }
+      preview = candidates.detect { |candidate| ViewComponent::Preview.exists?(candidate) }
+
+      if preview
+        @preview = ViewComponent::Preview.find(preview)
+      else
+        raise AbstractController::ActionNotFound, "Component preview '#{params[:path]}' not found."
+      end
+    end
+
+    def set_locale
+      I18n.with_locale(params[:locale] || I18n.default_locale) do
+        yield
+      end
+    end
+
+    # Returns either {} or {layout: value} depending on configuration
+    def determine_layout(layout_override = nil, prepend_views: true)
+      return {} unless defined?(Rails.root)
+
+      layout_declaration = {}
+
+      if !layout_override.nil?
+        # Allow component-level override, even if false (thus no layout rendered)
+        layout_declaration[:layout] = layout_override
+      elsif default_preview_layout.present?
+        layout_declaration[:layout] = default_preview_layout
+      end
+
+      prepend_application_view_paths if layout_declaration[:layout].present? && prepend_views
+
+      layout_declaration
+    end
+
+    def prepend_application_view_paths
+      prepend_view_path Rails.root.join("app/views") if defined?(Rails.root)
+    end
+
+    def prepend_preview_examples_view_path
+      prepend_view_path(ViewComponent::Base.preview_paths)
+    end
+  end
+end

data/app/controllers/view_components_controller.rb

@@ -3,91 +3,5 @@
 require "rails/application_controller"
 
 class ViewComponentsController < Rails::ApplicationController # :nodoc:
-  prepend_view_path File.expand_path("../views", __dir__)
-
-  around_action :set_locale, only: :previews
-  before_action :find_preview, only: :previews
-  before_action :require_local!, unless: :show_previews?
-
-  if respond_to?(:content_security_policy)
-    content_security_policy(false)
-  end
-
-  def index
-    @previews = ViewComponent::Preview.all
-    @page_title = "Component Previews"
-    render "view_components/index", **determine_layout
-  end
-
-  def previews
-    if params[:path] == @preview.preview_name
-      @page_title = "Component Previews for #{@preview.preview_name}"
-      render "view_components/previews", **determine_layout
-    else
-      prepend_application_view_paths
-      prepend_preview_examples_view_path
-      @example_name = File.basename(params[:path])
-      @render_args = @preview.render_args(@example_name, params: params.permit!)
-      layout = determine_layout(@render_args[:layout], prepend_views: false)[:layout]
-      locals = @render_args[:locals]
-      opts = {}
-      opts[:layout] = layout if layout.present? || layout == false
-      opts[:locals] = locals if locals.present?
-      render "view_components/preview", opts # rubocop:disable GitHub/RailsControllerRenderLiteral
-    end
-  end
-
-  private
-
-  def default_preview_layout # :doc:
-    ViewComponent::Base.default_preview_layout
-  end
-
-  def show_previews? # :doc:
-    ViewComponent::Base.show_previews
-  end
-
-  def find_preview # :doc:
-    candidates = []
-    params[:path].to_s.scan(%r{/|$}) { candidates << $` }
-    preview = candidates.detect { |candidate| ViewComponent::Preview.exists?(candidate) }
-
-    if preview
-      @preview = ViewComponent::Preview.find(preview)
-    else
-      raise AbstractController::ActionNotFound, "Component preview '#{params[:path]}' not found."
-    end
-  end
-
-  def set_locale
-    I18n.with_locale(params[:locale] || I18n.default_locale) do
-      yield
-    end
-  end
-
-  # Returns either {} or {layout: value} depending on configuration
-  def determine_layout(layout_override = nil, prepend_views: true)
-    return {} unless defined?(Rails.root)
-
-    layout_declaration = {}
-
-    if !layout_override.nil?
-      # Allow component-level override, even if false (thus no layout rendered)
-      layout_declaration[:layout] = layout_override
-    elsif default_preview_layout.present?
-      layout_declaration[:layout] = default_preview_layout
-    end
-
-    prepend_application_view_paths if layout_declaration[:layout].present? && prepend_views
-
-    layout_declaration
-  end
-
-  def prepend_application_view_paths
-    prepend_view_path Rails.root.join("app/views") if defined?(Rails.root)
-  end
-
-  def prepend_preview_examples_view_path
-    prepend_view_path(ViewComponent::Base.preview_paths)
-  end
+  include ViewComponent::PreviewActions
 end

data/docs/CHANGELOG.md

@@ -9,6 +9,53 @@ title: Changelog
 
 ## main
 
+## 2.55.0
+
+* Add `render_parent` convenience method to avoid confusion between `<%= super %>` and `<% super %>` in template code.
+
+    *Cameron Dutro*
+
+* Add note about discouraging inheritance.
+
+    *Joel Hawksley*
+
+* Clean up grammar in documentation.
+
+    *Joel Hawksley*
+
+* The ViewComponent team at GitHub is hiring! We're looking for a Rails engineer with accessibility experience: [https://boards.greenhouse.io/github/jobs/4020166](https://boards.greenhouse.io/github/jobs/4020166). Reach out to joelhawksley@github.com with any questions!
+
+* The ViewComponent team is hosting a happy hour at RailsConf. Join us for snacks, drinks, and stickers: [https://www.eventbrite.com/e/viewcomponent-happy-hour-tickets-304168585427](https://www.eventbrite.com/e/viewcomponent-happy-hour-tickets-304168585427)
+
+## 2.54.1
+
+* Update docs dependencies.
+
+    *Joel Hawksley*
+
+* Resolve warning in slots API.
+* Raise in the test environment when ViewComponent code emits a warning.
+
+    *Blake Williams*
+
+## 2.54.0
+
+* Add `with_*` slot API for defining slots. Note: we plan to deprecate the non `with_*` API for slots in an upcoming release.
+
+    *Blake Williams*
+
+* Add QuickNode to list of companies that use ViewComponent.
+
+    *Luc Castera*
+
+* Include the `Translatable` module by default.
+
+    *Elia Schito*
+
+* Update docs dependencies.
+
+    *Joel Hawksley*
+
 ## 2.53.0
 
 * Add support for relative I18n scopes to translations.
@@ -31,7 +78,7 @@ title: Changelog
 
     *Jason Swett*
 
-* Add Bearer to list of companies that heavily rely on ViewComponent.
+* Add Bearer to list of companies that use ViewComponent.
 
     *Yaroslav Shmarov*
 
@@ -39,6 +86,10 @@ title: Changelog
 
     *Joel Hawksley*
 
+* Enable rendering arbitrary block contents in the view context in tests.
+
+    *Cameron Dutro*
+
 ## 2.52.0
 
 * Add ADR for separate slot getter/setter API.
@@ -160,6 +211,10 @@ title: Changelog
 
     *Peter Goldstein*
 
+* Move preview logic to module for easier app integration.
+
+    *Sammy Henningsson*
+
 ## 2.48.0
 
 * Correct path in example test command in Contributing docs.

data/lib/view_component/base.rb

@@ -17,6 +17,7 @@ module ViewComponent
     include ViewComponent::ContentAreas
     include ViewComponent::Previewable
     include ViewComponent::SlotableV2
+    include ViewComponent::Translatable
     include ViewComponent::WithContentHelper
 
     ViewContextCalledBeforeRenderError = Class.new(StandardError)
@@ -69,7 +70,7 @@ module ViewComponent
       @view_context = view_context
       self.__vc_original_view_context ||= view_context
 
-      @output_buffer = ActionView::OutputBuffer.new unless @global_buffer_in_use
+      @output_buffer = ActionView::OutputBuffer.new unless defined?(@global_buffer_in_use) && @global_buffer_in_use
 
       @lookup_context ||= view_context.lookup_context
 
@@ -116,6 +117,20 @@ module ViewComponent
       render_template_for(@__vc_variant).to_s + _output_postamble
     end
 
+    # Subclass components that call `super` inside their template code will cause a
+    # double render if they accidentally emit the result:
+    #
+    # <%= super %> # double-renders
+    #
+    # <% super %> # does not double-render
+    #
+    # Calls `super`, returning nil to avoid rendering the result twice.
+    def render_parent
+      mtd = @__vc_variant ? "call_#{@__vc_variant}" : "call"
+      method(mtd).super_method.call
+      nil
+    end
+
     # :nocov:
     def render_template_for(variant = nil)
       # Force compilation here so the compiler always redefines render_template_for.

data/lib/view_component/compiler.rb

@@ -77,6 +77,7 @@ module ViewComponent
 
         define_render_template_for
 
+        component_class.build_i18n_backend
         component_class._after_compile
 
         CompileCache.register(component_class)

data/lib/view_component/polymorphic_slots.rb

@@ -45,10 +45,16 @@ module ViewComponent
               "#{slot_name}_#{poly_type}"
             end
 
+          # Deprecated: Will be removed in 3.0
           define_method(setter_name) do |*args, &block|
             set_polymorphic_slot(slot_name, poly_type, *args, &block)
           end
           ruby2_keywords(setter_name.to_sym) if respond_to?(:ruby2_keywords, true)
+
+          define_method("with_#{setter_name}") do |*args, &block|
+            set_polymorphic_slot(slot_name, poly_type, *args, &block)
+          end
+          ruby2_keywords(:"with_#{setter_name}") if respond_to?(:ruby2_keywords, true)
         end
 
         self.registered_slots[slot_name] = {

data/lib/view_component/slotable_v2.rb

@@ -61,20 +61,26 @@ module ViewComponent
       # = Setting sub-component content
       #
       # Consumers of the component can render a sub-component by calling a
-      # helper method with the same name as the slot.
+      # helper method with the same name as the slot prefixed with `with_`.
       #
       #   <%= render_inline(MyComponent.new) do |component| %>
-      #     <% component.header(classes: "Foo") do %>
+      #     <% component.with_header(classes: "Foo") do %>
       #       <p>Bar</p>
       #     <% end %>
       #   <% end %>
       def renders_one(slot_name, callable = nil)
         validate_singular_slot_name(slot_name)
 
+        define_method :"with_#{slot_name}" do |*args, &block|
+          set_slot(slot_name, nil, *args, &block)
+        end
+        ruby2_keywords(:"with_#{slot_name}") if respond_to?(:ruby2_keywords, true)
+
         define_method slot_name do |*args, &block|
           if args.empty? && block.nil?
             get_slot(slot_name)
           else
+            # Deprecated: Will remove in 3.0
             set_slot(slot_name, nil, *args, &block)
           end
         end
@@ -112,15 +118,15 @@ module ViewComponent
       # = Setting sub-component content
       #
       # Consumers of the component can set the content of a slot by calling a
-      # helper method with the same name as the slot. The method can be
-      # called multiple times to append to the slot.
+      # helper method with the same name as the slot prefixed with `with_`. The
+      # method can be called multiple times to append to the slot.
       #
       #   <%= render_inline(MyComponent.new) do |component| %>
-      #     <% component.item(name: "Foo") do %>
+      #     <% component.with_item(name: "Foo") do %>
       #       <p>One</p>
       #     <% end %>
       #
-      #     <% component.item(name: "Bar") do %>
+      #     <% component.with_item(name: "Bar") do %>
       #       <p>two</p>
       #     <% end %>
       #   <% end %>
@@ -132,17 +138,31 @@ module ViewComponent
         # Define setter for singular names
         # for example `renders_many :items` allows fetching all tabs with
         # `component.tabs` and setting a tab with `component.tab`
+        #
+        # Deprecated: Will remove in 3.0
         define_method singular_name do |*args, &block|
           set_slot(slot_name, nil, *args, &block)
         end
         ruby2_keywords(singular_name.to_sym) if respond_to?(:ruby2_keywords, true)
 
+        define_method :"with_#{singular_name}" do |*args, &block|
+          set_slot(slot_name, nil, *args, &block)
+        end
+        ruby2_keywords(:"with_#{singular_name}") if respond_to?(:ruby2_keywords, true)
+
+        define_method :"with_#{slot_name}" do |collection_args = nil, &block|
+          collection_args.map do |args|
+            set_slot(slot_name, nil, **args, &block)
+          end
+        end
+
         # Instantiates and and adds multiple slots forwarding the first
         # argument to each slot constructor
         define_method slot_name do |collection_args = nil, &block|
           if collection_args.nil? && block.nil?
             get_slot(slot_name)
           else
+            # Deprecated: Will remove in 3.0
             collection_args.map do |args|
               set_slot(slot_name, nil, **args, &block)
             end

data/lib/view_component/test_helpers.rb

@@ -19,8 +19,8 @@ module ViewComponent
       # :nocov:
       if ENV["DEBUG"]
         warn(
-          "WARNING in `ViewComponent::TestHelpers`: You must add `capybara` " \
-          "to your Gemfile to use Capybara assertions."
+          "WARNING in `ViewComponent::TestHelpers`: Add `capybara` " \
+          "to Gemfile to use Capybara assertions."
         )
       end
 
@@ -51,6 +51,21 @@ module ViewComponent
       Nokogiri::HTML.fragment(@rendered_component)
     end
 
+    # Execute the given block in the view context. Internally sets `page` to be a
+    # `Capybara::Node::Simple`, allowing for Capybara assertions to be used:
+    #
+    # ```ruby
+    # render_in_view_context do
+    #   render(MyComponent.new)
+    # end
+    #
+    # assert_text("Hello, World!")
+    # ```
+    def render_in_view_context(&block)
+      @rendered_component = controller.view_context.instance_exec(&block)
+      Nokogiri::HTML.fragment(@rendered_component)
+    end
+
     # @private
     def controller
       @controller ||= build_controller(Base.test_controller.constantize)

data/lib/view_component/translatable.rb

@@ -20,9 +20,7 @@ module ViewComponent
         @i18n_scope ||= virtual_path.sub(%r{^/}, "").gsub(%r{/_?}, ".")
       end
 
-      def _after_compile
-        super
-
+      def build_i18n_backend
         return if CompileCache.compiled? self
 
         if (translation_files = _sidecar_files(%w[yml yaml])).any?

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 53
+    MINOR = 55
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.53.0
+  version: 2.55.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -293,6 +293,7 @@ files:
 - README.md
 - app/assets/vendor/prism.css
 - app/assets/vendor/prism.min.js
+- app/controllers/concerns/view_component/preview_actions.rb
 - app/controllers/view_components_controller.rb
 - app/helpers/preview_helper.rb
 - app/views/test_mailer/test_email.html.erb