One pull request to (hopefully) clear the board on the problems Matt …

…and his team found (#36)

Close #33 
Close #32 
Close #31 
Close #28 
Ready for Laravel 8 once dependencies I don't control are updated.

.php_cs

@@ -0,0 +1,133 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__.DIRECTORY_SEPARATOR.'tests')
+    ->in(__DIR__.DIRECTORY_SEPARATOR.'src')
+    ->append(['.php_cs']);
+
+$rules = [
+    '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' => ['method'],
+    ],
+    'class_definition' => true,
+    'concat_space' => [
+        'spacing' => 'none',
+    ],
+    '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,
+    '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_constants' => 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' => true,
+    'native_function_casing' => true,
+    'no_alias_functions' => true,
+    'no_extra_blank_lines' => [
+        'tokens' => [
+            'extra',
+            'throw',
+            'use',
+            'use_trait',
+        ],
+    ],
+    '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,
+    'multiline_whitespace_before_semicolons' => [
+        'strategy' => 'no_multi_line',
+    ],
+    'no_short_bool_cast' => true,
+    'no_singleline_whitespace_before_semicolons' => true,
+    'no_spaces_after_function_name' => true,
+    'no_spaces_around_offset' => true,
+    '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' => true,
+    'no_unreachable_default_argument_value' => true,
+    'no_useless_return' => true,
+    'no_whitespace_before_comma_in_array' => true,
+    'no_whitespace_in_blank_line' => true,
+    'normalize_index_brace' => true,
+    'not_operator_with_successor_space' => true,
+    'object_operator_without_whitespace' => true,
+    'ordered_imports' => ['sortAlgorithm' => 'alpha'],
+    'phpdoc_indent' => true,
+    'phpdoc_inline_tag' => 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' => true,
+    'phpdoc_to_comment' => true,
+    'phpdoc_trim' => true,
+    'phpdoc_types' => true,
+    'phpdoc_var_without_name' => true,
+    'psr4' => true,
+    'self_accessor' => true,
+    'short_scalar_cast' => true,
+    'simplified_null_return' => false, // disabled by Shift
+    'single_blank_line_at_eof' => true,
+    'single_blank_line_before_namespace' => true,
+    'single_class_element_per_statement' => true,
+    '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_array' => true,
+    'trim_array_spaces' => true,
+    'unary_operator_spaces' => true,
+    'visibility_required' => [
+        'elements' => ['method', 'property'],
+    ],
+    'whitespace_after_comma_in_array' => true,
+];
+
+return PhpCsFixer\Config::create()
+    ->setUsingCache(true)
+    ->setRules($rules)
+    ->setRiskyAllowed(true)
+    ->setFinder($finder);

.phpunit.result.cache

@@ -0,0 +1 @@
+C:37:"PHPUnit\Runner\DefaultTestResultCache":1332:{a:2:{s:7:"defects";a:9:{s:87:"Tests\MakeSheetModelCommandTest::it_creates_a_sheet_model_without_committing_any_crimes";i:3;s:49:"Tests\SheetModelTest::can_read_from_google_sheets";i:4;s:64:"Tests\SheetModelTest::does_not_hit_google_sheets_if_cache_exists";i:4;s:49:"Tests\SheetModelTest::can_do_basic_eloquent_stuff";i:4;s:43:"Tests\SheetModelTest::can_infer_id_from_row";i:3;s:45:"Tests\SheetModelTest::can_use_defined_headers";i:4;s:42:"Tests\SheetModelTest::can_invalidate_cache";i:3;s:53:"Tests\SheetModelTest::can_invalidate_cache_by_request";i:3;s:86:"Tests\SheetModelTest::will_bail_out_without_creating_cache_file_if_error_reading_sheet";i:4;}s:5:"times";a:9:{s:87:"Tests\MakeSheetModelCommandTest::it_creates_a_sheet_model_without_committing_any_crimes";d:1.032;s:49:"Tests\SheetModelTest::can_read_from_google_sheets";d:1.425;s:64:"Tests\SheetModelTest::does_not_hit_google_sheets_if_cache_exists";d:0.608;s:49:"Tests\SheetModelTest::can_do_basic_eloquent_stuff";d:0.665;s:43:"Tests\SheetModelTest::can_infer_id_from_row";d:0.794;s:45:"Tests\SheetModelTest::can_use_defined_headers";d:0.838;s:42:"Tests\SheetModelTest::can_invalidate_cache";d:0.635;s:53:"Tests\SheetModelTest::can_invalidate_cache_by_request";d:0.922;s:86:"Tests\SheetModelTest::will_bail_out_without_creating_cache_file_if_error_reading_sheet";d:0.269;}}}

