view_component 2.49.1 → 2.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef9372866a072103dd38b8da27bfcf57ad66012524b6a80f6caf311a97533435
-  data.tar.gz: 654c9561c09c8cae7ca8720d126060e8196d38b0cd832d6a5a6e1f7e8c8ad133
+  metadata.gz: 4ea90ad2ed037528865b7e6cf8b5850df938b624883a1508d85de52d8978c4fb
+  data.tar.gz: f2c1e558a700b9f79b3939785f3ff6c2f812a6e03b697f9b60f4aa6f6eaf54a0
 SHA512:
-  metadata.gz: fbd9bf43a06132fa0d26fba5155382be904bba9aaf181c9bb0f715a3caf103f5ae7bff74640e62c31e3ea8600a61f5405e364553b5f56f3cbc5af7a22a77f5f8
-  data.tar.gz: 946639d557fd6dd76889c6a645187fc1235bd7e76817944429f306be1d7798ac9fe9b8005301f3ea106c564d6502d3e1bc21fc1ea5b9902784d99296979c8d93
+  metadata.gz: 9fd97f786e4382098f81e5ec6230b6ae550991641f83d74ecfd67d3eacea515cd899ab21264c8ac5b5de1caed7f35304eb9b6cba13f092e5abdb3a6dc45f6b06
+  data.tar.gz: b70d4f308f47c6937d8aa2e518564ebbc6313366168e6382f4c296823ed07489c7be333f8f47822e65d3a5159753b5d3934ead8cd4323c3777d0c22dde9870f8

data/app/helpers/preview_helper.rb

@@ -27,8 +27,8 @@ module PreviewHelper
       end.flatten
 
       # Search for templates the contain `html`.
-      matching_templates = all_template_paths.find_all do |template|
-        template =~ /#{template_identifier}*.(html)/
+      matching_templates = all_template_paths.find_all do |path|
+        path =~ /#{template_identifier}*.(html)/
       end
 
       # In-case of a conflict due to multiple template files with

data/docs/CHANGELOG.md

@@ -7,9 +7,61 @@ title: Changelog
 
 ## main
 
+## 2.50.0
+
+* Add tests for `layout` usage when rendering via controller.
+
+    *Felipe Sateler*
+
+* Support returning Arrays from i18n files, and support marking them as HTML-safe translations.
+
+    *foca*
+
+* Add Cometeer and Framework to users list.
+
+    *Elia Schito*
+
+* Update Microsoft Vale styles.
+
+    *Simon Fish*
+
+* Fix example in testing guide for how to setup default Rails tests.
+
+    *Steven Hansen*
+
+* Update benchmark script to render multiple components/partials instead of a single instance per-run.
+
+    *Blake Williams*
+
+* Add predicate methods `#{slot_name}?` to slots.
+
+    *Hans Lemuet*
+
+* Use a dedicated deprecation instance, silence it while testing.
+
+    *Max Beizer, Hans Lemuet, Elia Schito*
+
+* Fix Ruby warnings.
+
+    *Hans Lemuet*
+
+* Place all generator options under `config.generate` namespace.
+
+    *Simon Fish*
+
+* Allow preview generator to use provided component attributes.
+* Add config option `config.view_component.generate.preview` to enable project-wide preview generation.
+* Ensure all generated `.rb` files include `# frozen_string_literal: true` statement.
+
+    *Bob Maerten*
+
+* Add Shogun to users list.
+
+    *Bernie Chiu*
+
 ## 2.49.1
 
-* Patch XSS vulnerability in `Translatable` module caused by improperly escaped interpolation arguments.
+* Patch XSS vulnerability in `ViewComponent::Translatable` module caused by improperly escaped interpolation arguments.
 
     *Cameron Dutro*
 
@@ -619,6 +671,12 @@ title: Changelog
 
     *Joel Hawksley*
 
+## 2.31.2
+
+* Patch XSS vulnerability in `ViewComponent::Translatable` module caused by improperly escaped interpolation arguments.
+
+    *Cameron Dutro*
+
 ## 2.31.1
 
 * Fix `DEPRECATION WARNING: before_render_check` when compiling `ViewComponent::Base`
@@ -663,12 +721,6 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
     *Joel Hawksley*
 
-## 2.29.1
-
-* Patch XSS vulnerability in `ViewComponent::Translatable` module caused by improperly escaped interpolation arguments.
-
-    *Cameron Dutro*
-
 ## 2.29.0
 
 * Allow Slot lambdas to share data from the parent component and allow chaining on the returned component.

