view_component 3.16.0 → 3.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e3b39556c40610939b3bb6418c79ee0352d78b4e1ea28cdca0c7aa14cd889a6
-  data.tar.gz: 1be4c90a4cecd14ce38ac1aa9c45646415ed81c55a8cf922ec119b3cd5833c10
+  metadata.gz: 5f95cb571165fe8ad9d61f6236c5104ca6b9becec9c45e1f5bbb93f2e8bad487
+  data.tar.gz: 2f547097278242f1b1c945341b0cbcefd455ce93d2ed61145209f92a7acd5c2b
 SHA512:
-  metadata.gz: 585dddfd0449d8d73652ce8b94f818c312e86316e77c6766e157ab4c025a55f8b896a2b9ee8f0fbc649128594d8c24b138515a0f3d3172e227f57a60b47e6e79
-  data.tar.gz: 48833cc160e6ad0a747da98f5efc959d0425895539886f14efb02cd447268306b6ce700ce50e501e520a3842b96abeeaab5e33e96751826795f59497f3326782
+  metadata.gz: 51f0cbc8e8794c383cc2bbb97736e7be0da272c340c94ef9cf3927dd4526b58f73566aec5e1e37f0ee2a302fb99f0fec9a7f058620e6c051339db83426c8c852
+  data.tar.gz: 8484fa046329adf95fd78946ad5ce4b1ab647d9f6e7546da4bee02fe56fb74f25b8ad35cffee4afdae726d99832ebbcfae47a056603c6cfa1c9df7ef1e6476f4

data/docs/CHANGELOG.md

@@ -10,8 +10,30 @@ nav_order: 5
 
 ## main
 
+## 3.17.0
+
+* Use struct instead openstruct in lib code.
+
+    *Oleksii Vasyliev*
+
+* Fix bug where stimulus controller was not added to ERB when stimulus was activated by default.
+
+    *Denis Pasin*
+
+* Add typescript support to stimulus generator.
+
+    *Denis Pasin*
+
+* Fix the example of #vc_test_request in the API reference to use the correct method name.
+
+    *Alberto Rocha*
+
 ## 3.16.0
 
+* Fix development mode race condition that caused an invalid duplicate template error.
+
+    *Blake Williams*
+
 * Add template information to multiple template error messages.
 
     *Joel Hawksley*

data/lib/rails/generators/abstract_generator.rb

@@ -33,7 +33,7 @@ module ViewComponent
     end
 
     def stimulus_controller
-      if options["stimulus"]
+      if stimulus?
         File.join(destination_directory, destination_file_name)
           .sub("#{component_path}/", "")
           .tr("_", "-")
@@ -44,5 +44,13 @@ module ViewComponent
     def sidecar?
       options["sidecar"] || ViewComponent::Base.config.generate.sidecar
     end
+
+    def stimulus?
+      options["stimulus"] || ViewComponent::Base.config.generate.stimulus_controller
+    end
+
+    def typescript?
+      options["typescript"] || ViewComponent::Base.config.generate.typescript
+    end
   end
 end

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

@@ -24,7 +24,7 @@ module Erb
       private
 
       def data_attributes
-        if options["stimulus"]
+        if stimulus?
           " data-controller=\"#{stimulus_controller}\""
         end
       end

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

@@ -9,9 +9,10 @@ module Stimulus
 
       source_root File.expand_path("templates", __dir__)
       class_option :sidecar, type: :boolean, default: false
+      class_option :typescript, type: :boolean, default: false
 
       def create_stimulus_controller
-        template "component_controller.js", destination
+        template "component_controller.#{filetype}", destination
       end
 
       def stimulus_module
@@ -22,11 +23,15 @@ module Stimulus
 
       private
 
+      def filetype
+        typescript? ? "ts" : "js"
+      end
+
       def destination
         if sidecar?
-          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component_controller.js")
+          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component_controller.#{filetype}")
         else
-          File.join(component_path, class_path, "#{file_name}_component_controller.js")
+          File.join(component_path, class_path, "#{file_name}_component_controller.#{filetype}")
         end
       end
 

data/lib/rails/generators/stimulus/templates/component_controller.ts.tt

@@ -0,0 +1,9 @@
+import { Controller } from "<%= stimulus_module %>";
+
+export default class extends Controller {
+  declare element: HTMLElement;
+
+  connect() {
+    console.log("Hello, Stimulus!", this.element);
+  }
+}

