Merge pull request #32 from use-the-fork/refract/cleanup

Refract/cleanup - Added Test suite / formating etc. 🎉  🎉  🎉

.envrc

@@ -0,0 +1 @@
+use flake . --impure

.github/workflows/phpstan.yml

@@ -0,0 +1,31 @@
+name: PHPStan
+
+on:
+  push:
+    branches:
+      - main
+      - github-actions
+    paths:
+      - '**.php'
+      - 'phpstan.neon.dist'
+      - '.github/workflows/phpstan.yml'
+
+jobs:
+  phpstan:
+    name: phpstan
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          coverage: none
+
+      - name: Install composer dependencies
+        uses: ramsey/composer-install@v3
+
+      - name: Run PHPStan
+        run: ./vendor/bin/phpstan --error-format=github

.github/workflows/run-tests.yml

@@ -0,0 +1,69 @@
+name: run-tests
+
+on:
+  push:
+    branches:
+      - main
+      - github-actions
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    env:
+      BROADCAST_DRIVER: log
+      CACHE_DRIVER: redis
+      QUEUE_CONNECTION: redis
+      SESSION_DRIVER: redis
+      DB_CONNECTION: testing
+      APP_KEY: base64:2fl+Ktvkfl+Fuz3Qp/A76G2RTiGVA/ZjKZaz6fiiM10=
+      APP_ENV: testing
+      BCRYPT_ROUNDS: 10
+      MAIL_MAILER: array
+      TELESCOPE_ENABLED: false
+
+    # Docs: https://docs.github.com/en/actions/using-containerized-services
+    services:
+      elasticsearch:
+        image: elasticsearch:7.17.3
+        env:
+          discovery.type: single-node
+          ES_JAVA_OPTS: '-Xms512m -Xmx512m'
+        ports:
+          - 9200:9200
+        options: --health-cmd="curl http://localhost:9200/_cluster/health" --health-interval=10s --health-timeout=5s --health-retries=5
+
+      redis:
+        image: redis
+        ports:
+          - 6379/tcp
+        options: --health-cmd="redis-cli ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v4
+
+      - name: Verify Elasticsearch connection 🧩
+        run: |
+          curl -X GET "localhost:${{ job.services.elasticsearch.ports['9200'] }}/_cluster/health?pretty=true"
+
+      - name: Setup PHP 🏗
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          tools: composer:v2
+          coverage: xdebug
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo, mysql
+
+      - name: Install Project Dependencies 💻
+        run: |
+          composer install --no-interaction --prefer-dist --optimize-autoloader
+
+      - name: List Installed Dependencies 📦
+        run: composer show -D
+
+      - name: Run tests 🧪
+        run: |
+          ./vendor/bin/pest  --version
+          ./vendor/bin/pest
+        env:
+          REDIS_PORT: ${{ job.services.redis.ports['6379'] }}
+          ELASTICSEARCH_PORT: ${{ job.services.elasticsearch.ports['9200'] }}

.gitignore

@@ -1,2 +1,30 @@
-/vendor
-/.phpunit.cache
+.env
+.env.*
+
+#composer
+vendor
+
+# Snow-blower
+!secrets/.env*
+.sb*
+secrets.nix
+
+# pre-commit
+.pre-commit-config.yaml
+
+# direnv
+.direnv
+
+.phpunit*
+
+
+.idea
+.phpunit.cache
+build
+composer.lock
+coverage
+docs
+phpunit.xml
+phpstan.neon
+testbench.yaml
+node_modules

.php-cs-fixer.php

