@mytechtoday/augment-extensions 0.1.2 → 0.4.0

package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php

@@ -0,0 +1,234 @@
+<?php
+
+/**
+ * Legacy Code Refactoring Example
+ * 
+ * This example demonstrates refactoring procedural PHP code to modern OOP with:
+ * - Namespaces (PSR-4)
+ * - Type hints (PHP 8+)
+ * - Dependency injection
+ * - Single responsibility principle
+ * - Proper error handling
+ */
+
+// ============================================================================
+// BEFORE: Legacy Procedural Code
+// ============================================================================
+
+/**
+ * Legacy user management functions (BAD EXAMPLE - DO NOT USE)
+ */
+
+// Global database connection
+$db = mysqli_connect('localhost', 'user', 'pass', 'database');
+
+// Create user function with global dependency
+function create_user($name, $email, $password)
+{
+    global $db;
+    
+    // No validation
+    $hashed_password = md5($password); // Weak hashing!
+    
+    // SQL injection vulnerability!
+    $query = "INSERT INTO users (name, email, password) 
+              VALUES ('$name', '$email', '$hashed_password')";
+    
+    $result = mysqli_query($db, $query);
+    
+    if ($result) {
+        $user_id = mysqli_insert_id($db);
+        
+        // Send email (tightly coupled)
+        mail($email, 'Welcome', 'Welcome to our site!');
+        
+        return $user_id;
+    }
+    
+    return false;
+}
+
+// Get user function
+function get_user($id)
+{
+    global $db;
+    
+    // SQL injection vulnerability!
+    $query = "SELECT * FROM users WHERE id = $id";
+    $result = mysqli_query($db, $query);
+    
+    return mysqli_fetch_assoc($result);
+}
+
+// Update user function
+function update_user($id, $name, $email)
+{
+    global $db;
+    
+    // SQL injection vulnerability!
+    $query = "UPDATE users SET name = '$name', email = '$email' WHERE id = $id";
+    
+    return mysqli_query($db, $query);
+}
+
+// Delete user function
+function delete_user($id)
+{
+    global $db;
+    
+    // SQL injection vulnerability!
+    $query = "DELETE FROM users WHERE id = $id";
+    
+    return mysqli_query($db, $query);
+}
+
+// Usage (legacy)
+$user_id = create_user('John Doe', 'john@example.com', 'password123');
+$user = get_user($user_id);
+update_user($user_id, 'Jane Doe', 'jane@example.com');
+delete_user($user_id);
+
+// ============================================================================
+// AFTER: Modern OOP Code with Best Practices
+// ============================================================================
+
+declare(strict_types=1);
+
+namespace App\Models;
+
+/**
+ * User Model
+ */
+class User
+{
+    public function __construct(
+        private ?int $id = null,
+        private string $name = '',
+        private string $email = '',
+        private string $passwordHash = '',
+        private ?\DateTimeImmutable $createdAt = null,
+        private ?\DateTimeImmutable $updatedAt = null
+    ) {}
+    
+    // Getters
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+    
+    public function getName(): string
+    {
+        return $this->name;
+    }
+    
+    public function getEmail(): string
+    {
+        return $this->email;
+    }
+    
+    public function getPasswordHash(): string
+    {
+        return $this->passwordHash;
+    }
+    
+    // Setters with validation
+    public function setName(string $name): self
+    {
+        if (empty($name)) {
+            throw new \InvalidArgumentException('Name cannot be empty');
+        }
+        
+        $this->name = $name;
+        return $this;
+    }
+    
+    public function setEmail(string $email): self
+    {
+        if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
+            throw new \InvalidArgumentException('Invalid email address');
+        }
+        
+        $this->email = $email;
+        return $this;
+    }
+    
+    public function setPassword(string $password): self
+    {
+        if (strlen($password) < 8) {
+            throw new \InvalidArgumentException('Password must be at least 8 characters');
+        }
+        
+        // Use secure password hashing
+        $this->passwordHash = password_hash($password, PASSWORD_ARGON2ID);
+        return $this;
+    }
+    
+    public function verifyPassword(string $password): bool
+    {
+        return password_verify($password, $this->passwordHash);
+    }
+}
+
+// ============================================================================
+
+namespace App\Repositories;
+
+use App\Models\User;
+use PDO;
+
+/**
+ * User Repository - Database operations
+ */
+class UserRepository
+{
+    public function __construct(
+        private PDO $db
+    ) {}
+    
+    public function create(User $user): User
+    {
+        $stmt = $this->db->prepare(
+            "INSERT INTO users (name, email, password_hash, created_at, updated_at) 
+             VALUES (:name, :email, :password_hash, NOW(), NOW())"
+        );
+        
+        $stmt->execute([
+            'name' => $user->getName(),
+            'email' => $user->getEmail(),
+            'password_hash' => $user->getPasswordHash()
+        ]);
+        
+        $id = (int) $this->db->lastInsertId();
+        
+        return $this->findById($id);
+    }
+    
+    public function findById(int $id): ?User
+    {
+        $stmt = $this->db->prepare("SELECT * FROM users WHERE id = :id");
+        $stmt->execute(['id' => $id]);
+        
+        $data = $stmt->fetch(PDO::FETCH_ASSOC);
+        
+        if (!$data) {
+            return null;
+        }
+        
+        return $this->hydrate($data);
+    }
+    
+    public function findByEmail(string $email): ?User
+    {
+        $stmt = $this->db->prepare("SELECT * FROM users WHERE email = :email");
+        $stmt->execute(['email' => $email]);
+        
+        $data = $stmt->fetch(PDO::FETCH_ASSOC);
+        
+        if (!$data) {
+            return null;
+        }
+        
+        return $this->hydrate($data);
+    }
+}
+

