Add tests

.git-blame-ignore-revs

@@ -0,0 +1,4 @@
+680db0fef09dd6fb5a6e0d103a5647e5ae86de49
+d1b208da7ce29b70822e2e5fbec2013dd663fbd5
+9430a611b8807c3de6b78282b3eee19b33e133e3
+d513ed9ecc604a009cbc879f988eced82ef7f094

.github/workflows/tests.yml

@@ -0,0 +1,42 @@
+name: tests
+
+on:
+  pull_request:
+    branches: [development, dev, acceptance, staging, main, master]
+
+jobs:
+  skip-duplicates:
+    continue-on-error: true # Uncomment once integration is finished
+    runs-on: ubuntu-latest
+
+    # Map a step output to a job output
+    outputs:
+      should_skip: ${{ steps.skip_check.outputs.should_skip }}
+
+    steps:
+      - id: skip_check
+        uses: fkirc/skip-duplicate-actions@v5
+        with:
+          # All of these options are optional, so you can remove them if you are happy with the defaults
+          cancel_others: "true"
+          concurrent_skipping: "same_content"
+          skip_after_successful_duplicate: "true"
+          paths_ignore: '["**/README.md", "**/docs/**"]'
+
+  workbench-tests:
+    needs: skip-duplicates
+    if: needs.skip-duplicates.outputs.should_skip != 'true'
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.3"
+
+      - uses: php-actions/composer@v6
+
+      - name: Execute tests
+        run: ./vendor/bin/testbench package:test --bail --retry

.gitignore

@@ -1,3 +1,4 @@
 DS_Store
 composer.lock
 /vendor
+/skeleton

.php-cs-fixer.dist.php

@@ -1,129 +1,10 @@
 <?php
 
+// Prefer adding customizations to pint.json unless adding custom fixers
+
 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_definition' => [
-        'multi_line_extends_each_single_line' => true,
-        'single_item_single_line' => true,
-        'single_line' => true,
-    ],
-    '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_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_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,
-    '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__ . '/src',
@@ -137,6 +18,6 @@
 
 return (new Config)
     ->setFinder($finder)
-    ->setRules($rules)
+    ->setRules([])
     ->setRiskyAllowed(true)
     ->setUsingCache(false);

.phpcs.xml.dist

@@ -28,6 +28,8 @@
     <rule ref="PSR1.Files.SideEffects">
         <!-- Disable side effects for index file -->
         <exclude-pattern>/public/index.php</exclude-pattern>
+        <!-- Disable side effects for tests (Pest) -->
+        <exclude-pattern>/tests</exclude-pattern>
     </rule>
 
     <!-- PSR1 3 Namespaces and classes MUST follow PSR-0. -->

.vscode/extensions.json

