view_component 2.75.0 → 2.77.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0856bb7b57478e7604bb8f129a36448c937907308536649c59dc62a324fb8645'
-  data.tar.gz: 2211a54534c91373217a438c504d737054e538bb0f019d574eadd705b02b47ae
+  metadata.gz: fb24cfba68b7323e80beee43cfb7a676ddc833bc87d63201d953d16301defe5d
+  data.tar.gz: 40599c33c49d1dcaa29ae1ec0b6b9e93f191735c2e28207d88717f3f9c77a561
 SHA512:
-  metadata.gz: 21585851a66d7a087e33a43a24c53284d5dd633703f636d202bf583f19d6c25b31830ebf47e7757ef38fa36ff981144ee16d4fe9d5dbc87eb7c2baddbddd039c
-  data.tar.gz: f16688c10f6c3fe6928573b199b2313436a8462e7fbb8d94b12aff9a36cde5cbbb090f8f9a2f3561c6dfa2b264192df746bc329bcb899905ca27046e60349d6e
+  metadata.gz: b6dd24af9a10eae0a9fc81c18570fe410686bad3db5cbb9840ee0f52038185eff956c64d260b9231d75226ae7e06a7fcdcafcbc4c37214917bf7155b64d2dc59
+  data.tar.gz: 863f21e3be9102ddc02b6a20a7c804b4b1490c7714fbbf2ea848b79a3b5da6cec960afa28fe7bb752e882da6cb4df89a4db67a7d462dfaaf40261b8b2bbf64d1

data/docs/CHANGELOG.md

@@ -10,15 +10,57 @@ nav_order: 5
 
 ## main
 
+## 2.77.0
+
+* Support variants with dashes in their names.
+
+    *Javi Martín*
+
+## 2.76.0
+
+* `Component.with_collection` supports components that accept splatted keyword arguments.
+
+    *Zee Spencer*
+
+* Remove `config.view_component.use_consistent_rendering_lifecycle` since it is no longer planned for 3.0.
+
+    *Blake Williams*
+
+* Prevent polymorphic slots from calculating `content` when setting a slot.
+
+    *Blake Williams*
+
+* Add ability to pass in the preview class to `render_preview`.
+
+    *Jon Rohan*
+
+* Fix issue causing PVC tests to fail in CI.
+
+    *Cameron Dutro*
+
+* Fix YARD docs build task.
+
+    *Hans Lemuet*
+
+* Add Startup Jobs to list of companies using ViewComponent.
+
+    *Marc Köhlbrugge*
+
+* Run PVC's accessibility tests in a single process to avoid resource contention in CI.
+
+    *Cameron Dutro*
+
 ## 2.75.0
 
 * Avoid loading ActionView::Base during Rails initialization.
 
     *Jonathan del Strother*
 
+<!-- vale off -->
 * Mention lambda slots rendering returned values lazily in the guide.
 
     *Graham Rogers*
+<!-- vale on -->
 
 * Add "ViewComponent In The Wild" articles to resources.
 
@@ -287,7 +329,7 @@ nav_order: 5
 
 * Revert `Expose Capybara DSL methods directly inside tests.` This change unintentionally broke other Capybara methods and thus introduced a regression. We aren't confident that we can fail forward so we have decided to revert this change.
 
-    *Joel Hawksley*, *Blake Williams*
+    *Joel Hawksley, Blake Williams*
 
 * Revert change making content evaluation consistent.
 
@@ -370,7 +412,7 @@ nav_order: 5
 
 * Add @boardfish and @spone as maintainers.
 
-    *Joel Hawksley*, *Cameron Dutro*, *Blake Williams*
+    *Joel Hawksley, Cameron Dutro, Blake Williams*
 
 * Re-compile updated, inherited templates when class caching is disabled.
 
@@ -430,13 +472,13 @@ nav_order: 5
 
 * Restore removed `rendered_component`, marking it for deprecation in v3.0.0.
 
-    *Tyson Gach*, *Richard Macklin*, *Joel Hawksley*
+    *Tyson Gach, Richard Macklin, Joel Hawksley*
 
 ## 2.56.1
 
 * Rename private accessor `rendered_component` to `rendered_content`.
 
-    *Yoshiyuki Hirano*, *Simon Dawson*
+    *Yoshiyuki Hirano, Simon Dawson*
 
 ## 2.56.0
 
