Skip to content

Commit 9caa372

Browse files
committed
docs: update README
1 parent 79e1c77 commit 9caa372

File tree

2 files changed

+20
-103
lines changed

2 files changed

+20
-103
lines changed

Readme.md

Lines changed: 19 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
- [X] Create Example SwiftUI project to demonstrate package usage for previews
2222
- [X] Provide a way to customize lorem in different categories (like creditCard, phoneNumber, name, price etc..) (works for auto generated init)
2323
- [ ] Provide a way to customize loreming for the supported built-in types (to completely determine what to receive for the lorem data)
24-
- [ ] Improve diagnostic
2524
- [ ] Implement unit test
2625

2726
---
@@ -38,116 +37,34 @@ Then use `StructName.lorem()` or `ClassName.lorem()` or `EnumName.lorem()`. Basi
3837

3938

4039
```swift
41-
import LoremSwiftify
42-
43-
@LoremSwiftify
44-
class Book {
45-
let name: String
46-
let published: Date
47-
let author: Author
48-
49-
init(name: String, published: Date, author: Author) {
50-
self.name = name
51-
self.published = published
52-
self.author = author
53-
}
54-
40+
extension ContentView {
5541
@LoremSwiftify
56-
class Author {
57-
let name: String
58-
let surname: String
59-
var nickName: String?
60-
let age: Int
61-
62-
init(_ name: String, surname: String, nickName: String? = nil, age: Int) {
63-
self.name = name
64-
self.surname = surname
65-
self.nickName = nickName
66-
self.age = age
67-
}
68-
}
69-
// Expands
70-
extension Book.Author: LoremIpsumize {
71-
public static func lorem() -> Self {
72-
Book.Author(
73-
_: .lorem(),
74-
surname: .lorem(),
75-
nickName: nil,
76-
age: .lorem()
77-
) as! Self
78-
}
79-
}
80-
}
81-
// Expands
82-
extension Book: LoremIpsumize {
83-
public static func lorem() -> Self {
84-
Book(
85-
name: .lorem(),
86-
published: .lorem(),
87-
author: .lorem()
88-
) as! Self
89-
}
90-
}
91-
92-
print(Book.lorem())
42+
struct Display {
43+
let developers: [Developer]
9344

94-
@LoremSwiftify
95-
struct Hotel {
96-
@Lorem(.string(.name))
97-
let name: String
98-
99-
@Lorem(.string(.phoneNumber))
100-
let phoneNumber: String
45+
@LoremSwiftify
46+
struct Developer: Identifiable {
47+
let id: String = UUID().uuidString
10148

102-
@Lorem(.url(.website))
103-
let website: URL
49+
@Lorem(.string(.name))
50+
let name: String
10451

105-
let rooms: [Room]
52+
@Lorem(.string(.email))
53+
let email: String
10654

107-
@LoremSwiftify
108-
struct Room {
109-
let id: UUID
110-
let capacity: Capacity
55+
@Lorem(.string(.phoneNumber))
56+
let phoneNumber: String
11157

112-
@Lorem(.url(.image))
113-
let image: URL
58+
@Lorem(.url(.image))
59+
let imageURL: URL
11460

115-
@LoremSwiftify
116-
enum Capacity: Int {
117-
case one = 1
118-
case two = 2
119-
case three = 3
120-
case four = 4
121-
}
122-
// Expands
123-
extension Hotel.Room.Capacity: LoremIpsumize {
124-
public static func lorem() -> Self {
125-
Hotel.Room.Capacity.one
126-
}
127-
}
128-
}
129-
// Expands
130-
extension Hotel.Room: LoremIpsumize {
131-
public static func lorem() -> Self {
132-
Hotel.Room(
133-
id: .lorem(),
134-
capacity: .lorem(),
135-
image: .lorem(.url(.image))
136-
)
61+
@Lorem(.url(.website))
62+
let profileURL: URL
13763
}
13864
}
13965
}
140-
// Expands
141-
extension Hotel: LoremIpsumize {
142-
public static func lorem() -> Self {
143-
Hotel(
144-
name: .lorem(.string(.name)),
145-
phoneNumber: .lorem(.string(.phoneNumber)),
146-
website: .lorem(.url(.website)),
147-
rooms: .lorem()
148-
)
149-
}
150-
}
15166

152-
print(Hotel.lorem())
67+
#Preview {
68+
ContentView(display: .lorem())
69+
}
15370
```

Tests/LoremSwiftsumizeTests/TestUtils/MacroTestCase.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import LoremSwiftifyMacros
1616
class MacroTestCase: XCTestCase {
1717
override func invokeTest() {
1818
#if canImport(LoremSwiftifyMacros)
19-
withMacroTesting(isRecording: false, macros: ["LoremSwiftifyMacros": LoremSwiftifyMacro.self]) {
19+
withMacroTesting(record: false, macros: ["LoremSwiftifyMacros": LoremSwiftifyMacro.self]) {
2020
super.invokeTest()
2121
}
2222
#else

0 commit comments

Comments
 (0)