view_component 2.49.1 → 3.23.2

data/lib/rails/generators/abstract_generator.rb

@@ -3,9 +3,7 @@
 module ViewComponent
   module AbstractGenerator
     def copy_view_file
-      unless options["inline"]
-        template "component.html.#{engine_name}", destination
-      end
+      template "component.html.#{engine_name}", destination unless options["inline"]
     end
 
     private
@@ -31,20 +29,28 @@ module ViewComponent
     end
 
     def component_path
-      ViewComponent::Base.view_component_path
+      ViewComponent::Base.config.view_component_path
     end
 
     def stimulus_controller
-      if options["stimulus"]
-        File.join(destination_directory, destination_file_name).
-          sub("#{component_path}/", "").
-          gsub("_", "-").
-          gsub("/", "--")
+      if stimulus?
+        File.join(destination_directory, destination_file_name)
+          .sub("#{component_path}/", "")
+          .tr("_", "-")
+          .gsub("/", "--")
       end
     end
 
     def sidecar?
-      options["sidecar"] || ViewComponent::Base.generate_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/component/component_generator.rb

@@ -11,14 +11,18 @@ 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.config.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.config.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.config.generate.stimulus_controller
+      class_option :skip_suffix, type: :boolean, default: false
 
       def create_component_file
-        template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")
+        template "component.rb", File.join(component_path, class_path, "#{file_name}#{options[:skip_suffix] ? "" : "_component"}.rb")
       end
 
       hook_for :test_framework
@@ -38,7 +42,7 @@ module Rails
       def parent_class
         return options[:parent] if options[:parent]
 
-        ViewComponent::Base.component_parent_class || default_parent_class
+        ViewComponent::Base.config.component_parent_class || default_parent_class
       end
 
       def initialize_signature

data/lib/rails/generators/component/templates/component.rb.tt

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-class <%= class_name %>Component < <%= parent_class %>
+<% module_namespacing do -%>
+class <%= class_name %><%= options[:skip_suffix] ? "" : "Component" %> < <%= parent_class %>
 <%- if initialize_signature -%>
   def initialize(<%= initialize_signature %>)
     <%= initialize_body %>
@@ -11,5 +12,5 @@ class <%= class_name %>Component < <%= parent_class %>
     content_tag :h1, "Hello world!"<%= ", data: { controller: \"#{stimulus_controller}\" }" if options["stimulus"] %>
   end
 <%- 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/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.config.generate.distinct_locale_files
           I18n.available_locales.each do |locale|
             create_file destination(locale), translations_hash([locale]).to_yaml
           end
@@ -34,11 +34,11 @@ module Locale
       end
 
       def destination(locale = nil)
-        extention = ".#{locale}" if locale
+        extension = ".#{locale}" if locale
         if sidecar?
-          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component#{extention}.yml")
+          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component#{extension}.yml")
         else
-          File.join(component_path, class_path, "#{file_name}_component#{extention}.yml")
+          File.join(component_path, class_path, "#{file_name}_component#{extension}.yml")
         end
       end
     end

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

@@ -4,14 +4,22 @@ module Preview
   module Generators
     class ComponentGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path("templates", __dir__)
+      class_option :preview_path, type: :string, desc: "Path for previews, required when multiple preview paths are configured", default: ViewComponent::Base.config.generate.preview_path
 
+      argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "ComponentPreview"
 
       def create_preview_file
-        preview_paths = Rails.application.config.view_component.preview_paths
-        return if preview_paths.count > 1
+        preview_paths = ViewComponent::Base.config.preview_paths
+        optional_path = options[:preview_path]
+        return if preview_paths.count > 1 && optional_path.blank?
+
+        path_prefix = if optional_path.present?
+          optional_path
+        else
+          preview_paths.one? ? preview_paths.first : "test/components/previews"
+        end
 
-        path_prefix = preview_paths.one? ? preview_paths.first : "test/components/previews"
         template "component_preview.rb", File.join(path_prefix, class_path, "#{file_name}_component_preview.rb")
       end
 
@@ -20,6 +28,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,9 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
 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
+<% end -%>

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

@@ -1,18 +1,30 @@
 # frozen_string_literal: true
 
+require "rails/generators/abstract_generator"
+
 module Rspec
   module Generators
     class ComponentGenerator < ::Rails::Generators::NamedBase
+      include ViewComponent::AbstractGenerator
+
       source_root File.expand_path("templates", __dir__)
 
       def create_test_file
-        template "component_spec.rb", File.join("spec/components", class_path, "#{file_name}_component_spec.rb")
+        template "component_spec.rb", File.join(spec_component_path, class_path, "#{file_name}_component_spec.rb")
       end
 
       private
 
-      def file_name
-        @_file_name ||= super.sub(/_component\z/i, "")
+      def spec_component_path
+        return "spec/components" unless ViewComponent::Base.config.generate.use_component_path_for_rspec_tests
+
+        configured_component_path = component_path
+        if configured_component_path.start_with?("app#{File::SEPARATOR}")
+          _app, *rest_of_path = Pathname.new(configured_component_path).each_filename.to_a
+          File.join("spec", *rest_of_path)
+        else
+          "spec/components"
+        end
       end
     end
   end

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

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "rails_helper"
 
-RSpec.describe <%= class_name %>Component, type: :component do
+RSpec.describe <%= namespaced? ? "#{namespace.name}::" : '' %><%= class_name %>Component, type: :component do
   pending "add some examples to (or delete) #{__FILE__}"
 
   # it "renders something useful" do

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/rails/generators/test_unit/templates/component_test.rb.tt

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "test_helper"
 
-class <%= class_name %>ComponentTest < ViewComponent::TestCase
+class <%= namespaced? ? "#{namespace.name}::" : '' %><%= class_name %>ComponentTest < ViewComponent::TestCase
   def test_component_renders_something_useful
     # assert_equal(
     #   %(<span>Hello, components!</span>),