ACMS-4255: Add dynamic recipes discovery on installation page.

acquia · Oct 1, 2024 · 0e17325 · 0e17325
1 parent c67642c
commit 0e17325
Show file tree

Hide file tree

Showing 11 changed files with 39 additions and 16 deletions.
diff --git a/recipes/acquia_drupal_starterkit/recipe.yml b/recipes/acquia_drupal_starterkit/recipe.yml
@@ -1,6 +1,7 @@
 name: Acquia Drupal Starterkit
 description: Applies all the basic Acquia Drupal Starterkit recipes.
 type: Site
+visibility: hidden
 recipes:
  - acquia_drupal_starterkit_admin_theme
  - core/recipes/core_recommended_front_end_theme

diff --git a/recipes/acquia_drupal_starterkit_admin_theme/recipe.yml b/recipes/acquia_drupal_starterkit_admin_theme/recipe.yml
@@ -1,5 +1,6 @@
 name: 'Acquia Drupal Starterkit Admin Theme'
 type: 'Acquia Drupal Starterkit'
+visibility: hidden
 description: 'Sets up a nice administrative theme and toolbar.'
 install:
  - gin

diff --git a/recipes/acquia_drupal_starterkit_basic_html_editor/recipe.yml b/recipes/acquia_drupal_starterkit_basic_html_editor/recipe.yml
@@ -1,5 +1,6 @@
 name: 'Acquia Drupal Startekit Basic HTML editor'
 type: 'Acquia Drupal Startekit'
+visibility: hidden
 description: 'Enhances the Basic HTML editor with better linking and media support.'
 install:
  - ckeditor5

diff --git a/recipes/acquia_drupal_starterkit_content_model/recipe.yml b/recipes/acquia_drupal_starterkit_content_model/recipe.yml
@@ -1,6 +1,6 @@
 name: 'Acquia Drupal Startekit Content Model'
 description: 'An content model provides Article, Event, Page, Person, Place content types.'
-type: 'Starterkit'
+type: 'Starterkit addon'
 recipes:
  - acquia_drupal_starterkit_community
 install:

diff --git a/recipes/acquia_drupal_starterkit_dam/recipe.yml b/recipes/acquia_drupal_starterkit_dam/recipe.yml
@@ -1,6 +1,6 @@
 name: 'Acquia Drupal Startekit DAM'
 description: 'Integrates with Acquia DAM.'
-type: 'Starterkit'
+type: 'Starterkit addon'
 install:
  # Contrib
  - acquia_cms_dam
diff --git a/recipes/acquia_drupal_starterkit_full_html_editor/recipe.yml b/recipes/acquia_drupal_starterkit_full_html_editor/recipe.yml
@@ -1,5 +1,6 @@
 name: 'Acquia Drupal Startekit Full HTML editor'
 type: 'Acquia Drupal Startekit'
+visibility: hidden
 description: 'Enhances the Full HTML editor with better linking and media support.'
 install:
  - ckeditor5

diff --git a/recipes/acquia_drupal_starterkit_installer/acquia_drupal_starterkit_installer.profile b/recipes/acquia_drupal_starterkit_installer/acquia_drupal_starterkit_installer.profile
@@ -12,6 +12,7 @@ use Drupal\Core\Recipe\RecipeRunner;
 use Drupal\acquia_drupal_starterkit_installer\Form\RecipesStarterkitForm;
 use Drupal\acquia_drupal_starterkit_installer\Form\RecipesAddOnForm;
 use Drupal\acquia_drupal_starterkit_installer\Form\SiteNameForm;
