Merge pull request #15 from acquia/refactor-code

ACMS-3281: Refactor Drupal recommended settings.

Author: vishalkhode1

.github/workflows/drs_ci.yml

@@ -60,10 +60,16 @@ jobs:
           coverage: xdebug
       - name: Download ORCA
         run: composer create-project --no-dev --ignore-platform-req=php acquia/orca ../orca "$ORCA_VERSION" -n
+      - name: Before Install
+        run: ../orca/bin/ci/before_install.sh
+      - name: Install
+        run: ../orca/bin/ci/install.sh
       - name: Before script
         run: ../orca/bin/ci/before_script.sh
-      - name: Script
-        run: ../orca/bin/ci/script.sh
+      - name: Run PHPUnit tests
+        run: |
+          composer install
+          ./vendor/bin/phpunit tests
       - name: After script
         run: |
           ../orca/bin/ci/after_success.sh

README.md

@@ -1,14 +1,15 @@
 # Acquia Drupal Recommended Settings
-The Acquia Drupal Recommended Settings plugin adds the recommended settings to the Drupal project, so developers won't have to edit settings.php manually.
+The Acquia Drupal Recommended Settings plugin adds the recommended settings to
+the Drupal project, so developers won't have to edit settings.php manually.
 
 The recommended settings includes:
-- the required database credentials
-- configuration sync directory path.
-- public/private etc. file directory path.
+- The required database credentials.
+- Configuration sync directory path.
+- File directory path i.e public/private etc.
 - Acquia site studio sync directory path.
