view_component 3.2.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e505722b47ce320345cbb123e06e5138362a3b9abc5fe8cc77c5849a71e8baf5
-  data.tar.gz: c9f053e92c067b2743ae64d8135334518a14933710c81ad68e058d0cd076b610
+  metadata.gz: ce590ddce7011ae4362dde0733f78ba65992c31add6bac215555515d02ae1dc6
+  data.tar.gz: df4867599a61d2757e2f226a3c6b187981772e2d225fc442f9184484c0423e64
 SHA512:
-  metadata.gz: 3e3aab08e8665557c94e0f8df5c7f0f484b056bc9e0a85247a7d718cedfc3ff8aa3a2a6875fd4660626b15c0f6e002ac50797fdcce822f610ca91581afff8c9e
-  data.tar.gz: 2f25ccc3bcfefb4e3096a5c9289922b648353ba42c333ad963d59cc95f8bd1cf4d1db0f178494ad6cb4a59af6832a852b3b15f34f80dc3c2ebfa6cf78d65b445
+  metadata.gz: 0a39d71f089c0f4285dc1eecd324e44afc73f55565002a45c2d37292cc4fa8b05713f7237f04b530617ddc0bb2ccd08fab0c7d010400790dc00daf2d6c9c0546
+  data.tar.gz: 252a63a4ed7eefd7db529dc93081d3ccfb78555ac1d051540f7a69829a41d4d22fd94557fa2fe9eb88c012bd8dccfd2ceb813aae2582877e387a2df347e2d915

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

@@ -59,7 +59,7 @@ module ViewComponent
     def find_preview
       candidates = []
       params[:path].to_s.scan(%r{/|$}) { candidates << Regexp.last_match.pre_match }
-      preview = candidates.detect { |candidate| ViewComponent::Preview.exists?(candidate) }
+      preview = candidates.sort_by(&:length).reverse_each.detect { |candidate| ViewComponent::Preview.exists?(candidate) }
 
       if preview
         @preview = ViewComponent::Preview.find(preview)

data/docs/CHANGELOG.md

@@ -10,6 +10,44 @@ nav_order: 5
 
 ## main
 
+## 3.5.0
+
+* Add Skroutz to users list.
+
+    *Chris Nitsas*
+
+* Improve implementation of `#render_parent` so it respects variants and deep inheritance hierarchies.
+
+    *Cameron Dutro*
+
+* Add CharlieHR to users list.
+
+    *Alex Balhatchet*
+
+## 3.4.0
+
+* Avoid including Rails `url_helpers` into `Preview` class when they're not defined.
+
+    *Richard Macklin*
+
+* Allow instrumentation to be automatically included in Server-Timing headers generated by Rails. To enable this set the config `config.use_deprecated_instrumentation_name = false`.  The old key `!render.view_component` is deprecated: update ActiveSupport::Notification subscriptions to `render.view_component`.
+
+    *Travis Gaff*
+
+## 3.3.0
+
+* Include InlineTemplate by default in Base. **Note:** It's no longer necessary to include `ViewComponent::InlineTemplate` to use inline templates.
+
+    *Joel Hawksley*
+
+* Allow Setting host when using the `with_request_url` test helper.
+
+     *Daniel Alfaro*
+
+* Resolve ambiguous preview paths when using components without the Component suffix.
+
+     *Reed Law*
+
 ## 3.2.0
 
 * Fix viewcomponent.org Axe violations.

data/lib/view_component/base.rb

@@ -7,6 +7,7 @@ require "view_component/compile_cache"
 require "view_component/compiler"
 require "view_component/config"
 require "view_component/errors"
+require "view_component/inline_template"
 require "view_component/preview"
 require "view_component/slotable"
 require "view_component/translatable"
@@ -29,6 +30,7 @@ module ViewComponent
       attr_writer :config
     end
 
+    include ViewComponent::InlineTemplate
     include ViewComponent::Slotable
     include ViewComponent::Translatable
     include ViewComponent::WithContentHelper
@@ -114,20 +116,44 @@ module ViewComponent
     end
 
     # Subclass components that call `super` inside their template code will cause a
-    # double render if they emit the result:
+    # double render if they emit the result.
     #
     # ```erb
     # <%= super %> # double-renders
-    # <% super %> # does not double-render
+    # <% super %> # doesn't double-render
     # ```
     #
-    # Calls `super`, returning `nil` to avoid rendering the result twice.
+    # `super` also doesn't consider the current variant. `render_parent` renders the
+    # parent template considering the current variant and emits the result without
+    # double-rendering.
     def render_parent
