view_component 3.0.0.rc5 → 3.0.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3746041e156447e727a9974ad435795bd08333c13f6004ba5a03f629764d301d
-  data.tar.gz: 47e3d85474b5cb69fbc12abb48a59a85776f14475508ff55f40f672f393bd309
+  metadata.gz: d82093cc048c5af21538ee6ec01aa2ef474b71b97d2cae0fd02413f036b97616
+  data.tar.gz: 376d3bf8597d3eccd871ab9f8f1fa71a55f9564e44f7fcf920115c50e89b6224
 SHA512:
-  metadata.gz: cc5edccc814c845eb63ce951e621365ec9ec3013363b32b0bc5f05db8a0fb15ea26688eae22f54fcc17bbc477c5e93350cd0b3fbf3af9bd1e27f1f3f9e53cbec
-  data.tar.gz: d87a2ee301acf5b4e67ec159bc3433ce2d46da343de5da26af975314b862b4befbfdd247a0046239b99bb322e26b4062625073424ba0fd7e54a1e973a2d56ebd
+  metadata.gz: e410d228fd97a8007d50f7a4bfc262c20481ac3e1279f7e2cfada131fb475ca65991e99a2af6ee059c16dea38913974c72aca62d1d4c1d4530dcce8c13159721
+  data.tar.gz: 1d7bccb010f977dde4435af3aab5c4df57af2157684b924dea54b43b788d3624d1a914e15602f138184d9c222e9a43c80c2088c95b34269a8d994ec6eb5058c7

data/app/controllers/view_components_system_test_controller.rb

@@ -15,7 +15,7 @@ class ViewComponentsSystemTestController < ActionController::Base # :nodoc:
   private
 
   def validate_test_env
-    raise "ViewComponentsSystemTestController must only be called in a test environment" unless Rails.env.test?
+    raise ViewComponent::SystemTestControllerOnlyAllowedInTestError unless Rails.env.test?
   end
 
   # Ensure that the file path is valid and doesn't target files outside
@@ -24,7 +24,7 @@ class ViewComponentsSystemTestController < ActionController::Base # :nodoc:
     base_path = ::File.realpath(self.class.temp_dir)
     @path = ::File.realpath(params.permit(:file)[:file], base_path)
     unless @path.start_with?(base_path)
-      raise ArgumentError, "Invalid file path"
+      raise ViewComponent::SystemTestControllerNefariousPathError
     end
   end
 end

data/app/helpers/preview_helper.rb

@@ -31,10 +31,8 @@ module PreviewHelper
         path =~ /#{template_identifier}*.(html)/
       end
 
-      # In-case of a conflict due to multiple template files with
-      # the same name
-      raise "found 0 matches for templates for #{template_identifier}." if matching_templates.empty?
-      raise "found multiple templates for #{template_identifier}." if matching_templates.size > 1
+      raise ViewComponent::NoMatchingTemplatesForPreviewError.new(template_identifier) if matching_templates.empty?
+      raise ViewComponent::MultipleMatchingTemplatesForPreviewError.new(template_identifier) if matching_templates.size > 1
 
       template_file_path = matching_templates.first
       template_source = File.read(template_file_path)

data/docs/CHANGELOG.md

@@ -10,13 +10,63 @@ nav_order: 5
 
 ## main
 
