Merge pull request #3 from Thavarshan/development

PHPVM v1.3.0 - Enhanced Functionality and Error Handling

Author: Thavarshan

.github/workflows/test.yml

@@ -1,21 +1,29 @@
-name: Test
+name: PHPVM Tests
 
 on:
   push:
     branches:
       - main
+      - development
   pull_request:
+    branches:
+      - main
+      - development
 
 jobs:
   test:
-    runs-on: macos-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
 
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v3
 
-      - name: Install Dependencies
-        run: brew install bats
+      # Set up permissions for the script
+      - name: Make script executable
+        run: chmod +x ./phpvm.sh
 
-      - name: Run PHPVM Tests
-        run: bats test_phpvm.bats
+      # Run the integrated self-tests
+      - name: Run integrated tests
+        run: ./phpvm.sh test

.github/workflows/use.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - development
   pull_request:
 
 jobs:
@@ -38,3 +39,26 @@ jobs:
       - name: Verify PHP Version
         run: |
           php -v
+
+      - name: Switch to System PHP
+        run: |
+          ./phpvm.sh system
+
+      - name: Verify System PHP Switch
+        run: |
+          php -v
+
+      - name: Create Project with .phpvmrc
+        run: |
+          mkdir -p test_project
+          echo "8.3" > test_project/.phpvmrc
+          cd test_project
+
+      - name: Test Auto-Switch
+        run: |
+          cd test_project
+          ../phpvm.sh auto
+
+      - name: Verify Auto-Switch
+        run: |
+          php -v

CHANGELOG.md

@@ -1,5 +1,42 @@
 # Release Notes
 
+## [v1.3.0](https://github.com/Thavarshan/phpvm/compare/v1.2.0...v1.3.0) - 2025-05-11
+
+## Added
+
+- Added `system` command to easily switch back to system PHP version
+- Added timestamps to all log messages for better traceability and debugging
+- Added log levels (INFO, ERROR, WARNING, DEBUG) for more structured logging
+- Added `run_with_sudo` helper function to centralize sudo usage logic
+- Added comprehensive self-tests with `phpvm test` command
+- Added test for corrupted `.phpvmrc` file handling
+- Added better support for detecting and using latest PHP version from Homebrew
+- Added improved error messages with more detailed information
+- Added ability to run self-tests with `phpvm test` command
+- Added debugging capability via `DEBUG=true` environment variable
+
+## Changed
+
+- Changed logging format to include timestamps and log levels
+- Changed sudo handling to use a centralized helper function
+- Changed path expansion to use `$HOME` instead of tilde notation for better compatibility
+- Changed error handling to provide more descriptive and actionable messages
+- Changed test framework to be integrated directly into the script
+- Changed help message to include information about the `test` command
+- Improved bash/zsh shell compatibility with better sourcing logic
+- Improved code organization and reduced duplication with helper functions
+
+## Fixed
+
+- Fixed shell crash issue when sourcing in zsh with p10k theme
+- Fixed path expansion issues in Ubuntu bashrc configurations
+- Fixed missing system PHP switching functionality on macOS
+- Fixed detection of latest PHP version on macOS when installed via Homebrew's generic 'php' formula
+- Fixed potential sudo permission issues on Linux by using `run_with_sudo` consistently
+- Fixed auto-switching edge case with invalid or corrupted `.phpvmrc` files
+- Fixed script execution issues when sourced from shell initialization files
+- Fixed various edge cases in version detection and switching
+
 ## [v1.2.0](https://github.com/Thavarshan/phpvm/compare/v1.1.0...v1.2.0) - 2025-02-15
 
 ### Added

README.MD

@@ -15,11 +15,13 @@
 
 ```sh
 $ phpvm use 8.2
-Now using PHP v8.2.10
+Switching to PHP 8.2...
+Switched to PHP 8.2.
 $ php -v
 PHP 8.2.10
 $ phpvm use 8.1
-Now using PHP v8.1.13
+Switching to PHP 8.1...
+Switched to PHP 8.1.
 $ php -v
 PHP 8.1.13
 ```
@@ -31,8 +33,10 @@ PHP 8.1.13
 - Auto-switch PHP versions based on project `.phpvmrc`.
 - Supports macOS (via Homebrew) and Linux distributions.
 - Works with common shells (`bash`, `zsh`).
-- Improved error handling and informative, color-coded feedback.
+- Improved error handling with detailed messages and suggestions.
+- Informative, color-coded feedback with timestamps for logs.
 - Includes unit tests with BATS for automated testing.
+- Helper functions for better maintainability and reduced code duplication.
 
 ## Installation
 
@@ -52,7 +56,8 @@ This script will download and set up `phpvm` in `~/.phpvm` and automatically upd
 
 ```sh
 export PHPVM_DIR="$HOME/.phpvm"
-source "$PHPVM_DIR/phpvm.sh"
+export PATH="$PHPVM_DIR/bin:$PATH"
+[ -s "$PHPVM_DIR/phpvm.sh" ] && . "$PHPVM_DIR/phpvm.sh"
 ```
 
 ### Verify Installation
@@ -83,6 +88,12 @@ To switch between installed versions:
 phpvm use 8.0
 ```
 
+To switch back to the system PHP version:
+
+```sh
+phpvm system
+```
+
 Verify the active version with:
 
 ```sh
@@ -97,24 +108,34 @@ Create a `.phpvmrc` file in your project directory to specify the desired PHP ve
 echo "8.1" > .phpvmrc
 ```
 
-When you navigate to that project directory, `phpvm` will automatically switch to PHP 8.1.
-
-### Uninstalling PHP Versions
-
-To uninstall a specific PHP version:
+When you navigate to that project directory and run:
 
 ```sh
