Add a new component generator (#19)

Author: coorasse

README.md

@@ -51,6 +51,7 @@ We have no idea yet. We are still working on this.
 
 Bug reports and pull requests are very much welcome. Please check our [plan](https://github.com/orgs/renuo/projects/7) to see what components we would like to add.
 
+If you want to add a new component, run `bin/rails g ui_component my_component_name` and follow the instructions.
 
 ## Development
 

bin/fastcheck

@@ -23,3 +23,4 @@ echo "Executing: yarn eslint app/javascripts spec/javascripts"
 yarn eslint 'app/javascript/**/*.js'
 
 
+bin/rails zeitwerk:check

config/application.rb

@@ -28,7 +28,7 @@ class Application < Rails::Application
     # Please, add to the `ignore` list any other `lib` subdirectories that do
     # not contain `.rb` files, or that should not be reloaded or eager loaded.
     # Common ones are `templates`, `generators`, or `middleware`, for example.
-    config.autoload_lib(ignore: %w[assets tasks])
+    config.autoload_lib(ignore: %w[assets tasks generators])
 
     # Configuration for the application, engines, and railties goes here.
     #

lib/generators/ui_component/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates all necessary files to start coding your new UI component.
+
+Example:
+    bin/rails generate ui_component modal
+
+    This will create al necessary files to start coding a modal component.
+

lib/generators/ui_component/templates/component.scss

@@ -0,0 +1,10 @@
+# frozen_literal_string: true
+
+class <%= class_name %>ComponentPreview < Lookbook::Preview
+  include LookbookHelper
+
+  # @source ../../../app/views/components/<%= plural_name %>/_themes.html.erb
+  def themes
+    render 'components/<%= plural_name %>/themes'
+  end
+end

lib/generators/ui_component/templates/component_preview.rb.tt

@@ -0,0 +1 @@
+Your new <%= name %> component implementation.

lib/generators/ui_component/templates/themes.html.erb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class UiComponentGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def create_assets_file
+    template 'component.scss', "app/assets/stylesheets/components/_#{file_name}.scss"
+
+    import_string = "@import 'components/#{file_name}';"
+    application_stylesheet = 'app/assets/stylesheets/application.scss'
+    return unless File.exist?(application_stylesheet) && File.read(application_stylesheet).exclude?(import_string)
+
+    append_to_file application_stylesheet, "#{import_string}\n"
+  end
+
+  def create_preview_files
+    template 'component_preview.rb', "app/components/previews/#{file_name}_component_preview.rb"
+    template 'themes.html.erb', "app/views/components/#{plural_name}/_themes.html.erb"
+  end
+end