Added support for speech marks.

Review threads live on the whole diff, not on one commit, so none are shown here - a thread's line means something in the branch's final form, and painting it into an intermediate step would put it on code it is not about.

composer.jsonmodified+2-1

Changes to composer.json

		⋯27 linesShow the 27 lines above this hunk@@ -28,7 +28,8 @@
28	28	"php": "^7.3|^7.4|^8.0",
29	29	"aws/aws-sdk-php": "^3.178",
30	30	"guzzlehttp/guzzle": "^6.0|^7.0",
31		- "illuminate/support": "5.*|^6.0|^7.0|^8.0"
	31	+ "illuminate/support": "5.*|^6.0|^7.0|^8.0",
	32	+ "ext-json": "*"
32	33	},
33	34	"require-dev": {
34	35	"orchestra/testbench": "^4.0|^5.0|^6.0",

src/Converters/PollyConverter.phpmodified+52-16

Changes to src/Converters/PollyConverter.php

		⋯5 linesShow the 5 lines above this hunk@@ -6,6 +6,7 @@ use Aws\Polly\PollyClient;
6	6	use Aws\Result;
7	7	use Cion\TextToSpeech\Contracts\Converter;
8	8	use Cion\TextToSpeech\Traits\HasLanguage;
	9	+use Cion\TextToSpeech\Traits\HasSpeechMarks;
9	10	use Cion\TextToSpeech\Traits\Sourceable;
10	11	use Cion\TextToSpeech\Traits\SSMLable;
11	12	use Cion\TextToSpeech\Traits\Storable;
		⋯1 lineShow the 1 line above this hunk@@ -13,7 +14,7 @@ use Illuminate\Support\Arr;
13	14
14	15	class PollyConverter implements Converter
15	16	{
16		- use Storable, Sourceable, HasLanguage, SSMLable;
	17	+ use Storable, Sourceable, HasLanguage, SSMLable, HasSpeechMarks;
17	18
18	19	/**
19	20	* Client instance of Polly.
		⋯27 linesShow the 27 lines above this hunk@@ -47,7 +48,7 @@ class PollyConverter implements Converter
47	48	*
48	49	* @param string $data
49	50	* @param array $options
50		- * @return string
	51	+ * @return string|array
51	52	*/
52	53	public function convert(string $data, array $options = null)
53	54	{
		⋯5 linesShow the 5 lines above this hunk@@ -59,6 +60,10 @@ class PollyConverter implements Converter
59	60
60	61	$result = $this->synthesizeSpeech($text, $options);
61	62
	63	+ if ($this->hasSpeechMarks()) {
	64	+ return $this->formatToArray($this->getResultContent($result));
	65	+ }
	66	+
62	67	if ($result instanceof Result) {
63	68	// Store audio file to disk
64	69	return $this->store(
		⋯17 linesShow the 17 lines above this hunk@@ -82,26 +87,26 @@ class PollyConverter implements Converter
82	87	*/
83	88	protected function synthesizeSpeech($text, array $options = null)
84	89	{
	90	+ $arguments = [
	91	+ 'LanguageCode' => $this->getLanguage(),
	92	+ 'VoiceId' => $this->voice($options),
	93	+ 'OutputFormat' => $this->format($options),
	94	+ 'TextType' => $this->textType(),
	95	+ 'SpeechMarkTypes' => $this->speechMarks,
	96	+ ];
	97	+
85	98	if (is_string($text)) {
86		- return $this->client->synthesizeSpeech([
87		- 'LanguageCode' => $this->getLanguage(),
88		- 'VoiceId' => $this->voice($options),
89		- 'OutputFormat' => $this->format($options),
90		- 'TextType' => $this->textType(),
91		- 'Text' => $text,
92		- ]);
	99	+ return $this->client->synthesizeSpeech(array_merge($arguments, [
	100	+ 'Text' => $text,
	101	+ ]));
93	102	}
94	103
95	104	$results = [];
96	105
97	106	foreach ($text as $textItem) {
98		- $result = $this->client->synthesizeSpeech([
99		- 'LanguageCode' => $this->getLanguage(),
100		- 'VoiceId' => $this->voice($options),
101		- 'OutputFormat' => $this->format($options),
102		- 'TextType' => $this->textType(),
103		- 'Text' => $textItem,
104		- ]);
	107	+ $result = $this->client->synthesizeSpeech(array_merge($arguments, [
	108	+ 'Text' => $textItem,
	109	+ ]));
105	110
106	111	array_push($results, $result);
107	112	}
		⋯82 linesShow the 82 lines above this hunk@@ -190,6 +195,10 @@ class PollyConverter implements Converter
190	195	*/
191	196	protected function format($options)
192	197	{
	198	+ if ($this->hasSpeechMarks()) {
	199	+ return 'json';
	200	+ }
	201	+
193	202	$default = config('tts.output_format', 'mp3');
194	203
195	204	return Arr::get($options, 'format', $default);
		⋯9 linesShow the 9 lines above this hunk@@ -205,4 +214,31 @@ class PollyConverter implements Converter
205	214	{
206	215	return $result->get('AudioStream')->getContents();
207	216	}
	217	+
	218	+ /**
	219	+ * Determines if speech marks are set.
	220	+ *
	221	+ * @return bool
	222	+ */
	223	+ protected function hasSpeechMarks()
	224	+ {
	225	+ return ! empty($this->speechMarks);
	226	+ }
	227	+
	228	+ /**
	229	+ * Format the given json string into an array.
	230	+ *
	231	+ * @param string $json
	232	+ * @return array
	233	+ */
	234	+ protected function formatToArray($json)
	235	+ {
	236	+ $jsons = explode(PHP_EOL, $json);
	237	+
	238	+ array_pop($jsons);
	239	+
	240	+ return collect($jsons)->map(function ($json) {
	241	+ return json_decode($json, true);
	242	+ })->toArray();
	243	+ }
208	244	}

src/Facades/TextToSpeech.phpmodified+2-1

Changes to src/Facades/TextToSpeech.php

		⋯4 linesShow the 4 lines above this hunk@@ -5,12 +5,13 @@ namespace Cion\TextToSpeech\Facades;
5	5	use Illuminate\Support\Facades\Facade;
6	6
7	7	/**
8		- * @method static void convert($data, array $options)
	8	+ * @method static string|array convert($data, array $options)
9	9	* @method static \Cion\TextToSpeech\Contracts\Converter saveTo(string $path)
10	10	* @method static \Cion\TextToSpeech\Contracts\Converter disk(string $disk)
11	11	* @method static \Cion\TextToSpeech\Contracts\Converter source(string $source)
12	12	* @method static \Cion\TextToSpeech\Contracts\Converter language(string $language)
13	13	* @method static \Cion\TextToSpeech\Contracts\Converter ssml()
	14	+ * @method static \Cion\TextToSpeech\Contracts\Converter speechMarks(array $speechMarks)
14	15	*/
15	16	class TextToSpeech extends Facade
16	17	{

src/Traits/HasSpeechMarks.phpadded+26-0

Changes to src/Traits/HasSpeechMarks.php

		@@ -0,0 +1,26 @@
	1	+<?php
	2	+
	3	+
	4	+namespace Cion\TextToSpeech\Traits;
	5	+
	6	+
	7	+trait HasSpeechMarks
	8	+{
	9	+ /**
	10	+ * @var array
	11	+ */
	12	+ protected $speechMarks = [];
	13	+
	14	+ /**
	15	+ * Sets the speech mark types.
	16	+ *
	17	+ * @param array $speechMarks
	18	+ * @return $this
	19	+ */
	20	+ public function speechMarks(array $speechMarks)
	21	+ {
	22	+ $this->speechMarks = $speechMarks;
	23	+
	24	+ return $this;
	25	+ }
	26	+}

tests/PollyConverterTest.phpmodified+10-0

Changes to tests/PollyConverterTest.php

		⋯96 linesShow the 96 lines above this hunk@@ -97,4 +97,14 @@ class PollyConverterTest extends TextToSpeechTestCase
97	97
98	98	Storage::assertExists($path);
99	99	}
	100	+
	101	+ /** @test */
	102	+ public function it_should_return_an_array_when_speech_marks_are_set()
	103	+ {
	104	+ $converter = new PollyConverter($this->client);
	105	+
	106	+ $result = $converter->speechMarks(['sentence'])->convert('test');
	107	+
	108	+ $this->assertIsArray($result);
	109	+ }
100	110	}