view_component 4.0.0.alpha3 → 4.0.0.alpha5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d926054ff51767aa08c688eef809327cbbda35e8b403a574af8baa642aefe7ed
-  data.tar.gz: ed0a01b7b1fe98080c4c7210c7bdde4b474d08f4b0c5ab0a36c39e9e6631f185
+  metadata.gz: 544de384800ad5d0870666b9b1fdb3a74da9fd59d77f78e0d72ee5e134a3c307
+  data.tar.gz: 430c3652f5abc6fef9815b937274f66ebac34de297318e1ca6839589fa290ddf
 SHA512:
-  metadata.gz: 54aa90e88b7fb9f0773842f0737739c15cfaff4609f62fe733badd14ab8676ec21532c5d00915947ce183aca678f7ed79573f15e8dec06f873067a9585a277ab
-  data.tar.gz: 3c4187ccc4f70942964fedd232fb387314e5f7cfa47624df5def3006ff9478947d4de9380c0baf29b5102e20217de0eb77a9bfe8a21240a79065cb719d02bf94
+  metadata.gz: f30651af979f6c1c5fd43514d04cef3f6430982198e593375d61ce79190e83b8b2d61d7cccb67607248f0b791346b09db33b4705e81cb257b87bd8255c5b2d63
+  data.tar.gz: 956af9c486961785821e9401c9c1ce6b187f3f21a0425d5d6d36602f384f3beb79629f9be2e743e13f525bdc15498480565989cbdb37952a7b0e1cbb2aaabbb0

data/docs/CHANGELOG.md

@@ -10,6 +10,34 @@ nav_order: 6
 
 ## main
 
+## 4.0.0.alpha5
+
+* BREAKING: `config.view_component_path` is now `config.generate.path`, as components have long since been able to exist in any directory.
+
+    *Joel Hawksley*
+
+* BREAKING: Remove broken integration with `rails stats` that ignored components outside of `app/components`.
+
+    *Joel Hawksley*
+
+* Add internal optimization for Ruby object shapes.
+
+    *Adam Hess*, *Joel Hawksley*
+
+## 4.0.0.alpha4
+
+* BREAKING: Remove default initializer from `ViewComponent::Base`. Previously, `ViewComponent::Base` defined a catch-all initializer that allowed components without an initializer defined to be passed arbitrary arguments.
+
+    *Joel Hawksley*
+
+* Graduate `SlotableDefault` to be included by default.
+
+    *Joel Hawksley*
+
+* Fix bug in `SlotableDefault` where default couldn't be overridden when content was passed as a block.
+
+    *Bill Watts*, *Joel Hawksley*
+
 ## 4.0.0.alpha3
 
 * BREAKING: Remove dependency on `ActionView::Base`, eliminating the need for capture compatibility patch.

data/lib/view_component/base.rb

@@ -12,7 +12,6 @@ require "view_component/inline_template"
 require "view_component/preview"
 require "view_component/request_details"
 require "view_component/slotable"
-require "view_component/slotable_default"
 require "view_component/template"
 require "view_component/translatable"
 require "view_component/with_content_helper"
@@ -36,18 +35,51 @@ module ViewComponent
     class << self
       delegate(*ViewComponent::Config.defaults.keys, to: :config)
 
+      # Redefine `new` so we can pre-allocate instance variables to optimize
+      # for Ruby object shapes.
+      def new(...)
+        instance = allocate
+        instance.__vc_pre_allocate_instance_variables
+        instance.send(:initialize, ...)
+        instance
+      end
+
       # Returns the current config.
       #
       # @return [ActiveSupport::OrderedOptions]
       def config
-        module_parents.each do |m|
-          config = m.try(:config).try(:view_component)
-          return config if config
+        module_parents.each do |module_parent|
+          next unless module_parent.respond_to?(:config)
+          module_parent_config = module_parent.config.try(:view_component)
+          return module_parent_config if module_parent_config
         end
         ViewComponent::Config.current
       end
     end
 
+    def __vc_pre_allocate_instance_variables
+      @__vc_parent_render_level = 0
+      @__vc_set_slots = {}
+      @__vc_content_evaluated = false
+      @current_template = nil
+      @output_buffer = nil
+      @lookup_context = nil
+      @view_flow = nil
+      @view_context = nil
+      @virtual_path = nil
+      @__vc_ancestor_calls = nil
+      @__vc_controller = nil
+      @__vc_content = :unset # some behaviors depend on checking for nil
+      @__vc_content_set_by_with_content = nil
+      @__vc_helpers = nil
+      @__vc_inline_template = nil
+      @__vc_inline_template_defined = nil
+      @__vc_render_in_block = nil
+      @__vc_request = nil
+      @__vc_requested_details = nil
+      @__vc_original_view_context = nil
+    end
+
     include ActionView::Helpers
     include ERB::Escape
     include ActiveSupport::CoreExt::ERBUtil
