view_component 3.17.0 → 3.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f95cb571165fe8ad9d61f6236c5104ca6b9becec9c45e1f5bbb93f2e8bad487
-  data.tar.gz: 2f547097278242f1b1c945341b0cbcefd455ce93d2ed61145209f92a7acd5c2b
+  metadata.gz: 0be77c737ede73cbe4b576fe19f6d4afd6f1c1cc61cea7a1f61f1a18e98f83a3
+  data.tar.gz: 1b97ac4a9b78e0784e9258f8104cea39b25e12533cb9037c451cacb545da85ea
 SHA512:
-  metadata.gz: 51f0cbc8e8794c383cc2bbb97736e7be0da272c340c94ef9cf3927dd4526b58f73566aec5e1e37f0ee2a302fb99f0fec9a7f058620e6c051339db83426c8c852
-  data.tar.gz: 8484fa046329adf95fd78946ad5ce4b1ab647d9f6e7546da4bee02fe56fb74f25b8ad35cffee4afdae726d99832ebbcfae47a056603c6cfa1c9df7ef1e6476f4
+  metadata.gz: 504c9c261f6921980feae7a7d2ec2cfb7676fca87800113d33eac5a2bdf4c4e12e82002144880270118f77eb30853a7d328a171a37ffdcf0efb706eda554bf33
+  data.tar.gz: 751f433ec0bf34e9737b70a6e3394d5e24e869781c5aa104921d4635467281d3ac33bcfeb8c40280a19873f897fda6a074a8842edfb4798a926fbe4a2e00851b

data/docs/CHANGELOG.md

@@ -10,6 +10,32 @@ nav_order: 5
 
 ## main
 
