Skip to content

Commit 86dec0a

Browse files
maksugrmaksugr
committedJul 3, 2022
Init commit
·
v1.1.1v0.1.0
0 parents  commit 86dec0a

15 files changed

+1263
-0
lines changed
 

‎.editorconfig

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
root = true
2+
3+
[*]
4+
end_of_line = lf
5+
charset = utf-8
6+
trim_trailing_whitespace = true
7+
insert_final_newline = true
8+
indent_style = space
9+
indent_size = 4
10+

‎.github/workflows/build.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: build
2+
on:
3+
push:
4+
branches: [ "master" ]
5+
pull_request:
6+
branches: [ "master" ]
7+
env:
8+
CARGO_TERM_COLOR: always
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- name: Build
15+
run: cargo build --verbose

‎.github/workflows/coverage.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: coverage
2+
on:
3+
push:
4+
branches: [ "master" ]
5+
pull_request:
6+
branches: [ "master" ]
7+
env:
8+
CARGO_TERM_COLOR: always
9+
jobs:
10+
coverage:
11+
runs-on: ubuntu-latest
12+
container:
13+
image: xd009642/tarpaulin:develop-nightly
14+
options: --security-opt seccomp=unconfined
15+
steps:
16+
- name: Checkout repository
17+
uses: actions/checkout@v2
18+
- name: Generate code coverage
19+
run: |
20+
cargo +nightly tarpaulin --verbose --all-features --workspace --timeout 120 --out Xml
21+
- name: Upload to codecov.io
22+
uses: codecov/codecov-action@v2
23+
with:
24+
fail_ci_if_error: true

‎.github/workflows/test.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: test
2+
on:
3+
push:
4+
branches: [ "master" ]
5+
pull_request:
6+
branches: [ "master" ]
7+
env:
8+
CARGO_TERM_COLOR: always
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- name: Run tests
15+
run: cargo test --verbose

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/target
2+
/Cargo.lock

‎.vscode/settings.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"[rust]": {
3+
"editor.formatOnSave": true
4+
}
5+
}

‎Cargo.toml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[package]
2+
name = "text-to-sounds"
3+
version = "0.1.0"
4+
edition = "2021"
5+
authors = ["maksugr <maksugr@gmail.com>"]
6+
description = "Zero dependencies text-to-sounds parsing tool."
7+
license = "MIT OR Apache-2.0"
8+
documentation = "https://docs.rs/text-to-sounds/"
9+
homepage = "https://github.com/maksugr/text-to-sounds"
10+
repository = "https://github.com/maksugr/text-to-sounds"
11+
readme = "README.md"
12+
keywords = ["parsing", "serialization", "text-to-sounds", "sounds", "english grammar", "english sounds"]
13+
categories = ["Parser implementations"]
14+
15+
[dependencies]

