[1.0.x] Drupal Atomic Builder

Created on 3 November 2024, 20 days ago

The Drupal Atomic Builder (DAB) module is designed for front-end developers, offering functionalities for both visualizing and creating components through the Single Directory Component (SDC). It integrates smoothly with Drupal's admin interface for ease of use. The module allows developers to code their components without having to create full content. Despite its capabilities, it is strongly advised not to use this module in production environments.

Features
Provides in-admin lists and previews of your components.

To be used with Drupal 10.3.

Project Link →

💬 Support request
Status

Needs review

Component

module

Created by

🇫🇷France Quentin Harelle

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @Quentin Harelle
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    Thank you for applying!

    Please read Review process for security advisory coverage: What to expect → for more details and Security advisory coverage application checklist → to understand what reviewers look for. Tips for ensuring a smooth review → gives some hints for a smoother review.

    The important notes are the following.

    • If you have not done it yet, you should enable GitLab CI for the project and fix the PHP_CodeSniffer errors/warnings it reports.
    • For the time this application is open, only your commits are allowed.
    • The purpose of this application is giving you a new drupal.org role that allows you to opt projects into security advisory coverage, either projects you already created, or projects you will create. The project status will not be changed by this application; once this application is closed, you will be able to change the project status from Not covered to Opt into security advisory coverage. This is possible only 14 days after the project is created.
      Keep in mind that once the project is opted into security advisory coverage, only Security Team members may change coverage.
    • Only the person who created the application will get the permission to opt projects into security advisory coverage. No other person will get the same permission from the same application; that applies also to co-maintainers/maintainers of the project used for the application.
    • We only accept an application per user. If you change your mind about the project to use for this application, or it is necessary to use a different project for the application, please update the issue summary with the link to the correct project and the issue title with the project name and the branch to review.

    To the reviewers

    Please read How to review security advisory coverage applications → , Application workflow → , What to cover in an application review → , and Tools to use for reviews → .

    The important notes are the following.

    • It is preferable to wait for a project moderator before posting the first comment on newly created applications. Project moderators will do some preliminary checks that are necessary before any change on the project files is suggested.
    • Reviewers should show the output of a CLI tool → only once per application.
    • It may be best to have the applicant fix things before further review.

    For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues → .

  • 🇮🇹Italy apaderno Brescia, 🇮🇹
    • The following points are just a start and don't necessarily encompass all the changes that may be necessary
    • A specific point may just be an example and may apply in other places
    • A review is about code that does not follow the coding standards, contains possible security issues, or does not correctly use the Drupal API; the single points are not ordered, not even by importance

    src/Controller/DabComponentController.php

    Since that class does not use any method from the parent class, it does not need to use ControllerBase as parent class. Controllers do not need to have a parent class; as long as they implement \Drupal\Core\DependencyInjection\ContainerInjectionInterface, they are fine.

    src/Form/AddComponentForm.php

    FormBase already implements ContainerInjectionInterface; there is no need for a child class to define it implements it.

    src/Form/ConfirmationComponentForm.php

    Since that is a confirm form class, its parent class should be ConfirmFormBase.

  • 🇫🇷France Quentin Harelle

    Hi @avpaderno and thanks for the review !

    I fixed what you listed in your comment on 1.x branch.

  • 🇮🇳India vishal.kadam Mumbai
  • 🇮🇳India vishal.kadam Mumbai

    1. FILE: dab.module

    /**
     * @file
     * Primary module hooks for Drupal Atomic Builder module.
     *
     * @DCG
     * This file is no longer required in Drupal 8.
     * @see https://www.drupal.org/node/2217931
     */

    Drupal does not have primary and secondary hooks. Instead of that, it is preferable to use the usual description: Hook implementations for the [module name] module. where [module name] is the name of the module given in its .info.yml file.

    2. FILE: src/Controller/DabComponentController.php

      /**
       * The construct method.
       *
       * @param \Drupal\Core\Template\TwigEnvironment $twig_service
       *   The twig service.
       * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
       *   The form builder service.
       * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
       *   The request stack.
       * @param \Drupal\dab\Service\MarkdownService $markdown_service
       *   The markdown service.
       * @param \Drupal\dab\Service\ComponentFileManager $component_file_manager
       *   The component file manager service.
       */
      public function __construct(

    FILE: src/Controller/DabComponentListController.php

      /**
       * DabComponentListController constructor.
       *
       * @param \Drupal\Core\Theme\ComponentPluginManager $componentPluginManager
       *   The component plugin manager.
       * @param \Drupal\Core\Form\FormBuilderInterface $formBuilder
       *   The form builder.
       * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
       *   The request stack.
       */
      public function __construct(

    FILE: src/Form/AddComponentForm.php

      /**
       * AddComponentForm constructor.
       *
       * @param \Drupal\Core\Extension\ModuleExtensionList $module_extension_list
       *   The module extension service.
       * @param \Drupal\Core\Extension\ThemeExtensionList $theme_extension_list
       *   The theme extension service.
       * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
       *   The request stack.
       * @param \Drupal\Core\Theme\ComponentPluginManager $component_plugin_manager
       *   The component plugin manager.
       * @param \Drupal\dab\Service\ComponentFileManager $component_file_manager
       *   The component file manager.
       */
      public function __construct(

    FILE: src/Form/CacheClearForm.php

      /**
       * The construct.
       *
       * @param \Drupal\Core\Asset\JsCollectionOptimizerLazy $js_collection_optimizer
       *   The js collection optimizer.
       * @param \Drupal\Core\Asset\CssCollectionOptimizerLazy $css_collection_optimizer
       *   The css collection optimizer.
       * @param \Drupal\Core\Asset\AssetQueryStringInterface $asset_query_string
       *   The asset query string.
       * @param \Drupal\Core\Template\TwigEnvironment $twig
       *   The twig service.
       */
      public function __construct(

    FILE: src/Form/ComponentFilterForm.php

      /**
       * ComponentFilterForm constructor.
       *
       * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
       *   The current stack.
       * @param \Drupal\Core\Routing\RouteMatchInterface $routeMatch
       *   The route match.
       */
      public function __construct(

    FILE: src/Form/ConfirmationComponentForm.php

      /**
       * The constructor.
       *
       * @param \Drupal\Core\Messenger\MessengerInterface $messenger
       *   The messenger service.
       * @param \Drupal\Core\File\FileSystemInterface $file_system
       *   The file system service.
       * @param \Drupal\dab\Service\ComponentFileManager $component_file_manager
       *   The component file manager service.
       */
      public function __construct(

    FILE: src/Plugin/Derivative/AtomicComponentMenuLinkDeriver.php

      /**
       * AtomicComponentMenuLinkDeriver constructor.
       *
       * @param \Drupal\Core\Theme\ComponentPluginManager $componentPluginManager
       *   The component plugin manager.
       */
      public function __construct(ComponentPluginManager $componentPluginManager) {

    FILE: src/Service/ComponentFileManager.php

      /**
       * ComponentFileManager constructor.
       *
       * @param \Drupal\Core\File\FileSystemInterface $file_system
       *   The file system service.
       * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
       *   The config factory.
       * @param \Drupal\Core\Messenger\MessengerInterface $messenger
       *   The messenger service.
       * @param \Drupal\Core\Extension\ModuleExtensionList $module_extension_list
       *   The module extension list.
       * @param \Drupal\Core\Extension\ThemeExtensionList $theme_extension_list
       *   The theme extension list.
       */
      public function __construct(

    The documentation comment for constructors is not mandatory anymore, If it is given, the description must be Constructs a new [class name] object. where [class name] includes the class namespace.

  • 🇫🇷France Quentin Harelle

    Hi @vishal.kadam,

    Thanks for your review ! I made the changes your requested.

  • 🇮🇳India vishal.kadam Mumbai

    Rest looks fine to me.

    Let’s wait for a Code Review Administrator to take a look and if everything goes fine, you will get the role.

Production build 0.71.5 2024