Merge pull request #6 from OnrampLab/5-fix-get-custom-fields-query-bug

5 fix get custom fields query bug

Author: moon-brillar

README.md

@@ -24,61 +24,24 @@ Custom fields can be utilized to extend a model and offer a more flexible approa
 
 ## Installation
 
-```bash
+Install the package via composer
+
+```
 composer require onramplab/laravel-custom-fields
 ```
+Publish migration files and run command to build tables needed in the package
 
-This will create a basic project structure for you:
-
-* **/build** is used to store code coverage output by default;
-* **/src** is where your codes will live in, each class will need to reside in its own file inside this folder;
-* **/tests** each class that you write in src folder needs to be tested before it was even "included" into somewhere else. So basically we have tests classes there to test other classes;
-* **.gitignore** there are certain files that we don't want to publish in Git, so we just add them to this fle for them to "get ignored by git";
-* **CHANGELOG.md** to keep track of package updates;
-* **CONTRIBUTION.md** Contributor Covenant Code of Conduct;
-* **LICENSE** terms of how much freedom other programmers is allowed to use this library;
-* **README.md** it is a mini documentation of the library, this is usually the "home page" of your repo if you published it on GitHub and Packagist;
-* **composer.json** is where the information about your library is stored, like package name, author and dependencies;
-* **phpunit.xml** It is a configuration file of PHPUnit, so that tests classes will be able to test the classes you've written;
-* **.travis.yml** basic configuration for Travis CI with configured test coverage reporting for code climate.
+```
+ php artisan vendor:publish --tag="custom-fields-migrations"
+```
 
-Please refer to original [article](http://www.darwinbiler.com/creating-composer-package-library/) for more information.
+## Usage
 
-## Useful Tools
 
 ## Running Tests:
 
-    php vendor/bin/phpunit
-
- or
-
     composer test
 
-## Code Sniffer Tool:
-
-    php vendor/bin/phpcs --standard=PSR2 src/
-
- or
-
-    composer psr2check
-
-## Code Auto-fixer:
-
-    composer psr2autofix
-    composer insights:fix
-    rector:fix
-
-## Building Docs:
-
-    php vendor/bin/phpdoc -d "src" -t "docs"
-
- or
-
-    composer docs
-
-## Changelog
-
-To keep track, please refer to [CHANGELOG.md](https://github.com/Onramplab/laravel-custom-fields/blob/master/CHANGELOG.md).
 
 ## Contributing
 

src/Concerns/Customizable.php

@@ -16,7 +16,7 @@
  */
 trait Customizable
 {
-    protected ?array $validatedCustomFieldValues = [];
+    protected array $validatedCustomFieldValues = [];
 
     public static function bootCustomizable(): void
     {
@@ -37,21 +37,20 @@ public function customFieldValues(): MorphMany
     public function validateCustomFields(): void
     {
         $customFields = $this->getCustomFields();
+        $tableColumns = $this->getTableColumns();
+        $modelAttributes = Collection::make($this->getAttributes());
+        $this->setRawAttributes($modelAttributes->only($tableColumns)->toArray());
         if ($customFields->isEmpty()) {
             return;
         }
-        $tableColumns = $this->getTableColumns();
-        $modelAttributes = Collection::make($this->getAttributes());
         $modelAttributeKeys = $modelAttributes->keys();
         $customFieldColumns = $modelAttributeKeys->diff($tableColumns);
         $customFieldsRules = $customFields->flatMap(function (CustomField $field) {
             return $field->getValidationRule();
         })->all();
-
         $customFieldValues = $modelAttributes->only($customFieldColumns)->toArray();
         $validator = Validator::make($customFieldValues, $customFieldsRules);
         $this->validatedCustomFieldValues = $validator->validate();
-        $this->setRawAttributes($modelAttributes->only($tableColumns)->toArray());
     }
 
     protected function getTableColumns(): Collection
@@ -61,21 +60,23 @@ protected function getTableColumns(): Collection
 
     public function getCustomFields(): Collection
     {
-        $context = $this->getContext();
+        $context = $this->getCustomFieldContext();
         $query = CustomField::query();
+        $query->where('model_class', get_class($this));
+
         if (is_null($context)) {
             $customFields = $query->get();
         } else {
             $customFields = $query
-                ->where('contextable_type', get_class($context))
+                ->where('contextable_type', $context->getMorphClass())
                 ->where('contextable_id', $context->id)
                 ->get();
         }
 
         return $customFields;
     }
 
-    public function getContext(): ?Model
+    public function getCustomFieldContext(): ?Model
     {
         return null;
     }
@@ -92,7 +93,7 @@ public function saveCustomFieldValues(): void
                 $value = $validatedCustomFieldValues[$customField->key];
                 $constraints = [
                     'custom_field_id' => $customField->id,
-                    'customizable_type' => get_class($this),
+                    'customizable_type' => $this->getMorphClass(),
                     'customizable_id' => $this->id
                 ];
                 $values = ['value' => $value];

src/Models/CustomField.php

@@ -20,6 +20,7 @@ class CustomField extends Model
     public const TYPE_FLOAT = 'float';
     public const TYPE_DATETIME = 'datetime';
     public const TYPE_SELECT = 'select';
+    public const TYPE_BOOLEAN = 'boolean';
 
     /**
      * The attributes that are mass assignable.
@@ -49,7 +50,8 @@ class CustomField extends Model
         CustomField::TYPE_INTEGER => IntegerCustomField::class,
         CustomField::TYPE_FLOAT => FloatCustomField::class,
         CustomField::TYPE_DATETIME => DateTimeCustomField::class,
-        CustomField::TYPE_SELECT => SelectCustomField::class
+        CustomField::TYPE_SELECT => SelectCustomField::class,
+        CustomField::TYPE_BOOLEAN => BooleanCustomField::class
     ];
 
     protected static function newFactory(): Factory

tests/Classes/User.php

@@ -25,7 +25,7 @@ public function account(): BelongsTo
         return $this->belongsTo(Account::class);
     }
 
-    public function getContext(): Model
+    public function getCustomFieldContext(): Model
     {
         return $this->account;
     }