Merge pull request #22 from josantonius/release/v2.0.6

Release/v2.0.6

Author: josantonius

.github/lang/es-ES/README.md

@@ -19,7 +19,7 @@ Biblioteca PHP para la gestión de archivos JSON.
 - [Instalación](#instalación)
 - [Clases disponibles](#clases-disponibles)
   - [Clase Json](#clase-json)
-- [Excepciones usadas](#excepciones-usadas)
+- [Excepciones utilizadas](#excepciones-utilizadas)
 - [Uso](#uso)
 - [Tests](#tests)
 - [Tareas pendientes](#tareas-pendientes)
@@ -61,60 +61,65 @@ git clone https://github.com/josantonius/php-json.git
 
 ### Clase Json
 
+`Josantonius\Json\Json`
+
+Comprueba si existe un archivo local o remoto.
+
 ```php
-use Josantonius\Json\Json;
+public function exists(): bool;
 ```
 
 Obtener el contenido del archivo JSON:
 
 ```php
 /**
- * @throws CreateDirectoryException if there is an error when creating a directory.
- * @throws CreateFileException      if there is an error when creating a file.
- * @throws JsonErrorException       if there is an error when parsing a JSON file.
+ * @throws GetFileException   if there is an error when getting a file.
+ * @throws JsonErrorException if there is an error when parsing a JSON file.
  */
-$json->get(): array
+public function get(): array;
+```
+
+Obtiene la ruta o URL del archivo JSON.
+
+```php
+public function getFilepath(): string;
 ```
 
 Establecer el contenido del archivo JSON:
 
 ```php
 /**
  * @throws CreateFileException        if there is an error when creating a file.
- * @throws JsonErrorException         if there is an error when parsing a JSON file.
  * @throws UnavailableMethodException if the method is not available.
  */
-$json->set(array|object $content): void
+public function set(array|object $content = []): void;
 ```
 
 Fusionar en el archivo JSON:
 
 ```php
 /**
- * @throws CreateFileException        if there is an error when creating a file.
  * @throws GetFileException           if there is an error when getting a file.
  * @throws JsonErrorException         if there is an error when parsing a JSON file.
  * @throws UnavailableMethodException if the method is not available.
  */
-$json->merge(array|object $content): array
+public function merge(array|object $content): array;
 ```
 
 Incluir en el archivo JSON:
 
 ```php
 /**
- * @throws CreateFileException        if there is an error when creating a file.
  * @throws GetFileException           if there is an error when getting a file.
  * @throws JsonErrorException         if there is an error when parsing a JSON file.
  * @throws UnavailableMethodException if the method is not available.
  */
-$json->push(array|object $content): array
+public function push(array|object $content): array;
 ```
 
 ## Excepciones utilizadas
 
 ```php
-use Josantonius\Json\Exceptions\CreateDirectoryException;
 use Josantonius\Json\Exceptions\CreateFileException;
 use Josantonius\Json\Exceptions\GetFileException;
 use Josantonius\Json\Exceptions\JsonErrorException;
@@ -125,6 +130,30 @@ use Josantonius\Json\Exceptions\UnavailableMethodException;
 
 Ejemplo de uso para esta biblioteca:
 
+### Comprueba si existe un archivo local
+
+**`index.php`**
+
+```php
+use Josantonius\Json\Json;
+
+$json = new Json('file.json');
+
+$json->exists(); // bool
+```
+
+### Comprueba si existe un archivo remoto
+
+**`index.php`**
+
+```php
+use Josantonius\Json\Json;
+
+$json = new Json('https://example.com/file.json');
+
+$json->exists(); // bool
+```
+
 ### Obtener el contenido del archivo
 
 **`file.json`**
@@ -145,6 +174,68 @@ $json = new Json('file.json');
 $json->get(); // ['foo' => 'bar']
 ```
 
+### Obtener el contenido del archivo desde una URL
+
+**`https://example.com/file.json`**
+
+```json
+{
+    "foo": "bar"
+}
+```
+
+**`index.php`**
+
+```php
+use Josantonius\Json\Json;
+
+$json = new Json('https://example.com/file.json');
+
+$json->get(); // ['foo' => 'bar']
+```
+
+### Obtiene la ruta del archivo JSON
+
+**`index.php`**
+
+```php
+use Josantonius\Json\Json;
+
+$json = new Json('file.json');
+
+$json->getFilepath(); // 'file.json'
+```
+
+### Obtiene la URL del archivo JSON remoto
+
+**`index.php`**
+
+```php
+use Josantonius\Json\Json;
+
+$json = new Json('https://example.com/file.json');
+
+$json->getFilepath(); // 'https://example.com/file.json'
+```
+
+### Establecer una matriz vacía en el contenido del archivo JSON
+
+**`index.php`**
+
+```php
+use Josantonius\Json\Json;
+
+$json = new Json('file.json');
+
+$json->set();
+```
+
+**`file.json`**
+
+```json
+[]
+```
+
 ### Establecer el contenido del archivo
 
 **`index.php`**

CHANGELOG.md

@@ -1,5 +1,35 @@
 # CHANGELOG
 
+## [v2.0.6](https://github.com/josantonius/php-json/releases/tag/v2.0.6) (2022-09-05)
+
+### Added
+
+* `Josantonius\Json\Json->getFilepath()` method.
+* `Josantonius\Json\Json->exists()` method.
+
+### Changed
+
+* The file is no longer created if it does not exist when the instance is created.
+* The `$content` parameter of the `set` method is now optional and contains an empty array by default.
+
+### Deleted
+
+* `Josantonius\Json\Exceptions\CreateDirectoryException` class.
+* `Josantonius\Json\Tests\ExistsMethodTest` class.
+* `Josantonius\Json\Tests\GetFilepathMethodTest` class.
+* `Josantonius\Json\Json->createFileIfNotExists()` method.
+
+### Refactor
+
+* The notation type in the test function names has been changed from camel to snake case for readability.
+* Functions were added to document the methods and avoid confusion.
+* Disabled the ´CamelCaseMethodName´ rule in ´phpmd.xml´ to avoid warnings about function names in tests.
+* The alignment of the asterisks in the comments has been fixed.
+
+### Updated
+
+* Tests.
+
 ## [v2.0.5](https://github.com/josantonius/php-json/releases/tag/v2.0.5) (2022-08-11)
 
 * The exceptions directory was renamed from `exception` to `exceptions`.