-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbook_test.go
More file actions
877 lines (736 loc) · 22.7 KB
/
book_test.go
File metadata and controls
877 lines (736 loc) · 22.7 KB
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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
package binder
import (
"bytes"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gopkg.in/yaml.v3"
)
func TestFrontMatter_Unmarshal(t *testing.T) {
yamlData := `
title: Benthamville
short_title: Benthamville
author: Kevin Smith
author_lastname: Smith
contact_name: Kevin Smith
contact_address: 6513 Rainbow Court
contact_city_state_zip: Raleigh, NC 27612
contact_phone: (919) 345-4521
contact_email: kevin@poiesic.com
`
var fm FrontMatter
err := yaml.Unmarshal([]byte(yamlData), &fm)
require.NoError(t, err)
assert.Equal(t, "Benthamville", fm.Title)
assert.Equal(t, "Benthamville", fm.ShortTitle)
assert.Equal(t, "Kevin Smith", fm.Author)
assert.Equal(t, "Smith", fm.AuthorLastName)
assert.Equal(t, "Kevin Smith", fm.ContactName)
assert.Equal(t, "6513 Rainbow Court", fm.ContactAddress)
assert.Equal(t, "Raleigh, NC 27612", fm.ContactCityStateZip)
assert.Equal(t, "(919) 345-4521", fm.ContactPhone)
assert.Equal(t, "kevin@poiesic.com", fm.ContactEmail)
}
func TestFrontMatter_UnmarshalFromActualYAML(t *testing.T) {
// This test uses the format from front_matter.yaml
yamlData := `
title: Benthamville
short_title: Benthamville
author: Kevin Smith
author_lastname: Smith
contact_name: Kevin Smith
contact_address: 6513 Rainbow Court
contact_city_state_zip: Raleigh, NC 27612
contact_phone: (919) 345-4521
contact_email: kevin@poiesic.com
`
var fm FrontMatter
err := yaml.Unmarshal([]byte(yamlData), &fm)
require.NoError(t, err)
assert.Equal(t, "Benthamville", fm.Title)
assert.Equal(t, "Benthamville", fm.ShortTitle)
assert.Equal(t, "Kevin Smith", fm.Author)
assert.Equal(t, "Smith", fm.AuthorLastName, "AuthorLastName should be populated from author_lastname")
assert.Equal(t, "Kevin Smith", fm.ContactName)
assert.Equal(t, "6513 Rainbow Court", fm.ContactAddress)
assert.Equal(t, "Raleigh, NC 27612", fm.ContactCityStateZip)
assert.Equal(t, "(919) 345-4521", fm.ContactPhone)
assert.Equal(t, "kevin@poiesic.com", fm.ContactEmail)
}
func TestFrontMatter_EmptyFields(t *testing.T) {
yamlData := `title: Test Book`
var fm FrontMatter
err := yaml.Unmarshal([]byte(yamlData), &fm)
require.NoError(t, err)
assert.Equal(t, "Test Book", fm.Title)
assert.Empty(t, fm.ShortTitle)
assert.Empty(t, fm.Author)
assert.Empty(t, fm.AuthorLastName)
assert.Empty(t, fm.ContactName)
assert.Empty(t, fm.ContactAddress)
assert.Empty(t, fm.ContactCityStateZip)
assert.Empty(t, fm.ContactPhone)
assert.Empty(t, fm.ContactEmail)
}
func TestFrontMatter_PartialFields(t *testing.T) {
yamlData := `
title: My Novel
author: Jane Doe
contact_email: jane@example.com
`
var fm FrontMatter
err := yaml.Unmarshal([]byte(yamlData), &fm)
require.NoError(t, err)
assert.Equal(t, "My Novel", fm.Title)
assert.Empty(t, fm.ShortTitle)
assert.Equal(t, "Jane Doe", fm.Author)
assert.Empty(t, fm.AuthorLastName)
assert.Empty(t, fm.ContactName)
assert.Empty(t, fm.ContactAddress)
assert.Empty(t, fm.ContactCityStateZip)
assert.Empty(t, fm.ContactPhone)
assert.Equal(t, "jane@example.com", fm.ContactEmail)
}
func TestBook_Unmarshal(t *testing.T) {
// Test basic Book unmarshaling with proper YAML structure
yamlData := `
base_dir: "manuscript"
chapters:
- scenes:
- "chapter1_scene1"
- "chapter1_scene2"
- scenes:
- "chapter2_scene1"
`
var book Book
err := yaml.Unmarshal([]byte(yamlData), &book)
require.NoError(t, err)
assert.Equal(t, "manuscript", book.BaseDir)
require.Len(t, book.Chapters, 2)
assert.Equal(t, []string{"chapter1_scene1", "chapter1_scene2"}, book.Chapters[0].Scenes)
assert.Equal(t, []string{"chapter2_scene1"}, book.Chapters[1].Scenes)
}
func TestBook_UnmarshalFromActualYAML(t *testing.T) {
// This mimics the actual book.yaml format with top-level "book:" key
// Note: The actual YAML has duplicate "chapter:" keys which is invalid YAML
// Standard YAML parsers will only keep the last duplicate key
yamlData := `
book:
base_dir: "testdata/manuscript"
chapters:
- scenes:
- "foo"
- "baz"
- scenes:
- "bar"
- "quux"
`
// Need a wrapper struct for the top-level "book:" key
type BookFile struct {
Book Book `yaml:"book"`
}
var bf BookFile
err := yaml.Unmarshal([]byte(yamlData), &bf)
require.NoError(t, err)
assert.Equal(t, "testdata/manuscript", bf.Book.BaseDir)
require.Len(t, bf.Book.Chapters, 2)
assert.Equal(t, []string{"foo", "baz"}, bf.Book.Chapters[0].Scenes)
assert.Equal(t, []string{"bar", "quux"}, bf.Book.Chapters[1].Scenes)
}
func TestChapter_Unmarshal(t *testing.T) {
yamlData := `
scenes:
- "opening"
- "conflict"
- "resolution"
`
var ch Chapter
err := yaml.Unmarshal([]byte(yamlData), &ch)
require.NoError(t, err)
require.Len(t, ch.Scenes, 3)
assert.Equal(t, "opening", ch.Scenes[0])
assert.Equal(t, "conflict", ch.Scenes[1])
assert.Equal(t, "resolution", ch.Scenes[2])
}
func TestChapter_EmptyScenes(t *testing.T) {
yamlData := `scenes: []`
var ch Chapter
err := yaml.Unmarshal([]byte(yamlData), &ch)
require.NoError(t, err)
assert.Empty(t, ch.Scenes)
}
func TestBook_EmptyChapters(t *testing.T) {
yamlData := `
base_dir: "manuscript"
chapters: []
`
var book Book
err := yaml.Unmarshal([]byte(yamlData), &book)
require.NoError(t, err)
assert.Equal(t, "manuscript", book.BaseDir)
assert.Empty(t, book.Chapters)
}
func TestBook_CurrentYAMLFormat_DuplicateKeysAreInvalid(t *testing.T) {
// This test documents that the current book.yaml format is INVALID YAML.
// Duplicate "chapter:" keys cause a parse error in yaml.v3
yamlData := `
book:
base_dir: "testdata/manuscript"
chapter:
- "foo"
- "baz"
chapter:
- "bar"
- "quux"
`
type BookFile struct {
Book Book `yaml:"book"`
}
var bf BookFile
err := yaml.Unmarshal([]byte(yamlData), &bf)
require.Error(t, err, "Duplicate YAML keys should cause a parse error")
assert.Contains(t, err.Error(), "already defined")
}
func TestBook_CorrectYAMLFormat(t *testing.T) {
// This test shows the CORRECT YAML format that works with the Book struct
yamlData := `
book:
base_dir: "testdata/manuscript"
chapters:
- scenes:
- "foo"
- "baz"
- scenes:
- "bar"
- "quux"
`
type BookFile struct {
Book Book `yaml:"book"`
}
var bf BookFile
err := yaml.Unmarshal([]byte(yamlData), &bf)
require.NoError(t, err)
assert.Equal(t, "testdata/manuscript", bf.Book.BaseDir)
require.Len(t, bf.Book.Chapters, 2)
assert.Equal(t, []string{"foo", "baz"}, bf.Book.Chapters[0].Scenes)
assert.Equal(t, []string{"bar", "quux"}, bf.Book.Chapters[1].Scenes)
}
func TestCombinedYAML_MultiDocument(t *testing.T) {
// Combined YAML uses multi-document format with --- separators
// First document: FrontMatter
// Second document: Book (wrapped in "book:" key)
yamlData := `---
title: Benthamville
short_title: Benthamville
author: Kevin Smith
author_lastname: Smith
contact_name: Kevin Smith
contact_address: 6513 Rainbow Court
contact_city_state_zip: Raleigh, NC 27612
contact_phone: (919) 345-4521
contact_email: kevin@poiesic.com
---
book:
base_dir: "testdata/manuscript"
chapters:
- scenes:
- "foo"
- "baz"
- scenes:
- "bar"
- "quux"
`
decoder := yaml.NewDecoder(bytes.NewReader([]byte(yamlData)))
// Decode first document: FrontMatter
var fm FrontMatter
err := decoder.Decode(&fm)
require.NoError(t, err)
assert.Equal(t, "Benthamville", fm.Title)
assert.Equal(t, "Benthamville", fm.ShortTitle)
assert.Equal(t, "Kevin Smith", fm.Author)
assert.Equal(t, "Smith", fm.AuthorLastName)
assert.Equal(t, "Kevin Smith", fm.ContactName)
assert.Equal(t, "6513 Rainbow Court", fm.ContactAddress)
assert.Equal(t, "Raleigh, NC 27612", fm.ContactCityStateZip)
assert.Equal(t, "(919) 345-4521", fm.ContactPhone)
assert.Equal(t, "kevin@poiesic.com", fm.ContactEmail)
// Decode second document: Book
type BookFile struct {
Book Book `yaml:"book"`
}
var bf BookFile
err = decoder.Decode(&bf)
require.NoError(t, err)
assert.Equal(t, "testdata/manuscript", bf.Book.BaseDir)
require.Len(t, bf.Book.Chapters, 2)
assert.Equal(t, []string{"foo", "baz"}, bf.Book.Chapters[0].Scenes)
assert.Equal(t, []string{"bar", "quux"}, bf.Book.Chapters[1].Scenes)
}
func TestCombinedYAML_EmptyDocuments(t *testing.T) {
// Test handling when one document is minimal
yamlData := `---
title: Minimal Book
---
book:
base_dir: "src"
chapters: []
`
decoder := yaml.NewDecoder(bytes.NewReader([]byte(yamlData)))
var fm FrontMatter
err := decoder.Decode(&fm)
require.NoError(t, err)
assert.Equal(t, "Minimal Book", fm.Title)
assert.Empty(t, fm.Author)
var bf BookSpec
err = decoder.Decode(&bf)
require.NoError(t, err)
assert.Equal(t, "src", bf.Book.BaseDir)
assert.Empty(t, bf.Book.Chapters)
}
// LoadBook tests
func TestLoadBook_Success(t *testing.T) {
fm, book, err := LoadBook("testdata/valid_book.yaml")
require.NoError(t, err)
require.NotNil(t, fm)
require.NotNil(t, book)
// Verify FrontMatter
assert.Equal(t, "Test Book", fm.Title)
assert.Equal(t, "Test", fm.ShortTitle)
assert.Equal(t, "Test Author", fm.Author)
assert.Equal(t, "Author", fm.AuthorLastName)
assert.Equal(t, "Test Contact", fm.ContactName)
assert.Equal(t, "123 Test St", fm.ContactAddress)
assert.Equal(t, "Test City, TS 12345", fm.ContactCityStateZip)
assert.Equal(t, "(555) 123-4567", fm.ContactPhone)
assert.Equal(t, "test@example.com", fm.ContactEmail)
// Verify Book - now has 4 chapters (2 interludes + 2 regular chapters)
assert.Equal(t, "testdata/manuscript", book.BaseDir)
require.Len(t, book.Chapters, 4)
// Interlude 1
assert.True(t, book.Chapters[0].Interlude)
assert.Equal(t, []string{"interlude1"}, book.Chapters[0].Scenes)
// Chapter 1
assert.False(t, book.Chapters[1].Interlude)
assert.Equal(t, []string{"foo", "baz"}, book.Chapters[1].Scenes)
// Interlude 2
assert.True(t, book.Chapters[2].Interlude)
assert.Equal(t, []string{"interlude2"}, book.Chapters[2].Scenes)
// Chapter 2
assert.False(t, book.Chapters[3].Interlude)
assert.Equal(t, []string{"bar", "quux"}, book.Chapters[3].Scenes)
}
func TestLoadBook_FileNotFound(t *testing.T) {
fm, book, err := LoadBook("testdata/nonexistent.yaml")
require.Error(t, err)
assert.Nil(t, fm)
assert.Nil(t, book)
assert.Contains(t, err.Error(), "no such file")
}
func TestLoadBook_InvalidFrontMatter(t *testing.T) {
fm, book, err := LoadBook("testdata/invalid_frontmatter.yaml")
require.Error(t, err)
assert.Nil(t, fm)
assert.Nil(t, book)
}
func TestLoadBook_InvalidBook(t *testing.T) {
fm, book, err := LoadBook("testdata/invalid_book.yaml")
require.Error(t, err)
assert.Nil(t, fm)
assert.Nil(t, book)
}
// Book.GetChapters tests
func TestBook_GetChapters_AutoGeneratedNames(t *testing.T) {
book := &Book{
BaseDir: "manuscript",
Chapters: []Chapter{
{Scenes: []string{"scene1", "scene2"}},
{Scenes: []string{"scene3"}},
{Scenes: []string{"scene4", "scene5", "scene6"}},
},
}
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 3)
// Verify auto-generated chapter names use num2words with title case
assert.Equal(t, "Chapter One", chapters[0].Heading)
assert.Equal(t, "Chapter Two", chapters[1].Heading)
assert.Equal(t, "Chapter Three", chapters[2].Heading)
// Verify scene paths
assert.Equal(t, []string{"manuscript/scene1.md", "manuscript/scene2.md"}, chapters[0].Scenes)
assert.Equal(t, []string{"manuscript/scene3.md"}, chapters[1].Scenes)
assert.Equal(t, []string{"manuscript/scene4.md", "manuscript/scene5.md", "manuscript/scene6.md"}, chapters[2].Scenes)
}
func TestBook_GetChapters_CustomNames(t *testing.T) {
book := &Book{
BaseDir: "manuscript",
Chapters: []Chapter{
{Name: "Prologue", Scenes: []string{"intro"}},
{Scenes: []string{"middle"}},
{Name: "Epilogue", Scenes: []string{"outro"}},
},
}
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 3)
// Custom names should be used when provided (title-cased)
assert.Equal(t, "Prologue", chapters[0].Heading)
// Unnamed chapters get auto-generated names, but the counter only increments for unnamed
assert.Equal(t, "Chapter One", chapters[1].Heading)
assert.Equal(t, "Epilogue", chapters[2].Heading)
}
func TestBook_GetChapters_WithSubdirs(t *testing.T) {
book := &Book{
BaseDir: "base",
Chapters: []Chapter{
{Subdir: "part1", Scenes: []string{"scene1", "scene2"}},
{Subdir: "part2", Scenes: []string{"scene3"}},
{Scenes: []string{"scene4"}}, // No subdir, uses base_dir directly
},
}
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 3)
// Verify paths include subdirs when specified
assert.Equal(t, []string{"base/part1/scene1.md", "base/part1/scene2.md"}, chapters[0].Scenes)
assert.Equal(t, []string{"base/part2/scene3.md"}, chapters[1].Scenes)
assert.Equal(t, []string{"base/scene4.md"}, chapters[2].Scenes)
}
func TestBook_GetChapters_EmptyChapters(t *testing.T) {
book := &Book{
BaseDir: "manuscript",
Chapters: []Chapter{},
}
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
assert.Empty(t, chapters)
}
func TestBook_GetChapters_EmptyScenes(t *testing.T) {
book := &Book{
BaseDir: "manuscript",
Chapters: []Chapter{
{Scenes: []string{}},
},
}
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 1)
assert.Equal(t, "Chapter One", chapters[0].Heading)
assert.Empty(t, chapters[0].Scenes)
}
func TestBook_GetChapters_EarlyTermination(t *testing.T) {
book := &Book{
BaseDir: "manuscript",
Chapters: []Chapter{
{Scenes: []string{"scene1"}},
{Scenes: []string{"scene2"}},
{Scenes: []string{"scene3"}},
{Scenes: []string{"scene4"}},
},
}
// Only collect first 2 chapters to test early termination
var chapters []IteratedChapter
count := 0
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
count++
if count >= 2 {
break
}
}
require.Len(t, chapters, 2)
assert.Equal(t, "Chapter One", chapters[0].Heading)
assert.Equal(t, "Chapter Two", chapters[1].Heading)
}
func TestBook_GetChapters_LoadedFromFile(t *testing.T) {
fm, book, err := LoadBook("testdata/book_with_named_chapters.yaml")
require.NoError(t, err)
require.NotNil(t, fm)
require.NotNil(t, book)
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 3)
assert.Equal(t, "Prologue", chapters[0].Heading)
assert.Equal(t, "Chapter One", chapters[1].Heading)
assert.Equal(t, "Epilogue", chapters[2].Heading)
assert.Equal(t, []string{"testdata/manuscript/foo.md"}, chapters[0].Scenes)
assert.Equal(t, []string{"testdata/manuscript/bar.md", "testdata/manuscript/baz.md"}, chapters[1].Scenes)
assert.Equal(t, []string{"testdata/manuscript/quux.md"}, chapters[2].Scenes)
}
// IteratedChapter.Validate tests
func TestIteratedChapter_Validate_AllScenesExist(t *testing.T) {
ic := IteratedChapter{
Heading: "Chapter one",
Scenes: []string{
"testdata/manuscript/foo.md",
"testdata/manuscript/bar.md",
},
}
err := ic.Validate()
assert.NoError(t, err)
}
func TestIteratedChapter_Validate_EmptyScenes(t *testing.T) {
ic := IteratedChapter{
Heading: "Empty Chapter",
Scenes: []string{},
}
err := ic.Validate()
assert.NoError(t, err)
}
func TestIteratedChapter_Validate_SceneNotFound(t *testing.T) {
ic := IteratedChapter{
Heading: "Chapter one",
Scenes: []string{
"testdata/manuscript/foo.md",
"testdata/manuscript/nonexistent.md",
},
}
err := ic.Validate()
require.Error(t, err)
assert.Contains(t, err.Error(), "no such file")
}
func TestIteratedChapter_Validate_FirstSceneNotFound(t *testing.T) {
ic := IteratedChapter{
Heading: "Chapter one",
Scenes: []string{
"testdata/manuscript/nonexistent.md",
"testdata/manuscript/foo.md",
},
}
err := ic.Validate()
require.Error(t, err)
assert.Contains(t, err.Error(), "no such file")
}
func TestIteratedChapter_Validate_AllScenesNotFound(t *testing.T) {
ic := IteratedChapter{
Heading: "Chapter one",
Scenes: []string{
"testdata/manuscript/missing1.md",
"testdata/manuscript/missing2.md",
},
}
err := ic.Validate()
require.Error(t, err)
assert.Contains(t, err.Error(), "no such file")
}
func TestIteratedChapter_Validate_IntegrationWithLoadBook(t *testing.T) {
_, book, err := LoadBook("testdata/valid_book.yaml")
require.NoError(t, err)
for ch := range book.GetChapters() {
err := ch.Validate()
assert.NoError(t, err, "chapter %q should have all valid scenes", ch.Heading)
}
}
// Interlude tests
func TestChapter_UnmarshalWithInterlude(t *testing.T) {
yamlData := `
interlude: true
scenes:
- "interlude1"
`
var ch Chapter
err := yaml.Unmarshal([]byte(yamlData), &ch)
require.NoError(t, err)
assert.True(t, ch.Interlude)
assert.Empty(t, ch.Name)
require.Len(t, ch.Scenes, 1)
assert.Equal(t, "interlude1", ch.Scenes[0])
}
func TestChapter_UnmarshalWithoutInterlude(t *testing.T) {
yamlData := `
scenes:
- "scene1"
`
var ch Chapter
err := yaml.Unmarshal([]byte(yamlData), &ch)
require.NoError(t, err)
assert.False(t, ch.Interlude)
}
func TestChapter_InterludeWithName(t *testing.T) {
// An interlude can have a custom name
yamlData := `
interlude: true
name: "A Brief Pause"
scenes:
- "pause"
`
var ch Chapter
err := yaml.Unmarshal([]byte(yamlData), &ch)
require.NoError(t, err)
assert.True(t, ch.Interlude)
assert.Equal(t, "A Brief Pause", ch.Name)
}
func TestBook_GetChapters_InterludesDoNotIncrementChapterNumber(t *testing.T) {
book := &Book{
BaseDir: "manuscript",
Chapters: []Chapter{
{Interlude: true, Scenes: []string{"interlude1"}},
{Scenes: []string{"scene1"}},
{Interlude: true, Scenes: []string{"interlude2"}},
{Scenes: []string{"scene2"}},
},
}
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 4)
// First interlude has no heading
assert.Empty(t, chapters[0].Heading, "interlude should have empty heading")
// First regular chapter should be "Chapter One"
assert.Equal(t, "Chapter One", chapters[1].Heading)
// Second interlude has no heading
assert.Empty(t, chapters[2].Heading, "interlude should have empty heading")
// Second regular chapter should be "Chapter Two" (not Three)
assert.Equal(t, "Chapter Two", chapters[3].Heading)
}
func TestBook_GetChapters_InterludeWithCustomName(t *testing.T) {
book := &Book{
BaseDir: "manuscript",
Chapters: []Chapter{
{Scenes: []string{"scene1"}},
{Interlude: true, Name: "intermission", Scenes: []string{"break"}},
{Scenes: []string{"scene2"}},
},
}
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 3)
assert.Equal(t, "Chapter One", chapters[0].Heading)
// Interlude with custom name uses that name (title-cased)
assert.Equal(t, "Intermission", chapters[1].Heading)
assert.Equal(t, "Chapter Two", chapters[2].Heading)
}
func TestBook_GetChapters_ConsecutiveInterludes(t *testing.T) {
book := &Book{
BaseDir: "manuscript",
Chapters: []Chapter{
{Interlude: true, Scenes: []string{"interlude1"}},
{Interlude: true, Scenes: []string{"interlude2"}},
{Scenes: []string{"scene1"}},
},
}
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 3)
assert.Empty(t, chapters[0].Heading)
assert.Empty(t, chapters[1].Heading)
assert.Equal(t, "Chapter One", chapters[2].Heading)
}
func TestBook_GetChapters_AllInterludes(t *testing.T) {
book := &Book{
BaseDir: "manuscript",
Chapters: []Chapter{
{Interlude: true, Scenes: []string{"interlude1"}},
{Interlude: true, Scenes: []string{"interlude2"}},
},
}
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 2)
assert.Empty(t, chapters[0].Heading)
assert.Empty(t, chapters[1].Heading)
}
func TestBook_GetChapters_InterludeAtEnd(t *testing.T) {
book := &Book{
BaseDir: "manuscript",
Chapters: []Chapter{
{Scenes: []string{"scene1"}},
{Scenes: []string{"scene2"}},
{Interlude: true, Scenes: []string{"epilogue_interlude"}},
},
}
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 3)
assert.Equal(t, "Chapter One", chapters[0].Heading)
assert.Equal(t, "Chapter Two", chapters[1].Heading)
assert.Empty(t, chapters[2].Heading)
}
func TestIteratedChapter_HeadingToFilename_Interlude(t *testing.T) {
ic := IteratedChapter{
Heading: "",
Scenes: []string{"scene.md"},
}
assert.Equal(t, "interlude", ic.HeadingToFilename())
}
func TestIteratedChapter_HeadingToFilename_RegularChapter(t *testing.T) {
ic := IteratedChapter{
Heading: "Chapter One",
Scenes: []string{"scene.md"},
}
assert.Equal(t, "chapter-one", ic.HeadingToFilename())
}
func TestIteratedChapter_HeadingToFilename_CustomName(t *testing.T) {
ic := IteratedChapter{
Heading: "The Beginning",
Scenes: []string{"scene.md"},
}
assert.Equal(t, "the-beginning", ic.HeadingToFilename())
}
func TestBook_GetChapters_InterludeWithSubdir(t *testing.T) {
book := &Book{
BaseDir: "base",
Chapters: []Chapter{
{Interlude: true, Subdir: "interludes", Scenes: []string{"pause1"}},
{Subdir: "chapters", Scenes: []string{"ch1"}},
},
}
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 2)
assert.Equal(t, []string{"base/interludes/pause1.md"}, chapters[0].Scenes)
assert.Equal(t, []string{"base/chapters/ch1.md"}, chapters[1].Scenes)
}
func TestLoadBook_WithInterludes(t *testing.T) {
fm, book, err := LoadBook("testdata/valid_book.yaml")
require.NoError(t, err)
require.NotNil(t, fm)
require.NotNil(t, book)
// valid_book.yaml has 4 chapters: interlude, chapter, interlude, chapter
require.Len(t, book.Chapters, 4)
assert.True(t, book.Chapters[0].Interlude)
assert.False(t, book.Chapters[1].Interlude)
assert.True(t, book.Chapters[2].Interlude)
assert.False(t, book.Chapters[3].Interlude)
}
func TestBook_GetChapters_InterleavedInterludes_Integration(t *testing.T) {
_, book, err := LoadBook("testdata/valid_book.yaml")
require.NoError(t, err)
var chapters []IteratedChapter
for ch := range book.GetChapters() {
chapters = append(chapters, ch)
}
require.Len(t, chapters, 4)
// Interlude 1 - no heading
assert.Empty(t, chapters[0].Heading)
assert.Contains(t, chapters[0].Scenes[0], "interlude1.md")
// Chapter 1 - should be "Chapter One"
assert.Equal(t, "Chapter One", chapters[1].Heading)
// Interlude 2 - no heading
assert.Empty(t, chapters[2].Heading)
assert.Contains(t, chapters[2].Scenes[0], "interlude2.md")
// Chapter 2 - should be "Chapter Two"
assert.Equal(t, "Chapter Two", chapters[3].Heading)
}