@codigodoleo/wp-kit 2.0.4 → 3.0.1

package/modules/docs/templates/docs/Desenvolvimento.md

@@ -14,7 +14,7 @@ graph LR
     A --> C[feature/another-feature]
     A --> D[hotfix/critical-fix]
     A --> E[release/v1.2.0]
-    
+
     B --> F[MR to development]
     C --> F
     E --> G[MR to staging]
@@ -24,12 +24,12 @@ graph LR
     J --> I
     I --> K[MR to master]
     K --> L[master]
-    
+
     D --> M[MR to master]
     M --> L
     D --> N[MR to development]
     N --> H
-    
+
     style A fill:#ff6b6b
     style H fill:#feca57
     style I fill:#48dbfb
@@ -38,13 +38,13 @@ graph LR
 
 ### **Tipos de Branches**
 
-| Branch Type | Prefixo | Origem | Destino | Merge Via | Finalidade |
-|-------------|---------|--------|---------|-----------|------------|
-| **Feature** | `feature/` | `master` | `development` | **MR** | Novas funcionalidades |
-| **Bugfix** | `bugfix/` | `master` | `development` | **MR** | Correções não-críticas |
-| **Hotfix** | `hotfix/` | `master` | `master` + `development` | **MR** | Correções críticas |
-| **Release** | `release/` | `master` | `staging` → `master` | **MR** | Preparação de releases |
-| **Chore** | `chore/` | `master` | `development` | **MR** | Manutenção, docs, etc. |
+| Branch Type | Prefixo    | Origem   | Destino                  | Merge Via | Finalidade             |
+| ----------- | ---------- | -------- | ------------------------ | --------- | ---------------------- |
+| **Feature** | `feature/` | `master` | `development`            | **MR**    | Novas funcionalidades  |
+| **Bugfix**  | `bugfix/`  | `master` | `development`            | **MR**    | Correções não-críticas |
+| **Hotfix**  | `hotfix/`  | `master` | `master` + `development` | **MR**    | Correções críticas     |
+| **Release** | `release/` | `master` | `staging` → `master`     | **MR**    | Preparação de releases |
+| **Chore**   | `chore/`   | `master` | `development`            | **MR**    | Manutenção, docs, etc. |
 
 ### **Nomenclatura de Branches**
 
@@ -108,7 +108,7 @@ graph TD
     N --> O[Final Code Review + Approval]
     O --> P[✅ Merge to master via MR]
     P --> Q[Deploy to www.pipefy.com]
-    
+
     style F fill:#1dd1a1
     style K fill:#1dd1a1
     style P fill:#1dd1a1
@@ -166,7 +166,7 @@ git commit -m "fix: patch critical security vulnerability in user authentication
 git push origin hotfix/critical-security-patch
 
 # 3. DUAS Merge Requests simultâneas (OBRIGATÓRIO)
-# 
+#
 # MR 1: hotfix → master (para produção imediata)
 # - Create MR: hotfix/critical-security-patch → master
 # - Assign senior reviewers
@@ -185,22 +185,27 @@ git push origin hotfix/critical-security-patch
 
 ```markdown
 ## 🎯 Merge Request Title
+
 Brief description of changes
 
 ## 📝 Description
+
 Detailed description of what this MR does and why.
 
 ## 🔗 Related Issues
+
 - Closes #123
 - Relates to #456
 
 ## 🧪 Testing
+
 - [ ] Unit tests pass
 - [ ] Integration tests pass
 - [ ] Manual testing completed
 - [ ] Tested in local environment
 
 ## 📋 Checklist
+
 - [ ] Code follows project standards
 - [ ] All tests pass
 - [ ] Documentation updated
@@ -208,22 +213,25 @@ Detailed description of what this MR does and why.
 - [ ] No breaking changes (or properly documented)
 
 ## 🖼️ Screenshots (if applicable)
+
 Before/After screenshots for UI changes
 
 ## 🚀 Deployment Notes
+
 Any special deployment considerations
 
 ## 👥 Reviewers
+
 @senior-dev @team-lead
 ```
 
 ### **Aprovações Obrigatórias por Branch**
 