‎LICENSE-APACHE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎LICENSE-MIT

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Roman Ponomarev
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# text-to-sounds
2+
3+
[![build-svg]][build-url]
4+
[![test-svg]][test-url]
5+
[![codecov-svg]][codecov-url]
6+
[![crates-svg]][crates-url]
7+
[![docs-svg]][docs-url]
8+
[![deps-svg]][deps-url]
9+
10+
[build-svg]: https://github.com/maksugr/text-to-sounds/workflows/build/badge.svg
11+
[build-url]: https://github.com/maksugr/text-to-sounds/actions/workflows/build.yml
12+
[test-svg]: https://github.com/maksugr/text-to-sounds/workflows/test/badge.svg
13+
[test-url]: https://github.com/maksugr/text-to-sounds/actions/workflows/test.yml
14+
[codecov-svg]: https://img.shields.io/codecov/c/github/maksugr/text-to-sounds
15+
[codecov-url]: https://codecov.io/gh/maksugr/text-to-sounds
16+
[crates-svg]: https://img.shields.io/crates/v/text-to-sounds.svg
17+
[crates-url]: https://crates.io/crates/text-to-sounds
18+
[docs-svg]: https://docs.rs/text-to-sounds/badge.svg
19+
[docs-url]: https://docs.rs/text-to-sounds
20+
[deps-svg]: https://deps.rs/repo/github/maksugr/text-to-sounds/status.svg
21+
[deps-url]: https://deps.rs/repo/github/maksugr/text-to-sounds
22+
23+
Zero dependencies text-to-sounds parsing tool.
24+
25+
## Overview
26+
27+
The library has methods (`parse`, `serialize`) to parse text (`AsRef<str>`) to `Vec<Sound>` and serialize `Vec<Sound>` to `String`. `Sound` struct has information about English sound.
28+
29+
```rust
30+
// English sound kinds
31+
enum SoundKind {
32+
Ptk,
33+
Th,
34+
W,
35+
V,
36+
Ng,
37+
Ch,
38+
Dj,
39+
Undefined,
40+
}
41+
42+
// Struct of the sound
43+
pub struct Sound {
44+
kind: SoundKind,
45+
text: String,
46+
}
47+
```
48+
49+
## Installation
50+
51+
In order to use this crate, you have to add it under `[dependencies]` to your `Cargo.toml`:
52+
53+
```toml
54+
[dependencies]
55+
text-to-sounds = "0.1.0"
56+
```
57+
58+
## Examples
59+
60+
```rust
61+
use text_to_sounds::{parse, serialize, SoundKind, Sound};
62+
63+
let sounds = vec![
64+
Sound::new(SoundKind::Th, String::from("Th")),
65+
Sound::new(SoundKind::Undefined, String::from("e")),
66+
Sound::new(SoundKind::Undefined, String::from(" ")),
67+
Sound::new(SoundKind::Ptk, String::from("t")),
68+
Sound::new(SoundKind::Undefined, String::from("e")),
69+
Sound::new(SoundKind::Undefined, String::from("x")),
70+
Sound::new(SoundKind::Ptk, String::from("t")),
71+
Sound::new(SoundKind::Undefined, String::from(" ")),
72+
Sound::new(SoundKind::Dj, String::from("j")),
73+
Sound::new(SoundKind::Undefined, String::from("u")),
74+
Sound::new(SoundKind::Undefined, String::from("s")),
75+
Sound::new(SoundKind::Ptk, String::from("t")),
76+
Sound::new(SoundKind::Undefined, String::from(" ")),
77+
Sound::new(SoundKind::Undefined, String::from("i")),
78+
Sound::new(SoundKind::Undefined, String::from("n")),
79+
Sound::new(SoundKind::Undefined, String::from(" ")),
80+
Sound::new(SoundKind::Ptk, String::from("c")),
81+
Sound::new(SoundKind::Undefined, String::from("a")),
82+
Sound::new(SoundKind::Undefined, String::from("s")),
83+
Sound::new(SoundKind::Undefined, String::from("e")),
84+
];
85+
86+
// parse
87+
assert_eq!(parse("The text just in case"), sounds);
88+
89+
// serialize
90+
assert_eq!(serialize(sounds), "The text just in case");
91+
```
92+
93+
Also, you can consider tests inside the files.

‎src/lib.rs

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
//! # text-to-sounds
2+
//!
3+
//! Zero dependencies text-to-sounds parsing tool.
4+
//!
5+
//! ## Overview
6+
//!
7+
//! The library has methods (`parse`, `serialize`) to parse text (`AsRef<str>`) to `Vec<Sound>` and serialize `Vec<Sound>` to `String`. `Sound` struct has information about English sound.
8+
//!
9+
//! ```rust
10+
//! // English sound kinds
11+
//! enum SoundKind {
12+
//! Ptk,
13+
//! Th,
14+
//! W,
15+
//! V,
16+
//! Ng,
17+
//! Ch,
18+
//! Dj,
19+
//! Undefined,
20+
//! }
21+
//!
22+
//! // Struct of the sound
23+
//! pub struct Sound {
24+
//! kind: SoundKind,
25+
//! text: String,
26+
//! }
27+
//! ```
28+
//!
29+
//! ## Installation
30+
//!
31+
//! In order to use this crate, you have to add it under `[dependencies]` to your `Cargo.toml`:
32+
//!
33+
//! ```toml
34+
//! [dependencies]
35+
//! text-to-sounds = "0.1.0"
36+
//! ```
37+
//!
38+
//! ## Examples
39+
//!
40+
//! ```rust
41+
//! use text_to_sounds::{parse, serialize, SoundKind, Sound};
42+
//!
43+
//! let sounds = vec![
44+
//! Sound::new(SoundKind::Th, String::from("Th")),
45+
//! Sound::new(SoundKind::Undefined, String::from("e")),
46+
//! Sound::new(SoundKind::Undefined, String::from(" ")),
47+
//! Sound::new(SoundKind::Ptk, String::from("t")),
48+
//! Sound::new(SoundKind::Undefined, String::from("e")),
49+
//! Sound::new(SoundKind::Undefined, String::from("x")),
50+
//! Sound::new(SoundKind::Ptk, String::from("t")),
51+
//! Sound::new(SoundKind::Undefined, String::from(" ")),
52+
//! Sound::new(SoundKind::Dj, String::from("j")),
53+
//! Sound::new(SoundKind::Undefined, String::from("u")),
54+
//! Sound::new(SoundKind::Undefined, String::from("s")),
55+
//! Sound::new(SoundKind::Ptk, String::from("t")),
56+
//! Sound::new(SoundKind::Undefined, String::from(" ")),
57+
//! Sound::new(SoundKind::Undefined, String::from("i")),
58+
//! Sound::new(SoundKind::Undefined, String::from("n")),
59+
//! Sound::new(SoundKind::Undefined, String::from(" ")),
60+
//! Sound::new(SoundKind::Ptk, String::from("c")),
61+
//! Sound::new(SoundKind::Undefined, String::from("a")),
62+
//! Sound::new(SoundKind::Undefined, String::from("s")),
63+
//! Sound::new(SoundKind::Undefined, String::from("e")),
64+
//! ];
65+
//!
66+
//! // parse
67+
//! assert_eq!(parse("The text just in case"), sounds);
68+
//!
69+
//! // serialize
70+
//! assert_eq!(serialize(sounds), "The text just in case");
71+
//! ```
72+
//!
73+
//! Also, you can consider tests inside the files.
74+
75+
mod parser;
76+
mod scanner;
77+
mod serializer;
78+
mod sound;
79+
80+
pub use crate::parser::parse;
81+
pub use crate::serializer::serialize;
82+
pub use crate::sound::{Sound, SoundKind};