+use Symfony\Component\Yaml\Yaml;
 
 /**
  * Implements hook_install_tasks().
@@ -280,3 +281,31 @@ function acquia_drupal_starterkit_installer_preprocess_install_page(array &$vari
  ->generateString($images_path);
  $variables['images_path'] = $images_path;
 }
+
+/**
+ * Identifies all recipes available in the docroot/recipes directory.
+ *
+ * @param string $type
+ * The type of recipes to filter by.
+ *
+ * @return array
+ * An array of recipe names.
+ */
+function acquia_drupal_starterkit_installer_get_available_recipes(string $type = 'Starterkit addon'): array {
+ $recipes = [];
+ $directory = new \DirectoryIterator(\Drupal::root() . '/recipes');
+
+ foreach ($directory as $fileinfo) {
+ if ($fileinfo->isDir() && !$fileinfo->isDot()) {
+ $recipe_file = $fileinfo->getPathname() . '/recipe.yml';
+ if (file_exists($recipe_file)) {
+ $recipe_info = Yaml::parseFile($recipe_file);
+ if (isset($recipe_info['name']) && (!isset($recipe_info['visibility']) || $recipe_info['visibility'] !== 'hidden') && $recipe_info['type'] === $type) {
+ $recipes[$fileinfo->getFilename()] = $recipe_info['name'];
+ }
+ }
+ }
+ }
+
+ return $recipes;
+}
diff --git a/recipes/acquia_drupal_starterkit_installer/src/Form/RecipesAddOnForm.php b/recipes/acquia_drupal_starterkit_installer/src/Form/RecipesAddOnForm.php
@@ -30,16 +30,12 @@ public function buildForm(array $form, FormStateInterface $form_state): array {
  '#markup' => $this->t('You can change your mind later.'),
  '#suffix' => '</p>',
  ];
- $options = [
- 'acquia_drupal_starterkit_content_model' => $this->t('Acquia Drupal Starterkit Content Model'),
- 'acquia_drupal_starterkit_media_model' => $this->t('Acquia Drupal Starterkit Media Model'),
- ];
 
  $form['add_ons'] = [
  '#prefix' => '<div class="cms-installer__form-group">',
  '#suffix' => '</div>',
  '#type' => 'checkboxes',
- '#options' => $options,
+ '#options' => acquia_drupal_starterkit_installer_get_available_recipes('Starterkit addon'),
  '#default_value' => [],
  ];
  $form['actions'] = [

diff --git a/recipes/acquia_drupal_starterkit_installer/src/Form/RecipesStarterkitForm.php b/recipes/acquia_drupal_starterkit_installer/src/Form/RecipesStarterkitForm.php
@@ -31,17 +31,11 @@ public function buildForm(array $form, FormStateInterface $form_state): array {
  '#suffix' => '</p>',
  ];
 
- $options = [
- 'acquia_drupal_starterkit_community' => $this->t('Acquia Drupal Starterkit Community'),
- 'acquia_drupal_starterkit_headless' => $this->t('Acquia Drupal Starterkit Headless'),
- 'acquia_drupal_starterkit_low_code' => $this->t('Acquia Drupal Starterkit Low-Code'),
- ];
-
  $form['add_ons'] = [
  '#prefix' => '<div class="cms-installer__form-group">',
  '#suffix' => '</div>',
  '#type' => 'radios',
- '#options' => $options,
+ '#options' => acquia_drupal_starterkit_installer_get_available_recipes('Starterkit'),
  '#default_value' => [],
  ];
 

diff --git a/recipes/acquia_drupal_starterkit_media_model/recipe.yml b/recipes/acquia_drupal_starterkit_media_model/recipe.yml
@@ -1,6 +1,6 @@
 name: 'Acquia Drupal Startekit Media Model'
 description: 'An media model provides Audio, Document, Image< Video media types.'
-type: 'Starterkit'
+type: 'Starterkit addon'
 install:
  # Contrib
  - acquia_cms_audio

diff --git a/recipes/acquia_drupal_starterkit_search/recipe.yml b/recipes/acquia_drupal_starterkit_search/recipe.yml
@@ -1,6 +1,6 @@
 name: 'Acquia Drupal Startekit Search'
 description: "Provides integration between your Drupal site and Acquia's hosted search service."
-type: 'Starterkit'
+type: 'Starterkit addon'
 install:
  # Contrib
  - acquia_cms_search