.styleci.yml

@@ -0,0 +1,11 @@
+risky: true
+version: 7
+preset: laravel
+finder:
+  exclude:
+    - "config"
+    - "vendor"
+  name: "*.php"
+  not-name:
+    - "*.blade.php"
+    - "_ide_helper.php"

composer.json

@@ -13,13 +13,14 @@
     "prefer-stable": true,
     "require": {
         "php": "^7.3",
-        "illuminate/support": "^6.0|^7.0",
+        "illuminate/support": ">=6.0",
         "revolution/laravel-google-sheets": "^5.0",
         "calebporzio/sushi": "^2.0",
         "ext-json": "*"
     },
     "require-dev": {
-        "orchestra/testbench": "^4.6"
+        "orchestra/testbench": "^5.0",
+        "friendsofphp/php-cs-fixer": "^2.16"
     },
     "autoload": {
         "psr-4": {
@@ -36,5 +37,13 @@
         "laravel": {
             "providers": "Grosv\\EloquentSheets\\EloquentSheetsProvider"
         }
+    },
+    "scripts": {
+        "lint": "php-cs-fixer fix -v",
+        "test:unit": "phpunit",
+        "test": [
+            "@lint",
+            "@test:unit"
+        ]
     }
 }

phpunit.xml.dist

@@ -1,26 +1,17 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         verbose="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false">
-    <testsuites>
-        <testsuite name="Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
-    <php>
-        <env name="APP_ENV" value="testing"/>
-        <env name="APP_DEBUG" value="true"/>
-    </php>
-</phpunit>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <php>
+    <env name="APP_ENV" value="testing"/>
+    <env name="APP_DEBUG" value="true"/>
+  </php>
+</phpunit>

phpunit.xml.dist.bak

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="true">
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+    <php>
+        <env name="APP_ENV" value="testing"/>
+        <env name="APP_DEBUG" value="true"/>
+    </php>
+</phpunit>

src/Commands/MakeSheetModelCommand.php

@@ -44,7 +44,7 @@ public function handle()
         $this->modelPath .= '/'.$this->modelName.'.php';
         $this->calculateForgetUri();
 