@@ -527,7 +569,7 @@ nav_order: 5
 
 * Skip Rails 5.2 in local test environment if using incompatible Ruby version.
 
-    *Cameron Dutro*, *Blake Williams*, *Joel Hawksley*
+    *Cameron Dutro, Blake Williams, Joel Hawksley*
 
 * Improve landing page documentation.
 
@@ -553,7 +595,7 @@ nav_order: 5
 
 * Add the option to use a "global" output buffer so `form_for` and friends can be used with view components.
 
-    *Cameron Dutro*, *Blake Williams*
+    *Cameron Dutro, Blake Williams*
 
 * Fix fragment caching in partials when global output buffer is enabled.
 * Fix template inheritance when eager loading is disabled.
@@ -690,7 +732,7 @@ nav_order: 5
 
 * Add generators to support `tailwindcss-rails`.
 
-    *Dino Maric*, *Hans Lemuet*
+    *Dino Maric, Hans Lemuet*
 
 * Add a namespaced component example to docs.
 
@@ -871,7 +913,7 @@ nav_order: 5
 
 * Rename internal accessor to use private naming.
 
-    *Joel Hawksley*, *Blake Williams*, *Cameron Dutro*
+    *Joel Hawksley, Blake Williams, Cameron Dutro*
 
 * Add Github repo link to docs website header.
 
@@ -939,7 +981,7 @@ nav_order: 5
 
 * Add support for `image_path` helper in previews.
 
-    *Tobias Ahlin*, *Joel Hawksley*
+    *Tobias Ahlin, Joel Hawksley*
 
 * Add section to docs listing users of ViewComponent. Please submit a PR to add your team to the list!
 
@@ -977,7 +1019,7 @@ nav_order: 5
 
 * Fix bug where `helpers` would instantiate and use a new `view_context` in each component.
 
-    *Blake Williams*, *Ian C. Anderson*
+    *Blake Williams, Ian C. Anderson*
 
 * Implement polymorphic slots as experimental feature. See the Slots documentation to learn more.
 
@@ -1004,7 +1046,7 @@ nav_order: 5
 
 * Fix bug where `with_collection_parameter` didn't inherit from parent component.
 
-    *Will Drexler*, *Christian Campoli*
+    *Will Drexler, Christian Campoli*
 
 * Allow query parameters in `with_request_url` test helper.
 
@@ -1044,7 +1086,7 @@ nav_order: 5
 
 * Clarify documentation of `with_variant` as an override of Action Pack.
 
-    *Blake Williams*, *Cameron Dutro*, *Joel Hawksley*
+    *Blake Williams, Cameron Dutro, Joel Hawksley*
 
 * Update docs page to be called Javascript and CSS, rename Building ViewComponents to Guide.
 
@@ -1069,7 +1111,7 @@ nav_order: 5
 
 * Clarify slots example in docs to reduce naming confusion.
 
-    *Joel Hawksley*, *Blake Williams*
+    *Joel Hawksley, Blake Williams*
 
 * Fix error in documentation for `render_many` passthrough slots.
 
@@ -1531,7 +1573,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 * Add support for templates as ViewComponent::Preview examples.
 
-    *Juan Manuel Ramallo
+    *Juan Manuel Ramallo*
 
 ## 2.14.1
 
@@ -1908,11 +1950,11 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
     *Rainer Borene*
 
+<!-- vale off -->
 * Fix edge case issue with extracting variants from less conventional source_locations.
 
-<!-- vale proselint.GenderBias = NO -->
     *Ryan Workman*
-<!-- vale proselint.GenderBias = YES -->
+<!-- vale on -->
 
 ## v1.6.0
 
@@ -1930,7 +1972,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 * Template-less variants fall back to default template.
 
-    *Asger Behncke Jacobsen*, *Cesario Uy*
+    *Asger Behncke Jacobsen, Cesario Uy*
 
 * Generated tests use new naming convention.
 
@@ -1946,11 +1988,11 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## v1.5.3
 
+<!-- vale off -->
 * Add support for RSpec to generators.
 
-<!-- vale proselint.GenderBias = NO -->
     *Dylan Clark, Ryan Workman*
-<!-- vale proselint.GenderBias = YES -->
+<!-- vale on -->
 
 * Require controllers as part of setting autoload paths.
 
