summaryrefslogtreecommitdiffstats
path: root/python/tests/citation_efficiency.py
blob: fe5006cc787c0bf2678fa12f977b4c26740f90d4 (plain)
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

import json
import pytest
from copy import copy

from fatcat_client import *
from fatcat_client.rest import ApiException
from fixtures import *


def test_citation_indexing(api):
    # indexing is consistent and reacts to change

    eg = quick_eg(api)
    r1 = ReleaseEntity(title="the target")
    r1.refs = [
        ReleaseRef(key="first", title="the first title"),
        ReleaseRef(key="second", title="the second title"),
        ReleaseRef(key="third", title="a third title"),
    ]
    r1 = api.get_release(api.create_release(r1, editgroup_id=eg.editgroup_id).ident)
    api.accept_editgroup(eg.editgroup_id)

    assert r1.refs[0].index == 0
    assert r1.refs[0].key == "first"
    assert r1.refs[1].index == 1
    assert r1.refs[1].key == "second"
    assert r1.refs[2].index == 2
    assert r1.refs[2].key == "third"

    r1.refs.pop(1)
    eg = quick_eg(api)
    api.update_release(r1.ident, r1, editgroup_id=eg.editgroup_id)
    api.accept_editgroup(eg.editgroup_id)
    r1 = api.get_release(r1.ident)

    assert r1.refs[0].index == 0
    assert r1.refs[0].key == "first"
    assert r1.refs[1].index == 1
    assert r1.refs[1].key == "third"

def test_citation_targets(api):
    # invariant to linking citations
    # also, updates work

    eg = quick_eg(api)
    r1 = ReleaseEntity(title="the target")
    r1 = api.get_release(api.create_release(r1, editgroup_id=eg.editgroup_id).ident)
    r2 = ReleaseEntity(title="the citer")
    r2.refs = [
        ReleaseRef(key="first", title="something else"),
        ReleaseRef(key="second", title="the target title"),
    ]
    r2 = api.get_release(api.create_release(r2, editgroup_id=eg.editgroup_id).ident)
    api.accept_editgroup(eg.editgroup_id)

    eg = quick_eg(api)
    r2.refs[1].target_release_id = r1.ident
    api.update_release(r2.ident, r2, editgroup_id=eg.editgroup_id)
    api.accept_editgroup(eg.editgroup_id)
    r2 = api.get_release(r2.ident)
    assert r2.refs[0].key == "first"
    assert r2.refs[1].key == "second"
    assert r2.refs[0].index == 0 # TODO: one-indexing?
    assert r2.refs[1].index == 1
    assert r2.refs[0].target_release_id == None
    assert r2.refs[1].target_release_id == r1.ident
    assert len(r2.refs) == 2

def test_citation_empty_array(api):
    # distinction between empty array (no citations) and no array (hidden)

    r1 = ReleaseEntity(title="citation null")
    r2 = ReleaseEntity(title="citation empty array")
    r1.refs = None
    r2.refs = []

    eg = quick_eg(api)
    r1 = api.get_release(api.create_release(r1, editgroup_id=eg.editgroup_id).ident)
    r2 = api.get_release(api.create_release(r2, editgroup_id=eg.editgroup_id).ident)
    api.accept_editgroup(eg.editgroup_id)

    print(r1.refs)
    print(r2.refs)
    assert r1.refs == []
    assert r1.refs == r2.refs

    r1b = api.get_release(r1.ident, hide="refs")
    assert r1b.refs == None

def test_citation_encoding(api):
    # escape-only changes (eg, \u1234 whatever for ASCII)

    r1 = ReleaseEntity(title="citation encoding")
    title = "title-unicode \\u0050 \\\" "
    container = "container-unicode ☃︎ ä ö ü スティー"
    extra = extra={'a': 1, 'b': 2, 'ö': 3}
    locator = "p123"
    r1.refs = [
        ReleaseRef(key="1", year=1923, title=title, container_name=container,
            extra=extra, locator=locator),
        ReleaseRef(key="2"),
    ]

    eg = quick_eg(api)
    r1 = api.get_release(api.create_release(r1, editgroup_id=eg.editgroup_id).ident)
    api.accept_editgroup(eg.editgroup_id)

    assert title == r1.refs[0].title
    assert container == r1.refs[0].container_name
    assert extra == r1.refs[0].extra
    assert locator == r1.refs[0].locator