-phpvm uninstall 7.4
+phpvm auto
 ```
 
+phpvm will automatically detect and switch to the version specified in the `.phpvmrc` file.
+
 ### Listing Installed Versions
 
-To list installed PHP versions:
+To list all installed PHP versions:
 
 ```sh
 phpvm list
 ```
 
+This will show all installed PHP versions and indicate the currently active one.
+
+### Running Self-Tests
+
+phpvm includes built-in self-tests to verify everything is working correctly:
+
+```sh
+phpvm test
+```
+
+This will run a series of tests on your system to ensure all phpvm functions are working properly.
+
 ## Uninstallation
 
 To completely remove `phpvm`, run:
@@ -127,23 +148,57 @@ Then remove the following lines from your shell profile (`~/.bashrc`, `~/.zshrc`
 
 ```sh
 export PHPVM_DIR="$HOME/.phpvm"
-source "$PHPVM_DIR/phpvm.sh"
+export PATH="$PHPVM_DIR/bin:$PATH"
+[ -s "$PHPVM_DIR/phpvm.sh" ] && . "$PHPVM_DIR/phpvm.sh"
 ```
 
 ## Troubleshooting
 
 If you experience issues with `phpvm`, try the following:
 
-- Ensure your shell profile is sourcing `phpvm.sh`.
-- Restart your terminal after installing or updating.
-- Verify that Homebrew is installed (for macOS users).
-- Check for permission issues during the installation or PHP version switching process.
-- Refer to the [Changelog](./CHANGELOG.md) for recent updates and fixes.
+- Run `phpvm test` to verify all functions are working correctly
+- Ensure your shell profile is sourcing `phpvm.sh`
+- Restart your terminal after installing or updating
+- Verify that the required package manager is installed:
+  - Homebrew for macOS
+  - apt, dnf, yum, or pacman for Linux
+- Check for permission issues during the installation or PHP version switching process
+- For Linux systems, you may need to use `sudo` for installation and switching
+- Refer to the [Changelog](./CHANGELOG.md) for recent updates and fixes
 
 ## Development & Testing
 
 - This project includes a set of BATS unit tests located in the repository (e.g., `test_phpvm.bats`).
 - Contributions, bug reports, and feature requests are welcome.
+- The codebase now includes helper functions for better maintainability and reduced duplication.
+
+### Testing
+
+phpvm includes built-in self-tests that validate all core functionality:
+
+```sh
+# Run the built-in tests
+phpvm test
+```
+
+The test framework verifies:
+
+- Output and formatting functions
+- System detection
+- PHP version installation (mocked)
+- Version switching
+- Auto-switching based on .phpvmrc
+- System PHP integration
+
+These tests can be run in any environment with a shell and don't require external testing frameworks.
+
+### Debugging
+
+To enable debug output, set the `DEBUG` environment variable to `true`:
+
+```sh
+DEBUG=true phpvm install 8.1
+```
 
 ## Maintainers
 

install-bats.sh

@@ -0,0 +1,83 @@
+#!/bin/sh
+# Script to install BATS (Bash Automated Testing System)
+
+set -e
+
+# Detect OS
+if [ "$(uname)" = "Darwin" ]; then
+    # macOS
+    echo "Detected macOS, using Homebrew to install BATS..."
+    if ! command -v brew >/dev/null 2>&1; then
+        echo "Homebrew not found. Please install Homebrew first:"
+        echo "  /bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\""
+        exit 1
+    fi
+
+    if ! brew list bats-core >/dev/null 2>&1; then
+        brew install bats-core
+    else
+        echo "BATS already installed"
+    fi
+
+elif [ -f /etc/debian_version ]; then
+    # Debian/Ubuntu
+    echo "Detected Debian/Ubuntu, using apt to install BATS..."
+    if ! command -v bats >/dev/null 2>&1; then
+        sudo apt-get update
+        sudo apt-get install -y bats
+    else
+        echo "BATS already installed"
+    fi
+
+elif [ -f /etc/redhat-release ]; then
+    # RHEL/CentOS
+    echo "Detected RHEL/CentOS, installing BATS from GitHub..."
+    if ! command -v bats >/dev/null 2>&1; then
+        # Create temporary directory for installation
+        TEMP_DIR=$(mktemp -d)
+        cd "$TEMP_DIR"
+
+        # Clone and install BATS
+        git clone https://github.com/bats-core/bats-core.git
+        cd bats-core
+        sudo ./install.sh /usr/local
+
+        # Clean up
+        cd /
+        rm -rf "$TEMP_DIR"
+    else
+        echo "BATS already installed"
+    fi
+
+else
+    # Other Linux or Unix
+    echo "Installing BATS from GitHub..."
+    if ! command -v bats >/dev/null 2>&1; then
+        # Create temporary directory for installation
+        TEMP_DIR=$(mktemp -d)
+        cd "$TEMP_DIR"
+
+        # Clone and install BATS
+        git clone https://github.com/bats-core/bats-core.git
+        cd bats-core
+        sudo ./install.sh /usr/local
+
+        # Clean up
+        cd /
+        rm -rf "$TEMP_DIR"
+    else
+        echo "BATS already installed"
+    fi
+fi
+
+# Verify installation
+if command -v bats >/dev/null 2>&1; then
+    echo "BATS installed successfully!"
+    echo "Version information:"
+    bats --version
+    echo ""
+    echo "To run phpvm tests, use: bats test_phpvm.bats"
+else
+    echo "BATS installation failed."
+    exit 1
+fi