diff --git a/.gitignore b/.gitignore index 772e5fe4..ed3bfd88 100644 --- a/.gitignore +++ b/.gitignore @@ -150,4 +150,8 @@ public/mal_mappings.json .is-dev -tmp \ No newline at end of file +tmp +tools/vendor/ +tools/phinx/vendor/ +/.php-cs-fixer.php +/.php-cs-fixer.cache \ No newline at end of file diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 00000000..37df8f9a --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,528 @@ +in([ + __DIR__, + __DIR__ . '/app', + __DIR__ . '/tools', + ]) + ->exclude([ + 'apidocs', + 'build', + 'coverage', + 'frontEndSrc', + 'phinx', + 'public', + 'tools', + 'tmp', + 'vendor', + 'views', + 'templates', + ]); + +return (new Config()) + ->setRiskyAllowed(TRUE) + ->setFinder($finder) + ->setIndent(' ') + ->setRules([ + 'align_multiline_comment' => false, + 'array_indentation' => true, + 'array_push' => true, + 'array_syntax' => ['syntax' => 'short'], + 'assign_null_coalescing_to_coalesce_equal' => true, + 'backtick_to_shell_exec' => true, + 'binary_operator_spaces' => [ + 'default' => 'single_space', + 'operators' => [ + '=' => NULL, + '&' => NULL, + ] + ], + 'blank_line_after_namespace' => true, + 'blank_line_after_opening_tag' => false, + 'blank_line_before_statement' => [ + 'statements' => [ + 'case', + 'continue', + 'declare', + 'default', + 'do', + 'exit', + 'for', + 'foreach', + 'goto', + 'return', + 'switch', + 'throw', + 'try', + 'while', + 'yield', + 'yield_from', + ], + ], + 'braces' => [ + 'allow_single_line_anonymous_class_with_empty_body' => true, + 'allow_single_line_closure' => true, + 'position_after_anonymous_constructs' => 'same', + 'position_after_control_structures' => 'next', + 'position_after_functions_and_oop_constructs' => 'next', + ], + 'cast_spaces' => ['space' => 'single'], + 'class_attributes_separation' => [ + 'elements' => [ + 'const' => 'none', + 'property' => 'none', + 'method' => 'one', + 'trait_import' => 'none', + ], + ], + 'class_definition' => [ + 'multi_line_extends_each_single_line' => true, + 'single_item_single_line' => true, + 'single_line' => true, + 'space_before_parenthesis' => true, + ], + 'class_reference_name_casing' => true, + 'clean_namespace' => true, + 'combine_consecutive_issets' => true, + 'combine_consecutive_unsets' => true, + 'combine_nested_dirname' => true, + 'comment_to_phpdoc' => [ + 'ignored_tags' => [ + 'todo', + 'codeCoverageIgnore', + 'codeCoverageIgnoreStart', + 'codeCoverageIgnoreEnd', + 'phpstan-ignore-line', + 'phpstan-ignore-next-line', + ], + ], + 'compact_nullable_typehint' => true, + 'concat_space' => ['spacing' => 'one'], + 'constant_case' => ['case' => 'upper'], + 'control_structure_continuation_position' => ['position' => 'next_line'], + 'date_time_immutable' => false, + 'declare_equal_normalize' => ['space' => 'none'], + 'declare_parentheses' => true, + 'declare_strict_types' => true, + 'dir_constant' => true, + 'doctrine_annotation_array_assignment' => false, + 'doctrine_annotation_braces' => false, + 'doctrine_annotation_indentation' => false, + 'doctrine_annotation_spaces' => false, + 'echo_tag_syntax' => [ + 'format' => 'short', + 'long_function' => 'echo', + 'shorten_simple_statements_only' => false, + ], + 'elseif' => true, + 'empty_loop_body' => ['style' => 'braces'], + 'empty_loop_condition' => ['style' => 'while'], + 'encoding' => true, + 'error_suppression' => [ + 'mute_deprecation_error' => true, + 'noise_remaining_usages' => false, + 'noise_remaining_usages_exclude' => [], + ], + 'escape_implicit_backslashes' => [ + 'double_quoted' => true, + 'heredoc_syntax' => true, + 'single_quoted' => false, + ], + 'explicit_indirect_variable' => true, + 'explicit_string_variable' => true, + 'final_class' => false, + 'final_internal_class' => [ + 'annotation_exclude' => ['@no-final'], + 'annotation_include' => ['@internal'], + 'consider_absent_docblock_as_internal_class' => false, + ], + 'final_public_method_for_abstract_class' => false, + 'fopen_flag_order' => true, + 'fopen_flags' => ['b_mode' => true], + 'full_opening_tag' => true, + 'fully_qualified_strict_types' => true, + 'function_declaration' => ['closure_function_spacing' => 'one'], + 'function_to_constant' => [ + 'functions' => [ + 'get_called_class', + 'get_class', + 'get_class_this', + 'php_sapi_name', + 'phpversion', + 'pi', + ], + ], + 'function_typehint_space' => true, + 'general_phpdoc_annotation_remove' => false, + 'general_phpdoc_tag_rename' => false, + 'get_class_to_class_keyword' => false, + 'global_namespace_import' => [ + 'import_constants' => true, + 'import_functions' => true, + 'import_classes' => true, + ], + 'group_import' => true, + 'header_comment' => false, // false by default + 'heredoc_indentation' => ['indentation' => 'start_plus_one'], + 'heredoc_to_nowdoc' => true, + 'implode_call' => true, + 'include' => true, + 'increment_style' => ['style' => 'post'], + 'indentation_type' => true, + 'integer_literal_case' => true, + 'is_null' => true, + 'lambda_not_used_import' => true, + 'line_ending' => true, + 'linebreak_after_opening_tag' => false, + 'list_syntax' => ['syntax' => 'short'], + 'logical_operators' => true, + 'lowercase_cast' => true, + 'lowercase_keywords' => true, + 'lowercase_static_reference' => true, + 'magic_constant_casing' => true, + 'magic_method_casing' => true, + 'mb_str_functions' => false, + 'method_argument_space' => [ + 'after_heredoc' => false, + 'keep_multiple_spaces_after_comma' => false, + 'on_multiline' => 'ensure_fully_multiline', + ], + 'method_chaining_indentation' => true, + 'modernize_strpos' => false, // requires 8.0+ + 'modernize_types_casting' => true, + 'multiline_comment_opening_closing' => true, + 'multiline_whitespace_before_semicolons' => ['strategy' => 'no_multi_line'], + 'native_constant_invocation' => false, + 'native_function_casing' => true, + 'native_function_invocation' => false, + 'native_function_type_declaration_casing' => true, + 'new_with_braces' => true, + 'no_alias_functions' => ['sets' => ['@all']], + 'no_alias_language_construct_call' => true, + 'no_alternative_syntax' => ['fix_non_monolithic_code' => false], + 'no_binary_string' => true, + 'no_blank_lines_after_class_opening' => true, + 'no_blank_lines_after_phpdoc' => true, + 'no_blank_lines_before_namespace' => false, // conflicts with `single_blank_line_before_namespace` + 'no_break_comment' => ['comment_text' => 'no break'], + 'no_closing_tag' => true, + 'no_empty_comment' => true, + 'no_empty_phpdoc' => true, + 'no_empty_statement' => true, + 'no_extra_blank_lines' => ['tokens' => ['extra']], + 'no_homoglyph_names' => 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_null_property_initialization' => 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_spaces_inside_parenthesis' => true, + 'no_superfluous_elseif' => true, + 'no_superfluous_phpdoc_tags' => [ + 'allow_mixed' => true, + 'allow_unused_params' => true, + 'remove_inheritdoc' => false, + ], + '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_trailing_whitespace_in_string' => true, + 'no_unneeded_control_parentheses' => [ + 'statements' => [ + 'break', + 'clone', + 'continue', + 'echo_print', + 'return', + 'switch_case', + 'yield', + ], + ], + 'no_unneeded_curly_braces' => ['namespaces' => true], + 'no_unneeded_final_method' => ['private_methods' => true], + 'no_unneeded_import_alias' => true, + 'no_unreachable_default_argument_value' => true, + 'no_unset_cast' => true, + 'no_unset_on_property' => false, + 'no_unused_imports' => true, + 'no_useless_else' => true, + 'no_useless_return' => true, + 'no_useless_sprintf' => true, + 'no_whitespace_before_comma_in_array' => ['after_heredoc' => true], + 'no_whitespace_in_blank_line' => true, + 'non_printable_character' => ['use_escape_sequences_in_strings' => true], + 'normalize_index_brace' => true, + 'not_operator_with_space' => true, + 'not_operator_with_successor_space' => true, + 'nullable_type_declaration_for_default_null_value' => ['use_nullable_type_declaration' => true], + 'object_operator_without_whitespace' => true, + 'operator_linebreak' => ['only_booleans' => true, 'position' => 'beginning'], + 'ordered_class_elements' => [ + 'order' => [ + 'use_trait', + 'constant', + 'property', + 'method', + ], + 'sort_algorithm' => 'none', + ], + 'ordered_imports' => [ + 'sort_algorithm' => 'alpha', + 'imports_order' => ['class', 'function', 'const'], + ], + 'ordered_interfaces' => false, + 'ordered_traits' => false, + 'php_unit_construct' => [ + 'assertions' => [ + 'assertSame', + 'assertEquals', + 'assertNotEquals', + 'assertNotSame', + ], + ], + 'php_unit_dedicate_assert' => ['target' => 'newest'], + 'php_unit_dedicate_assert_internal_type' => ['target' => 'newest'], + 'php_unit_expectation' => ['target' => 'newest'], + 'php_unit_fqcn_annotation' => true, + 'php_unit_internal_class' => ['types' => ['final']], + 'php_unit_method_casing' => ['case' => 'camel_case'], + 'php_unit_mock' => ['target' => 'newest'], + 'php_unit_mock_short_will_return' => true, + 'php_unit_namespaced' => ['target' => 'newest'], + 'php_unit_no_expectation_annotation' => [ + 'target' => 'newest', + 'use_class_const' => true, + ], + 'php_unit_set_up_tear_down_visibility' => true, + 'php_unit_size_class' => false, +// 'php_unit_strict' => [ +// 'assertions' => [ +// 'assertAttributeEquals', +// 'assertAttributeNotEquals', +// 'assertEquals', +// 'assertNotEquals', +// ], +// ], + 'php_unit_test_annotation' => ['style' => 'prefix'], + 'php_unit_test_case_static_method_calls' => [ + 'call_type' => 'this', + 'methods' => [], + ], + 'php_unit_test_class_requires_covers' => false, + 'phpdoc_add_missing_param_annotation' => ['only_untyped' => true], + 'phpdoc_align' => [ + 'align' => 'left' + ], + 'phpdoc_annotation_without_dot' => false, + 'phpdoc_indent' => true, + 'phpdoc_inline_tag_normalizer' => [ + 'tags' => [ + 'example', + 'id', + 'internal', + 'inheritdoc', + 'inheritdocs', + 'link', + 'source', + 'toc', + 'tutorial', + ], + ], + 'phpdoc_line_span' => [ + 'const' => 'multi', + 'method' => 'multi', + 'property' => 'multi', + ], + 'phpdoc_no_access' => true, + 'phpdoc_no_empty_return' => false, + 'phpdoc_no_package' => false, + 'phpdoc_no_useless_inheritdoc' => true, + 'phpdoc_order' => true, + 'phpdoc_order_by_value' => [ + 'annotations' => [ + 'author', + 'covers', + 'coversNothing', + 'dataProvider', + 'depends', + 'group', + 'internal', + 'method', + 'property', + 'property-read', + 'property-write', + 'requires', + 'throws', + 'uses', + ], + ], + 'phpdoc_return_self_reference' => [ + 'replacements' => [ + 'this' => '$this', + '@this' => '$this', + '$self' => 'self', + '@self' => 'self', + '$static' => 'static', + '@static' => 'static', + ], + ], + 'phpdoc_scalar' => [ + 'types' => [ + 'boolean', + 'callback', + 'double', + 'integer', + 'real', + 'str', + ], + ], + 'phpdoc_separation' => false, + 'phpdoc_single_line_var_spacing' => true, + 'phpdoc_summary' => false, + 'phpdoc_tag_casing' => ['tags' => ['inheritDoc']], + 'phpdoc_tag_type' => ['tags' => ['inheritDoc' => 'inline']], + 'phpdoc_to_comment' => false, + 'phpdoc_to_param_type' => false, + 'phpdoc_to_property_type' => false, + 'phpdoc_to_return_type' => false, + 'phpdoc_trim' => true, + 'phpdoc_trim_consecutive_blank_line_separation' => true, + 'phpdoc_types' => ['groups' => ['simple', 'alias', 'meta']], + 'phpdoc_types_order' => [ + 'null_adjustment' => 'always_last', + 'sort_algorithm' => 'alpha', + ], + 'phpdoc_var_annotation_correct_order' => true, + 'phpdoc_var_without_name' => true, + 'pow_to_exponentiation' => true, + 'protected_to_private' => true, + 'psr_autoloading' => ['dir' => null], + 'random_api_migration' => [ + 'replacements' => [ + 'getrandmax' => 'mt_getrandmax', + 'rand' => 'mt_rand', + 'srand' => 'mt_srand', + ], + ], + 'regular_callable_call' => true, + 'return_assignment' => true, + 'return_type_declaration' => ['space_before' => 'none'], + 'self_accessor' => false, + 'self_static_accessor' => true, + 'semicolon_after_instruction' => false, + 'set_type_to_cast' => true, + 'short_scalar_cast' => true, + 'simple_to_complex_string_variable' => true, + 'simplified_if_return' => true, + 'simplified_null_return' => false, + 'single_blank_line_at_eof' => true, + 'single_blank_line_before_namespace' => true, + 'single_class_element_per_statement' => ['elements' => ['const', 'property']], + 'single_import_per_statement' => false, + 'single_line_after_imports' => true, + 'single_line_comment_style' => ['comment_types' => ['asterisk', 'hash']], + 'single_line_throw' => false, + 'single_quote' => ['strings_containing_single_quote_chars' => false], + 'single_space_after_construct' => [ + 'constructs' => [ + 'abstract', + 'as', + 'attribute', + 'break', + 'case', + 'catch', + 'class', + 'clone', + 'comment', + 'const', + 'const_import', + 'continue', + 'do', + 'echo', + 'else', + 'elseif', + 'extends', + 'final', + 'finally', + 'for', + 'foreach', + 'function', + 'function_import', + 'global', + 'goto', + 'if', + 'implements', + 'include', + 'include_once', + 'instanceof', + 'insteadof', + 'interface', + 'match', + 'named_argument', + 'new', + 'open_tag_with_echo', + 'php_doc', + 'php_open', + 'print', + 'private', + 'protected', + 'public', + 'require', + 'require_once', + 'return', + 'static', + 'throw', + 'trait', + 'try', + 'use', + 'use_lambda', + 'use_trait', + 'var', + 'while', + 'yield', + 'yield_from', + ], + ], + 'single_trait_insert_per_statement' => true, + 'space_after_semicolon' => ['remove_in_empty_for_expressions' => true], + 'standardize_increment' => true, + 'standardize_not_equals' => true, + 'static_lambda' => true, + 'strict_comparison' => true, + 'strict_param' => true, + 'string_length_to_empty' => true, + 'string_line_ending' => true, + 'switch_case_semicolon_to_colon' => true, + 'switch_case_space' => true, + 'switch_continue_to_break' => true, + 'ternary_operator_spaces' => true, + 'ternary_to_elvis_operator' => true, + 'ternary_to_null_coalescing' => true, + 'trailing_comma_in_multiline' => [ + 'after_heredoc' => true, + 'elements' => ['arrays'], + ], + 'trim_array_spaces' => true, + 'types_spaces' => ['space' => 'none'], + 'unary_operator_spaces' => false, + 'use_arrow_functions' => true, + 'visibility_required' => ['elements' => ['const', 'method', 'property']], + 'void_return' => false, // changes method signature + 'whitespace_after_comma_in_array' => true, + 'yoda_style' => [ + 'equal' => false, + 'identical' => null, + 'less_and_greater' => false, + 'always_move_variable' => false, + ], + ]); diff --git a/app/appConf/base_config.php b/app/appConf/base_config.php index f7adccca..55d5875f 100644 --- a/app/appConf/base_config.php +++ b/app/appConf/base_config.php @@ -57,4 +57,4 @@ return array_merge($tomlConfig, [ // Included config files 'routes' => require 'routes.php', -]); \ No newline at end of file +]); diff --git a/app/appConf/routes.php b/app/appConf/routes.php index f599c439..85a3d5ca 100644 --- a/app/appConf/routes.php +++ b/app/appConf/routes.php @@ -16,10 +16,10 @@ use const Aviat\AnimeClient\{ ALPHA_SLUG_PATTERN, - NUM_PATTERN, - SLUG_PATTERN, + DEFAULT_CONTROLLER, DEFAULT_CONTROLLER_METHOD, - DEFAULT_CONTROLLER + NUM_PATTERN, + SLUG_PATTERN }; // ------------------------------------------------------------------------- @@ -190,14 +190,14 @@ $routes = [ 'character' => [ 'path' => '/character/{slug}', 'tokens' => [ - 'slug' => SLUG_PATTERN - ] + 'slug' => SLUG_PATTERN, + ], ], 'person' => [ 'path' => '/people/{slug}', 'tokens' => [ 'slug' => SLUG_PATTERN, - ] + ], ], 'default_user_info' => [ 'path' => '/me', @@ -209,8 +209,8 @@ $routes = [ 'controller' => 'user', 'action' => 'about', 'tokens' => [ - 'username' => '.*?' - ] + 'username' => '.*?', + ], ], // --------------------------------------------------------------------- // Default / Shared routes @@ -231,8 +231,8 @@ $routes = [ 'controller' => 'images', 'tokens' => [ 'type' => SLUG_PATTERN, - 'file' => '[a-z0-9\-]+\.[a-z]{3,4}' - ] + 'file' => '[a-z0-9\-]+\.[a-z]{3,4}', + ], ], 'settings' => [ 'path' => '/settings', @@ -259,8 +259,8 @@ $routes = [ 'controller' => 'history', 'path' => '/history/{type}', 'tokens' => [ - 'type' => SLUG_PATTERN - ] + 'type' => SLUG_PATTERN, + ], ], 'increment' => [ 'path' => '/{controller}/increment', @@ -316,7 +316,7 @@ $defaultMap = [ foreach ($routes as &$route) { - foreach($defaultMap as $key => $val) + foreach ($defaultMap as $key => $val) { if ( ! array_key_exists($key, $route)) { diff --git a/app/bootstrap.php b/app/bootstrap.php index d9c88629..6574ef3d 100644 --- a/app/bootstrap.php +++ b/app/bootstrap.php @@ -6,12 +6,10 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\AnimeClient; @@ -20,12 +18,10 @@ use Aura\Html\HelperLocatorFactory; use Aura\Router\RouterContainer; use Aura\Session\SessionFactory; use Aviat\AnimeClient\API\{Anilist, Kitsu}; -use Aviat\AnimeClient\Component; -use Aviat\AnimeClient\Model; +use Aviat\AnimeClient\{Component, Model}; use Aviat\Banker\Teller; use Aviat\Ion\Config; -use Aviat\Ion\Di\Container; -use Aviat\Ion\Di\ContainerInterface; +use Aviat\Ion\Di\{Container, ContainerInterface}; use Laminas\Diactoros\ServerRequestFactory; use Monolog\Formatter\JsonFormatter; use Monolog\Handler\RotatingFileHandler; @@ -38,7 +34,7 @@ if ( ! defined('HB_APP_DIR')) { define('HB_APP_DIR', __DIR__); define('ROOT_DIR', dirname(HB_APP_DIR)); - define('TEMPLATE_DIR', _dir(HB_APP_DIR, 'templates')); + define('TEMPLATE_DIR', _dir(HB_APP_DIR, 'templates')); } // ----------------------------------------------------------------------------- @@ -74,18 +70,19 @@ return static function (array $configArray = []): Container { $container->set('config', static fn () => new Config($configArray)); // Create Cache Object - $container->set('cache', static function(ContainerInterface $container): CacheInterface { + $container->set('cache', static function (ContainerInterface $container): CacheInterface { $logger = $container->getLogger(); $config = $container->get('config')->get('cache'); + return new Teller($config, $logger); }); // Create Aura Router Object - $container->set('aura-router', static fn() => new RouterContainer); + $container->set('aura-router', static fn () => new RouterContainer()); // Create Html helpers - $container->set('html-helper', static function(ContainerInterface $container) { - $htmlHelper = (new HelperLocatorFactory)->newInstance(); + $container->set('html-helper', static function (ContainerInterface $container) { + $htmlHelper = (new HelperLocatorFactory())->newInstance(); $helpers = [ 'menu' => Helper\Menu::class, 'field' => Helper\Form::class, @@ -94,9 +91,10 @@ return static function (array $configArray = []): Container { foreach ($helpers as $name => $class) { - $htmlHelper->set($name, static function() use ($class, $container) { - $helper = new $class; + $htmlHelper->set($name, static function () use ($class, $container) { + $helper = new $class(); $helper->setContainer($container); + return $helper; }); } @@ -106,7 +104,7 @@ return static function (array $configArray = []): Container { // Create Component helpers $container->set('component-helper', static function (ContainerInterface $container) { - $helper = (new HelperLocatorFactory)->newInstance(); + $helper = (new HelperLocatorFactory())->newInstance(); $components = [ 'animeCover' => Component\AnimeCover::class, 'mangaCover' => Component\MangaCover::class, @@ -119,8 +117,9 @@ return static function (array $configArray = []): Container { foreach ($components as $name => $componentClass) { $helper->set($name, static function () use ($container, $componentClass) { - $helper = new $componentClass; + $helper = new $componentClass(); $helper->setContainer($container); + return $helper; }); } @@ -144,7 +143,7 @@ return static function (array $configArray = []): Container { $container->set('util', static fn ($container) => new Util($container)); // Models - $container->set('kitsu-model', static function(ContainerInterface $container): Kitsu\Model { + $container->set('kitsu-model', static function (ContainerInterface $container): Kitsu\Model { $requestBuilder = new Kitsu\RequestBuilder($container); $requestBuilder->setLogger($container->getLogger('kitsu-request')); @@ -158,9 +157,10 @@ return static function (array $configArray = []): Container { $cache = $container->get('cache'); $model->setCache($cache); + return $model; }); - $container->set('anilist-model', static function(ContainerInterface $container): Anilist\Model { + $container->set('anilist-model', static function (ContainerInterface $container): Anilist\Model { $requestBuilder = new Anilist\RequestBuilder($container); $requestBuilder->setLogger($container->getLogger('anilist-request')); @@ -178,9 +178,10 @@ return static function (array $configArray = []): Container { $container->set('manga-model', static fn ($container) => new Model\Manga($container)); $container->set('anime-collection-model', static fn ($container) => new Model\AnimeCollection($container)); $container->set('manga-collection-model', static fn ($container) => new Model\MangaCollection($container)); - $container->set('settings-model', static function($container) { + $container->set('settings-model', static function ($container) { $model = new Model\Settings($container->get('config')); $model->setContainer($container); + return $model; }); @@ -196,4 +197,4 @@ return static function (array $configArray = []): Container { return $container; }; -// End of bootstrap.php \ No newline at end of file +// End of bootstrap.php diff --git a/app/templates/anime-cover.php b/app/templates/anime-cover.php index 95790cca..0965d29f 100644 --- a/app/templates/anime-cover.php +++ b/app/templates/anime-cover.php @@ -1,6 +1,7 @@
isAuthenticated()): ?> diff --git a/app/views/main-menu.php b/app/views/main-menu.php index 42d40d66..e1b01448 100644 --- a/app/views/main-menu.php +++ b/app/views/main-menu.php @@ -1,4 +1,16 @@ + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 5.2 + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient + */ namespace Aviat\AnimeClient; diff --git a/build/update_header_comments.php b/build/update_header_comments.php deleted file mode 100644 index efc9d911..00000000 --- a/build/update_header_comments.php +++ /dev/null @@ -1,99 +0,0 @@ - token type constant - // [1] => raw syntax parsed to that token - // [2] => line number - foreach($tokens as $token) - { - // Since we only care about opening docblocks, - // bail out when we get to the namespace token - if (is_array($token) && $token[0] === T_NAMESPACE) - { - break; - } - - if (is_array($token)) - { - $token = $token[1]; - } - - $output .= $token; - } - - return $output; -} - -function get_tokens(string $source): array -{ - return token_get_all($source); -} - -function replace_files(array $files, string $template): void -{ - print_r($files); - foreach ($files as $file) - { - $source = file_get_contents($file); - if ($source === FALSE) - { - continue; - } - - if (stripos($source, 'namespace') === FALSE) - { - continue; - } - - $tokens = get_tokens($source); - $text_to_replace = get_text_to_replace($tokens); - - $header = file_get_contents(__DIR__ . $template); - $new_text = "= 8.0.0", + "monolog/monolog": "^3.0.0", + "php": ">= 8.1.0", "psr/http-message": "^1.0.1", - "psr/log": "*", - "robmorgan/phinx": "^0.12.4", "symfony/polyfill-mbstring": "^1.0.0", "symfony/polyfill-util": "^1.0.0", "tracy/tracy": "^2.8.0", @@ -68,7 +63,7 @@ "scripts": { "build:css": "cd public && npm run build:css && cd ..", "build:js": "cd public && npm run build:js && cd ..", - "coverage": "phpdbg -qrr -- vendor/bin/phpunit -c build", + "coverage": "php -dpcov.enabled=1 -dpcov.directory=. -dpcov.exclude=\"~vendor~\" ./vendor/bin/phpunit -c build", "phpstan": "phpstan analyse -c phpstan.neon", "watch:css": "cd public && npm run watch:css", "watch:js": "cd public && npm run watch:js", diff --git a/frontEndSrc/js/anime.js b/frontEndSrc/js/anime.js index 9f531bc3..a163ae88 100644 --- a/frontEndSrc/js/anime.js +++ b/frontEndSrc/js/anime.js @@ -63,6 +63,7 @@ _.on('body.anime.list', 'click', '.plus-one', (e) => { // Setup the update data let data = { id: parentSel.dataset.kitsuId, + anilist_id: parentSel.dataset.anilistId, mal_id: parentSel.dataset.malId, data: { progress: watchedCount + 1 @@ -94,11 +95,18 @@ _.on('body.anime.list', 'click', '.plus-one', (e) => { _.hide('#loading-shadow'); _.showMessage('error', `Failed to update ${title}. `); _.scrollToTop(); + return; } + // We've completed the series if (resData.data.libraryEntry.update.libraryEntry.status === 'COMPLETED') { _.hide(parentSel); + _.hide('#loading-shadow'); + _.showMessage('success', `Successfully completed ${title}`); + _.scrollToTop(); + + return; } _.hide('#loading-shadow'); diff --git a/frontEndSrc/js/manga.js b/frontEndSrc/js/manga.js index d07907bb..b35df7d3 100644 --- a/frontEndSrc/js/manga.js +++ b/frontEndSrc/js/manga.js @@ -83,6 +83,11 @@ _.on('.manga.list', 'click', '.edit-buttons button', (e) => { if (String(data.data.status).toUpperCase() === 'COMPLETED') { _.hide(parentSel); + _.hide('#loading-shadow'); + _.showMessage('success', `Successfully completed ${mangaName}`); + _.scrollToTop(); + + return; } _.hide('#loading-shadow'); diff --git a/frontEndSrc/js/template-helpers.js b/frontEndSrc/js/template-helpers.js index b83af63a..3146cf75 100644 --- a/frontEndSrc/js/template-helpers.js +++ b/frontEndSrc/js/template-helpers.js @@ -5,6 +5,7 @@ import _ from './anime-client.js'; _.on('main', 'change', '.big-check', (e) => { const id = e.target.id; document.getElementById(`mal_${id}`).checked = true; + document.getElementById(`anilist_${id}`).checked = true; }); /** @@ -55,6 +56,7 @@ export function renderSearchResults (type, data, isCollection = false) { return `
+ + Yes '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__10.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__10.php index 2fc21a3b..34d5eb54 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__10.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__10.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__11.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__11.php index ea5de9fd..54310534 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__11.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__11.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__12.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__12.php index b1e33914..5c4dae0b 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__12.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__12.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__13.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__13.php index d1f4af33..58ba6f8b 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__13.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__13.php @@ -1,4 +1,6 @@ - + diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__14.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__14.php index d4346410..37fc0aa7 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__14.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__14.php @@ -1,3 +1,5 @@ - Yes + Yes '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__15.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__15.php index b0f88bdd..12a3a030 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__15.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__15.php @@ -1,3 +1,5 @@ - Yes + Yes '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__16.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__16.php index 804a1a2e..3bdff010 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__16.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__16.php @@ -1,4 +1,6 @@ - + diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__17.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__17.php index a82a2acb..c926730a 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__17.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__17.php @@ -1,4 +1,6 @@ - + diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__18.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__18.php index 0ce5af29..3a8dacba 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__18.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__18.php @@ -1,4 +1,6 @@ - + diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__19.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__19.php index 8934dafb..7eca4e89 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__19.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__19.php @@ -1,4 +1,6 @@ - + diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__2.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__2.php index 9fc4ac0e..4343f335 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__2.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__2.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__20.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__20.php index bd5f0d42..fcf0a2e8 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__20.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__20.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__21.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__21.php index 2b561aef..08f1828b 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__21.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__21.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__22.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__22.php index 1b1ec486..552f41cd 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__22.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__22.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__23.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__23.php index 9085638f..f28c0723 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__23.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__23.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__24.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__24.php index dfb792e8..b1b1e91d 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__24.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__24.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__25.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__25.php index 982bef2e..e16cbd68 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__25.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__25.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__3.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__3.php index a3597a93..73b99758 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__3.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__3.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__4.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__4.php index 3dcdd0be..ba30e713 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__4.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__4.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__5.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__5.php index cd149af8..9df3724e 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__5.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__5.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__6.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__6.php index 294d675b..218e75e1 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__6.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__6.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__7.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__7.php index c8650aa1..cc6ef72c 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__7.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__7.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__8.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__8.php index 05321fb5..208c6f50 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__8.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__8.php @@ -1,2 +1,4 @@ - + '; diff --git a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__9.php b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__9.php index ee7f474c..03624f63 100644 --- a/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__9.php +++ b/tests/AnimeClient/__snapshots__/FormGeneratorTest__testGeneration__9.php @@ -1,4 +1,6 @@ - + diff --git a/tests/AnimeClient/mocks.php b/tests/AnimeClient/mocks.php index 9914aba0..0c3bfba9 100644 --- a/tests/AnimeClient/mocks.php +++ b/tests/AnimeClient/mocks.php @@ -1,45 +1,52 @@ -getProperties(); $props = []; - foreach($properties as $reflectProp) + foreach ($properties as $reflectProp) { $reflectProp->setAccessible(TRUE); $props[$reflectProp->getName()] = $reflectProp->getValue($this); @@ -84,7 +93,8 @@ trait MockViewOutputTrait { $view = new TestView(); $friend = new Friend($view); - foreach($props as $name => $val) + + foreach ($props as $name => $val) { $friend->__set($name, $val); } @@ -93,15 +103,20 @@ trait MockViewOutputTrait { } } -class MockUtil { - public function get_cached_image($api_path, $series_slug, $type = "anime"): string +class MockUtil +{ + public function get_cached_image($api_path, $series_slug, $type = 'anime'): string { return "/public/images/{$type}/{$series_slug}.jpg"; } } -class TestView extends HttpView { - public function send(): void {} +class TestView extends HttpView +{ + public function send(): void + { + } + protected function output(): void { /*$content =& $this->response->content; @@ -111,38 +126,46 @@ class TestView extends HttpView { } } -class TestHtmlView extends HtmlView { +class TestHtmlView extends HtmlView +{ use MockViewOutputTrait; } -class TestHttpView extends HttpView { +class TestHttpView extends HttpView +{ use MockViewOutputTrait; } -class TestJsonView extends JsonView { - public function __destruct() {} +class TestJsonView extends JsonView +{ + public function __destruct() + { + } } // ----------------------------------------------------------------------------- // AnimeClient Mocks // ----------------------------------------------------------------------------- -trait MockInjectionTrait { +trait MockInjectionTrait +{ public function __get(string $key): mixed { - return $this->$key; + return $this->{$key}; } public function __set(string $key, mixed $value) { - $this->$key = $value; + $this->{$key} = $value; + return $this; } } -class MockBaseApiModel extends BaseApiModel { - +class MockBaseApiModel extends BaseApiModel +{ use MockInjectionTrait; + protected string $base_url = 'https://httpbin.org/'; protected function _get_list_from_api(string $status): array @@ -151,17 +174,20 @@ class MockBaseApiModel extends BaseApiModel { } } -class TestAnimeModel extends AnimeModel { +class TestAnimeModel extends AnimeModel +{ use MockInjectionTrait; } -class TestMangaModel extends MangaModel { +class TestMangaModel extends MangaModel +{ use MockInjectionTrait; protected function _check_cache($response) { $file = __DIR__ . '/test_data/manga_list/manga-transformed.json'; + return Json::decodeFile($file); } } -// End of mocks.php \ No newline at end of file +// End of mocks.php diff --git a/tests/Ion/BaseModelTest.php b/tests/Ion/BaseModelTest.php index 033075cd..3cc03801 100644 --- a/tests/Ion/BaseModelTest.php +++ b/tests/Ion/BaseModelTest.php @@ -6,23 +6,24 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests; use Aviat\Ion\Model as BaseModel; -class BaseModelTest extends IonTestCase { - +/** + * @internal + */ +final class BaseModelTest extends IonTestCase +{ public function testBaseModelSanity() { $baseModel = new BaseModel(); - $this->assertTrue(is_object($baseModel)); + $this->assertIsObject($baseModel); } -} \ No newline at end of file +} diff --git a/tests/Ion/ConfigTest.php b/tests/Ion/ConfigTest.php index 40854d8d..203bb1b1 100644 --- a/tests/Ion/ConfigTest.php +++ b/tests/Ion/ConfigTest.php @@ -6,23 +6,24 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests; use Aviat\Ion\Config; -class ConfigTest extends IonTestCase { - +/** + * @internal + */ +final class ConfigTest extends IonTestCase +{ protected Config $config; - public function setUp(): void + protected function setUp(): void { $this->config = new Config([ 'foo' => 'bar', @@ -47,8 +48,8 @@ class ConfigTest extends IonTestCase { public function testConfigGet(): void { - $this->assertEquals('bar', $this->config->get('foo')); - $this->assertEquals('baz', $this->config->get('bar')); + $this->assertSame('bar', $this->config->get('foo')); + $this->assertSame('baz', $this->config->get('bar')); $this->assertNull($this->config->get('baz')); $this->assertNull($this->config->get(['apple', 'sauce', 'is'])); } @@ -57,13 +58,13 @@ class ConfigTest extends IonTestCase { { $ret = $this->config->set('foo', 'foobar'); $this->assertInstanceOf(Config::class, $ret); - $this->assertEquals('foobar', $this->config->get('foo')); + $this->assertSame('foobar', $this->config->get('foo')); $this->config->set(['apple', 'sauce', 'is'], 'great'); $apple = $this->config->get('apple'); - $this->assertEquals('great', $apple['sauce']['is'], 'Config value not set correctly'); + $this->assertSame('great', $apple['sauce']['is'], 'Config value not set correctly'); - $this->assertEquals('great', $this->config->get(['apple', 'sauce', 'is']), "Array argument get for config failed."); + $this->assertSame('great', $this->config->get(['apple', 'sauce', 'is']), 'Array argument get for config failed.'); } public function dataConfigDelete(): array @@ -74,57 +75,58 @@ class ConfigTest extends IonTestCase { 'assertKeys' => [ [ 'path' => ['apple', 'sauce', 'is'], - 'expected' => NULL + 'expected' => NULL, ], [ 'path' => ['apple', 'sauce'], - 'expected' => NULL + 'expected' => NULL, ], [ 'path' => 'apple', - 'expected' => NULL - ] - ] + 'expected' => NULL, + ], + ], ], 'mid level delete' => [ 'key' => ['apple', 'sauce'], 'assertKeys' => [ [ 'path' => ['apple', 'sauce', 'is'], - 'expected' => NULL + 'expected' => NULL, ], [ 'path' => ['apple', 'sauce'], - 'expected' => NULL + 'expected' => NULL, ], [ 'path' => 'apple', 'expected' => [ - 'sauce' => NULL - ] - ] - ] + 'sauce' => NULL, + ], + ], + ], ], 'deep delete' => [ 'key' => ['apple', 'sauce', 'is'], 'assertKeys' => [ [ 'path' => ['apple', 'sauce', 'is'], - 'expected' => NULL + 'expected' => NULL, ], [ 'path' => ['apple', 'sauce'], 'expected' => [ - 'is' => NULL - ] - ] - ] - ] + 'is' => NULL, + ], + ], + ], + ], ]; } /** * @dataProvider dataConfigDelete + * @param mixed $key */ public function testConfigDelete($key, array $assertKeys): void { @@ -132,9 +134,9 @@ class ConfigTest extends IonTestCase { $config->set(['apple', 'sauce', 'is'], 'great'); $config->delete($key); - foreach($assertKeys as $pair) + foreach ($assertKeys as $pair) { - $this->assertEquals($pair['expected'], $config->get($pair['path'])); + $this->assertSame($pair['expected'], $config->get($pair['path'])); } } @@ -142,4 +144,4 @@ class ConfigTest extends IonTestCase { { $this->assertNull($this->config->get('foobar')); } -} \ No newline at end of file +} diff --git a/tests/Ion/Di/ContainerAwareTest.php b/tests/Ion/Di/ContainerAwareTest.php index 6fe4bf61..6ad4a620 100644 --- a/tests/Ion/Di/ContainerAwareTest.php +++ b/tests/Ion/Di/ContainerAwareTest.php @@ -6,12 +6,10 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests\Di; @@ -19,7 +17,8 @@ namespace Aviat\Ion\Tests\Di; use Aviat\Ion\Di\{Container, ContainerAware, ContainerInterface}; use Aviat\Ion\Tests\IonTestCase; -class Aware { +class Aware +{ use ContainerAware; public function __construct(ContainerInterface $container) @@ -28,12 +27,14 @@ class Aware { } } - -class ContainerAwareTest extends IonTestCase { - +/** + * @internal + */ +final class ContainerAwareTest extends IonTestCase +{ protected Aware $aware; - public function setUp(): void + protected function setUp(): void { $this->container = new Container(); $this->aware = new Aware($this->container); @@ -47,9 +48,9 @@ class ContainerAwareTest extends IonTestCase { $container2 = new Container([ 'foo' => 'bar', - 'baz' => 'foobar' + 'baz' => 'foobar', ]); $this->aware->setContainer($container2); $this->assertSame($container2, $this->aware->getContainer()); } -} \ No newline at end of file +} diff --git a/tests/Ion/Di/ContainerTest.php b/tests/Ion/Di/ContainerTest.php index 228475c7..d90d1aaf 100644 --- a/tests/Ion/Di/ContainerTest.php +++ b/tests/Ion/Di/ContainerTest.php @@ -6,42 +6,47 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests\Di; -use Aviat\Ion\Di\{Container, ContainerAware}; -use Aviat\Ion\Di\Exception\ContainerException; -use Aviat\Ion\Tests\IonTestCase; -use Monolog\Logger; -use Monolog\Handler\{TestHandler, NullHandler}; use Aviat\Ion\Di\ContainerInterface; -use Aviat\Ion\Di\Exception\NotFoundException; +use Aviat\Ion\Di\Exception\{ContainerException, NotFoundException}; +use Aviat\Ion\Di\{Container, ContainerAware}; +use Aviat\Ion\Tests\IonTestCase; +use Monolog\Handler\{NullHandler, TestHandler}; +use Monolog\Logger; use Throwable; use TypeError; -class FooTest { - +/** + * @internal + */ +final class FooTest +{ public $item; - public function __construct($item) { + public function __construct($item) + { $this->item = $item; } } -class FooTest2 { +class FooTest2 +{ use ContainerAware; } -class ContainerTest extends IonTestCase { - - public function setUp(): void +/** + * @internal + */ +final class ContainerTest extends IonTestCase +{ + protected function setUp(): void { $this->container = new Container(); } @@ -60,13 +65,14 @@ class ContainerTest extends IonTestCase { 'Non-existent id' => [ 'id' => 'foo', 'exception' => NotFoundException::class, - 'message' => "Item 'foo' does not exist in container." - ] + 'message' => "Item 'foo' does not exist in container.", + ], ]; } /** * @dataProvider dataGetWithException + * @param mixed $exception */ public function testGetWithException(mixed $id, $exception, ?string $message = NULL): void { @@ -74,12 +80,12 @@ class ContainerTest extends IonTestCase { { $this->container->get($id); } - catch(ContainerException $e) + catch (ContainerException $e) { $this->assertInstanceOf($exception, $e); - $this->assertEquals($message, $e->getMessage()); + $this->assertSame($message, $e->getMessage()); } - catch(Throwable $e) + catch (Throwable $e) { $this->assertInstanceOf($exception, $e); } @@ -87,6 +93,7 @@ class ContainerTest extends IonTestCase { /** * @dataProvider dataGetWithException + * @param mixed $exception */ public function testGetNewWithException(mixed $id, $exception, ?string $message = NULL): void { @@ -117,6 +124,9 @@ class ContainerTest extends IonTestCase { /** * @dataProvider dataSetInstanceWithException + * @param mixed $id + * @param mixed $exception + * @param mixed $message */ public function testSetInstanceWithException($id, $exception, $message): void { @@ -124,64 +134,56 @@ class ContainerTest extends IonTestCase { { $this->container->setInstance($id, NULL); } - catch(ContainerException $e) + catch (ContainerException $e) { $this->assertInstanceOf($exception, $e); - $this->assertEquals($message, $e->getMessage()); + $this->assertSame($message, $e->getMessage()); } } public function testGetNew(): void { - $this->container->set('footest', static function($item) { - return new FooTest($item); - }); + $this->container->set('footest', static fn ($item) => new FooTest($item)); // Check that the item is the container, if called without arguments $footest1 = $this->container->getNew('footest'); $this->assertInstanceOf(ContainerInterface::class, $footest1->item); $footest2 = $this->container->getNew('footest', ['Test String']); - $this->assertEquals('Test String', $footest2->item); + $this->assertSame('Test String', $footest2->item); } public function testSetContainerInInstance(): void { - $this->container->set('footest2', function() { - return new FooTest2(); - }); + $this->container->set('footest2', static fn () => new FooTest2()); $footest2 = $this->container->get('footest2'); - $this->assertEquals($this->container, $footest2->getContainer()); + $this->assertSame($this->container, $footest2->getContainer()); } public function testGetNewReturnCallable(): void { - $this->container->set('footest', static function($item) { - return static function() use ($item) { - return $item; - }; - }); + $this->container->set('footest', static fn ($item) => static fn () => $item); // Check that the item is the container, if called without arguments $footest1 = $this->container->getNew('footest'); $this->assertInstanceOf(ContainerInterface::class, $footest1()); $footest2 = $this->container->getNew('footest', ['Test String']); - $this->assertEquals('Test String', $footest2()); + $this->assertSame('Test String', $footest2()); } public function testGetSet(): void { - $container = $this->container->set('foo', static function() { - return static function() {}; + $container = $this->container->set('foo', static function () { + return static function () {}; }); $this->assertInstanceOf(Container::class, $container); $this->assertInstanceOf(ContainerInterface::class, $container); // The factory returns a callable - $this->assertTrue(is_callable($container->get('foo'))); + $this->assertIsCallable($container->get('foo')); } public function testLoggerMethods(): void @@ -202,12 +204,12 @@ class ContainerTest extends IonTestCase { $this->assertInstanceOf(ContainerInterface::class, $container); $this->assertInstanceOf(Container::class, $container2); - $this->assertEquals($logger1, $this->container->getLogger('default')); - $this->assertEquals($logger2, $this->container->getLogger('test')); + $this->assertSame($logger1, $this->container->getLogger('default')); + $this->assertSame($logger2, $this->container->getLogger('test')); $this->assertNull($this->container->getLogger('foo')); $this->assertTrue($this->container->hasLogger()); $this->assertTrue($this->container->hasLogger('default')); $this->assertTrue($this->container->hasLogger('test')); } -} \ No newline at end of file +} diff --git a/tests/Ion/EnumTest.php b/tests/Ion/EnumTest.php index d0a52c3e..382bd820 100644 --- a/tests/Ion/EnumTest.php +++ b/tests/Ion/EnumTest.php @@ -6,27 +6,27 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests; -use Aviat\Ion\Enum; - -class EnumTest extends IonTestCase { - +/** + * @internal + */ +final class EnumTest extends IonTestCase +{ protected $expectedConstList = [ 'FOO' => 'bar', 'BAR' => 'foo', - 'FOOBAR' => 'baz' + 'FOOBAR' => 'baz', ]; - public function setUp(): void { + protected function setUp(): void + { parent::setUp(); $this->enum = new TestEnum(); } @@ -34,13 +34,13 @@ class EnumTest extends IonTestCase { public function testStaticGetConstList() { $actual = TestEnum::getConstList(); - $this->assertEquals($this->expectedConstList, $actual); + $this->assertSame($this->expectedConstList, $actual); } public function testGetConstList() { $actual = $this->enum->getConstList(); - $this->assertEquals($this->expectedConstList, $actual); + $this->assertSame($this->expectedConstList, $actual); } public function dataIsValid() @@ -49,28 +49,31 @@ class EnumTest extends IonTestCase { 'Valid' => [ 'value' => 'baz', 'expected' => TRUE, - 'static' => FALSE + 'static' => FALSE, ], 'ValidStatic' => [ 'value' => 'baz', 'expected' => TRUE, - 'static' => TRUE + 'static' => TRUE, ], 'Invalid' => [ 'value' => 'foobar', 'expected' => FALSE, - 'static' => FALSE + 'static' => FALSE, ], 'InvalidStatic' => [ 'value' => 'foobar', 'expected' => FALSE, - 'static' => TRUE - ] + 'static' => TRUE, + ], ]; } /** * @dataProvider dataIsValid + * @param mixed $value + * @param mixed $expected + * @param mixed $static */ public function testIsValid($value, $expected, $static) { @@ -78,6 +81,6 @@ class EnumTest extends IonTestCase { ? TestEnum::isValid($value) : $this->enum->isValid($value); - $this->assertEquals($expected, $actual); + $this->assertSame($expected, $actual); } -} \ No newline at end of file +} diff --git a/tests/Ion/EventTest.php b/tests/Ion/EventTest.php index 78327a73..4f135bf7 100644 --- a/tests/Ion/EventTest.php +++ b/tests/Ion/EventTest.php @@ -6,12 +6,10 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests; @@ -19,11 +17,14 @@ namespace Aviat\Ion\Tests; use Aviat\Ion\Event; use PHPUnit\Framework\TestCase; -class EventTest extends TestCase { - +/** + * @internal + */ +final class EventTest extends TestCase +{ public function testEmit(): void { Event::on('test-event', fn ($fired) => $this->assertTrue($fired)); - Event::emit('test-event', [true]); + Event::emit('test-event', [TRUE]); } -} \ No newline at end of file +} diff --git a/tests/Ion/Exception/DoubleRenderExceptionTest.php b/tests/Ion/Exception/DoubleRenderExceptionTest.php index d4df21e4..700098a2 100644 --- a/tests/Ion/Exception/DoubleRenderExceptionTest.php +++ b/tests/Ion/Exception/DoubleRenderExceptionTest.php @@ -6,12 +6,10 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests\Exception; @@ -19,8 +17,11 @@ namespace Aviat\Ion\Tests\Exception; use Aviat\Ion\Exception\DoubleRenderException; use Aviat\Ion\Tests\IonTestCase; -class DoubleRenderExceptionTest extends IonTestCase { - +/** + * @internal + */ +final class DoubleRenderExceptionTest extends IonTestCase +{ public function testDefaultMessage() { $this->expectException(DoubleRenderException::class); @@ -28,4 +29,4 @@ class DoubleRenderExceptionTest extends IonTestCase { throw new DoubleRenderException(); } -} \ No newline at end of file +} diff --git a/tests/Ion/FriendTest.php b/tests/Ion/FriendTest.php index 99bcd423..e25d6eeb 100644 --- a/tests/Ion/FriendTest.php +++ b/tests/Ion/FriendTest.php @@ -6,60 +6,61 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests; use Aviat\Ion\Friend; -use Aviat\Ion\Tests\FriendTestClass; - -class FriendTest extends IonTestCase { +/** + * @internal + */ +final class FriendTest extends IonTestCase +{ protected $friend; - public function setUp(): void { + protected function setUp(): void + { parent::setUp(); $obj = new FriendTestClass(); $this->friend = new Friend($obj); } - public function testPrivateMethod():void + public function testPrivateMethod(): void { $actual = $this->friend->getPrivate(); - $this->assertEquals(23, $actual); + $this->assertSame(23, $actual); } - public function testProtectedMethod():void + public function testProtectedMethod(): void { $actual = $this->friend->getProtected(); - $this->assertEquals(4, $actual); + $this->assertSame(4, $actual); } - public function testGet():void + public function testGet(): void { - $this->assertEquals(356, $this->friend->protected); + $this->assertSame(356, $this->friend->protected); $this->assertNull($this->friend->foo); // Return NULL for non-existent properties - $this->assertEquals(47, $this->friend->parentProtected); - $this->assertEquals(84, $this->friend->grandParentProtected); + $this->assertSame(47, $this->friend->parentProtected); + $this->assertSame(84, $this->friend->grandParentProtected); $this->assertNull($this->friend->parentPrivate); // Can't get a parent's privates } public function testSet(): void { $this->friend->private = 123; - $this->assertEquals(123, $this->friend->private); + $this->assertSame(123, $this->friend->private); $this->friend->foo = 32; $this->assertNull($this->friend->foo); } - public function testBadInvokation():void + public function testBadInvokation(): void { $this->expectException('InvalidArgumentException'); $this->expectExceptionMessage('Friend must be an object'); @@ -67,11 +68,11 @@ class FriendTest extends IonTestCase { $friend = new Friend('foo'); } - public function testBadMethod():void + public function testBadMethod(): void { $this->expectException('BadMethodCallException'); $this->expectExceptionMessage("Method 'foo' does not exist"); $this->friend->foo(); } -} \ No newline at end of file +} diff --git a/tests/Ion/IonTestCase.php b/tests/Ion/IonTestCase.php index 8d2c97d0..6d69a4da 100644 --- a/tests/Ion/IonTestCase.php +++ b/tests/Ion/IonTestCase.php @@ -6,26 +6,25 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests; -use function Aviat\Ion\_dir; - use Aviat\Ion\Di\ContainerInterface; -use PHPUnit\Framework\TestCase; + use Laminas\Diactoros\ServerRequestFactory; +use PHPUnit\Framework\TestCase; +use function Aviat\Ion\_dir; /** * Base class for TestCases */ -class IonTestCase extends TestCase { +class IonTestCase extends TestCase +{ // Test directory constants public const ROOT_DIR = AC_TEST_ROOT_DIR; public const SRC_DIR = SRC_DIR; @@ -44,7 +43,7 @@ class IonTestCase extends TestCase { self::$session_handler = $session_handler; }*/ - public function setUp(): void + protected function setUp(): void { parent::setUp(); @@ -62,7 +61,7 @@ class IonTestCase extends TestCase { 'pass' => '', 'port' => '', 'name' => 'default', - 'database' => '', + 'database' => '', 'file' => ':memory:', ], 'cache' => [ @@ -72,31 +71,32 @@ class IonTestCase extends TestCase { 'pass' => '', 'port' => '', 'name' => 'default', - 'database' => '', + 'database' => '', 'file' => ':memory:', - ] + ], ], 'routes' => [ 'route_config' => [ - 'asset_path' => '/assets' + 'asset_path' => '/assets', ], 'routes' => [ - ] + ], ], 'redis' => [ 'host' => (array_key_exists('REDIS_HOST', $_ENV)) ? $_ENV['REDIS_HOST'] : 'localhost', - 'database' => 13 - ] + 'database' => 13, + ], ]; // Set up DI container - $di = require('di.php'); + $di = require 'di.php'; $container = $di($config_array); - $container->set('session-handler', static function() { + $container->set('session-handler', static function () { // Use mock session handler $session_handler = new TestSessionHandler(); session_set_save_handler($session_handler, TRUE); + return $session_handler; }); @@ -105,9 +105,6 @@ class IonTestCase extends TestCase { /** * Set arbitrary superglobal values for testing purposes - * - * @param array $supers - * @return void */ public function setSuperGlobals(array $supers = []): void { @@ -116,7 +113,7 @@ class IonTestCase extends TestCase { '_GET' => $_GET, '_POST' => $_POST, '_COOKIE' => $_COOKIE, - '_FILES' => $_FILES + '_FILES' => $_FILES, ]; $request = call_user_func_array( @@ -126,4 +123,4 @@ class IonTestCase extends TestCase { $this->container->setInstance('request', $request); } } -// End of IonTestCase.php \ No newline at end of file +// End of IonTestCase.php diff --git a/tests/Ion/JsonTest.php b/tests/Ion/JsonTest.php index 4f00e1f8..48a14037 100644 --- a/tests/Ion/JsonTest.php +++ b/tests/Ion/JsonTest.php @@ -6,50 +6,51 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests; -use function Aviat\Ion\_dir; - use Aviat\Ion\{Json, JsonException}; -class JsonTest extends IonTestCase { +use function Aviat\Ion\_dir; +/** + * @internal + */ +final class JsonTest extends IonTestCase +{ public function testEncode() { $data = (object) [ - 'foo' => [1, 2, 3, 4] + 'foo' => [1, 2, 3, 4], ]; $expected = '{"foo":[1,2,3,4]}'; - $this->assertEquals($expected, Json::encode($data)); + $this->assertSame($expected, Json::encode($data)); } - public function dataEncodeDecode() + public function dataEncodeDecode(): array { return [ 'set1' => [ 'data' => [ 'apple' => [ - 'sauce' => ['foo','bar','baz'] - ] + 'sauce' => ['foo', 'bar', 'baz'], + ], ], 'expected_size' => 39, - 'expected_json' => '{"apple":{"sauce":["foo","bar","baz"]}}' - ] + 'expected_json' => '{"apple":{"sauce":["foo","bar","baz"]}}', + ], ]; } /** * @dataProvider dataEncodeDecode */ - public function testEncodeDecodeFile($data, $expected_size, $expected_json) + public function testEncodeDecodeFile(array $data, int $expected_size, string $expected_json): void { $target_file = _dir(self::TEST_DATA_DIR, 'json_write.json'); @@ -57,8 +58,8 @@ class JsonTest extends IonTestCase { $actual_json = file_get_contents($target_file); $this->assertTrue(Json::isJson($actual_json)); - $this->assertEquals($expected_size, $actual_size); - $this->assertEquals($expected_json, $actual_json); + $this->assertSame($expected_size, $actual_size); + $this->assertSame($expected_json, $actual_json); $this->assertEquals($data, Json::decodeFile($target_file)); @@ -69,10 +70,10 @@ class JsonTest extends IonTestCase { { $json = '{"foo":[1,2,3,4]}'; $expected = [ - 'foo' => [1, 2, 3, 4] + 'foo' => [1, 2, 3, 4], ]; - $this->assertEquals($expected, Json::decode($json)); - $this->assertEquals((object)$expected, Json::decode($json, false)); + $this->assertSame($expected, Json::decode($json)); + $this->assertEquals((object) $expected, Json::decode($json, FALSE)); $badJson = '{foo:{1|2}}'; $this->expectException('Aviat\Ion\JsonException'); @@ -86,4 +87,4 @@ class JsonTest extends IonTestCase { { $this->assertNull(Json::decode(NULL)); } -} \ No newline at end of file +} diff --git a/tests/Ion/TestSessionHandler.php b/tests/Ion/TestSessionHandler.php index cf5be4b8..4e222274 100644 --- a/tests/Ion/TestSessionHandler.php +++ b/tests/Ion/TestSessionHandler.php @@ -6,20 +6,18 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests; use SessionHandlerInterface; -class TestSessionHandler implements SessionHandlerInterface { - +class TestSessionHandler implements SessionHandlerInterface +{ public $data = []; public $save_path = './test_data/sessions'; @@ -30,12 +28,13 @@ class TestSessionHandler implements SessionHandlerInterface { public function destroy($id) { - $file = "$this->save_path/$id"; + $file = "{$this->save_path}/{$id}"; if (file_exists($file)) { @unlink($file); } $this->data[$id] = []; + return TRUE; } @@ -56,16 +55,15 @@ class TestSessionHandler implements SessionHandlerInterface { public function read($id) { - return json_decode(@file_get_contents("$this->save_path/$id"), TRUE); + return json_decode(@file_get_contents("{$this->save_path}/{$id}"), TRUE); } public function write($id, $data) { - $file = "$this->save_path/$id"; + $file = "{$this->save_path}/{$id}"; file_put_contents($file, json_encode($data)); return TRUE; } - } -// End of TestSessionHandler.php \ No newline at end of file +// End of TestSessionHandler.php diff --git a/tests/Ion/Transformer/AbstractTransformerTest.php b/tests/Ion/Transformer/AbstractTransformerTest.php index 4a7d3c41..bb185151 100644 --- a/tests/Ion/Transformer/AbstractTransformerTest.php +++ b/tests/Ion/Transformer/AbstractTransformerTest.php @@ -6,26 +6,28 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests\Transformer; use Aviat\Ion\Tests\IonTestCase; use Aviat\Ion\Tests\{TestTransformer, TestTransformerUntransform}; +use BadMethodCallException; -class AbstractTransformerTest extends IonTestCase { - +/** + * @internal + */ +final class AbstractTransformerTest extends IonTestCase +{ protected $transformer; protected $untransformer; - - public function setUp(): void { + protected function setUp(): void + { $this->transformer = new TestTransformer(); $this->untransformer = new TestTransformerUntransform(); } @@ -35,29 +37,29 @@ class AbstractTransformerTest extends IonTestCase { return [ 'object' => [ 'original' => [ - (object)[ + (object) [ ['name' => 'Comedy'], ['name' => 'Romance'], ['name' => 'School'], - ['name' => 'Harem'] + ['name' => 'Harem'], ], - (object)[ + (object) [ ['name' => 'Action'], ['name' => 'Comedy'], ['name' => 'Magic'], ['name' => 'Fantasy'], - ['name' => 'Mahou Shoujo'] + ['name' => 'Mahou Shoujo'], ], - (object)[ + (object) [ ['name' => 'Comedy'], - ['name' => 'Sci-Fi'] - ] + ['name' => 'Sci-Fi'], + ], ], 'expected' => [ ['Comedy', 'Romance', 'School', 'Harem'], ['Action', 'Comedy', 'Magic', 'Fantasy', 'Mahou Shoujo'], - ['Comedy', 'Sci-Fi'] - ] + ['Comedy', 'Sci-Fi'], + ], ], 'array' => [ 'original' => [ @@ -65,25 +67,25 @@ class AbstractTransformerTest extends IonTestCase { ['name' => 'Comedy'], ['name' => 'Romance'], ['name' => 'School'], - ['name' => 'Harem'] + ['name' => 'Harem'], ], [ ['name' => 'Action'], ['name' => 'Comedy'], ['name' => 'Magic'], ['name' => 'Fantasy'], - ['name' => 'Mahou Shoujo'] + ['name' => 'Mahou Shoujo'], ], [ ['name' => 'Comedy'], - ['name' => 'Sci-Fi'] - ] + ['name' => 'Sci-Fi'], + ], ], 'expected' => [ ['Comedy', 'Romance', 'School', 'Harem'], ['Action', 'Comedy', 'Magic', 'Fantasy', 'Mahou Shoujo'], - ['Comedy', 'Sci-Fi'] - ] + ['Comedy', 'Sci-Fi'], + ], ], ]; } @@ -93,28 +95,28 @@ class AbstractTransformerTest extends IonTestCase { return [ 'object' => [ 'original' => [ - (object)['Comedy', 'Romance', 'School', 'Harem'], - (object)['Action', 'Comedy', 'Magic', 'Fantasy', 'Mahou Shoujo'], - (object)['Comedy', 'Sci-Fi'] + (object) ['Comedy', 'Romance', 'School', 'Harem'], + (object) ['Action', 'Comedy', 'Magic', 'Fantasy', 'Mahou Shoujo'], + (object) ['Comedy', 'Sci-Fi'], ], 'expected' => [ ['Comedy', 'Romance', 'School', 'Harem'], ['Action', 'Comedy', 'Magic', 'Fantasy', 'Mahou Shoujo'], - ['Comedy', 'Sci-Fi'] - ] + ['Comedy', 'Sci-Fi'], + ], ], 'array' => [ 'original' => [ ['Comedy', 'Romance', 'School', 'Harem'], ['Action', 'Comedy', 'Magic', 'Fantasy', 'Mahou Shoujo'], - ['Comedy', 'Sci-Fi'] + ['Comedy', 'Sci-Fi'], ], 'expected' => [ ['Comedy', 'Romance', 'School', 'Harem'], ['Action', 'Comedy', 'Magic', 'Fantasy', 'Mahou Shoujo'], - ['Comedy', 'Sci-Fi'] - ] - ] + ['Comedy', 'Sci-Fi'], + ], + ], ]; } @@ -125,33 +127,39 @@ class AbstractTransformerTest extends IonTestCase { $expected = $data['object']['expected'][0]; $actual = $this->transformer->transform($original); - $this->assertEquals($expected, $actual); + $this->assertSame($expected, $actual); } /** * @dataProvider dataTransformCollection + * @param mixed $original + * @param mixed $expected */ public function testTransformCollection($original, $expected) { $actual = $this->transformer->transformCollection($original); - $this->assertEquals($expected, $actual); + $this->assertSame($expected, $actual); } /** * @dataProvider dataUnTransformCollection + * @param mixed $original + * @param mixed $expected */ public function testUntransformCollection($original, $expected) { $actual = $this->untransformer->untransformCollection($original); - $this->assertEquals($expected, $actual); + $this->assertSame($expected, $actual); } /** * @dataProvider dataUnTransformCollection + * @param mixed $original + * @param mixed $expected */ public function testUntransformCollectionWithException($original, $expected) { - $this->expectException(\BadMethodCallException::class); + $this->expectException(BadMethodCallException::class); $this->transformer->untransformCollection($original); } -} \ No newline at end of file +} diff --git a/tests/Ion/Type/ArrayTypeTest.php b/tests/Ion/Type/ArrayTypeTest.php index 8ea0b5d3..b67a8667 100644 --- a/tests/Ion/Type/ArrayTypeTest.php +++ b/tests/Ion/Type/ArrayTypeTest.php @@ -6,20 +6,22 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests\Type; -use Aviat\Ion\Type\ArrayType; use Aviat\Ion\Tests\IonTestCase; +use Aviat\Ion\Type\ArrayType; -class ArrayTypeTest extends IonTestCase { +/** + * @internal + */ +final class ArrayTypeTest extends IonTestCase +{ public function dataCall() { $method_map = [ @@ -43,38 +45,38 @@ class ArrayTypeTest extends IonTestCase { 'method' => 'merge', 'array' => [1, 3, 5, 7], 'args' => [[2, 4, 6, 8]], - 'expected' => [1, 3, 5, 7, 2, 4, 6, 8] + 'expected' => [1, 3, 5, 7, 2, 4, 6, 8], ], 'array_product' => [ 'method' => 'product', 'array' => [1, 2, 3], 'args' => [], - 'expected' => 6 + 'expected' => 6, ], 'array_reverse' => [ 'method' => 'reverse', 'array' => [1, 2, 3, 4, 5], 'args' => [], - 'expected' => [5, 4, 3, 2, 1] + 'expected' => [5, 4, 3, 2, 1], ], 'array_sum' => [ 'method' => 'sum', 'array' => [1, 2, 3, 4, 5, 6], 'args' => [], - 'expected' => 21 + 'expected' => 21, ], 'array_unique' => [ 'method' => 'unique', 'array' => [1, 1, 3, 2, 2, 2, 3, 3, 5], 'args' => [SORT_REGULAR], - 'expected' => [0 => 1, 2 => 3, 3 => 2, 8 => 5] + 'expected' => [0 => 1, 2 => 3, 3 => 2, 8 => 5], ], 'array_values' => [ 'method' => 'values', 'array' => ['foo' => 'bar', 'baz' => 'foobar'], 'args' => [], - 'expected' => ['bar', 'foobar'] - ] + 'expected' => ['bar', 'foobar'], + ], ]; } @@ -82,16 +84,13 @@ class ArrayTypeTest extends IonTestCase { * Test the array methods defined for the __Call method * * @dataProvider dataCall - * @param string $method - * @param array $array - * @param array $args * @param $expected */ public function testCall(string $method, array $array, array $args, $expected): void { $obj = ArrayType::from($array); $actual = $obj->__call($method, $args); - $this->assertEquals($expected, $actual); + $this->assertSame($expected, $actual); } public function testSet(): void @@ -100,16 +99,16 @@ class ArrayTypeTest extends IonTestCase { $arraytype = $obj->set('foo', 'bar'); $this->assertInstanceOf(ArrayType::class, $arraytype); - $this->assertEquals('bar', $obj->get('foo')); + $this->assertSame('bar', $obj->get('foo')); } public function testGet(): void { $array = [1, 2, 3, 4, 5]; $obj = ArrayType::from($array); - $this->assertEquals($array, $obj->get()); - $this->assertEquals(1, $obj->get(0)); - $this->assertEquals(5, $obj->get(4)); + $this->assertSame($array, $obj->get()); + $this->assertSame(1, $obj->get(0)); + $this->assertSame(5, $obj->get(4)); } public function testGetDeepKey(): void @@ -117,22 +116,20 @@ class ArrayTypeTest extends IonTestCase { $arr = [ 'foo' => 'bar', 'baz' => [ - 'bar' => 'foobar' - ] + 'bar' => 'foobar', + ], ]; $obj = ArrayType::from($arr); - $this->assertEquals('foobar', $obj->getDeepKey(['baz', 'bar'])); + $this->assertSame('foobar', $obj->getDeepKey(['baz', 'bar'])); $this->assertNull($obj->getDeepKey(['foo', 'bar', 'baz'])); } public function testMap(): void { $obj = ArrayType::from([1, 2, 3]); - $actual = $obj->map(function($item) { - return $item * 2; - }); + $actual = $obj->map(static fn ($item) => $item * 2); - $this->assertEquals([2, 4, 6], $actual); + $this->assertSame([2, 4, 6], $actual); } public function testBadCall(): void @@ -153,14 +150,14 @@ class ArrayTypeTest extends IonTestCase { $actual = $obj->shuffle(); //$this->assertNotEquals($actual, $original); - $this->assertTrue(is_array($actual)); + $this->assertIsArray($actual); } public function testHasKey(): void { $obj = ArrayType::from([ 'a' => 'b', - 'z' => 'y' + 'z' => 'y', ]); $this->assertTrue($obj->hasKey('a')); $this->assertFalse($obj->hasKey('b')); @@ -200,7 +197,7 @@ class ArrayTypeTest extends IonTestCase { { $obj = ArrayType::from([1, 2, 5, 7, 47]); $actual = $obj->search(47); - $this->assertEquals(4, $actual); + $this->assertSame(4, $actual); } public function testFill(): void @@ -208,6 +205,6 @@ class ArrayTypeTest extends IonTestCase { $obj = ArrayType::from([]); $expected = ['?', '?', '?']; $actual = $obj->fill(0, 3, '?'); - $this->assertEquals($actual, $expected); + $this->assertSame($actual, $expected); } -} \ No newline at end of file +} diff --git a/tests/Ion/Type/StringTypeTest.php b/tests/Ion/Type/StringTypeTest.php index 64a6a136..869bca1f 100644 --- a/tests/Ion/Type/StringTypeTest.php +++ b/tests/Ion/Type/StringTypeTest.php @@ -6,62 +6,59 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests\Type; -use Aviat\Ion\Type\StringType; use Aviat\Ion\Tests\IonTestCase; +use Aviat\Ion\Type\StringType; -class StringTypeTest extends IonTestCase { - +/** + * @internal + */ +final class StringTypeTest extends IonTestCase +{ public function dataFuzzyCaseMatch(): array { return [ 'space separated' => [ 'str1' => 'foo bar baz', 'str2' => 'foo-bar-baz', - 'expected' => true + 'expected' => TRUE, ], 'camelCase' => [ 'str1' => 'fooBarBaz', 'str2' => 'foo-bar-baz', - 'expected' => true + 'expected' => TRUE, ], 'PascalCase' => [ 'str1' => 'FooBarBaz', 'str2' => 'foo-bar-baz', - 'expected' => true + 'expected' => TRUE, ], 'snake_case' => [ 'str1' => 'foo_bar_baz', 'str2' => 'foo-bar-baz', - 'expected' => true + 'expected' => TRUE, ], 'mEsSYcAse' => [ 'str1' => 'fOObArBAZ', 'str2' => 'foo-bar-baz', - 'expected' => false + 'expected' => FALSE, ], ]; } /** * @dataProvider dataFuzzyCaseMatch - * @param string $str1 - * @param string $str2 - * @param bool $expected */ public function testFuzzyCaseMatch(string $str1, string $str2, bool $expected): void { $actual = StringType::from($str1)->fuzzyCaseMatch($str2); - $this->assertEquals($expected, $actual); + $this->assertSame($expected, $actual); } - -} \ No newline at end of file +} diff --git a/tests/Ion/View/HtmlViewTest.php b/tests/Ion/View/HtmlViewTest.php index 9c299449..fa078a35 100644 --- a/tests/Ion/View/HtmlViewTest.php +++ b/tests/Ion/View/HtmlViewTest.php @@ -6,25 +6,27 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests\View; -use function Aviat\Ion\_dir; - use Aviat\Ion\Tests\TestHtmlView; -class HtmlViewTest extends HttpViewTest { +use function Aviat\Ion\_dir; +/** + * @internal + */ +final class HtmlViewTest extends HttpViewTest +{ protected $template_path; - public function setUp(): void { + protected function setUp(): void + { parent::setUp(); $this->view = new TestHtmlView($this->container); } @@ -34,9 +36,8 @@ class HtmlViewTest extends HttpViewTest { $path = _dir(self::TEST_VIEW_DIR, 'test_view.php'); $expected = 'foo'; $actual = $this->view->renderTemplate($path, [ - 'var' => 'foo' + 'var' => 'foo', ]); - $this->assertEquals($expected, $actual); + $this->assertSame($expected, $actual); } - -} \ No newline at end of file +} diff --git a/tests/Ion/View/HttpViewTest.php b/tests/Ion/View/HttpViewTest.php index 41d9b20f..ec8acf4f 100644 --- a/tests/Ion/View/HttpViewTest.php +++ b/tests/Ion/View/HttpViewTest.php @@ -6,70 +6,68 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests\View; -use Aviat\Ion\Friend; use Aviat\Ion\Exception\DoubleRenderException; -use Aviat\Ion\Tests\IonTestCase; -use Aviat\Ion\Tests\TestHttpView; - -class HttpViewTest extends IonTestCase { +use Aviat\Ion\Friend; +use Aviat\Ion\Tests\{IonTestCase, TestHttpView}; +class HttpViewTest extends IonTestCase +{ protected $view; protected $friend; - public function setUp(): void { + protected function setUp(): void + { parent::setUp(); $this->view = new TestHttpView(); $this->friend = new Friend($this->view); } - public function testGetOutput():void + public function testGetOutput(): void { $this->friend->setOutput('foo'); - $this->assertEquals('foo', $this->friend->getOutput()); + $this->assertSame('foo', $this->friend->getOutput()); $this->assertFalse($this->friend->hasRendered); - $this->assertEquals($this->friend->getOutput(), $this->friend->__toString()); + $this->assertSame($this->friend->getOutput(), $this->friend->__toString()); $this->assertTrue($this->friend->hasRendered); } - public function testSetOutput():void + public function testSetOutput(): void { $same = $this->view->setOutput('

'); - $this->assertEquals($same, $this->view); - $this->assertEquals('

', $this->view->getOutput()); + $this->assertSame($same, $this->view); + $this->assertSame('

', $this->view->getOutput()); } - public function testAppendOutput():void + public function testAppendOutput(): void { $this->view->setOutput('

'); $this->view->appendOutput('

'); - $this->assertEquals('

', $this->view->getOutput()); + $this->assertSame('

', $this->view->getOutput()); } - public function testSetStatusCode():void + public function testSetStatusCode(): void { $view = $this->view->setStatusCode(404); - $this->assertEquals(404, $view->response->getStatusCode()); + $this->assertSame(404, $view->response->getStatusCode()); } - public function testAddHeader():void + public function testAddHeader(): void { $view = $this->view->addHeader('foo', 'bar'); $this->assertTrue($view->response->hasHeader('foo')); - $this->assertEquals(['bar'], $view->response->getHeader('foo')); + $this->assertSame(['bar'], $view->response->getHeader('foo')); } - public function testSendDoubleRenderException():void + public function testSendDoubleRenderException(): void { $this->expectException(DoubleRenderException::class); $this->expectExceptionMessage('A view can only be rendered once, because headers can only be sent once.'); @@ -81,7 +79,7 @@ class HttpViewTest extends IonTestCase { $this->view->send(); } - public function test__toStringDoubleRenderException():void + public function testToStringDoubleRenderException(): void { $this->expectException(DoubleRenderException::class); $this->expectExceptionMessage('A view can only be rendered once, because headers can only be sent once.'); @@ -106,4 +104,4 @@ class HttpViewTest extends IonTestCase { $this->assertTrue($this->friend->hasRendered); } -} \ No newline at end of file +} diff --git a/tests/Ion/View/JsonViewTest.php b/tests/Ion/View/JsonViewTest.php index adcd587f..be950aea 100644 --- a/tests/Ion/View/JsonViewTest.php +++ b/tests/Ion/View/JsonViewTest.php @@ -6,12 +6,10 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests\View; @@ -19,16 +17,20 @@ namespace Aviat\Ion\Tests\View; use Aviat\Ion\Friend; use Aviat\Ion\Tests\TestJsonView; -class JsonViewTest extends HttpViewTest { - - public function setUp(): void { +/** + * @internal + */ +final class JsonViewTest extends HttpViewTest +{ + protected function setUp(): void + { parent::setUp(); $this->view = new TestJsonView(); $this->friend = new Friend($this->view); } - public function testSetOutputJSON():void + public function testSetOutputJSON(): void { // Extend view class to remove destructor which does output $view = new TestJsonView(); @@ -37,21 +39,21 @@ class JsonViewTest extends HttpViewTest { $content = ['foo' => 'bar']; $expected = json_encode($content); $view->setOutput($content); - $this->assertEquals($expected, $view->getOutput()); + $this->assertSame($expected, $view->getOutput()); } - public function testSetOutput():void + public function testSetOutput(): void { // Directly set string $view = new TestJsonView(); $content = '{}'; $expected = '{}'; $view->setOutput($content); - $this->assertEquals($expected, $view->getOutput()); + $this->assertSame($expected, $view->getOutput()); } - public function testOutputType():void + public function testOutputType(): void { - $this->assertEquals('application/json', $this->friend->contentType); + $this->assertSame('application/json', $this->friend->contentType); } -} \ No newline at end of file +} diff --git a/tests/Ion/di.php b/tests/Ion/di.php index b01b7ad0..a1aa8608 100644 --- a/tests/Ion/di.php +++ b/tests/Ion/di.php @@ -2,25 +2,21 @@ use Aura\Html\HelperLocatorFactory; use Aura\Session\SessionFactory; -use Laminas\Diactoros\ServerRequestFactory; -use Laminas\Diactoros\Response; - use Aviat\Ion\Config; use Aviat\Ion\Di\Container; +use Laminas\Diactoros\{Response, ServerRequestFactory}; // ----------------------------------------------------------------------------- // Setup DI container // ----------------------------------------------------------------------------- -return static function(array $config_array = []) { +return static function (array $config_array = []) { $container = new Container(); - $container->set('config', static function() { - return new Config([]); - }); + $container->set('config', static fn () => new Config([])); $container->setInstance('config', new Config($config_array)); - $container->set('request', static function() { + $container->set('request', static function () { return ServerRequestFactory::fromGlobals( $GLOBALS['_SERVER'], $_GET, @@ -30,18 +26,14 @@ return static function(array $config_array = []) { ); }); - $container->set('response', static function() { - return new Response(); - }); + $container->set('response', static fn () => new Response()); // Create session Object - $container->set('session', static function() { - return (new SessionFactory())->newInstance($_COOKIE); - }); + $container->set('session', static fn () => (new SessionFactory())->newInstance($_COOKIE)); // Create Html helper Object - $container->set('html-helper', fn() => (new HelperLocatorFactory)->newInstance()); - $container->set('component-helper', fn() => (new HelperLocatorFactory)->newInstance()); + $container->set('html-helper', static fn () => (new HelperLocatorFactory())->newInstance()); + $container->set('component-helper', static fn () => (new HelperLocatorFactory())->newInstance()); return $container; -}; \ No newline at end of file +}; diff --git a/tests/Ion/functionsTest.php b/tests/Ion/functionsTest.php index a117cc8c..3e28bdb1 100644 --- a/tests/Ion/functionsTest.php +++ b/tests/Ion/functionsTest.php @@ -6,28 +6,29 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests; -use function Aviat\Ion\_dir; - use PHPUnit\Framework\TestCase; -class functionsTest extends TestCase { +use function Aviat\Ion\_dir; +use const DIRECTORY_SEPARATOR; - - public function test_dir() +/** + * @internal + */ +final class functionsTest extends TestCase +{ + public function testDir() { $args = ['foo', 'bar', 'baz']; - $expected = implode(\DIRECTORY_SEPARATOR, $args); + $expected = implode(DIRECTORY_SEPARATOR, $args); - $this->assertEquals(_dir(...$args), $expected); + $this->assertSame(_dir(...$args), $expected); } -} \ No newline at end of file +} diff --git a/tests/Ion/mocks.php b/tests/Ion/mocks.php index c0a2f755..cc3a9ca5 100644 --- a/tests/Ion/mocks.php +++ b/tests/Ion/mocks.php @@ -6,50 +6,54 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ namespace Aviat\Ion\Tests; -use Aviat\Ion\Enum; use Aviat\Ion\Exception\DoubleRenderException; -use Aviat\Ion\Friend; use Aviat\Ion\Transformer\AbstractTransformer; use Aviat\Ion\View\{HtmlView, HttpView, JsonView}; +use Aviat\Ion\{Enum, Friend}; // ----------------------------------------------------------------------------- // Mock the default error handler // ----------------------------------------------------------------------------- -class MockErrorHandler { - public function addDataTable($name, array $values=[]) {} +class MockErrorHandler +{ + public function addDataTable($name, array $values=[]) + { + } } // ----------------------------------------------------------------------------- // Ion Mocks // ----------------------------------------------------------------------------- -class TestEnum extends Enum { - const FOO = 'bar'; - const BAR = 'foo'; - const FOOBAR = 'baz'; +class TestEnum extends Enum +{ + public const FOO = 'bar'; + public const BAR = 'foo'; + public const FOOBAR = 'baz'; } -class FriendGrandParentTestClass { +class FriendGrandParentTestClass +{ protected $grandParentProtected = 84; } -class FriendParentTestClass extends FriendGrandParentTestClass { +class FriendParentTestClass extends FriendGrandParentTestClass +{ protected $parentProtected = 47; private $parentPrivate = 654; } -class FriendTestClass extends FriendParentTestClass { +class FriendTestClass extends FriendParentTestClass +{ protected $protected = 356; private $private = 486; @@ -64,14 +68,14 @@ class FriendTestClass extends FriendParentTestClass { } } -class TestTransformer extends AbstractTransformer { - +class TestTransformer extends AbstractTransformer +{ public function transform(array|object $item): array { $out = []; $genre_list = (array) $item; - foreach($genre_list as $genre) + foreach ($genre_list as $genre) { $out[] = $genre['name']; } @@ -80,14 +84,16 @@ class TestTransformer extends AbstractTransformer { } } -class TestTransformerUntransform extends TestTransformer { +class TestTransformerUntransform extends TestTransformer +{ public function untransform($item) { - return (array)$item; + return (array) $item; } } -trait MockViewOutputTrait { +trait MockViewOutputTrait +{ /*protected function output() { $reflect = new ReflectionClass($this); $properties = $reflect->getProperties(); @@ -120,7 +126,8 @@ trait MockViewOutputTrait { } } -class TestHtmlView extends HtmlView { +class TestHtmlView extends HtmlView +{ protected function output(): void { if ($this->hasRendered) @@ -132,7 +139,8 @@ class TestHtmlView extends HtmlView { } } -class TestHttpView extends HttpView { +class TestHttpView extends HttpView +{ protected function output(): void { if ($this->hasRendered) @@ -144,8 +152,11 @@ class TestHttpView extends HttpView { } } -class TestJsonView extends JsonView { - public function __destruct() {} +class TestJsonView extends JsonView +{ + public function __destruct() + { + } protected function output(): void { @@ -162,16 +173,18 @@ class TestJsonView extends JsonView { // AnimeClient Mocks // ----------------------------------------------------------------------------- -trait MockInjectionTrait { +trait MockInjectionTrait +{ public function __get($key) { - return $this->$key; + return $this->{$key}; } public function __set($key, $value) { - $this->$key = $value; + $this->{$key} = $value; + return $this; } } -// End of mocks.php \ No newline at end of file +// End of mocks.php diff --git a/tests/bootstrap.php b/tests/bootstrap.php index ce97f6d1..127e03c9 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -39,4 +39,4 @@ $_COOKIE = []; require_once TEST_DIR . 'AnimeClient/mocks.php'; require_once TEST_DIR . 'Ion/mocks.php'; -// End of bootstrap.php \ No newline at end of file +// End of bootstrap.php diff --git a/tools/composer.json b/tools/composer.json new file mode 100644 index 00000000..3e6d249f --- /dev/null +++ b/tools/composer.json @@ -0,0 +1,6 @@ +{ + "require": { + "friendsofphp/php-cs-fixer": "^3.6", + "rector/rector": "^0.12.16" + } +} diff --git a/build/header_comment.txt b/tools/header_comment.txt similarity index 51% rename from build/header_comment.txt rename to tools/header_comment.txt index f8b8c45c..b6560506 100644 --- a/build/header_comment.txt +++ b/tools/header_comment.txt @@ -5,11 +5,9 @@ * * PHP version 8 * - * @package HummingbirdAnimeClient - * @author Timothy J. Warren - * @copyright 2015 - 2021 Timothy J. Warren + * @copyright 2015 - 2022 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @version 5.2 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient */ diff --git a/tools/phinx/composer.json b/tools/phinx/composer.json new file mode 100644 index 00000000..e8d4e05d --- /dev/null +++ b/tools/phinx/composer.json @@ -0,0 +1,5 @@ +{ + "require": { + "robmorgan/phinx": "^0.12.4" + } +} \ No newline at end of file diff --git a/tools/rector.php b/tools/rector.php new file mode 100644 index 00000000..23483ee0 --- /dev/null +++ b/tools/rector.php @@ -0,0 +1,91 @@ +parameters(); + $parameters->set(Option::AUTO_IMPORT_NAMES, FALSE); + $parameters->set(Option::IMPORT_SHORT_CLASSES, FALSE); + $parameters->set(Option::SKIP, [ + ReadOnlyPropertyRector::class, + RestoreDefaultNullToNullableTypePropertyRector::class, + ]); + + walk_array([$config, 'import'], [ + LevelSetList::UP_TO_PHP_80, + ]); + + $services = $config->services(); + walk_array([$services, 'set'], [ + AddArrayDefaultToArrayPropertyRector::class, + AddArrayParamDocTypeRector::class, + AddArrayReturnDocTypeRector::class, + AddClosureReturnTypeRector::class, + AddMethodCallBasedStrictParamTypeRector::class, + CallUserFuncArrayToVariadicRector::class, + CallUserFuncToMethodCallRector::class, + ChangeIfElseValueAssignToEarlyReturnRector::class, + ChangeNestedForeachIfsToEarlyContinueRector::class, + CompleteDynamicPropertiesRector::class, + ConsecutiveNullCompareReturnsToNullCoalesceQueueRector::class, + CountArrayToEmptyArrayComparisonRector::class, + ForRepeatedCountToOwnVariableRector::class, + ForToForeachRector::class, + // MakeTypedPropertyNullableIfCheckedRector::class, + // NewlineAfterStatementRector::class, + NewlineBeforeNewAssignSetRector::class, + ParamTypeByMethodCallTypeRector::class, + ParamTypeByParentCallTypeRector::class, + RemoveAlwaysElseRector::class, + RemoveDuplicatedCaseInSwitchRector::class, + RemoveFinalFromConstRector::class, + RemoveUnusedForeachKeyRector::class, + RemoveUselessParamTagRector::class, + RemoveUselessReturnTagRector::class, + RemoveUselessVarTagRector::class, + // SimplifyDeMorganBinaryRector::class, + SimplifyDuplicatedTernaryRector::class, + SimplifyIfElseToTernaryRector::class, + SimplifyIfReturnBoolRector::class, + SimplifyTautologyTernaryRector::class, + SwitchNegatedTernaryRector::class, + TypedPropertyFromAssignsRector::class, + WrapEncapsedVariableInCurlyBracesRector::class, + ]); +}; diff --git a/tools/update_header_comments.php b/tools/update_header_comments.php new file mode 100644 index 00000000..4850413c --- /dev/null +++ b/tools/update_header_comments.php @@ -0,0 +1,89 @@ + + * @license http://www.opensource.org/licenses/mit-license.html MIT License + * @version 5.2 + * @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient + */ + +namespace Aviat\Ion\Etc; + +if ( ! function_exists('glob_recursive')) +{ + // Does not support flag GLOB_BRACE + + function glob_recursive(string $pattern, int $flags = 0): array + { + $files = glob($pattern, $flags); + + foreach (glob(dirname($pattern) . '/*', GLOB_ONLYDIR | GLOB_NOSORT) as $dir) + { + $files = array_merge($files, glob_recursive($dir . '/' . basename($pattern), $flags)); + } + + return $files; + } +} + +function get_text_to_replace(array $tokens): string +{ + $output = ''; + + // Tokens have the follow structure if arrays: + // [0] => token type constant + // [1] => raw syntax parsed to that token + // [2] => line number + foreach($tokens as $token) + { + // Since we only care about opening docblocks, + // bail out when we get to the namespace token + if (is_array($token) && $token[0] === T_NAMESPACE) + { + break; + } + + if (is_array($token)) + { + $token = $token[1]; + } + + $output .= $token; + } + + return $output; +} + +function replace_file(string $file, string $template): void +{ + $source = file_get_contents($file); + if ($source === FALSE || stripos($source, 'namespace') === FALSE) + { + return; + } + + $tokens = token_get_all($source); + $text_to_replace = get_text_to_replace($tokens); + + $header = file_get_contents(__DIR__ . $template); + $new_text = " ! (str_contains($file, '/vendor/') || str_contains($file, '/tmp/')) +); +array_walk($files, fn (string $file) => replace_file($file, '/header_comment.txt')); + +echo json_encode(array_values($files), JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR) . "\n"; +printf("Successfully updated header comments in %d files\n", count($files));