-      mtd = @__vc_variant ? "call_#{@__vc_variant}" : "call"
-      method(mtd).super_method.call
+      render_parent_to_string
       nil
     end
 
+    # Renders the parent component to a string and returns it. This method is meant
+    # to be used inside custom #call methods when a string result is desired, eg.
+    #
+    # ```ruby
+    # def call
+    #   "<div>#{render_parent_to_string}</div>"
+    # end
+    # ```
+    #
+    # When rendering the parent inside an .erb template, use `#render_parent` instead.
+    def render_parent_to_string
+      @__vc_parent_render_level ||= 0 # ensure a good starting value
+
+      begin
+        target_render = self.class.instance_variable_get(:@__vc_ancestor_calls)[@__vc_parent_render_level]
+        @__vc_parent_render_level += 1
+
+        target_render.bind_call(self, @__vc_variant)
+      ensure
+        @__vc_parent_render_level -= 1
+      end
+    end
+
     # Optional content to be returned after the rendered template.
     #
     # @return [String]
@@ -457,6 +483,13 @@ module ViewComponent
         # Set collection parameter to the extended component
         child.with_collection_parameter provided_collection_parameter
 
+        if instance_methods(false).include?(:render_template_for)
+          vc_ancestor_calls = defined?(@__vc_ancestor_calls) ? @__vc_ancestor_calls.dup : []
+
+          vc_ancestor_calls.unshift(instance_method(:render_template_for))
+          child.instance_variable_set(:@__vc_ancestor_calls, vc_ancestor_calls)
+        end
+
         super
       end
 

data/lib/view_component/compiler.rb

@@ -56,17 +56,17 @@ module ViewComponent
           RUBY
           # rubocop:enable Style/EvalWithLocation
 
+          component_class.define_method("_call_#{safe_class_name}", component_class.instance_method(:call))
+
           component_class.silence_redefinition_of_method("render_template_for")
           component_class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def render_template_for(variant = nil)
-            call
+            _call_#{safe_class_name}
           end
           RUBY
         end
       else
         templates.each do |template|
-          # Remove existing compiled template methods,
-          # as Ruby warns when redefining a method.
           method_name = call_method_name(template[:variant])
 
           redefinition_lock.synchronize do
@@ -95,15 +95,20 @@ module ViewComponent
 
     def define_render_template_for
       variant_elsifs = variants.compact.uniq.map do |variant|
-        "elsif variant.to_sym == :'#{variant}'\n    #{call_method_name(variant)}"
+        safe_name = "_call_variant_#{normalized_variant_name(variant)}_#{safe_class_name}"
+        component_class.define_method(safe_name, component_class.instance_method(call_method_name(variant)))
+
+        "elsif variant.to_sym == :'#{variant}'\n    #{safe_name}"
       end.join("\n")
 
+      component_class.define_method("_call_#{safe_class_name}", component_class.instance_method(:call))
+
       body = <<-RUBY
         if variant.nil?
-          call
+          _call_#{safe_class_name}
         #{variant_elsifs}
         else
-          call
+          _call_#{safe_class_name}
         end
       RUBY
 
@@ -276,12 +281,17 @@ module ViewComponent
       variant.to_s.gsub("-", "__").gsub(".", "___")
     end
 
+    def safe_class_name
+      @safe_class_name ||= component_class.name.underscore.gsub("/", "__")
+    end
+
     def should_compile_superclass?
-      development? && templates.empty? && !has_inline_template? &&
-        !(
-          component_class.instance_methods(false).include?(:call) ||
-            component_class.private_instance_methods(false).include?(:call)
-        )
+      development? && templates.empty? && !has_inline_template? && !call_defined?
+    end
+
+    def call_defined?
+      component_class.instance_methods(false).include?(:call) ||
+        component_class.private_instance_methods(false).include?(:call)
     end
   end
 end

data/lib/view_component/config.rb

@@ -17,6 +17,7 @@ module ViewComponent
           preview_route: "/rails/view_components",
           show_previews_source: false,
           instrumentation_enabled: false,
+          use_deprecated_instrumentation_name: true,
           render_monkey_patch_enabled: true,
           view_component_path: "app/components",
           component_parent_class: nil,
@@ -99,6 +100,13 @@ module ViewComponent
       # Whether ActiveSupport notifications are enabled.
       # Defaults to `false`.
 
