1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
---
title: Subplot and its implementation in Rust
author: Lars Wirzenius for the Subplot project
date: 2019-10-10
...
https://subplot.liw.fi/
---
Subplot? Let me tell you a story...
---
---
Acceptance criteria are expressed as scenarios (a la Cucumber):
_given_ a system in a specific start state
_when_ user does some thing
_then_ system state has changed in the intended way
_and_ other aspect of state has stayed the same
---
FIXME: Markdown example
---
Currently only docgen exists, codegen will happen soon.
Docgen = Pandoc + Pandoc filter, in Rust
Filter modifies document during typesetting to make document more
useful for communicating acceptance criteria. Changes how code blocks
with scenario text are presented.
---
FIXME: Bindings example
---
Bindings connect the scenario step to the code that implements the
step.
Can extract parts of step to pass to the code as an argument.
Essentially, scenario step is a function call.
---
~~~~rust
use std::path::PathBuf;
use structopt::StructOpt;
#[derive(Debug, StructOpt)]
#[structopt(name = "docgen", about = "...")]
struct Opt {
// One or more input filename.
#[structopt(parse(from_os_str))]
filenames: Vec<PathBuf>,
// Set output file name.
#[structopt(short="-o", parse(from_os_str))]
output: PathBuf,
}
// in main()
let opt = Opt::from_args();
let output = format!("{}", opt.output.display());
~~~~
---
~~~~rust
fn main() -> Result<(), Box<dyn std::error::Error>> {
let mut pandoc = pandoc::new();
...
pandoc.add_filter(|json| {
pandoc_ast::filter(json, |mut doc| {
MyVisitor.walk_pandoc(&mut doc);
doc
})
});
pandoc.execute()?;
...
}
~~~~
---
~~~~rust
struct MyVisitor;
impl MutVisitor for MyVisitor {
fn visit_vec_block(&mut self, blks: &mut Vec<Block>) {
for blk in blks {
match blk {
Block::CodeBlock(attr, s) => {
if is_scenario(attr) {
*blk = typeset_scenario(s)
}
}
_ => {
self.visit_block(blk);
}
}
}
}
}
~~~~
---
~~~~rust
// Is a code block marked as a scenario snippet?
fn is_scenario(attr: &Attr) -> bool {
match attr {
(_id, classes, _kvpairs) =>
classes.iter().any(|s| is_scenario_class(s)),
}
}
fn is_scenario_class(class: &str) -> bool {
class == "subplot" || class == "subplot-scenario"
}
fn typeset_scenario(text: &str) -> Block {
Block::LineBlock(
text.lines()
.map(typeset_scenario_line)
.collect())
}
~~~~
---
~~~~rust
fn typeset_scenario_line(line: &str) -> Vec<Inline> {
let mut words = line.split_whitespace();
let mut inlines = Vec::new();
if let Some(keyword) = words.next() {
typeset_keyword(keyword, &mut inlines);
inlines.push(typeset_str(" "));
}
for word in words {
inlines.push(typeset_str(word));
inlines.push(typeset_str(" "));
}
inlines
}
~~~~
---
~~~~rust
fn typeset_keyword(word: &str, inl: &mut Vec<Inline>) {
let word = typeset_str(word);
let emph = Inline::Emph(vec![word]);
inl.push(emph);
}
fn typeset_str(s: &str) -> Inline {
Inline::Str(s.to_string())
}
~~~~
---
The Subplot project is at the very beginning (but Yarn was used for
six years). Help is welcome.
* What do you think of the concept?
* What's good?
* What's less good?
* Can you see yourself using it?
* What would it take for you to try it?
* Do you see Subplot filling a gap for you?
Expect a working version by the end of the year. Patches are welcome,
but more important now is constructive feedback, especially from
people who use Subplot, or want to.
---
Free software.
Won't affect the licensing of the outputs. OK to use for proprietary
systmes.
---
Thank you
---
This talk is licensed CC-BY-SA 4.0 (International)
|