@@ -0,0 +1,239 @@
+<?php
+  # PHPCS Fixer modified for Laravel Pint standards
+
+  declare(strict_types=1);
+
+  use PhpCsFixer\Config;
+  use PhpCsFixer\Finder;
+
+  $rules = [
+    'array_indentation' => true,
+    'array_syntax' => ['syntax' => 'short'],
+    'binary_operator_spaces' => [
+      'default' => 'single_space',
+    ],
+    'blank_line_after_namespace' => true,
+    'blank_line_after_opening_tag' => true,
+    'blank_line_before_statement' => [
+      'statements' => [
+        'continue',
+        'return',
+      ],
+    ],
+    'blank_line_between_import_groups' => true,
+    'blank_lines_before_namespace' => true,
+    'braces_position' => [
+      'control_structures_opening_brace' => 'same_line',
+      'functions_opening_brace' => 'next_line_unless_newline_at_signature_end',
+      'anonymous_functions_opening_brace' => 'same_line',
+      'classes_opening_brace' => 'next_line_unless_newline_at_signature_end',
+      'anonymous_classes_opening_brace' => 'next_line_unless_newline_at_signature_end',
+      'allow_single_line_empty_anonymous_classes' => false,
+      'allow_single_line_anonymous_functions' => false,
+    ],
+    '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,
+    ],
+    'class_reference_name_casing' => true,
+    'clean_namespace' => true,
+    'compact_nullable_type_declaration' => true,
+    'concat_space' => [
+      'spacing' => 'none',
+    ],
+    'constant_case' => ['case' => 'lower'],
+    'control_structure_braces' => true,
+    'control_structure_continuation_position' => [
+      'position' => 'same_line',
+    ],
+    'declare_equal_normalize' => true,
+    'declare_parentheses' => true,
+    'elseif' => true,
+    'encoding' => true,
+    'full_opening_tag' => true,
+    'fully_qualified_strict_types' => false,
+    'function_declaration' => true,
+    'general_phpdoc_tag_rename' => true,
+    'heredoc_to_nowdoc' => true,
+    'include' => true,
+    'increment_style' => ['style' => 'post'],
+    'indentation_type' => true,
+    'integer_literal_case' => true,
+    'lambda_not_used_import' => true,
+    'line_ending' => true,
+    'linebreak_after_opening_tag' => true,
+    'list_syntax' => true,
+    'lowercase_cast' => true,
+    'lowercase_keywords' => true,
+    'lowercase_static_reference' => true,
+    'magic_constant_casing' => true,
+    'magic_method_casing' => true,
+    'method_argument_space' => [
+      'on_multiline' => 'ignore',
+    ],
+    'method_chaining_indentation' => true,
+    'multiline_whitespace_before_semicolons' => [
+      'strategy' => 'no_multi_line',
+    ],
+    'native_function_casing' => true,
+    'native_type_declaration_casing' => true,
+    'no_alias_functions' => true,
+    'no_alias_language_construct_call' => true,
+    'no_alternative_syntax' => true,
+    'no_binary_string' => 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_extra_blank_lines' => [
+      'tokens' => [
+        'extra',
+        'throw',
+        'use',
+      ],
+    ],
+    'no_leading_import_slash' => true,
+    'no_leading_namespace_whitespace' => true,
+    'no_mixed_echo_print' => [
+      'use' => 'echo',
+    ],
+    'no_multiline_whitespace_around_double_arrow' => true,
+    'no_multiple_statements_per_line' => true,
+    'no_short_bool_cast' => true,
+    'no_singleline_whitespace_before_semicolons' => true,
+    'no_space_around_double_colon' => true,
+    'no_spaces_after_function_name' => true,
+    'no_spaces_around_offset' => [
+      'positions' => ['inside', 'outside'],
+    ],
+    'no_superfluous_phpdoc_tags' => [
+      'allow_mixed' => true,
+      'allow_unused_params' => true,
+    ],
+    'no_trailing_comma_in_singleline' => 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_unneeded_braces' => true,
+    'no_unreachable_default_argument_value' => true,
+    'no_unset_cast' => 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,
+    'nullable_type_declaration' => true,
+    'nullable_type_declaration_for_default_null_value' => true,
+    'object_operator_without_whitespace' => true,
+    'ordered_imports' => ['sort_algorithm' => 'alpha', 'imports_order' => ['const', 'class', 'function']],
+    'ordered_interfaces' => true,
+    'ordered_traits' => true,
+    'phpdoc_align' => [
+      'align' => 'left',
+      'spacing' => [
+        'param' => 2,
+      ],
+    ],
+    'phpdoc_indent' => true,
+    'phpdoc_inline_tag_normalizer' => true,
+    'phpdoc_no_access' => true,
+    'phpdoc_no_package' => true,
+    'phpdoc_no_useless_inheritdoc' => true,
+    'phpdoc_order' => [
+      'order' => ['param', 'return', 'throws'],
+    ],
+    'phpdoc_scalar' => true,
+    'phpdoc_separation' => [
+      'groups' => [
+        ['deprecated', 'link', 'see', 'since'],
+        ['author', 'copyright', 'license'],
+        ['category', 'package', 'subpackage'],
+        ['property', 'property-read', 'property-write'],
+        ['param', 'return'],
+      ],
+    ],
+    'phpdoc_single_line_var_spacing' => true,
+    'phpdoc_summary' => false,
+    'phpdoc_tag_type' => [
+      'tags' => [
+        'inheritdoc' => 'inline',
+      ],
+    ],
+    'phpdoc_to_comment' => false,
+    'phpdoc_trim' => true,
+    'phpdoc_types' => true,
+    'phpdoc_var_without_name' => true,
+    'psr_autoloading' => false,
+    'return_type_declaration' => ['space_before' => 'none'],
+    'self_accessor' => false,
+    'self_static_accessor' => true,
+    'short_scalar_cast' => true,
+    'simplified_null_return' => false,
+    'single_blank_line_at_eof' => 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_line_empty_body' => true,
+    'single_quote' => true,
+    'single_space_around_construct' => true,
+    'space_after_semicolon' => true,
+    'spaces_inside_parentheses' => true,
+    'standardize_not_equals' => true,
+    'statement_indentation' => 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,
+    'type_declaration_spaces' => true,
+    'types_spaces' => true,
+    'unary_operator_spaces' => true,
+    'visibility_required' => [
+      'elements' => ['method', 'property'],
+    ],
+    'whitespace_after_comma_in_array' => true,
+    'yoda_style' => [
+      'always_move_variable' => false,
+      'equal' => false,
+      'identical' => false,
+      'less_and_greater' => false,
+    ],
+    'declare_strict_types' => true,
+    'explicit_string_variable' => true,
+  ];
+
+  $finder = Finder::create()
+                  ->in([
+                         __DIR__.'/src',
+                         __DIR__.'/tests',
+                       ])
+                  ->name('*.php')
+                  ->notName('*.blade.php')
+                  ->ignoreDotFiles(true)
+                  ->ignoreVCS(true);
+
+  $config = new Config();
+
+  return $config->setFinder($finder)
+                ->setRules($rules)
+                ->setRiskyAllowed(true)
+                ->setUsingCache(true);