doing-plugins 0.3.1

Export and import plugins for the doing CLI
Documentation
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
use std::collections::BTreeMap;

use chrono::Local;
use doing_config::Config;
use doing_taskpaper::Entry;
use doing_template::renderer::RenderOptions;
use serde::Serialize;

use crate::{ExportPlugin, Plugin, PluginSettings, helpers};

/// Day format for grouping entries by day.
const DAY_GROUP_FORMAT: &str = "%Y-%m-%d";

/// Date format for Day One entries.
const DAYONE_DATE_FORMAT: &str = "%Y-%m-%d %H:%M:%S %z";

/// Export plugin that renders entries in Day One format, grouped by day.
///
/// Same behavior as `dayone` — one journal entry per day.
pub struct DayoneDaysExport;

impl ExportPlugin for DayoneDaysExport {
  fn render(&self, entries: &[Entry], options: &RenderOptions, config: &Config) -> String {
    DayoneExport.render(entries, options, config)
  }
}

impl Plugin for DayoneDaysExport {
  fn name(&self) -> &str {
    "dayone-days"
  }

  fn settings(&self) -> PluginSettings {
    PluginSettings {
      trigger: "dayone[_-]?days".into(),
    }
  }
}

/// Export plugin that renders entries in Day One format, one journal entry per doing entry.
pub struct DayoneEntriesExport;

impl ExportPlugin for DayoneEntriesExport {
  fn render(&self, entries: &[Entry], _options: &RenderOptions, config: &Config) -> String {
    let dayone_entries: Vec<DayoneEntry> = entries.iter().map(|e| render_single_entry(e, config)).collect();

    serde_json::to_string_pretty(&DayoneExportData {
      entries: dayone_entries,
    })
    .unwrap_or_else(|_| "{}".into())
  }
}

impl Plugin for DayoneEntriesExport {
  fn name(&self) -> &str {
    "dayone-entries"
  }

  fn settings(&self) -> PluginSettings {
    PluginSettings {
      trigger: "dayone[_-]?entr(?:y|ies)".into(),
    }
  }
}

/// Export plugin that renders entries in Day One journal format, one entry per day.
///
/// Entries are grouped by date and rendered as a single journal entry per day,
/// matching the behavior of Ruby doing's `dayone` output.
pub struct DayoneExport;

impl ExportPlugin for DayoneExport {
  fn render(&self, entries: &[Entry], _options: &RenderOptions, config: &Config) -> String {
    let grouped = group_by_day(entries);
    let dayone_entries: Vec<DayoneEntry> = grouped
      .into_iter()
      .map(|(day, items)| render_day_entry(&day, &items, config))
      .collect();

    serde_json::to_string_pretty(&DayoneExportData {
      entries: dayone_entries,
    })
    .unwrap_or_else(|_| "{}".into())
  }
}

impl Plugin for DayoneExport {
  fn name(&self) -> &str {
    "dayone"
  }

  fn settings(&self) -> PluginSettings {
    PluginSettings {
      trigger: "dayone$|day_?one$".into(),
    }
  }
}

/// A single Day One journal entry.
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct DayoneEntry {
  creation_date: String,
  tags: Vec<String>,
  text: String,
}

/// Top-level Day One export structure.
#[derive(Serialize)]
struct DayoneExportData {
  entries: Vec<DayoneEntry>,
}

/// Get the earliest date from a list of entries.
fn earliest_date(entries: &[&Entry]) -> String {
  entries
    .iter()
    .map(|e| e.date())
    .min()
    .unwrap_or_else(Local::now)
    .format(DAYONE_DATE_FORMAT)
    .to_string()
}

/// Append note lines from an entry to a text buffer, each indented and newline-terminated.
fn render_note_lines(entry: &Entry, indent: &str, text: &mut String) {
  for line in entry.note().lines().iter() {
    text.push_str(&format!("{indent}{}\n", line.trim()));
  }
}

