Merge pull request #14 from kiwilan/develop

v3.0.01

Author: ewilan-riviere

.github/workflows/run-tests.yml

@@ -24,11 +24,13 @@ jobs:
           php-version: ${{ matrix.php }}
           coverage: none
 
-      - name: apt
+      - name: Linux installation
         if: runner.os == 'Linux'
-        run: sudo apt-get install vorbis-tools flac
+        run: |
+          sudo apt update
+          sudo apt install vorbis-tools flac
 
-      - name: scoop
+      - name: Windows installation
         if: runner.os == 'Windows'
         run: |
           [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

README.md

@@ -15,20 +15,6 @@ PHP package to parse and update audio files metadata, with [`JamesHeinrich/getID
 >
 > You can check formats supported on [Supported formats](#supported-formats) section.
 
-## Table of contents
-
--   [About](#about)
--   [Requirements](#requirements)
--   [Installation](#installation)
--   [Usage](#usage)
--   [Supported formats](#supported-formats)
--   [Testing](#testing)
--   [Tools](#tools)
--   [FAQ](#faq)
--   [Changelog](#changelog)
--   [Credits](#credits)
--   [License](#license)
-
 ## About
 
 Audio files can use different formats, this package aims to provide a simple way to read them with [`JamesHeinrich/getID3`](https://github.com/JamesHeinrich/getID3). The `JamesHeinrich/getID3` package is excellent to read metadata from audio files, but output is just an array, current package aims to provide a simple way to read audio files with a beautiful API.
@@ -40,6 +26,10 @@ Audio files can use different formats, this package aims to provide a simple way
     -   `FLAC`: `flac` (with `apt`, `brew` or `scoop`)
     -   `OGG`: `vorbis-tools` (with `apt` or `brew`) / `extras/icecast` (with `scoop`)
 
+### Roadmap
+
+-   Add support for more formats with [external packages](https://askubuntu.com/questions/226773/how-to-read-mp3-tags-in-shell)
+
 ## Installation
 
 You can install the package via composer:
@@ -323,7 +313,7 @@ use Kiwilan\Audio\Audio;
 
 $audio = Audio::get('path/to/audio.mp3');
 
-$audio->getCover()->getContent(); // `?string` raw file
+$audio->getCover()->getContents(); // `?string` raw file
 $audio->getCover()->getMimeType(); // `?string` (image/jpeg, image/png, ...)
 $audio->getCover()->getWidth(); // `?int` in pixels
 $audio->getCover()->getHeight(); // `?int` in pixels

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "kiwilan/php-audio",
     "description": "PHP package to parse and update audio files metadata, with `JamesHeinrich/getID3`.",
-    "version": "3.0.0",
+    "version": "3.0.01",
     "keywords": [
         "audio",
         "php",

src/Audio.php

@@ -427,7 +427,7 @@ private function parse(): self
         $this->audio = AudioMetadata::make($this);
         $this->cover = AudioCover::make($reader->getComments());
 
-        if ($this->cover?->getContent()) {
+        if ($this->cover?->getContents()) {
             $this->hasCover = true;
         }
 

src/Models/AudioCover.php

@@ -4,7 +4,7 @@
 
 class AudioCover
 {
-    protected ?string $content = null;
+    protected ?string $contents = null;
 
     protected ?string $mimeType = null;
 
@@ -20,17 +20,25 @@ public static function make(?Id3Comments $comments): ?self
 
         $self = new self();
 
-        $self->content = $comments->picture()->data();
+        $self->contents = $comments->picture()->data();
         $self->mimeType = $comments->picture()->image_mime();
         $self->width = $comments->picture()->image_width();
         $self->height = $comments->picture()->image_height();
 
         return $self;
     }
 
+    /**
+     * @deprecated Use `getContents()` instead.
+     */
     public function getContent(): ?string
     {
-        return $this->content;
+        return $this->contents;
+    }
+
+    public function getContents(): ?string
+    {
+        return $this->contents;
     }
 
     public function getMimeType(): ?string

tests/AudioTest.php

@@ -71,6 +71,7 @@
     if ($audio->hasCover()) {
         expect($cover)->toBeInstanceOf(AudioCover::class);
         expect($cover->getContent())->toBeString();
+        expect($cover->getContents())->toBeString();
         expect($cover->getMimeType())->toBeString();
         if ($cover->getWidth()) {
             expect($cover->getWidth())->toBeInt();
@@ -80,7 +81,7 @@
         }
 
         $path = "tests/output/cover-{$ext}.jpg";
-        file_put_contents($path, $cover->getContent());
+        file_put_contents($path, $cover->getContents());
         expect(file_exists($path))->toBeTrue();
         expect($path)->toBeReadableFile();
     } else {

tests/Mp3Test.php

@@ -45,13 +45,13 @@
     $cover = $audio->getCover();
 
     expect($cover)->toBeInstanceOf(AudioCover::class);
-    expect($cover->getContent())->toBeString();
+    expect($cover->getContents())->toBeString();
     expect($cover->getMimeType())->toBe('image/jpeg');
     expect($cover->getWidth())->toBe(640);
     expect($cover->getHeight())->toBe(640);
 
     $path = 'tests/output/cover.jpg';
-    file_put_contents($path, $cover->getContent());
+    file_put_contents($path, $cover->getContents());
     expect(file_exists($path))->toBeTrue();
     expect($path)->toBeReadableFile();
 });

tests/WriterTest.php

@@ -106,7 +106,7 @@
     expect($audio->getTitle())->toBe($random);
 
     $content = file_get_contents(FOLDER);
-    expect($audio->getCover()->getContent())->toBe($content);
+    expect($audio->getCover()->getContents())->toBe($content);
 })->with([MP3_WRITER]);
 
 it('can update use tags with tag formats', function (string $path) {