Integrate gravatar image + GitHub link to README

Author: pH-7

composer.json

@@ -6,7 +6,8 @@
     "require": {
         "php": ">=8.0.0",
         "symfony/console": "^5.3",
-        "monolog/monolog": "^2.3"
+        "monolog/monolog": "^2.3",
+        "ph-7/ph2gravatar": "^1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

src/Command/Markdown/Builder.php

@@ -4,29 +4,46 @@
 
 namespace PH7\PhpReadmeGeneratorFile\Command\Markdown;
 
+use PH7\PH2Gravatar\Gravatar\Image;
+use PH7\PhpReadmeGeneratorFile\DefaultValue;
+
 class Builder
 {
-    private string $title;
+    private string $projectName;
 
     private string $heading;
 
     private string $description;
 
+    private string $requirements;
+
     private string $authorName;
 
     private string $authorEmail;
 
+    private string $authorWebpage;
+
     private string $licenseType;
 
+    private string $licenseLink;
+
+    private string $gravatarImage;
+
+    private string $githubUsername;
+
     public function __construct(array $data)
     {
-        $this->title = $data['title'];
+        $this->probjectName = $data['name'];
         $this->heading = $data['heading'];
         $this->description = $data['description'];
+        $this->projectRequirements = $data['requirements'];
         $this->authorName = $data['author'];
         $this->authorEmail = $data['email'];
+        $this->authorWebpage = $data['webpage'];
         $this->licenseType = $data['license'];
         $this->licenseLink = License::getLicenseLink($data['license']);
+        $this->gravatarImage = $this->getGravatar();
+        $this->githubUsername = $data['github'];
     }
 
     public function save(string $path): bool|int
@@ -39,26 +56,39 @@ private function getContents(): string
         return $this->parse(file_get_contents(__DIR__ . '/view/readme-template.md'));
     }
 
+    private function getGravatar(): string
+    {
+        return Image::get($this->authorEmail, ['size' => DefaultValue::GRAVATAR_SIZE]);
+    }
+
     private function parse(string $contents): string
     {
         return str_ireplace(
             [
-                ':TITLE:',
+                ':PROJECT-NAME:',
                 ':HEADING:',
                 ':DESCRIPTION:',
-                ':AUTHOR:',
+                ':REQUIREMENTS:',
+                ':AUTHOR-NAME:',
                 ':EMAIL:',
-                ':LICENSE_NAME:',
-                ':LICENSE_LINK:'
+                ':AUTHOR-URL:',
+                ':LICENSE-NAME:',
+                ':LICENSE-LINK:',
+                ':GRAVATAR-IMAGE:',
+                ':GITHUB-USERNAME:',
             ],
             [
-                $this->title,
+                $this->projectName,
                 $this->heading,
                 $this->description,
+                $this->requirements,
                 $this->authorName,
                 $this->authorEmail,
+                $this->authorWebpage,
                 $this->licenseType,
                 $this->licenseLink,
+                $this->gravatarImage,
+                $this->githubUsername,
             ],
             $contents
         );

src/Command/Markdown/Generator.php

@@ -25,13 +25,7 @@ public function __construct()
 
     protected function configure()
     {
-        $this
-            ->setName('markdown:generate')
-            ->addArgument(
-                'title',
-                InputArgument::REQUIRED,
-                'Project Name'
-            );
+        $this->setName('markdown:generate');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
@@ -77,18 +71,23 @@ private function treatFields(InputInterface $input, OutputInterface $output): ar
         $io = new SymfonyStyle($input, $output);
 
         try {
+            $name = $this->promptName($io);
             $heading = $this->promptHeading($io);
             $description = $this->promptDescription($io);
             $author = $this->promptAuthor($io);
             $email = $this->promptEmail($io);
+            $webpage = $this->promptHomepageUrl($io);
+            $githubUsername = $this->promptGithub($io);
             $license = $this->promptLicense($helper, $input, $output);
 
             return [
-                'title' => $input->getArgument('title'),
+                'name' => $name,
                 'heading' => $heading,
                 'description' => $description,
                 'author' => $author,
                 'email' => $email,
+                'webpage' => $webpage,
+                'github' => $githubUsername,
                 'license' => $license
             ];
         } catch (EmptyFieldException $e) {
@@ -98,6 +97,17 @@ private function treatFields(InputInterface $input, OutputInterface $output): ar
         }
     }
 
+    private function promptName(SymfonyStyle $io): string
+    {
+        $heading = $io->ask('Project Name');
+
+        if (!$this->isFieldFilled($heading)) {
+            throw new EmptyFieldException('Mention a name for your project 😺');
+        }
+
+        return $heading;
+    }
+
     private function promptHeading(SymfonyStyle $io): string
     {
         $heading = $io->ask('Project Heading');
@@ -142,6 +152,29 @@ private function promptEmail(SymfonyStyle $io): string
         return $email;
     }
 
+    private function promptHomepageUrl(SymfonyStyle $io): string
+    {
+        $webpage = $io->ask('Author Webpage');
+
+
+        if (!$this->isFieldFilled($webpage)) {
+            throw new EmptyFieldException('Can you mention your homepage (.e.g website, GitHub profile, etc).');
+        }
+
+        return $webpage;
+    }
+
+    private function promptGithub(SymfonyStyle $io): string
+    {
+        $github = $io->ask('GitHub Username');
+
+        if (!$this->isFieldFilled($github)) {
+            throw new EmptyFieldException('GitHub nickname is required.');
+        }
+
+        return $github;
+    }
+
     private function promptLicense(HelperInterface $helper, InputInterface $input, OutputInterface $output): string
     {
         $question = new ChoiceQuestion(

src/Command/Markdown/view/readme-template.md

@@ -1,14 +1,40 @@
-# :TITLE:
+# :PROJECT-NAME:
 
 ## :HEADING:
 
 :DESCRIPTION:
 
-## About
+## ⛏ Requirements
 
-:AUTHOR:, :EMAIL:
+:REQUIREMENTS:
 
+## 🏗 How to install it?
 
-## License
+<!-- Add what you need here -->
 
-[:LICENSE_NAME:](:LICENSE_LINK:)
+## 💭 How to use it?
+
+<!-- Add what you need here -->
+
+## 🪄 Author
+
+I'm **[:AUTHOR-NAME:][:AUTHOR-URL:]**. A passionate,  zen &amp; dedicated software engineer 😊
+
+
+![[github-url]][github-image]][github-url]
+
+---
+
+[![:AUTHOR-NAME:](:GRAVATAR:)](:AUTHOR-URL: ":AUTHOR-NAME:, a Software Developer")
+
+## 📃 License
+
+pH2Gravatar is distributed under [:LICENSE-NAME:](:LICENSE-LINK:) license 🚀 Enjoy! ❤️
+
+<!-- GitHub's Markdown reference links -->
+[author-url]: :AUTHOR-URL:
+[license-url]: :LICENSE-LINK:
+[github-url]: https://github.com/:GITHUB-USERNAME:
+[github-image]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white
+
+<!-- Generated by README Generator CLI: https://github.com/pH-7 -->