WIP 2.0.0

forxer · Mar 17, 2023 · 0548943 · 0548943
1 parent db8d3dc
commit 0548943
Show file tree

Hide file tree

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

diff --git a/src/Gravatar.php b/src/Gravatar.php
@@ -30,11 +30,11 @@ public function __construct(array $config)
     /**
      * Return the Gravatar image based on the provided email address.
      *
-     * @param string $sEmail The email to get the gravatar for.
+     * @param string|null $sEmail The email to get the gravatar for.
      * @param string $presetName The preset name to apply.
      * @return Image
      */
-    public function image($email, $presetName = null): Image
+    public function image(?string $email = null, ?string $presetName = null): Image
     {
         $image = new Image($email);
 
@@ -72,12 +72,16 @@ public function profile(?string $email = null, ?string $format = null): Profile
      * Apply preset to Gravatar image.
      *
      * @param Image $image
-     * @param null|array $presetName
+     * @param null|string $presetName
      * @return Image
      * @throws InvalidArgumentException
      */
-    private function applyPreset(Image $image, ?array $presetName = null): Image
+    private function applyPreset(Image $image, ?string $presetName = null): Image
     {
+        if ($presetName === null) {
+            return $image;
+        }
+
         foreach ($this->getPresetValues($presetName) as $k => $v) {
             $setter = 'set'.ucfirst(Str::camel($k));
 
@@ -109,9 +113,8 @@ private function getPresetValues(?string $presetName = null): array
         }
 
         if (empty($this->config['presets']) || ! is_array($this->config['presets'])) {
-            throw new InvalidArgumentException("Unable to retrieve Gravatar presets array configuration.");
-        }
-        elseif (! isset($this->config['presets'][$presetName])) {
+            throw new InvalidArgumentException('Unable to retrieve Gravatar presets array configuration.');
+        } elseif (! isset($this->config['presets'][$presetName])) {
             throw new InvalidArgumentException("Unable to retrieve Gravatar preset values, \"{$presetName}\" is probably a wrong preset name.");
         }
 

diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -19,7 +19,7 @@ public function boot()
     {
         if ($this->app->runningInConsole()) {
             $this->publishes([
-                __DIR__ . '/../config/gravatar.php' => $this->app->configPath('gravatar.php'),
+                __DIR__.'/../config/gravatar.php' => $this->app->configPath('gravatar.php'),
             ], 'gravatar-config');
         }
     }

diff --git a/src/helpers.php b/src/helpers.php
@@ -3,7 +3,7 @@
 use Gravatar\Image;
 use LaravelGravatar\Gravatar;
 
-if (!function_exists('gravatar')) {
+if (! function_exists('gravatar')) {
     /**
      * Return a gravatar instance.
      *