data/lib/view_component/base.rb

@@ -412,6 +412,14 @@ module ViewComponent
     # config.view_component.generate.stimulus_controller = true
     # ```
     #
+    # #### `#typescript`
+    #
+    # Generate TypeScript files instead of JavaScript files:
+    #
+    # ```ruby
+    # config.view_component.generate.typescript = true
+    # ```
+    #
     # #### #locale
     #
     # Always generate translations file alongside the component:

data/lib/view_component/compiler.rb

@@ -30,7 +30,12 @@ module ViewComponent
         @component.superclass.compile(raise_errors: raise_errors)
       end
 
-      return if gather_template_errors(raise_errors).any?
+      if template_errors.present?
+        raise TemplateError.new(template_errors) if raise_errors
+
+        # this return is load bearing, and prevents the component from being considered "compiled?"
+        return false
+      end
 
       if raise_errors
         @component.validate_initialization_parameters!
@@ -98,70 +103,70 @@ module ViewComponent
       end
     end
 
-    def gather_template_errors(raise_errors)
-      errors = []
+    def template_errors
+      @_template_errors ||= begin
+        errors = []
 
-      errors << "Couldn't find a template file or inline render method for #{@component}." if @templates.empty?
+        errors << "Couldn't find a template file or inline render method for #{@component}." if @templates.empty?
 
-      # We currently allow components to have both an inline call method and a template for a variant, with the
-      # inline call method overriding the template. We should aim to change this in v4 to instead
-      # raise an error.
-      @templates.reject(&:inline_call?)
-        .map { |template| [template.variant, template.format] }
-        .tally
-        .select { |_, count| count > 1 }
-        .each do |tally|
-        variant, this_format = tally.first
+        # We currently allow components to have both an inline call method and a template for a variant, with the
+        # inline call method overriding the template. We should aim to change this in v4 to instead
+        # raise an error.
+        @templates.reject(&:inline_call?)
+          .map { |template| [template.variant, template.format] }
+          .tally
+          .select { |_, count| count > 1 }
+          .each do |tally|
+          variant, this_format = tally.first
 
-        variant_string = " for variant `#{variant}`" if variant.present?
-
-        errors << "More than one #{this_format.upcase} template found#{variant_string} for #{@component}. "
-      end
+          variant_string = " for variant `#{variant}`" if variant.present?
 
-      default_template_types = @templates.each_with_object(Set.new) do |template, memo|
-        next if template.variant
+          errors << "More than one #{this_format.upcase} template found#{variant_string} for #{@component}. "
+        end
 
-        memo << :template_file if !template.inline_call?
-        memo << :inline_render if template.inline_call? && template.defined_on_self?
+        default_template_types = @templates.each_with_object(Set.new) do |template, memo|
+          next if template.variant
 
-        memo
-      end
+          memo << :template_file if !template.inline_call?
+          memo << :inline_render if template.inline_call? && template.defined_on_self?
 
-      if default_template_types.length > 1
-        errors <<
-          "Template file and inline render method found for #{@component}. " \
-          "There can only be a template file or inline render method per component."
-      end
+          memo
+        end
 
-      # If a template has inline calls, they can conflict with template files the component may use
-      # to render. This attempts to catch and raise that issue before run time. For example,
-      # `def render_mobile` would conflict with a sidecar template of `component.html+mobile.erb`
-      duplicate_template_file_and_inline_call_variants =
-        @templates.reject(&:inline_call?).map(&:variant) &
-        @templates.select { _1.inline_call? && _1.defined_on_self? }.map(&:variant)
-
-      unless duplicate_template_file_and_inline_call_variants.empty?
-        count = duplicate_template_file_and_inline_call_variants.count
-
-        errors <<
-          "Template #{"file".pluralize(count)} and inline render #{"method".pluralize(count)} " \
-          "found for #{"variant".pluralize(count)} " \
-          "#{duplicate_template_file_and_inline_call_variants.map { |v| "'#{v}'" }.to_sentence} " \
-          "in #{@component}. There can only be a template file or inline render method per variant."
-      end
+        if default_template_types.length > 1
+          errors <<
+            "Template file and inline render method found for #{@component}. " \
+            "There can only be a template file or inline render method per component."
+        end
 
