generate-readme.php

<?php

// Set the error reporting level to include all types of errors and warnings
error_reporting(E_ALL);

// Display errors on the screen (useful for debugging)
ini_set('display_errors', 1);

// Custom error handler function
function handleError($errno, $errstr, $errfile, $errline) {
    // Error message
    $message = "Error [$errno]: $errstr in $errfile on line $errline\n";

    // Display the error message
    echo $message;

    // Exit the script
    exit(1);
}

// Set the custom error handler
set_error_handler('handleError');

function createAssociativeArrayOfReqDirs_v1($currentFoldersRelativePathInConsideration = './', $directoryRegex = '/^task_/')
{
    $baseDir = getenv('BASE_DIR');
   
    // Check if the environment variable is defined
    if ($baseDir === false) {
        exit("Error: The environment variable BASE_DIR is not defined.\n");
    }

    $associativeArrayOfTasksetDirectories = [];

    $arrayOfRelativePathsOfChildFoldersInCurrentFolder = array_filter(
                                    glob($currentFoldersRelativePathInConsideration . '/*'), // The glob function in PHP searches for all files and directories that match the given pattern.
                                    'is_dir'
                                    ); //         arrayOfRelativePathsOfChildFoldersInCurrentFolder: Array ([0] => ./base/css/css_essential_training/taskset_css_css/task_000_zero, [1] => ./base/css/css_essential_training/taskset_css_css/task_001_one )
    sort($arrayOfRelativePathsOfChildFoldersInCurrentFolder);

    foreach ($arrayOfRelativePathsOfChildFoldersInCurrentFolder as $childFoldersRelativePathInCurrentFolder) { // childFoldersRelativePathInCurrentFolder: ./base/css/css_essential_training/taskset_css_css/task_000_zero
        $baseDirectoryName = trim(basename($childFoldersRelativePathInCurrentFolder)); // baseDirectoryName: task_000_zero

        if (preg_match($directoryRegex, $baseDirectoryName)) {
            $childFoldersAbsolutePathInCurrentFolder = realpath($childFoldersRelativePathInCurrentFolder); // childFoldersAbsolutePathInCurrentFolder: /Users/username/workspace/repoName/phpscript/task_001_createAssociativeArrayOfReqDirs/base/css/css_essential_training/taskset_css_css/task_000_zero
            $childFoldersRelativePathFromHome = substr($childFoldersAbsolutePathInCurrentFolder, strpos($childFoldersAbsolutePathInCurrentFolder, $baseDir)); // childFoldersRelativePathFromHome: base/css/css_essential_training/taskset_css_css/task_000_zero

            $arrayOfPathPartsFromHomeAfterRemovingSlash = explode(DIRECTORY_SEPARATOR, $childFoldersRelativePathFromHome); //                 arrayOfPathPartsFromHomeAfterRemovingSlash: Array([0] => base, [1] => css, [2] => css, [3] => taskset_css_css, [4] => task_000_zero)
            $parentDirOfCurrentTaskDirectory = $arrayOfPathPartsFromHomeAfterRemovingSlash[count($arrayOfPathPartsFromHomeAfterRemovingSlash) - 2]; // parentDirOfCurrentTaskDirectory: taskset_css_css

            if (!isset($associativeArrayOfTasksetDirectories[$parentDirOfCurrentTaskDirectory])) { // if not initialized, initialize it as an empty array
                $associativeArrayOfTasksetDirectories[$parentDirOfCurrentTaskDirectory] = []; // associativeArrayOfTasksetDirectories[taskset_css_css]: task_000_zero base/css/css_essential_training/taskset_css_css/task_000_zero
            }
            $associativeArrayOfTasksetDirectories[$parentDirOfCurrentTaskDirectory][] = "$baseDirectoryName $childFoldersRelativePathFromHome"; // $associativeArrayOfTasksetDirectories[$parentDirOfCurrentTaskDirectory][]: The [] notation is used to append an element to the array associated with the key $parentDirOfCurrentTaskDirectory. 
        }

        if (!empty(glob("$childFoldersRelativePathInCurrentFolder/*"))) { // The glob function in PHP searches for all files and directories that match the given pattern. The !empty(...) condition checks if the array returned by glob is not empty, meaning that there are files or subdirectories present in the directory.
            $associativeArrayOfTasksetDirectories = array_merge($associativeArrayOfTasksetDirectories, createAssociativeArrayOfReqDirs_v1($childFoldersRelativePathInCurrentFolder));
        }
    }
    return $associativeArrayOfTasksetDirectories;
}




