Skip to content

Commit cf8996b

Browse files
k-koheyk-kohey
authored
Merge pull request #17 from k-kohey/feature/auto_generation
Add Command line tool generate event file
2 parents af58dc0 + d823ea4 commit cf8996b

15 files changed

+675
-104
lines changed

‎.github/workflows/swift.yml

+11-8
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@ name: Swift
55

66
on:
77
push:
8-
branches: [ "main" ]
8+
branches: ["main"]
99
pull_request:
10-
branches: [ "main" ]
10+
branches: ["main"]
1111

1212
jobs:
1313
build:
14-
1514
runs-on: macos-12
1615

1716
steps:
18-
- uses: actions/checkout@v3
19-
- name: Build
20-
run: swift build -v
21-
- name: Run tests
22-
run: swift test -v
17+
- uses: actions/checkout@v3
18+
- name: Build
19+
run: |
20+
swift build -v
21+
swift build -v --package-path EventGen
22+
- name: Run tests
23+
run: |
24+
swift test -v
25+
swift test -v --package-path EventGen

‎EventGeneration/.gitignore ‎EventGen/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@
44
/*.xcodeproj
55
xcuserdata/
66
DerivedData/
7+
.swiftpm/config/registries.json
78
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
9+
.netrc

‎EventGen/Package.resolved

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"pins" : [
3+
{
4+
"identity" : "swift-argument-parser",
5+
"kind" : "remoteSourceControl",
6+
"location" : "https://github.com/apple/swift-argument-parser.git",
7+
"state" : {
8+
"revision" : "fddd1c00396eed152c45a46bea9f47b98e59301d",
9+
"version" : "1.2.0"
10+
}
11+
},
12+
{
13+
"identity" : "swift-cmark",
14+
"kind" : "remoteSourceControl",
15+
"location" : "https://github.com/apple/swift-cmark.git",
16+
"state" : {
17+
"branch" : "gfm",
18+
"revision" : "bfdc057b5a02fc65af20771a7ba08f9c944eb117"
19+
}
20+
},
21+
{
22+
"identity" : "swift-markdown",
23+
"kind" : "remoteSourceControl",
24+
"location" : "https://github.com/apple/swift-markdown",
25+
"state" : {
26+
"revision" : "87ae1a8fa9180b85630c7b41ddd5aa40ffc87ce3"
27+
}
28+
}
29+
],
30+
"version" : 2
31+
}

‎EventGen/Package.swift

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// swift-tools-version: 5.7
2+
// The swift-tools-version declares the minimum version of Swift required to build this package.
3+
4+
import PackageDescription
5+
6+
let package = Package(
7+
name: "EventGen",
8+
platforms: [.macOS(.v11)],
9+
products: [
10+
.executable(name: "eventgen", targets: ["eventgen"])
11+
],
12+
dependencies: [
13+
.package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.0.0"),
14+
.package(url: "https://github.com/apple/swift-markdown", revision: "87ae1a8fa9180b85630c7b41ddd5aa40ffc87ce3"),
15+
.package(name: "Parchment", path: "../")
16+
],
17+
targets: [
18+
.executableTarget(
19+
name: "eventgen",
20+
dependencies: [
21+
.product(name: "ArgumentParser", package: "swift-argument-parser"),
22+
"EventGenKit"
23+
]
24+
),
25+
.target(
26+
name: "EventGenKit",
27+
dependencies: [
28+
.product(name: "Markdown", package: "swift-markdown"),
29+
.product(name: "Parchment", package: "Parchment")
30+
]
31+
),
32+
.testTarget(
33+
name: "EventGenKitTests",
34+
dependencies: [
35+
"EventGenKit"
36+
]
37+
),
38+
]
39+
)

‎EventGen/README.md

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# EventGen
2+
3+
This is an experimental command line tool.
4+
Using this command line tool, you can generate event types defined using Swift from event specifications defined using natural language.
5+
6+
This tool is based on the following blog post.
7+
8+
- https://techlife.cookpad.com/entry/2020/11/05/110000
9+
- https://zenn.dev/satoshin21/articles/58e516dc7f8403
10+
11+
## Getting started
12+
13+
First, prepare the following markdown file in specific directory.
14+
In this file, write a description of the events to be sent from the application to the backend.
15+
16+
```md
17+
# impression
18+
19+
This event is automatically sent by the system when any screen is displayed．
20+
21+
## Parameters
22+
23+
- screenName
24+
- type
25+
- string
26+
- nullable
27+
- false
28+
- description
29+
- the displayed screen name
30+
- count
31+
- type
32+
- int
33+
- nullable
34+
- true
35+
- description
36+
- If this screen has been displayed in the past, indicate how many times it has been displayed
37+
38+
## Discussion
39+
40+
This event was called `shown` in the past
41+
42+
```
43+
44+
Then, execute the following command
45+
46+
```
47+
# Markdown files are located in the ./Events
48+
$ swift run eventgen prepare --inputPath ./Events --outputPath result.json
49+
$ swift run eventgen transpile --inputPath result.json --outputPath output.swift
50+
```
51+
52+
Finally, you will get the following Swift file as output.swift.
53+
54+
```swift
55+
struct GeneratedEvent: Loggable {
56+
let eventName: String
57+
let paramerters: [String: Sendasble]
58+
}
59+
60+
extension GeneratedEvent {
61+
/// This event is automatically sent by the system when any screen is displayed．
62+
/// - Parameters:
63+
/// - screenName: the displayed screen name
64+
/// - count: If this screen has been displayed in the past, indicate how many times it has been displayed
65+
static func impression(screenName: String, count: Int?) -> Self {
66+
.init(
67+
eventName: "impression",
68+
parameters: [screenName: screenName, count: count]
69+
)
70+
}
71+
}
72+
73+
```
74+
75+
This tool is experimental and may only work in certain cases.
76+
If it does not work, there may be no explanation as to why it does not work.
77+
78+
## Customization
79+
80+
Prepare subcommand generates an JSON file as shown below.
81+
Then, the transpile subcommand generates a Swift file based on the file. Therefore, it is possible to generate and transpile an JSON file by oneself without using the Prepare subcommand.
82+
For example, it is possible to generate an intermediate file from a csv or xml file.
83+
84+
```json
85+
[
86+
{
87+
"properties":[
88+
89+
],
90+
"name":"firstLaunch",
91+
"description":"Event sent when the user launches the application for the first time．",
92+
"discussion":""
93+
},
94+
{
95+
"properties":[
96+
{
97+
"nullable":false,
98+
"name":"screenName",
99+
"type":"string",
100+
"description":"the displayed screen name"
101+
},
102+
{
103+
"nullable":true,
104+
"name":"count",
105+
"type":"int",
106+
"description":"If this screen has been displayed in the past, indicate how many times it has been displayed"
107+
}
108+
],
109+
"name":"impression",
110+
"description":"This event is automatically sent by the system when any screen is displayed．",
111+
"discussion":"This event was called `shown` in the past"
112+
}
113+
]
114+
```

‎EventGen/Sources/EventGenKit/EventDefinision.swift

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
//
2+
// File.swift
3+
//
4+
//
5+
// Created by k-kohey on 2022/12/30.
6+
//
7+
8+
import Foundation
9+
10+
struct Field: Codable, Equatable {
11+
let name: String
12+
let type: String
13+
let description: String
14+
let nullable: Bool
15+
}
16+
17+
public struct EventDefinision: Codable, Equatable {
18+
let name: String
19+
let properties: [Field]
20+
let description: String
21+
let discussion: String
22+
}

‎EventGen/Sources/EventGenKit/IntermediateFileParser.swift

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
//
2+
// IntermediateFileParser.swift
3+
//
4+
//
5+
// Created by k-kohey on 2022/12/30.
6+
//
7+
8+
import Foundation
9+
import Markdown
10+
11+
public struct IntermediateFileParser {
12+
public init() {}
13+
14+
// TODO: Refactor
15+
public func parse(with source: String) -> EventDefinision {
16+
let document = Document(parsing: source)
17+
18+
19+
let sectionBlocks = document.blockChildren.split { block in
20+
block is Heading
21+
}
22+
let headings = document.blockChildren.compactMap { $0 as? Heading }
23+
24+
25+
let eventName = Array(headings)[0].plainText
26+
let eventDescription = sectionBlocks[0].compactMap { $0 as? Paragraph }
27+
.map(\.plainText).joined(separator: "\n")
28+
29+
30+
let paramertesrBlock = Array(document.blockChildren
31+
.compactMap { $0 as? UnorderedList }).first
32+
let paramerters = paramertesrBlock?.children.compactMap { $0 as? ListItem }
33+
34+
var fields: [Field] = []
35+
for paramerter in paramerters ?? [] {
36+
let paramerterName = (paramerter.child(at: 0) as! Paragraph).plainText
37+
let options = (paramerter.child(at: 1) as! UnorderedList).children.map { $0 as! ListItem }
38+
.map {
39+
let key = ($0.child(through: [
40+
(0, Paragraph.self),
41+
(0, Text.self)
42+
]) as! Text).plainText
43+
let value = ($0.child(through: [
44+
(1, UnorderedList.self),
45+
(0, ListItem.self),
46+
(0, Paragraph.self),
47+
(0, Text.self),
48+
]) as! Text).plainText
49+
50+
return [key: value]
51+
}
52+
.reduce([String: String].init(), { $0.merging($1, uniquingKeysWith: { _, last in last }) })
53+
54+
fields.append(
55+
Field(
56+
name: paramerterName,
57+
type: options["type"]!,
58+
description: options["description"]!,
59+
nullable: options["nullable"]! == "true" ? true : false
60+
)
61+
)
62+
}
63+
64+
let discussion: String
65+
if 2 < sectionBlocks.count {
66+
discussion = sectionBlocks[2]
67+
.compactMap { $0 as? Paragraph }
68+
.map(\.plainText)
69+
.joined(separator: "\n")
70+
} else {
71+
discussion = ""
72+
}
73+
74+
return EventDefinision(
75+
name: eventName,
76+
properties: fields,
77+
description: eventDescription,
78+
discussion: discussion
79+
)
80+
}
81+
}

0 commit comments

Comments
 (0)