collective.documentgenerator 3.46__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (176) hide show
  1. collective/documentgenerator/AT_renderer.py +98 -0
  2. collective/documentgenerator/DX_renderer.py +52 -0
  3. collective/documentgenerator/__init__.py +17 -0
  4. collective/documentgenerator/adapters.py +23 -0
  5. collective/documentgenerator/browser/__init__.py +0 -0
  6. collective/documentgenerator/browser/actionspanel.py +19 -0
  7. collective/documentgenerator/browser/check_pod_templates.pt +63 -0
  8. collective/documentgenerator/browser/children_pod_template.pt +16 -0
  9. collective/documentgenerator/browser/configure.zcml +220 -0
  10. collective/documentgenerator/browser/controlpanel.py +159 -0
  11. collective/documentgenerator/browser/converter.py +43 -0
  12. collective/documentgenerator/browser/generation_view.py +532 -0
  13. collective/documentgenerator/browser/overrides.py +9 -0
  14. collective/documentgenerator/browser/resources/css/documentgenerator.css +133 -0
  15. collective/documentgenerator/browser/static/.gitkeep +0 -0
  16. collective/documentgenerator/browser/static/configurable.svg +1232 -0
  17. collective/documentgenerator/browser/static/csv.svg +521 -0
  18. collective/documentgenerator/browser/static/doc.svg +23 -0
  19. collective/documentgenerator/browser/static/docx.svg +20 -0
  20. collective/documentgenerator/browser/static/download_icon.svg +54 -0
  21. collective/documentgenerator/browser/static/libreoffice-blanck.svg +481 -0
  22. collective/documentgenerator/browser/static/mailinglooptemplate.svg +1207 -0
  23. collective/documentgenerator/browser/static/missing_use.svg +42 -0
  24. collective/documentgenerator/browser/static/nok.svg +38 -0
  25. collective/documentgenerator/browser/static/nok_use.svg +38 -0
  26. collective/documentgenerator/browser/static/nok_used.svg +38 -0
  27. collective/documentgenerator/browser/static/odp.svg +1264 -0
  28. collective/documentgenerator/browser/static/ods.svg +1354 -0
  29. collective/documentgenerator/browser/static/odt.svg +1347 -0
  30. collective/documentgenerator/browser/static/ok.svg +38 -0
  31. collective/documentgenerator/browser/static/ok_use.svg +38 -0
  32. collective/documentgenerator/browser/static/ok_used.svg +38 -0
  33. collective/documentgenerator/browser/static/pdf.svg +557 -0
  34. collective/documentgenerator/browser/static/podtemplate.svg +1197 -0
  35. collective/documentgenerator/browser/static/rtf.svg +521 -0
  36. collective/documentgenerator/browser/static/style.svg +1207 -0
  37. collective/documentgenerator/browser/static/subtemplate.svg +1250 -0
  38. collective/documentgenerator/browser/static/xls.svg +159 -0
  39. collective/documentgenerator/browser/static/xlsx.svg +48 -0
  40. collective/documentgenerator/browser/table.py +277 -0
  41. collective/documentgenerator/browser/templates_listing.pt +23 -0
  42. collective/documentgenerator/browser/views.py +365 -0
  43. collective/documentgenerator/config.py +162 -0
  44. collective/documentgenerator/configure.zcml +41 -0
  45. collective/documentgenerator/content/__init__.py +0 -0
  46. collective/documentgenerator/content/condition.py +60 -0
  47. collective/documentgenerator/content/conditions.zcml +29 -0
  48. collective/documentgenerator/content/configure.zcml +25 -0
  49. collective/documentgenerator/content/document_factory.py +73 -0
  50. collective/documentgenerator/content/file_representation.py +73 -0
  51. collective/documentgenerator/content/file_representation.zcml +28 -0
  52. collective/documentgenerator/content/merge_templates.py +15 -0
  53. collective/documentgenerator/content/merge_templates.zcml +10 -0
  54. collective/documentgenerator/content/pod_template.py +547 -0
  55. collective/documentgenerator/content/style_template.py +52 -0
  56. collective/documentgenerator/content/vocabulary.py +315 -0
  57. collective/documentgenerator/content/vocabulary.zcml +104 -0
  58. collective/documentgenerator/demo/__init__.py +0 -0
  59. collective/documentgenerator/demo/archetypes.zcml +10 -0
  60. collective/documentgenerator/demo/configure.zcml +19 -0
  61. collective/documentgenerator/demo/helper.py +198 -0
  62. collective/documentgenerator/events/__init__.py +0 -0
  63. collective/documentgenerator/events/configure.zcml +30 -0
  64. collective/documentgenerator/events/pod_templates_events.py +66 -0
  65. collective/documentgenerator/events/styles_events.py +122 -0
  66. collective/documentgenerator/helper/__init__.py +9 -0
  67. collective/documentgenerator/helper/archetypes-adapter.zcml +10 -0
  68. collective/documentgenerator/helper/archetypes-page.zcml +9 -0
  69. collective/documentgenerator/helper/archetypes.py +67 -0
  70. collective/documentgenerator/helper/base.py +266 -0
  71. collective/documentgenerator/helper/configure.zcml +38 -0
  72. collective/documentgenerator/helper/dexterity.py +174 -0
  73. collective/documentgenerator/interfaces.py +165 -0
  74. collective/documentgenerator/locales/collective.documentgenerator.pot +564 -0
  75. collective/documentgenerator/locales/es/LC_MESSAGES/collective.documentgenerator.po +572 -0
  76. collective/documentgenerator/locales/es/LC_MESSAGES/plone.po +32 -0
  77. collective/documentgenerator/locales/fr/LC_MESSAGES/collective.documentgenerator.po +566 -0
  78. collective/documentgenerator/locales/fr/LC_MESSAGES/plone.po +27 -0
  79. collective/documentgenerator/locales/manual.pot +30 -0
  80. collective/documentgenerator/locales/plone-manual.pot +22 -0
  81. collective/documentgenerator/locales/plone.pot +30 -0
  82. collective/documentgenerator/locales/update.sh +22 -0
  83. collective/documentgenerator/migrations/__init__.py +0 -0
  84. collective/documentgenerator/migrations/migrate_to_11.py +53 -0
  85. collective/documentgenerator/migrations/migrate_to_12.py +30 -0
  86. collective/documentgenerator/migrations/migrate_to_13.py +37 -0
  87. collective/documentgenerator/migrations/migrate_to_3.py +36 -0
  88. collective/documentgenerator/migrations/migrate_to_5.py +30 -0
  89. collective/documentgenerator/migrations/migrate_to_6.py +27 -0
  90. collective/documentgenerator/migrations/migrate_to_7.py +32 -0
  91. collective/documentgenerator/migrations/migrate_to_8.py +34 -0
  92. collective/documentgenerator/migrations/migrate_to_9.py +48 -0
  93. collective/documentgenerator/profiles/base/browserlayer.xml +7 -0
  94. collective/documentgenerator/profiles/base/controlpanel.xml +20 -0
  95. collective/documentgenerator/profiles/base/metadata.xml +7 -0
  96. collective/documentgenerator/profiles/base/types/ConfigurablePODTemplate.xml +43 -0
  97. collective/documentgenerator/profiles/base/types/MailingLoopTemplate.xml +42 -0
  98. collective/documentgenerator/profiles/base/types/PODTemplate.xml +42 -0
  99. collective/documentgenerator/profiles/base/types/StyleTemplate.xml +42 -0
  100. collective/documentgenerator/profiles/base/types/SubTemplate.xml +42 -0
  101. collective/documentgenerator/profiles/base/types.xml +10 -0
  102. collective/documentgenerator/profiles/base/viewlets.xml +6 -0
  103. collective/documentgenerator/profiles/demo/browserlayer.xml +7 -0
  104. collective/documentgenerator/profiles/demo/collectivedocumentgenerator_demo_marker.txt +0 -0
  105. collective/documentgenerator/profiles/demo/import_steps.xml +11 -0
  106. collective/documentgenerator/profiles/demo/metadata.xml +7 -0
  107. collective/documentgenerator/profiles/demo/registry.xml +13 -0
  108. collective/documentgenerator/profiles/demo/templates/mailing.odt +0 -0
  109. collective/documentgenerator/profiles/demo/templates/modele_general.ods +0 -0
  110. collective/documentgenerator/profiles/demo/templates/modele_general.odt +0 -0
  111. collective/documentgenerator/profiles/demo/templates/mod/303/250le_collection.odt +0 -0
  112. collective/documentgenerator/profiles/demo/templates/possibly_mailed_model.odt +0 -0
  113. collective/documentgenerator/profiles/demo/templates/styles.odt +0 -0
  114. collective/documentgenerator/profiles/demo/templates/styles_2.odt +0 -0
  115. collective/documentgenerator/profiles/demo/templates/sub_template.odt +0 -0
  116. collective/documentgenerator/profiles/demo/viewlets.xml +3 -0
  117. collective/documentgenerator/profiles/plone4/collectivedocumentgenerator_marker.txt +0 -0
  118. collective/documentgenerator/profiles/plone4/cssregistry.xml +11 -0
  119. collective/documentgenerator/profiles/plone4/metadata.xml +7 -0
  120. collective/documentgenerator/profiles/plone4/registry.xml +6 -0
  121. collective/documentgenerator/profiles/plone5/metadata.xml +7 -0
  122. collective/documentgenerator/profiles/plone5/registry.xml +15 -0
  123. collective/documentgenerator/profiles/testing/metadata.xml +7 -0
  124. collective/documentgenerator/profiles/testing/propertiestool.xml +5 -0
  125. collective/documentgenerator/profiles/testing/types/member.xml +85 -0
  126. collective/documentgenerator/profiles/testing/types.xml +5 -0
  127. collective/documentgenerator/profiles.zcml +186 -0
  128. collective/documentgenerator/renderer.zcml +145 -0
  129. collective/documentgenerator/search_replace/__init__.py +0 -0
  130. collective/documentgenerator/search_replace/configure.zcml +19 -0
  131. collective/documentgenerator/search_replace/pod_template.py +146 -0
  132. collective/documentgenerator/search_replace/search_result_form.pt +48 -0
  133. collective/documentgenerator/search_replace/searchreplace_panel.pt +22 -0
  134. collective/documentgenerator/search_replace/searchreplace_panel.py +261 -0
  135. collective/documentgenerator/setuphandlers.py +287 -0
  136. collective/documentgenerator/testing.py +324 -0
  137. collective/documentgenerator/testing.zcml +16 -0
  138. collective/documentgenerator/tests/__init__.py +0 -0
  139. collective/documentgenerator/tests/failing_template.odt +0 -0
  140. collective/documentgenerator/tests/robot/.gitkeep +0 -0
  141. collective/documentgenerator/tests/template_to_clean.odt +0 -0
  142. collective/documentgenerator/tests/template_without_style_page.odt +0 -0
  143. collective/documentgenerator/tests/test_AT_helper_view.py +276 -0
  144. collective/documentgenerator/tests/test_DX_helper_view.py +355 -0
  145. collective/documentgenerator/tests/test_base_helper_view.py +128 -0
  146. collective/documentgenerator/tests/test_check_podtemplates_view.py +138 -0
  147. collective/documentgenerator/tests/test_config.py +106 -0
  148. collective/documentgenerator/tests/test_configurable_pod_template.py +383 -0
  149. collective/documentgenerator/tests/test_demo_profile.py +115 -0
  150. collective/documentgenerator/tests/test_events.py +169 -0
  151. collective/documentgenerator/tests/test_file.odt +0 -0
  152. collective/documentgenerator/tests/test_generation_view.py +652 -0
  153. collective/documentgenerator/tests/test_mailing.odt +0 -0
  154. collective/documentgenerator/tests/test_mailing_loop_template.py +48 -0
  155. collective/documentgenerator/tests/test_pod_template.py +178 -0
  156. collective/documentgenerator/tests/test_robot.py +26 -0
  157. collective/documentgenerator/tests/test_search_replace.py +419 -0
  158. collective/documentgenerator/tests/test_setup.py +49 -0
  159. collective/documentgenerator/tests/test_style_template.py +19 -0
  160. collective/documentgenerator/tests/test_sub_template.py +49 -0
  161. collective/documentgenerator/tests/test_templates_listing_view.py +91 -0
  162. collective/documentgenerator/tests/test_utils.py +244 -0
  163. collective/documentgenerator/tests/test_vocabulary.py +154 -0
  164. collective/documentgenerator/utils.py +396 -0
  165. collective/documentgenerator/viewlets/__init__.py +0 -0
  166. collective/documentgenerator/viewlets/batchactions.py +14 -0
  167. collective/documentgenerator/viewlets/configure.zcml +16 -0
  168. collective/documentgenerator/viewlets/generationlinks.pt +28 -0
  169. collective/documentgenerator/viewlets/generationlinks.py +58 -0
  170. collective.documentgenerator-3.46-py3.13-nspkg.pth +1 -0
  171. collective_documentgenerator-3.46.dist-info/METADATA +1142 -0
  172. collective_documentgenerator-3.46.dist-info/RECORD +176 -0
  173. collective_documentgenerator-3.46.dist-info/WHEEL +5 -0
  174. collective_documentgenerator-3.46.dist-info/entry_points.txt +5 -0
  175. collective_documentgenerator-3.46.dist-info/namespace_packages.txt +1 -0
  176. collective_documentgenerator-3.46.dist-info/top_level.txt +1 -0