-        if (!$this->confirm('Ready to write model '.$this->fullyQualfiedModelName.' at '.$this->modelPath.'?')) {
+        if (! $this->confirm('Ready to write model '.$this->fullyQualfiedModelName.' at '.$this->modelPath.'?')) {
             return;
         }
         File::put($this->modelPath, $this->makeSubstitutions());

src/ForgetSheet.php

@@ -3,13 +3,34 @@
 namespace Grosv\EloquentSheets;
 
 use Illuminate\Support\Facades\File;
+use Illuminate\Support\Str;
 
 class ForgetSheet
 {
     public function execute($id)
     {
-        File::delete(config('sushi.cache-path').'/'.$id.'.sqlite');
+        if (File::isFile(config('sushi.cache-path').'/'.$id.'.sqlite')) {
+            File::delete(config('sushi.cache-path').'/'.$id.'.sqlite');
+        }
+        if (File::isFile(storage_path('framework/cache/'.$id.'.sqlite'))) {
+            File::delete(storage_path('framework/cache/'.$id.'.sqlite'));
+        }
+
+        $this->triggerCallback($id);
 
         return response()->noContent();
     }
+
+    protected function triggerCallback($id)
+    {
+        $class = 'App\\'.Str::studly(str_replace('sushi-', '', $id));
+        if (! class_exists($class)) {
+            return;
+        }
+        $model = new $class();
+
+        if (method_exists($model, 'onForget')) {
+            $model->onForget();
+        }
+    }
 }

src/SheetModel.php

@@ -5,6 +5,7 @@
 use Google_Client;
 use Google_Service_Sheets;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\File;
 use Illuminate\Support\Str;
 use Revolution\Google\Sheets\Sheets;
 use Sushi\Sushi;
@@ -19,29 +20,33 @@ class SheetModel extends Model
     protected $headerRow;
     public $primaryKey = 'id';
     public $cacheName;
+    private $cacheDirectory;
     protected $headers;
 
     public function __construct()
     {
         parent::__construct();
-        $this->cacheDirectory = realpath(config('sushi.cache-path', storage_path('framework/cache')));
+        $this->cacheDirectory = File::isDirectory(config('sushi.cache-path', storage_path('framework/cache'))) ?
+            config('sushi.cache-path', storage_path('framework/cache')) :
+            File::makeDirectory(config('sushi.cache-path', storage_path('framework/cache')));
+
         $this->cacheName = $this->getCacheName();
     }
 
     public function getRows()
     {
-        return !empty($this->rows) ? $this->rows : $this->loadFromSheet();
+        return ! empty($this->rows) ? $this->rows : $this->loadFromSheet();
     }
 
     public function invalidateCache()
     {
-        if (!file_exists(config('sushi.cache-path').'/'.config('sushi.cache-prefix', 'sushi').'-'.Str::kebab(str_replace('\\', '', static::class)).'.sqlite')) {
+        if (! file_exists($this->cacheDirectory.'/'.config('sushi.cache-prefix', 'sushi').'-'.Str::kebab(str_replace('\\', '', static::class)).'.sqlite')) {
             return;
         }
-        unlink(config('sushi.cache-path').'/'.config('sushi.cache-prefix', 'sushi').'-'.Str::kebab(str_replace('\\', '', static::class)).'.sqlite');
+        unlink($this->cacheDirectory.'/'.config('sushi.cache-prefix', 'sushi').'-'.Str::kebab(str_replace('\\', '', static::class)).'.sqlite');
     }
 
-    public function loadFromSheet(): array
+    public function loadFromSheet(): ?array
     {
         $sheets = new Sheets();
         $client = new Google_Client(config('google'));
@@ -50,30 +55,35 @@ public function loadFromSheet(): array
         $sheets->setService($service);
         $inferId = 0;
 
-        $sheet = $sheets->spreadsheet($this->spreadsheetId)->sheetById($this->sheetId)->get();
+        try {
+            $sheet = $sheets->spreadsheet($this->spreadsheetId)->sheetById($this->sheetId)->get();
+        } catch (\Exception $e) {
+            $this->invalidateCache();
+            throw $e;
+        }
 
         $headers = is_array($this->headers) ? collect($this->headers) : collect($sheet->pull($this->headerRow - 1));
 
-        if (!$headers->contains($this->primaryKey)) {
+        if (! $headers->contains($this->primaryKey)) {
             $headers->push($this->primaryKey);
             $inferId = 1;
         }
 
         $rows = collect([]);
 
         $sheet->each(function ($row) use ($headers, $rows, &$inferId) {
-            if ($inferId) {
-                $row[] = $inferId++;
-            }
+            $record = [];
 
             // append empty cols inside the row to match the number of cols in header
             foreach ($headers as $index => $header) {
-                if (!isset($row[$index])) {
-                    $row[$index] = '';
-                }
+                $record[$header] = $row[$index] ?? '';
+            }
+
+            if ($inferId) {
+                $record[$this->primaryKey] = $inferId++;
             }
 
-            $rows->push($headers->combine($row));
+            $rows->push($headers->combine($record));
         });
 
         return $rows->toArray();
@@ -91,6 +101,6 @@ public function getSpreadsheetId()
 
     public function getCacheName()
     {
-        return !is_null($this->getConnection()) ? explode('.', basename($this->getConnection()->getDatabaseName()))[0] : null;
+        return ! is_null($this->getConnection()) ? explode('.', basename($this->getConnection()->getDatabaseName()))[0] : null;
     }
 }