def diff_toc(older_version, newer_version, old_toc, diff, from_version):
#We work around Subparts in the TOC for now.
compiled_toc = extract_sections(old_toc)
for node in (v['node'] for v in diff.values() if v['op'] == 'added'):
if len(node['label']) == 2 and node['title']:
element = {
'label': node['title'],
'index': node['label'],
'section_id': '-'.join(node['label']),
'op': 'added'
}
data = {'index': node['label'], 'title': node['title']}
TableOfContentsLayer.section(element, data)
TableOfContentsLayer.appendix_supplement(element, data)
compiled_toc.append(element)
modified, deleted = modified_deleted_sections(diff)
for el in compiled_toc:
if not 'Subpart' in el['index']:
el['url'] = reverse_chrome_diff_view(
el['section_id'], older_version, newer_version, from_version)
# Deleted first, lest deletions in paragraphs affect the section
if tuple(el['index']) in deleted and 'op' not in el:
el['op'] = 'deleted'
if tuple(el['index']) in modified and 'op' not in el:
el['op'] = 'modified'
return sort_toc(compiled_toc)
def test_apply_layer_interp_subparts(self):
toc = TableOfContentsLayer({
'100': [
{'title': 'Subpart A', 'index': ['100', 'Subpart', 'A']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}],
'100-Subpart-A': [
{'title': '100.1 Intro', 'index': ['100', '1']},
{'title': '100.2 Second', 'index': ['100', '2']}]})
_, result = toc.apply_layer('100')
self.assertEqual(2, len(result))
subpartA, interp = result
self.assertEqual(2, len(subpartA['sub_toc']))
self.assertEqual(1, len(interp['sub_toc']))
nosubpart = interp['sub_toc'][0]
self.assertEqual('Subpart A', nosubpart['label'])
self.assertEqual(['100', 'Subpart', 'A', 'Interp'], nosubpart['index'])
toc = TableOfContentsLayer({
'100': [
{'title': 'Subpart A', 'index': ['100', 'Subpart', 'A']},
{'title': 'Appendix A', 'index': ['100', 'A']},
{'title': 'Appendix C', 'index': ['100', 'C']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}],
'100-Subpart-A': [
{'title': '100.1 Intro', 'index': ['100', '1']},
{'title': '100.2 Second', 'index': ['100', '2']}]})
_, result = toc.apply_layer('100')
self.assertEqual(4, len(result))
subpartA, appA, appC, interp = result
self.assertEqual(2, len(interp['sub_toc']))
nosubpart, appendices = interp['sub_toc']
self.assertEqual('Subpart A', nosubpart['label'])
self.assertEqual(['100', 'Subpart', 'A', 'Interp'], nosubpart['index'])
self.assertEqual('Appendices', appendices['label'])
self.assertEqual(['100', 'Appendices', 'Interp'], appendices['index'])
def diff_toc(versions, old_toc, diff):
# We work around Subparts in the TOC for now.
compiled_toc = extract_sections(old_toc)
for node in (v['node'] for v in diff.values() if v['op'] == 'added'):
if len(node['label']) == 2 and node['title']:
element = {
'label': node['title'],
'index': node['label'],
'section_id': '-'.join(node['label']),
'op': 'added'
}
data = {'index': node['label'], 'title': node['title']}
TableOfContentsLayer.section(element, data)
TableOfContentsLayer.appendix_supplement(element, data)
compiled_toc.append(element)
modified, deleted = modified_deleted_sections(diff)
for el in compiled_toc:
if 'Subpart' not in el['index'] and 'Subjgrp' not in el['index']:
el['url'] = reverse_chrome_diff_view(el['section_id'], *versions)
# Deleted first, lest deletions in paragraphs affect the section
if tuple(el['index']) in deleted and 'op' not in el:
el['op'] = 'deleted'
if tuple(el['index']) in modified and 'op' not in el:
el['op'] = 'modified'
return sorted(compiled_toc, key=normalize_toc)
def test_section_with_thin_space(self):
toc = TableOfContentsLayer(None)
el = {}
toc.section(el, {'index': ['1', '2'], 'title': u'§ 1.2 - Awesome'})
self.assertEqual(el, {
'is_section': True,
'is_section_span': False,
'section_id': '1-2',
'label': '1.2',
'sub_label': 'Awesome'
})
def test_section_with_thin_space(self):
toc = TableOfContentsLayer(None)
el = {}
toc.section(el, {'index': ['1', '2'], 'title': u'§ 1.2 - Awesome'})
self.assertEqual(el, {
'is_section': True,
'is_section_span': False,
'section_id': '1-2',
'label': '1.2',
'sub_label': 'Awesome'
})
def test_apply_layer_url(self):
toc = TableOfContentsLayer({'100': [
{'title': '100.1 Intro', 'index': ['100', '1']}]})
result = toc.apply_layer('100')
self.assertEqual('#100-1', result[1][0]['url'])
toc.sectional = True
toc.version = 'verver'
result = toc.apply_layer('100')
self.assertTrue('100-1/verver#100-1' in result[1][0]['url'])
def test_attach_metadata_interp_emptysubpart(self):
toc = TableOfContentsLayer({'100': [
{'title': u'§ 100.1 Intro', 'index': ['100', '1']},
{'title': u'§ 100.2 Second', 'index': ['100', '2']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}]})
node = {'label_id': '100'}
toc.attach_metadata(node)
self.assertEqual(3, len(node['TOC']))
s1, s2, interp = node['TOC']
self.assertEqual(1, len(interp['sub_toc']))
nosubpart = interp['sub_toc'][0]
self.assertEqual('Regulation Text', nosubpart['label'])
self.assertEqual(['100', 'Subpart', 'Interp'], nosubpart['index'])
toc = TableOfContentsLayer({'100': [
{'title': u'§ 100.1 Intro', 'index': ['100', '1']},
{'title': u'§ 100.2 Second', 'index': ['100', '2']},
{'title': 'Appendix A', 'index': ['100', 'A']},
{'title': 'Appendix C', 'index': ['100', 'C']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}]})
toc.attach_metadata(node)
self.assertEqual(5, len(node['TOC']))
s1, s2, appA, appC, interp = node['TOC']
self.assertEqual(2, len(interp['sub_toc']))
nosubpart, appendices = interp['sub_toc']
self.assertEqual('Regulation Text', nosubpart['label'])
self.assertEqual(['100', 'Subpart', 'Interp'], nosubpart['index'])
self.assertEqual('Appendices', appendices['label'])
self.assertEqual(['100', 'Appendices', 'Interp'], appendices['index'])
def test_section_span(self):
toc = TableOfContentsLayer(None)
el = {}
toc.section(el, {
'index': ['1', '2'],
'title': u'§§ 1.2-6 - This is a span'
})
self.assertEqual(el, {
'is_section': True,
'is_section_span': True,
'section_id': '1-2',
'label': '1.2-6',
'sub_label': 'This is a span'
})
def test_section_span(self):
toc = TableOfContentsLayer(None)
el = {}
toc.section(el, {
'index': ['1', '2'],
'title': u'§§ 1.2-6 - This is a span'
})
self.assertEqual(el, {
'is_section': True,
'is_section_span': True,
'section_id': '1-2',
'label': '1.2-6',
'sub_label': 'This is a span'
})
def test_attach_metadata_url(self):
toc = TableOfContentsLayer({'100': [
{'title': u'§ 100.1 Intro', 'index': ['100', '1']}]})
node = {'label_id': '100'}
toc.attach_metadata(node)
self.assertEqual('#100-1', node['TOC'][0]['url'])
toc.sectional = True
toc.version = 'verver'
toc.attach_metadata(node)
self.assertTrue('100-1/verver#100-1' in node['TOC'][0]['url'])
def test_apply_layer_first_appendix(self):
toc = TableOfContentsLayer({'100': [
{'title': 'Appendix A', 'index': ['100', 'A']},
{'title': 'Appendix B', 'index': ['100', 'B']},
{'title': 'Appendix C', 'index': ['100', 'C']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}]})
_, result = toc.apply_layer('100')
self.assertEqual(4, len(result))
aA, aB, aC, sI = result
self.assertTrue(aA['is_first_appendix'])
self.assertFalse(aB['is_first_appendix'])
self.assertFalse(aC['is_first_appendix'])
self.assertFalse(sI.get('is_first_appendix', False))
toc = TableOfContentsLayer({'100': [
{'title': 'Supplement I', 'index': ['100', 'Interp']}]})
_, result = toc.apply_layer('100')
self.assertEqual(1, len(result))
self.assertFalse(result[0].get('is_first_appendix', False))
def test_apply_layer_compatibility(self):
toc = TableOfContentsLayer({'100': [
{'title': '100.1 Intro', 'index': ['100', '1']},
{'title': 'Appendix A', 'index': ['100', 'A']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}]})
_, result = toc.apply_layer('100')
self.assertEqual(3, len(result))
toc = TableOfContentsLayer({
'100': [
{'title': 'Subpart A', 'index': ['100', 'Subpart', 'A']},
{'title': 'Appendix A', 'index': ['100', 'A']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}],
'100-Subpart-A': [
{'title': '100.1 Intro', 'index': ['100', '1']},
{'title': '100.2 Sec2', 'index': ['100', '2']},
{'title': '100.3 Sec3', 'index': ['100', '3']}]
})
_, result = toc.apply_layer('100')
self.assertEqual(3, len(result))
self.assertEqual(3, len(result[0]['sub_toc']))
def test_apply_layer_interp_subparts(self):
toc = TableOfContentsLayer({
'100': [
{'title': 'Subpart A', 'index': ['100', 'Subpart', 'A']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}],
'100-Subpart-A': [
{'title': u'§ 100.1 Intro', 'index': ['100', '1']},
{'title': u'§ 100.2 Second', 'index': ['100', '2']}]})
_, result = toc.apply_layer('100')
self.assertEqual(2, len(result))
subpartA, interp = result
self.assertEqual(2, len(subpartA['sub_toc']))
self.assertEqual(1, len(interp['sub_toc']))
nosubpart = interp['sub_toc'][0]
self.assertEqual('Subpart A', nosubpart['label'])
self.assertEqual(['100', 'Subpart', 'A', 'Interp'], nosubpart['index'])
toc = TableOfContentsLayer({
'100': [
{'title': 'Subpart A', 'index': ['100', 'Subpart', 'A']},
{'title': 'Appendix A', 'index': ['100', 'A']},
{'title': 'Appendix C', 'index': ['100', 'C']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}],
'100-Subpart-A': [
{'title': u'§ 100.1 Intro', 'index': ['100', '1']},
{'title': u'§ 100.2 Second', 'index': ['100', '2']}]})
_, result = toc.apply_layer('100')
self.assertEqual(4, len(result))
subpartA, appA, appC, interp = result
self.assertEqual(2, len(interp['sub_toc']))
nosubpart, appendices = interp['sub_toc']
self.assertEqual('Subpart A', nosubpart['label'])
self.assertEqual(['100', 'Subpart', 'A', 'Interp'], nosubpart['index'])
self.assertEqual('Appendices', appendices['label'])
self.assertEqual(['100', 'Appendices', 'Interp'], appendices['index'])
def test_apply_layer_first_appendix(self):
toc = TableOfContentsLayer({
'100': [{
'title': 'Appendix A',
'index': ['100', 'A']
}, {
'title': 'Appendix B',
'index': ['100', 'B']
}, {
'title': 'Appendix C',
'index': ['100', 'C']
}, {
'title': 'Supplement I',
'index': ['100', 'Interp']
}]
})
_, result = toc.apply_layer('100')
self.assertEqual(4, len(result))
aA, aB, aC, sI = result
self.assertTrue(aA['is_first_appendix'])
self.assertFalse(aB['is_first_appendix'])
self.assertFalse(aC['is_first_appendix'])
self.assertFalse(sI.get('is_first_appendix', False))
toc = TableOfContentsLayer(
{'100': [{
'title': 'Supplement I',
'index': ['100', 'Interp']
}]})
_, result = toc.apply_layer('100')
self.assertEqual(1, len(result))
self.assertFalse(result[0].get('is_first_appendix', False))
def test_apply_layer_url(self):
toc = TableOfContentsLayer({'100': [
{'title': u'§ 100.1 Intro', 'index': ['100', '1']}]})
result = toc.apply_layer('100')
self.assertEqual('#100-1', result[1][0]['url'])
toc.sectional = True
toc.version = 'verver'
result = toc.apply_layer('100')
self.assertTrue('100-1/verver#100-1' in result[1][0]['url'])
def test_attach_metadata_first_appendix(self):
toc = TableOfContentsLayer({'100': [
{'title': 'Appendix A', 'index': ['100', 'A']},
{'title': 'Appendix B', 'index': ['100', 'B']},
{'title': 'Appendix C', 'index': ['100', 'C']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}]})
node = {'label_id': '100'}
toc.attach_metadata(node)
self.assertEqual(4, len(node['TOC']))
aA, aB, aC, sI = node['TOC']
self.assertTrue(aA['is_first_appendix'])
self.assertFalse(aB['is_first_appendix'])
self.assertFalse(aC['is_first_appendix'])
self.assertFalse(sI.get('is_first_appendix', False))
toc = TableOfContentsLayer({'100': [
{'title': 'Supplement I', 'index': ['100', 'Interp']}]})
toc.attach_metadata(node)
self.assertEqual(1, len(node['TOC']))
self.assertFalse(node['TOC'][0].get('is_first_appendix', False))
def test_attach_metadata_compatibility(self):
toc = TableOfContentsLayer({'100': [
{'title': u'§ 100.1 Intro', 'index': ['100', '1']},
{'title': 'Appendix A', 'index': ['100', 'A']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}]})
node = {'label_id': '100'}
toc.attach_metadata(node)
self.assertEqual(3, len(node['TOC']))
toc = TableOfContentsLayer({
'100': [
{'title': 'Subpart A', 'index': ['100', 'Subpart', 'A']},
{'title': 'Appendix A', 'index': ['100', 'A']},
{'title': 'Supplement I', 'index': ['100', 'Interp']}],
'100-Subpart-A': [
{'title': u'§ 100.1 Intro', 'index': ['100', '1']},
{'title': u'§ 100.2 Sec2', 'index': ['100', '2']},
{'title': u'§ 100.3 Sec3', 'index': ['100', '3']}]
})
toc.attach_metadata(node)
self.assertEqual(3, len(node['TOC']))
self.assertEqual(3, len(node['TOC'][0]['sub_toc']))
def test_apply_layer_interp_emptysubpart(self):
toc = TableOfContentsLayer({
'100': [{
'title': '100.1 Intro',
'index': ['100', '1']
}, {
'title': '100.2 Second',
'index': ['100', '2']
}, {
'title': 'Supplement I',
'index': ['100', 'Interp']
}]
})
_, result = toc.apply_layer('100')
self.assertEqual(3, len(result))
s1, s2, interp = result
self.assertEqual(1, len(interp['sub_toc']))
nosubpart = interp['sub_toc'][0]
self.assertEqual('Regulation Text', nosubpart['label'])
self.assertEqual(['100', 'Subpart', 'Interp'], nosubpart['index'])
toc = TableOfContentsLayer({
'100': [{
'title': '100.1 Intro',
'index': ['100', '1']
}, {
'title': '100.2 Second',
'index': ['100', '2']
}, {
'title': 'Appendix A',
'index': ['100', 'A']
}, {
'title': 'Appendix C',
'index': ['100', 'C']
}, {
'title': 'Supplement I',
'index': ['100', 'Interp']
}]
})
_, result = toc.apply_layer('100')
self.assertEqual(5, len(result))
s1, s2, appA, appC, interp = result
self.assertEqual(2, len(interp['sub_toc']))
nosubpart, appendices = interp['sub_toc']
self.assertEqual('Regulation Text', nosubpart['label'])
self.assertEqual(['100', 'Subpart', 'Interp'], nosubpart['index'])
self.assertEqual('Appendices', appendices['label'])
self.assertEqual(['100', 'Appendices', 'Interp'], appendices['index'])
def test_apply_layer_compatibility(self):
toc = TableOfContentsLayer({
'100': [{
'title': '100.1 Intro',
'index': ['100', '1']
}, {
'title': 'Appendix A',
'index': ['100', 'A']
}, {
'title': 'Supplement I',
'index': ['100', 'Interp']
}]
})
_, result = toc.apply_layer('100')
self.assertEqual(3, len(result))
toc = TableOfContentsLayer({
'100': [{
'title': 'Subpart A',
'index': ['100', 'Subpart', 'A']
}, {
'title': 'Appendix A',
'index': ['100', 'A']
}, {
'title': 'Supplement I',
'index': ['100', 'Interp']
}],
'100-Subpart-A': [{
'title': '100.1 Intro',
'index': ['100', '1']
}, {
'title': '100.2 Sec2',
'index': ['100', '2']
}, {
'title': '100.3 Sec3',
'index': ['100', '3']
}]
})
_, result = toc.apply_layer('100')
self.assertEqual(3, len(result))
self.assertEqual(3, len(result[0]['sub_toc']))
def test_section(self):
toc = TableOfContentsLayer(None)
el = {}
toc.section(el, {'index': ['1']})
self.assertEqual({}, el)
toc.section(el, {'index': ['1', '2', '3']})
self.assertEqual({}, el)
toc.section(el, {'index': ['1', 'B']})
self.assertEqual({}, el)
toc.section(el, {'index': ['1', 'Interpretations']})
self.assertEqual({}, el)
toc.section(el, {'index': ['1', '2'], 'title': u'§ 1.2 - Awesome'})
self.assertEqual(el, {
'is_section': True,
'is_section_span': False,
'section_id': '1-2',
'label': '1.2',
'sub_label': 'Awesome'
})
toc.section(el, {'index': ['2', '1'], 'title': u'§ 2.1 Sauce'})
self.assertEqual(el, {
'is_section': True,
'is_section_span': False,
'section_id': '2-1',
'label': '2.1',
'sub_label': 'Sauce'
})
def test_appendix_supplement(self):
toc = TableOfContentsLayer(None)
el = {}
toc.appendix_supplement(el, {'index': ['1']})
self.assertEqual({}, el)
toc.appendix_supplement(el, {'index': ['1', '2', '3']})
self.assertEqual({}, el)
toc.appendix_supplement(el, {'index': ['1', 'B', '3']})
self.assertEqual({}, el)
toc.appendix_supplement(el, {'index': ['1', 'Interp', '3']})
self.assertEqual({}, el)
toc.appendix_supplement(el, {
'index': ['1', 'B'],
'title': 'Appendix B - Bologna'})
self.assertEqual(el, {
'is_appendix': True,
'is_first_appendix': True,
'label': 'Appendix B',
'sub_label': 'Bologna',
'section_id': '1-B'
})
el = {}
toc.appendix_supplement(el, {
'index': ['204', 'A'],
'title': 'Appendix A to Part 204 - Model Forms'})
self.assertEqual(el, {
'is_appendix': True,
'is_first_appendix': True,
'label': 'Appendix A to Part 204',
'sub_label': 'Model Forms',
'section_id': '204-A'
})
el = {}
toc.appendix_supplement(el, {
'index': ['1', 'Interp'],
'title': 'Supplement I to 8787 - I am Iron Man'})
self.assertEqual(el, {
'is_supplement': True,
'label': 'Supplement I to 8787',
'sub_label': 'I am Iron Man',
'section_id': '1-Interp'
})
def test_appendix_supplement(self):
toc = TableOfContentsLayer(None)
el = {}
toc.appendix_supplement(el, {'index': ['1']})
self.assertEqual({}, el)
toc.appendix_supplement(el, {'index': ['1', '2', '3']})
self.assertEqual({}, el)
toc.appendix_supplement(el, {'index': ['1', 'B', '3']})
self.assertEqual({}, el)
toc.appendix_supplement(el, {'index': ['1', 'Interp', '3']})
self.assertEqual({}, el)
toc.appendix_supplement(el, {
'index': ['1', 'B'],
'title': 'Appendix B - Bologna'})
self.assertEqual(el, {
'is_appendix': True,
'is_first_appendix': True,
'label': 'Appendix B',
'sub_label': 'Bologna',
'section_id': '1-B'
})
el = {}
toc.appendix_supplement(el, {
'index': ['204', 'A'],
'title': 'Appendix A to Part 204 - Model Forms'})
self.assertEqual(el, {
'is_appendix': True,
'is_first_appendix': True,
'label': 'Appendix A to Part 204',
'sub_label': 'Model Forms',
'section_id': '204-A'
})
el = {}
toc.appendix_supplement(el, {
'index': ['1', 'Interp'],
'title': 'Supplement I to 8787 - I am Iron Man'})
self.assertEqual(el, {
'is_supplement': True,
'label': 'Supplement I to 8787',
'sub_label': 'I am Iron Man',
'section_id': '1-Interp'
})
def test_section(self):
toc = TableOfContentsLayer(None)
el = {}
toc.section(el, {'index': ['1']})
self.assertEqual({}, el)
toc.section(el, {'index': ['1', '2', '3']})
self.assertEqual({}, el)
toc.section(el, {'index': ['1', 'B']})
self.assertEqual({}, el)
toc.section(el, {'index': ['1', 'Interpretations']})
self.assertEqual({}, el)
toc.section(el, {'index': ['1', '2'], 'title': '1.2 - Awesome'})
self.assertEqual(el, {
'is_section': True,
'section_id': '1-2',
'label': '1.2',
'sub_label': 'Awesome'
})
toc.section(el, {'index': ['2', '1'], 'title': '2.1Sauce'})
self.assertEqual(el, {
'is_section': True,
'section_id': '2-1',
'label': '2.1',
'sub_label': 'Sauce'
})