ViewComponent · paul · Oct 9, 2024 · Oct 9, 2024 · Oct 16, 2024
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -24,6 +24,10 @@ nav_order: 5
 
     *Joel Hawksley*
 
+* BREAKING: Move generators to a ViewComponent namespace.
+
+    *Paul Sadauskas*
+
 * Add basic internal testing for memory allocations.
 
     *Joel Hawksley*

diff --git a/lib/rails/generators/abstract_generator.rb → ...tors/view_component/abstract_generator.rb b/lib/rails/generators/abstract_generator.rb → ...tors/view_component/abstract_generator.rb
diff --git a/lib/rails/generators/component/USAGE → ...generators/view_component/component/USAGE b/lib/rails/generators/component/USAGE → ...generators/view_component/component/USAGE
diff --git a/...nerators/component/component_generator.rb → ...omponent/component/component_generator.rb b/...nerators/component/component_generator.rb → ...omponent/component/component_generator.rb
@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "rails/generators/abstract_generator"
+require "generators/view_component/abstract_generator"
 
-module Rails
+module ViewComponent
   module Generators
     class ComponentGenerator < Rails::Generators::NamedBase
       include ViewComponent::AbstractGenerator

diff --git a/...ators/component/templates/component.rb.tt → ...onent/component/templates/component.rb.tt b/...ators/component/templates/component.rb.tt → ...onent/component/templates/component.rb.tt
diff --git a/...ils/generators/erb/component_generator.rb → ...ators/view_component/erb/erb_generator.rb b/...ils/generators/erb/component_generator.rb → ...ators/view_component/erb/erb_generator.rb
@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require "rails/generators/erb"
-require "rails/generators/abstract_generator"
+require "generators/view_component/abstract_generator"
 
-module Erb
+module ViewComponent
   module Generators
-    class ComponentGenerator < Base
+    class ErbGenerator < Rails::Generators::NamedBase
       include ViewComponent::AbstractGenerator
 
       source_root File.expand_path("templates", __dir__)

diff --git a/...ators/erb/templates/component.html.erb.tt → ...onent/erb/templates/component.html.erb.tt b/...ators/erb/templates/component.html.erb.tt → ...onent/erb/templates/component.html.erb.tt
diff --git a/...ls/generators/haml/component_generator.rb → ...ors/view_component/haml/haml_generator.rb b/...ls/generators/haml/component_generator.rb → ...ors/view_component/haml/haml_generator.rb
@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "rails/generators/erb/component_generator"
+require "generators/view_component/erb/erb_generator"
 
-module Haml
+module ViewComponent
   module Generators
-    class ComponentGenerator < Erb::Generators::ComponentGenerator
+    class HamlGenerator < ViewComponent::Generators::ErbGenerator
       include ViewComponent::AbstractGenerator
 
       source_root File.expand_path("templates", __dir__)

diff --git a/...ors/haml/templates/component.html.haml.tt → ...ent/haml/templates/component.html.haml.tt b/...ors/haml/templates/component.html.haml.tt → ...ent/haml/templates/component.html.haml.tt
diff --git a/.../generators/locale/component_generator.rb → ...view_component/locale/locale_generator.rb b/.../generators/locale/component_generator.rb → ...view_component/locale/locale_generator.rb
@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "rails/generators/abstract_generator"
+require "generators/view_component/abstract_generator"
 
-module Locale
+module ViewComponent
   module Generators
-    class ComponentGenerator < ::Rails::Generators::NamedBase
+    class LocaleGenerator < ::Rails::Generators::NamedBase
       include ViewComponent::AbstractGenerator
 
       source_root File.expand_path("templates", __dir__)

diff --git a/...generators/preview/component_generator.rb → ...ew_component/preview/preview_generator.rb b/...generators/preview/component_generator.rb → ...ew_component/preview/preview_generator.rb
@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module Preview
+module ViewComponent
   module Generators
-    class ComponentGenerator < ::Rails::Generators::NamedBase
+    class PreviewGenerator < ::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
 

diff --git a/...preview/templates/component_preview.rb.tt → ...preview/templates/component_preview.rb.tt b/...preview/templates/component_preview.rb.tt → ...preview/templates/component_preview.rb.tt
diff --git a/...s/generators/rspec/component_generator.rb → ...s/view_component/rspec/rspec_generator.rb b/...s/generators/rspec/component_generator.rb → ...s/view_component/rspec/rspec_generator.rb
@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "rails/generators/abstract_generator"
+require "generators/view_component/abstract_generator"
 
-module Rspec
+module ViewComponent
   module Generators
-    class ComponentGenerator < ::Rails::Generators::NamedBase
+    class RspecGenerator < ::Rails::Generators::NamedBase
       include ViewComponent::AbstractGenerator
 
       source_root File.expand_path("templates", __dir__)