+      # @!attribute use_deprecated_instrumentation_name
+      # @return [Boolean]
+      # Whether ActiveSupport Notifications use the private name `"!render.view_component"`
+      # or are made more publicly available via `"render.view_component"`.
+      # Will default to `false` in next major version.
+      # Defaults to `true`.
+
       # @!attribute render_monkey_patch_enabled
       # @return [Boolean] Whether the #render method should be monkey patched.
       # If this is disabled, use `#render_component` or

data/lib/view_component/engine.rb

@@ -2,6 +2,7 @@
 
 require "rails"
 require "view_component/config"
+require "view_component/deprecation"
 
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
@@ -39,8 +40,14 @@ module ViewComponent
         Base.config = app.config.view_component
 
         if app.config.view_component.instrumentation_enabled.present?
-          # :nocov:
+          # :nocov: Re-executing the below in tests duplicates initializers and causes order-dependent failures.
           ViewComponent::Base.prepend(ViewComponent::Instrumentation)
+          if app.config.view_component.use_deprecated_instrumentation_name
+            ViewComponent::Deprecation.deprecation_warning(
+              "!render.view_component",
+              "Use the new instrumentation key `render.view_component` instead. See https://viewcomponent.org/guide/instrumentation.html"
+            )
+          end
           # :nocov:
         end
       end

data/lib/view_component/inline_template.rb

@@ -39,7 +39,7 @@ module ViewComponent # :nodoc:
       end
 
       def inline_template
-        @__vc_inline_template
+        @__vc_inline_template if defined?(@__vc_inline_template)
       end
 
       def inline_template_language

data/lib/view_component/instrumentation.rb

@@ -10,7 +10,7 @@ module ViewComponent # :nodoc:
 
     def render_in(view_context, &block)
       ActiveSupport::Notifications.instrument(
-        "!render.view_component",
+        notification_name,
         {
           name: self.class.name,
           identifier: self.class.identifier
@@ -19,5 +19,13 @@ module ViewComponent # :nodoc:
         super(view_context, &block)
       end
     end
+
+    private
+
+    def notification_name
+      return "!render.view_component" if ViewComponent::Base.config.use_deprecated_instrumentation_name
+
+      "render.view_component"
+    end
   end
 end

data/lib/view_component/preview.rb

@@ -4,7 +4,7 @@ require "active_support/descendants_tracker"
 
 module ViewComponent # :nodoc:
   class Preview
-    include Rails.application.routes.url_helpers
+    include Rails.application.routes.url_helpers if defined?(Rails.application.routes.url_helpers)
     include ActionView::Helpers::TagHelper
     include ActionView::Helpers::AssetTagHelper
     extend ActiveSupport::DescendantsTracker

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

@@ -4,8 +4,10 @@ task stats: "view_component:statsetup"
 
 namespace :view_component do
   task :statsetup do
+    # :nocov:
     require "rails/code_statistics"
 
     ::STATS_DIRECTORIES << ["ViewComponents", ViewComponent::Base.view_component_path]
+    # :nocov:
   end
 end

data/lib/view_component/test_helpers.rb

@@ -155,8 +155,18 @@ module ViewComponent
     # end
     # ```
     #
+    # To use a specific host, pass the host param:
+    #
+    # ```ruby
+    # with_request_url("/users/42", host: "app.example.com") do
+    #   render_inline(MyComponent.new)
+    # end
+    # ```
+    #
     # @param path [String] The path to set for the current request.
-    def with_request_url(path)
+    # @param host [String] The host to set for the current request.
+    def with_request_url(path, host: nil)
+      old_request_host = vc_test_request.host
       old_request_path_info = vc_test_request.path_info
       old_request_path_parameters = vc_test_request.path_parameters
       old_request_query_parameters = vc_test_request.query_parameters
@@ -164,12 +174,14 @@ module ViewComponent
       old_controller = defined?(@vc_test_controller) && @vc_test_controller
 
       path, query = path.split("?", 2)
+      vc_test_request.host = host if host
       vc_test_request.path_info = path
       vc_test_request.path_parameters = Rails.application.routes.recognize_path_with_request(vc_test_request, path, {})
       vc_test_request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_nested_query(query))
       vc_test_request.set_header(Rack::QUERY_STRING, query)
       yield
     ensure
+      vc_test_request.host = old_request_host
       vc_test_request.path_info = old_request_path_info
       vc_test_request.path_parameters = old_request_path_parameters
       vc_test_request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 3
-    MINOR = 2
+    MINOR = 5
     PATCH = 0
     PRE = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.5.0
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-12 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport