Merge branch 'release/1.0.6' into main

Author: likeadeckofcards

.gitattributes

@@ -0,0 +1,6 @@
+/.gitignore     export-ignore
+/pint.json      export-ignore
+/tests          export-ignore
+/phpunit.xml.dist   export-ignore
+/.gitattributes export-ignore
+/.github

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Dependencies
+- FileMaker Version: #.#.#
+- PHP Version: #.#.#
+- Laravel Version: #.#.#
+- Eloquent FileMaker Version: #.#.#
+
+### Description of the issue:
+
+### Expected Behavior:
+
+### Steps to reproduce:

.github/workflows/code-style.yml

@@ -0,0 +1,18 @@
+name: "Code Style"
+on: [pull_request]
+
+jobs:
+  code_style:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: "Laravel Pint"
+        uses: aglipanci/laravel-pint-action@2.0.0
+        with:
+          verboseMode: true
+          testMode: true
+          configPath: "./pint.json"

README.md

@@ -41,21 +41,21 @@ composer require gearbox-solutions/eloquent-filemaker
 With the package installed you can now have access to all the features of this package. There are a few different areas to configure.
 
 ## Database configuration
-The first thing to do is to add a new data connection in your ```database.php``` config file. The connections you specify here will be used in your FMModel classes to configure which databases each model will connect to.
+The first thing to do is to add a new data connection in your `database.php` config file. The connections you specify here will be used in your FMModel classes to configure which databases each model will connect to.
 
 You may use the following code block below as a template.
-
-        'filemaker' => [
-            'driver' => 'filemaker',
-            'host' => env('DB_HOST', 'fms.mycompany.com'),
-            'database' => env('DB_DATABASE', 'MyFileName'),
-            'username' => env('DB_USERNAME', 'myusername'),
-            'password' => env('DB_PASSWORD', ''),
-            'prefix' => env('DB_PREFIX', ''),
-            'version' => env('DB_VERSION', 'vLatest'),
-            'protocol' => env('DB_PROTOCOL', 'https'),
-        ]
-
+```php
+'filemaker' => [
+    'driver' => 'filemaker',
+    'host' => env('DB_HOST', 'fms.mycompany.com'),
+    'database' => env('DB_DATABASE', 'MyFileName'),
+    'username' => env('DB_USERNAME', 'myusername'),
+    'password' => env('DB_PASSWORD', ''),
+    'prefix' => env('DB_PREFIX', ''),
+    'version' => env('DB_VERSION', 'vLatest'),
+    'protocol' => env('DB_PROTOCOL', 'https'),
+]
+```
 You should add one database connection configuration for each FileMaker database you will be connecting to. Each file can have completely different configurations, and can even be on different servers.
 
 Sessions will be maintained on a per-connection basis and tokens will automatically be cached using whatever cache configuration you have set up for your Laravel app.
@@ -100,17 +100,17 @@ This package supports both reading and writing container field data. Container f
 #### Writing to container fields
 When setting a container field you should set the value to be an `Illuminate/HTTP/File` or `Illuminate/HTTP/UploadedFile` object. These attributes will be written back to your container fields along with any other model updates when the `save()` method is called on your model object.
 ```php
-  $file = new File(storage_path('app/public/gator.jpg'));
-  $newPet->photo = $file;
-  $newPet->save();
+$file = new File(storage_path('app/public/gator.jpg'));
+$newPet->photo = $file;
+$newPet->save();
 ```
 
 #### Custom filenames when inserting files into containers
 By default, files are inserted into containers using the filename of the file you are inserting. If you wish to set a new filename when the file is inserted into the container you can do so by passing the file and filename together in an array when setting your container.
 ```php
-  $file = new File(storage_path('app/public/gator.jpg'));
-  $newPet->photo = [$file, 'fluffy.jpg'];
-  $newPet->save();
+$file = new File(storage_path('app/public/gator.jpg'));
+$newPet->photo = [$file, 'fluffy.jpg'];
+$newPet->save();
 ```
 
 ### Renaming and Mapping FileMaker Fields
@@ -125,7 +125,7 @@ protected $fieldMapping = [
 and then you can get/set the attributes via....
 
 ```php
- $myModel->a_much_better_name = 'my new value';
+$myModel->a_much_better_name = 'my new value';
 ```
 
 ### Fields from related records
@@ -169,23 +169,25 @@ $person->person_pet_portal[1]['person_PET::type'] = 'cat';
 This package has special handling for casting FileMaker Timestamp and Date fields to Carbon instances for you. To take advantage of this, you must map the fields as you would with a native Laravel Model class. You can use the `$casts` property as you normally would for these attributes.
 
 ```php
-    protected $casts = [
-        'nextAppointment' => 'datetime',
-        'birthday' => 'date',
-    ];
+protected $casts = [
+    'nextAppointment' => 'datetime',
+    'birthday' => 'date',
+];
 ```
 
 The format Date and Timestamp fields written to FileMaker can be changed via the `$dateFormat` property of your model. This value must be compatible with the format output from the FileMaker Data API for Timestamp values and will be the format written back into your database. One important requirement is that this must be a full timestamp format, not just a date format.
 
 Here are some example formats:
 ```php
-    protected $dateFormat = 'n/j/Y g:i:s A'; // 7/1/1920 4:01:01 PM
-    protected $dateFormat = 'n/j/Y G:i:s'; // 7/1/1920 16:01:01
+protected $dateFormat = 'n/j/Y g:i:s A'; // 7/1/1920 4:01:01 PM
+protected $dateFormat = 'n/j/Y G:i:s'; // 7/1/1920 16:01:01
 ```
 
 
 ## Example FMModel Class
 ```php
+// Person.php
+
 class Person extends FMModel
 {
 
@@ -206,7 +208,6 @@ class Person extends FMModel
     }
 
 }
-
 ```
 
 # The Base Query Builder and the FM Facade
@@ -301,9 +302,9 @@ $result = FM::layout('MyLayoutName')->performScript('MyScriptName');
 Run a script with JSON data as a parameter
 ```php
 $json = json_encode ([
-      'name' => 'Joe Smith',
-      'birthday' => '1/1/1970'
-      'favorite_color' => 'blue'
+    'name' => 'Joe Smith',
+    'birthday' => '1/1/1970'
+    'favorite_color' => 'blue'
 ]);
 
 $result = FM::layout('globals')->performScript('New Contact Request'; $json);
@@ -317,7 +318,6 @@ $result = FM::connection('MyOtherDatabaseConnectionName')->layout('MyLayoutName'
 Create a record with an array of field data and then perform a script after record creation, within the same request
 ```php
 FM::layout('MyLayoutName')->script('ScriptName')->fieldData($data)->createRecord();
-
 ```
 
 ## Logging out, disconnecting, and ending your Data API session
@@ -347,6 +347,8 @@ Once they're set correctly, you can create relationships, such as a belongsTo, b
 Here is an example of setting a native Laravel User Model to belong to a FileMaker-based Company FMModel class.
 
 ```php
+// User.php
+
 class User extends Model
 {
     public function company()

composer.json

@@ -32,7 +32,8 @@
     },
     "require-dev": {
         "orchestra/testbench": "^7.0",
-        "mockery/mockery": "^1.5.1"
+        "mockery/mockery": "^1.5.1",
+        "laravel/pint": "^1.1"
     },
     "extra": {
         "laravel": {

pint.json

@@ -0,0 +1,8 @@
+{
+  "presets": "laravel",
+  "rules": {
+    "concat_space": {
+      "spacing": "one"
+    }
+  }
+}

src/Database/Eloquent/Concerns/FMGuardsAttributes.php

@@ -6,11 +6,10 @@
 
 trait FMGuardsAttributes
 {
-
     /**
      * Determine if the given key is guarded.
      *
-     * @param string $key
+     * @param  string  $key
      * @return bool
      */
     public function isGuarded($key)
@@ -20,21 +19,21 @@ public function isGuarded($key)
         }
 
         return $this->getGuarded() == ['*'] ||
-            !empty(preg_grep('/^' . preg_quote($key) . '$/i', $this->getGuarded())) ||
-            !$this->isGuardableColumn($key);
+            ! empty(preg_grep('/^' . preg_quote($key) . '$/i', $this->getGuarded())) ||
+            ! $this->isGuardableColumn($key);
     }
 
     /**
      * Determine if the given column is a valid, guardable column.
      *
-     * @param string $key
+     * @param  string  $key
      * @return bool
      */
     protected function isGuardableColumn($key)
     {
         $this->primeGuardableColumns();
 
-        if(in_array($key, static::$guardableColumns[get_class($this)])) {
+        if (in_array($key, static::$guardableColumns[get_class($this)])) {
             return true;
         }
 
@@ -45,7 +44,7 @@ protected function isGuardableColumn($key)
 
     protected function primeGuardableColumns($forceRefresh = false)
     {
-        if (!isset(static::$guardableColumns[get_class($this)])) {
+        if (! isset(static::$guardableColumns[get_class($this)])) {
             $columns = $this->getColumns($forceRefresh);
 
             if (empty($columns)) {
@@ -55,23 +54,21 @@ protected function primeGuardableColumns($forceRefresh = false)
         }
     }
 
-
     protected function getColumns($forceRefresh = false): array
     {
         $cacheKey = "eloquent-filemaker-{$this->table}-columns";
-        $refreshCallback = function() {
+        $refreshCallback = function () {
             $layoutMetaData = $this->getConnection()->getLayoutMetadata($this->table);
 
             return array_column($layoutMetaData['fieldMetaData'], 'name');
         };
 
-        if($forceRefresh) {
+        if ($forceRefresh) {
             Cache::forever($cacheKey, $columns = $refreshCallback());
 
             return $columns;
         }
 
         return Cache::rememberForever($cacheKey, $refreshCallback);
     }
-
 }

src/Database/Eloquent/Concerns/FMHasAttributes.php

@@ -3,17 +3,15 @@
 namespace GearboxSolutions\EloquentFileMaker\Database\Eloquent\Concerns;
 
 use DateTime;
-use Illuminate\Database\Eloquent\Concerns\HasAttributes;
 use Illuminate\Support\Arr;
 
 trait FMHasAttributes
 {
-
     /**
      * Set a given attribute on the model.
      *
-     * @param string $key
-     * @param mixed $value
+     * @param  string  $key
+     * @param  mixed  $value
      * @return mixed
      */
     public function setAttribute($key, $value)
@@ -36,7 +34,7 @@ public function setAttribute($key, $value)
         // When writing dates the regular datetime format won't work, so we have to get JUST the date value
         // check the key's cast to see if it is cast to a date or custom date:format
         $castType = $this->getCasts()[$key] ?? '';
-        $isDate = $castType == "date" || str_starts_with($castType, 'date:');
+        $isDate = $castType == 'date' || str_starts_with($castType, 'date:');
         if ($isDate) {
             $value = Arr::first(explode(' ', $value));
         }
@@ -55,5 +53,4 @@ public function setAttribute($key, $value)
 
         return $this;
     }
-
 }

src/Database/Eloquent/Concerns/FMHasRelationships.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace GearboxSolutions\EloquentFileMaker\Database\Eloquent\Concerns;
 
 use GearboxSolutions\EloquentFileMaker\Database\Eloquent\Relations\BelongsTo;
@@ -11,13 +10,12 @@
 
 trait FMHasRelationships
 {
-
     /**
      * Define a one-to-one relationship.
      *
-     * @param string $related
-     * @param string|null $foreignKey
-     * @param string|null $localKey
+     * @param  string  $related
+     * @param  string|null  $foreignKey
+     * @param  string|null  $localKey
      */
     public function hasOne($related, $foreignKey = null, $localKey = null)
     {
@@ -30,13 +28,12 @@ public function hasOne($related, $foreignKey = null, $localKey = null)
         return $this->newHasOne($instance->newQuery(), $this, $foreignKey, $localKey);
     }
 
-
     /**
      * Define a one-to-many relationship.
      *
-     * @param string $related
-     * @param string|null $foreignKey
-     * @param string|null $localKey
+     * @param  string  $related
+     * @param  string|null  $foreignKey
+     * @param  string|null  $localKey
      * @return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function hasMany($related, $foreignKey = null, $localKey = null)
@@ -55,11 +52,9 @@ public function hasMany($related, $foreignKey = null, $localKey = null)
     /**
      * Instantiate a new BelongsTo relationship.
      *
-     * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param \Illuminate\Database\Eloquent\Model $child
-     * @param string $foreignKey
-     * @param string $ownerKey
-     * @param string $relation
+     * @param  string  $foreignKey
+     * @param  string  $ownerKey
+     * @param  string  $relation
      * @return BelongsTo
      */
     protected function newBelongsTo(Builder $query, Model $child, $foreignKey, $ownerKey, $relation)
@@ -71,10 +66,8 @@ protected function newBelongsTo(Builder $query, Model $child, $foreignKey, $owne
     /**
      * Instantiate a new HasMany relationship.
      *
-     * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param \Illuminate\Database\Eloquent\Model $parent
-     * @param string $foreignKey
-     * @param string $localKey
+     * @param  string  $foreignKey
+     * @param  string  $localKey
      * @return HasMany
      */
     protected function newHasMany(Builder $query, Model $parent, $foreignKey, $localKey)
@@ -112,17 +105,13 @@ public function morphMany($related, $name, $type = null, $id = null, $localKey =
     /**
      * Instantiate a new HasOne relationship.
      *
-     * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param \Illuminate\Database\Eloquent\Model $parent
-     * @param string $foreignKey
-     * @param string $localKey
+     * @param  string  $foreignKey
+     * @param  string  $localKey
      * @return HasOne
      */
     protected function newHasOne(Builder $query, Model $parent, $foreignKey, $localKey)
     {
         // custom version of this so we can return our own BelongsTo class with a custom constraint for FM
         return new HasOne($query, $parent, $foreignKey, $localKey);
     }
-
-
 }