feat: Store documentation file on a configurable directory

[hans-thomas]

Hi, it adds the ability to store the generated documentation file in a configurable directory.

TODO list:

• Local and Storage drivers should have new config, named directory with the default value documentations
• the production_path config for Local and Storage drivers should be renamed to base_file_name with the default value documentation (without .json extension)
• documentation file extension should be automatically extended by the .json extension
• Local driver should check if directory exists and create it if not (on documentation saving)
• Storage driver should create storage directory only for non Cloud drivers (on documentation saving)
• Config version should be increased to force developers republish package config

[DenTray]

@hans-thomas I've updated task description, please add required changes accordingly the new task description (please feel free to open few PRs if you can divide task for small subtasks without breaking the package work)

[DenTray]

@hans-thomas please do not use autoclosing issues as we need to test task before closing

[hans-thomas]

Hi @DenTray, would you please review this PR?

[DenTray]

Suggested change

	$directory = str_ends_with($this->config['directory'], DIRECTORY_SEPARATOR)
	$directory = (str_ends_with($this->config['directory'], DIRECTORY_SEPARATOR))

[hans-thomas]

I made this change but I can't understand the difference.

[DenTray]

as you already did the same in the local driver, let's move this logic to the BaseDriver class

Suggested change

	$directory = str_ends_with($this->config['directory'], DIRECTORY_SEPARATOR)
	$directory = (str_ends_with($this->config['directory'], DIRECTORY_SEPARATOR))

[DenTray]

not sure this logic required for the Storage driver as it works correctly for all next cases:

• Storage::put('file.txt', 'content')
• Storage::put('/path/file.txt', 'content')
• Storage::put('path/file.txt', 'content')
• Storage::put('/file.txt', 'content')
• Storage::put('//file.txt', 'content')

[hans-thomas]

That logic was preventing this case:

Storage::put('documentations//documentation.json', 'content')

However, it's handling this case correctly, too.

[DenTray]

Suggested change

	$this->assertFileExists(self::$tmpDocumentationFilePath);
	$this->assertFileExists(storage_path('documentations/documentation.json'));

[hans-thomas]

These static properties are used several times in this class and I believe they are beneficial to keep tests simpler and improve the readability.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud