view_component 2.39.0 → 2.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5f28b38a232a62dbe80033fe0ac5a7b0ee717f933afc76a1e991396ff51a8d6
-  data.tar.gz: ed6610e4fc417a876aeac464439cc627c5ce6e242a65faa0d7db001e2249035a
+  metadata.gz: a6b59c1dbd53f3cb893d36ca15cb6838e6b127a36c895d2e062f961929f03bb9
+  data.tar.gz: b32e3ecaa9f9734eded75141a75baeaa4396652e475827ff9db29dcf647e36c7
 SHA512:
-  metadata.gz: d7e130233a0699c54a1a9664c9a893afc6df8e45795d397ce6592e2edbd719c61ed6ef9fb373b3dc8d8285bc3a2d712c013579303138fb466806e646c2480465
-  data.tar.gz: 25001a6bff37068aceccfb029d5829cd759f4662f7f0b8eb4ab76a42bf0a31ba55f1ceb97480c4a285dc3e9d9da62e746194f623f6b443c647fdb17bb21b3963
+  metadata.gz: e1e2312bb9dda96f1f52d6fa513514e461b2c3f9880ffa8321fcba69aabeaf1d87fc5199a7cf190c2596184051c0db30539b4600dbe2a15b5a560f76dc04240f
+  data.tar.gz: fc65722d4b20457c22de5d0603b80b171777c18bbae19c579f841b4aa092e6feb8e821da8832b6c2fb283d6a2fbca8929967f379b96d68d8ad94c8b171fa2293

data/docs/CHANGELOG.md

@@ -7,6 +7,24 @@ title: Changelog
 
 ## main
 
+## 2.40.0
+
+* Replace antipatterns section in the documentation with best practices.
+
+    *Blake Williams*
+
+* Add components to `rails stats` task.
+
+    *Nicolas Brousse*
+
+* Fix bug when using Slim and writing a slot whose block evaluates to `nil`.
+
+    *Yousuf Jukaku*
+
+* Add documentation for test helpers.
+
+    *Joel Hawksley*
+
 ## 2.39.0
 
 * Clarify documentation of `with_variant` as an override of Action Pack.

data/lib/view_component/engine.rb

@@ -8,6 +8,10 @@ module ViewComponent
     config.view_component = ActiveSupport::OrderedOptions.new
     config.view_component.preview_paths ||= []
 
+    rake_tasks do
+      load "view_component/rails/tasks/view_component.rake"
+    end
+
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
 

data/lib/view_component/rails/tasks/view_component.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+task stats: "view_component:statsetup"
+
+namespace :view_component do
+  task statsetup: :environment do
+    require "rails/code_statistics"
+
+    ::STATS_DIRECTORIES << ["ViewComponents", ViewComponent::Base.view_component_path]
+  end
+end

data/lib/view_component/slot_v2.rb

@@ -64,7 +64,7 @@ module ViewComponent
           @__vc_content_set_by_with_content
              end
 
-      @content
+      @content = @content.to_s
     end
 
     # Allow access to public component methods via the wrapper

data/lib/view_component/test_helpers.rb

@@ -27,8 +27,19 @@ module ViewComponent
       # :nocov:
     end
 
+    # @private
     attr_reader :rendered_component
 
+    # Render a component inline. Internally sets `page` to be a `Capybara::Node::Simple`,
+    # allowing for Capybara assertions to be used:
+    #
+    # ```ruby
+    # render_inline(MyComponent.new)
+    # assert_text("Hello, World!")
+    # ```
+    #
+    # @param component [ViewComponent::Base] The instance of the component to be rendered.
+    # @return [Nokogiri::HTML]
     def render_inline(component, **args, &block)
       @rendered_component =
         if Rails.version.to_f >= 6.1
@@ -40,10 +51,12 @@ module ViewComponent
       Nokogiri::HTML.fragment(@rendered_component)
     end
 
+    # @private
     def controller
       @controller ||= build_controller(Base.test_controller.constantize)
     end
 
+    # @private
     def request
       @request ||=
         begin
@@ -53,6 +66,15 @@ module ViewComponent
         end
     end
 
+    # Set the Action Pack request variant for the given block:
+    #
+    # ```ruby
+    # with_variant(:phone) do
+    #   render_inline(MyComponent.new)
+    # end
+    # ```
+    #
+    # @param variant [Symbol] The variant to be set for the provided block.
     def with_variant(variant)
       old_variants = controller.view_context.lookup_context.variants
 
@@ -62,6 +84,16 @@ module ViewComponent
       controller.view_context.lookup_context.variants = old_variants
     end
 
+    # Set the controller to be used while executing the given block,
+    # allowing access to controller-specific methods:
+    #
+    # ```ruby
+    # with_controller_class(UsersController) do
+    #   render_inline(MyComponent.new)
+    # end
+    # ```
+    #
+    # @param klass [ActionController::Base] The controller to be used.
     def with_controller_class(klass)
       old_controller = defined?(@controller) && @controller
 
@@ -71,6 +103,15 @@ module ViewComponent
       @controller = old_controller
     end
 
+    # Set the URL for the current request (such as when using request-dependent path helpers):
+    #
+    # ```ruby
+    # with_request_url("/users/42") do
+    #   render_inline(MyComponent.new)
+    # end
+    # ```
+    #
+    # @param path [String] The path to set for the current request.
     def with_request_url(path)
       old_request_path_parameters = request.path_parameters
       old_controller = defined?(@controller) && @controller
@@ -82,6 +123,7 @@ module ViewComponent
       @controller = old_controller
     end
 
+    # @private
     def build_controller(klass)
       klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
     end

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 39
+    MINOR = 40
     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.39.0
+  version: 2.40.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-31 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -303,6 +303,7 @@ files:
 - lib/view_component/preview.rb
 - lib/view_component/preview_template_error.rb
 - lib/view_component/previewable.rb
+- lib/view_component/rails/tasks/view_component.rake
 - lib/view_component/render_component_helper.rb
 - lib/view_component/render_component_to_string_helper.rb
 - lib/view_component/render_monkey_patch.rb