+## 3.18.0
+
+* Enable components to use `@request` and `request` methods/ivars.
+
+    *Blake Williams*
+
+* Fix bug where implicit locales in component filenames threw a `NameError`.
+
+    *Chloe Fons*
+
+* Register ViewComponent tests directory for `rails stats`.
+
+    *Javier Aranda*
+
+* Wrap entire compile step in a mutex to make it more resilient to race conditions.
+
+    *Blake Williams*
+
+* Add [Niva]([niva.co](https://www.niva.co/)) to companies who use `ViewComponent`.
+
+    *Daniel Vu Dao*
+
+* Fix `preview_paths` in docs.
+
+    *Javier Aranda*
+
 ## 3.17.0
 
 * Use struct instead openstruct in lib code.
@@ -28,12 +54,12 @@ nav_order: 5
 
     *Alberto Rocha*
 
-## 3.16.0
-
 * Fix development mode race condition that caused an invalid duplicate template error.
 
     *Blake Williams*
 
+## 3.16.0
+
 * Add template information to multiple template error messages.
 
     *Joel Hawksley*

data/lib/view_component/base.rb

@@ -109,10 +109,10 @@ module ViewComponent
 
       if render?
         rendered_template =
-          if compiler.renders_template_for?(@__vc_variant, request&.format&.to_sym)
-            render_template_for(@__vc_variant, request&.format&.to_sym)
+          if compiler.renders_template_for?(@__vc_variant, __vc_request&.format&.to_sym)
+            render_template_for(@__vc_variant, __vc_request&.format&.to_sym)
           else
-            maybe_escape_html(render_template_for(@__vc_variant, request&.format&.to_sym)) do
+            maybe_escape_html(render_template_for(@__vc_variant, __vc_request&.format&.to_sym)) do
               Kernel.warn("WARNING: The #{self.class} component rendered HTML-unsafe output. The output will be automatically escaped, but you may want to investigate.")
             end
           end.to_s
@@ -286,7 +286,14 @@ module ViewComponent
     #
     # @return [ActionDispatch::Request]
     def request
-      @request ||= controller.request if controller.respond_to?(:request)
+      __vc_request
+    end
+
+    # Enables consumers to override request/@request
+    #
+    # @private
+    def __vc_request
+      @__vc_request ||= controller.request if controller.respond_to?(:request)
     end
 
     # The content passed to the component instance as a block.
@@ -328,7 +335,7 @@ module ViewComponent
     end
 
     def maybe_escape_html(text)
-      return text if request && !request.format.html?
+      return text if __vc_request && !__vc_request.format.html?
       return text if text.blank?
 
       if text.html_safe?

data/lib/view_component/compiler.rb

@@ -12,7 +12,7 @@ module ViewComponent
 
     def initialize(component)
       @component = component
-      @redefinition_lock = Mutex.new
+      @lock = Mutex.new
       @rendered_templates = Set.new
     end
 
@@ -24,30 +24,36 @@ module ViewComponent
       return if compiled? && !force
       return if @component == ViewComponent::Base
 
-      gather_templates
+      @lock.synchronize do
+        # this check is duplicated so that concurrent compile calls can still
+        # early exit
+        return if compiled? && !force
 
-      if self.class.development_mode && @templates.any?(&:requires_compiled_superclass?)
-        @component.superclass.compile(raise_errors: raise_errors)
-      end
+        gather_templates
 
-      if template_errors.present?
-        raise TemplateError.new(template_errors) if raise_errors
+        if self.class.development_mode && @templates.any?(&:requires_compiled_superclass?)
+          @component.superclass.compile(raise_errors: raise_errors)
+        end
 
-        # this return is load bearing, and prevents the component from being considered "compiled?"
-        return false
-      end
+        if template_errors.present?
+          raise TemplateError.new(template_errors) if raise_errors
 
-      if raise_errors
-        @component.validate_initialization_parameters!
-        @component.validate_collection_parameter!
-      end
+          # this return is load bearing, and prevents the component from being considered "compiled?"
+          return false
+        end
 
-      define_render_template_for
+        if raise_errors
+          @component.validate_initialization_parameters!
+          @component.validate_collection_parameter!
+        end
+
+        define_render_template_for
 
-      @component.register_default_slots
-      @component.build_i18n_backend
+        @component.register_default_slots
+        @component.build_i18n_backend
 
-      CompileCache.register(@component)
+        CompileCache.register(@component)
+      end
     end
 
     def renders_template_for?(variant, format)
@@ -60,9 +66,7 @@ module ViewComponent
 
     def define_render_template_for
       @templates.each do |template|
-        @redefinition_lock.synchronize do
-          template.compile_to_component
-        end
+        template.compile_to_component
       end
 
       method_body =
@@ -93,14 +97,12 @@ module ViewComponent
           out << "else\n  #{templates.find { _1.variant.nil? && _1.default_format? }.safe_method_name}\nend"
         end
 
-      @redefinition_lock.synchronize do
-        @component.silence_redefinition_of_method(:render_template_for)
-        @component.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def render_template_for(variant = nil, format = nil)
-          #{method_body}
-        end
-        RUBY
+      @component.silence_redefinition_of_method(:render_template_for)
+      @component.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def render_template_for(variant = nil, format = nil)
+        #{method_body}
       end
+      RUBY
     end
 
     def template_errors
@@ -190,7 +192,7 @@ module ViewComponent
               path: path,
               lineno: 0,
               extension: path.split(".").last,
-              this_format: this_format,
+              this_format: this_format.to_s.split(".").last&.to_sym, # strip locale from this_format, see #2113
               variant: variant
             )
 

data/lib/view_component/config.rb

@@ -152,7 +152,7 @@ module ViewComponent
       # @!attribute preview_paths
       # @return [Array<String>]
       # The locations in which component previews will be looked up.
-      # Defaults to `['test/component/previews']` relative to your Rails root.
+      # Defaults to `['test/components/previews']` relative to your Rails root.
 
       # @!attribute test_controller
       # @return [String]

data/lib/view_component/engine.rb

@@ -15,8 +15,14 @@ module ViewComponent
     else
       initializer "view_component.stats_directories" do |app|
         require "rails/code_statistics"
-        dir = ViewComponent::Base.view_component_path
-        Rails::CodeStatistics.register_directory("ViewComponents", dir)
+
+        if Rails.root.join(ViewComponent::Base.view_component_path).directory?
+          Rails::CodeStatistics.register_directory("ViewComponents", ViewComponent::Base.view_component_path)
+        end
+
+        if Rails.root.join("test/components").directory?
+          Rails::CodeStatistics.register_directory("ViewComponent tests", "test/components", test_directory: true)
+        end
       end
     end
 

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

@@ -7,8 +7,14 @@ namespace :view_component do
     # :nocov:
     require "rails/code_statistics"
 
-    dir = ViewComponent::Base.view_component_path
-    ::STATS_DIRECTORIES << ["ViewComponents", dir] if File.directory?(Rails.root + dir)
+    if Rails.root.join(ViewComponent::Base.view_component_path).directory?
+      ::STATS_DIRECTORIES << ["ViewComponents", ViewComponent::Base.view_component_path]
+    end
+
+    if Rails.root.join("test/components").directory?
+      ::STATS_DIRECTORIES << ["ViewComponent tests", "test/components"]
+      CodeStatistics::TEST_TYPES << "ViewComponent tests"
+    end
     # :nocov:
   end
 end

data/lib/view_component/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 3.17.0
+  version: 3.18.0
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-08 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport