Skip to content

Add generator for all components #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cirdes merged 5 commits into from
May 12, 2025
Merged

Add generator for all components #289

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
058e19e
Add generator for all components
cirdes May 10, 2025
5351b8b
fix linter
cirdes May 11, 2025
2ce49af
add force option to all generators
cirdes May 11, 2025
e5c6605
Change all generator to use force option
cirdes May 12, 2025
87863bd
Add 3.4 to CI and remove head
cirdes May 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ You can generate your components using `ruby_ui:component` generator.
bin/rails g ruby_ui:component Accordion
```

You also can generate all components using `ruby_ui:component:all` generator

## Documentation 📖

Visit https://rubyui.com/docs/introduction to view the full documentation, including:
Expand Down
23 changes: 23 additions & 0 deletions lib/generators/ruby_ui/component/all_generator.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
module RubyUI
module Generators
module Component
class AllGenerator < Rails::Generators::Base
namespace "ruby_ui:component:all"

source_root File.expand_path("../../../ruby_ui", __dir__)

def generate_components
say "Generating all components..."

Dir.children(self.class.source_root).each do |folder_name|
Copy link
Contributor

@stephannv stephannv May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you do something like Dir.glob("path/to/ruby_ui/*/") you will get ruby_ui folders, then you won't need to do next if folder_name == "base.rb".

Copy link
Collaborator Author

@cirdes cirdes May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It started to return the full path. I decided to check if the string ends_with?(".rb") to make it more generic and robust

folder_name: /Users/cirdes/Workspace/ruby-ui/ruby_ui/lib/ruby_ui/accordion/

puts "folder_name: #{folder_name}"
next if folder_name == "base.rb"

component_name = folder_name.camelize
run "bin/rails generate ruby_ui:component #{component_name} --force true"
Copy link
Contributor

@stephannv stephannv May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this should be --force true by default since it is an irreversible action if the overwritten files are not in git.

Copy link
Collaborator Author

@cirdes cirdes May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stephannv , good point. I have changed it to be an option with default: false now

end
end
end
end
end
end
7 changes: 4 additions & 3 deletions lib/generators/ruby_ui/component_generator.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ class ComponentGenerator < Rails::Generators::Base

source_root File.expand_path("../../ruby_ui", __dir__)
argument :component_name, type: :string, required: true
class_option :force, type: :boolean, default: false

def generate_component
if component_not_found?
Expand All @@ -23,7 +24,7 @@ def copy_related_component_files

components_file_paths.each do |file_path|
component_file_name = file_path.split("/").last
copy_file file_path, Rails.root.join("app/components/ruby_ui", component_folder_name, component_file_name)
copy_file file_path, Rails.root.join("app/components/ruby_ui", component_folder_name, component_file_name), force: options["force"]
end
end

Expand All @@ -34,7 +35,7 @@ def copy_js_files

js_controller_file_paths.each do |file_path|
controller_file_name = file_path.split("/").last
copy_file file_path, Rails.root.join("app/javascript/controllers/ruby_ui", controller_file_name)
copy_file file_path, Rails.root.join("app/javascript/controllers/ruby_ui", controller_file_name), force: options["force"]
end

# Importmap doesn't have controller manifest, instead it uses `eagerLoadControllersFrom("controllers", application)`
Expand Down Expand Up @@ -68,7 +69,7 @@ def js_controller_file_paths = Dir.glob(File.join(component_folder_path, "*.js")

def install_components_dependencies(components)
components&.each do |component|
run "bin/rails generate ruby_ui:component #{component}"
run "bin/rails generate ruby_ui:component #{component} --force #{options["force"]}"
end
end

Expand Down