@@ -0,0 +1,48 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from collective.documentgenerator.content.condition import PODTemplateCondition
4
+ from collective.documentgenerator.interfaces import IPODTemplateCondition
5
+ from collective.documentgenerator.testing import POD_TEMPLATE_INTEGRATION
6
+ from collective.documentgenerator.testing import TEST_INSTALL_INTEGRATION
7
+ from plone import api
8
+ from zope.component import queryMultiAdapter
9
+
10
+ import unittest
11
+
12
+
13
+ class TestMailingLoopTemplate(unittest.TestCase):
14
+ """
15
+ Test MailingLoopTemplate content type.
16
+ """
17
+
18
+ layer = TEST_INSTALL_INTEGRATION
19
+
20
+ def test_MailingLoopTemplate_portal_type_is_registered(self):
21
+ portal_types = api.portal.get_tool('portal_types')
22
+ registered_types = portal_types.listContentTypes()
23
+ self.assertTrue('MailingLoopTemplate' in registered_types)
24
+
25
+
26
+ class TestMailingLoopTemplateIntegration(unittest.TestCase):
27
+ """
28
+ Test PODTemplate methods.
29
+ """
30
+
31
+ layer = POD_TEMPLATE_INTEGRATION
32
+
33
+ def setUp(self):
34
+ super(TestMailingLoopTemplateIntegration, self).setUp()
35
+ self.portal = api.portal.get()
36
+ self.test_template = self.portal.podtemplates.get('loop_template')
37
+
38
+ def test_default_generation_condition_registration(self):
39
+ context = self.portal
40
+ condition_obj = queryMultiAdapter(
41
+ (self.test_template, context),
42
+ IPODTemplateCondition,
43
+ )
44
+
45
+ self.assertTrue(isinstance(condition_obj, PODTemplateCondition))
46
+
47
+ def test_default_generation_condition_is_False(self):
48
+ self.assertTrue(self.test_template.can_be_generated(self.portal))
@@ -0,0 +1,178 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from Acquisition import aq_base
4
+ from collective.documentgenerator.content.condition import PODTemplateCondition
5
+ from collective.documentgenerator.content.merge_templates import TemplatesToMergeForPODTemplate
6
+ from collective.documentgenerator.content.pod_template import IPODTemplate
7
+ from collective.documentgenerator.interfaces import IPODTemplateCondition
8
+ from collective.documentgenerator.interfaces import ITemplatesToMerge
9
+ from collective.documentgenerator.testing import PODTemplateIntegrationTest
10
+ from collective.documentgenerator.testing import TEST_INSTALL_INTEGRATION
11
+ from plone import api
12
+ from plone.namedfile.file import NamedBlobFile
13
+ from zope.component import getGlobalSiteManager
14
+ from zope.component import queryAdapter
15
+ from zope.component import queryMultiAdapter
16
+ from zope.interface import Interface
17
+
18
+ import unittest
19
+
20
+
21
+ class TestPODTemplate(unittest.TestCase):
22
+ """
23
+ Test PODTemplate content type.
24
+ """
25
+
26
+ layer = TEST_INSTALL_INTEGRATION
27
+
28
+ def test_PODTemplate_portal_type_is_registered(self):
29
+ portal_types = api.portal.get_tool('portal_types')
30
+ registered_types = portal_types.listContentTypes()
31
+ self.assertTrue('PODTemplate' in registered_types)
32
+
33
+
34
+ class TestPODTemplateFields(PODTemplateIntegrationTest):
35
+ """
36
+ Test schema fields declaration.
37
+ """
38
+
39
+ def test_class_registration(self):
40
+ from collective.documentgenerator.content.pod_template import PODTemplate
41
+ self.assertTrue(self.test_podtemplate.__class__ == PODTemplate)
42
+
43
+ def test_schema_registration(self):
44
+ portal_types = api.portal.get_tool('portal_types')
45
+ podtemplate_type = portal_types.get(self.test_podtemplate.portal_type)
46
+ self.assertTrue('IPODTemplate' in podtemplate_type.schema)
47
+
48
+ def test_odt_file_attribute(self):
49
+ test_podtemplate = aq_base(self.test_podtemplate)
50
+ self.assertTrue(hasattr(test_podtemplate, 'odt_file'))
51
+
52
+ def test_odt_file_field_display(self):
53
+ self.browser.open(self.test_podtemplate.absolute_url())
54
+ contents = self.browser.contents
55
+ msg = "field 'odt_file' is not displayed"
56
+ self.assertTrue('id="form-widgets-odt_file"' in contents, msg)
57
+ msg = "field 'odt_file' is not translated"
58
+ self.assertTrue('Canevas' in contents, msg)
59
+
60
+ def test_odt_file_field_edit(self):
61
+ contents = self._edit_object(self.test_podtemplate)
62
+ msg = "field 'odt_file' is not editable"
63
+ self.assertTrue('Canevas' in contents, msg)
64
+
65
+ def test_initial_md5_attribute(self):
66
+ test_podtemplate = aq_base(self.test_podtemplate)
67
+ self.assertTrue(hasattr(test_podtemplate, 'initial_md5'))
68
+
69
+ def test_initial_md5_field_display(self):
70
+ self.browser.open(self.test_podtemplate.absolute_url())
71
+ contents = self.browser.contents
72
+ msg = "field 'initial_md5' is displayed"
73
+ self.assertTrue('id="form-widgets-initial_md5"' not in contents, msg)
74
+
75
+ def test_initial_md5_field_edit(self):
76
+ contents = self._edit_object(self.test_podtemplate)
77
+ msg = "field 'initial_md5' is editable"
78
+ self.assertTrue('md5' not in contents, msg)
79
+
80
+ def test_enabled_attribute(self):
81
+ test_podtemplate = aq_base(self.test_podtemplate)
82
+ self.assertTrue(hasattr(test_podtemplate, 'enabled'))
83
+
84
+ def test_enabled_field_display(self):
85
+ self.browser.open(self.test_podtemplate.absolute_url())
86
+ contents = self.browser.contents
87
+ msg = "field 'enabled' is not displayed"
88
+ self.assertTrue('id="form-widgets-enabled"' in contents, msg)
89
+ msg = "field 'enabled' is not translated"
90
+ self.assertTrue('Activé' in contents, msg)
91
+
92
+ def test_enabled_field_edit(self):
93
+ contents = self._edit_object(self.test_podtemplate)
94
+ msg = "field 'enabled' is not editable"
95
+ self.assertTrue('Activé' in contents, msg)
96
+
97
+
98
+ class TestPODTemplateIntegration(PODTemplateIntegrationTest):
99
+ """
100
+ Test PODTemplate methods.
101
+ """
102
+
103
+ def test_get_file(self):
104
+ expected_file = self.test_podtemplate.odt_file
105
+
106
+ self.test_podtemplate.odt_file = expected_file
107
+ odt_file = self.test_podtemplate.get_file()
108
+ msg = "Accessor 'get_file' does not return odt_file field value."
109
+ self.assertTrue(odt_file == expected_file, msg)
110
+
111
+ def test_default_generation_condition_registration(self):
112
+ context = self.portal
113
+ condition_obj = queryMultiAdapter(
114
+ (self.test_podtemplate, context),
115
+ IPODTemplateCondition,
116
+ )
117
+
118
+ self.assertTrue(isinstance(condition_obj, PODTemplateCondition))
119
+
120
+ def test_can_be_generated(self):
121
+ self.assertTrue(self.test_podtemplate.can_be_generated(self.portal))
122
+
123
+ # Disable the template.
124
+ self.test_podtemplate.enabled = False
125
+ msg = 'disabled template should not be generated'
126
+ self.assertTrue(not self.test_podtemplate.can_be_generated(self.portal), msg)
127
+
128
+ def test_custom_generation_condition(self):
129
+ """
130
+ Register a custom condition and see if its taken into account by our test_podtemplate.
131
+ """
132
+ pod_template = self.test_podtemplate
133
+ can_be_generated = pod_template.can_be_generated(self.portal)
134
+ self.assertTrue(can_be_generated is True)
135
+
136
+ class CustomCondition(PODTemplateCondition):
137
+ def evaluate(self):
138
+ return 'yolo'
139
+
140
+ gsm = getGlobalSiteManager()
141
+ gsm.registerAdapter(CustomCondition, (IPODTemplate, Interface), IPODTemplateCondition)
142
+
143
+ can_be_generated = pod_template.can_be_generated(self.portal)
144
+ self.assertTrue(can_be_generated == 'yolo')
145
+
146
+ # finally, unregister our adapter...
147
+ gsm.registerAdapter(PODTemplateCondition, (IPODTemplate, Interface), IPODTemplateCondition)
148
+
149
+ def test_get_style_template(self):
150
+ pod_template = self.test_podtemplate
151
+ self.assertTrue(pod_template.get_style_template() is None)
152
+
153
+ def test_default_merge_templates_registration(self):
154
+ adapter = queryAdapter(self.test_podtemplate, ITemplatesToMerge)
155
+ self.assertTrue(isinstance(adapter, TemplatesToMergeForPODTemplate))
156
+
157
+ def test_template_has_been_modified_method(self):
158
+ pod_template = self.test_podtemplate
159
+
160
+ setup_tool = api.portal.get_tool('portal_setup')
161
+ demo_profile = setup_tool.getProfileInfo('collective.documentgenerator:demo')
162
+ template_path = '{}/templates/styles.odt'.format(demo_profile.get('path'))
163
+ template_file = file(template_path, 'rb').read()
164
+ blob_file = NamedBlobFile(data=template_file, contentType='application/vnd.oasis.opendocument.text')
165
+
166
+ pod_template.odt_file = blob_file
167
+
168
+ self.assertTrue(pod_template.has_been_modified())
169
+
170
+ def test_get_available_formats(self):
171
+ self.assertEqual(self.test_podtemplate.get_available_formats(), ['odt', ])
172
+
173
+
174
+ class TestPODTemplateValidator(PODTemplateIntegrationTest):
175
+ def test_file_extension_is_odt(self):
176
+ pod_template = self.test_podtemplate
177
+ extension = pod_template.odt_file.filename.split('.')[-1]
178
+ self.assertEqual(extension, 'odt')
@@ -0,0 +1,26 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from collective.documentgenerator.testing import ACCEPTANCE
4
+ from plone.testing import layered
5
+
6
+ import os
7
+ import robotsuite
8
+ import unittest
9
+
10
+
11
+ def test_suite():
12
+ suite = unittest.TestSuite()
13
+ current_dir = os.path.abspath(os.path.dirname(__file__))
14
+ robot_dir = os.path.join(current_dir, 'robot')
15
+ robot_tests = [
16
+ os.path.join('robot', doc) for doc in os.listdir(robot_dir)
17
+ if doc.endswith('.robot') and doc.startswith('test_')
18
+ ]
19
+ for test in robot_tests:
20
+ suite.addTests([
21
+ layered(
22
+ robotsuite.RobotTestSuite(test),
23
+ layer=ACCEPTANCE
24
+ ),
25
+ ])
26
+ return suite
@@ -0,0 +1,419 @@
1
+ # coding=utf-8
2
+ from collective.documentgenerator.search_replace.pod_template import SearchAndReplacePODTemplates
3
+ from collective.documentgenerator.testing import PODTemplateIntegrationTest
4
+ from collective.documentgenerator.utils import compute_md5
5
+ from plone.testing._z2_testbrowser import Browser
6
+ from zExceptions import Unauthorized
7
+ from zope.interface import Invalid
8
+
9
+ import io
10
+ import os
11
+ import zipfile
12
+
13
+
14
+ class TestSearchReplaceTemplate(PODTemplateIntegrationTest):
15
+ """
16
+ Test search and replace feature
17
+ """
18
+
19
+ def setUp(self):
20
+ super(TestSearchReplaceTemplate, self).setUp()
21
+ self.template1 = self.portal.podtemplates.test_template
22
+ self.template2 = self.portal.podtemplates.test_template_bis
23
+ self.ods_template = self.portal.podtemplates.test_ods_template
24
+
25
+ def test_podtemplate_is_searchable(self):
26
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
27
+ results = search_replace.search("view")
28
+
29
+ self.assertGreater(len(results.keys()), 0)
30
+
31
+ def test_search_dont_alter_podtemplate(self):
32
+ template1_md5 = compute_md5(self.template1.odt_file.data)
33
+ template2_md5 = compute_md5(self.template2.odt_file.data)
34
+
35
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
36
+ search_replace.search("view")
37
+
38
+ self.assertEqual(compute_md5(self.template1.odt_file.data), template1_md5)
39
+ self.assertEqual(compute_md5(self.template2.odt_file.data), template2_md5)
40
+
41
+ def test_can_search_regex(self):
42
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
43
+ # We want only the `view` before the `get_localized_field_name` method
44
+ results = search_replace.search("view(?=.get_localized_field_name)", is_regex=True)
45
+
46
+ template1_results = results[self.template1.UID()]
47
+ self.assertEqual(len(template1_results), 1)
48
+ self.assertIn("view.get_localized_field_name", template1_results[0].content)
49
+
50
+ self.assertNotIn(self.template2.UID(), results.keys()) # Nothing in template2
51
+
52
+ def test_can_search_string(self):
53
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
54
+ results = search_replace.search("Author")
55
+
56
+ self.assertNotIn(self.template1.UID(), results.keys())
57
+ template2_results = results[self.template2.UID()]
58
+ self.assertEqual(len(template2_results), 1)
59
+
60
+ self.assertIn("Author", template2_results[0].content)
61
+
62
+ def test_can_search_in_ods(self):
63
+ with SearchAndReplacePODTemplates((self.ods_template,)) as search_replace:
64
+ not_found_results = search_replace.search("Nowhere to be found")
65
+ brain_results = search_replace.search("brain")
66
+ regex_results = search_replace.search("view\\..*\\.results\\(\\)", is_regex=True)
67
+ # At the regex start, '^' was failing before
68
+ regex_start_results = search_replace.search("^do row", is_regex=True)
69
+
70
+ self.assertNotIn(self.ods_template.UID(), not_found_results.keys())
71
+ self.assertIn(self.ods_template.UID(), regex_start_results.keys())
72
+ ods_brain_results = brain_results[self.ods_template.UID()]
73
+ ods_regex_results = regex_results[self.ods_template.UID()]
74
+
75
+ self.assertEqual(len(ods_brain_results), 4)
76
+ self.assertEqual(len(ods_regex_results), 1)
77
+ for result in ods_brain_results:
78
+ self.assertIn("brain", result.content)
79
+
80
+ self.assertIn("view.real_context.results()", ods_regex_results[0].content)
81
+
82
+ def test_can_search_in_headers_and_footers(self):
83
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
84
+ header_results = search_replace.search("context.title.upper()")
85
+ footer_results = search_replace.search("^view.display_date", is_regex=True)
86
+
87
+ self.assertNotIn(self.template1.UID(), header_results.keys())
88
+ self.assertNotIn(self.template1.UID(), footer_results.keys())
89
+
90
+ self.assertEqual(len(header_results[self.template2.UID()]), 1)
91
+ self.assertIn("context.title.upper()", header_results[self.template2.UID()][0].content)
92
+
93
+ self.assertEqual(len(footer_results[self.template2.UID()]), 1)
94
+ self.assertIn("view.display_date", footer_results[self.template2.UID()][0].content)
95
+
96
+ def test_can_search_multiple_times(self):
97
+ with SearchAndReplacePODTemplates((self.template1,)) as search_replace:
98
+ not_found_results = search_replace.search("Nowhere to be found")
99
+ view_results = search_replace.search("view")
100
+ regex_results = search_replace.search(
101
+ "view(?=.get_localized_field_name)", is_regex=True
102
+ )
103
+
104
+ template1_uid = self.template1.UID()
105
+
106
+ self.assertNotEqual(not_found_results, view_results)
107
+ self.assertNotEqual(view_results, regex_results)
108
+
109
+ self.assertNotIn(template1_uid, not_found_results)
110
+
111
+ for result in view_results[template1_uid]:
112
+ self.assertIn("view", result.content)
113
+
114
+ self.assertEqual(len(regex_results[template1_uid]), 1)
115
+ self.assertIn("view.get_localized_field_name", regex_results[template1_uid][0].content)
116
+
117
+ def test_search_clean_after_itself(self):
118
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
119
+ tmp_dir = search_replace.tmp_dir
120
+ search_replace.search("view")
121
+
122
+ self.assertFalse(os.path.exists(tmp_dir))
123
+
124
+ # Test if it clean after itself after an exception is raised
125
+ try:
126
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
127
+ tmp_dir = search_replace.tmp_dir
128
+ search_replace.search("view")
129
+ raise OSError
130
+ except OSError:
131
+ pass
132
+
133
+ self.assertFalse(os.path.exists(tmp_dir))
134
+
135
+ def test_can_replace_in_podtemplate(self):
136
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
137
+ results = search_replace.replace("view", "View")
138
+
139
+ self.assertGreater(len(results), 0)
140
+
141
+ def test_replace_change_podtemplate_file(self):
142
+ template1_md5 = compute_md5(self.template1.odt_file.data)
143
+ template2_md5 = compute_md5(self.template2.odt_file.data)
144
+
145
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
146
+ search_replace.replace("view", "View")
147
+
148
+ self.assertNotEquals(compute_md5(self.template1.odt_file.data), template1_md5)
149
+ self.assertNotEquals(compute_md5(self.template2.odt_file.data), template2_md5)
150
+
151
+ def test_replace_dont_alter_pod_template_odt_file_structure(self):
152
+ with SearchAndReplacePODTemplates((self.template1,)) as search_replace:
153
+ search_replace.replace("view", "View")
154
+
155
+ zip_bytes = io.BytesIO(self.template1.odt_file.data)
156
+ zip_file = zipfile.ZipFile(zip_bytes)
157
+ odt_subfiles = zip_file.namelist()
158
+
159
+ expected_files = [
160
+ u"mimetype",
161
+ u"content.xml",
162
+ u"styles.xml",
163
+ u"meta.xml",
164
+ u"settings.xml",
165
+ u"manifest.rdf",
166
+ u"META-INF/manifest.xml",
167
+ ]
168
+
169
+ for expected_file in expected_files:
170
+ self.assertIn(expected_file, odt_subfiles)
171
+
172
+ def test_replace_dont_change_podtemplate_file_size_too_much(self):
173
+ before_template1_filesize = self.template1.odt_file.getSize()
174
+ before_template2_filesize = self.template2.odt_file.getSize()
175
+
176
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
177
+ search_replace.replace("view", "View")
178
+
179
+ self.assertAlmostEqual(before_template1_filesize, self.template1.odt_file.getSize(), delta=1000)
180
+ self.assertAlmostEqual(before_template2_filesize, self.template2.odt_file.getSize(), delta=1000)
181
+
182
+ def test_can_replace_string(self):
183
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
184
+ results = search_replace.replace("Author", "Writer")
185
+
186
+ self.assertNotIn(self.template1.UID(), results.keys())
187
+ template2_results = results[self.template2.UID()]
188
+ self.assertEqual(len(template2_results), 1)
189
+
190
+ self.assertEqual("Author", template2_results[0].keyword)
191
+ self.assertIn("Author", template2_results[0].content)
192
+ self.assertNotIn("Author", template2_results[0].patched)
193
+ self.assertIn("Writer", template2_results[0].patched)
194
+
195
+ # Verification with search
196
+ with SearchAndReplacePODTemplates((self.template2,)) as search_replace:
197
+ writer_search = search_replace.search("Writer")
198
+ author_search = search_replace.search("Author")
199
+
200
+ template2_writer_search = writer_search[self.template2.UID()]
201
+ self.assertGreater(len(template2_writer_search), 0)
202
+
203
+ self.assertNotIn(self.template2.UID(), author_search.keys())
204
+
205
+ def test_can_replace_regex(self):
206
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
207
+ # We want only the `view` before the `get_localized_field_name` method
208
+ results = search_replace.replace(
209
+ "view(?=.get_localized_field_name)", "NewView", is_regex=True
210
+ )
211
+
212
+ template1_results = results[self.template1.UID()]
213
+ self.assertEqual(len(template1_results), 1)
214
+ self.assertNotIn(self.template2.UID(), results.keys()) # Nothing in template2
215
+
216
+ self.assertIn("view.get_localized_field_name", template1_results[0].content)
217
+ self.assertIn("NewView.get_localized_field_name", template1_results[0].patched)
218
+
219
+ # Verification with search
220
+ with SearchAndReplacePODTemplates((self.template1,)) as search_replace:
221
+ results = search_replace.search("NewView")
222
+
223
+ result = results[self.template1.UID()]
224
+ self.assertEqual("NewView", result[0].keyword)
225
+
226
+ def test_can_replace_multiple_times(self):
227
+ with SearchAndReplacePODTemplates((self.template2,)) as search_replace:
228
+ search_replace.replace("Author", "Writer")
229
+ search_replace.replace("Writer", "Écrivain")
230
+ results = search_replace.replace("Écrivain", "Schrijver")
231
+
232
+ template2_results = results[self.template2.UID()]
233
+ self.assertEqual(len(template2_results), 1)
234
+ self.assertIn("Schrijver", template2_results[0].patched)
235
+ self.assertNotIn("Author", template2_results[0].patched)
236
+
237
+ # Verification with search
238
+ with SearchAndReplacePODTemplates((self.template2,)) as search_replace:
239
+ results = search_replace.search("Schrijver")
240
+
241
+ template2_results = results[self.template2.UID()]
242
+ self.assertEqual(len(template2_results), 1)
243
+ self.assertEqual("Schrijver", template2_results[0].keyword)
244
+ self.assertIn("Schrijver", template2_results[0].content)
245
+
246
+ def test_replace_clean_after_itself(self):
247
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
248
+ tmp_dir = search_replace.tmp_dir
249
+ search_replace.replace("View", "view")
250
+
251
+ self.assertFalse(os.path.exists(tmp_dir))
252
+ # Test if it clean after itself after an exception is raised
253
+ try:
254
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
255
+ tmp_dir = search_replace.tmp_dir
256
+ search_replace.replace("View", "view")
257
+ raise OSError
258
+ except OSError:
259
+ pass
260
+
261
+ self.assertFalse(os.path.exists(tmp_dir))
262
+
263
+ def test_can_replace_in_ods(self):
264
+ with SearchAndReplacePODTemplates((self.ods_template,)) as search_replace:
265
+ brain_results = search_replace.replace("brain", "cell")
266
+ not_found_results = search_replace.replace("Nowhere to be found", "xxx")
267
+ regex_results = search_replace.replace(
268
+ "view\\..*\\.results\\(\\)", "regex are evil", is_regex=True
269
+ )
270
+ # At the regex start, '^' was failing before
271
+ regex_start_results = search_replace.replace("^do row", "do this", is_regex=True)
272
+
273
+ self.assertNotIn(self.ods_template.UID(), not_found_results.keys())
274
+ self.assertIn(self.ods_template.UID(), regex_start_results.keys())
275
+ ods_brain_results = brain_results[self.ods_template.UID()]
276
+ ods_regex_results = regex_results[self.ods_template.UID()]
277
+
278
+ self.assertIn("brain", ods_brain_results[0].content)
279
+ self.assertNotIn("brain", ods_brain_results[0].patched)
280
+ self.assertIn("cell", ods_brain_results[0].patched)
281
+
282
+ self.assertIn("view.real_context.results()", ods_regex_results[0].content)
283
+ self.assertIn("regex are evil", ods_regex_results[0].patched)
284
+
285
+ # Verification with search
286
+ with SearchAndReplacePODTemplates((self.ods_template,)) as search_replace:
287
+ cell_search = search_replace.search("cell")
288
+ regex_search = search_replace.search("regex are evil")
289
+
290
+ self.assertIn(self.ods_template.UID(), cell_search.keys())
291
+ self.assertIn(self.ods_template.UID(), regex_search.keys())
292
+
293
+ self.assertIn("cell", cell_search[self.ods_template.UID()][0].content)
294
+ self.assertIn("regex are evil", regex_search[self.ods_template.UID()][0].content)
295
+
296
+ def test_replace_can_replace_in_headers_and_footers(self):
297
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
298
+ header_results = search_replace.replace(
299
+ "context.title.upper()", "context.title.lower()"
300
+ )
301
+ footer_results = search_replace.replace(
302
+ "^view.display_date", "view.new_method", is_regex=True
303
+ )
304
+
305
+ self.assertNotIn(self.template1.UID(), header_results.keys())
306
+ self.assertNotIn(self.template1.UID(), footer_results.keys())
307
+
308
+ self.assertIn("context.title.lower()", header_results[self.template2.UID()][0].patched)
309
+ self.assertIn("view.new_method(", footer_results[self.template2.UID()][0].patched)
310
+
311
+ # Verification with search
312
+ with SearchAndReplacePODTemplates((self.template2,)) as search_replace:
313
+ header_results = search_replace.search("context.title.lower()")
314
+ footer_results = search_replace.search("view.new_method(")
315
+
316
+ self.assertGreater(len(header_results), 0)
317
+ self.assertEqual("context.title.lower()", header_results[self.template2.UID()][0].keyword)
318
+
319
+ self.assertGreater(len(footer_results), 0)
320
+ self.assertEqual("view.new_method(", footer_results[self.template2.UID()][0].keyword)
321
+
322
+ def test_podtemplate_is_still_functional_after_search_replace(self):
323
+ with SearchAndReplacePODTemplates((self.template2,)) as search_replace:
324
+ search_replace.replace("context.description", "context.title")
325
+ search_replace.search("context.description")
326
+
327
+ template_uid = self.template2.UID()
328
+ view = self.portal.podtemplates.restrictedTraverse("@@document-generation")
329
+ self.assertIn("pdf", self.template2.get_available_formats())
330
+ generated_doc = view(template_uid, "pdf")
331
+ self.assertEqual("%PDF", generated_doc[:4])
332
+
333
+ def test_search_replace_control_panel_anonymous_unauthorized(self):
334
+ app = self.layer["app"]
335
+ browser = Browser(app)
336
+ browser.handleErrors = False
337
+ with self.assertRaises(Unauthorized): # Anonymous cannot access this page
338
+ browser.open(
339
+ "{}/@@collective.documentgenerator-searchreplacepanel".format(
340
+ self.portal.absolute_url()
341
+ )
342
+ )
343
+
344
+ def test_search_replace_control_panel_doesnt_fail(self):
345
+ # self.browser is logged in as admin
346
+ self.browser.handleErrors = False
347
+ self.browser.open(
348
+ "{}/@@collective.documentgenerator-searchreplacepanel".format(
349
+ self.portal.absolute_url()
350
+ )
351
+ )
352
+
353
+ def test_search_replace_control_panel_can_preview(self):
354
+ view = self.portal.restrictedTraverse("@@collective.documentgenerator-searchreplacepanel")
355
+ selected_templates_mock = [self.template1.UID(), self.template2.UID()]
356
+ replacements_mock = [
357
+ {
358
+ "search_expr": "^view.display_date",
359
+ "replace_expr": "view.display_new_date",
360
+ "is_regex": True,
361
+ },
362
+ {"search_expr": "Author", "replace_expr": "Writer", "is_regex": False},
363
+ ]
364
+ form_data = {
365
+ "selected_templates": selected_templates_mock,
366
+ "replacements": replacements_mock,
367
+ }
368
+
369
+ view.form_instance.perform_preview(form_data)
370
+ view()
371
+
372
+ def test_search_replace_control_panel_can_replace(self):
373
+ view = self.portal.restrictedTraverse("@@collective.documentgenerator-searchreplacepanel")
374
+ selected_templates_mock = [self.template1.UID(), self.template2.UID()]
375
+ replacements_mock = [
376
+ {
377
+ "search_expr": "^view.display_date",
378
+ "replace_expr": "view.display_new_date",
379
+ "is_regex": True,
380
+ },
381
+ {"search_expr": "Author", "replace_expr": "Writer", "is_regex": False},
382
+ ]
383
+ form_data = {
384
+ "selected_templates": selected_templates_mock,
385
+ "replacements": replacements_mock,
386
+ }
387
+
388
+ view.form_instance.perform_replacements(form_data)
389
+ view()
390
+
391
+ def test_search_replace_control_panel_regex_validator(self):
392
+ view = self.portal.restrictedTraverse("@@collective.documentgenerator-searchreplacepanel")
393
+ form = view.form_instance
394
+ form.update()
395
+ selected_templates = [self.template1.UID(), self.template2.UID()]
396
+ replacements = [
397
+ {"search_expr": "get_elements(", "replace_expr": "", "is_regex": False},
398
+ {"search_expr": "get_elements(", "replace_expr": "", "is_regex": True},
399
+ ]
400
+ data = {"replacements": replacements, "selected_templates": selected_templates}
401
+ errors = form.widgets.validate(data)
402
+ self.assertEqual(len(errors), 1)
403
+ self.assertTrue(isinstance(errors[0], Invalid))
404
+ self.assertEqual(errors[0].message, u'Incorrect regex at row #2 : "get_elements("')
405
+ replacements = [
406
+ {"search_expr": "get_elements(", "replace_expr": "", "is_regex": False},
407
+ {"search_expr": "valid_regex?", "replace_expr": "", "is_regex": True},
408
+ ]
409
+ data = {"replacements": replacements}
410
+ errors = form.widgets.validate(data)
411
+ self.assertFalse(errors)
412
+
413
+ def test_no_odt_file_or_no_filename(self):
414
+ self.template1.odt_file = None
415
+ self.template2.odt_file.filename = None
416
+ with SearchAndReplacePODTemplates((self.template1, self.template2)) as search_replace:
417
+ results = search_replace.search("view")
418
+
419
+ self.assertEqual(len(results.keys()), 0)