@@ -1972,11 +2014,11 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 Note: `actionview-component` is now loaded by requiring `actionview/component`, not `actionview/component/base`.
 
+<!-- vale off -->
 * Fix issue with generating component method signatures.
 
-<!-- vale proselint.GenderBias = NO -->
     *Ryan Workman, Dylan Clark*
-<!-- vale proselint.GenderBias = YES -->
+<!-- vale off -->
 
 * Create component generator.
 

data/lib/view_component/base.rb

@@ -19,9 +19,15 @@ module ViewComponent
     class << self
       delegate(*ViewComponent::Config.defaults.keys, to: :config)
 
+      # Returns the current config.
+      #
+      # @return [ViewComponent::Config]
       def config
         @config ||= ActiveSupport::OrderedOptions.new
       end
+
+      # Replaces the entire config. You shouldn't need to use this directly
+      # unless you're building a `ViewComponent::Config` elsewhere.
       attr_writer :config
     end
 
@@ -124,11 +130,6 @@ module ViewComponent
       before_render
 
       if render?
-        # Ensure `content` is evaluated before rendering the template, this is
-        # needed so slots and other side-effects are performed before the
-        # component template is evaluated.
-        content if self.class.use_consistent_rendering_lifecycle
-
         render_template_for(@__vc_variant).to_s + output_postamble
       else
         ""
@@ -334,18 +335,6 @@ module ViewComponent
     # Defaults to `nil`. If this is falsy, `app/components` is used.
     #
 
-    # Evaluate `#content` before `#call` to ensure side-effects are present
-    # during component renders. This will be the default behavior in a future
-    # release.
-    #
-    # ```ruby
-    # config.view_component.use_consistent_rendering_lifecycle = true
-    # ```
-    #
-    # Defaults to `false`
-    #
-    mattr_accessor :use_consistent_rendering_lifecycle, instance_writer: false, default: false
-
     # Parent class for generated components
     #
     # ```ruby
@@ -413,7 +402,7 @@ module ViewComponent
       # Find sidecar files for the given extensions.
       #
       # The provided array of extensions is expected to contain
-      # strings starting without the "dot", example: `["erb", "haml"]`.
+      # strings starting without the dot, example: `["erb", "haml"]`.
       #
       # For example, one might collect sidecar CSS files that need to be compiled.
       # @param extensions [Array<String>] Extensions of which to return matching sidecar files.
@@ -591,7 +580,7 @@ module ViewComponent
         parameter = validate_default ? collection_parameter : provided_collection_parameter
 
         return unless parameter
-        return if initialize_parameter_names.include?(parameter)
+        return if initialize_parameter_names.include?(parameter) || splatted_keyword_argument_present?
 
         # If Ruby can't parse the component class, then the initalize
         # parameters will be empty and ViewComponent will not be able to render
@@ -647,6 +636,11 @@ module ViewComponent
 
       private
 
+      def splatted_keyword_argument_present?
+        initialize_parameters.flatten.include?(:keyrest) &&
+          !initialize_parameters.include?([:keyrest, :**]) # Un-named splatted keyword args don't count!
+      end
+
       def initialize_parameter_names
         return attribute_names.map(&:to_sym) if respond_to?(:attribute_names)
 

data/lib/view_component/compiler.rb

@@ -92,7 +92,7 @@ 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)}"
+        "elsif variant.to_sym == :'#{variant}'\n    #{call_method_name(variant)}"
       end.join("\n")
 
       body = <<-RUBY
@@ -163,6 +163,19 @@ module ViewComponent
               "There can only be a template file or inline render method per variant."
           end
 
+          uniq_variants = variants.compact.uniq
+          normalized_variants = uniq_variants.map { |variant| normalized_variant_name(variant) }
+
+          colliding_variants = uniq_variants.select do |variant|
+            normalized_variants.count(normalized_variant_name(variant)) > 1
+          end
+
+          unless colliding_variants.empty?
+            errors <<
+              "Colliding templates #{colliding_variants.sort.map { |v| "'#{v}'" }.to_sentence} " \
+              "found in #{component_class}."
+          end
+
           errors
         end
     end
@@ -234,12 +247,16 @@ module ViewComponent
 
     def call_method_name(variant)
       if variant.present? && variants.include?(variant)
-        "call_#{variant}"
+        "call_#{normalized_variant_name(variant)}"
       else
         "call"
       end
     end
 