@@ -114,14 +146,12 @@ module ViewComponent
       @__vc_requested_details ||= @lookup_context.vc_requested_details
 
       # For caching, such as #cache_if
-      @current_template = nil unless defined?(@current_template)
       old_current_template = @current_template
 
-      if block && defined?(@__vc_content_set_by_with_content)
+      if block && __vc_content_set_by_with_content?
         raise DuplicateContentError.new(self.class.name)
       end
 
-      @__vc_content_evaluated = false
       @__vc_render_in_block = block
 
       before_render
@@ -175,16 +205,12 @@ module ViewComponent
     #
     # 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 = self.class.instance_variable_get(:@__vc_ancestor_calls)[@__vc_parent_render_level]
+      @__vc_parent_render_level += 1
 
-        target_render.bind_call(self, @__vc_requested_details)
-      ensure
-        @__vc_parent_render_level -= 1
-      end
+      target_render.bind_call(self, @__vc_requested_details)
+    ensure
+      @__vc_parent_render_level -= 1
     end
 
     # Optional content to be returned before the rendered template.
@@ -216,12 +242,6 @@ module ViewComponent
       true
     end
 
-    # Override the ActionView::Base initializer so that components
-    # do not need to define their own initializers.
-    # @private
-    def initialize(*)
-    end
-
     # Re-use original view_context if we're not rendering a component.
     #
     # This prevents an exception when rendering a partial inside of a component that has also been rendered outside
@@ -274,7 +294,7 @@ module ViewComponent
         raise e, <<~MESSAGE.chomp if view_context && e.is_a?(NameError) && helpers.respond_to?(method_name)
           #{e.message}
 
-          You may be trying to call a method provided as a view helper. Did you mean `helpers.#{method_name}'?
+          You may be trying to call a method provided as a view helper. Did you mean `helpers.#{method_name}`?
         MESSAGE
 
         raise
@@ -313,12 +333,12 @@ module ViewComponent
     # @return [String]
     def content
       @__vc_content_evaluated = true
-      return @__vc_content if defined?(@__vc_content)
+      return @__vc_content if @__vc_content != :unset
 
       @__vc_content =
         if __vc_render_in_block_provided?
           view_context.capture(self, &@__vc_render_in_block)
-        elsif __vc_content_set_by_with_content_defined?
+        elsif __vc_content_set_by_with_content?
           @__vc_content_set_by_with_content
         end
     end
@@ -327,7 +347,7 @@ module ViewComponent
     #
     # @return [Boolean]
     def content?
-      __vc_render_in_block_provided? || __vc_content_set_by_with_content_defined?
+      __vc_render_in_block_provided? || __vc_content_set_by_with_content?
     end
 
     private
@@ -335,15 +355,15 @@ module ViewComponent
     attr_reader :view_context
 
     def __vc_render_in_block_provided?
-      defined?(@view_context) && @view_context && @__vc_render_in_block
+      @view_context && @__vc_render_in_block
     end
 
-    def __vc_content_set_by_with_content_defined?
-      defined?(@__vc_content_set_by_with_content)
+    def __vc_content_set_by_with_content?
+      !@__vc_content_set_by_with_content.nil?
     end
 
     def content_evaluated?
-      defined?(@__vc_content_evaluated) && @__vc_content_evaluated
+      @__vc_content_evaluated
     end
 
     def maybe_escape_html(text)
@@ -380,15 +400,6 @@ module ViewComponent
     # configured on a per-test basis using `with_controller_class`.
     #
 
-    # Path for component files
-    #
-    # ```ruby
-    # config.view_component.view_component_path = "app/my_components"
-    # ```
-    #
-    # Defaults to `nil`. If this is falsy, `app/components` is used.
-    #
-
     # Parent class for generated components
     #
     # ```ruby
@@ -558,19 +569,13 @@ module ViewComponent
         # We use `base_label` method here instead of `label` to avoid cases where the method
         # owner is included in a prefix like `ApplicationComponent.inherited`.
         child.identifier = caller_locations(1, 10).reject { |l| l.base_label == "inherited" }[0].path