-| Target Branch | Reviewers Required | Auto-merge | Finalidade |
-|---------------|-------------------|------------|------------|
-| **development** | 1 senior dev | ❌ | Features, bugfixes |
-| **staging** | 2 senior devs | ❌ | Release preparation |
-| **master** | 2 senior devs + 1 lead | ❌ | Production releases |
+| Target Branch   | Reviewers Required     | Auto-merge | Finalidade          |
+| --------------- | ---------------------- | ---------- | ------------------- |
+| **development** | 1 senior dev           | ❌         | Features, bugfixes  |
+| **staging**     | 2 senior devs          | ❌         | Release preparation |
+| **master**      | 2 senior devs + 1 lead | ❌         | Production releases |
 
 ### **Configuração GitLab (Merge Request Rules)**
 
@@ -232,18 +240,18 @@ Any special deployment considerations
 push_rules:
   development:
     required_approvals: 1
-    required_approval_groups: ["senior-developers"]
+    required_approval_groups: ['senior-developers']
     allow_force_push: false
-    
+
   staging:
     required_approvals: 2
-    required_approval_groups: ["senior-developers"]
+    required_approval_groups: ['senior-developers']
     allow_force_push: false
     require_code_owner_reviews: true
-    
+
   master:
     required_approvals: 2
-    required_approval_groups: ["senior-developers", "tech-leads"]
+    required_approval_groups: ['senior-developers', 'tech-leads']
     allow_force_push: false
     require_code_owner_reviews: true
     dismiss_stale_reviews: true
@@ -293,56 +301,56 @@ git push origin feature/my-feature
 
 ```json
 {
-    "name": "pipefy/wordpress-website",
-    "description": "Pipefy WordPress Website",
-    "type": "project",
-    "require": {
-        "php": ">=8.0",
-        "composer/installers": "^2.0",
-        "wpackagist-plugin/advanced-custom-fields-pro": "*",
-        "wpackagist-plugin/wp-rocket": "*"
-    },
-    "require-dev": {
-        "phpunit/phpunit": "^9.0",
-        "squizlabs/php_codesniffer": "*",
-        "dealerdirect/phpcodesniffer-composer-installer": "*",
-        "wp-coding-standards/wpcs": "*"
-    },
-    "repositories": [
-        {
-            "type": "composer",
-            "url": "https://wpackagist.org"
-        },
-        {
-            "type": "package",
-            "package": {
-                "name": "advanced-custom-fields/advanced-custom-fields-pro",
-                "version": "6.0.0",
-                "type": "wordpress-plugin",
-                "dist": {
-                    "type": "zip",
-                    "url": "https://connect.advancedcustomfields.com/..."
-                }
-            }
-        }
-    ],
-    "extra": {
-        "installer-paths": {
-            "dist/wp-content/plugins/{$name}/": ["type:wordpress-plugin"],
-            "dist/wp-content/themes/{$name}/": ["type:wordpress-theme"]
-        }
+  "name": "pipefy/wordpress-website",
+  "description": "Pipefy WordPress Website",
+  "type": "project",
+  "require": {
+    "php": ">=8.0",
+    "composer/installers": "^2.0",
+    "wpackagist-plugin/advanced-custom-fields-pro": "*",
+    "wpackagist-plugin/wp-rocket": "*"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^9.0",
+    "squizlabs/php_codesniffer": "*",
+    "dealerdirect/phpcodesniffer-composer-installer": "*",
+    "wp-coding-standards/wpcs": "*"
+  },
+  "repositories": [
+    {
+      "type": "composer",
+      "url": "https://wpackagist.org"
     },
-    "autoload": {
-        "psr-4": {
-            "Pipefy\\": "dist/wp-content/themes/pipefy-2020/inc/"
+    {
+      "type": "package",
+      "package": {
+        "name": "advanced-custom-fields/advanced-custom-fields-pro",
+        "version": "6.0.0",
+        "type": "wordpress-plugin",
+        "dist": {
+          "type": "zip",
+          "url": "https://connect.advancedcustomfields.com/..."
         }
-    },
-    "scripts": {
-        "install-plugins": "composer install --no-dev",
-        "test": "phpunit",
-        "lint": "phpcs --standard=WordPress dist/wp-content/themes/pipefy-2020/",
-        "format": "phpcbf --standard=WordPress dist/wp-content/themes/pipefy-2020/"
+      }
+    }
+  ],
+  "extra": {
+    "installer-paths": {
+      "dist/wp-content/plugins/{$name}/": ["type:wordpress-plugin"],
+      "dist/wp-content/themes/{$name}/": ["type:wordpress-theme"]
     }
+  },
+  "autoload": {
+    "psr-4": {
+      "Pipefy\\": "dist/wp-content/themes/pipefy-2020/inc/"
+    }
+  },
+  "scripts": {
+    "install-plugins": "composer install --no-dev",
+    "test": "phpunit",
+    "lint": "phpcs --standard=WordPress dist/wp-content/themes/pipefy-2020/",
+    "format": "phpcbf --standard=WordPress dist/wp-content/themes/pipefy-2020/"
+  }
 }
 ```
 