+    def normalized_variant_name(variant)
+      variant.to_s.gsub("-", "__")
+    end
+
     def should_compile_superclass?
       development? &&
         templates.empty? &&

data/lib/view_component/config.rb

@@ -34,25 +34,25 @@ module ViewComponent
       # All options under this namespace default to `false` unless otherwise
       # stated.
       #
-      # #### #sidecar
+      # #### `#sidecar`
       #
       # Always generate a component with a sidecar directory:
       #
       #     config.view_component.generate.sidecar = true
       #
-      # #### #stimulus_controller
+      # #### `#stimulus_controller`
       #
       # Always generate a Stimulus controller alongside the component:
       #
       #     config.view_component.generate.stimulus_controller = true
       #
-      # #### #locale
+      # #### `#locale`
       #
       # Always generate translations file alongside the component:
       #
       #     config.view_component.generate.locale = true
       #
-      # #### #distinct_locale_files
+      # #### `#distinct_locale_files`
       #
       # Always generate as many translations files as available locales:
       #
@@ -61,7 +61,7 @@ module ViewComponent
       # One file will be generated for each configured `I18n.available_locales`,
       # falling back to `[:en]` when no `available_locales` is defined.
       #
-      # #### #preview
+      # #### `#preview`
       #
       # Always generate a preview alongside the component:
       #

data/lib/view_component/docs_builder_component.html.erb

@@ -1,6 +1,6 @@
 ---
 layout: default
-title: API
+title: API reference
 nav_order: 3
 ---
 

data/lib/view_component/docs_builder_component.rb

@@ -57,7 +57,7 @@ module ViewComponent
 
       def call
         <<~DOCS.chomp
-          #{separator}#{signature_or_name}#{types}#{suffix}
+          `#{separator}#{signature_or_name}`#{types}#{suffix}
 
           #{docstring_and_deprecation_text}
         DOCS

data/lib/view_component/polymorphic_slots.rb

@@ -89,7 +89,7 @@ module ViewComponent
       def set_polymorphic_slot(slot_name, poly_type = nil, *args, &block)
         slot_definition = self.class.registered_slots[slot_name]
 
-        if !slot_definition[:collection] && get_slot(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"
         end
 

data/lib/view_component/test_helpers.rb

@@ -81,22 +81,10 @@ module ViewComponent
     # In RSpec, `Preview` is appended to `described_class`.
     #
     # @param name [String] The name of the preview to be rendered.
+    # @param from [ViewComponent::Preview] The class of the preview to be rendered.
     # @param params [Hash] Parameters to be passed to the preview.
     # @return [Nokogiri::HTML]
-    def render_preview(name, params: {})
-      begin
-        preview_klass = if respond_to?(:described_class)
-          raise "`render_preview` expected a described_class, but it is nil." if described_class.nil?
-
-          "#{described_class}Preview"
-        else
-          self.class.name.gsub("Test", "Preview")
-        end
-        preview_klass = preview_klass.constantize
-      rescue NameError
-        raise NameError, "`render_preview` expected to find #{preview_klass}, but it does not exist."
-      end
-
+    def render_preview(name, from: preview_class, params: {})
       previews_controller = build_controller(Rails.application.config.view_component.preview_controller.constantize)
 
       # From what I can tell, it's not possible to overwrite all request parameters
@@ -105,7 +93,7 @@ module ViewComponent
         previews_controller.request.params[k] = v
       end
 
-      previews_controller.request.params[:path] = "#{preview_klass.preview_name}/#{name}"
+      previews_controller.request.params[:path] = "#{from.preview_name}/#{name}"
       previews_controller.response = ActionDispatch::Response.new
       result = previews_controller.previews
 
@@ -216,5 +204,20 @@ module ViewComponent
     def build_controller(klass)
       klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
     end
+
+    private
+
+    def preview_class
+      result = if respond_to?(:described_class)
+        raise "`render_preview` expected a described_class, but it is nil." if described_class.nil?
+
+        "#{described_class}Preview"
+      else
+        self.class.name.gsub("Test", "Preview")
+      end
+      result = result.constantize
+    rescue NameError
+      raise NameError, "`render_preview` expected to find #{result}, but it does not exist."
+    end
   end
 end

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 75
+    MINOR = 77
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.75.0
+  version: 2.77.0
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport