mohab/st_package_test

a simple php helper for a string

dev-main 2025-09-28 14:28 UTC

Requires (Dev)

• phpunit/phpunit: ^10.0

MIT

• mohab ali

README

A simple PHP helper library for string manipulation operations.

Installation

Install the package using Composer:

composer install

For development dependencies (including PHPUnit):

composer install --dev

Usage

<?php

use Mohab\StringHelper\StringHelper;

// Convert to uppercase
echo StringHelper::upperCase('hello world'); // Output: HELLO WORLD

// Convert to lowercase
echo StringHelper::lowerCase('HELLO WORLD'); // Output: hello world

// Convert to camel case (first letter lowercase)
echo StringHelper::camelCase('Hello World'); // Output: hello World

Available Methods

upperCase(string $string): string

Converts a string to uppercase.

lowerCase(string $string): string

Converts a string to lowercase.

camelCase(string $string): string

Converts the first character of a string to lowercase.

Testing

This package includes comprehensive unit tests using PHPUnit.

Run Tests

# Using composer script
composer test

# Or directly with PHPUnit
./vendor/bin/phpunit

Test Coverage

Run tests with coverage report:

composer test-coverage

Test Structure

• Tests are located in the tests/Unit/ directory
• Each method is tested with various inputs including:
  • Basic functionality
  • Edge cases (empty strings, special characters)
  • Data type validation
  • Multiple test scenarios using data providers

Development

Project Structure

├── src/
│   └── StringHelper.php      # Main helper class
├── tests/
│   └── Unit/
│       └── StringHelperTest.php  # Unit tests
├── vendor/                   # Composer dependencies
├── composer.json            # Package configuration
├── phpunit.xml              # PHPUnit configuration
└── README.md               # This file

Requirements

• PHP 7.4 or higher
• Composer

Contributing

1. Fork the repository
2. Create a feature branch
3. Add tests for new functionality
4. Ensure all tests pass
5. Submit a pull request

License

This project is licensed under the MIT License.