package/augment-extensions/coding-standards/php/examples/web-application-example.php

@@ -0,0 +1,211 @@
+<?php
+
+/**
+ * Web Application Example - Laravel User Authentication Module
+ * 
+ * This example demonstrates best practices for PHP web applications including:
+ * - MVC architecture with thin controllers
+ * - Eloquent ORM for database interactions
+ * - Form validation with Form Requests
+ * - Middleware for authentication and authorization
+ * - Blade templating with auto-escaping
+ * - CSRF protection
+ * - Session management
+ */
+
+namespace App\Http\Controllers;
+
+use App\Http\Requests\StoreUserRequest;
+use App\Http\Requests\UpdateUserRequest;
+use App\Services\UserService;
+use Illuminate\Http\Request;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\View\View;
+
+/**
+ * User Controller - Thin controller delegating to service layer
+ */
+class UserController extends Controller
+{
+    public function __construct(
+        private UserService $userService
+    ) {
+        $this->middleware('auth');
+        $this->middleware('can:manage-users')->except(['index', 'show']);
+    }
+    
+    /**
+     * Display a listing of users
+     */
+    public function index(Request $request): View
+    {
+        $users = $this->userService->getPaginatedUsers(
+            perPage: $request->input('per_page', 20),
+            search: $request->input('search')
+        );
+        
+        return view('users.index', [
+            'users' => $users,
+            'search' => $request->input('search')
+        ]);
+    }
+    
+    /**
+     * Show the form for creating a new user
+     */
+    public function create(): View
+    {
+        return view('users.create', [
+            'roles' => $this->userService->getAvailableRoles()
+        ]);
+    }
+    
+    /**
+     * Store a newly created user
+     */
+    public function store(StoreUserRequest $request): RedirectResponse
+    {
+        $user = $this->userService->createUser($request->validated());
+        
+        return redirect()
+            ->route('users.show', $user)
+            ->with('success', 'User created successfully!');
+    }
+    
+    /**
+     * Display the specified user
+     */
+    public function show(int $id): View
+    {
+        $user = $this->userService->findUserById($id);
+        
+        return view('users.show', ['user' => $user]);
+    }
+    
+    /**
+     * Show the form for editing the specified user
+     */
+    public function edit(int $id): View
+    {
+        $user = $this->userService->findUserById($id);
+        
+        return view('users.edit', [
+            'user' => $user,
+            'roles' => $this->userService->getAvailableRoles()
+        ]);
+    }
+    
+    /**
+     * Update the specified user
+     */
+    public function update(UpdateUserRequest $request, int $id): RedirectResponse
+    {
+        $user = $this->userService->updateUser($id, $request->validated());
+        
+        return redirect()
+            ->route('users.show', $user)
+            ->with('success', 'User updated successfully!');
+    }
+    
+    /**
+     * Remove the specified user
+     */
+    public function destroy(int $id): RedirectResponse
+    {
+        $this->userService->deleteUser($id);
+        
+        return redirect()
+            ->route('users.index')
+            ->with('success', 'User deleted successfully!');
+    }
+}
+
+// ============================================================================
+// Form Request - Validation Logic
+// ============================================================================
+
+namespace App\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Rule;
+
+class StoreUserRequest extends FormRequest
+{
+    public function authorize(): bool
+    {
+        return $this->user()->can('create', User::class);
+    }
+    
+    public function rules(): array
+    {
+        return [
+            'name' => 'required|string|max:255',
+            'email' => 'required|email|unique:users,email',
+            'password' => 'required|min:8|confirmed',
+            'role' => ['required', Rule::in(['user', 'admin', 'moderator'])],
+            'is_active' => 'boolean'
+        ];
+    }
+    
+    public function messages(): array
+    {
+        return [
+            'name.required' => 'Please provide a name for the user',
+            'email.unique' => 'This email address is already registered',
+            'password.min' => 'Password must be at least 8 characters long'
+        ];
+    }
+}
+
+// ============================================================================
+// Service Layer - Business Logic
+// ============================================================================
+
+namespace App\Services;
+
+use App\Models\User;
+use App\Repositories\UserRepository;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Facades\Hash;
+use Illuminate\Support\Facades\DB;
+
+class UserService
+{
+    public function __construct(
+        private UserRepository $userRepository
+    ) {}
+    
+    public function getPaginatedUsers(int $perPage = 20, ?string $search = null): LengthAwarePaginator
+    {
+        return $this->userRepository->paginate($perPage, $search);
+    }
+    
+    public function findUserById(int $id): User
+    {
+        return $this->userRepository->findOrFail($id);
+    }
+    
+    public function createUser(array $data): User
+    {
+        return DB::transaction(function () use ($data) {
+            $user = User::create([
+                'name' => $data['name'],
+                'email' => $data['email'],
+                'password' => Hash::make($data['password']),
+                'role' => $data['role'],
+                'is_active' => $data['is_active'] ?? true
+            ]);
+            
+            // Send welcome email
+            $user->sendWelcomeEmail();
+            
+            // Log activity
+            activity()
+                ->performedOn($user)
+                ->log('User created');
+            
+            return $user;
+        });
+    }
+}
+