function createIndividualSectionsMarkdown($associativeArrayOfReqDirs)
{
    $baseDir = getenv('BASE_DIR');

    // Check if the environment variable is defined
    if ($baseDir === false) {
        exit("Error: The environment variable BASE_DIR is not defined.\n");
    }
    foreach ($associativeArrayOfReqDirs as $tasksetDirectoryKey => $arrayOfDirectoriesInTasksetDirectory) {
        $markdown = '';
        $numberOfTasksInTasksetDirectory = count($arrayOfDirectoriesInTasksetDirectory);
        $pattern = sprintf('/%s\/.*?(?=\/task_)/', preg_quote($baseDir, '/'));
        preg_match($pattern, $arrayOfDirectoriesInTasksetDirectory[0], $matches);
        if (!isset($matches[0])) {
            echo "No match found for pattern $pattern. Skipping...\n";
            continue;
        }
        $relativePathToTasksetDirectoryReadMeFile = $matches[0];
        $relativePathToTasksetDirectoryReadMeFile = substr($relativePathToTasksetDirectoryReadMeFile, 0, strrpos($relativePathToTasksetDirectoryReadMeFile, '/'));

        $markdown .= "# $tasksetDirectoryKey\n\n> [Auto](https://github.com/codeaprendiz/learn_fullstack/blob/main/home/php/intermediate/taskset_intermediate_php/task_004_createGlobalMarkdownTable/generate-readme.php) generated ReadMe. Number of tasks: $numberOfTasksInTasksetDirectory\n";
        // Check if ReadMe_static.md file exists
        if (file_exists($relativePathToTasksetDirectoryReadMeFile . '/ReadMe_static.md')) {
            $commandToGetStaticContentOfTasksetDirectory = 'cat ' . $relativePathToTasksetDirectoryReadMeFile .'/ReadMe_static.md | egrep -v ReadMe_static';
            $staticContentOfTasksetDirectory = shell_exec($commandToGetStaticContentOfTasksetDirectory);
            $markdown .= $staticContentOfTasksetDirectory;
        }

        
        $markdown .= "\n| Task | Description |\n";
        $markdown .= "| --- | --- |\n";
        foreach ($arrayOfDirectoriesInTasksetDirectory as $taskDirectoryChildFolderConcatenatedWithRelativePath) {
            $taskNumber = substr($taskDirectoryChildFolderConcatenatedWithRelativePath, strpos($taskDirectoryChildFolderConcatenatedWithRelativePath, 'task_'), 8);
            $arrayOfChildFolderNameAndItsRelativePath=explode(' ', $taskDirectoryChildFolderConcatenatedWithRelativePath);
            $childFolderName=$arrayOfChildFolderNameAndItsRelativePath[0];
            $childFolderName=$arrayOfChildFolderNameAndItsRelativePath[0];
            $arrayOfChildFoldersRelativePathExplodedWithSlash = explode('/', $arrayOfChildFolderNameAndItsRelativePath[1]);
            $tasksetDirectoryName = $arrayOfChildFoldersRelativePathExplodedWithSlash[count($arrayOfChildFoldersRelativePathExplodedWithSlash) - 2]; // second last element
            $markdown .= "| $taskNumber | [$childFolderName]($tasksetDirectoryName/$childFolderName) |\n";
        }
        file_put_contents($relativePathToTasksetDirectoryReadMeFile . '/ReadMe.md', $markdown);
    }
}