data/lib/rails/generators/abstract_generator.rb

@@ -44,7 +44,7 @@ module ViewComponent
     end
 
     def sidecar?
-      options["sidecar"] || ViewComponent::Base.generate_sidecar
+      options["sidecar"] || ViewComponent::Base.generate.sidecar
     end
   end
 end

data/lib/rails/generators/component/component_generator.rb

@@ -11,11 +11,13 @@ module Rails
 
       argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "Component"
+
       class_option :inline, type: :boolean, default: false
+      class_option :locale, type: :boolean, default: ViewComponent::Base.generate.locale
       class_option :parent, type: :string, desc: "The parent class for the generated component"
-      class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate_stimulus_controller
+      class_option :preview, type: :boolean, default: ViewComponent::Base.generate.preview
       class_option :sidecar, type: :boolean, default: false
-      class_option :locale, type: :boolean, default: ViewComponent::Base.generate_locale
+      class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate.stimulus_controller
 
       def create_component_file
         template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")

data/lib/rails/generators/locale/component_generator.rb

@@ -12,7 +12,7 @@ module Locale
       class_option :sidecar, type: :boolean, default: false
 
       def create_locale_file
-        if ViewComponent::Base.generate_distinct_locale_files
+        if ViewComponent::Base.generate.distinct_locale_files
           I18n.available_locales.each do |locale|
             create_file destination(locale), translations_hash([locale]).to_yaml
           end

data/lib/rails/generators/preview/component_generator.rb

@@ -5,6 +5,7 @@ module Preview
     class ComponentGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path("templates", __dir__)
 
+      argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "ComponentPreview"
 
       def create_preview_file
@@ -20,6 +21,12 @@ module Preview
       def file_name
         @_file_name ||= super.sub(/_component\z/i, "")
       end
