Merge pull request #48 from gjinali/mappers

Implement Snake Case Mapping for ViewModel Properties and Methods

Author: freekmurze

src/ViewModel.php

@@ -20,6 +20,7 @@ abstract class ViewModel implements Arrayable, Responsable
     protected $view = '';
 
     protected $_data = [];
+    protected $snakeCase = false;
 
     public function toArray(): array
     {
@@ -58,15 +59,15 @@ protected function items(): Collection
                 return $this->shouldIgnore($property->getName());
             })
             ->mapWithKeys(function (ReflectionProperty $property) {
-                return [$property->getName() => $this->{$property->getName()}];
+                return [$this->resolveName($property->getName()) => $this->{$property->getName()}];
             });
 
         $publicMethods = collect($class->getMethods(ReflectionMethod::IS_PUBLIC))
             ->reject(function (ReflectionMethod $method) {
                 return $this->shouldIgnore($method->getName());
             })
             ->mapWithKeys(function (ReflectionMethod $method) {
-                return [$method->getName() => $this->createVariableFromMethod($method)];
+                return [$this->resolveName($method->getName()) => $this->createVariableFromMethod($method)];
             });
 
 
@@ -99,4 +100,13 @@ protected function createVariableFromMethod(ReflectionMethod $method)
 
         return Closure::fromCallable([$this, $method->getName()]);
     }
+
+    protected function resolveName(string $name): string
+    {
+        if (! $this->snakeCase) {
+            return $name;
+        }
+
+        return Str::snake($name);
+    }
 }

tests/SnakeCaseViewModel.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Spatie\ViewModels\Tests;
+
+use Spatie\ViewModels\ViewModel;
+use stdClass;
+
+class SnakeCaseViewModel extends ViewModel
+{
+    protected $snakeCase = true;
+
+    public $dummyProperty = 'abc';
+
+    protected $ignore = ['ignoredMethod'];
+
+    public function __construct()
+    {
+        // This one is here for testing purposes
+    }
+
+    public function publishedPost(): stdClass
+    {
+        return (object) [
+            'title' => 'title',
+            'body' => 'body',
+        ];
+    }
+
+    public function availableCategories(): array
+    {
+        return [
+            (object) [
+                'name' => 'category A',
+            ],
+            (object) [
+                'name' => 'category B',
+            ],
+        ];
+    }
+
+    public function ignoredMethod(): bool
+    {
+        return true;
+    }
+
+    public function callableMethod(string $name): string
+    {
+        return $name;
+    }
+}

tests/SnakeCaseViewModelTest.php

@@ -0,0 +1,42 @@
+<?php
+
+use Illuminate\Http\JsonResponse;
+use Spatie\ViewModels\Tests\SnakeCaseViewModel;
+
+beforeEach(function () {
+    $this->viewModel = new SnakeCaseViewModel();
+});
+
+test('public methods are listed and mapped as snake case', function () {
+    $array = $this->viewModel->toArray();
+
+    expect($array)->toHaveKeys(['published_post', 'available_categories']);
+});
+
+test('public properties are listed and mapped as snake case', function () {
+    $array = $this->viewModel->toArray();
+
+    expect($array)->toHaveKey('dummy_property');
+});
+
+test('values are kept as they are', function () {
+    $array = $this->viewModel->toArray();
+
+    expect($array['published_post']->title)->toEqual('title');
+});
+
+test('callables can be stored', function () {
+    $array = $this->viewModel->toArray();
+
+    expect($array['callable_method']('foo'))->toEqual('foo');
+});
+
+test('to response returns json by default', function () {
+    $response = $this->viewModel->toResponse(createRequest());
+
+    expect($response)->toBeInstanceOf(JsonResponse::class);
+
+    $array = getResponseBody($response);
+
+    expect($array)->toHaveKeys(['published_post', 'available_categories']);
+});