+### v3.0.0.rc6
+
+Run into an issue with this release candidate? [Let us know](https://github.com/ViewComponent/view_component/issues/1629). We hope to release v3.0.0 in the near future!
+
+* BREAKING: `#SLOT_NAME` getter no longer accepts arguments. This change was missed as part of the earlier deprecation in `3.0.0.rc1`.
+
+    *Joel Hawksley*
+
+* BREAKING: Raise `TranslateCalledBeforeRenderError`, `ControllerCalledBeforeRenderError`, or `HelpersCalledBeforeRenderError` instead of `ViewContextCalledBeforeRenderError`.
+
+    *Joel Hawksley*
+
+* BREAKING: Raise `SlotPredicateNameError`, `RedefinedSlotError`, `ReservedSingularSlotNameError`, `ContentSlotNameError`, `InvalidSlotDefinitionError`, `ReservedPluralSlotNameError`, `ContentAlreadySetForPolymorphicSlotErrror`, `SystemTestControllerOnlyAllowedInTestError`, `SystemTestControllerNefariousPathError`, `NoMatchingTemplatesForPreviewError`, `MultipleMatchingTemplatesForPreviewError`, `DuplicateContentError`, `EmptyOrInvalidInitializerError`, `MissingCollectionArgumentError`, `ReservedParameterError`, `InvalidCollectionArgumentError`, `MultipleInlineTemplatesError`, `MissingPreviewTemplateError`, `DuplicateSlotContentError` or `NilWithContentError` instead of generic error classes.
+
+    *Joel Hawksley*
+
+* Fix bug where `content?` and `with_content` didn't work reliably with slots.
+
+    *Derek Kniffin, Joel Hawksley*
+
+* Add `with_SLOT_NAME_content` helper.
+
+    *Will Cosgrove*
+
+* Allow ActiveRecord objects to be passed to `renders_many`.
+
+    *Leigh Halliday*
+
+* Fix broken links in documentation.
+
+    *Ellen Keal*
+
+* Run `standardrb` against markdown in docs.
+
+    *Joel Hawksley*
+
+* Allow `.with_content` to be redefined by components.
+
+    *Joel Hawksley*
+
+* Run `standardrb` against markdown in docs.
+
+    *Joel Hawksley*
+
+* Raise error if translations are used in initializer.
+
+    *Joel Hawksley*
+
 ## v3.0.0.rc5
 
+Run into an issue with this release candidate? [Let us know](https://github.com/ViewComponent/view_component/issues/1629).
+
 * Fix bug where `mkdir_p` failed due to incorrect permissions.
 
     *Joel Hawksley*
 
-* Check for inline `erb_template` calls when deciding whether or not to compile a component's superclass.
+* Check for inline `erb_template` calls when deciding whether to compile a component's superclass.
 
     *Justin Kenyon*
 
@@ -72,7 +122,7 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
     *Joel Hawksley*
 
-* BREAKING: Rename private TestHelpers#controller, #build_controller, #request, and #preview_class to avoid conflicts. Note: While these methods were undocumented and marked as private, they was easily accessible in tests. As such, we're cautiously considering this to be a breaking change.
+* BREAKING: Rename private TestHelpers#controller, #build_controller, #request, and #preview_class to avoid conflicts. Note: While these methods were undocumented and marked as private, they were accessible in tests. As such, we're considering this to be a breaking change.
 
     *Joel Hawksley*
 
@@ -112,7 +162,7 @@ Run into an issue with this release? [Let us know](https://github.com/ViewCompon
 
 1,000+ days and 100+ releases later, the 200+ contributors to ViewComponent are proud to ship v3.0.0!
 
-We're so grateful for all of the work of community members to get us to this release. Whether it’s filing bug reports, designing APIs in long-winded discussion threads, or writing code itself, ViewComponent is built by the community, for the community. We couldn’t be more proud of what we’re building together :heart:
+We're so grateful for all the work of community members to get us to this release. Whether it’s filing bug reports, designing APIs in long-winded discussion threads, or writing code itself, ViewComponent is built by the community, for the community. We couldn’t be more proud of what we’re building together :heart:
 
 This release makes the following breaking changes, many of which have long been deprecated:
 

data/lib/view_component/base.rb

@@ -6,6 +6,7 @@ require "view_component/collection"
 require "view_component/compile_cache"
 require "view_component/compiler"
 require "view_component/config"
+require "view_component/errors"
 require "view_component/preview"
 require "view_component/slotable"
 require "view_component/translatable"
@@ -32,8 +33,6 @@ module ViewComponent
     include ViewComponent::Translatable
     include ViewComponent::WithContentHelper
 
-    ViewContextCalledBeforeRenderError = Class.new(StandardError)
-
     RESERVED_PARAMETER = :content
 
     # For CSRF authenticity tokens in forms
@@ -94,9 +93,7 @@ module ViewComponent
       @current_template = self
 
       if block && defined?(@__vc_content_set_by_with_content)
-        raise ArgumentError, "It looks like a block was provided after calling `with_content` on #{self.class.name}, " \
-          "which means that ViewComponent doesn't know which content to use.\n\n" \
-          "To fix this issue, use either `with_content` or a block."
+        raise DuplicateContentError.new(self.class.name)
       end
 
       @__vc_content_evaluated = false
@@ -175,16 +172,7 @@ module ViewComponent
     #
     # @return [ActionController::Base]
     def controller
-      if view_context.nil?
-        raise(
-          ViewContextCalledBeforeRenderError,
-          "`#controller` can't be used during initialization, as it depends " \
-          "on the view context that only exists once a ViewComponent is passed to " \
-          "the Rails render pipeline.\n\n" \
-          "It's sometimes possible to fix this issue by moving code dependent on " \
-          "`#controller` to a `#before_render` method: https://viewcomponent.org/api.html#before_render--void."
-        )
-      end
+      raise ControllerCalledBeforeRenderError if view_context.nil?
 
       @__vc_controller ||= view_context.controller
     end
@@ -194,16 +182,7 @@ module ViewComponent
     #
     # @return [ActionView::Base]
     def helpers
-      if view_context.nil?
-        raise(
-          ViewContextCalledBeforeRenderError,
-          "`#helpers` can't be used during initialization, as it depends " \
-          "on the view context that only exists once a ViewComponent is passed to " \
-          "the Rails render pipeline.\n\n" \
-          "It's sometimes possible to fix this issue by moving code dependent on " \
-          "`#helpers` to a `#before_render` method: https://viewcomponent.org/api.html#before_render--void."
-        )
-      end
+      raise HelpersCalledBeforeRenderError if view_context.nil?
 
       # Attempt to re-use the original view_context passed to the first
       # component rendered in the rendering pipeline. This prevents the
@@ -270,7 +249,7 @@ module ViewComponent
     attr_reader :view_context
 
     def __vc_render_in_block_provided?
-      @view_context && @__vc_render_in_block
+      defined?(@view_context) && @view_context && @__vc_render_in_block
     end
 
     def __vc_content_set_by_with_content_defined?
@@ -278,7 +257,7 @@ module ViewComponent
     end
 
     def content_evaluated?
-      @__vc_content_evaluated
+      defined?(@__vc_content_evaluated) && @__vc_content_evaluated
     end
 
     # Set the controller used for testing components:
@@ -535,7 +514,7 @@ module ViewComponent
       # end
       # ```
       #
-      # @param value [Boolean] Whether or not to strip newlines.
+      # @param value [Boolean] Whether to strip newlines.
       def strip_trailing_whitespace(value = true)
         self.__vc_strip_trailing_whitespace = value
       end
@@ -559,20 +538,14 @@ module ViewComponent
         return unless parameter
         return if initialize_parameter_names.include?(parameter) || splatted_keyword_argument_present?
 
-        # If Ruby can't parse the component class, then the initalize
+        # If Ruby can't parse the component class, then the initialize
         # parameters will be empty and ViewComponent will not be able to render
         # the component.
         if initialize_parameters.empty?
-          raise ArgumentError, "The #{self} initializer is empty or invalid." \
-            "It must accept the parameter `#{parameter}` to render it as a collection.\n\n" \
-            "To fix this issue, update the initializer to accept `#{parameter}`.\n\n" \
-            "See https://viewcomponent.org/guide/collections.html for more information on rendering collections."
+          raise EmptyOrInvalidInitializerError.new(name, parameter)
         end
 
-        raise ArgumentError, "The initializer for #{self} doesn't accept the parameter `#{parameter}`, " \
-          "which is required in order to render it as a collection.\n\n" \
-          "To fix this issue, update the initializer to accept `#{parameter}`.\n\n" \
-          "See https://viewcomponent.org/guide/collections.html for more information on rendering collections."
+        raise MissingCollectionArgumentError.new(name, parameter)
       end
 
       # Ensure the component initializer doesn't define
@@ -582,8 +555,7 @@ module ViewComponent
       def validate_initialization_parameters!
         return unless initialize_parameter_names.include?(RESERVED_PARAMETER)
 
-        raise ViewComponent::ComponentError, "#{self} initializer can't accept the parameter `#{RESERVED_PARAMETER}`, as it will override a " \
-          "public ViewComponent method. To fix this issue, rename the parameter."
+        raise ReservedParameterError.new(name, RESERVED_PARAMETER)
       end
 
       # @private

data/lib/view_component/collection.rb

@@ -53,10 +53,7 @@ module ViewComponent
       if object.respond_to?(:to_ary)
         object.to_ary
       else
-        raise ArgumentError.new(
-          "The value of the first argument passed to `with_collection` isn't a valid collection. " \
-          "Make sure it responds to `to_ary`."
-        )
+        raise InvalidCollectionArgumentError
       end
     end
 

data/lib/view_component/compiler.rb

@@ -31,17 +31,9 @@ module ViewComponent
       return if component_class == ViewComponent::Base
 
       component_class.superclass.compile(raise_errors: raise_errors) if should_compile_superclass?
-      subclass_instance_methods = component_class.instance_methods(false)
-
-      if subclass_instance_methods.include?(:with_content) && raise_errors
-        raise ViewComponent::ComponentError.new(
-          "#{component_class} implements a reserved method, `#with_content`.\n\n" \
-          "To fix this issue, change the name of the method."
-        )
-      end
 
       if template_errors.present?
-        raise ViewComponent::TemplateError.new(template_errors) if raise_errors
+        raise TemplateError.new(template_errors) if raise_errors
 
         return false
       end

data/lib/view_component/docs_builder_component.html.erb

@@ -12,7 +12,11 @@ nav_order: 3
 ## <%= section.heading %>
 
 <% section.methods.each do |method| %>
-### <%== render ViewComponent::DocsBuilderComponent::MethodDoc.new(method) %>
+### <%== render ViewComponent::DocsBuilderComponent::MethodDoc.new(method, section.show_types) %>
+
+<% end %>
+<% section.error_klasses.each do |error_klass| %>
+### <%== render ViewComponent::DocsBuilderComponent::ErrorKlassDoc.new(error_klass, section.show_types) %>
 
 <% end %>
 <% end %>

data/lib/view_component/docs_builder_component.rb

@@ -2,21 +2,40 @@
 
 module ViewComponent
   class DocsBuilderComponent < Base
-    class Section < Struct.new(:heading, :methods, :show_types, keyword_init: true)
-      def initialize(heading: nil, methods: [], show_types: true)
+    class Section < Struct.new(:heading, :methods, :error_klasses, :show_types, keyword_init: true)
+      def initialize(heading: nil, methods: [], error_klasses: [], show_types: true)
         methods.sort_by! { |method| method[:name] }
+        error_klasses.sort!
         super
       end
     end
 
-    class MethodDoc < ViewComponent::Base
-      def initialize(method, section: Section.new(show_types: true))
-        @method = method
-        @section = section
+    class ErrorKlassDoc < ViewComponent::Base
+      def initialize(error_klass, _show_types)
+        @error_klass = error_klass
+      end
+
+      def klass_name
+        @error_klass.gsub("ViewComponent::", "").gsub("::MESSAGE", "")
       end
 
-      def show_types?
-        @section.show_types
+      def error_message
+        ViewComponent.const_get(@error_klass)
+      end
+
+      def call
+        <<~DOCS.chomp
+          `#{klass_name}`
+
+          #{error_message}
+        DOCS
+      end
+    end
+
+    class MethodDoc < ViewComponent::Base
+      def initialize(method, show_types = true)
+        @method = method
+        @show_types = show_types
       end
 
       def deprecated?
@@ -28,7 +47,7 @@ module ViewComponent
       end
 
       def types
-        " → [#{@method.tag(:return).types.join(",")}]" if @method.tag(:return)&.types && show_types?
+        " → [#{@method.tag(:return).types.join(",")}]" if @method.tag(:return)&.types && @show_types
       end
 
       def signature_or_name

data/lib/view_component/errors.rb

@@ -0,0 +1,213 @@
+module ViewComponent
+  class BaseError < StandardError
+    def initialize
+      super(self.class::MESSAGE)
+    end
+  end
+
+  class DuplicateSlotContentError < StandardError
+    MESSAGE =
+      "It looks like a block was provided after calling `with_content` on COMPONENT, " \
+      "which means that ViewComponent doesn't know which content to use.\n\n" \
+      "To fix this issue, use either `with_content` or a block."
+
+    def initialize(klass_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s))
+    end
+  end
+
+  class TemplateError < StandardError
+    def initialize(errors)
+      super(errors.join(", "))
+    end
+  end
+
+  class MultipleInlineTemplatesError < BaseError
+    MESSAGE = "Inline templates can only be defined once per-component."
+  end
+
+  class MissingPreviewTemplateError < StandardError
+    MESSAGE =
+      "A preview template for example EXAMPLE doesn't exist.\n\n" \
+      "To fix this issue, create a template for the example."
+
+    def initialize(example)
+      super(MESSAGE.gsub("EXAMPLE", example))
+    end
+  end
+
+  class DuplicateContentError < StandardError
+    MESSAGE =
+      "It looks like a block was provided after calling `with_content` on COMPONENT, " \
+      "which means that ViewComponent doesn't know which content to use.\n\n" \
+      "To fix this issue, use either `with_content` or a block."
+
+    def initialize(klass_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s))
+    end
+  end
+
+  class EmptyOrInvalidInitializerError < StandardError
+    MESSAGE =
+      "The COMPONENT initializer is empty or invalid. " \
+      "It must accept the parameter `PARAMETER` to render it as a collection.\n\n" \
+      "To fix this issue, update the initializer to accept `PARAMETER`.\n\n" \
+      "See [the collections docs](https://viewcomponent.org/guide/collections.html) for more information on rendering collections."
+
+    def initialize(klass_name, parameter)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("PARAMETER", parameter.to_s))
+    end
+  end
+
+  class MissingCollectionArgumentError < StandardError
+    MESSAGE =
+      "The initializer for COMPONENT doesn't accept the parameter `PARAMETER`, " \
+      "which is required to render it as a collection.\n\n" \
+      "To fix this issue, update the initializer to accept `PARAMETER`.\n\n" \
+      "See [the collections docs](https://viewcomponent.org/guide/collections.html) for more information on rendering collections."
+
+    def initialize(klass_name, parameter)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("PARAMETER", parameter.to_s))
+    end
+  end
+
+  class ReservedParameterError < StandardError
+    MESSAGE =
+      "COMPONENT initializer can't accept the parameter `PARAMETER`, as it will override a " \
+      "public ViewComponent method. To fix this issue, rename the parameter."
+
+    def initialize(klass_name, parameter)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("PARAMETER", parameter.to_s))
+    end
+  end
+
+  class InvalidCollectionArgumentError < BaseError
+    MESSAGE =
+      "The value of the first argument passed to `with_collection` isn't a valid collection. " \
+      "Make sure it responds to `to_ary`."
+  end
+
+  class ContentSlotNameError < StandardError
+    MESSAGE =
+      "COMPONENT declares a slot named content, which is a reserved word in ViewComponent.\n\n" \
+      "Content passed to a ViewComponent as a block is captured and assigned to the `content` accessor without having to create an explicit slot.\n\n" \
+      "To fix this issue, either use the `content` accessor directly or choose a different slot name."
+
+    def initialize(klass_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s))
+    end
+  end
+
+  class InvalidSlotDefinitionError < BaseError
+    MESSAGE =
+      "Invalid slot definition. Please pass a class, " \
+      "string, or callable (that is proc, lambda, etc)"
+  end
+
+  class SlotPredicateNameError < StandardError
+    MESSAGE =
+      "COMPONENT declares a slot named SLOT_NAME, which ends with a question mark.\n\n" \
+      "This isn't allowed because the ViewComponent framework already provides predicate " \
+      "methods ending in `?`.\n\n" \
+      "To fix this issue, choose a different name."
+
+    def initialize(klass_name, slot_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
+  class RedefinedSlotError < StandardError
+    MESSAGE =
+      "COMPONENT declares the SLOT_NAME slot multiple times.\n\n" \
+      "To fix this issue, choose a different slot name."
+
+    def initialize(klass_name, slot_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
+  class ReservedSingularSlotNameError < StandardError
+    MESSAGE =
+      "COMPONENT declares a slot named SLOT_NAME, which is a reserved word in the ViewComponent framework.\n\n" \
+      "To fix this issue, choose a different name."
+
+    def initialize(klass_name, slot_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
+  class ReservedPluralSlotNameError < StandardError
+    MESSAGE =
+      "COMPONENT declares a slot named SLOT_NAME, which is a reserved word in the ViewComponent framework.\n\n" \
+      "To fix this issue, choose a different name."
+
+    def initialize(klass_name, slot_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
+  class ContentAlreadySetForPolymorphicSlotError < StandardError
+    MESSAGE = "Content for slot SLOT_NAME has already been provided."
+
+    def initialize(slot_name)
+      super(MESSAGE.gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
+  class NilWithContentError < BaseError
+    MESSAGE =
+      "No content provided to `#with_content` for #{self}.\n\n" \
+      "To fix this issue, pass a value."
+  end
+
+  class TranslateCalledBeforeRenderError < BaseError
+    MESSAGE =
+      "`#translate` can't be used during initialization as it depends " \
+      "on the view context that only exists once a ViewComponent is passed to " \
+      "the Rails render pipeline.\n\n" \
+      "It's sometimes possible to fix this issue by moving code dependent on " \
+      "`#translate` to a [`#before_render` method](https://viewcomponent.org/api.html#before_render--void)."
+  end
+
+  class HelpersCalledBeforeRenderError < BaseError
+    MESSAGE =
+      "`#helpers` can't be used during initialization as it depends " \
+      "on the view context that only exists once a ViewComponent is passed to " \
+      "the Rails render pipeline.\n\n" \
+      "It's sometimes possible to fix this issue by moving code dependent on " \
+      "`#helpers` to a [`#before_render` method](https://viewcomponent.org/api.html#before_render--void)."
+  end
+
+  class ControllerCalledBeforeRenderError < BaseError
+    MESSAGE =
+      "`#controller` can't be used during initialization, as it depends " \
+      "on the view context that only exists once a ViewComponent is passed to " \
+      "the Rails render pipeline.\n\n" \
+      "It's sometimes possible to fix this issue by moving code dependent on " \
+      "`#controller` to a [`#before_render` method](https://viewcomponent.org/api.html#before_render--void)."
+  end
+
+  class NoMatchingTemplatesForPreviewError < StandardError
+    MESSAGE = "Found 0 matches for templates for TEMPLATE_IDENTIFIER."
+
+    def initialize(template_identifier)
+      super(MESSAGE.gsub("TEMPLATE_IDENTIFIER", template_identifier))
+    end
+  end
+
+  class MultipleMatchingTemplatesForPreviewError < StandardError
+    MESSAGE = "Found multiple templates for TEMPLATE_IDENTIFIER."
+
+    def initialize(template_identifier)
+      super(MESSAGE.gsub("TEMPLATE_IDENTIFIER", template_identifier))
+    end
+  end
+
+  class SystemTestControllerOnlyAllowedInTestError < BaseError
+    MESSAGE = "ViewComponent SystemTest controller must only be called in a test environment for security reasons."
+  end
+
+  class SystemTestControllerNefariousPathError < BaseError
+    MESSAGE = "ViewComponent SystemTest controller attempted to load a file outside of the expected directory."
+  end
+end

data/lib/view_component/inline_template.rb

@@ -10,7 +10,7 @@ module ViewComponent # :nodoc:
         return super if !method.end_with?("_template")
 
         if defined?(@__vc_inline_template_defined) && @__vc_inline_template_defined
-          raise ViewComponent::ComponentError, "inline templates can only be defined once per-component"
+          raise MultipleInlineTemplatesError
         end
 
         if args.size != 1

data/lib/view_component/preview.rb

@@ -80,13 +80,7 @@ module ViewComponent # :nodoc:
             Dir["#{path}/#{preview_name}_preview/#{example}.html.*"].first
           end
 
-        if preview_path.nil?
-          raise(
-            PreviewTemplateError,
-            "A preview template for example #{example} doesn't exist.\n\n" \
-            "To fix this issue, create a template for the example."
-          )
-        end
+        raise MissingPreviewTemplateError.new(example) if preview_path.nil?
 
         path = Dir["#{preview_path}/#{preview_name}_preview/#{example}.html.*"].first
         Pathname.new(path)

data/lib/view_component/slot.rb

@@ -12,6 +12,23 @@ module ViewComponent
       @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 false if !__vc_component_instance?
+
+      @__vc_component_instance.content?
+    end
+
+    def with_content(args)
+      if __vc_component_instance?
+        @__vc_component_instance.with_content(args)
+      else
+        super
+      end
+    end
+
     # Used to render the slot content in the template
     #
     # There's currently 3 different values that may be set, that we can render.
@@ -31,22 +48,14 @@ module ViewComponent
       view_context = @parent.send(:view_context)
 
       if defined?(@__vc_content_block) && defined?(@__vc_content_set_by_with_content)
-        raise ArgumentError.new(
-          "It looks like a block was provided after calling `with_content` on #{self.class.name}, " \
-          "which means that ViewComponent doesn't know which content to use.\n\n" \
-          "To fix this issue, use either `with_content` or a block."
-        )
+        raise DuplicateSlotContentError.new(self.class.name)
       end
 
       @content =
-        if defined?(@__vc_component_instance)
+        if __vc_component_instance?
           @__vc_component_instance.__vc_original_view_context = @parent.__vc_original_view_context
 
-          if defined?(@__vc_content_set_by_with_content)
-            @__vc_component_instance.with_content(@__vc_content_set_by_with_content)
-
-            @__vc_component_instance.render_in(view_context)
-          elsif defined?(@__vc_content_block)
+          if defined?(@__vc_content_block)
             # render_in is faster than `parent.render`
             @__vc_component_instance.render_in(view_context, &@__vc_content_block)
           else
@@ -92,7 +101,13 @@ module ViewComponent
     end
 
     def respond_to_missing?(symbol, include_all = false)
-      defined?(@__vc_component_instance) && @__vc_component_instance.respond_to?(symbol, include_all)
+      __vc_component_instance? && @__vc_component_instance.respond_to?(symbol, include_all)
+    end
+
+    private
+
+    def __vc_component_instance?
+      defined?(@__vc_component_instance)
     end
   end
 end

data/lib/view_component/slotable.rb

@@ -68,6 +68,11 @@ module ViewComponent
       #       <p>Bar</p>
       #     <% end %>
       #   <% end %>
+      #
+      # Additionally, content can be set by calling `with_SLOT_NAME_content`
+      # on the component instance.
+      #
+      #   <%= render_inline(MyComponent.new.with_header_content("Foo")) %>
       def renders_one(slot_name, callable = nil)
         validate_singular_slot_name(slot_name)
 
@@ -76,20 +81,27 @@ module ViewComponent
         else
           validate_plural_slot_name(ActiveSupport::Inflector.pluralize(slot_name).to_sym)
 
-          define_method :"with_#{slot_name}" do |*args, &block|
+          setter_method_name = :"with_#{slot_name}"
+
+          define_method setter_method_name do |*args, &block|
             set_slot(slot_name, nil, *args, &block)
           end
-          ruby2_keywords(:"with_#{slot_name}") if respond_to?(:ruby2_keywords, true)
+          ruby2_keywords(setter_method_name) if respond_to?(:ruby2_keywords, true)
 
-          define_method slot_name do |*args, &block|
+          define_method slot_name do
             get_slot(slot_name)
           end
-          ruby2_keywords(slot_name.to_sym) if respond_to?(:ruby2_keywords, true)
 
           define_method "#{slot_name}?" do
             get_slot(slot_name).present?
           end
 
+          define_method "with_#{slot_name}_content" do |content|
+            send(setter_method_name) { content.to_s }
+
+            self
+          end
+
           register_slot(slot_name, collection: false, callable: callable)
         end
       end
@@ -140,18 +152,30 @@ module ViewComponent
           singular_name = ActiveSupport::Inflector.singularize(slot_name)
           validate_singular_slot_name(ActiveSupport::Inflector.singularize(slot_name).to_sym)
 
-          define_method :"with_#{singular_name}" do |*args, &block|
+          setter_method_name = :"with_#{singular_name}"
+
+          define_method setter_method_name do |*args, &block|
             set_slot(slot_name, nil, *args, &block)
           end
-          ruby2_keywords(:"with_#{singular_name}") if respond_to?(:ruby2_keywords, true)
+          ruby2_keywords(setter_method_name) if respond_to?(:ruby2_keywords, true)
+
+          define_method "with_#{singular_name}_content" do |content|
+            send(setter_method_name) { content.to_s }
+
+            self
+          end
 
           define_method :"with_#{slot_name}" do |collection_args = nil, &block|
             collection_args.map do |args|
-              set_slot(slot_name, nil, **args, &block)
+              if args.respond_to?(:to_hash)
+                set_slot(slot_name, nil, **args, &block)
+              else
+                set_slot(slot_name, nil, *args, &block)
+              end
             end
           end
 
-          define_method slot_name do |collection_args = nil, &block|
+          define_method slot_name do
             get_slot(slot_name)
           end
 
@@ -206,10 +230,18 @@ module ViewComponent
               "#{slot_name}_#{poly_type}"
             end
 
-          define_method("with_#{setter_name}") do |*args, &block|
+          setter_method_name = :"with_#{setter_name}"
+
+          define_method(setter_method_name) do |*args, &block|
             set_polymorphic_slot(slot_name, poly_type, *args, &block)
           end
-          ruby2_keywords(:"with_#{setter_name}") if respond_to?(:ruby2_keywords, true)
+          ruby2_keywords(setter_method_name) if respond_to?(:ruby2_keywords, true)
+
+          define_method "with_#{setter_name}_content" do |content|
+            send(setter_method_name) { content.to_s }
+
+            self
+          end
         end
 
         registered_slots[slot_name] = {
@@ -244,10 +276,7 @@ module ViewComponent
           define_method method_name, &callable
           slot[:renderable_function] = instance_method(method_name)
         else
-          raise(
-            ArgumentError,
-            "invalid slot definition. Please pass a class, string, or callable (i.e. proc, lambda, etc)"
-          )
+          raise(InvalidSlotDefinitionError)
         end
 
         slot
@@ -255,10 +284,7 @@ module ViewComponent
 
       def validate_plural_slot_name(slot_name)
         if RESERVED_NAMES[:plural].include?(slot_name.to_sym)
-          raise ArgumentError.new(
-            "#{self} declares a slot named #{slot_name}, which is a reserved word in the ViewComponent framework.\n\n" \
-            "To fix this issue, choose a different name."
-          )
+          raise ReservedPluralSlotNameError.new(name, slot_name)
         end
 
         raise_if_slot_ends_with_question_mark(slot_name)
@@ -267,18 +293,11 @@ module ViewComponent
 
       def validate_singular_slot_name(slot_name)
         if slot_name.to_sym == :content
-          raise ArgumentError.new(
-            "#{self} declares a slot named content, which is a reserved word in ViewComponent.\n\n" \
-            "Content passed to a ViewComponent as a block is captured and assigned to the `content` accessor without having to create an explicit slot.\n\n" \
-            "To fix this issue, either use the `content` accessor directly or choose a different slot name."
-          )
+          raise ContentSlotNameError.new(name)
         end
 
         if RESERVED_NAMES[:singular].include?(slot_name.to_sym)
-          raise ArgumentError.new(
-            "#{self} declares a slot named #{slot_name}, which is a reserved word in the ViewComponent framework.\n\n" \
-            "To fix this issue, choose a different name."
-          )
+          raise ReservedSingularSlotNameError.new(name, slot_name)
         end
 
         raise_if_slot_ends_with_question_mark(slot_name)
@@ -288,22 +307,12 @@ module ViewComponent
       def raise_if_slot_registered(slot_name)
         if registered_slots.key?(slot_name)
           # TODO remove? This breaks overriding slots when slots are inherited
-          raise ArgumentError.new(
-            "#{self} declares the #{slot_name} slot multiple times.\n\n" \
-            "To fix this issue, choose a different slot name."
-          )
+          raise RedefinedSlotError.new(name, slot_name)
         end
       end
 
       def raise_if_slot_ends_with_question_mark(slot_name)
-        if slot_name.to_s.ends_with?("?")
-          raise ArgumentError.new(
-            "#{self} declares a slot named #{slot_name}, which ends with a question mark.\n\n" \
-            "This is not allowed because the ViewComponent framework already provides predicate " \
-            "methods ending in `?`.\n\n" \
-            "To fix this issue, choose a different name."
-          )
-        end
+        raise SlotPredicateNameError.new(name, slot_name) if slot_name.to_s.ends_with?("?")
       end
     end
 
@@ -384,7 +393,7 @@ module ViewComponent
       slot_definition = self.class.registered_slots[slot_name]
 
       if !slot_definition[:collection] && (defined?(@__vc_set_slots) && @__vc_set_slots[slot_name])
-        raise ArgumentError, "content for slot '#{slot_name}' has already been provided"
+        raise ContentAlreadySetForPolymorphicSlotError.new(slot_name)
       end
 
       poly_def = slot_definition[:renderable_hash][poly_type]

data/lib/view_component/test_helpers.rb

@@ -97,7 +97,7 @@ module ViewComponent
     # Capybara assertions to be used. All arguments are forwarded to the block.
     #
     # ```ruby
-    # render_in_view_context(arg1, arg2:) do |arg1, arg2:|
+    # render_in_view_context(arg1, arg2: nil) do |arg1, arg2:|
     #   render(MyComponent.new(arg1, arg2))
     # end
     #

data/lib/view_component/translatable.rb

@@ -81,6 +81,8 @@ module ViewComponent
     end
 
     def translate(key = nil, **options)
+      raise ViewComponent::TranslateCalledBeforeRenderError if view_context.nil?
+
       return super unless i18n_backend
       return key.map { |k| translate(k, **options) } if key.is_a?(Array)
 

data/lib/view_component/version.rb

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

data/lib/view_component/with_content_helper.rb

@@ -3,14 +3,9 @@
 module ViewComponent
   module WithContentHelper
     def with_content(value)
-      if value.nil?
-        raise ArgumentError.new(
-          "No content provided to `#with_content` for #{self}.\n\n" \
-          "To fix this issue, pass a value."
-        )
-      else
-        @__vc_content_set_by_with_content = value
-      end
+      raise NilWithContentError if value.nil?
+
+      @__vc_content_set_by_with_content = value
 
       self
     end

data/lib/view_component.rb

@@ -16,12 +16,10 @@ module ViewComponent
   autoload :InlineTemplate
   autoload :Instrumentation
   autoload :Preview
-  autoload :PreviewTemplateError
   autoload :TestHelpers
   autoload :SystemTestHelpers
   autoload :TestCase
   autoload :SystemTestCase
-  autoload :TemplateError
   autoload :Translatable
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc5
+  version: 3.0.0.rc6
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -90,16 +90,16 @@ dependencies:
   name: better_html
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -118,16 +118,16 @@ dependencies:
   name: erb_lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.37
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.37
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -212,6 +212,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -363,10 +377,10 @@ files:
 - lib/view_component/docs_builder_component.html.erb
 - lib/view_component/docs_builder_component.rb
 - lib/view_component/engine.rb
+- lib/view_component/errors.rb
 - lib/view_component/inline_template.rb
 - lib/view_component/instrumentation.rb
 - lib/view_component/preview.rb
-- lib/view_component/preview_template_error.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
@@ -378,7 +392,6 @@ files:
 - lib/view_component/slotable.rb
 - lib/view_component/system_test_case.rb
 - lib/view_component/system_test_helpers.rb
-- lib/view_component/template_error.rb
 - lib/view_component/test_case.rb
 - lib/view_component/test_helpers.rb
 - lib/view_component/translatable.rb

data/lib/view_component/preview_template_error.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  class PreviewTemplateError < StandardError
-  end
-end

data/lib/view_component/template_error.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  class TemplateError < StandardError
-    def initialize(errors)
-      super(errors.join(", "))
-    end
-  end
-end