view_component 2.83.0 → 3.21.0

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/component/component_generator.rb

@@ -19,9 +19,10 @@ module Rails
       class_option :sidecar, type: :boolean, default: false
       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

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

@@ -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/templates/component_preview.rb.tt

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+<% module_namespacing do -%>
 class <%= class_name %>ComponentPreview < ViewComponent::Preview
   def default
     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

@@ -2,7 +2,7 @@
 
 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

@@ -2,7 +2,7 @@
 
 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>),