-      @templates.select(&:variant).each_with_object(Hash.new { |h, k| h[k] = Set.new }) do |template, memo|
-        memo[template.normalized_variant_name] << template.variant
-        memo
-      end.each do |_, variant_names|
-        next unless variant_names.length > 1
+        # If a template has inline calls, they can conflict with template files the component may use
+        # to render. This attempts to catch and raise that issue before run time. For example,
+        # `def render_mobile` would conflict with a sidecar template of `component.html+mobile.erb`
+        duplicate_template_file_and_inline_call_variants =
+          @templates.reject(&:inline_call?).map(&:variant) &
+          @templates.select { _1.inline_call? && _1.defined_on_self? }.map(&:variant)
+
+        unless duplicate_template_file_and_inline_call_variants.empty?
+          count = duplicate_template_file_and_inline_call_variants.count
+
+          errors <<
+            "Template #{"file".pluralize(count)} and inline render #{"method".pluralize(count)} " \
+            "found for #{"variant".pluralize(count)} " \
+            "#{duplicate_template_file_and_inline_call_variants.map { |v| "'#{v}'" }.to_sentence} " \
+            "in #{@component}. There can only be a template file or inline render method per variant."
+        end
 
-        errors << "Colliding templates #{variant_names.sort.map { |v| "'#{v}'" }.to_sentence} found in #{@component}."
-      end
+        @templates.select(&:variant).each_with_object(Hash.new { |h, k| h[k] = Set.new }) do |template, memo|
+          memo[template.normalized_variant_name] << template.variant
+          memo
+        end.each do |_, variant_names|
+          next unless variant_names.length > 1
 
-      raise TemplateError.new(errors, @templates) if errors.any? && raise_errors
+          errors << "Colliding templates #{variant_names.sort.map { |v| "'#{v}'" }.to_sentence} found in #{@component}."
+        end
 
-      errors
+        errors
+      end
     end
 
     def gather_templates

data/lib/view_component/config.rb

@@ -48,6 +48,12 @@ module ViewComponent
       #
       #     config.view_component.generate.stimulus_controller = true
       #
+      # #### `#typescript`
+      #
+      # Generate TypeScript files instead of JavaScript files:
+      #
+      #     config.view_component.generate.typescript = true
+      #
       # #### `#locale`
       #
       # Always generate translations file alongside the component:

data/lib/view_component/errors.rb

@@ -20,12 +20,6 @@ module ViewComponent
     def initialize(errors, templates = nil)
       message = errors.join("\n")
 
-      if templates
-        message << "\n"
-        message << "Templates:\n"
-        message << templates.map(&:inspect).join("\n")
-      end
-
       super(message)
     end
   end

data/lib/view_component/template.rb

@@ -1,7 +1,10 @@
-require "ostruct"
+# frozen_string_literal: true
 
 module ViewComponent
   class Template
+    DataWithSource = Struct.new(:format, :identifier, :short_identifier, :type, keyword_init: true)
+    DataNoSource = Struct.new(:source, :identifier, :type, keyword_init: true)
+
     attr_reader :variant, :this_format, :type
 
     def initialize(
@@ -109,13 +112,13 @@ module ViewComponent
 
       if handler.method(:call).parameters.length > 1
         handler.call(
-          OpenStruct.new(format: @this_format, identifier: @path, short_identifier: short_identifier, type: type),
+          DataWithSource.new(format: @this_format, identifier: @path, short_identifier: short_identifier, type: type),
           this_source
         )
       # :nocov:
       # TODO: Remove in v4
       else
-        handler.call(OpenStruct.new(source: this_source, identifier: @path, type: type))
+        handler.call(DataNoSource.new(source: this_source, identifier: @path, type: type))
       end
       # :nocov:
     end

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 3
-    MINOR = 16
+    MINOR = 17
     PATCH = 0
     PRE = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 3.16.0
+  version: 3.17.0
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-01 00:00:00.000000000 Z
+date: 2024-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -492,6 +492,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: drb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ostruct
   requirement: !ruby/object:Gem::Requirement
@@ -543,6 +599,7 @@ files:
 - lib/rails/generators/slim/templates/component.html.slim.tt
 - lib/rails/generators/stimulus/component_generator.rb
 - lib/rails/generators/stimulus/templates/component_controller.js.tt
+- lib/rails/generators/stimulus/templates/component_controller.ts.tt
 - lib/rails/generators/tailwindcss/component_generator.rb
 - lib/rails/generators/tailwindcss/templates/component.html.erb.tt
 - lib/rails/generators/test_unit/component_generator.rb