Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for Singers instructions #4

Merged
merged 3 commits into from
Feb 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 42 additions & 31 deletions tests/test_patterns.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,18 @@

def pytest_generate_tests(metafunc: pytest.Metafunc):
metafunc.parametrize(
'case',
getattr(metafunc.cls, metafunc.function.__name__.replace('test_', ''), []),
scope='class'
"case",
getattr(metafunc.cls, metafunc.function.__name__.replace("test_", ""), []),
scope="class",
)


class Base:
@property
def pattern(self) -> re.Pattern:
return re.compile(getattr(patterns, self.__class__.__name__.replace('Test', '').upper()))
return re.compile(
getattr(patterns, self.__class__.__name__.replace("Test", "").upper())
)

def test_matches(self, case: str):
assert self.pattern.match(case)
Expand All @@ -27,73 +29,82 @@ def test_failures(self, case: str):

class TestChord(Base):
matches = [
'(C)',
'(C#)',
'(Cb)',
'(Dm)',
"(C)",
"(C#)",
"(Cb)",
"(Dm)",
]
failures = [
'(H)',
"(H)",
]


class TestHyphens(Base):
matches = [
'-',
'- ',
' -',
' - ',
'—',
"-",
"- ",
" -",
" - ",
"—",
]
failures = [
'_',
"_",
]


class TestVox(Base):
matches = [
'(I can mash potato)',
'(I can (Bb)mash po(C)tato)',
"(I can mash potato)",
"(I can (Bb)mash po(C)tato)",
"""(G) I'll be (C)there for (D)you (when the rain starts to
(G)Pour) I'll be (C)there for (D)you (like I've been there
Be(G)fore) I'll be (C)there for (D)you ('Cause you're there for me (F)too)""",
]


class TestNotes(Base):
matches = [
'{repeat x2}',
'{demented choir noises}',
"{repeat x2}",
"{demented choir noises}",
]


class TestBox(Base):
matches = [
'| {repeat x2}',
"| {repeat x2}",
# New paragraph within box?
'| |',
"| |",
]
failures = [
# TODO: These should (probably) not fail?
# https://github.com/birdcolour/ukulele-wednesdays/issues/24
'| (D) (D) (D) (F) | (D) (D) (D) (F)',
'| (C) (C) (A7sus4) (A7sus4) | (G) (G) (F) (F)',
'| (D) (D) (D) (F) | (D) (D) (D) (F) |',
'| (C) (C) (A7sus4) (A7sus4) | (G) (G) (F) (F) |',
"| (D) (D) (D) (F) | (D) (D) (D) (F)",
"| (C) (C) (A7sus4) (A7sus4) | (G) (G) (F) (F)",
"| (D) (D) (D) (F) | (D) (D) (D) (F) |",
"| (C) (C) (A7sus4) (A7sus4) | (G) (G) (F) (F) |",
# https://github.com/birdcolour/ukulele-wednesdays/issues/25
'|',
'| ',
"|",
"| ",
]

class TestSinger(Base):
matches = [
"<Danny>",
"<spoken>",
]


class TestHeader(Base):
matches = [
'[chorus]',
'[bridge]',
"[chorus]",
"[bridge]",
]


class TestRepeats(Base):
matches = [
'x2',
"x2",
]
failures = [
'x 3',
"x 3",
]
3 changes: 3 additions & 0 deletions ukedown/patterns.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,6 @@

# pattern to pickup and "boldify" repetitions
REPEATS = r"(x\d+)"

# Singers' instructions/notes now in angled brackets
SINGER = r"<([^<]+)>"
12 changes: 12 additions & 0 deletions ukedown/udn.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,13 @@ def handleMatch(self, m, data):
el.text = m.group(1)
return el, m.start(0), m.end(0)

class SingerProcessor(InlineProcessor):
def handleMatch(self, m, data):
el = etree.Element("span")
el.set("class", "singer")
el.text = m.group(1)
return el, m.start(0), m.end(0)


class RepeatsProcessor(InlineProcessor):
def handleMatch(self, m, data):
Expand Down Expand Up @@ -263,6 +270,7 @@ def __init__(self, **kwargs):
"inline_element": ["span", "HTML element for inline items"],
"chord_pattern": [patterns.CHORD, "regex matching chords"],
"vox_pattern": [patterns.VOX, "regex matching backing vocals"],
"singer_pattern": [patterns.SINGER, "regex matching singers' notes"],
"notes_pattern": [
patterns.NOTES,
"regex matching notes/instructions",
Expand Down Expand Up @@ -304,6 +312,10 @@ def extendMarkdown(self, md):
VoxProcessor(self.getConfig("vox_pattern"), md), "vox", 177
)

md.inlinePatterns.register(
SingerProcessor(self.getConfig("singer_pattern"), md), "singer", 177
)

md.inlinePatterns.register(
NotesProcessor(self.getConfig("notes_pattern"), md), "notes", 176
)
Expand Down
Loading