‎src/parser.rs

+419
Large diffs are not rendered by default.

‎src/scanner.rs

+248
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,248 @@
1+
/// The scanner to move through the text
2+
/// Inspired by [Lyn crate](https://crates.io/crates/lyn) and by an [article](https://depth-first.com/articles/2021/12/16/a-beginners-guide-to-parsing-in-rust/)
3+
#[derive(Debug)]
4+
pub struct Scanner {
5+
cursor: usize,
6+
characters: Vec<char>,
7+
}
8+
9+
/// Default letter if Scanner will found nothing
10+
/// Just an easy workaround for Option
11+
const DEFAULT_LETTER: &char = &' ';
12+
13+
impl Scanner {
14+
/// Creates new Scanner
15+
pub fn new(string: &str) -> Self {
16+
Self {
17+
cursor: 0,
18+
characters: string.chars().collect(),
19+
}
20+
}
21+
22+
/// Returns the current cursor. Useful for reporting errors.
23+
#[allow(dead_code)]
24+
pub fn cursor(&self) -> usize {
25+
self.cursor
26+
}
27+
28+
/// Returns the next character without advancing the cursor.
29+
pub fn peek(&self) -> &char {
30+
self.characters.get(self.cursor).unwrap_or(DEFAULT_LETTER)
31+
}
32+
33+
/// Returns the next + 1 character without advancing the cursor.
34+
pub fn peek_next(&self) -> &char {
35+
self.characters
36+
.get(self.cursor + 1)
37+
.unwrap_or(DEFAULT_LETTER)
38+
}
39+
40+
/// Returns true if further progress is not possible.
41+
pub fn is_done(&self) -> bool {
42+
self.cursor == self.characters.len()
43+
}
44+
45+
/// Returns true if the first char.
46+
pub fn is_first(&self) -> bool {
47+
self.cursor == 0
48+
}
49+
50+
/// Returns true if the last char.
51+
pub fn is_last(&self) -> bool {
52+
self.cursor + 1 == self.characters.len()
53+
}
54+
55+
/// Returns the next character and advances the cursor.
56+
pub fn pop(&mut self) -> &char {
57+
match self.characters.get(self.cursor) {
58+
Some(character) => {
59+
self.cursor += 1;
60+
61+
character
62+
}
63+
None => DEFAULT_LETTER,
64+
}
65+
}
66+
}
67+
68+
#[cfg(test)]
69+
mod cursor {
70+
use super::*;
71+
72+
#[test]
73+
fn empty() {
74+
let scanner = Scanner::new("");
75+
76+
assert_eq!(scanner.cursor(), 0)
77+
}
78+
79+
#[test]
80+
fn in_progress() {
81+
let mut scanner = Scanner::new("abc");
82+
83+
scanner.pop();
84+
85+
assert_eq!(scanner.cursor(), 1);
86+
}
87+
88+
#[test]
89+
fn done() {
90+
let mut scanner = Scanner::new("abc");
91+
92+
scanner.pop();
93+
scanner.pop();
94+
scanner.pop();
95+
96+
assert_eq!(scanner.cursor(), 3)
97+
}
98+
}
99+
100+
#[cfg(test)]
101+
mod is_done {
102+
use super::*;
103+
104+
#[test]
105+
fn emtpy() {
106+
let scanner = Scanner::new("");
107+
108+
assert!(scanner.is_done())
109+
}
110+
111+
#[test]
112+
fn not_done() {
113+
let mut scanner = Scanner::new("abc");
114+
115+
scanner.pop();
116+
117+
assert!(!scanner.is_done())
118+
}
119+
120+
#[test]
121+
fn done() {
122+
let mut scanner = Scanner::new("abc");
123+
124+
scanner.pop();
125+
scanner.pop();
126+
scanner.pop();
127+
128+
assert!(scanner.is_done())
129+
}
130+
}
131+
132+
#[cfg(test)]
133+
mod peek {
134+
use super::*;
135+
136+
#[test]
137+
fn empty() {
138+
let scanner = Scanner::new("");
139+
140+
assert_eq!(scanner.peek(), DEFAULT_LETTER)
141+
}
142+
143+
#[test]
144+
fn not_done() {
145+
let mut scanner = Scanner::new("abc");
146+
147+
scanner.pop();
148+
149+
assert_eq!(scanner.peek(), &'b')
150+
}
151+
}
152+
153+
#[cfg(test)]
154+
mod peek_next {
155+
use super::*;
156+
157+
#[test]
158+
fn empty() {
159+
let scanner = Scanner::new("");
160+
161+
assert_eq!(scanner.peek_next(), DEFAULT_LETTER)
162+
}
163+
164+
#[test]
165+
fn not_done() {
166+
let mut scanner = Scanner::new("abc");
167+
168+
scanner.pop();
169+
170+
assert_eq!(scanner.peek_next(), &'c')
171+
}
172+
}
173+
174+
#[cfg(test)]
175+
mod is_first {
176+
use super::*;
177+
178+
#[test]
179+
fn is_first() {
180+
let scanner = Scanner::new("abc");
181+
182+
assert!(scanner.is_first())
183+
}
184+
185+
#[test]
186+
fn not_is_first() {
187+
let mut scanner = Scanner::new("abc");
188+
189+
scanner.pop();
190+
191+
assert!(!scanner.is_first())
192+
}
193+
}
194+
195+
#[cfg(test)]
196+
mod is_last {
197+
use super::*;
198+
199+
#[test]
200+
fn not_is_last() {
201+
let scanner = Scanner::new("abc");
202+
203+
assert!(!scanner.is_last())
204+
}
205+
206+
#[test]
207+
fn is_last() {
208+
let mut scanner = Scanner::new("abc");
209+
210+
scanner.pop();
211+
scanner.pop();
212+
213+
assert!(scanner.is_last())
214+
}
215+
}
216+
217+
#[cfg(test)]
218+
mod pop {
219+
use super::*;
220+
221+
#[test]
222+
fn empty() {
223+
let mut scanner = Scanner::new("");
224+
225+
assert_eq!(scanner.pop(), DEFAULT_LETTER);
226+
assert_eq!(scanner.cursor(), 0)
227+
}
228+
229+
#[test]
230+
fn not_done() {
231+
let mut scanner = Scanner::new("abc");
232+
233+
assert_eq!(scanner.pop(), &'a');
234+
assert_eq!(scanner.cursor(), 1)
235+
}
236+
237+
#[test]
238+
fn done() {
239+
let mut scanner = Scanner::new("abc");
240+
241+
scanner.pop();
242+
scanner.pop();
243+
scanner.pop();
244+
245+
assert_eq!(scanner.pop(), DEFAULT_LETTER);
246+
assert_eq!(scanner.cursor(), 3)
247+
}
248+
}

