Fix Lyric inconsistency

landrok · landrok · commit 2341ef3a2ba9 · 2020-11-27T10:08:07.000+01:00
diff --git a/src/PhpTabs/Music/Lyric.php b/src/PhpTabs/Music/Lyric.php
@@ -17,13 +17,20 @@ class Lyric
 {
     const REGEX = " ";
 
+    /**
+     * @var int
+     */
     private $from;
+
+    /**
+     * @var string
+     */
     private $lyrics;
 
     public function __construct()
     {
         $this->from   = 1;
-        $this->lyrics = [];
+        $this->lyrics = '';
     }
 
     public function getFrom(): int
@@ -36,16 +43,12 @@ public function setFrom(int $from): void
         $this->from = $from;
     }
 
-    public function getLyrics(): array
+    public function getLyrics(): string
     {
         return $this->lyrics;
     }
 
-    /**
-     * @param array|string $lyrics
-     * @todo Fix given type either string or array
-     */
-    public function setLyrics($lyrics): void
+    public function setLyrics(string $lyrics): void
     {
         $this->lyrics = $lyrics;
     }
@@ -65,7 +68,7 @@ public function getLyricBeats(): array
 
     public function isEmpty(): bool
     {
-        return count($this->getLyrics()) == 0;
+        return strlen($this->getLyrics()) === 0;
     }
 
     public function copyFrom(Lyric $lyric): void
diff --git a/src/PhpTabs/Writer/GuitarPro/GuitarPro5Writer.php b/src/PhpTabs/Writer/GuitarPro/GuitarPro5Writer.php
@@ -230,14 +230,14 @@ private function writeLyrics(Song $song): void
             }
         }
 
-        $this->writeInt($lyricTrack == null ? 0 : $lyricTrack->getNumber());
-        $this->writeInt($lyricTrack == null ? 0 : $lyricTrack->getLyrics()->getFrom());
+        $this->writeInt(is_null($lyricTrack) ? 0 : $lyricTrack->getNumber());
+        $this->writeInt(is_null($lyricTrack) ? 0 : $lyricTrack->getLyrics()->getFrom());
         $this->writeStringInteger(
-            $lyricTrack == null ? '' : $lyricTrack->getLyrics()->getLyrics()
+            is_null($lyricTrack) ? '' : $lyricTrack->getLyrics()->getLyrics()
         );
 
         for ($i = 0; $i < 4; $i++) {
-            $this->writeInt($lyricTrack === null ? 0 : 1);
+            $this->writeInt(is_null($lyricTrack) ? 0 : 1);
             $this->writeStringInteger('');
         }
     }