@@ -425,15 +433,15 @@ create_release:
     - |
       # Atualizar version no style.css
       sed -i "s/Version: .*/Version: ${CI_COMMIT_TAG#v}/" dist/wp-content/themes/pipefy-2020/style.css
-      
+
       # Atualizar version no functions.php
       sed -i "s/PIPEFY_THEME_VERSION', '.*'/PIPEFY_THEME_VERSION', '${CI_COMMIT_TAG#v}'/" dist/wp-content/themes/pipefy-2020/functions.php
-      
+
       # Commit das mudanças
       git add .
       git commit -m "chore: bump version to ${CI_COMMIT_TAG}"
       git push origin HEAD:master
-      
+
     - echo "Release ${CI_COMMIT_TAG} created successfully"
   only:
     - tags
@@ -453,36 +461,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+
 - New feature in development
 
 ### Changed
+
 - Improved existing functionality
 
 ### Fixed
+
 - Bug fixes
 
 ## [1.2.3] - 2025-06-05
 
 ### Added
+
 - User profile avatar upload functionality
 - Enhanced security measures for file uploads
 - New Gutenberg block for testimonials
 
 ### Changed
+
 - Improved performance of image loading
 - Updated WordPress core to latest version
 - Refactored authentication system
 
 ### Fixed
+
 - Fixed responsive header issue on mobile devices
 - Resolved caching issue with dynamic content
 - Fixed accessibility issues in navigation
 
 ### Security
+
 - Patched XSS vulnerability in contact form
 - Updated dependencies with security fixes
 
 ## [1.2.2] - 2025-05-23