‎src/serializer.rs

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
use crate::sound::Sound;
2+
3+
/// Serialize sounds to text
4+
///
5+
/// ## Example
6+
///
7+
/// ```rust
8+
/// use text_to_sounds::{serialize, SoundKind, Sound};
9+
///
10+
/// let sounds = vec![
11+
/// Sound::new(SoundKind::Th, String::from("Th")),
12+
/// Sound::new(SoundKind::Undefined, String::from("e")),
13+
/// Sound::new(SoundKind::Undefined, String::from(" ")),
14+
/// Sound::new(SoundKind::Ptk, String::from("t")),
15+
/// Sound::new(SoundKind::Undefined, String::from("e")),
16+
/// Sound::new(SoundKind::Undefined, String::from("x")),
17+
/// Sound::new(SoundKind::Ptk, String::from("t")),
18+
/// Sound::new(SoundKind::Undefined, String::from(" ")),
19+
/// Sound::new(SoundKind::Dj, String::from("j")),
20+
/// Sound::new(SoundKind::Undefined, String::from("u")),
21+
/// Sound::new(SoundKind::Undefined, String::from("s")),
22+
/// Sound::new(SoundKind::Ptk, String::from("t")),
23+
/// Sound::new(SoundKind::Undefined, String::from(" ")),
24+
/// Sound::new(SoundKind::Undefined, String::from("i")),
25+
/// Sound::new(SoundKind::Undefined, String::from("n")),
26+
/// Sound::new(SoundKind::Undefined, String::from(" ")),
27+
/// Sound::new(SoundKind::Ptk, String::from("c")),
28+
/// Sound::new(SoundKind::Undefined, String::from("a")),
29+
/// Sound::new(SoundKind::Undefined, String::from("s")),
30+
/// Sound::new(SoundKind::Undefined, String::from("e")),
31+
/// ];
32+
///
33+
/// assert_eq!(serialize(sounds), "The text just in case");
34+
/// ```
35+
pub fn serialize(sounds: Vec<Sound>) -> String {
36+
if sounds.is_empty() {
37+
return String::from("");
38+
}
39+
40+
sounds
41+
.iter()
42+
.fold(String::new(), |string, sound| string + sound.text())
43+
}
44+
45+
#[cfg(test)]
46+
mod serialize {
47+
use super::{serialize, Sound};
48+
use crate::sound::SoundKind;
49+
50+
#[test]
51+
fn it_should_serialize_empty() {
52+
assert_eq!(serialize(Vec::new()), String::from(""));
53+
}
54+
55+
#[test]
56+
fn it_should_serialize_sounds() {
57+
let sounds = vec![
58+
Sound::new(SoundKind::Th, String::from("Th")),
59+
Sound::new(SoundKind::Undefined, String::from("e")),
60+
Sound::new(SoundKind::Undefined, String::from("n")),
61+
Sound::new(SoundKind::Undefined, String::from(" ")),
62+
Sound::new(SoundKind::Ptk, String::from("P")),
63+
Sound::new(SoundKind::Undefined, String::from("u")),
64+
Sound::new(SoundKind::Ptk, String::from("T")),
65+
Sound::new(SoundKind::Undefined, String::from(" ")),
66+
Sound::new(SoundKind::Ptk, String::from("t")),
67+
Sound::new(SoundKind::Undefined, String::from("O")),
68+
Sound::new(SoundKind::Undefined, String::from("g")),
69+
Sound::new(SoundKind::Undefined, String::from("E")),
70+
Sound::new(SoundKind::Th, String::from("TH")),
71+
Sound::new(SoundKind::Undefined, String::from("e")),
72+
Sound::new(SoundKind::Undefined, String::from("r")),
73+
];
74+
75+
assert_eq!(serialize(sounds), "Then PuT tOgETHer");
76+
}
77+
}

‎src/sound.rs

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/// English sound kinds
2+
#[derive(Debug, PartialEq)]
3+
pub enum SoundKind {
4+
Ptk,
5+
Th,
6+
W,
7+
V,
8+
Ng,
9+
Ch,
10+
Dj,
11+
Undefined,
12+
}
13+
14+
/// Struct of the sound
15+
#[derive(Debug, PartialEq)]
16+
pub struct Sound {
17+
kind: SoundKind,
18+
text: String,
19+
}
20+
21+
impl Sound {
22+
/// Creates new Sound
23+
pub fn new(kind: SoundKind, text: String) -> Self {
24+
Self { kind, text }
25+
}
26+
27+
/// Returns kind of the sound
28+
pub fn kind(&self) -> &SoundKind {
29+
&self.kind
30+
}
31+
32+
/// Returns text of the sound
33+
pub fn text(&self) -> &String {
34+
&self.text
35+
}
36+
}

0 commit comments

Comments
 (0)
Please sign in to comment.