Merge branch 'release2.20.0'

Author: RicLeP

.github/workflows/tests.yml

@@ -2,9 +2,9 @@ name: Tests
 
 on:
   push:
-    branches: [ dev ]
+    branches: [ develop ]
   pull_request:
-    branches: [ dev ]
+    branches: [ develop ]
 
 jobs:
   tests:
@@ -14,26 +14,11 @@ jobs:
 
     strategy:
       fail-fast: false
-      matrix:
-        php-version:
-          - "8.0"
-          - "8.1"
-          - "8.2"
 
     steps:
-      - uses: actions/checkout@dev
-
-      - name: Setup PHP
-        uses: shivammathur/setup-php@master
+      - uses: actions/checkout@v3
+      - uses: php-actions/composer@v6
+      - uses: php-actions/phpunit@v3
         with:
-          php-version: ${{ matrix.php-version }}
-          coverage: xdebug
-
-      - name: Validate composer.json and composer.lock
-        run: composer validate
-
-      - name: Install dependencies
-        run: composer install --prefer-dist --no-progress --no-suggest
-
-      - name: Run test suite
-        run: ./vendor/bin/pest --ci
+          configuration: phpunit.xml.dist
+          args: --coverage-text

.idea/laravel-storyblok.iml

@@ -1,9 +1,14 @@
 # Use Storyblok’s amazing headless CMS in way that feels familiar to Laravel developers
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/riclep/laravel-storyblok.svg?style=flat-square)](https://packagist.org/packages/riclep/laravel-storyblok)
+[![Total Downloads](https://img.shields.io/packagist/dt/riclep/laravel-storyblok.svg?style=flat-square)](https://packagist.org/packages/riclep/laravel-storyblok)
+
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/riclep/laravel-storyblok/Tests)
+![Packagist PHP Version](https://img.shields.io/packagist/dependency-v/riclep/laravel-storyblok/php)
+
 [![Build](https://img.shields.io/scrutinizer/build/g/riclep/laravel-storyblok?style=flat-square)](https://scrutinizer-ci.com/g/riclep/laravel-storyblok)
 [![Quality Score](https://img.shields.io/scrutinizer/g/riclep/laravel-storyblok.svg?style=flat-square)](https://scrutinizer-ci.com/g/riclep/laravel-storyblok)
-[![Total Downloads](https://img.shields.io/packagist/dt/riclep/laravel-storyblok.svg?style=flat-square)](https://packagist.org/packages/riclep/laravel-storyblok)
+
 [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/M4M2C42W6)
 [![Twitter](https://img.shields.io/twitter/follow/riclep.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=riclep)
 
@@ -44,7 +49,7 @@ Improve your content’s typography. [Package](https://github.com/RicLeP/laravel
 
 Helpers for layout, block positioning and CSS class name generation. [Package](https://github.com/RicLeP/laravel-storyblok-css) [Docs](https://ls.sirric.co.uk/docs/2.19/css-classes)
 
-### Laravel Storyblok Form builder
+### Laravel Storyblok Form builder (BETA)
 
 Build forms with Storyblok complete with Laravel’s validation. [Package](https://github.com/RicLeP/laravel-storyblok-forms) [Docs](https://ls.sirric.co.uk/docs/2.19/laravel-storyblok-forms)
 
@@ -70,9 +75,10 @@ If you discover any security related issues, please email [email protected] inste
 
 ## Credits
 
-- Richard Le Poidevin [GitHub](https://github.com/riclep) / [Twitter](https://twitter.com/riclep)
-- [Storyblok](https://www.storyblok.com/)
-- [Laravel](https://laravel.com/)
+- Richard Le Poidevin [GitHub](https://github.com/riclep) / [Twitter](https://twitter.com/riclep) ![img](https://ls.sirric.co.uk/img/storyblok-ambassador-asset-vert-color.svg)
+- [The contributors](https://github.com/RicLeP/laravel-storyblok/graphs/contributors) 😍
+- [Storyblok](https://www.storyblok.com/) 😻
+- [Laravel](https://laravel.com/) 🥰
 
 ## License
 

.idea/php.xml

@@ -218,4 +218,14 @@
     |
     */
     'settings_field' => 'settings',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Default date format
+    |--------------------------------------------------------------------------
+    |
+    | Use any valid PHP date format, applied when casting DateTimes to string
+    |
+    */
+    'date_format' => 'H:i:s j F Y',
 ];

.travis.yml

@@ -0,0 +1,43 @@
+<?php
+
+namespace Riclep\Storyblok\Console;
+
+use Illuminate\Console\GeneratorCommand;
+use Illuminate\Support\Str;
+
+class PageMakeCommand extends GeneratorCommand
+{
+	protected $name  = 'ls:page';
+
+	protected $description = 'Create a new page class';
+
+	protected $type = 'Page';
+
+	protected function getStub(): string
+	{
+		return file_exists(resource_path('stubs/storyblok/page.stub')) ? resource_path('stubs/storyblok/page.stub') : __DIR__ . '/stubs/page.stub';
+	}
+
+	protected function getDefaultNamespace($rootNamespace): string
+	{
+		return $rootNamespace . '\Storyblok\Page';
+	}
+
+	public function handle(): void
+	{
+		parent::handle();
+
+		$this->doOtherOperations();
+	}
+
+	protected function doOtherOperations(): void
+	{
+		$class = $this->qualifyClass($this->getNameInput());
+		$path = $this->getPath($class);
+		$content = file_get_contents($path);
+
+		$content = str_replace('DummySlug', Str::kebab($this->getNameInput()), $content);
+
+		file_put_contents($path, $content);
+	}
+}

README.md

@@ -0,0 +1,12 @@
+<?php
+
+namespace DummyNamespace;
+
+use Riclep\Storyblok\Page as BasePage;
+
+/**
+ */
+class DummyClass extends BasePage
+{
+    //
+}

config/storyblok.php

@@ -11,7 +11,15 @@ class DateTime extends Field
 {
 	public function __toString(): string
 	{
-		return $this->content->toDatetimeString();
+		if (!$this->content) {
+			return '';
+		}
+
+		if (property_exists($this, 'format')) {
+			return $this->content->format($this->format);
+		}
+
+		return config('storyblok.date_format') ? $this->content->format(config('storyblok.date_format')) : $this->content->toDatetimeString();
 	}
 
 	/**

src/Console/PageMakeCommand.php

@@ -34,6 +34,7 @@ public function boot(): void
 			BlockMakeCommand::class,
 			BlockSyncCommand::class,
 			FolderMakeCommand::class,
+			PageMakeCommand::class,
 			StubViewsCommand::class
 		]);
     }

src/Console/stubs/page.stub

@@ -443,4 +443,17 @@ public function block_settings_can_process_comma_separated_list()
 
 		$this->assertEquals(['quarter', 'half', 'full'], $block->settings('lsf_style')['commas']);
 	}
+
+	/** @test */
+	public function will_return_mutli_self_fields()
+	{
+		$page = $this->makePage('multi-option-self.json');
+		$block = $page->block();
+
+		$this->assertEquals([
+			0 => '20',
+			1 => '10',
+			2 => '30',
+		], $block->body[0]->test_field);
+	}
 }

src/Fields/DateTime.php

@@ -18,6 +18,7 @@
 use Riclep\Storyblok\Support\ImageTransformers\Storyblok;
 use Riclep\Storyblok\Tests\Fixtures\Blocks\NullBlock;
 use Riclep\Storyblok\Tests\Fixtures\Fields\AssetWithAccessor;
+use Riclep\Storyblok\Tests\Fixtures\Fields\CustomDate;
 use Riclep\Storyblok\Tests\Fixtures\Fields\HeroImage;
 use Riclep\Storyblok\Tests\Fixtures\Fields\Imgix;
 use Riclep\Storyblok\Tests\Fixtures\Fields\WithImage;
@@ -97,10 +98,28 @@ public function can_convert_date_to_carbon()
 	}
 
 	/** @test */
-	public function can_convert_date_to_string()
+	public function can_set_default_date_format()
 	{
 		$field = new DateTime($this->getFieldContents('datetime'), null);
-		$this->assertEquals('2020-07-01 20:57:00', (string) $field);
+
+		$this->assertEquals('20:57:00 1 July 2020', (string) $field);
+	}
+
+	/** @test */
+	public function can_set_date_format_with_property()
+	{
+		$field = new CustomDate($this->getFieldContents('datetime'), null);
+
+		$this->assertEquals('01/07/2020', (string) $field);
+	}
+
+	/** @test */
+	public function empty_dates_return_null()
+	{
+		$field = new DateTime('', null);
+
+		$this->assertNull($field->content());
+		$this->assertEquals('', (string) $field);
 	}
 
 	/** @test */

src/StoryblokServiceProvider.php

@@ -0,0 +1,12 @@
+<?php
+
+
+namespace Riclep\Storyblok\Tests\Fixtures\Fields;
+
+
+use Riclep\Storyblok\Fields\DateTime;
+
+class CustomDate extends DateTime
+{
+	protected string $format = 'd/m/Y';
+}

tests/BlockTest.php

@@ -0,0 +1,19 @@
+<?php
+
+
+namespace Riclep\Storyblok\Tests\Fixtures\Folders;
+
+
+use Illuminate\Support\Collection;
+
+class SortedFolder extends \Riclep\Storyblok\Folder
+{
+	public function __construct()
+	{
+		// these are lost when $folder->settings() is called
+		$this->settings([
+			'sort_by' => 'content.date:desc',
+			'per_page' => 17
+		]);
+	}
+}

tests/FieldTest.php

@@ -0,0 +1,28 @@
+{
+	"story": {
+		"name": "test",
+		"created_at": "2022-07-15T10:32:54.701Z",
+		"published_at": "2022-06-16T12:51:40.423Z",
+		"id": 163795103,
+		"uuid": "847ef2f7-c110-40bf-b2e2-e6ea8f684ca7",
+		"content": {
+			"_uid": "1515771c-3ec4-4922-8921-9607eda522e6",
+			"body": [
+				{
+					"_uid": "29914472-2a98-428d-868c-56c30207d608",
+					"component": "test-component",
+					"test_field": [
+						"20",
+						"10",
+						"30"
+					]
+				}
+			],
+			"component": "relation"
+		},
+		"tag_list": [],
+		"slug": "test",
+		"full_slug": "test/test",
+		"first_published_at": "2022-06-16T12:51:40.423Z"
+	}
+}

tests/Fixtures/Fields/CustomDate.php

@@ -7,6 +7,7 @@
 use Riclep\Storyblok\Page;
 use Riclep\Storyblok\Tests\Fixtures\Folders\Folder;
 use Riclep\Storyblok\Tests\Fixtures\Folders\EmptyFolder;
+use Riclep\Storyblok\Tests\Fixtures\Folders\SortedFolder;
 
 class FolderTest extends TestCase
 {
@@ -102,5 +103,37 @@ public function can_set_settings() {
 			'per_page' => 7,
 		], $settings);
 	}
+
+	/** @test */
+	public function can_add_settings_in_folder_constructor() {
+		$folder = new SortedFolder();
+		$settings = $this::callMethod($folder, 'getSettings');
+
+		$this->assertEquals([
+			'is_startpage' => false,
+			'sort_by' => 'content.date:desc',
+			'starts_with' => '',
+			'page' => 0,
+			'per_page' => 17,
+		], $settings);
+
+
+		$folder2 = new SortedFolder();
+
+		// calling settings overrides the settings in the constructor if the constructor uses
+		// a settings array
+		$folder2->settings([
+			'per_page' => 8,
+		]);
+		$settings2 = $this::callMethod($folder2, 'getSettings');
+
+		$this->assertEquals([
+			'is_startpage' => false,
+			'sort_by' => 'published_at:desc',
+			'starts_with' => '',
+			'page' => 0,
+			'per_page' => 8,
+		], $settings2);
+	}
 }