DataFixture
Create data models easily, with no headache. DataFixture is a convenient way to generate new data for testing / seeding your Realm Database.
Installation
Cocoapods
CocoaPods 0.39.0+ is required to build this library
To install DataFixture, simply add in your Podfile pod 'DataFixture' and run pod install
Usage
Basic
- Create a new file to define the fixture factory for a model.
import DataFixture
extension Company: FixtureFactoryable {
static var factory: CompanyFixtureFactory {
return CompanyFixtureFactory()
}
}
struct CompanyFixtureFactory: FixtureFactory {
typealias Model = Company
func definition() -> FixtureDefinition<Company> {
define { (faker) in
Company(
name: faker.company.name(),
employees: Person.factory.make(5)
)
}
}
// If you need to override a model field, simply define a function that returns a `FixtureDefinition`.
// To redefine the default definition, you must use the `redefine` function.
func empty(name: String) -> FixtureDefinition<Company> {
redefine { (company) in
company.name = name
company.employees = []
}
}
}
- Then you can build the model by using its factory.
// Create a single object of type Company.
Company.factory.make()
// Create a single object of type Company with no employees.
Company.factory.empty(name: "EmptyCompany").make()
// Create 10 objects of type Company.
Company.factory.make(10)
// Create 10 objects of type Company with no employees.
Company.factory.empty(name: "EmptyCompany").make(10)
JSON Fixtures
A factory can create a JSON Object from a generated model.
- First, you have to extend
JSONFixtureFactoryprotocol to the model factory.
import DataFixture
extension Company: FixtureFactoryable {
static var factory: CompanyFixtureFactory {
return CompanyFixtureFactory()
}
}
struct CompanyFixtureFactory: JSONFixtureFactory {
typealias Model = Company
func definition() -> FixtureDefinition<Company> {
define { (faker) in
Company(
name: faker.company.name(),
employees: Person.factory.make(5)
)
}
}
// This function define the json definition, using the default definition (function `definition()`).
func jsonDefinition() -> JSONFixtureDefinition<Company> {
defineJSON { (company) -> [String : Any] in
[
"name": company.name,
"employees": Person.factory.makeJSON(from: company.employees)
]
}
}
// If you need to generate the JSON Object of an empty company, change the return type to `JSONFixtureDefinition`
func empty(name: String) -> JSONFixtureDefinition<Company> { // Previously `FixtureDefinition`
redefine { (company) in
company.name = name
company.employees = []
}
}
}
- Now you can generate the JSON Object of the model.
// Create a single JSON object of type Company.
Company.factory.makeJSON()
// Create a single JSON object of type Company with no employees.
Company.factory.empty(name: "EmptyCompany").makeJSON()
// Create a JSON Array of 10 objects of type Company.
Company.factory.makeJSON(10)
// Create a JSON Array of 10 objects of type Company with no employees.
Company.factory.empty(name: "EmptyCompany").makeJSON(10)
// Create a Company object with its relative JSON object.
Company.factory.makeWithJSON()
// Create 10 Company object with its relative JSON objects.
Company.factory.makeWithJSON(10)
- With
JSONFixtureFactoryyou can create a JSON from an external model object.
let company = Company.factory.make()
let JSONObject = Company.factory.makeJSON(from: company)
let companies = Company.factory.make(3)
let JSONArray = Company.factory.makeJSON(from: companies)
RealmSeeder
This submodule can seed some data easily in Realm Database, using Seeder. First of all, define it in your Podfile pod 'DataFixture/RealmSeeder'. Then create a new struct to define a RealmSeeder.
import DataFixture
struct ExampleSeeder: RealmSeeder {
func run(realm: Realm) throws {
// Put here your database population
realm.add(Person(firstName: "Luke"), update: .all) // You can simply create an object and then add in Realm instance.
try Dog.factory.create(10, in: realm) // You can easily create 10 fake dogs and then add in Realm instance.
try realm.seed(AnotherSeeder.self, AnotherAnotherSeeder.self) // To call another seed, please use this function to automatic handling transactions.
}
}
To run the ExampleSeeder just call the seed function on a Realm instance. This function automatically starts a transaction if needed.
try realm.seed(ExampleSeeder.self)
Documentation
Click here to read the complete DataFixture API documentation.
Contributing
DataFixture is an open source project, so feel free to contribute. You can open an issue for problems or suggestions, and you can propose your own fixes by opening a pull request with the changes.
39 May 19, 2022
446 Dec 29, 2022
183 Dec 24, 2022
317 Nov 22, 2022
36 Dec 13, 2022
1.6k Jan 3, 2023
1.4k Dec 21, 2022
1 Oct 9, 2021
589 Sep 7, 2022
0 Feb 26, 2022
94 Feb 28, 2022
6 Dec 19, 2022
8.5k Jan 3, 2023
6.9k Dec 8, 2022
2 Aug 31, 2022
26 Nov 26, 2022
257 Dec 6, 2022
44 Dec 27, 2022
49 Jan 2, 2023