diff --git a/...tors/rspec/templates/component_spec.rb.tt → ...nent/rspec/templates/component_spec.rb.tt b/...tors/rspec/templates/component_spec.rb.tt → ...nent/rspec/templates/component_spec.rb.tt
diff --git a/...ls/generators/slim/component_generator.rb → ...ors/view_component/slim/slim_generator.rb b/...ls/generators/slim/component_generator.rb → ...ors/view_component/slim/slim_generator.rb
@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "rails/generators/erb/component_generator"
+require "generators/view_component/erb/erb_generator"
 
-module Slim
+module ViewComponent
   module Generators
-    class ComponentGenerator < Erb::Generators::ComponentGenerator
+    class SlimGenerator < ViewComponent::Generators::ErbGenerator
       include ViewComponent::AbstractGenerator
 
       source_root File.expand_path("templates", __dir__)

diff --git a/...ors/slim/templates/component.html.slim.tt → ...ent/slim/templates/component.html.slim.tt b/...ors/slim/templates/component.html.slim.tt → ...ent/slim/templates/component.html.slim.tt
diff --git a/...enerators/stimulus/component_generator.rb → ..._component/stimulus/stimulus_generator.rb b/...enerators/stimulus/component_generator.rb → ..._component/stimulus/stimulus_generator.rb
@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "rails/generators/abstract_generator"
+require "generators/view_component/abstract_generator"
 
-module Stimulus
+module ViewComponent
   module Generators
-    class ComponentGenerator < ::Rails::Generators::NamedBase
+    class StimulusGenerator < ::Rails::Generators::NamedBase
       include ViewComponent::AbstractGenerator
 
       source_root File.expand_path("templates", __dir__)

diff --git a/...ulus/templates/component_controller.js.tt → ...ulus/templates/component_controller.js.tt b/...ulus/templates/component_controller.js.tt → ...ulus/templates/component_controller.js.tt
diff --git a/lib/generators/view_component/tailwindcss/tailwindcss_generator.rb b/lib/generators/view_component/tailwindcss/tailwindcss_generator.rb
@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "generators/view_component/erb/erb_generator"
+
+module ViewComponent
+  module Generators
+    class TailwindcssGenerator < ViewComponent::Generators::ErbGenerator
+      source_root File.expand_path("templates", __dir__)
+    end
+  end
+end
diff --git a/...ilwindcss/templates/component.html.erb.tt → ...ilwindcss/templates/component.html.erb.tt b/...ilwindcss/templates/component.html.erb.tt → ...ilwindcss/templates/component.html.erb.tt
diff --git a/.../test_unit/templates/component_test.rb.tt → .../test_unit/templates/component_test.rb.tt b/.../test_unit/templates/component_test.rb.tt → .../test_unit/templates/component_test.rb.tt
diff --git a/...nerators/test_unit/component_generator.rb → ...omponent/test_unit/test_unit_generator.rb b/...nerators/test_unit/component_generator.rb → ...omponent/test_unit/test_unit_generator.rb
@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module TestUnit
+module ViewComponent
   module Generators
-    class ComponentGenerator < ::Rails::Generators::NamedBase
+    class TestUnitGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path("templates", __dir__)
       check_class_collision suffix: "ComponentTest"
 

diff --git a/lib/rails/generators/tailwindcss/component_generator.rb b/lib/rails/generators/tailwindcss/component_generator.rb
diff --git a/test/sandbox/test/generators/component_generator_test.rb b/test/sandbox/test/generators/component_generator_test.rb
@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "rails/generators/component/component_generator"
+require "generators/view_component/component/component_generator"
 
 Rails.application.load_generators
 
 class ComponentGeneratorTest < Rails::Generators::TestCase
-  tests Rails::Generators::ComponentGenerator
+  tests ViewComponent::Generators::ComponentGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/sandbox/test/generators/erb_generator_test.rb b/test/sandbox/test/generators/erb_generator_test.rb
@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "rails/generators/erb/component_generator"
+require "generators/view_component/erb/erb_generator"
 
 Rails.application.load_generators
 
 class ErbGeneratorTest < Rails::Generators::TestCase
-  tests Erb::Generators::ComponentGenerator
+  tests ViewComponent::Generators::ErbGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/sandbox/test/generators/haml_generator_test.rb b/test/sandbox/test/generators/haml_generator_test.rb
@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "rails/generators/haml/component_generator"
+require "generators/view_component/haml/haml_generator"
 
 Rails.application.load_generators
 
 class HamlGeneratorTest < Rails::Generators::TestCase
