view_component 2.54.1 → 2.56.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9cab3c05c054f173b248b903912dfb432eeec09b2d3d42f6fd602a7565acd2d
-  data.tar.gz: 78b70e8ea1306fb635978dbe2a86cece2618247bb0079798e5a886f2210dfed1
+  metadata.gz: 338f95cb25ce1684e1be8486d44f84130f7a2a1b96f01d3a99b9909cb64ff650
+  data.tar.gz: ac955c1551852c4ef4f5c884bacca4513f10b08b59e6a6b9aa635cfc20a7481c
 SHA512:
-  metadata.gz: 653d1c627f3fb52677e47516472fec508c562359e3beac3defa43d172d3e793359207df638f352f1c1cc6a876a0f3c3fdc4c7ff4eefdc1907c20a161e9359d83
-  data.tar.gz: 25bc7a21cde84c3311d9482cdb2ccccf821ce2c104492506a999e81f8cd9d9a5b3b3c19f3b417dc3f250787adf18fbe9f9d9ff5589e897fc199e26e50e4b0efa
+  metadata.gz: efc8cebe7198a787d2534bf1d5ddadbea1d90940495df41cd1c13fe8f2f8ec2f4f065c6a7ee874e4e0c84cb823a02bdbcc3b912c29f00580b04b7475c1384755
+  data.tar.gz: 0c4f543ec0047ce0cbd7fbbeafd38ddc973051e6e010e19b36a3040a89ebdd96a3dc108c48b7aeb2ce95416908bbefad0387fe965f7400940ea07284f177c5eb

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

@@ -8,7 +8,6 @@ module ViewComponent
       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)
@@ -23,6 +22,8 @@ module ViewComponent
     end
 
     def previews
+      find_preview
+
       if params[:path] == @preview.preview_name
         @page_title = "Component Previews for #{@preview.preview_name}"
         render "view_components/previews", **determine_layout

data/docs/CHANGELOG.md

@@ -9,6 +9,56 @@ title: Changelog
 
 ## main
 
+## 2.56.1
+
+* Rename private accessor `rendered_component` to `rendered_content`.
+
+    *Yoshiyuki Hirano*, *Simon Dawson*
+
+## 2.56.0
+
+* Introduce experimental `render_preview` test helper. Note: `@rendered_component` in `TestHelpers` has been renamed to `@rendered_content`.
+
+    *Joel Hawksley*
+
+* Move framework tests into sandbox application.
+
+    *Joel Hawksley*
+
+* Add G2 to list of companies that use ViewComponent.
+
+    *Jack Shuff*
+
+* Add Within3 to list of companies that use ViewComponent.
+
+    *Drew Bragg*
+
+* Add Mission Met to list of companies that use ViewComponent.
+
+    *Nick Smith*
+
+* Fix `#with_request_url` test helper not parsing nested query parameters into nested hashes.
+
+    *Richard Marbach*
+
+## 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.
@@ -26,7 +76,7 @@ title: Changelog
 
     *Blake Williams*
 
-* Add QuickNode to list of companies that heavily rely on ViewComponent.
+* Add QuickNode to list of companies that use ViewComponent.
 
     *Luc Castera*
 
@@ -60,7 +110,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*
 
@@ -68,6 +118,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.

data/lib/view_component/base.rb

@@ -117,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/preview.rb

@@ -30,7 +30,8 @@ module ViewComponent # :nodoc:
     class << self
       # Returns all component preview classes.
       def all
-        load_previews if descendants.empty?
+        load_previews
+
         descendants
       end
 
@@ -98,14 +99,14 @@ module ViewComponent # :nodoc:
         source[1...(source.size - 1)].join("\n")
       end
 
-      private
-
       def load_previews
         Array(preview_paths).each do |preview_path|
           Dir["#{preview_path}/**/*_preview.rb"].sort.each { |file| require_dependency file }
         end
       end
 
+      private
+
       def preview_paths
         Base.preview_paths
       end

data/lib/view_component/render_preview_helper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module RenderPreviewHelper
+    # Render a preview inline. Internally sets `page` to be a `Capybara::Node::Simple`,
+    # allowing for Capybara assertions to be used:
+    #
+    # ```ruby
+    # render_preview(:default)
+    # assert_text("Hello, World!")
+    # ```
+    #
+    # Note: `#rendered_preview` expects a preview to be defined with the same class
+    # name as the calling test, but with `Test` replaced with `Preview`:
+    #
+    # MyComponentTest -> MyComponentPreview etc.
+    #
+    # @param preview [String] The name of the preview to be rendered.
+    # @return [Nokogiri::HTML]
+    def render_preview(name)
+      begin
+        preview_klass = self.class.name.gsub("Test", "Preview")
+        preview_klass = preview_klass.constantize
+      rescue NameError
+        raise NameError.new(
+          "`render_preview` expected to find #{preview_klass}, but it does not exist."
+        )
+      end
+
+      previews_controller = build_controller(ViewComponent::Base.preview_controller.constantize)
+      previews_controller.request.params[:path] = "#{preview_klass.preview_name}/#{name}"
+      previews_controller.response = ActionDispatch::Response.new
+      result = previews_controller.previews
+
+      @rendered_content = result
+
+      Nokogiri::HTML.fragment(@rendered_content)
+    end
+  end
+end

data/lib/view_component/test_helpers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "view_component/render_preview_helper"
+
 module ViewComponent
   module TestHelpers
     begin
@@ -7,7 +9,7 @@ module ViewComponent
       include Capybara::Minitest::Assertions
 
       def page
-        Capybara::Node::Simple.new(@rendered_component)
+        Capybara::Node::Simple.new(@rendered_content)
       end
 
       def refute_component_rendered
@@ -19,8 +21,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
 
@@ -28,7 +30,7 @@ module ViewComponent
     end
 
     # @private
-    attr_reader :rendered_component
+    attr_reader :rendered_content
 
     # Render a component inline. Internally sets `page` to be a `Capybara::Node::Simple`,
     # allowing for Capybara assertions to be used:
@@ -41,14 +43,29 @@ module ViewComponent
     # @param component [ViewComponent::Base, ViewComponent::Collection] The instance of the component to be rendered.
     # @return [Nokogiri::HTML]
     def render_inline(component, **args, &block)
-      @rendered_component =
+      @rendered_content =
         if Rails.version.to_f >= 6.1
           controller.view_context.render(component, args, &block)
         else
           controller.view_context.render_component(component, &block)
         end
 
-      Nokogiri::HTML.fragment(@rendered_component)
+      Nokogiri::HTML.fragment(@rendered_content)
+    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_content = controller.view_context.instance_exec(&block)
+      Nokogiri::HTML.fragment(@rendered_content)
     end
 
     # @private
@@ -121,7 +138,7 @@ module ViewComponent
 
       request.path_info = path
       request.path_parameters = Rails.application.routes.recognize_path(path)
-      request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_query(path.split("?")[1]))
+      request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_nested_query(path.split("?")[1]))
       request.set_header(Rack::QUERY_STRING, path.split("?")[1])
       yield
     ensure

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 54
+    MINOR = 56
     PATCH = 1
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.54.1
+  version: 2.56.1
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -345,6 +345,7 @@ files:
 - lib/view_component/render_component_helper.rb
 - lib/view_component/render_component_to_string_helper.rb
 - lib/view_component/render_monkey_patch.rb
+- lib/view_component/render_preview_helper.rb
 - lib/view_component/render_to_string_monkey_patch.rb
 - lib/view_component/rendering_component_helper.rb
 - lib/view_component/rendering_monkey_patch.rb