package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php

@@ -0,0 +1,215 @@
+<?php
+/**
+ * Plugin Name: WooCommerce Custom Cart Handler
+ * Plugin URI: https://example.com/woo-custom-cart
+ * Description: Custom shopping cart handler with stock validation and secure payment tokenization
+ * Version: 1.0.0
+ * Author: Your Name
+ * Author URI: https://example.com
+ * WC requires at least: 5.0
+ * WC tested up to: 7.0
+ * License: GPL v2 or later
+ * Text Domain: woo-custom-cart
+ */
+
+// Prevent direct access
+if (!defined('ABSPATH')) {
+    exit;
+}
+
+// Check if WooCommerce is active
+if (!in_array('woocommerce/woocommerce.php', apply_filters('active_plugins', get_option('active_plugins')))) {
+    return;
+}
+
+/**
+ * Main Plugin Class
+ */
+class WC_Custom_Cart_Handler
+{
+    private static $instance = null;
+    
+    public static function get_instance()
+    {
+        if (null === self::$instance) {
+            self::$instance = new self();
+        }
+        return self::$instance;
+    }
+    
+    private function __construct()
+    {
+        $this->init_hooks();
+    }
+    
+    private function init_hooks()
+    {
+        // Cart hooks
+        add_filter('woocommerce_add_to_cart_validation', [$this, 'validate_add_to_cart'], 10, 3);
+        add_action('woocommerce_before_calculate_totals', [$this, 'modify_cart_prices']);
+        add_action('woocommerce_check_cart_items', [$this, 'validate_cart_stock']);
+        
+        // Checkout hooks
+        add_action('woocommerce_checkout_process', [$this, 'validate_checkout']);
+        add_action('woocommerce_checkout_create_order', [$this, 'add_order_meta'], 10, 2);
+        add_action('woocommerce_checkout_order_processed', [$this, 'process_order'], 10, 3);
+        
+        // Order status hooks
+        add_action('woocommerce_order_status_completed', [$this, 'handle_order_completed']);
+        add_action('woocommerce_order_status_cancelled', [$this, 'handle_order_cancelled']);
+        
+        // Payment hooks
+        add_filter('woocommerce_payment_gateways', [$this, 'add_payment_gateway']);
+    }
+    
+    /**
+     * Validate product before adding to cart
+     */
+    public function validate_add_to_cart($passed, $product_id, $quantity)
+    {
+        $product = wc_get_product($product_id);
+        
+        if (!$product) {
+            wc_add_notice(__('Product not found.', 'woo-custom-cart'), 'error');
+            return false;
+        }
+        
+        // Check if product is purchasable
+        if (!$product->is_purchasable()) {
+            wc_add_notice(__('This product cannot be purchased.', 'woo-custom-cart'), 'error');
+            return false;
+        }
+        
+        // Check stock availability
+        if (!$product->has_enough_stock($quantity)) {
+            wc_add_notice(
+                sprintf(
+                    __('Sorry, we do not have enough "%s" in stock. Only %d available.', 'woo-custom-cart'),
+                    $product->get_name(),
+                    $product->get_stock_quantity()
+                ),
+                'error'
+            );
+            return false;
+        }
+        
+        // Custom validation: Check if user has already purchased this product
+        if ($this->user_already_purchased($product_id)) {
+            wc_add_notice(
+                __('You have already purchased this product.', 'woo-custom-cart'),
+                'error'
+            );
+            return false;
+        }
+        
+        return $passed;
+    }
+    
+    /**
+     * Modify cart item prices based on custom logic
+     */
+    public function modify_cart_prices($cart)
+    {
+        if (is_admin() && !defined('DOING_AJAX')) {
+            return;
+        }
+        
+        foreach ($cart->get_cart() as $cart_item_key => $cart_item) {
+            $product = $cart_item['data'];
+            
+            // Apply volume discount
+            if ($cart_item['quantity'] >= 10) {
+                $discount_percentage = 10; // 10% discount for 10+ items
+                $original_price = $product->get_regular_price();
+                $discounted_price = $original_price * (1 - $discount_percentage / 100);
+                
+                $product->set_price($discounted_price);
+                
+                // Add notice about discount
+                if (!WC()->session->get('volume_discount_notice_shown')) {
+                    wc_add_notice(
+                        sprintf(
+                            __('Volume discount applied: %d%% off!', 'woo-custom-cart'),
+                            $discount_percentage
+                        ),
+                        'success'
+                    );
+                    WC()->session->set('volume_discount_notice_shown', true);
+                }
+            }
+        }
+    }
+    
+    /**
+     * Validate cart stock before checkout
+     */
+    public function validate_cart_stock()
+    {
+        foreach (WC()->cart->get_cart() as $cart_item_key => $cart_item) {
+            $product = $cart_item['data'];
+            $product_id = $cart_item['product_id'];
+            $quantity = $cart_item['quantity'];
+            
+            // Re-check stock (in case it changed since adding to cart)
+            $fresh_product = wc_get_product($product_id);
+            
+            if (!$fresh_product->has_enough_stock($quantity)) {
+                wc_add_notice(
+                    sprintf(
+                        __('Sorry, "%s" stock has changed. Only %d available.', 'woo-custom-cart'),
+                        $product->get_name(),
+                        $fresh_product->get_stock_quantity()
+                    ),
+                    'error'
+                );
+            }
+        }
+    }
+    
+    /**
+     * Validate checkout fields
+     */
+    public function validate_checkout()
+    {
+        // Custom field validation
+        if (empty($_POST['custom_delivery_instructions'])) {
+            wc_add_notice(
+                __('Please provide delivery instructions.', 'woo-custom-cart'),
+                'error'
+            );
+        }
+        
+        // Validate minimum order amount
+        $cart_total = WC()->cart->get_total('');
+        $minimum_order = 50.00;
+        
+        if ($cart_total < $minimum_order) {
+            wc_add_notice(
+                sprintf(
+                    __('Minimum order amount is $%s. Your current total is $%s.', 'woo-custom-cart'),
+                    number_format($minimum_order, 2),
+                    number_format($cart_total, 2)
+                ),
+                'error'
+            );
+        }
+    }
+    
+    /**
+     * Add custom meta to order
+     */
+    public function add_order_meta($order, $data)
+    {
+        if (isset($_POST['custom_delivery_instructions'])) {
+            $order->update_meta_data(
+                '_delivery_instructions',
+                sanitize_textarea_field($_POST['custom_delivery_instructions'])
+            );
+        }
+        
+        // Add custom order number
+        $custom_order_number = 'ORD-' . date('Ymd') . '-' . str_pad($order->get_id(), 6, '0', STR_PAD_LEFT);
+        $order->update_meta_data('_custom_order_number', $custom_order_number);
+    }
+}
+