Consolidating view_components previews into test/previews/ folder (#1232

)

* Adding test/components/previews folder to app config

* Moving demo/test/component/previews

* Fixing rubocop issues

* Fixing flash preview

* Combining duplicate previews

* Fixing tooltip test

* Fixing underline panels test

* Fixing tab panels test

* Fixing autocomplete test

* Fixing remaining integration tests

* Move to root test/previews/

* move it out of previews folder

* always create system test

* Revert "move it out of previews folder"

This reverts commit 3ebf573.

* Create loud-tips-fold.md

.changeset/loud-tips-fold.md

@@ -0,0 +1,5 @@
+---
+"@primer/view-components": patch
+---
+
+Consolidating view_components previews into test/previews/ folder

.gitignore

@@ -8,7 +8,7 @@ demo/app/assets/stylesheets/primer.css
 # Generated by lib/tasks/docs.rake
 /.yardoc
 /doc
-demo/test/components/previews/primer/docs/
+test/previews/primer/docs/
 lookbook/app/assets/builds/
 docs/content/adr/
 docs/content/components/

component_generator.thor

@@ -36,12 +36,11 @@ class ComponentGenerator < Thor::Group
   end
 
   def create_system_test
-    template("templates/system_test.rb.tt", "test/system/#{status_path}#{underscore_name}_test.rb") if js_package_name
-    template("templates/#{status_template_path}system_test_preview.rb.tt", "demo/test/components/previews/primer/#{status_path}#{underscore_name}_preview.rb") if js_package_name
+    template("templates/system_test.rb.tt", "test/system/#{status_path}#{underscore_name}_test.rb")
   end
 
   def create_preview
-    template("templates/preview.tt", "test/components/previews/#{status_path}#{underscore_name}_preview.rb")
+    template("templates/preview.tt", "test/previews/primer/#{status_path}#{underscore_name}_preview.rb")
   end
 
   def add_to_docs_rakefile

contributor-docs/adding-components.md

@@ -60,7 +60,7 @@ If the `js` flag is passed in it will create some extra files:
 
 - `app/components/<status>/<component_name>.ts` contains the imports for any specified npm dependencies
 - `test/system/<status>/<component_name>.rb` contains the component’s system tests
-- `demo/test/components/preview/primer/<status>/<component_name>_preview.rb` contains the component’s previews
+- `test/components/preview/primer/<status>/<component_name>_preview.rb` contains the component’s previews
 
 The script also edits some files:
 

demo/config/environments/test.rb

@@ -44,4 +44,6 @@
   # config.action_view.raise_on_missing_translations = true
   config.primer_view_components.silence_deprecations = true
   config.primer_view_components.raise_on_invalid_options = false
+
+  config.view_component.preview_paths << Rails.root.join("../test/previews")
 end

lib/tasks/docs.rake

@@ -359,7 +359,7 @@ namespace :docs do
   task :preview do
     registry = generate_yard_registry
 
-    FileUtils.rm_rf("demo/test/components/previews/primer/docs/")
+    FileUtils.rm_rf("test/previews/primer/docs/")
 
     components = Primer::Component.descendants
 
@@ -373,7 +373,7 @@ namespace :docs do
 
       yard_example_tags = initialize_method.tags(:example)
 
-      path = Pathname.new("demo/test/components/previews/primer/docs/#{short_name.underscore}_preview.rb")
+      path = Pathname.new("test/previews/primer/docs/#{short_name.underscore}_preview.rb")
       path.dirname.mkdir unless path.dirname.exist?
 
       File.open(path, "w") do |f|
@@ -386,7 +386,7 @@ namespace :docs do
           method_name = name.split("|").first.downcase.parameterize.underscore
           f.puts("      def #{method_name}; end")
           f.puts unless index == yard_example_tags.size - 1
-          path = Pathname.new("demo/test/components/previews/primer/docs/#{short_name.underscore}_preview/#{method_name}.html.erb")
+          path = Pathname.new("test/previews/primer/docs/#{short_name.underscore}_preview/#{method_name}.html.erb")
           path.dirname.mkdir unless path.dirname.exist?
           File.open(path, "w") do |view_file|
             view_file.puts(code.to_s)

lookbook/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    primer_view_components (0.0.82)
+    primer_view_components (0.0.83)
       actionview (>= 5.0.0)
       activesupport (>= 5.0.0)
       octicons (>= 17.0.0)

lookbook/config/environments/development.rb

@@ -65,7 +65,7 @@
   # Suppress logger output for asset requests.
   config.assets.quiet = true
 
-  config.view_component.preview_paths << Rails.root.join("../test/components/previews")
+  config.view_component.preview_paths << Rails.root.join("../test/previews")
   config.lookbook.listen_paths << Rails.root.join("../app/components")
 
   # Raises error for missing translations.

lookbook/config/environments/production.rb

@@ -93,5 +93,5 @@
   # Do not dump schema after migrations.
   config.active_record.dump_schema_after_migration = false
 
-  config.view_component.preview_paths << Rails.root.join("../test/components/previews")
+  config.view_component.preview_paths << Rails.root.join("../test/previews")
 end