+
+      def render_signature
+        return if attributes.blank?
+
+        attributes.map { |attr| %(#{attr.name}: "#{attr.name}") }.join(", ")
+      end
     end
   end
 end

data/lib/rails/generators/preview/templates/component_preview.rb.tt

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class <%= class_name %>ComponentPreview < ViewComponent::Preview
   def default
-    render(<%= class_name %>Component.new)
+    render(<%= class_name %>Component.new<%= "(#{render_signature})" if render_signature %>)
   end
 end

data/lib/rails/generators/rspec/templates/component_spec.rb.tt

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails_helper"
 
 RSpec.describe <%= class_name %>Component, type: :component do

data/lib/rails/generators/test_unit/templates/component_test.rb.tt

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "test_helper"
 
 class <%= class_name %>ComponentTest < ViewComponent::TestCase

data/lib/view_component/base.rb

@@ -40,6 +40,23 @@ module ViewComponent
       # noop
     end
 
+    # @!macro [attach] deprecated_generate_mattr_accessor
+    #   @method generate_$1
+    #   @deprecated Use `#generate.$1` instead. Will be removed in v3.0.0.
+    def self._deprecated_generate_mattr_accessor(name)
+      define_singleton_method("generate_#{name}".to_sym) do
+        generate.public_send(name)
+      end
+      define_singleton_method("generate_#{name}=".to_sym) do |value|
+        generate.public_send("#{name}=".to_sym, value)
+      end
+    end
+
+    _deprecated_generate_mattr_accessor :distinct_locale_files
+    _deprecated_generate_mattr_accessor :locale
+    _deprecated_generate_mattr_accessor :sidecar
+    _deprecated_generate_mattr_accessor :stimulus_controller
+
     # Entrypoint for rendering components.
     #
     # - `view_context`: ActionView context from calling view
@@ -218,14 +235,11 @@ module ViewComponent
     # @param variant [Symbol] The variant to be used by the component.
     # @return [self]
     def with_variant(variant)
-      ActiveSupport::Deprecation.warn(
-        "`with_variant` is deprecated and will be removed in ViewComponent v3.0.0."
-      )
-
       @__vc_variant = variant
 
       self
     end
+    deprecate :with_variant, deprecator: ViewComponent::Deprecation
 
     # The current request. Use sparingly as doing so introduces coupling that
     # inhibits encapsulation & reuse, often making testing difficult.
@@ -271,56 +285,63 @@ module ViewComponent
     #
     mattr_accessor :render_monkey_patch_enabled, instance_writer: false, default: true
 
-    # Always generate a Stimulus controller alongside the component:
+    # Path for component files
     #
-    #     config.view_component.generate_stimulus_controller = true
+    #     config.view_component.view_component_path = "app/my_components"
     #
-    # Defaults to `false`.
+    # Defaults to `app/components`.
     #
-    mattr_accessor :generate_stimulus_controller, instance_writer: false, default: false
+    mattr_accessor :view_component_path, instance_writer: false, default: "app/components"
 
-    # Always generate translations file alongside the component:
+    # Parent class for generated components
     #
-    #     config.view_component.generate_locale = true
+    #     config.view_component.component_parent_class = "MyBaseComponent"
     #
-    # Defaults to `false`.
+    # Defaults to nil. If this is falsy, generators will use
+    # "ApplicationComponent" if defined, "ViewComponent::Base" otherwise.
     #
-    mattr_accessor :generate_locale, instance_writer: false, default: false
+    mattr_accessor :component_parent_class, instance_writer: false
 
-    # Always generate as many translations files as available locales:
+    # Configuration for generators.
     #
-    #     config.view_component.generate_distinct_locale_files = true
+    # All options under this namespace default to `false` unless otherwise
+    # stated.
     #
-    # Defaults to `false`.
+    # #### #sidecar
     #
-    # One file will be generated for each configured `I18n.available_locales`.
-    # Fallback on `[:en]` when no available_locales is defined.
+    # Always generate a component with a sidecar directory:
     #
-    mattr_accessor :generate_distinct_locale_files, instance_writer: false, default: false
-
-    # Path for component files
+    #     config.view_component.generate.sidecar = true
     #
-    #     config.view_component.view_component_path = "app/my_components"
+    # #### #stimulus_controller
     #
-    # Defaults to `app/components`.
+    # Always generate a Stimulus controller alongside the component:
     #
-    mattr_accessor :view_component_path, instance_writer: false, default: "app/components"
-
-    # Parent class for generated components
+    #     config.view_component.generate.stimulus_controller = true
     #
-    #     config.view_component.component_parent_class = "MyBaseComponent"
+    # #### #locale
+    #
+    # Always generate translations file alongside the component:
     #
-    # Defaults to "ApplicationComponent" if defined, "ViewComponent::Base" otherwise.
+    #     config.view_component.generate.locale = true
     #
-    mattr_accessor :component_parent_class, instance_writer: false
-
-    # Always generate a component with a sidecar directory:
+    # #### #distinct_locale_files
+    #
+    # Always generate as many translations files as available locales:
+    #
+    #     config.view_component.generate.distinct_locale_files = true
+    #
+    # One file will be generated for each configured `I18n.available_locales`,
+    # falling back to `[:en]` when no `available_locales` is defined.
+    #
+    # #### #preview
     #
-    #     config.view_component.generate_sidecar = true
+    # Always generate preview alongside the component:
     #
-    # Defaults to `false`.
+    #      config.view_component.generate.preview = true
     #
-    mattr_accessor :generate_sidecar, instance_writer: false, default: false
+    #  Defaults to `false`.
+    mattr_accessor :generate, instance_writer: false, default: ActiveSupport::OrderedOptions.new(false)
 
     class << self
       # @private

data/lib/view_component/compiler.rb

@@ -49,7 +49,7 @@ module ViewComponent
         end
 
         if subclass_instance_methods.include?(:before_render_check)
-          ActiveSupport::Deprecation.warn(
+          ViewComponent::Deprecation.warn(
             "`#before_render_check` will be removed in v3.0.0.\n\n" \
             "To fix this issue, use `#before_render` instead."
           )

data/lib/view_component/content_areas.rb

@@ -31,7 +31,7 @@ module ViewComponent
 
     class_methods do
       def with_content_areas(*areas)
-        ActiveSupport::Deprecation.warn(
+        ViewComponent::Deprecation.warn(
           "`with_content_areas` is deprecated and will be removed in ViewComponent v3.0.0.\n\n" \
           "Use slots (https://viewcomponent.org/guide/slots.html) instead."
         )

data/lib/view_component/deprecation.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "active_support/deprecation"
+
+module ViewComponent
+  DEPRECATION_HORIZON = 3
+  Deprecation = ActiveSupport::Deprecation.new(DEPRECATION_HORIZON.to_s, "ViewComponent")
+end

data/lib/view_component/docs_builder_component.html.erb

@@ -0,0 +1,18 @@
+---
+layout: default
+title: API
+nav_order: 3
+---
+
+<!-- Warning: AUTO-GENERATED file, don't edit. Add code comments to your Ruby instead <3 -->
+
+# API
+
+<% @sections.each do |section| %>
+## <%= section.heading %>
+
+<% section.methods.each do |method| %>
+### <%== render ViewComponent::DocsBuilderComponent::MethodDoc.new(method) %>
+
+<% end %>
+<% end %>

data/lib/view_component/docs_builder_component.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  class DocsBuilderComponent < Base
+    class Section < Struct.new(:heading, :methods, :show_types, keyword_init: true)
+      def initialize(heading: nil, methods: [], show_types: true)
+        methods.sort_by! { |method| method[:name] }
+        super
+      end
+    end
+
+    class MethodDoc < ViewComponent::Base
+      def initialize(method, section: Section.new(show_types: true))
+        @method = method
+        @section = section
+      end
+
+      def show_types?
+        @section.show_types
+      end
+
+      def deprecated?
+        @method.tag(:deprecated).present?
+      end
+
+      def suffix
+        " (Deprecated)" if deprecated?
+      end
+
+      def types
+        " → [#{@method.tag(:return).types.join(',')}]" if @method.tag(:return)&.types && show_types?
+      end
+
+      def signature_or_name
+        @method.signature ? @method.signature.gsub("def ", "") : @method.name
+      end
+
+      def separator
+        @method.sep
+      end
+
+      def docstring
+        @method.docstring
+      end
+
+      def deprecation_text
+        @method.tag(:deprecated)&.text
+      end
+
+      def docstring_and_deprecation_text
+        <<~DOCS.strip
+          #{docstring}
+
+          #{"_#{deprecation_text}_" if deprecated?}
+        DOCS
+      end
+
+      def call
+        <<~DOCS.chomp
+          #{separator}#{signature_or_name}#{types}#{suffix}
+
+          #{docstring_and_deprecation_text}
+        DOCS
+      end
+    end
+
+    # { heading: String, public_only: Boolean, show_types: Boolean}
+    def initialize(sections: [])
+      @sections = sections
+    end
+
+    # deprecation
+    # return
+    # only public methods
+    # sig with types or name
+  end
+end

data/lib/view_component/engine.rb

@@ -27,7 +27,7 @@ module ViewComponent
         )
 
         if options.preview_path.present?
-          ActiveSupport::Deprecation.warn(
+          ViewComponent::Deprecation.warn(
             "`preview_path` will be removed in v3.0.0. Use `preview_paths` instead."
           )
           options.preview_paths << options.preview_path
@@ -155,7 +155,9 @@ end
 
 # :nocov:
 unless defined?(ViewComponent::Base)
-  ActiveSupport::Deprecation.warn(
+  require "view_component/deprecation"
+
+  ViewComponent::Deprecation.warn(
     "This manually engine loading is deprecated and will be removed in v3.0.0. " \
     "Remove `require \"view_component/engine\"`."
   )

data/lib/view_component/polymorphic_slots.rb

@@ -25,12 +25,19 @@ module ViewComponent
       end
 
       def register_polymorphic_slot(slot_name, types, collection:)
+        unless types.empty?
+          getter_name = slot_name
+
+          define_method(getter_name) do
+            get_slot(slot_name)
+          end
+        end
+
         renderable_hash = types.each_with_object({}) do |(poly_type, poly_callable), memo|
           memo[poly_type] = define_slot(
             "#{slot_name}_#{poly_type}", collection: collection, callable: poly_callable
           )
 
-          getter_name = slot_name
           setter_name =
             if collection
               "#{ActiveSupport::Inflector.singularize(slot_name)}_#{poly_type}"
@@ -38,10 +45,6 @@ module ViewComponent
               "#{slot_name}_#{poly_type}"
             end
 
-          define_method(getter_name) do
-            get_slot(slot_name)
-          end
-
           define_method(setter_name) do |*args, &block|
             set_polymorphic_slot(slot_name, poly_type, *args, &block)
           end

data/lib/view_component/preview.rb

@@ -73,8 +73,8 @@ module ViewComponent # :nodoc:
       # Returns the relative path (from preview_path) to the preview example template if the template exists
       def preview_example_template_path(example)
         preview_path =
-          Array(preview_paths).detect do |preview_path|
-            Dir["#{preview_path}/#{preview_name}_preview/#{example}.html.*"].first
+          Array(preview_paths).detect do |path|
+            Dir["#{path}/#{preview_name}_preview/#{example}.html.*"].first
           end
 
         if preview_path.nil?

data/lib/view_component/slotable.rb

@@ -23,7 +23,7 @@ module ViewComponent
       #   class_name: "Header" # class name string, used to instantiate Slot
       # )
       def with_slot(*slot_names, collection: false, class_name: nil)
-        ActiveSupport::Deprecation.warn(
+        ViewComponent::Deprecation.warn(
           "`with_slot` is deprecated and will be removed in ViewComponent v3.0.0.\n" \
           "Use the new slots API (https://viewcomponent.org/guide/slots.html) instead."
         )

data/lib/view_component/slotable_v2.rb

@@ -7,6 +7,11 @@ module ViewComponent
   module SlotableV2
     extend ActiveSupport::Concern
 
+    RESERVED_NAMES = {
+      singular: %i[content render].freeze,
+      plural: %i[contents renders].freeze,
+    }.freeze
+
     # Setup component slot state
     included do
       # Hash of registered Slots
@@ -75,6 +80,10 @@ module ViewComponent
         end
         ruby2_keywords(slot_name.to_sym) if respond_to?(:ruby2_keywords, true)
 
+        define_method "#{slot_name}?" do
+          get_slot(slot_name).present?
+        end
+
         register_slot(slot_name, collection: false, callable: callable)
       end
 
@@ -140,6 +149,10 @@ module ViewComponent
           end
         end
 
+        define_method "#{slot_name}?" do
+          get_slot(slot_name).present?
+        end
+
         register_slot(slot_name, collection: true, callable: callable)
       end
 
@@ -197,24 +210,26 @@ module ViewComponent
       end
 
       def validate_plural_slot_name(slot_name)
-        if slot_name.to_sym == :contents
+        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."
           )
         end
 
+        raise_if_slot_ends_with_question_mark(slot_name)
         raise_if_slot_registered(slot_name)
       end
 
       def validate_singular_slot_name(slot_name)
-        if slot_name.to_sym == :content
+        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."
           )
         end
 
+        raise_if_slot_ends_with_question_mark(slot_name)
         raise_if_slot_registered(slot_name)
       end
 
@@ -227,6 +242,17 @@ module ViewComponent
           )
         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
+      end
     end
 
     def get_slot(slot_name)
@@ -276,8 +302,8 @@ module ViewComponent
         renderable_function = slot_definition[:renderable_function].bind(self)
         renderable_value =
           if block_given?
-            renderable_function.call(*args) do |*args|
-              view_context.capture(*args, &block)
+            renderable_function.call(*args) do |*rargs|
+              view_context.capture(*rargs, &block)
             end
           else
             renderable_function.call(*args)

data/lib/view_component/translatable.rb

@@ -87,7 +87,7 @@ module ViewComponent
         end
 
         if HTML_SAFE_TRANSLATION_KEY.match?(key)
-          translated = translated.html_safe # rubocop:disable Rails/OutputSafety
+          translated = html_safe_translation(translated)
         end
 
         translated

data/lib/view_component/version.rb

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 49
-    PATCH = 1
+    MINOR = 50
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

data/lib/view_component.rb

@@ -10,6 +10,7 @@ module ViewComponent
   autoload :Compiler
   autoload :CompileCache
   autoload :ComponentError
+  autoload :Deprecation
   autoload :Instrumentation
   autoload :Preview
   autoload :PreviewTemplateError
@@ -21,8 +22,8 @@ end
 
 # :nocov:
 if defined?(ViewComponent::Engine)
-  ActiveSupport::Deprecation.warn(
-    "This manually engine loading is deprecated and will be removed in v3.0.0. " \
+  ViewComponent::Deprecation.warn(
+    "Manually loading the engine is deprecated and will be removed in v3.0.0. " \
     "Remove `require \"view_component/engine\"`."
   )
 elsif defined?(Rails::Engine)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.49.1
+  version: 2.50.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-02 00:00:00.000000000 Z
+date: 2022-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -329,6 +329,9 @@ files:
 - lib/view_component/compiler.rb
 - lib/view_component/component_error.rb
 - lib/view_component/content_areas.rb
+- lib/view_component/deprecation.rb
+- lib/view_component/docs_builder_component.html.erb
+- lib/view_component/docs_builder_component.rb
 - lib/view_component/engine.rb
 - lib/view_component/instrumentation.rb
 - lib/view_component/polymorphic_slots.rb