Merge pull request #2354 from ViewComponent/v4-var-rename

Rename more methods and variables to avoid collisions with consumers

Author: joelhawksley

lib/view_component.rb

@@ -7,19 +7,21 @@ module ViewComponent
   extend ActiveSupport::Autoload
 
   autoload :Base
-  autoload :CaptureCompatibility
   autoload :Compiler
   autoload :CompileCache
   autoload :Config
   autoload :Deprecation
   autoload :InlineTemplate
   autoload :Instrumentation
   autoload :Preview
-  autoload :TestHelpers
-  autoload :SystemTestHelpers
-  autoload :TestCase
-  autoload :SystemTestCase
   autoload :Translatable
+
+  if Rails.env.test?
+    autoload :TestHelpers
+    autoload :SystemTestHelpers
+    autoload :TestCase
+    autoload :SystemTestCase
+  end
 end
 
 require "view_component/engine" if defined?(Rails::Engine)

lib/view_component/base.rb

@@ -146,7 +146,7 @@ def render_in(view_context, &block)
           value = if output_preamble.blank? && output_postamble.blank?
             rendered_template
           else
-            safe_output_preamble + rendered_template + safe_output_postamble
+            __vc_safe_output_preamble + rendered_template + __vc_safe_output_postamble
           end
         end
 
@@ -355,11 +355,7 @@ def __vc_content_set_by_with_content_defined?
       defined?(@__vc_content_set_by_with_content)
     end
 
-    def content_evaluated?
-      defined?(@__vc_content_evaluated) && @__vc_content_evaluated
-    end
-
-    def maybe_escape_html(text)
+    def __vc_maybe_escape_html(text)
       return text if @current_template && !@current_template.html?
       return text if text.blank?
 
@@ -371,14 +367,14 @@ def maybe_escape_html(text)
       end
     end
 
-    def safe_output_preamble
-      maybe_escape_html(output_preamble) do
+    def __vc_safe_output_preamble
+      __vc_maybe_escape_html(output_preamble) do
         Kernel.warn("WARNING: The #{self.class} component was provided an HTML-unsafe preamble. The preamble will be automatically escaped, but you may want to investigate.")
       end
     end
 
-    def safe_output_postamble
-      maybe_escape_html(output_postamble) do
+    def __vc_safe_output_postamble
+      __vc_maybe_escape_html(output_postamble) do
         Kernel.warn("WARNING: The #{self.class} component was provided an HTML-unsafe postamble. The postamble will be automatically escaped, but you may want to investigate.")
       end
     end
@@ -556,7 +552,7 @@ def render_template_for(requested_details)
         child.virtual_path = child.name&.underscore
 
         # Set collection parameter to the extended component
-        child.with_collection_parameter provided_collection_parameter
+        child.with_collection_parameter(__vc_provided_collection_parameter)
 
         if instance_methods(false).include?(:render_template_for)
           vc_ancestor_calls = defined?(@__vc_ancestor_calls) ? @__vc_ancestor_calls.dup : []
@@ -591,8 +587,8 @@ def __vc_compiler
       #
       # @param parameter [Symbol] The parameter name used when rendering elements of a collection.
       def with_collection_parameter(parameter)
-        @provided_collection_parameter = parameter
-        @initialize_parameters = nil
+        @__vc_provided_collection_parameter = parameter
+        @__vc_initialize_parameters = nil
       end
 
       # Strips trailing whitespace from templates before compiling them.
@@ -622,10 +618,10 @@ def strip_trailing_whitespace?
       # rendering is optional.
       # @private
       def __vc_validate_collection_parameter!(validate_default: false)
-        parameter = validate_default ? __vc_collection_parameter : provided_collection_parameter
+        parameter = validate_default ? __vc_collection_parameter : __vc_provided_collection_parameter
 
         return unless parameter
-        return if __vc_initialize_parameter_names.include?(parameter) || splatted_keyword_argument_present?
+        return if __vc_initialize_parameter_names.include?(parameter) || __vc_splatted_keyword_argument_present?
 
         raise MissingCollectionArgumentError.new(name, parameter)
       end
@@ -642,7 +638,7 @@ def __vc_validate_initialization_parameters!
 
       # @private
       def __vc_collection_parameter
-        @provided_collection_parameter ||= name && name.demodulize.underscore.chomp("_component").to_sym
+        @__vc_provided_collection_parameter ||= name && name.demodulize.underscore.chomp("_component").to_sym
       end
 
       # @private
@@ -667,25 +663,25 @@ def __vc_iteration_argument_present?
 
       private
 
-      def splatted_keyword_argument_present?
-        initialize_parameters.flatten.include?(:keyrest)
+      def __vc_splatted_keyword_argument_present?
+        __vc_initialize_parameters.flatten.include?(:keyrest)
       end
 
       def __vc_initialize_parameter_names
         @__vc_initialize_parameter_names ||=
           if respond_to?(:attribute_names)
             attribute_names.map(&:to_sym)
           else
-            initialize_parameters.map(&:last)
+            __vc_initialize_parameters.map(&:last)
           end
       end
 
-      def initialize_parameters
-        @initialize_parameters ||= instance_method(:initialize).parameters
+      def __vc_initialize_parameters
+        @__vc_initialize_parameters ||= instance_method(:initialize).parameters
       end
 
-      def provided_collection_parameter
-        @provided_collection_parameter ||= nil
+      def __vc_provided_collection_parameter
+        @__vc_provided_collection_parameter ||= nil
       end
     end
 

lib/view_component/compiler.rb

@@ -57,7 +57,7 @@ def compile(raise_errors: false, force: false)
         unique_formats = templates.map(&:format).uniq
         @component.__vc_response_format = unique_formats.last if unique_formats.one?
 
-        @component.register_default_slots
+        @component.__vc_register_default_slots
         @component.__vc_build_i18n_backend
 
         CompileCache.register(@component)
@@ -177,10 +177,10 @@ def template_errors
 
     def gather_templates
       @templates ||=
-        if @component.inline_template.present?
+        if @component.__vc_inline_template.present?
           [Template::Inline.new(
             component: @component,
-            inline_template: @component.inline_template
+            inline_template: @component.__vc_inline_template
           )]
         else
           path_parser = ActionView::Resolver::PathParser.new

lib/view_component/inline_template.rb

@@ -37,7 +37,7 @@ def respond_to_missing?(method, include_all = false)
         method.end_with?("_template") || super
       end
 
-      def inline_template
+      def __vc_inline_template
         @__vc_inline_template if defined?(@__vc_inline_template)
       end