Merge pull request #20 from forxer/develop

Added QA tools

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

.gitattributes

@@ -0,0 +1,4 @@
+/.editorconfig           export-ignore
+/.gitattributes          export-ignore
+/.php-cs-fixer.dist.php  export-ignore
+/rector.php              export-ignore

.gitignore

@@ -0,0 +1,3 @@
+/vendor
+.php-cs-fixer.cache
+composer.lock

.php-cs-fixer.dist.php

@@ -0,0 +1,164 @@
+<?php
+
+// source : https://gist.github.com/laravel-shift/cab527923ed2a109dda047b97d53c200#file-php-cs-fixer-php
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+$rules = [
+    'array_indentation' => true,
+    'array_syntax' => ['syntax' => 'short'],
+    'binary_operator_spaces' => [
+        'default' => 'single_space',
+        'operators' => ['=>' => null],
+    ],
+    'blank_line_after_namespace' => true,
+    'blank_line_after_opening_tag' => true,
+    'blank_line_before_statement' => [
+        'statements' => ['return'],
+    ],
+    'braces' => true,
+    'cast_spaces' => true,
+    'class_attributes_separation' => [
+        'elements' => [
+            'const' => 'one',
+            'method' => 'one',
+            'property' => 'one',
+            'trait_import' => 'none',
+        ],
+    ],
+    'class_definition' => [
+        'multi_line_extends_each_single_line' => true,
+        'single_item_single_line' => true,
+        'single_line' => true,
+    ],
+    'concat_space' => [
+        'spacing' => 'none',
+    ],
+    'constant_case' => ['case' => 'lower'],
+    'declare_equal_normalize' => true,
+    'elseif' => true,
+    'encoding' => true,
+    'full_opening_tag' => true,
+    'fully_qualified_strict_types' => true, // added by Shift
+    'function_declaration' => true,
+    'function_typehint_space' => true,
+    'general_phpdoc_tag_rename' => true,
+    'heredoc_to_nowdoc' => true,
+    'include' => true,
+    'increment_style' => ['style' => 'post'],
+    'indentation_type' => true,
+    'linebreak_after_opening_tag' => true,
+    'line_ending' => true,
+    'lowercase_cast' => true,
+    'lowercase_keywords' => true,
+    'lowercase_static_reference' => true, // added from Symfony
+    'magic_method_casing' => true, // added from Symfony
+    'magic_constant_casing' => true,
+    'method_argument_space' => [
+        'on_multiline' => 'ignore',
+    ],
+    'multiline_whitespace_before_semicolons' => [
+        'strategy' => 'no_multi_line',
+    ],
+    'native_function_casing' => true,
+    'no_alias_functions' => true,
+    'no_extra_blank_lines' => [
+        'tokens' => [
+            'extra',
+            'throw',
+            'use',
+        ],
+    ],
+    'no_blank_lines_after_class_opening' => true,
+    'no_blank_lines_after_phpdoc' => true,
+    'no_closing_tag' => true,
+    'no_empty_phpdoc' => true,
+    'no_empty_statement' => true,
+    'no_leading_import_slash' => true,
+    'no_leading_namespace_whitespace' => true,
+    'no_mixed_echo_print' => [
+        'use' => 'echo',
+    ],
+    'no_multiline_whitespace_around_double_arrow' => true,
+    'no_short_bool_cast' => true,
+    'no_singleline_whitespace_before_semicolons' => true,
+    'no_spaces_after_function_name' => true,
+    'no_spaces_around_offset' => [
+        'positions' => ['inside', 'outside'],
+    ],
+    'no_spaces_inside_parenthesis' => true,
+    'no_trailing_comma_in_list_call' => true,
+    'no_trailing_comma_in_singleline_array' => true,
+    'no_trailing_whitespace' => true,
+    'no_trailing_whitespace_in_comment' => true,
+    'no_unneeded_control_parentheses' => [
+        'statements' => ['break', 'clone', 'continue', 'echo_print', 'return', 'switch_case', 'yield'],
+    ],
+    'no_unreachable_default_argument_value' => true,
+    'no_unused_imports' => true,
+    'no_useless_return' => true,
+    'no_whitespace_before_comma_in_array' => true,
+    'no_whitespace_in_blank_line' => true,
+    'normalize_index_brace' => true,
+    'not_operator_with_successor_space' => true,
+    'object_operator_without_whitespace' => true,
+    'ordered_imports' => ['sort_algorithm' => 'alpha'],
+    'psr_autoloading' => true,
+    'phpdoc_indent' => true,
+    'phpdoc_inline_tag_normalizer' => true,
+    'phpdoc_no_access' => true,
+    'phpdoc_no_package' => true,
+    'phpdoc_no_useless_inheritdoc' => true,
+    'phpdoc_scalar' => true,
+    'phpdoc_single_line_var_spacing' => true,
+    'phpdoc_summary' => false,
+    'phpdoc_to_comment' => false, // override to preserve user preference
+    'phpdoc_tag_type' => true,
+    'phpdoc_trim' => true,
+    'phpdoc_types' => true,
+    'phpdoc_var_without_name' => true,
+    'self_accessor' => true,
+    'short_scalar_cast' => true,
+    'simplified_null_return' => false, // disabled as "risky"
+    'single_blank_line_at_eof' => true,
+    'single_blank_line_before_namespace' => true,
+    'single_class_element_per_statement' => [
+        'elements' => ['const', 'property'],
+    ],
+    'single_import_per_statement' => true,
+    'single_line_after_imports' => true,
+    'single_line_comment_style' => [
+        'comment_types' => ['hash'],
+    ],
+    'single_quote' => true,
+    'space_after_semicolon' => true,
+    'standardize_not_equals' => true,
+    'switch_case_semicolon_to_colon' => true,
+    'switch_case_space' => true,
+    'ternary_operator_spaces' => true,
+    'trailing_comma_in_multiline' => ['elements' => ['arrays']],
+    'trim_array_spaces' => true,
+    'unary_operator_spaces' => true,
+    'visibility_required' => [
+        'elements' => ['method', 'property'],
+    ],
+    'whitespace_after_comma_in_array' => true,
+];
+
+
+$finder = Finder::create()
+    ->in([
+        __DIR__ . '/config',
+        __DIR__ . '/lang',
+        __DIR__ . '/src',
+    ])
+    ->name('*.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return (new Config)
+    ->setFinder($finder)
+    ->setRules($rules)
+    ->setRiskyAllowed(true)
+    ->setUsingCache(true);

CHANGELOG.md

@@ -1,6 +1,19 @@
 CHANGELOG
 =========
 
+0.8.2 (2023-08-14)
+------------------
+
+- Added QA tools
+
+
+0.8.1 (2023-08-02)
+------------------
+
+- Added an important note regarding values passed to input fields
+- Added a note for select multiple
+
+
 0.8.0 (2023-06-27)
 ------------------
 

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "forxer/blade-ui-kit-bootstrap",
-    "description": "Use Bootstrap styles to Blade UI Kit components",
+    "description": "Blade UI Kit components with Bootstrap styles and classes",
     "homepage": "https://github.com/forxer/blade-ui-kit-bootstrap",
     "license": "MIT",
     "keywords": [
@@ -23,6 +23,10 @@
         "illuminate/support": "^10.0",
         "illuminate/view": "^10.0"
     },
+    "require-dev": {
+        "driftingly/rector-laravel": "^0.21",
+        "rector/rector": "^0.17"
+    },
     "autoload": {
         "psr-4": {
             "BladeUIKitBootstrap\\": "src"

rector.php

@@ -0,0 +1,79 @@
+<?php
+
+use RectorLaravel\Set\LaravelSetList;
+use Rector\CodeQuality\Rector\Array_\CallableThisArrayToAnonymousFunctionRector;
+use Rector\CodeQuality\Rector\ClassMethod\ReturnTypeFromStrictScalarReturnExprRector;
+use Rector\CodeQuality\Rector\Equal\UseIdenticalOverEqualWithSameTypeRector;
+use Rector\Config\RectorConfig;
+use Rector\Php70\Rector\StaticCall\StaticCallOnNonStaticToInstanceCallRector;
+use Rector\Php74\Rector\Closure\ClosureToArrowFunctionRector;
+use Rector\Php81\Rector\Array_\FirstClassCallableRector;
+use Rector\Php81\Rector\Class_\MyCLabsClassToEnumRector;
+use Rector\Php81\Rector\FuncCall\NullToStrictStringFuncCallArgRector;
+use Rector\Php81\Rector\MethodCall\MyCLabsMethodCallToEnumConstRector;
+use Rector\Set\ValueObject\LevelSetList;
+use Rector\Set\ValueObject\SetList;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddVoidReturnTypeWhereNoReturnRector;
+use Rector\TypeDeclaration\Rector\Closure\AddClosureReturnTypeRector;
+use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictConstructorRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/config',
+        __DIR__ . '/lang',
+        __DIR__ . '/src',
+    ]);
+
+    $rectorConfig->parallel(
+        seconds: 360,
+        maxNumberOfProcess: 16,
+        jobSize: 20
+    );
+
+    $rectorConfig->importNames();
+
+    // skip paths and/or rules
+    //----------------------------------------------------------
+    $rectorConfig->skip([
+        // Pour la mise à jour PHP 8.1, ne pas prendre en compte MyCLabs enum to natives PHP enum
+        //MyCLabsClassToEnumRector::class,
+        //MyCLabsMethodCallToEnumConstRector::class,
+
+        // Transforme des faux-positifs, je préfère désactiver ça (PHP 8.1)
+        NullToStrictStringFuncCallArgRector::class,
+
+        // Pas de ça dans les routes car transforme :
+        // [Controller::class, 'method'] en (new Controller)->method(...)
+        //StaticCallOnNonStaticToInstanceCallRector::class => [__DIR__.'/routes'],
+        //FirstClassCallableRector::class => [__DIR__.'/routes'],
+
+        // Également, si SetList::CODE_QUALITY, éviter de transformer dans les routes
+        // [GlideController::class, 'images'] en fn($path, Request $request) => (new GlideController())->images($path, $request)
+        //CallableThisArrayToAnonymousFunctionRector::class => [__DIR__.'/routes'],
+        //ClosureToArrowFunctionRector::class => [__DIR__.'/routes'],
+    ]);
+
+    // register single rules
+    //----------------------------------------------------------
+
+    // TYPE_DECLARATION
+    //$rectorConfig->rule(TypedPropertyFromStrictConstructorRector::class);
+    //$rectorConfig->rule(AddVoidReturnTypeWhereNoReturnRector::class);
+    //$rectorConfig->rule(AddClosureReturnTypeRector::class);
+
+    // CODE_QUALITY
+    //$rectorConfig->rule(ReturnTypeFromStrictScalarReturnExprRector::class);
+    //$rectorConfig->rule(UseIdenticalOverEqualWithSameTypeRector::class);
+
+    // define what sets of rules will be applied
+    // tip: use "SetList" class to autocomplete sets with your IDE
+    //----------------------------------------------------------
+    $rectorConfig->sets([
+        LaravelSetList::LARAVEL_FACADE_ALIASES_TO_FULL_NAMES,
+        LevelSetList::UP_TO_PHP_82,
+        SetList::CODE_QUALITY,
+        SetList::DEAD_CODE,
+        SetList::EARLY_RETURN,
+        SetList::TYPE_DECLARATION,
+    ]);
+};