/// Group entries by their date (day portion).
fn group_by_day(entries: &[Entry]) -> Vec<(String, Vec<&Entry>)> {
  let mut groups: BTreeMap<String, Vec<&Entry>> = BTreeMap::new();
  for entry in entries {
    let day = entry.date().format(DAY_GROUP_FORMAT).to_string();
    groups.entry(day).or_default().push(entry);
  }
  groups.into_iter().collect()
}

/// Render a group of entries for a single day into a Day One entry.
fn render_day_entry(day: &str, entries: &[&Entry], config: &Config) -> DayoneEntry {
  let mut text = format!("# {day}\n\n");
  let mut all_tags: Vec<String> = Vec::new();

  for entry in entries {
    text.push_str(&format!("* **{}**", entry.title()));

    if let Some(interval_str) = helpers::format_interval(entry, config) {
      text.push_str(&format!(" ({interval_str})"));
    }

    text.push('\n');
    render_note_lines(entry, "  ", &mut text);

    for tag in entry.tags().iter() {
      if tag.name() != "done" && !all_tags.iter().any(|t| t.eq_ignore_ascii_case(tag.name())) {
        all_tags.push(tag.name().to_string());
      }
    }
  }

  let creation_date = earliest_date(entries);

  DayoneEntry {
    creation_date,
    tags: all_tags,
    text,
  }
}

/// Render a single entry as a Day One entry.
fn render_single_entry(entry: &Entry, config: &Config) -> DayoneEntry {
  let mut text = format!("**{}**", entry.title());

  if let Some(interval_str) = helpers::format_interval(entry, config) {
    text.push_str(&format!(" ({interval_str})"));
  }

  text.push('\n');

  if !entry.note().is_empty() {
    text.push('\n');
    render_note_lines(entry, "", &mut text);
  }

  let tags: Vec<String> = entry
    .tags()
    .iter()
    .filter(|t| t.name() != "done")
    .map(|t| t.name().to_string())
    .collect();

  DayoneEntry {
    creation_date: entry.date().format(DAYONE_DATE_FORMAT).to_string(),
    tags,
    text,
  }
}

#[cfg(test)]
mod test {
  use doing_taskpaper::{Note, Tag, Tags};

  use super::*;
  use crate::test_helpers::{sample_date, sample_options};

  mod dayone_entries_export_name {
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn it_returns_dayone_entries() {
      assert_eq!(DayoneEntriesExport.name(), "dayone-entries");
    }
  }

  mod dayone_entries_export_render {
    use super::*;

    #[test]
    fn it_renders_one_entry_per_doing_entry() {
      let config = Config::default();
      let options = sample_options();
      let entries = vec![
        Entry::new(
          sample_date(17, 14, 0),
          "Task A",
          Tags::new(),
          Note::new(),
          "Currently",
          None::<String>,
        ),
        Entry::new(
          sample_date(17, 15, 0),
          "Task B",
          Tags::new(),
          Note::new(),
          "Currently",
          None::<String>,
        ),
      ];

      let output = DayoneEntriesExport.render(&entries, &options, &config);
      let parsed: serde_json::Value = serde_json::from_str(&output).unwrap();
      let dayone_entries = parsed["entries"].as_array().unwrap();

      assert_eq!(dayone_entries.len(), 2);
      assert!(dayone_entries[0]["text"].as_str().unwrap().contains("Task A"));
      assert!(dayone_entries[1]["text"].as_str().unwrap().contains("Task B"));
    }
  }

  mod dayone_entries_export_settings {
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn it_returns_dayone_entries_trigger() {
      let settings = DayoneEntriesExport.settings();

      assert_eq!(settings.trigger, "dayone[_-]?entr(?:y|ies)");
    }
  }

  mod dayone_export_name {
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn it_returns_dayone() {
      assert_eq!(DayoneExport.name(), "dayone");
    }
  }

  mod dayone_export_render {
    use super::*;

    #[test]
    fn it_renders_empty_entries() {
      let config = Config::default();
      let options = sample_options();

      let output = DayoneExport.render(&[], &options, &config);
      let parsed: serde_json::Value = serde_json::from_str(&output).unwrap();

      assert!(parsed["entries"].as_array().unwrap().is_empty());
    }