function createGlobalMarkdownTable($associativeArrayOfReqDirs) {

    $baseDir = getenv('BASE_DIR');

    // Check if the environment variable is defined
    if ($baseDir === false) {
        exit("Error: The environment variable BASE_DIR is not defined.\n");
    }

    // Retrieve the 'MAX_COLUMNS' environment variable
    $maxColumns = getenv('MAX_COLUMNS');

    // Check if the environment variable is set and is a valid number
    if ($maxColumns === false || !is_numeric($maxColumns)) {
        // If not set or not valid, use the default value
        $maxColumns = 5;
    }
    
    // Execute the find command and count the number of lines
    $commandToGetTotalNumberOfTasks = 'find . -name "task_*" | wc -l';
    $totalNumberOfTasks = shell_exec($commandToGetTotalNumberOfTasks);
    // remove whitespace from the beginning and end of the string
    $totalNumberOfTasks = trim($totalNumberOfTasks);
    ## First heading of ReadMe.md
    $markdown = "# Home\n\n> [Auto](https://github.com/codeaprendiz/learn_fullstack/blob/main/home/php/intermediate/taskset_intermediate_php/task_004_createGlobalMarkdownTable/generate-readme.php) generated ReadMe. Number of tasks: $totalNumberOfTasks\n\n";
    
    // ls -ltrh base | egrep -v "total" | awk '{print "\"" $9 "\","}' |  tr -d "\"," |  sort
    $commandToGetAllFoldersInCurrentDir='ls -ltrh ' . $baseDir . ' | egrep -v "total|ReadMe.md" | awk \'{print "\"" $9 "\","}\' |  tr -d "\"," | sort';
    $arrayOfFolderNames = shell_exec($commandToGetAllFoldersInCurrentDir); // Array ( [0] => css, [1] => javascript )
   
    // Convert the string to an array, splitting by new lines and trimming each line
    $arrayOfFolderNames = array_filter(array_map('trim', explode("\n", $arrayOfFolderNames)));
    
    ## Create the table of contents section
    foreach ($arrayOfFolderNames as $folderName) { // folderName=css $folderName is the value of the current element
        $groupName=$folderName; // folderName=css
        $groupName = str_replace('_', ' ', $groupName); // folderName=css , replacing _ with space if present
        $markdown .= "- [$groupName](#$folderName)\n"; // Adding following line to markdown: - [css](#css)
    }
   
    foreach ($arrayOfFolderNames as $folderName) { // folderName=css
        $markdown .= "\n"; // Adding a new line to markdown
        $arrayOfMatchingTasksetDirectory = array_filter(   // filters the keys of $associativeArrayOfReqDirs to return only those that contain the substring $group, resulting in an array of matching keys.
            array_keys($associativeArrayOfReqDirs),
            function ($tasksetDirectoryKey) use ($folderName) {
                return preg_match('/_' . preg_quote($folderName, '/') . '$/', $tasksetDirectoryKey); # the key should match the pattern _css at the end of the key. So _javascript will not match _java
            }
        ); //    arrayOfMatchingTasksetDirectory = Array ( [0] => taskset_css_essential_training, [1] => taskset_getting_started_with_css, [2] => taskset_intermediate_html_and_css )

        ## Add the folderName name like CSS or Javascript as a heading
        $markdown .= "## $folderName\n"; // Adding following line to markdown: ## css

        if (file_exists('./' . $baseDir . '/' . $folderName . '/ReadMe_static.md')) {
            $markdown .= "\n[Useful Links](./$baseDir/$folderName/ReadMe_static.md)\n"; // Adding following line to markdown: [Useful Links](./base/css/ReadMe.md)
        }
        
        $rowHeader = "";
        
        foreach ($arrayOfMatchingTasksetDirectory as $matchingTasksetDirectory) { // matchingTasksetDirectory=taskset_css_essential_training_css
            // remove taskset_ and $folderName from matchingTasksetDirectory. Note $folderName is always at the end of matchingTasksetDirectory
            $matchingTasksetDirectory = str_replace('taskset_', '', $matchingTasksetDirectory); // matchingTasksetDirectory=css_essential_training_css
            // strip off the $folderName from the end of matchingTasksetDirectory
            $matchingTasksetDirectory = substr($matchingTasksetDirectory, 0, strrpos($matchingTasksetDirectory, $folderName)); // matchingTasksetDirectory=css_essential_training_ 
            // remove trailing _ from matchingTasksetDirectory
            $matchingTasksetDirectory = rtrim($matchingTasksetDirectory, '_'); // matchingTasksetDirectory=css_essential_training
            $rowHeader .= " $matchingTasksetDirectory |"; // Adding following words to rowHeader line: Css_essential_training |
            
        }

        // explode rowHeader with |
        $rowHeader = explode('|', $rowHeader);

        $rowData = "";



        foreach ($arrayOfMatchingTasksetDirectory as $matchingTasksetDirectory) { // matchingTasksetDirectory=taskset_css_essential_training
            $pattern = sprintf('/%s\/.*?(?=\/task_)/', preg_quote($baseDir, '/'));
            preg_match($pattern, $associativeArrayOfReqDirs[$matchingTasksetDirectory][0], $matches);
            $relativePathToTasksetDirectoryReadMeFile = $matches[0]; // relativePathToTasksetDirectoryReadMeFile: base/css/css_essential_training_essential_training/taskset_css_essential_training
            $relativePathToTasksetDirectoryReadMeFile = substr($relativePathToTasksetDirectoryReadMeFile, 0, strrpos($relativePathToTasksetDirectoryReadMeFile, '/')); // relativePathToTasksetDirectoryReadMeFile: base/css/css_essential_training_essential_training  
            $linkToDir = $relativePathToTasksetDirectoryReadMeFile; // linkToDir: base/css/css_essential_training
            $commandToGetAllFoldersInCurrentDir='ls -ltrh ' . $linkToDir . '/taskset*/ | tail -n +2 | wc -l'; # tail -n +2 ignores the first line of output
            $totalNumberOfTasks = shell_exec($commandToGetAllFoldersInCurrentDir);
            // trim whitespace from the beginning and end of the string
            $totalNumberOfTasks = trim($totalNumberOfTasks);
            $rowData .= " [Tasks: $totalNumberOfTasks]($linkToDir) |";
        }

        $rowData = explode('|', $rowData);

        $lastColumnPosition=0;
        $activeColumnPosition=0;
        $maxAllowedColumnsInRow=$maxColumns;
        // print("\nRowHeader ");print_r($rowHeader);
        $twoSlashNsRequired="No"; // One \n is required the first time, two \n are required after that
        // While $lastColumnPosition is less than the length of the rowHeader array
        while ($lastColumnPosition < count($rowHeader)-1) {
            $maxAllowedColumnsInRow = $lastColumnPosition + $maxColumns;
            // Start the row with a pipe
            if ($twoSlashNsRequired=="No") {
                $markdown .= "\n|";
                $twoSlashNsRequired="Yes";
            }
            else {
                $markdown .= "\n\n|";
            }
            // Iterate over the rowHeader array by incrementing $activeColumnPosition and $lastColumnPosition until the maximum number of columns is reached
            for ($activeColumnPosition = $lastColumnPosition; $activeColumnPosition < $maxAllowedColumnsInRow; $activeColumnPosition++) {
                // If rowHeader[$activeColumnPosition] is empty, break the loop
                if (empty($rowHeader[$activeColumnPosition])) {
                    break;
                }
                // print("\nActiveColumnPosition: ");print($activeColumnPosition);
                // print("\nLastColumnPosition: ");print($lastColumnPosition);
                // print("\nMaxAllowedColumnsInRow: ");print($maxAllowedColumnsInRow);
                // print("\nRowHeader[ActiveColumnPosition]: ");print($rowHeader[$activeColumnPosition]);
                $markdown .= $rowHeader[$activeColumnPosition];
                $markdown .= "|";
            }

            // Add |---|---| as per number of allowed columns in a row
            $markdown .= "\n";
            $markdown .= "|";
            for ($activeColumnPosition=$lastColumnPosition; $activeColumnPosition < $maxAllowedColumnsInRow; $activeColumnPosition++) {
                // If rowHeader[$activeColumnPosition] is empty, break the loop
                if (empty($rowHeader[$activeColumnPosition])) {
                    break;
                }
                $markdown .= " --- |";
            }


            // Add rowData for each row as per maximum allowed columns
            $markdown .= "\n";
            $markdown .= "|";
            for ($activeColumnPosition = $lastColumnPosition; $activeColumnPosition < $maxAllowedColumnsInRow; $activeColumnPosition++) {
                // If rowHeader[$activeColumnPosition] is empty, break the loop
                if (empty($rowHeader[$activeColumnPosition])) {
                break;
                }
                $markdown .= $rowData[$activeColumnPosition];
                $markdown .= "|";
            }

            $lastColumnPosition=$activeColumnPosition;
            // print("\nLastColumnPosition: ");print($lastColumnPosition);

            
        }


        $markdown .= "\n";

        // All caps certain words in markdown like AWS, GCP, OS etc
        $markdown = str_replace('Aws', 'AWS', $markdown);
        $markdown = str_replace('Oci', 'OCI', $markdown);
        $markdown = str_replace('Gcp', 'GCP', $markdown);
        $markdown = str_replace('Os', 'OS', $markdown);

    }

    return $markdown;
}

$associativeArrayOfReqDirs = createAssociativeArrayOfReqDirs_v1('.', '/^task_/'); // if first call is for ".", second call is for "./base" and so on as the function is recursive

createIndividualSectionsMarkdown($associativeArrayOfReqDirs);

$globalMarkdownTable = createGlobalMarkdownTable($associativeArrayOfReqDirs);

file_put_contents('ReadMe.md', $globalMarkdownTable);

?>