Refactor: Comprehensive code quality and maintainability improvements #21
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This major refactoring enhances code quality, type safety, and maintainability across the entire library while maintaining backward compatibility. ## Type Safety & Strict Types - Add `declare(strict_types=1)` to all PHP files - Add complete parameter and return type declarations (PHP 8.0+) - Implement union types where appropriate (array|ArrayAccess, string|array) - Add property type declarations ## Enhanced Functionality - **Arr**: Fix exists() logic to properly handle nested arrays and ArrayAccess - **Str**: Improve random string generation for better security and consistency - **Carbon**: Add 6 new helper methods (fromTimestamp, isToday, isPast, isFuture, isBetweenDates, diffInDaysAbsolute) - **Functions**: Update with proper type hints and enhanced documentation ## Documentation - Add comprehensive PHPDoc blocks to all 40+ methods - Include @param, @return, @throws tags with detailed descriptions - Add real-world usage examples in every PHPDoc - Expand README.md with complete usage guide and examples - Add table of contents and feature highlights ## Testing - Add 25+ edge case tests covering: - Empty strings and arrays - Unicode and multi-byte characters - Deeply nested structures - Null, false, and zero values - ArrayAccess objects - Special characters - Very long strings (10,000+ chars) - Add new CarbonTest.php with 7 comprehensive tests - All 63 tests passing (330 assertions) ## Static Analysis & Code Quality - Install and configure PHPStan at Level 8 (strictest) - Create phpstan.neon with comprehensive rules - Create pint.json with PSR-12 + strict coding standards - Add PHPStan to CI workflow - Add new composer scripts: analyze, check, analyze-baseline ## Configuration Updates - Update composer.json with PHPStan and Pest dependencies - Migrate phpunit.xml.dist to PHPUnit 10.5 schema (removes warnings) - Update CI workflow to run static analysis on all builds - Add .gitignore entries for build artifacts ## Breaking Changes None - All changes maintain backward compatibility while adding strict types ## Key Improvements - 100% strict type coverage - PHPStan Level 8 compliant - PSR-12 code style enforced - UTF-8 safe string operations - Modern PHP 8.0+ syntax - Enterprise-grade code quality
- Add parameter validation in random_bytes() calls (src/Str.php) - Replace @throws Random\RandomException with Exception for PHP 8.0/8.1 compatibility - Remove unmatched ignored error from phpstan.neon
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #21 +/- ##
============================================
+ Coverage 98.98% 99.04% +0.05%
- Complexity 47 55 +8
============================================
Files 3 4 +1
Lines 99 105 +6
============================================
+ Hits 98 104 +6
Misses 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Remove --coverage flag from test execution command to fix conflict with --coverage-clover flag. Using both flags together caused Pest to fail with "Coverage not found in path" error. The --coverage-clover flag alone is sufficient for generating the XML coverage report needed by Codecov.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.