src/Components/BladeComponent.php

@@ -9,7 +9,7 @@
 
 abstract class BladeComponent extends IlluminateComponent
 {
-    abstract function viewName(): string;
+    abstract public function viewName(): string;
 
     public function viewPath(string $view): string
     {

src/Components/Forms/Inputs/Select.php

@@ -7,7 +7,7 @@
 use BladeUIKitBootstrap\Components\BladeComponent;
 use BladeUIKitBootstrap\Concerns\CanHaveErrors;
 use Illuminate\Support\Collection;
-use \InvalidArgumentException;
+use InvalidArgumentException;
 
 class Select extends BladeComponent
 {

src/Components/Modals/Modal.php

@@ -9,12 +9,15 @@
 class Modal extends BladeComponent
 {
     public string $id;
+
     public string $title;
+
     public bool $dismissable;
 
     public string $titleLabel;
 
     public $header;
+
     public $footer;
 
     public function __construct(string $id, string $title, bool $dismissable = true)

src/ServiceProvider.php

@@ -33,7 +33,7 @@ private function bootResources(): void
 
     private function bootBladeComponents(): void
     {
-        $this->callAfterResolving(BladeCompiler::class, function (BladeCompiler $blade) {
+        $this->callAfterResolving(BladeCompiler::class, function (BladeCompiler $blade): void {
             $prefix = config('blade-ui-kit-bootstrap.prefix', '');
 
             /** @var BladeComponent $component */
@@ -60,4 +60,4 @@ private function configurePublishing(): void
             __DIR__.'/../lang/' => $this->app->langPath().'/vendor/blade-ui-kit-bootstrap',
         ], 'blade-ui-kit-bootstrap-translations');
     }
-}
+}