-
-        # If Rails application is loaded, removes the first part of the path and the extension.
-        if defined?(Rails) && Rails.application
-          child.virtual_path = child.identifier.gsub(
-            /(.*#{Regexp.quote(ViewComponent::Base.config.view_component_path)})|(\.rb)/, ""
-          )
-        end
+        child.virtual_path = child.name&.underscore
 
         # 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 = (!@__vc_ancestor_calls.nil?) ? @__vc_ancestor_calls.dup : []
 
           vc_ancestor_calls.unshift(instance_method(:render_template_for))
           child.instance_variable_set(:@__vc_ancestor_calls, vc_ancestor_calls)

data/lib/view_component/config.rb

@@ -16,7 +16,6 @@ module ViewComponent
           preview_controller: "ViewComponentsController",
           preview_route: "/rails/view_components",
           instrumentation_enabled: false,
-          view_component_path: "app/components",
           component_parent_class: nil,
           show_previews: Rails.env.development? || Rails.env.test?,
           preview_paths: default_preview_paths,
@@ -32,6 +31,12 @@ module ViewComponent
       # All options under this namespace default to `false` unless otherwise
       # stated.
       #
+      # #### `#path`
+      #
+      # Where to put generated components. Defaults to `app/components`:
+      #
+      #     config.view_component.generate.path = "lib/components"
+      #
       # #### `#sidecar`
       #
       # Always generate a component with a sidecar directory:
@@ -84,14 +89,14 @@ module ViewComponent
       #
       # #### `#use_component_path_for_rspec_tests`
       #
-      # Whether to use the `config.view_component_path` when generating new
+      # Whether to use `config.generate.path` when generating new
       # RSpec component tests:
       #
       #     config.view_component.generate.use_component_path_for_rspec_tests = true
       #
-      # When set to `true`, the generator will use the `view_component_path` to
+      # When set to `true`, the generator will use the `path` to
       # decide where to generate the new RSpec component test.
-      # For example, if the `view_component_path` is
+      # For example, if the `path` is
       # `app/views/components`, then the generator will create a new spec file
       # in `spec/views/components/` rather than the default `spec/components/`.
 
@@ -110,12 +115,6 @@ module ViewComponent
       # Whether ActiveSupport notifications are enabled.
       # Defaults to `false`.
 
-      # @!attribute view_component_path
-      # @return [String]
-      # The path in which components, their templates, and their sidecars should
-      # be stored.
-      # Defaults to `"app/components"`.
-
       # @!attribute component_parent_class
       # @return [String]
       # The parent class from which generated components will inherit.
@@ -171,6 +170,7 @@ module ViewComponent
       def default_generate_options
         options = ActiveSupport::OrderedOptions.new(false)
         options.preview_path = ""
+        options.path = "app/components"
         options
       end
     end

data/lib/view_component/engine.rb

@@ -8,24 +8,6 @@ module ViewComponent
   class Engine < Rails::Engine # :nodoc:
     config.view_component = ViewComponent::Config.current
 
-    if Rails.version.to_f < 8.0
-      rake_tasks do
-        load "view_component/rails/tasks/view_component.rake"
-      end
-    else
-      initializer "view_component.stats_directories" do |app|
-        require "rails/code_statistics"
-
-        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
-
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
 

data/lib/view_component/inline_template.rb

@@ -9,7 +9,7 @@ module ViewComponent # :nodoc:
       def method_missing(method, *args)
         return super if !method.end_with?("_template")
 
-        if defined?(@__vc_inline_template_defined) && @__vc_inline_template_defined
+        if @__vc_inline_template_defined
           raise MultipleInlineTemplatesError
         end
 
@@ -38,11 +38,11 @@ module ViewComponent # :nodoc:
       end
 
       def inline_template
-        @__vc_inline_template if defined?(@__vc_inline_template)
+        @__vc_inline_template
       end
 
       def __vc_inline_template_language
-        @__vc_inline_template_language if defined?(@__vc_inline_template_language)
+        @__vc_inline_template_language
       end
 
       def inherited(subclass)

data/lib/view_component/slot.rb

@@ -9,13 +9,18 @@ module ViewComponent
     attr_writer :__vc_component_instance, :__vc_content_block, :__vc_content
 
     def initialize(parent)
+      @content = nil
+      @__vc_component_instance = nil
+      @__vc_content = nil
+      @__vc_content_block = nil
+      @__vc_content_set_by_with_content = nil
       @parent = parent
     end
 
     def content?
-      return true if defined?(@__vc_content) && @__vc_content.present?
-      return true if defined?(@__vc_content_set_by_with_content) && @__vc_content_set_by_with_content.present?
-      return true if defined?(@__vc_content_block) && @__vc_content_block.present?
+      return true if @__vc_content.present?
+      return true if @__vc_content_set_by_with_content.present?
+      return true if @__vc_content_block.present?
       return false if !__vc_component_instance?
 
       @__vc_component_instance.content?
@@ -43,11 +48,11 @@ module ViewComponent
     # If there is no slot renderable, we evaluate the block passed to
     # the slot and return it.
     def to_s
-      return @content if defined?(@content)
+      return @content if !@content.nil?
 
       view_context = @parent.send(:view_context)
 
-      if defined?(@__vc_content_block) && defined?(@__vc_content_set_by_with_content)
+      if !@__vc_content_block.nil? && !@__vc_content_set_by_with_content.nil? && !@__vc_content_set_by_with_content.nil?
         raise DuplicateSlotContentError.new(self.class.name)
       end
 
@@ -55,7 +60,7 @@ module ViewComponent
         if __vc_component_instance?
           @__vc_component_instance.__vc_original_view_context = @parent.__vc_original_view_context
 
-          if defined?(@__vc_content_block)
+          if !@__vc_content_block.nil?
             # render_in is faster than `parent.render`
             @__vc_component_instance.render_in(view_context) do |*args|
               @__vc_content_block.call(*args)
@@ -63,11 +68,11 @@ module ViewComponent
           else
             @__vc_component_instance.render_in(view_context)
           end
-        elsif defined?(@__vc_content)
+        elsif !@__vc_content.nil?
           @__vc_content
-        elsif defined?(@__vc_content_block)
+        elsif !@__vc_content_block.nil?
           view_context.capture(&@__vc_content_block)
-        elsif defined?(@__vc_content_set_by_with_content)
+        elsif !@__vc_content_set_by_with_content.nil?
           @__vc_content_set_by_with_content
         end
 
@@ -108,7 +113,7 @@ module ViewComponent
     private
 
     def __vc_component_instance?
-      defined?(@__vc_component_instance)
+      !@__vc_component_instance.nil?
     end
   end
 end

data/lib/view_component/slotable.rb

@@ -351,16 +351,26 @@ module ViewComponent
     end
 
     def get_slot(slot_name)
+      @__vc_set_slots ||= {}
       content unless content_evaluated? # ensure content is loaded so slots will be defined
 
-      slot = self.class.registered_slots[slot_name]
-      @__vc_set_slots ||= {}
+      # If the slot is set, return it
+      return @__vc_set_slots[slot_name] if @__vc_set_slots[slot_name]
 
-      if @__vc_set_slots[slot_name]
-        return @__vc_set_slots[slot_name]
-      end
+      # If there is a default method for the slot, call it
+      if (default_method = registered_slots[slot_name][:default_method])
+        renderable_value = send(default_method)
+        slot = Slot.new(self)
+
+        if renderable_value.respond_to?(:render_in)
+          slot.__vc_component_instance = renderable_value
+        else
+          slot.__vc_content = renderable_value
+        end
 
-      if slot[:collection]
+        slot
+      elsif self.class.registered_slots[slot_name][:collection]
+        # If empty slot is a collection, return an empty array
         []
       end
     end
@@ -410,8 +420,6 @@ module ViewComponent
         end
       end
 
-      @__vc_set_slots ||= {}
-
       if slot_definition[:collection]
         @__vc_set_slots[slot_name] ||= []
         @__vc_set_slots[slot_name].push(slot)
@@ -425,7 +433,7 @@ module ViewComponent
     def set_polymorphic_slot(slot_name, poly_type = nil, *args, **kwargs, &block)
       slot_definition = self.class.registered_slots[slot_name]
 
-      if !slot_definition[:collection] && defined?(@__vc_set_slots) && @__vc_set_slots[slot_name]
+      if !slot_definition[:collection] && @__vc_set_slots[slot_name]
         raise ContentAlreadySetForPolymorphicSlotError.new(slot_name)
       end
 

data/lib/view_component/slotable_default.rb

@@ -1,8 +1,6 @@
 module ViewComponent
   module SlotableDefault
     def get_slot(slot_name)
-      @__vc_set_slots ||= {}
-
       return super unless !@__vc_set_slots[slot_name] && (default_method = registered_slots[slot_name][:default_method])
 
       renderable_value = send(default_method)

data/lib/view_component/version.rb

@@ -5,7 +5,7 @@ module ViewComponent
     MAJOR = 4
     MINOR = 0
     PATCH = 0
-    PRE = "alpha3"
+    PRE = "alpha5"
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 4.0.0.alpha3
+  version: 4.0.0.alpha5
 platform: ruby
 authors:
 - ViewComponent Team