@@ -1,6 +1,7 @@
 {
     "recommendations": [
         "wongjn.php-sniffer",
+        "m1guelpf.better-pest",
         "junstyle.php-cs-fixer",
         "d9705996.tighten-lint",
         "SanderRonde.phpstan-vscode",

README.md

@@ -1,6 +1,7 @@
 # Workspace
 
 [![codestyle](https://github.com/media-code/workspace/actions/workflows/codestyle.yml/badge.svg)](https://github.com/media-code/workspace/actions/workflows/codestyle.yml)
+[![tests](https://github.com/media-code/workspace/actions/workflows/tests.yml/badge.svg)](https://github.com/media-code/workspace/actions/workflows/tests.yml)
 
 ## Install Workspace in your project
 
@@ -69,11 +70,8 @@ If you've skipped this installation step, not to worry; Simply run `php artisan
 
 **Refactors**
 
--   [ ] Add comprehensive test coverage
-
 -   [ ] Add easy method to create portable workspaces as a package that extends gdd/workspace internally
 -   [ ] Refactor default integrations to a standalone portable workspace (except for duster)
-
 -   [ ] Refactor `Manager` so it intelligently diffs `suggestedPlugins` & `requiredPlugins` with `avoidPlugins`. (when people want to extend it for their own organization this will avoid plugin conflicts)
 -   [ ] Consider intelligently merging configs instead of overwriting them? (out of scope?)
 
@@ -117,3 +115,4 @@ If you've skipped this installation step, not to worry; Simply run `php artisan
 -   [x] Refactor `update` command
 
 -   [x] Integrate Duster -> linting and fixing for the project
+-   [x] Add comprehensive test coverage

composer.json

@@ -3,29 +3,38 @@
     "description": "Opinionated wrapper around tighten/duster with default configs, Larastan & Prettier blade formatting integration & CI workflows. For internal use.",
     "type": "library",
     "license": "MIT",
-    "autoload": {
-        "psr-4": {
-            "Gedachtegoed\\Workspace\\": "src/"
-        }
-    },
+    "minimum-stability": "stable",
+    "prefer-stable": true,
     "authors": [
         {
             "name": "Willem Leuverink",
-            "email": "[email protected]"
+            "email": "[email protected]",
+            "homepage": "https://leuver.ink"
         }
     ],
-    "extra": {
-        "laravel": {
-            "providers": [
-                "Gedachtegoed\\Workspace\\ServiceProvider"
-            ]
+    "funding": [
+        {
+            "type": "github",
+            "url": "https://github.com/sponsors/gwleuverink"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "Gedachtegoed\\Workspace\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Gedachtegoed\\Workspace\\Tests\\": "tests/"
         }
     },
     "scripts": {
         "lint": "vendor/bin/duster lint",
         "fix": "vendor/bin/duster fix",
         "analyze": "vendor/bin/phpstan analyse",
-        "baseline": "vendor/bin/phpstan analyse --generate-baseline"
+        "baseline": "vendor/bin/phpstan analyse --generate-baseline",
+
+        "test": "vendor/bin/testbench package:test --bail --retry"
     },
     "require": {
         "php": "^8.1.0",
@@ -38,8 +47,36 @@
         "squizlabs/php_codesniffer": "^3.7",
         "tightenco/duster": "^2.4",
         "tightenco/tlint": "^9.1",
-        "orchestra/testbench": "^8.12"
+        "orchestra/testbench": "^8.12",
+        "pestphp/pest": "^2.20",
+        "symfony/thanks": "^1.2",
+        "timacdonald/callable-fake": "^1.6"
     },
-    "minimum-stability": "stable",
-    "prefer-stable": true
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true,
+            "symfony/thanks": true
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Gedachtegoed\\Workspace\\ServiceProvider"
+            ]
+        },
+        "thanks": [
+            {
+                "name": "tightenco/duster",
+                "url": "https://github.com/tighten/duster"
+            },
+            {
+                "name": "laravel/prompts",
+                "url": "https://github.com/laravel/prompts"
+            },
+            {
+                "name": "timacdonald/callable-fake",
+                "url": "https://github.com/timacdonald/callable-fake"
+            }
+        ]
+    }
 }

phpstan.neon

@@ -6,13 +6,14 @@ parameters:
     paths:
         - src/
 
+    excludePaths:
+        - tests/
+
     # Level 9 is the highest level
     level: 5
 
-    ignoreErrors:
+#    ignoreErrors:
 #        - "#^Access to an undefined property Illuminate\\\\Database\\\\Eloquent\\\\Model\\:\\:\\$id\\.$#"
 #
-#    excludePaths:
-#        - ./*/*/FileToBeExcluded.php
 #
 #    checkMissingIterableValueType: false

phpunit.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Integration">
+            <directory suffix="Test.php">./tests/Integration</directory>
+        </testsuite>
+
+        <testsuite name="Feature">
+            <directory suffix="Test.php">./tests/Feature</directory>
+        </testsuite>
+
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Unit</directory>
+        </testsuite>
+    </testsuites>
+    <source>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
+</phpunit>

pint.json

@@ -7,10 +7,7 @@
         },
         "class_attributes_separation": {
             "elements": {
-                "const": "one",
-                "method": "one",
-                "property": "one",
-                "trait_import": "none"
+                "method": "one"
             }
         },
         "curly_braces_position": {

src/Commands/Concerns/PromptForOptionWhenMissing.php

@@ -10,7 +10,7 @@ protected function promptForOptionWhenMissing(string $option, string $label, boo
     {
         $value = $this->option($option);
 
-        if ($value) {
+        if ($value !== null) {
             return $value;
         }