-  tests Haml::Generators::ComponentGenerator
+  tests ViewComponent::Generators::HamlGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/sandbox/test/generators/locale_generator_test.rb b/test/sandbox/test/generators/locale_generator_test.rb
@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "rails/generators/locale/component_generator"
+require "generators/view_component/locale/locale_generator"
 
 Rails.application.load_generators
 
 class LocaleGeneratorTest < Rails::Generators::TestCase
-  tests Locale::Generators::ComponentGenerator
+  tests ViewComponent::Generators::LocaleGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/sandbox/test/generators/preview_generator_test.rb b/test/sandbox/test/generators/preview_generator_test.rb
@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "rails/generators/preview/component_generator"
+require "generators/view_component/preview/preview_generator"
 
 # See: https://github.com/rails/rails/pull/47752#issuecomment-1720256371
 require "active_record"
 
 Rails.application.load_generators
 
 class PreviewGeneratorTest < Rails::Generators::TestCase
-  tests Preview::Generators::ComponentGenerator
+  tests ViewComponent::Generators::PreviewGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/sandbox/test/generators/rspec_generator_test.rb b/test/sandbox/test/generators/rspec_generator_test.rb
@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "rails/generators/rspec/component_generator"
+require "generators/view_component/rspec/rspec_generator"
 
 Rails.application.load_generators
 
 class RSpecGeneratorTest < Rails::Generators::TestCase
-  tests Rspec::Generators::ComponentGenerator
+  tests ViewComponent::Generators::RspecGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/sandbox/test/generators/slim_generator_test.rb b/test/sandbox/test/generators/slim_generator_test.rb
@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "rails/generators/slim/component_generator"
+require "generators/view_component/slim/slim_generator"
 
 Rails.application.load_generators
 
 class SlimGeneratorTest < Rails::Generators::TestCase
-  tests Slim::Generators::ComponentGenerator
+  tests ViewComponent::Generators::SlimGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/sandbox/test/generators/stimulus_generator_test.rb b/test/sandbox/test/generators/stimulus_generator_test.rb
@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "rails/generators/stimulus/component_generator"
+require "generators/view_component/stimulus/stimulus_generator"
 
 Rails.application.load_generators
 
 class StimulusGeneratorTest < Rails::Generators::TestCase
-  tests Stimulus::Generators::ComponentGenerator
+  tests ViewComponent::Generators::StimulusGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/sandbox/test/generators/tailwindcss_generator_test.rb b/test/sandbox/test/generators/tailwindcss_generator_test.rb
@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "rails/generators/test_case"
-require "rails/generators/tailwindcss/component_generator"
+require "generators/view_component/tailwindcss/tailwindcss_generator"
 
 Rails.application.load_generators
 
 class TailwindcssGeneratorTest < Rails::Generators::TestCase
-  tests Tailwindcss::Generators::ComponentGenerator
+  tests ViewComponent::Generators::TailwindcssGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/sandbox/test/generators/test_unit_generator_test.rb b/test/sandbox/test/generators/test_unit_generator_test.rb
@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "rails/generators/test_unit/component_generator"
+require "generators/view_component/test_unit/test_unit_generator"
 
 Rails.application.load_generators
 
 class TestUnitGeneratorTest < Rails::Generators::TestCase
-  tests TestUnit::Generators::ComponentGenerator
+  tests ViewComponent::Generators::TestUnitGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/test_engine/test/generators/component_generator_test.rb b/test/test_engine/test/generators/component_generator_test.rb
@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "../../test_helper"
-require "rails/generators/component/component_generator"
+require "generators/view_component/component/component_generator"
 
 class ComponentGeneratorTest < Rails::Generators::TestCase
-  tests Rails::Generators::ComponentGenerator
+  tests ViewComponent::Generators::ComponentGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/test_engine/test/generators/preview_generator_test.rb b/test/test_engine/test/generators/preview_generator_test.rb
@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "../../test_helper"
-require "rails/generators/preview/component_generator"
+require "generators/view_component/preview/preview_generator"
 
 class PreviewGeneratorTest < Rails::Generators::TestCase
-  tests Preview::Generators::ComponentGenerator
+  tests ViewComponent::Generators::PreviewGenerator
   destination Dir.mktmpdir
   setup :prepare_destination
 

diff --git a/test/test_engine/test/generators/test_unit_generator_test.rb b/test/test_engine/test/generators/test_unit_generator_test.rb
@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "../../test_helper"
-require "rails/generators/test_unit/component_generator"
+require "generators/view_component/test_unit/test_unit_generator"
 
 class TestUnitGeneratorTest < Rails::Generators::TestCase
-  tests TestUnit::Generators::ComponentGenerator
+  tests ViewComponent::Generators::TestUnitGenerator
   destination Dir.mktmpdir
   setup :prepare_destination