collective.documentgenerator 4.0__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 (167) hide show
  1. collective/documentgenerator/DX_renderer.py +51 -0
  2. collective/documentgenerator/__init__.py +11 -0
  3. collective/documentgenerator/adapters.py +30 -0
  4. collective/documentgenerator/browser/__init__.py +0 -0
  5. collective/documentgenerator/browser/actionspanel.py +19 -0
  6. collective/documentgenerator/browser/check_pod_templates.pt +86 -0
  7. collective/documentgenerator/browser/children_pod_template.pt +27 -0
  8. collective/documentgenerator/browser/configure.zcml +217 -0
  9. collective/documentgenerator/browser/controlpanel.py +165 -0
  10. collective/documentgenerator/browser/generation_view.py +613 -0
  11. collective/documentgenerator/browser/overrides.py +9 -0
  12. collective/documentgenerator/browser/resources/css/documentgenerator.css +133 -0
  13. collective/documentgenerator/browser/static/.gitkeep +0 -0
  14. collective/documentgenerator/browser/static/configurable.svg +1232 -0
  15. collective/documentgenerator/browser/static/csv.svg +521 -0
  16. collective/documentgenerator/browser/static/doc.svg +23 -0
  17. collective/documentgenerator/browser/static/docx.svg +20 -0
  18. collective/documentgenerator/browser/static/download_icon.svg +54 -0
  19. collective/documentgenerator/browser/static/libreoffice-blanck.svg +481 -0
  20. collective/documentgenerator/browser/static/mailinglooptemplate.svg +1207 -0
  21. collective/documentgenerator/browser/static/missing_use.svg +42 -0
  22. collective/documentgenerator/browser/static/nok.svg +38 -0
  23. collective/documentgenerator/browser/static/nok_use.svg +38 -0
  24. collective/documentgenerator/browser/static/nok_used.svg +38 -0
  25. collective/documentgenerator/browser/static/odp.svg +1264 -0
  26. collective/documentgenerator/browser/static/ods.svg +1354 -0
  27. collective/documentgenerator/browser/static/odt.svg +1347 -0
  28. collective/documentgenerator/browser/static/ok.svg +38 -0
  29. collective/documentgenerator/browser/static/ok_use.svg +38 -0
  30. collective/documentgenerator/browser/static/ok_used.svg +38 -0
  31. collective/documentgenerator/browser/static/pdf.svg +557 -0
  32. collective/documentgenerator/browser/static/podtemplate.svg +1197 -0
  33. collective/documentgenerator/browser/static/rtf.svg +521 -0
  34. collective/documentgenerator/browser/static/style.svg +1207 -0
  35. collective/documentgenerator/browser/static/subtemplate.svg +1232 -0
  36. collective/documentgenerator/browser/static/xls.svg +159 -0
  37. collective/documentgenerator/browser/static/xlsx.svg +48 -0
  38. collective/documentgenerator/browser/table.py +326 -0
  39. collective/documentgenerator/browser/templates_listing.pt +29 -0
  40. collective/documentgenerator/browser/views.py +366 -0
  41. collective/documentgenerator/config.py +174 -0
  42. collective/documentgenerator/configure.zcml +51 -0
  43. collective/documentgenerator/content/__init__.py +0 -0
  44. collective/documentgenerator/content/condition.py +66 -0
  45. collective/documentgenerator/content/conditions.zcml +30 -0
  46. collective/documentgenerator/content/configure.zcml +18 -0
  47. collective/documentgenerator/content/document_factory.py +73 -0
  48. collective/documentgenerator/content/file_representation.py +70 -0
  49. collective/documentgenerator/content/file_representation.zcml +29 -0
  50. collective/documentgenerator/content/merge_templates.py +15 -0
  51. collective/documentgenerator/content/merge_templates.zcml +11 -0
  52. collective/documentgenerator/content/pod_template.py +601 -0
  53. collective/documentgenerator/content/style_template.py +54 -0
  54. collective/documentgenerator/content/vocabulary.py +344 -0
  55. collective/documentgenerator/content/vocabulary.zcml +105 -0
  56. collective/documentgenerator/demo/__init__.py +0 -0
  57. collective/documentgenerator/demo/configure.zcml +18 -0
  58. collective/documentgenerator/demo/helper.py +170 -0
  59. collective/documentgenerator/events/__init__.py +0 -0
  60. collective/documentgenerator/events/configure.zcml +44 -0
  61. collective/documentgenerator/events/pod_templates_events.py +66 -0
  62. collective/documentgenerator/events/styles_events.py +151 -0
  63. collective/documentgenerator/helper/__init__.py +7 -0
  64. collective/documentgenerator/helper/base.py +334 -0
  65. collective/documentgenerator/helper/configure.zcml +34 -0
  66. collective/documentgenerator/helper/dexterity.py +178 -0
  67. collective/documentgenerator/interfaces.py +166 -0
  68. collective/documentgenerator/locales/collective.documentgenerator.pot +564 -0
  69. collective/documentgenerator/locales/es/LC_MESSAGES/collective.documentgenerator.po +572 -0
  70. collective/documentgenerator/locales/es/LC_MESSAGES/plone.po +32 -0
  71. collective/documentgenerator/locales/fr/LC_MESSAGES/collective.documentgenerator.po +566 -0
  72. collective/documentgenerator/locales/fr/LC_MESSAGES/plone.po +27 -0
  73. collective/documentgenerator/locales/manual.pot +30 -0
  74. collective/documentgenerator/locales/plone-manual.pot +22 -0
  75. collective/documentgenerator/locales/plone.pot +30 -0
  76. collective/documentgenerator/locales/update.sh +22 -0
  77. collective/documentgenerator/migrations/__init__.py +0 -0
  78. collective/documentgenerator/migrations/migrate_to_11.py +52 -0
  79. collective/documentgenerator/migrations/migrate_to_12.py +32 -0
  80. collective/documentgenerator/migrations/migrate_to_13.py +35 -0
  81. collective/documentgenerator/migrations/migrate_to_3.py +36 -0
  82. collective/documentgenerator/migrations/migrate_to_5.py +30 -0
  83. collective/documentgenerator/migrations/migrate_to_6.py +27 -0
  84. collective/documentgenerator/migrations/migrate_to_7.py +34 -0
  85. collective/documentgenerator/migrations/migrate_to_8.py +36 -0
  86. collective/documentgenerator/migrations/migrate_to_9.py +50 -0
  87. collective/documentgenerator/profiles/base/browserlayer.xml +6 -0
  88. collective/documentgenerator/profiles/base/controlpanel.xml +21 -0
  89. collective/documentgenerator/profiles/base/metadata.xml +8 -0
  90. collective/documentgenerator/profiles/base/registry.xml +48 -0
  91. collective/documentgenerator/profiles/base/types/ConfigurablePODTemplate.xml +69 -0
  92. collective/documentgenerator/profiles/base/types/MailingLoopTemplate.xml +68 -0
  93. collective/documentgenerator/profiles/base/types/PODTemplate.xml +68 -0
  94. collective/documentgenerator/profiles/base/types/StyleTemplate.xml +68 -0
  95. collective/documentgenerator/profiles/base/types/SubTemplate.xml +68 -0
  96. collective/documentgenerator/profiles/base/types.xml +22 -0
  97. collective/documentgenerator/profiles/base/viewlets.xml +10 -0
  98. collective/documentgenerator/profiles/demo/browserlayer.xml +6 -0
  99. collective/documentgenerator/profiles/demo/collectivedocumentgenerator_demo_marker.txt +0 -0
  100. collective/documentgenerator/profiles/demo/import_steps.xml +11 -0
  101. collective/documentgenerator/profiles/demo/metadata.xml +7 -0
  102. collective/documentgenerator/profiles/demo/registry.xml +14 -0
  103. collective/documentgenerator/profiles/demo/templates/mailing.odt +0 -0
  104. collective/documentgenerator/profiles/demo/templates/modele_general.ods +0 -0
  105. collective/documentgenerator/profiles/demo/templates/modele_general.odt +0 -0
  106. collective/documentgenerator/profiles/demo/templates/mod/303/250le_collection.odt +0 -0
  107. collective/documentgenerator/profiles/demo/templates/possibly_mailed_model.odt +0 -0
  108. collective/documentgenerator/profiles/demo/templates/styles.odt +0 -0
  109. collective/documentgenerator/profiles/demo/templates/styles_2.odt +0 -0
  110. collective/documentgenerator/profiles/demo/templates/sub_template.odt +0 -0
  111. collective/documentgenerator/profiles/demo/viewlets.xml +3 -0
  112. collective/documentgenerator/profiles/testing/metadata.xml +7 -0
  113. collective/documentgenerator/profiles/testing/types/member.xml +114 -0
  114. collective/documentgenerator/profiles/testing/types.xml +9 -0
  115. collective/documentgenerator/profiles/uninstall/browserlayer.xml +7 -0
  116. collective/documentgenerator/profiles/uninstall/controlpanel.xml +21 -0
  117. collective/documentgenerator/profiles/uninstall/metadata.xml +4 -0
  118. collective/documentgenerator/profiles/uninstall/registry.xml +14 -0
  119. collective/documentgenerator/profiles/uninstall/types.xml +27 -0
  120. collective/documentgenerator/profiles/uninstall/viewlets.xml +8 -0
  121. collective/documentgenerator/profiles.zcml +209 -0
  122. collective/documentgenerator/renderer.zcml +36 -0
  123. collective/documentgenerator/search_replace/__init__.py +0 -0
  124. collective/documentgenerator/search_replace/configure.zcml +21 -0
  125. collective/documentgenerator/search_replace/pod_template.py +161 -0
  126. collective/documentgenerator/search_replace/search_result_form.pt +76 -0
  127. collective/documentgenerator/search_replace/searchreplace_panel.pt +31 -0
  128. collective/documentgenerator/search_replace/searchreplace_panel.py +274 -0
  129. collective/documentgenerator/setuphandlers.py +297 -0
  130. collective/documentgenerator/testing.py +278 -0
  131. collective/documentgenerator/testing.zcml +17 -0
  132. collective/documentgenerator/tests/__init__.py +0 -0
  133. collective/documentgenerator/tests/failing_template.odt +0 -0
  134. collective/documentgenerator/tests/robot/.gitkeep +0 -0
  135. collective/documentgenerator/tests/template_to_clean.odt +0 -0
  136. collective/documentgenerator/tests/template_without_style_page.odt +0 -0
  137. collective/documentgenerator/tests/test_DX_helper_view.py +398 -0
  138. collective/documentgenerator/tests/test_base_helper_view.py +216 -0
  139. collective/documentgenerator/tests/test_check_podtemplates_view.py +138 -0
  140. collective/documentgenerator/tests/test_config.py +119 -0
  141. collective/documentgenerator/tests/test_configurable_pod_template.py +467 -0
  142. collective/documentgenerator/tests/test_demo_profile.py +121 -0
  143. collective/documentgenerator/tests/test_events.py +187 -0
  144. collective/documentgenerator/tests/test_generation_view.py +680 -0
  145. collective/documentgenerator/tests/test_mailing_loop_template.py +48 -0
  146. collective/documentgenerator/tests/test_pod_template.py +190 -0
  147. collective/documentgenerator/tests/test_robot.py +26 -0
  148. collective/documentgenerator/tests/test_search_replace.py +485 -0
  149. collective/documentgenerator/tests/test_setup.py +77 -0
  150. collective/documentgenerator/tests/test_style_template.py +19 -0
  151. collective/documentgenerator/tests/test_sub_template.py +49 -0
  152. collective/documentgenerator/tests/test_templates_listing_view.py +120 -0
  153. collective/documentgenerator/tests/test_utils.py +205 -0
  154. collective/documentgenerator/tests/test_vocabulary.py +169 -0
  155. collective/documentgenerator/utils.py +245 -0
  156. collective/documentgenerator/viewlets/__init__.py +0 -0
  157. collective/documentgenerator/viewlets/batchactions.py +14 -0
  158. collective/documentgenerator/viewlets/configure.zcml +17 -0
  159. collective/documentgenerator/viewlets/generationlinks.pt +46 -0
  160. collective/documentgenerator/viewlets/generationlinks.py +67 -0
  161. collective.documentgenerator-4.0-py3.12-nspkg.pth +1 -0
  162. collective_documentgenerator-4.0.dist-info/METADATA +1136 -0
  163. collective_documentgenerator-4.0.dist-info/RECORD +167 -0
  164. collective_documentgenerator-4.0.dist-info/WHEEL +5 -0
  165. collective_documentgenerator-4.0.dist-info/entry_points.txt +2 -0
  166. collective_documentgenerator-4.0.dist-info/namespace_packages.txt +1 -0
  167. collective_documentgenerator-4.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,485 @@
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(
27
+ (self.template1, self.template2)
28
+ ) as search_replace:
29
+ results = search_replace.search("view")
30
+
31
+ self.assertGreater(len(results.keys()), 0)
32
+
33
+ def test_search_dont_alter_podtemplate(self):
34
+ template1_md5 = compute_md5(self.template1.odt_file.data)
35
+ template2_md5 = compute_md5(self.template2.odt_file.data)
36
+
37
+ with SearchAndReplacePODTemplates(
38
+ (self.template1, self.template2)
39
+ ) as search_replace:
40
+ search_replace.search("view")
41
+
42
+ self.assertEqual(compute_md5(self.template1.odt_file.data), template1_md5)
43
+ self.assertEqual(compute_md5(self.template2.odt_file.data), template2_md5)
44
+
45
+ def test_can_search_regex(self):
46
+ with SearchAndReplacePODTemplates(
47
+ (self.template1, self.template2)
48
+ ) as search_replace:
49
+ # We want only the `view` before the `get_localized_field_name` method
50
+ results = search_replace.search(
51
+ "view(?=.get_localized_field_name)", is_regex=True
52
+ )
53
+
54
+ template1_results = results[self.template1.UID()]
55
+ self.assertEqual(len(template1_results), 1)
56
+ self.assertIn("view.get_localized_field_name", template1_results[0].content)
57
+
58
+ self.assertNotIn(self.template2.UID(), results.keys()) # Nothing in template2
59
+
60
+ def test_can_search_string(self):
61
+ with SearchAndReplacePODTemplates(
62
+ (self.template1, self.template2)
63
+ ) as search_replace:
64
+ results = search_replace.search("Author")
65
+
66
+ self.assertNotIn(self.template1.UID(), results.keys())
67
+ template2_results = results[self.template2.UID()]
68
+ self.assertEqual(len(template2_results), 1)
69
+
70
+ self.assertIn("Author", template2_results[0].content)
71
+
72
+ def test_can_search_in_ods(self):
73
+ with SearchAndReplacePODTemplates((self.ods_template,)) as search_replace:
74
+ not_found_results = search_replace.search("Nowhere to be found")
75
+ brain_results = search_replace.search("brain")
76
+ regex_results = search_replace.search(
77
+ "view\\..*\\.results\\(\\)", is_regex=True
78
+ )
79
+ # At the regex start, '^' was failing before
80
+ regex_start_results = search_replace.search("^do row", is_regex=True)
81
+
82
+ self.assertNotIn(self.ods_template.UID(), not_found_results.keys())
83
+ self.assertIn(self.ods_template.UID(), regex_start_results.keys())
84
+ ods_brain_results = brain_results[self.ods_template.UID()]
85
+ ods_regex_results = regex_results[self.ods_template.UID()]
86
+
87
+ self.assertEqual(len(ods_brain_results), 4)
88
+ self.assertEqual(len(ods_regex_results), 1)
89
+ for result in ods_brain_results:
90
+ self.assertIn("brain", result.content)
91
+
92
+ self.assertIn("view.real_context.results()", ods_regex_results[0].content)
93
+
94
+ def test_can_search_in_headers_and_footers(self):
95
+ with SearchAndReplacePODTemplates(
96
+ (self.template1, self.template2)
97
+ ) as search_replace:
98
+ header_results = search_replace.search("context.title.upper()")
99
+ footer_results = search_replace.search("^view.display_date", is_regex=True)
100
+
101
+ self.assertNotIn(self.template1.UID(), header_results.keys())
102
+ self.assertNotIn(self.template1.UID(), footer_results.keys())
103
+
104
+ self.assertEqual(len(header_results[self.template2.UID()]), 1)
105
+ self.assertIn(
106
+ "context.title.upper()", header_results[self.template2.UID()][0].content
107
+ )
108
+
109
+ self.assertEqual(len(footer_results[self.template2.UID()]), 1)
110
+ self.assertIn(
111
+ "view.display_date", footer_results[self.template2.UID()][0].content
112
+ )
113
+
114
+ def test_can_search_multiple_times(self):
115
+ with SearchAndReplacePODTemplates((self.template1,)) as search_replace:
116
+ not_found_results = search_replace.search("Nowhere to be found")
117
+ view_results = search_replace.search("view")
118
+ regex_results = search_replace.search(
119
+ "view(?=.get_localized_field_name)", is_regex=True
120
+ )
121
+
122
+ template1_uid = self.template1.UID()
123
+
124
+ self.assertNotEqual(not_found_results, view_results)
125
+ self.assertNotEqual(view_results, regex_results)
126
+
127
+ self.assertNotIn(template1_uid, not_found_results)
128
+
129
+ for result in view_results[template1_uid]:
130
+ self.assertIn("view", result.content)
131
+
132
+ self.assertEqual(len(regex_results[template1_uid]), 1)
133
+ self.assertIn(
134
+ "view.get_localized_field_name", regex_results[template1_uid][0].content
135
+ )
136
+
137
+ def test_search_clean_after_itself(self):
138
+ with SearchAndReplacePODTemplates(
139
+ (self.template1, self.template2)
140
+ ) as search_replace:
141
+ tmp_dir = search_replace.tmp_dir
142
+ search_replace.search("view")
143
+
144
+ self.assertFalse(os.path.exists(tmp_dir))
145
+
146
+ # Test if it clean after itself after an exception is raised
147
+ try:
148
+ with SearchAndReplacePODTemplates(
149
+ (self.template1, self.template2)
150
+ ) as search_replace:
151
+ tmp_dir = search_replace.tmp_dir
152
+ search_replace.search("view")
153
+ raise OSError
154
+ except OSError:
155
+ pass
156
+
157
+ self.assertFalse(os.path.exists(tmp_dir))
158
+
159
+ def test_can_replace_in_podtemplate(self):
160
+ with SearchAndReplacePODTemplates(
161
+ (self.template1, self.template2)
162
+ ) as search_replace:
163
+ results = search_replace.replace("view", "View")
164
+
165
+ self.assertGreater(len(results), 0)
166
+
167
+ def test_replace_change_podtemplate_file(self):
168
+ template1_md5 = compute_md5(self.template1.odt_file.data)
169
+ template2_md5 = compute_md5(self.template2.odt_file.data)
170
+
171
+ with SearchAndReplacePODTemplates(
172
+ (self.template1, self.template2)
173
+ ) as search_replace:
174
+ search_replace.replace("view", "View")
175
+
176
+ self.assertNotEqual(compute_md5(self.template1.odt_file.data), template1_md5)
177
+ self.assertNotEqual(compute_md5(self.template2.odt_file.data), template2_md5)
178
+
179
+ def test_replace_dont_alter_pod_template_odt_file_structure(self):
180
+ with SearchAndReplacePODTemplates((self.template1,)) as search_replace:
181
+ search_replace.replace("view", "View")
182
+
183
+ zip_bytes = io.BytesIO(self.template1.odt_file.data)
184
+ zip_file = zipfile.ZipFile(zip_bytes)
185
+ odt_subfiles = zip_file.namelist()
186
+
187
+ expected_files = [
188
+ u"mimetype",
189
+ u"content.xml",
190
+ u"styles.xml",
191
+ u"meta.xml",
192
+ u"settings.xml",
193
+ u"manifest.rdf",
194
+ u"META-INF/manifest.xml",
195
+ ]
196
+
197
+ for expected_file in expected_files:
198
+ self.assertIn(expected_file, odt_subfiles)
199
+
200
+ def test_replace_dont_change_podtemplate_file_size_too_much(self):
201
+ before_template1_filesize = self.template1.odt_file.getSize()
202
+ before_template2_filesize = self.template2.odt_file.getSize()
203
+
204
+ with SearchAndReplacePODTemplates(
205
+ (self.template1, self.template2)
206
+ ) as search_replace:
207
+ search_replace.replace("view", "View")
208
+
209
+ self.assertAlmostEqual(
210
+ before_template1_filesize, self.template1.odt_file.getSize(), delta=1000
211
+ )
212
+ self.assertAlmostEqual(
213
+ before_template2_filesize, self.template2.odt_file.getSize(), delta=1000
214
+ )
215
+
216
+ def test_can_replace_string(self):
217
+ with SearchAndReplacePODTemplates(
218
+ (self.template1, self.template2)
219
+ ) as search_replace:
220
+ results = search_replace.replace("Author", "Writer")
221
+
222
+ self.assertNotIn(self.template1.UID(), results.keys())
223
+ template2_results = results[self.template2.UID()]
224
+ self.assertEqual(len(template2_results), 1)
225
+
226
+ self.assertEqual("Author", template2_results[0].keyword)
227
+ self.assertIn("Author", template2_results[0].content)
228
+ self.assertNotIn("Author", template2_results[0].patched)
229
+ self.assertIn("Writer", template2_results[0].patched)
230
+
231
+ # Verification with search
232
+ with SearchAndReplacePODTemplates((self.template2,)) as search_replace:
233
+ writer_search = search_replace.search("Writer")
234
+ author_search = search_replace.search("Author")
235
+
236
+ template2_writer_search = writer_search[self.template2.UID()]
237
+ self.assertGreater(len(template2_writer_search), 0)
238
+
239
+ self.assertNotIn(self.template2.UID(), author_search.keys())
240
+
241
+ def test_can_replace_regex(self):
242
+ with SearchAndReplacePODTemplates(
243
+ (self.template1, self.template2)
244
+ ) as search_replace:
245
+ # We want only the `view` before the `get_localized_field_name` method
246
+ results = search_replace.replace(
247
+ "view(?=.get_localized_field_name)", "NewView", is_regex=True
248
+ )
249
+
250
+ template1_results = results[self.template1.UID()]
251
+ self.assertEqual(len(template1_results), 1)
252
+ self.assertNotIn(self.template2.UID(), results.keys()) # Nothing in template2
253
+
254
+ self.assertIn("view.get_localized_field_name", template1_results[0].content)
255
+ self.assertIn("NewView.get_localized_field_name", template1_results[0].patched)
256
+
257
+ # Verification with search
258
+ with SearchAndReplacePODTemplates((self.template1,)) as search_replace:
259
+ results = search_replace.search("NewView")
260
+
261
+ result = results[self.template1.UID()]
262
+ self.assertEqual("NewView", result[0].keyword)
263
+
264
+ def test_can_replace_multiple_times(self):
265
+ with SearchAndReplacePODTemplates((self.template2,)) as search_replace:
266
+ search_replace.replace("Author", "Writer")
267
+ search_replace.replace("Writer", "Écrivain")
268
+ results = search_replace.replace("Écrivain", "Schrijver")
269
+
270
+ template2_results = results[self.template2.UID()]
271
+ self.assertEqual(len(template2_results), 1)
272
+ self.assertIn("Schrijver", template2_results[0].patched)
273
+ self.assertNotIn("Author", template2_results[0].patched)
274
+
275
+ # Verification with search
276
+ with SearchAndReplacePODTemplates((self.template2,)) as search_replace:
277
+ results = search_replace.search("Schrijver")
278
+
279
+ template2_results = results[self.template2.UID()]
280
+ self.assertEqual(len(template2_results), 1)
281
+ self.assertEqual("Schrijver", template2_results[0].keyword)
282
+ self.assertIn("Schrijver", template2_results[0].content)
283
+
284
+ def test_replace_clean_after_itself(self):
285
+ with SearchAndReplacePODTemplates(
286
+ (self.template1, self.template2)
287
+ ) as search_replace:
288
+ tmp_dir = search_replace.tmp_dir
289
+ search_replace.replace("View", "view")
290
+
291
+ self.assertFalse(os.path.exists(tmp_dir))
292
+ # Test if it clean after itself after an exception is raised
293
+ try:
294
+ with SearchAndReplacePODTemplates(
295
+ (self.template1, self.template2)
296
+ ) as search_replace:
297
+ tmp_dir = search_replace.tmp_dir
298
+ search_replace.replace("View", "view")
299
+ raise OSError
300
+ except OSError:
301
+ pass
302
+
303
+ self.assertFalse(os.path.exists(tmp_dir))
304
+
305
+ def test_can_replace_in_ods(self):
306
+ with SearchAndReplacePODTemplates((self.ods_template,)) as search_replace:
307
+ brain_results = search_replace.replace("brain", "cell")
308
+ not_found_results = search_replace.replace("Nowhere to be found", "xxx")
309
+ regex_results = search_replace.replace(
310
+ "view\\..*\\.results\\(\\)", "regex are evil", is_regex=True
311
+ )
312
+ # At the regex start, '^' was failing before
313
+ regex_start_results = search_replace.replace(
314
+ "^do row", "do this", is_regex=True
315
+ )
316
+
317
+ self.assertNotIn(self.ods_template.UID(), not_found_results.keys())
318
+ self.assertIn(self.ods_template.UID(), regex_start_results.keys())
319
+ ods_brain_results = brain_results[self.ods_template.UID()]
320
+ ods_regex_results = regex_results[self.ods_template.UID()]
321
+
322
+ self.assertIn("brain", ods_brain_results[0].content)
323
+ self.assertNotIn("brain", ods_brain_results[0].patched)
324
+ self.assertIn("cell", ods_brain_results[0].patched)
325
+
326
+ self.assertIn("view.real_context.results()", ods_regex_results[0].content)
327
+ self.assertIn("regex are evil", ods_regex_results[0].patched)
328
+
329
+ # Verification with search
330
+ with SearchAndReplacePODTemplates((self.ods_template,)) as search_replace:
331
+ cell_search = search_replace.search("cell")
332
+ regex_search = search_replace.search("regex are evil")
333
+
334
+ self.assertIn(self.ods_template.UID(), cell_search.keys())
335
+ self.assertIn(self.ods_template.UID(), regex_search.keys())
336
+
337
+ self.assertIn("cell", cell_search[self.ods_template.UID()][0].content)
338
+ self.assertIn(
339
+ "regex are evil", regex_search[self.ods_template.UID()][0].content
340
+ )
341
+
342
+ def test_replace_can_replace_in_headers_and_footers(self):
343
+ with SearchAndReplacePODTemplates(
344
+ (self.template1, self.template2)
345
+ ) as search_replace:
346
+ header_results = search_replace.replace(
347
+ "context.title.upper()", "context.title.lower()"
348
+ )
349
+ footer_results = search_replace.replace(
350
+ "^view.display_date", "view.new_method", is_regex=True
351
+ )
352
+
353
+ self.assertNotIn(self.template1.UID(), header_results.keys())
354
+ self.assertNotIn(self.template1.UID(), footer_results.keys())
355
+
356
+ self.assertIn(
357
+ "context.title.lower()", header_results[self.template2.UID()][0].patched
358
+ )
359
+ self.assertIn(
360
+ "view.new_method(", footer_results[self.template2.UID()][0].patched
361
+ )
362
+
363
+ # Verification with search
364
+ with SearchAndReplacePODTemplates((self.template2,)) as search_replace:
365
+ header_results = search_replace.search("context.title.lower()")
366
+ footer_results = search_replace.search("view.new_method(")
367
+
368
+ self.assertGreater(len(header_results), 0)
369
+ self.assertEqual(
370
+ "context.title.lower()", header_results[self.template2.UID()][0].keyword
371
+ )
372
+
373
+ self.assertGreater(len(footer_results), 0)
374
+ self.assertEqual(
375
+ "view.new_method(", footer_results[self.template2.UID()][0].keyword
376
+ )
377
+
378
+ def test_podtemplate_is_still_functional_after_search_replace(self):
379
+ with SearchAndReplacePODTemplates((self.template2,)) as search_replace:
380
+ search_replace.replace("context.description", "context.title")
381
+ search_replace.search("context.description")
382
+
383
+ template_uid = self.template2.UID()
384
+ view = self.portal.podtemplates.restrictedTraverse("@@document-generation")
385
+ self.assertIn("pdf", self.template2.get_available_formats())
386
+ generated_doc = view(template_uid, "pdf")
387
+ self.assertEqual(b"%PDF", generated_doc[:4])
388
+
389
+ def test_search_replace_control_panel_anonymous_unauthorized(self):
390
+ app = self.layer["app"]
391
+ browser = Browser(app)
392
+ browser.handleErrors = False
393
+ with self.assertRaises(Unauthorized): # Anonymous cannot access this page
394
+ browser.open(
395
+ "{}/@@collective.documentgenerator-searchreplacepanel".format(
396
+ self.portal.absolute_url()
397
+ )
398
+ )
399
+
400
+ def test_search_replace_control_panel_doesnt_fail(self):
401
+ # self.browser is logged in as admin
402
+ self.browser.handleErrors = False
403
+ self.browser.open(
404
+ "{}/@@collective.documentgenerator-searchreplacepanel".format(
405
+ self.portal.absolute_url()
406
+ )
407
+ )
408
+
409
+ def test_search_replace_control_panel_can_preview(self):
410
+ view = self.portal.restrictedTraverse(
411
+ "@@collective.documentgenerator-searchreplacepanel"
412
+ )
413
+ selected_templates_mock = [self.template1.UID(), self.template2.UID()]
414
+ replacements_mock = [
415
+ {
416
+ "search_expr": "^view.display_date",
417
+ "replace_expr": "view.display_new_date",
418
+ "is_regex": True,
419
+ },
420
+ {"search_expr": "Author", "replace_expr": "Writer", "is_regex": False},
421
+ ]
422
+ form_data = {
423
+ "selected_templates": selected_templates_mock,
424
+ "replacements": replacements_mock,
425
+ }
426
+
427
+ view.form_instance.perform_preview(form_data)
428
+ view()
429
+
430
+ def test_search_replace_control_panel_can_replace(self):
431
+ view = self.portal.restrictedTraverse(
432
+ "@@collective.documentgenerator-searchreplacepanel"
433
+ )
434
+ selected_templates_mock = [self.template1.UID(), self.template2.UID()]
435
+ replacements_mock = [
436
+ {
437
+ "search_expr": "^view.display_date",
438
+ "replace_expr": "view.display_new_date",
439
+ "is_regex": True,
440
+ },
441
+ {"search_expr": "Author", "replace_expr": "Writer", "is_regex": False},
442
+ ]
443
+ form_data = {
444
+ "selected_templates": selected_templates_mock,
445
+ "replacements": replacements_mock,
446
+ }
447
+
448
+ view.form_instance.perform_replacements(form_data)
449
+ view()
450
+
451
+ def test_search_replace_control_panel_regex_validator(self):
452
+ view = self.portal.restrictedTraverse(
453
+ "@@collective.documentgenerator-searchreplacepanel"
454
+ )
455
+ form = view.form_instance
456
+ form.update()
457
+ selected_templates = [self.template1.UID(), self.template2.UID()]
458
+ replacements = [
459
+ {"search_expr": "get_elements(", "replace_expr": "", "is_regex": False},
460
+ {"search_expr": "get_elements(", "replace_expr": "", "is_regex": True},
461
+ ]
462
+ data = {"replacements": replacements, "selected_templates": selected_templates}
463
+ errors = form.widgets.validate(data)
464
+ self.assertEqual(len(errors), 1)
465
+ self.assertTrue(isinstance(errors[0], Invalid))
466
+ self.assertEqual(
467
+ errors[0].args[0], u'Incorrect regex at row #2 : "get_elements("'
468
+ )
469
+ replacements = [
470
+ {"search_expr": "get_elements(", "replace_expr": "", "is_regex": False},
471
+ {"search_expr": "valid_regex?", "replace_expr": "", "is_regex": True},
472
+ ]
473
+ data = {"replacements": replacements}
474
+ errors = form.widgets.validate(data)
475
+ self.assertFalse(errors)
476
+
477
+ def test_no_odt_file_or_no_filename(self):
478
+ self.template1.odt_file = None
479
+ self.template2.odt_file.filename = None
480
+ with SearchAndReplacePODTemplates(
481
+ (self.template1, self.template2)
482
+ ) as search_replace:
483
+ results = search_replace.search("view")
484
+
485
+ self.assertEqual(len(results.keys()), 0)
@@ -0,0 +1,77 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from collective.documentgenerator.content.pod_template import POD_TEMPLATE_TYPES
4
+ from collective.documentgenerator.interfaces import ICollectiveDocumentGeneratorLayer
5
+ from collective.documentgenerator.testing import NAKED_PLONE_INTEGRATION
6
+ from collective.documentgenerator.testing import POD_TEMPLATE_INTEGRATION
7
+ from plone.browserlayer import utils
8
+ from Products.CMFPlone.utils import get_installer
9
+
10
+ import unittest
11
+
12
+
13
+ class TestInstallDependencies(unittest.TestCase):
14
+
15
+ layer = NAKED_PLONE_INTEGRATION
16
+
17
+ def setUp(self):
18
+ self.portal = self.layer["portal"]
19
+
20
+ def test_dexterity_is_dependency_of_documentgenerator(self):
21
+ """
22
+ dexterity should be installed when we install documentgenerator
23
+ """
24
+ dependencies = self.portal.portal_setup.getProfileDependencyChain(
25
+ "collective.documentgenerator:default"
26
+ )
27
+ self.assertIn(u"profile-plone.app.dexterity:default", dependencies)
28
+
29
+ def test_z3cformdatagridfield_is_dependency_of_documentgenerator(self):
30
+ """
31
+ z3cform.datagridfield should be installed when we install documentgenerator
32
+ """
33
+ dependencies = self.portal.portal_setup.getProfileDependencyChain(
34
+ "collective.documentgenerator:default"
35
+ )
36
+ self.assertIn(u"profile-collective.z3cform.datagridfield:default", dependencies)
37
+
38
+
39
+ class TestSetup(unittest.TestCase):
40
+
41
+ layer = POD_TEMPLATE_INTEGRATION
42
+
43
+ def setUp(self):
44
+ """Custom shared utility setup for tests."""
45
+ self.portal = self.layer["portal"]
46
+ self.installer = get_installer(self.portal)
47
+
48
+ def test_pod_templates_folder_allowed_types(self):
49
+
50
+ pod_folder = self.portal.podtemplates
51
+
52
+ allowed_types = [fti.__name__ for fti in pod_folder.allowedContentTypes()]
53
+
54
+ msg = "pod folder allowed content types should only be the ones from documentgenerator"
55
+ self.assertEqual(len(allowed_types), len(POD_TEMPLATE_TYPES), msg)
56
+ for portal_type in POD_TEMPLATE_TYPES:
57
+ msg = "type '{}' should be in pod folder allowed types".format(portal_type)
58
+ self.assertIn(portal_type, allowed_types, msg)
59
+
60
+ def test_product_installed(self):
61
+ """Test if collective.documentgenerator is installed with portal_quickinstaller."""
62
+ self.assertTrue(
63
+ self.installer.is_product_installed("collective.documentgenerator")
64
+ )
65
+
66
+ def test_uninstall(self):
67
+ """Test if collective.documentgenerator is cleanly uninstalled."""
68
+ self.installer.uninstall_product("collective.documentgenerator")
69
+ self.assertFalse(
70
+ self.installer.is_product_installed("collective.documentgenerator")
71
+ )
72
+
73
+ def test_browserlayer(self):
74
+ """Test that ICollectiveDocumentGeneratorLayer is registered."""
75
+ self.assertIn(ICollectiveDocumentGeneratorLayer, utils.registered_layers())
76
+ self.installer.uninstall_product("collective.documentgenerator")
77
+ self.assertNotIn(ICollectiveDocumentGeneratorLayer, utils.registered_layers())
@@ -0,0 +1,19 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from collective.documentgenerator.testing import TEST_INSTALL_INTEGRATION
4
+ from plone import api
5
+
6
+ import unittest
7
+
8
+
9
+ class TestStyleTemplate(unittest.TestCase):
10
+ """
11
+ Test StyleTemplate content type.
12
+ """
13
+
14
+ layer = TEST_INSTALL_INTEGRATION
15
+
16
+ def test_StyleTemplate_portal_type_is_registered(self):
17
+ portal_types = api.portal.get_tool("portal_types")
18
+ registered_types = portal_types.listContentTypes()
19
+ self.assertTrue("StyleTemplate" in registered_types)
@@ -0,0 +1,49 @@
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 TestSubTemplate(unittest.TestCase):
14
+ """
15
+ Test SubTemplate content type.
16
+ """
17
+
18
+ layer = TEST_INSTALL_INTEGRATION
19
+
20
+ def test_SubTemplate_portal_type_is_registered(self):
21
+ portal_types = api.portal.get_tool("portal_types")
22
+ registered_types = portal_types.listContentTypes()
23
+ self.assertTrue("SubTemplate" in registered_types)
24
+
25
+
26
+ class TestSubTemplateIntegration(unittest.TestCase):
27
+ """
28
+ Test PODTemplate methods.
29
+ """
30
+
31
+ layer = POD_TEMPLATE_INTEGRATION
32
+
33
+ def setUp(self):
34
+ super(TestSubTemplateIntegration, self).setUp()
35
+ self.portal = api.portal.get()
36
+ self.test_subtemplate = self.portal.podtemplates.get("sub_template")
37
+
38
+ def test_default_generation_condition_registration(self):
39
+ context = self.portal
40
+ condition_obj = queryMultiAdapter(
41
+ (self.test_subtemplate, context),
42
+ IPODTemplateCondition,
43
+ )
44
+
45
+ self.assertTrue(isinstance(condition_obj, PODTemplateCondition))
46
+
47
+ def test_default_generation_condition_is_False(self):
48
+ can_be_generated = self.test_subtemplate.can_be_generated(self.portal)
49
+ self.assertTrue(can_be_generated is False)