diff --git a/test/PhpTabs/files/json/testSimpleMidi.mid.json b/test/PhpTabs/files/json/testSimpleMidi.mid.json
@@ -157,7 +157,7 @@
                     },
                     "lyrics": {
                         "from": 1,
-                        "lyrics": []
+                        "lyrics": ""
                     },
                     "measures": [
                         {
@@ -3304,7 +3304,7 @@
                     },
                     "lyrics": {
                         "from": 1,
-                        "lyrics": []
+                        "lyrics": ""
                     },
                     "measures": [
                         {
diff --git a/test/PhpTabs/files/json/testSimpleTab.gp3.json b/test/PhpTabs/files/json/testSimpleTab.gp3.json
@@ -183,7 +183,7 @@
                     },
                     "lyrics": {
                         "from": 1,
-                        "lyrics": []
+                        "lyrics": ""
                     },
                     "measures": [
                         {
@@ -3262,7 +3262,7 @@
                     },
                     "lyrics": {
                         "from": 1,
-                        "lyrics": []
+                        "lyrics": ""
                     },
                     "measures": [
                         {
diff --git a/test/PhpTabs/files/json/testSimpleTab.gp4.json b/test/PhpTabs/files/json/testSimpleTab.gp4.json
@@ -183,7 +183,7 @@
                     },
                     "lyrics": {
                         "from": 1,
-                        "lyrics": []
+                        "lyrics": ""
                     },
                     "measures": [
                         {
@@ -3262,7 +3262,7 @@
                     },
                     "lyrics": {
                         "from": 1,
-                        "lyrics": []
+                        "lyrics": ""
                     },
                     "measures": [
                         {
diff --git a/test/PhpTabs/files/json/testSimpleTab.gp5.json b/test/PhpTabs/files/json/testSimpleTab.gp5.json
@@ -183,7 +183,7 @@
                     },
                     "lyrics": {
                         "from": 1,
-                        "lyrics": []
+                        "lyrics": ""
                     },
                     "measures": [
                         {
@@ -3262,7 +3262,7 @@
                     },
                     "lyrics": {
                         "from": 1,
-                        "lyrics": []
+                        "lyrics": ""
                     },
                     "measures": [
                         {
diff --git a/test/PhpTabs/files/json/testSimpleTab.mid.json b/test/PhpTabs/files/json/testSimpleTab.mid.json
@@ -157,7 +157,7 @@
                     },
                     "lyrics": {
                         "from": 1,
-                        "lyrics": []
+                        "lyrics": ""
                     },
                     "measures": [
                         {
@@ -3196,7 +3196,7 @@
                     },
                     "lyrics": {
                         "from": 1,
-                        "lyrics": []
+                        "lyrics": ""
                     },
                     "measures": [
                         {
diff --git a/test/PhpTabs/files/serialized/testSimpleMidi.mid.ser b/test/PhpTabs/files/serialized/testSimpleMidi.mid.ser
diff --git a/test/PhpTabs/files/serialized/testSimpleTab.gp3.ser b/test/PhpTabs/files/serialized/testSimpleTab.gp3.ser
diff --git a/test/PhpTabs/files/serialized/testSimpleTab.gp4.ser b/test/PhpTabs/files/serialized/testSimpleTab.gp4.ser
diff --git a/test/PhpTabs/files/serialized/testSimpleTab.gp5.ser b/test/PhpTabs/files/serialized/testSimpleTab.gp5.ser
diff --git a/test/PhpTabs/files/serialized/testSimpleTab.mid.ser b/test/PhpTabs/files/serialized/testSimpleTab.mid.ser
diff --git a/test/PhpTabs/files/xml/testSimpleMidi.mid.xml b/test/PhpTabs/files/xml/testSimpleMidi.mid.xml
@@ -144,7 +144,7 @@
    </color>
    <lyrics>
     <from>1</from>
-    <lyrics/>
+    <lyrics></lyrics>
    </lyrics>
    <measures>
     <measure>
@@ -2883,7 +2883,7 @@
    </color>
    <lyrics>
     <from>1</from>
-    <lyrics/>
+    <lyrics></lyrics>
    </lyrics>
    <measures>
     <measure>
diff --git a/test/PhpTabs/files/xml/testSimpleTab.gp3.xml b/test/PhpTabs/files/xml/testSimpleTab.gp3.xml
@@ -163,7 +163,7 @@ Testing comments line 2</comments>
    </color>
    <lyrics>
     <from>1</from>
-    <lyrics/>
+    <lyrics></lyrics>
    </lyrics>
    <measures>
     <measure>
@@ -2904,7 +2904,7 @@ Testing comments line 2</comments>
    </color>
    <lyrics>
     <from>1</from>
-    <lyrics/>
+    <lyrics></lyrics>
    </lyrics>
    <measures>
     <measure>
diff --git a/test/PhpTabs/files/xml/testSimpleTab.gp4.xml b/test/PhpTabs/files/xml/testSimpleTab.gp4.xml
@@ -163,7 +163,7 @@ Testing comments line 2</comments>
    </color>
    <lyrics>
     <from>1</from>
-    <lyrics/>
+    <lyrics></lyrics>
    </lyrics>
    <measures>
     <measure>
@@ -2904,7 +2904,7 @@ Testing comments line 2</comments>
    </color>
    <lyrics>
     <from>1</from>
-    <lyrics/>
+    <lyrics></lyrics>
    </lyrics>
    <measures>
     <measure>
diff --git a/test/PhpTabs/files/xml/testSimpleTab.gp5.xml b/test/PhpTabs/files/xml/testSimpleTab.gp5.xml
@@ -163,7 +163,7 @@ Testing comments line 2</comments>
    </color>
    <lyrics>
     <from>1</from>
-    <lyrics/>
+    <lyrics></lyrics>
    </lyrics>
    <measures>
     <measure>
@@ -2904,7 +2904,7 @@ Testing comments line 2</comments>
    </color>
    <lyrics>
     <from>1</from>
-    <lyrics/>
+    <lyrics></lyrics>
    </lyrics>
    <measures>
     <measure>
diff --git a/test/PhpTabs/files/xml/testSimpleTab.mid.xml b/test/PhpTabs/files/xml/testSimpleTab.mid.xml
@@ -144,7 +144,7 @@
    </color>
    <lyrics>
     <from>1</from>
-    <lyrics/>
+    <lyrics></lyrics>
    </lyrics>
    <measures>
     <measure>
@@ -2785,7 +2785,7 @@
    </color>
    <lyrics>
     <from>1</from>
-    <lyrics/>
+    <lyrics></lyrics>
    </lyrics>
    <measures>
     <measure>
diff --git a/test/PhpTabs/files/yaml/testSimpleMidi.mid.yml b/test/PhpTabs/files/yaml/testSimpleMidi.mid.yml
@@ -122,7 +122,7 @@ song:
         B: 0
       lyrics:
         from: 1
-        lyrics:
+        lyrics: ""
       measures:
         measure:
           channelId: 1
@@ -2412,7 +2412,7 @@ song:
         B: 0
       lyrics:
         from: 1
-        lyrics:
+        lyrics: ""
       measures:
         measure:
           channelId: 2
diff --git a/test/PhpTabs/files/yaml/testSimpleTab.gp3.yml b/test/PhpTabs/files/yaml/testSimpleTab.gp3.yml
@@ -137,7 +137,7 @@ Testing comments line 2"
         B: 0
       lyrics:
         from: 1
-        lyrics:
+        lyrics: ""
       measures:
         measure:
           channelId: 1
@@ -2389,7 +2389,7 @@ Testing comments line 2"
         B: 0
       lyrics:
         from: 1
-        lyrics:
+        lyrics: ""
       measures:
         measure:
           channelId: 2
diff --git a/test/PhpTabs/files/yaml/testSimpleTab.gp4.yml b/test/PhpTabs/files/yaml/testSimpleTab.gp4.yml
@@ -137,7 +137,7 @@ Testing comments line 2"
         B: 0
       lyrics:
         from: 1
-        lyrics:
+        lyrics: ""
       measures:
         measure:
           channelId: 1
@@ -2389,7 +2389,7 @@ Testing comments line 2"
         B: 0
       lyrics:
         from: 1
-        lyrics:
+        lyrics: ""
       measures:
         measure:
           channelId: 2
diff --git a/test/PhpTabs/files/yaml/testSimpleTab.gp5.yml b/test/PhpTabs/files/yaml/testSimpleTab.gp5.yml
@@ -137,7 +137,7 @@ Testing comments line 2"
         B: 0
       lyrics:
         from: 1
-        lyrics:
+        lyrics: ""
       measures:
         measure:
           channelId: 1
@@ -2389,7 +2389,7 @@ Testing comments line 2"
         B: 0
       lyrics:
         from: 1
-        lyrics:
+        lyrics: ""
       measures:
         measure:
           channelId: 2
diff --git a/test/PhpTabs/files/yaml/testSimpleTab.mid.yml b/test/PhpTabs/files/yaml/testSimpleTab.mid.yml
@@ -122,7 +122,7 @@ song:
         B: 0
       lyrics:
         from: 1
-        lyrics:
+        lyrics: ""
       measures:
         measure:
           channelId: 1
@@ -2328,7 +2328,7 @@ song:
         B: 0
       lyrics:
         from: 1
-        lyrics:
+        lyrics: ""
       measures:
         measure:
           channelId: 2

Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,20 @@ class Lyric`
`17`	`17`	`{`
`18`	`18`	`const REGEX = " ";`
`19`	`19`
	`20`	`+ /**`
	`21`	`+ * @var int`
	`22`	`+ */`
`20`	`23`	`private $from;`
	`24`	`+`
	`25`	`+ /**`
	`26`	`+ * @var string`
	`27`	`+ */`
`21`	`28`	`private $lyrics;`
`22`	`29`
`23`	`30`	`public function __construct()`
`24`	`31`	`{`
`25`	`32`	`$this->from = 1;`
`26`		`- $this->lyrics = [];`
	`33`	`+ $this->lyrics = '';`
`27`	`34`	`}`
`28`	`35`
`29`	`36`	`public function getFrom(): int`
`@@ -36,16 +43,12 @@ public function setFrom(int $from): void`
`36`	`43`	`$this->from = $from;`
`37`	`44`	`}`
`38`	`45`
`39`		`- public function getLyrics(): array`
	`46`	`+ public function getLyrics(): string`
`40`	`47`	`{`
`41`	`48`	`return $this->lyrics;`
`42`	`49`	`}`
`43`	`50`
`44`		`- /**`
`45`		`- * @param array\|string $lyrics`
`46`		`- * @todo Fix given type either string or array`
`47`		`- */`
`48`		`- public function setLyrics($lyrics): void`
	`51`	`+ public function setLyrics(string $lyrics): void`
`49`	`52`	`{`
`50`	`53`	`$this->lyrics = $lyrics;`
`51`	`54`	`}`
`@@ -65,7 +68,7 @@ public function getLyricBeats(): array`
`65`	`68`
`66`	`69`	`public function isEmpty(): bool`
`67`	`70`	`{`
`68`		`- return count($this->getLyrics()) == 0;`
	`71`	`+ return strlen($this->getLyrics()) === 0;`
`69`	`72`	`}`
`70`	`73`
`71`	`74`	`public function copyFrom(Lyric $lyric): void`
Original file line number	Diff line number	Diff line change
`@@ -230,14 +230,14 @@ private function writeLyrics(Song $song): void`
`230`	`230`	`}`
`231`	`231`	`}`
`232`	`232`
`233`		`- $this->writeInt($lyricTrack == null ? 0 : $lyricTrack->getNumber());`
`234`		`- $this->writeInt($lyricTrack == null ? 0 : $lyricTrack->getLyrics()->getFrom());`
	`233`	`+ $this->writeInt(is_null($lyricTrack) ? 0 : $lyricTrack->getNumber());`
	`234`	`+ $this->writeInt(is_null($lyricTrack) ? 0 : $lyricTrack->getLyrics()->getFrom());`
`235`	`235`	`$this->writeStringInteger(`
`236`		`- $lyricTrack == null ? '' : $lyricTrack->getLyrics()->getLyrics()`
	`236`	`+ is_null($lyricTrack) ? '' : $lyricTrack->getLyrics()->getLyrics()`
`237`	`237`	`);`
`238`	`238`
`239`	`239`	`for ($i = 0; $i < 4; $i++) {`
`240`		`- $this->writeInt($lyricTrack === null ? 0 : 1);`
	`240`	`+ $this->writeInt(is_null($lyricTrack) ? 0 : 1);`
`241`	`241`	`$this->writeStringInteger('');`
`242`	`242`	`}`
`243`	`243`	`}`