+
 ...
 ```
 
@@ -494,11 +510,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 // ✅ Correto
 class UserProfileManager {
     private $userRepository;
-    
+
     public function updateUserAvatar($userId, $avatarData) {
         // implementation
     }
-    
+
     private function validateImageFormat($imageData) {
         // implementation
     }
@@ -507,7 +523,7 @@ class UserProfileManager {
 // ❌ Incorreto
 class GerenciadorPerfilUsuario {
     private $repositorioUsuario;
-    
+
     public function atualizarAvatarUsuario($idUsuario, $dadosAvatar) {
         // implementation
     }
@@ -551,48 +567,48 @@ payment-gateway-config.php
 ```scss
 // Block: componente independente
 .hero-section {
-    padding: 2rem;
-    background: #fff;
-    
-    // Element: parte do block
-    &__title {
-        font-size: 2.5rem;
-        font-weight: bold;
-        color: #333;
-    }
-    
-    &__subtitle {
-        font-size: 1.2rem;
-        color: #666;
+  padding: 2rem;
+  background: #fff;
+
+  // Element: parte do block
+  &__title {
+    font-size: 2.5rem;
+    font-weight: bold;
+    color: #333;
+  }
+
+  &__subtitle {
+    font-size: 1.2rem;
+    color: #666;
+  }
+
+  &__button {
+    padding: 1rem 2rem;
+    background: #007cba;
+    color: white;
+    border: none;
+
+    // Modifier: variação do element
+    &--large {
+      padding: 1.5rem 3rem;
+      font-size: 1.2rem;
     }
-    
-    &__button {
-        padding: 1rem 2rem;
-        background: #007cba;
-        color: white;
-        border: none;
-        
-        // Modifier: variação do element
-        &--large {
-            padding: 1.5rem 3rem;
-            font-size: 1.2rem;
-        }
-        
-        &--secondary {
-            background: #666;
-            color: white;
-        }
+
+    &--secondary {
+      background: #666;
+      color: white;
     }
-    
-    // Modifier: variação do block
-    &--dark-theme {
-        background: #333;
-        color: white;
-        
-        .hero-section__title {
-            color: white;
-        }
+  }
+
+  // Modifier: variação do block
+  &--dark-theme {
+    background: #333;
+    color: white;
+
+    .hero-section__title {
+      color: white;
     }
+  }
 }
 ```
 
@@ -607,27 +623,27 @@ class UserController {
             wp_send_json_error('User not found', 404);
             return;
         }
-        
+
         if (!current_user_can('edit_user', $userId)) {
             wp_send_json_error('Insufficient permissions', 403);
             return;
         }
-        
+
         // Update logic
     }
-    
+
     public function deleteProfile($userId) {
         $user = get_user_by('ID', $userId);
         if (!$user) {
             wp_send_json_error('User not found', 404);
             return;
         }
-        
+
         if (!current_user_can('delete_user', $userId)) {
             wp_send_json_error('Insufficient permissions', 403);
             return;
         }
-        
+
         // Delete logic
     }
 }
@@ -640,26 +656,26 @@ class UserController {
             wp_send_json_error('User not found', 404);
             return false;
         }
-        
+
         if (!current_user_can($capability, $userId)) {
             wp_send_json_error('Insufficient permissions', 403);
             return false;
         }
-        
+
         return $user;
     }
-    
+
     public function updateProfile($userId, $data) {
         $user = $this->validateUserAccess($userId, 'edit_user');
         if (!$user) return;
-        
+
         // Update logic
     }
-    
+
     public function deleteProfile($userId) {
         $user = $this->validateUserAccess($userId, 'delete_user');
         if (!$user) return;
-        
+
         // Delete logic
     }
 }
@@ -676,26 +692,26 @@ namespace Pipefy\Services;
 class UserService {
     private $userRepository;
     private $emailService;
-    
+
     public function __construct(UserRepository $userRepository, EmailService $emailService) {
         $this->userRepository = $userRepository;
         $this->emailService = $emailService;
     }
-    
+
     public function createUser(array $userData): User {
         $this->validateUserData($userData);
-        
+
         $user = $this->userRepository->create($userData);
         $this->emailService->sendWelcomeEmail($user);
-        
+
         return $user;
     }
-    
+
     private function validateUserData(array $data): void {
         if (empty($data['email'])) {
             throw new InvalidArgumentException('Email is required');
         }
-        
+
         if (!filter_var($data['email'], FILTER_VALIDATE_EMAIL)) {
             throw new InvalidArgumentException('Invalid email format');
         }
@@ -721,28 +737,28 @@ class UserRepository implements UserRepositoryInterface {
         $userData = get_user_by('ID', $id);
         return $userData ? new User($userData) : null;
     }
-    
+
     public function create(array $data): User {
         $userId = wp_insert_user($data);
-        
+
         if (is_wp_error($userId)) {
             throw new Exception('Failed to create user: ' . $userId->get_error_message());
         }
-        
+
         return $this->find($userId);
     }
-    
+
     public function update(int $id, array $data): User {
         $data['ID'] = $id;
         $result = wp_update_user($data);
-        
+
         if (is_wp_error($result)) {
             throw new Exception('Failed to update user: ' . $result->get_error_message());
         }
-        
+
         return $this->find($id);
     }
-    
+
     public function delete(int $id): bool {
         return wp_delete_user($id);
     }
@@ -761,7 +777,7 @@ class User {
     private $firstName;
     private $lastName;
     private $avatar;
-    
+
     public function __construct($userData) {
         $this->id = $userData->ID;
         $this->email = $userData->user_email;
@@ -769,23 +785,23 @@ class User {
         $this->lastName = $userData->last_name;
         $this->avatar = get_user_meta($userData->ID, 'avatar', true);
     }
-    
+
     public function getId(): int {
         return $this->id;
     }
-    
+
     public function getEmail(): string {
         return $this->email;
     }
-    
+
     public function getFullName(): string {
         return trim($this->firstName . ' ' . $this->lastName);
     }
-    
+
     public function getAvatar(): ?string {
         return $this->avatar;
     }
-    
+
     public function toArray(): array {
         return [
             'id' => $this->id,
@@ -825,35 +841,35 @@ composer require --dev wp-coding-standards/wpcs
 <?xml version="1.0"?>
 <ruleset name="Pipefy WordPress Coding Standards">
     <description>Pipefy WordPress coding standards</description>
-    
+
     <!-- Include WordPress-Core standards -->
     <rule ref="WordPress-Core">
         <!-- Exclude filename rules -->
         <exclude name="WordPress.Files.FileName"/>
     </rule>
-    
+
     <!-- Include WordPress-Extra standards -->
     <rule ref="WordPress-Extra">
         <!-- Allow short array syntax -->
         <exclude name="Generic.Arrays.DisallowShortArraySyntax"/>
     </rule>
-    
+
     <!-- Include WordPress-Docs standards -->
     <rule ref="WordPress-Docs"/>
-    
+
     <!-- Check only PHP files -->
     <arg name="extensions" value="php"/>
-    
+
     <!-- Show colors in output -->
     <arg name="colors"/>
-    
+
     <!-- Show progress -->
     <arg value="p"/>
-    
+
     <!-- Include paths -->
     <file>dist/wp-content/themes/pipefy-2020/</file>
     <file>dist/wp-content/mu-plugins/</file>
-    
+
     <!-- Exclude paths -->
     <exclude-pattern>*/vendor/*</exclude-pattern>
     <exclude-pattern>*/node_modules/*</exclude-pattern>
@@ -876,49 +892,49 @@ class UserServiceTest extends TestCase {
     private $userService;
     private $userRepository;
     private $emailService;
-    
+
     protected function setUp(): void {
         $this->userRepository = $this->createMock(UserRepository::class);
         $this->emailService = $this->createMock(EmailService::class);
         $this->userService = new UserService($this->userRepository, $this->emailService);
     }
-    
+
     public function testCreateUserWithValidData(): void {
         $userData = [
             'email' => 'test@example.com',
             'first_name' => 'John',
             'last_name' => 'Doe'
         ];
-        
+
         $expectedUser = new User((object) array_merge($userData, ['ID' => 1]));
-        
+
         $this->userRepository
             ->expects($this->once())
             ->method('create')
             ->with($userData)
             ->willReturn($expectedUser);
-            
+
         $this->emailService
             ->expects($this->once())
             ->method('sendWelcomeEmail')
             ->with($expectedUser);
-        
+
         $result = $this->userService->createUser($userData);
-        
+
         $this->assertInstanceOf(User::class, $result);
         $this->assertEquals('test@example.com', $result->getEmail());
     }
-    
+
     public function testCreateUserWithInvalidEmailThrowsException(): void {
         $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('Invalid email format');
-        
+
         $userData = [
             'email' => 'invalid-email',
             'first_name' => 'John',
             'last_name' => 'Doe'
         ];
-        
+
         $this->userService->createUser($userData);
     }
 }
@@ -932,42 +948,49 @@ class UserServiceTest extends TestCase {
 ## Code Review Checklist
 
 ### ✅ Functionality
+
 - [ ] Code implements requirements correctly
 - [ ] Edge cases are handled appropriately
 - [ ] Error handling is implemented
 - [ ] Performance considerations are addressed
 
 ### ✅ Code Quality
+
 - [ ] Code follows DRY principles
 - [ ] Functions are single-responsibility
 - [ ] Variable and function names are descriptive (in English)
 - [ ] Code is readable and well-structured
 
 ### ✅ Standards Compliance
+
 - [ ] Follows WordPress coding standards
 - [ ] BEM methodology for CSS
 - [ ] PSR-12 compliance for PHP
 - [ ] Semantic versioning for releases
 
 ### ✅ Security
+
 - [ ] Input validation is implemented
 - [ ] SQL injection prevention
 - [ ] XSS prevention
 - [ ] CSRF protection where needed
 
 ### ✅ Testing
+
 - [ ] Unit tests are included
 - [ ] Test coverage is adequate
 - [ ] Integration tests pass
 - [ ] Manual testing completed
 
 ### ✅ Documentation
+
 - [ ] Code is properly documented
 - [ ] README updated if needed
 - [ ] CHANGELOG updated for user-facing changes
 - [ ] API documentation updated
 
 ### ✅ Merge Request Process
+
 - [ ] MR template properly filled
 - [ ] Target branch is correct
 - [ ] Required approvals obtained
@@ -978,7 +1001,7 @@ class UserServiceTest extends TestCase {
 
 ```bash
 # Formato: type(scope): description
-# 
+#
 # Types:
 # feat: nova funcionalidade
 # fix: correção de bug
@@ -1113,4 +1136,4 @@ function pipefy_get_responsive_image($attachment_id, $sizes = 'full') {
 📦 **Dependencies**: Composer-based plugin management  
 🧪 **Quality**: PHPCS + Unit Tests + Code Review  
 🎨 **Standards**: BEM + DRY + Laravel-inspired architecture  
-✅ **Process**: **Merge Requests obrigatórios para staging/master**
+✅ **Process**: **Merge Requests obrigatórios para staging/master**