-- Includes Drupal module [Config sync without site uuid](https://www.drupal.org/project/config_sync_without_site_uuid) features. 
 
-It allows your websites to be easily installed in both Acquia Cloud IDE & local and deployable on Acquia Cloud.
+It allows your websites to be easily installed in both Acquia Cloud IDE & local
+and deployable on Acquia Cloud.
 
 ## Installation
 
@@ -18,43 +19,78 @@ You can also install this using Composer like so:
 composer require acquia/drupal-recommended-settings
 ```
 
-## Steps to switch from BLT to Acquia Drupal Recommended Settings
-This plugin doesn't work with the acquia/blt plugin. If the plugin exists, it must be removed.
+# Quick examples
+## Generate settings for a given site
+ ```
+<?php
 
-- Remove BLT plugin using below command
+/**
+ * @file
+ * Include DRS settings.
+ */
+
+use Acquia\Drupal\RecommendedSettings\Exceptions\SettingsException;
+use Acquia\Drupal\RecommendedSettings\Settings;
+
+// Create settings object.
+$siteUri = "site1";
+$settings = new Settings(DRUPAL_ROOT, $siteUri);
+
+try {
+  // Call generate method.
+  $settings->generate();
+} catch (SettingsException $e) {
+  echo $e->getMessage();
+}
 ```
-composer remove acquia/blt
+
+## Generate settings for a given site passing database credentials
+
 ```
+<?php
 
-- Remove BLT reference from settings.php file located at
-``/docroot/sites/default/settings.php``.
-```php
-require DRUPAL_ROOT . "/../vendor/acquia/blt/settings/blt.settings.php";
 /**
- * IMPORTANT.
- *
- * Do not include additional settings here. Instead, add them to settings
- * included by `blt.settings.php`. See BLT's documentation for more detail.
- *
- * @link https://docs.acquia.com/blt/
+ * @file
+ * Include DRS settings.
  */
-```
 
-- Require Acquia Drupal Recommended Settings plugin using
-```
-composer require acquia/drupal-recommended-settings
-```
- 
-- Update `default.local.settings.php` and `local.settings.php` to use the Environment Detector provided by this plugin instead of BLT:
-```diff
-- use Acquia\Blt\Robo\Common\EnvironmentDetector;
-+ use Acquia\Drupal\RecommendedSettings\Helpers\EnvironmentDetector;
+use Acquia\Drupal\RecommendedSettings\Exceptions\SettingsException;
+use Acquia\Drupal\RecommendedSettings\Settings;
+
+// Create settings object.
+$siteUri = "site1";
+$settings = new Settings(DRUPAL_ROOT, $siteUri);
+
+// Database details.
+$dbSpec = [
+  'drupal' => [
+    'db' => [
+      'database' => 'drupal',
+      'username' => 'drupal',
+      'password' => 'drupal',
+      'host' => 'localhost',
+      'port' => '3306',
+    ],
+  ],
+];
+
+try {
+  // Call generate method passing database details.
+  $settings->generate($dbSpec);
+} catch (SettingsException $e) {
+  echo $e->getMessage();
+}
 ```
 
 # License
 
 Copyright (C) 2023 Acquia, Inc.
 
-This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU General Public License version 2 as published by the
+Free Software Foundation.
 
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See the GNU General Public License for more details.

composer.json

@@ -19,25 +19,20 @@
         "docs": "https://docs.acquia.com/drupal-recommended-settings/"
     },
     "require": {
-        "php": ">=7.4",
+        "php": ">=8.1",
         "composer-plugin-api": "^2",
         "acquia/drupal-environment-detector": "^1.5.3",
-        "composer/composer": "^2.2",
-        "consolidation/config": "^1.0.0 || ^2.0.0",
-        "dflydev/dot-access-data": "^1.1.0 || ^2 || ^3",
-        "grasmash/yaml-expander": "^3",
-        "loophp/phposinfo": "^1.7.1",
-        "symfony/filesystem": "^5.4 || ^6.2",
-        "symfony/yaml": "^4.4 || ^5 || ^6"
+        "consolidation/config": "^2.0.0",
+        "grasmash/yaml-expander": "^3.0",
+        "loophp/phposinfo": "^1.7.1"
     },
     "require-dev": {
         "acquia/coding-standards": "^2.0",
+        "composer/composer": "^2.2",
         "dealerdirect/phpcodesniffer-composer-installer": "^0.7.2",
-        "ergebnis/composer-normalize": "~2.21.0",
-        "phpro/grumphp-shim": "^1.5"
-    },
-    "conflict": {
-        "acquia/blt": "*"
+        "ergebnis/composer-normalize": "^2.30.2",
+        "phpro/grumphp-shim": "^1.5",
+        "phpunit/phpunit": "^9 || ^10"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
@@ -46,6 +41,11 @@
             "Acquia\\Drupal\\RecommendedSettings\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Acquia\\Drupal\\RecommendedSettings\\Tests\\": "tests/src"
+        }
+    },
     "config": {
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true,

config/build.yml

@@ -5,4 +5,4 @@ drupal:
     username: drupal
     password: drupal
     host: localhost
-    port: 3306
+    port: 3306

settings/acquia-recommended.settings.php

@@ -2,7 +2,9 @@
 
 /**
  * @file
- * Setup Acquia Drupal Recommended Settings utility variables, include required files.
+ * Setup Acquia Drupal Recommended Settings utility variables.
+ *
+ * Includes required settings files.
  */
 
 use Acquia\Drupal\RecommendedSettings\Exceptions\SettingsException;

settings/config.settings.php

@@ -22,19 +22,19 @@
  */
 
 
- /**
-  * Site path.
-  *
-  * @var string $site_path
-  * This is always set and exposed by the Drupal Kernel.
-  */
+/**
+ * Site path.
+ *
+ * @var string $site_path
+ * This is always set and exposed by the Drupal Kernel.
+ */
  // phpcs:ignore
  $site_name = EnvironmentDetector::getSiteName($site_path);
 // phpcs:ignore
 // Config sync settings.
-$settings['config_sync_directory'] = "../config/" . $site_name . "/sync";
+$settings['config_sync_directory'] = "../config/" . $site_name;
 // Site Studio sync settings.
-$settings['site_studio_sync'] = "../config/" . $site_name . "/sitestudio";
+$settings['site_studio_sync'] = "../sitestudio/" . $site_name;
 
 $split_filename_prefix = 'config_split.config_split';
 

settings/default.global.settings.php settings/global/default.global.settings.php

@@ -2,7 +2,9 @@
 
 /**
  * @file
- * Generated by Acquia Drupal Recommended Settings. Serves as an example of global includes.
+ * Generated by Acquia Drupal Recommended Settings.
+ *
+ * Serves as an example of global includes.
  */
 
 /**
@@ -14,7 +16,8 @@
 /**
  * Include settings files in docroot/sites/settings.
  *
- * If instead you want to add settings to a specific site, see Acquia Drupal Recommended Settings includes
+ * If instead you want to add settings to a specific site, see
+ * Acquia Drupal Recommended Settings includes
  * file in docroot/sites/{site-name}/settings/default.includes.settings.php.
  */
 $additionalSettingsFiles = [

settings/default.includes.settings.php settings/site/default.includes.settings.php

@@ -12,20 +12,20 @@ class ArrayManipulator {
   /**
    * Merges arrays recursively while preserving.
    *
-   * @param array $array1
+   * @param string[] $array1
    *   The first array.
-   * @param array $array2
+   * @param string[] $array2
    *   The second array.
    *
-   * @return array
+   * @return string[]
    *   The merged array.
    *
    * @see http://php.net/manual/en/function.array-merge-recursive.php#92195
    */
   public static function arrayMergeRecursiveDistinct(
         array &$array1,
         array &$array2
-    ) {
+    ): array {
     $merged = $array1;
     foreach ($array2 as $key => &$value) {
       if (is_array($value) && isset($merged[$key]) && is_array($merged[$key])) {
@@ -45,13 +45,13 @@ public static function arrayMergeRecursiveDistinct(
    * E.g., [drush.alias => 'self'] would be expanded to
    * ['drush' => ['alias' => 'self']]
    *
-   * @param array $array
+   * @param string[] $array
    *   The array containing unexpanded dot-notated keys.
    *
-   * @return array
+   * @return string[]
    *   The expanded array.
    */
-  public static function expandFromDotNotatedKeys(array $array) {
+  public static function expandFromDotNotatedKeys(array $array): array {
     $data = new Data();
 
     // @todo Make this work at all levels of array.
@@ -69,13 +69,13 @@ public static function expandFromDotNotatedKeys(array $array) {
    * ['drush' => ['alias' => 'self']] would be flattened to
    * [drush.alias => 'self'].
    *
-   * @param array $array
+   * @param string[] $array
    *   The multidimensional array.
    *
-   * @return array
+   * @return string[]
    *   The flattened array.
    */
-  public static function flattenToDotNotatedKeys(array $array) {
+  public static function flattenToDotNotatedKeys(array $array): array {
     return self::flattenMultidimensionalArray($array, '.');
   }
 
@@ -86,15 +86,15 @@ public static function flattenToDotNotatedKeys(array $array) {
    * ['drush' => ['alias' => 'self']] would be flattened to
    * [drush.alias => 'self'].
    *
-   * @param array $array
+   * @param string[] $array
    *   The multidimensional array.
    * @param string $glue
    *   The character(s) to use for imploding keys.
    *
-   * @return array
+   * @return string[]
    *   The flattened array.
    */
-  public static function flattenMultidimensionalArray(array $array, $glue) {
+  public static function flattenMultidimensionalArray(array $array, string $glue): array {
     $iterator = new \RecursiveIteratorIterator(new \RecursiveArrayIterator($array));
     $result = [];
     foreach ($iterator as $leafValue) {
@@ -113,13 +113,13 @@ public static function flattenMultidimensionalArray(array $array, $glue) {
    *
    * Used primarily for rendering tables via Symfony Console commands.
    *
-   * @param array $array
+   * @param string[] $array
    *   The multi-dimensional array.
    *
-   * @return array
-   *   The human-readble, flat array.
+   * @return string[]
+   *   The human-readable, flat array.
    */
-  public static function convertArrayToFlatTextArray(array $array) {
+  public static function convertArrayToFlatTextArray(array $array): array {
     $rows = [];
     $max_line_length = 60;
     foreach ($array as $key => $value) {

settings/default.local.settings.php settings/site/default.local.settings.php

@@ -40,7 +40,7 @@ class RandomString {
    *
    * @see \Drupal\Component\Utility\Random::name()
    */
-  public static function string($length = 8, $unique = FALSE, callable $validator = NULL, $characters = '') {
+  public static function string(int $length = 8, bool $unique = FALSE, callable $validator = NULL, string $characters = ''): string {
     $counter = 0;
     $strings = [];
     $characters_array = $characters ? str_split($characters) : [];