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
|
from typing import TYPE_CHECKING, Any, Dict, Iterable, List
import pybtex.plugin
import pytest
from pybtex.database import Entry, Person
from pybtex.richtext import HRef
from pybtex.style.template import FieldIsMissing, Node, _format_list
# direct import of the plugin to ensure we are testing this specific class
from sphinxcontrib.bibtex.richtext import BaseReferenceText
from sphinxcontrib.bibtex.style.names.last import LastNameStyle
from sphinxcontrib.bibtex.style.referencing import BaseReferenceStyle, format_references
from sphinxcontrib.bibtex.style.referencing.basic_author_year import (
BasicAuthorYearTextualReferenceStyle,
)
from sphinxcontrib.bibtex.style.referencing.basic_super import (
BasicSuperParentheticalReferenceStyle,
BasicSuperTextualReferenceStyle,
)
from sphinxcontrib.bibtex.style.template import entry_label, join, names, node
if TYPE_CHECKING:
from pybtex.backends import BaseBackend
from pybtex.richtext import BaseText
from pybtex.style.formatting import BaseStyle
def test_style_names_last() -> None:
name = Person(string=r"Charles Louis Xavier Joseph de la Vall{\'e}e Poussin")
last = LastNameStyle().format
assert last(name).format().render_as("latex") == "de~la Vall{é}e~Poussin"
assert (
last(name).format().render_as("html")
== 'de la Vall<span class="bibtex-protected">é</span>e Poussin'
)
name2 = Person(first="First", last="Last", middle="Middle")
assert last(name2).format().render_as("latex") == "Last"
def test_style_names() -> None:
auth = Person("First Last")
fields = dict(title="The Book", year="2000", publisher="Santa")
entry = Entry(type_="book", fields=fields, persons=dict(author=[auth]))
style = BasicAuthorYearTextualReferenceStyle()
rich_name = style.person.names("author", full=True).format_data(
dict(entry=entry, style=style)
)
assert rich_name.render_as("text") == "Last"
def test_style_names_no_author() -> None:
entry = Entry(type_="book")
with pytest.raises(FieldIsMissing):
names("author").format_data(dict(entry=entry))
class SimpleReferenceText(BaseReferenceText[str]):
"""A simple reference text class storing the url as a string in *info*."""
def render(self, backend):
url = self.info[0]
return HRef(url, *self.parts).render(backend)
@node
def simple_reference(children, data: Dict[str, Any]):
"""Pybtex node for inserting a docutils reference node to a citation.
The children of the node
comprise the content of the reference, and any referencing information
is stored in the *reference_info* key of the *data*.
The data must also contain a *style* key pointing to the corresponding
:class:`~sphinxcontrib.bibtex.style.referencing.BaseReferenceStyle`.
"""
parts = _format_list(children, data)
info = data["reference_info"]
return SimpleReferenceText(info, *parts)
class SimpleReferenceStyle(BaseReferenceStyle):
def role_names(self) -> Iterable[str]:
return ["p"]
def outer(self, role_name: str, children: List["BaseText"]) -> "Node":
return join["{", join(";")[children], "}"]
def inner(self, role_name: str) -> "Node":
return simple_reference[entry_label]
def test_simple_reference_style() -> None:
cit_style: "BaseStyle" = pybtex.plugin.find_plugin(
"pybtex.style.formatting", "unsrtalpha"
)()
ref_style = SimpleReferenceStyle()
auth1 = Person("First Last")
auth2 = Person("Ein Zwei")
auth3 = Person("Primo Secundo")
fields1 = dict(title="The Book", year="2000", publisher="Santa")
entry1 = Entry(type_="book", fields=fields1, persons=dict(author=[auth1]))
entry2 = Entry(type_="book", fields=fields1, persons=dict(author=[auth2]))
entry3 = Entry(type_="book", fields=fields1, persons=dict(author=[auth3]))
entries = [entry1, entry2, entry3]
formatted_entries = list(cit_style.format_entries(entries))
infos = ["#id1", "#id2", "#id3"]
references = list(zip(entries, formatted_entries, infos))
backend: "BaseBackend" = pybtex.plugin.find_plugin("pybtex.backends", "html")()
assert "p" in ref_style.role_names()
assert (
format_references(ref_style, "p", references).render(backend)
== '{<a href="#id1">Las00</a>;<a href="#id2">Zwe00</a>'
';<a href="#id3">Sec00</a>}'
)
# need to instantiate these for 100% coverage
def test_super_coverage() -> None:
BasicSuperParentheticalReferenceStyle()
BasicSuperTextualReferenceStyle()
|
