Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getspherelabs/blahblah
Blah-Blah generates fake data for robust testing and developmental purposes
https://github.com/getspherelabs/blahblah
blahblah fake kmm kmp kotlin multiplatform tdd
Last synced: 2 months ago
JSON representation
Blah-Blah generates fake data for robust testing and developmental purposes
- Host: GitHub
- URL: https://github.com/getspherelabs/blahblah
- Owner: getspherelabs
- License: mit
- Created: 2023-08-08T05:50:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-24T07:07:27.000Z (over 1 year ago)
- Last Synced: 2024-11-07T15:46:35.319Z (2 months ago)
- Topics: blahblah, fake, kmm, kmp, kotlin, multiplatform, tdd
- Language: Kotlin
- Homepage: https://getspherelabs.github.io/blahblah/
- Size: 2.57 MB
- Stars: 27
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-list - getspherelabs/blahblah - Blah-Blah generates fake data for robust testing and developmental purposes (Kotlin)
- kmp-awesome - BlahBlah - Blah-Blah generates fake data for robust testing and development (Libraries / 🔧 Utils)
README
Blah-Blah
Blah-Blah is a Kotlin Multiplatform (KMP) library designed to generates fake data for robust testing and development. It can be used for things such as:
- Unit Testing
- Performance Testing
- Building Demos
- Working without a completed backend
Blah-Blah's flexibility and compatibility with Kotlin Multiplatform make it an essential tool for creating high-quality applications that are thoroughly tested and well-prepared for dynamic development demands.
## Features
- It generates realistic data, enabling effective scenario simulation without relying on actual data sources.
- The library provides a solid foundation for robust testing by offering diverse datasets that mimic real-world scenarios.
- Blah-Blah supports Kotlin Multiplatform.
## Documentation 📖
- [Getting Started](https://getspherelabs.github.io/blahblah/guides/getting-started)
- [Core Concepts](https://getspherelabs.github.io/blahblah/guides/concepts)
- [Contributing](https://getspherelabs.github.io/blahblah/contribute/)
## Architecture
```mermaid
flowchart LR
K[(Resource)] --> H[YAML Parser]
H --> N[YAML Provider] --> F[BlahBlah Provider]
F --> A[Module]
A[Module] --> B[(BlahBlah)]
```
## Modules
- [Address](https://github.com/getspherelabs/blahblah/)
- [Ancient](https://github.com/getspherelabs/blahblah/)
- [Animal](https://github.com/getspherelabs/blahblah/)
- [App](https://github.com/getspherelabs/blahblah/)
- [Artist](https://github.com/getspherelabs/blahblah/)
- [Bank](https://github.com/getspherelabs/blahblah/)
- [Book](https://github.com/getspherelabs/blahblah/)
- [Cat](https://github.com/getspherelabs/blahblah/)
- [Code](https://github.com/getspherelabs/blahblah/)
- [Color](https://github.com/getspherelabs/blahblah/)
- [Commerce](https://github.com/getspherelabs/blahblah/)
- [Company](https://github.com/getspherelabs/blahblah/)
- [CreditCard](https://github.com/getspherelabs/blahblah/)
- [Compass](https://github.com/getspherelabs/blahblah/)
- [Education](https://github.com/getspherelabs/blahblah/)
- [Esports](https://github.com/getspherelabs/blahblah/)
- [File](https://github.com/getspherelabs/blahblah/)
- [Food](https://github.com/getspherelabs/blahblah/)
- [Hacker](https://github.com/getspherelabs/blahblah/)
- [IdNumber](https://github.com/getspherelabs/blahblah/)
- [Internet](https://github.com/getspherelabs/blahblah/)
- [Job](https://github.com/getspherelabs/blahblah/)
- [Lorem](https://github.com/getspherelabs/blahblah/)
- [Music](https://github.com/getspherelabs/blahblah/)
- [Name](https://github.com/getspherelabs/blahblah/)
- [Space](https://github.com/getspherelabs/blahblah/)
- [Uuid](https://github.com/getspherelabs/blahblah/)
- [University](https://github.com/getspherelabs/blahblah/)
- [Team](https://github.com/getspherelabs/blahblah/)
## Setup
Add the dependency below into your module's `build.gradle.kts` file:
```kt
// For development
// It includes blah-blah fake.
implementation("io.github.behzodhalil:blahblah-fake:")
// If only need yaml parser
implementation("io.github.behzodhalil:blahblah-yaml:")
// For testing
// It includes blah-blah fake.
testImplementation("io.github.behzodhalil:blahblah-fake:")
// If only need yaml parser
testImplementation("io.github.behzodhalil:blahblah-yaml:")
```
## Usage
### Testing
class BlahBlahTest {
private lateinit var blah: BlahBlah
@BeforeTest
fun setup() {
blah = blah()
}
@Test
fun `check the blah blah works properly`() {
val city = blah.address.city
val state = blah.address.state
assertNotNull(city)
assertNotNull(state)
}
@Test
fun `check the street address gets successfully`() {
val streetAddress = blah.address.streetAddress
assertNotNull(streetAddress)
assertTrue(streetAddress.isDigit())
}
}
## YamlParser
YamlParser for parsing YAML files and retrieving values organized in a specific structure.
```kt
interface YamlParser {
fun values(): YamlResource
}
```
## YamlProvider
YamlProvider for providing values fetched from YAML resources using specified keys.
```kt
interface YamlProvider {
fun get(key: String): String
}
```
## Provider
Provider representing a provider that retrieves content from a specified path. It is a bridge between module and yaml provider.
```kt
public interface Provider {
public fun get(path: Path): String
}
```
## Path
Path representing a path to a resource.It is not Okio path.
```kt
public interface Path {
public val value: String
}
```
## License
[](LICENSE.md)