    #[test]
    fn it_groups_entries_by_day() {
      let config = Config::default();
      let options = sample_options();
      let entries = vec![
        Entry::new(
          sample_date(17, 14, 0),
          "Day 17 task",
          Tags::new(),
          Note::new(),
          "Currently",
          None::<String>,
        ),
        Entry::new(
          sample_date(18, 10, 0),
          "Day 18 task",
          Tags::new(),
          Note::new(),
          "Currently",
          None::<String>,
        ),
        Entry::new(
          sample_date(17, 16, 0),
          "Day 17 second task",
          Tags::new(),
          Note::new(),
          "Currently",
          None::<String>,
        ),
      ];

      let output = DayoneExport.render(&entries, &options, &config);
      let parsed: serde_json::Value = serde_json::from_str(&output).unwrap();
      let dayone_entries = parsed["entries"].as_array().unwrap();

      assert_eq!(dayone_entries.len(), 2);
      let text_day17 = dayone_entries[0]["text"].as_str().unwrap();
      assert!(text_day17.contains("Day 17 task"));
      assert!(text_day17.contains("Day 17 second task"));
    }

    #[test]
    fn it_renders_entries_with_tags() {
      let config = Config::default();
      let options = sample_options();
      let entry = Entry::new(
        sample_date(17, 14, 0),
        "Working",
        Tags::from_iter(vec![Tag::new("coding", None::<String>)]),
        Note::new(),
        "Currently",
        None::<String>,
      );

      let output = DayoneExport.render(&[entry], &options, &config);
      let parsed: serde_json::Value = serde_json::from_str(&output).unwrap();
      let tags = parsed["entries"][0]["tags"].as_array().unwrap();

      assert!(tags.iter().any(|t| t == "coding"));
    }

    #[test]
    fn it_renders_valid_json() {
      let config = Config::default();
      let options = sample_options();
      let entry = Entry::new(
        sample_date(17, 14, 0),
        "Task with \"quotes\"",
        Tags::new(),
        Note::new(),
        "Currently",
        None::<String>,
      );

      let output = DayoneExport.render(&[entry], &options, &config);

      assert!(serde_json::from_str::<serde_json::Value>(&output).is_ok());
    }
  }

  mod dayone_export_settings {
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn it_returns_dayone_trigger() {
      let settings = DayoneExport.settings();

      assert_eq!(settings.trigger, "dayone$|day_?one$");
    }
  }

  mod earliest_date {
    use super::*;

    #[test]
    fn it_returns_earliest_entry_date() {
      let entries = vec![
        Entry::new(
          sample_date(17, 15, 0),
          "Later",
          Tags::new(),
          Note::new(),
          "Currently",
          None::<String>,
        ),
        Entry::new(
          sample_date(17, 10, 0),
          "Earlier",
          Tags::new(),
          Note::new(),
          "Currently",
          None::<String>,
        ),
      ];
      let refs: Vec<&Entry> = entries.iter().collect();

      let result = super::super::earliest_date(&refs);

      assert!(result.contains("10:00:00"));
    }
  }

  mod group_by_day {
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn it_groups_entries_by_date() {
      let entries = vec![
        Entry::new(
          sample_date(17, 14, 0),
          "A",
          Tags::new(),
          Note::new(),
          "Currently",
          None::<String>,
        ),
        Entry::new(
          sample_date(18, 10, 0),
          "B",
          Tags::new(),
          Note::new(),
          "Currently",
          None::<String>,
        ),
        Entry::new(
          sample_date(17, 16, 0),
          "C",
          Tags::new(),
          Note::new(),
          "Currently",
          None::<String>,
        ),
      ];

      let groups = super::super::group_by_day(&entries);

      assert_eq!(groups.len(), 2);
      assert_eq!(groups[0].0, "2024-03-17");
      assert_eq!(groups[0].1.len(), 2);
      assert_eq!(groups[1].0, "2024-03-18");
      assert_eq!(groups[1].1.len(), 1);
    }
  }
}