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,383 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from Acquisition import aq_base
4
+ from collective.documentgenerator.content.pod_template import IConfigurablePODTemplate
5
+ from collective.documentgenerator.content.pod_template import PodFormatsValidator
6
+ from collective.documentgenerator.interfaces import IPODTemplateCondition
7
+ from collective.documentgenerator.testing import ConfigurablePODTemplateIntegrationTest
8
+ from collective.documentgenerator.testing import TEST_INSTALL_INTEGRATION
9
+ from plone import api
10
+ from Products.CMFCore.permissions import AccessContentsInformation
11
+ from Products.CMFCore.permissions import View
12
+ from Products.CMFCore.utils import _checkPermission
13
+ from zope.component import queryMultiAdapter
14
+ from zope.i18n import translate
15
+ from zope.interface import Invalid
16
+
17
+ import unittest
18
+
19
+
20
+ class TestConfigurablePODTemplate(unittest.TestCase):
21
+ """
22
+ Test ConfigurablePODTemplate content type.
23
+ """
24
+
25
+ layer = TEST_INSTALL_INTEGRATION
26
+
27
+ def test_ConfigurablePODTemplate_portal_type_is_registered(self):
28
+ portal_types = api.portal.get_tool('portal_types')
29
+ registered_types = portal_types.listContentTypes()
30
+ self.assertTrue('ConfigurablePODTemplate' in registered_types)
31
+
32
+
33
+ class TestConfigurablePODTemplateFields(ConfigurablePODTemplateIntegrationTest):
34
+ """
35
+ Test schema fields declaration.
36
+ """
37
+
38
+ def test_class_registration(self):
39
+ from collective.documentgenerator.content.pod_template import ConfigurablePODTemplate
40
+ self.assertTrue(self.test_podtemplate.__class__ == ConfigurablePODTemplate)
41
+
42
+ def test_schema_registration(self):
43
+ portal_types = api.portal.get_tool('portal_types')
44
+ podtemplate_type = portal_types.get(self.test_podtemplate.portal_type)
45
+ self.assertTrue('IConfigurablePODTemplate' in podtemplate_type.schema)
46
+
47
+ def test_pod_portal_types_attribute(self):
48
+ test_podtemplate = aq_base(self.test_podtemplate)
49
+ self.assertTrue(hasattr(test_podtemplate, 'pod_portal_types'))
50
+
51
+ def test_pod_portal_types_field_display(self):
52
+ self.browser.open(self.test_podtemplate.absolute_url())
53
+ contents = self.browser.contents
54
+ msg = "field 'pod_portal_types' is not displayed"
55
+ self.assertTrue('id="form-widgets-pod_portal_types"' in contents, msg)
56
+ msg = "field 'pod_portal_types' is not translated"
57
+ self.assertTrue('Types de contenu autorisés' in contents, msg)
58
+
59
+ def test_pod_portal_types_field_edit(self):
60
+ contents = self._edit_object(self.test_podtemplate)
61
+ msg = "field 'pod_portal_types' is not editable"
62
+ self.assertTrue('Types de contenu autorisés' in contents, msg)
63
+
64
+ def test_style_template_attribute(self):
65
+ test_podtemplate = aq_base(self.test_podtemplate)
66
+ self.assertTrue(hasattr(test_podtemplate, 'style_template'))
67
+
68
+ def test_style_template_field_display(self):
69
+ self.browser.open(self.test_podtemplate.absolute_url())
70
+ contents = self.browser.contents
71
+ msg = "field 'style_template' is not displayed"
72
+ self.assertTrue('id="form-widgets-style_template"' in contents, msg)
73
+ msg = "field 'style_template' is not translated"
74
+ self.assertTrue('Modèle de style' in contents, msg)
75
+
76
+ def test_style_template_field_edit(self):
77
+ contents = self._edit_object(self.test_podtemplate)
78
+ msg = "field 'style_template' is not editable"
79
+ self.assertTrue('Modèle de style' in contents, msg)
80
+
81
+ def test_merge_templates_attribute(self):
82
+ test_podtemplate = aq_base(self.test_podtemplate)
83
+ self.assertTrue(hasattr(test_podtemplate, 'merge_templates'))
84
+
85
+ def test_merge_templates_field_display(self):
86
+ self.browser.open(self.test_podtemplate.absolute_url())
87
+ contents = self.browser.contents
88
+ msg = "field 'merge_templates' is not displayed"
89
+ self.assertTrue('id="form-widgets-merge_templates"' in contents, msg)
90
+ msg = "field 'merge_templates' is not translated"
91
+ self.assertTrue('Modèles à fusionner' in contents, msg)
92
+
93
+ def test_merge_templates_field_edit(self):
94
+ contents = self._edit_object(self.test_podtemplate)
95
+ msg = "field 'merge_templates' is not editable"
96
+ self.assertTrue('Modèles à fusionner' in contents, msg)
97
+
98
+
99
+ class TestConfigurablePODTemplateIntegration(ConfigurablePODTemplateIntegrationTest):
100
+ """
101
+ Test ConfigurablePODTemplate methods.
102
+ """
103
+
104
+ def test_get_file(self):
105
+ msg = "Accessor 'get_file' does not return odt_file field value."
106
+
107
+ reusable_template = self.portal.podtemplates.get('test_template_reusable')
108
+ self.test_podtemplate.pod_template_to_use = reusable_template.UID()
109
+
110
+ # template uses odt file from another
111
+ self.assertEqual(self.test_podtemplate.get_file(), reusable_template.odt_file, msg)
112
+ # template uses odt file from another
113
+ self.test_podtemplate.odt_file = None
114
+ self.assertEqual(self.test_podtemplate.get_file(), reusable_template.odt_file, msg)
115
+ self.assertEqual(reusable_template.get_file(), reusable_template.odt_file, msg)
116
+ # basic case without reuse
117
+ self.test_podtemplate.pod_template_to_use = None
118
+ self.assertEqual(self.test_podtemplate.get_file(), self.test_podtemplate.odt_file, msg)
119
+
120
+ def test_get_file_is_unrestricted(self):
121
+ """When reusing another POD template odt_file, we will get
122
+ the odt_file unrestricted in case user would not have access to the POD template."""
123
+ reusable_template = self.portal.podtemplates.get('test_template_reusable')
124
+ self.test_podtemplate.pod_template_to_use = reusable_template.UID()
125
+
126
+ # make reusable template not accessible
127
+ reusable_template.manage_permission(View, [])
128
+ reusable_template.manage_permission(AccessContentsInformation, [])
129
+ reusable_template.reindexObjectSecurity()
130
+
131
+ # get_file will correctly return the odt_file
132
+ self.assertFalse(_checkPermission(View, reusable_template))
133
+ self.assertFalse(_checkPermission(AccessContentsInformation, reusable_template))
134
+ self.assertFalse(self.portal.portal_catalog(UID=reusable_template.UID()))
135
+ self.assertEqual(self.test_podtemplate.get_file(), reusable_template.odt_file)
136
+
137
+ def test_get_filename(self):
138
+ self.assertEqual(self.test_podtemplate.get_filename(), u'mod\xe8le_collection.odt')
139
+ reusable_template = self.portal.podtemplates.get('test_template_reusable')
140
+ self.assertEqual(reusable_template.get_filename(), u'modele_general.odt')
141
+
142
+ def test_generation_condition_registration(self):
143
+ from collective.documentgenerator.content.condition import ConfigurablePODTemplateCondition
144
+
145
+ context = self.portal
146
+ condition_obj = queryMultiAdapter(
147
+ (self.test_podtemplate, context),
148
+ IPODTemplateCondition,
149
+ )
150
+
151
+ self.assertTrue(isinstance(condition_obj, ConfigurablePODTemplateCondition))
152
+
153
+ def test_can_be_generated(self):
154
+ self.test_podtemplate.pod_portal_types = []
155
+ self.assertTrue(self.test_podtemplate.can_be_generated(self.portal))
156
+
157
+ # Disable the template.
158
+ self.test_podtemplate.enabled = False
159
+ msg = 'disabled template should not be generated'
160
+ self.assertTrue(not self.test_podtemplate.can_be_generated(self.portal), msg)
161
+ # may be generated if enabled
162
+ self.test_podtemplate.enabled = True
163
+ self.assertTrue(self.test_podtemplate.can_be_generated(self.portal))
164
+
165
+ # Restrict allowed types to 'File'.
166
+ self.test_podtemplate.enabled = True
167
+ self.test_podtemplate.pod_portal_types = ['File']
168
+ msg = 'disabled template should not be generated'
169
+ self.assertTrue(not self.test_podtemplate.can_be_generated(self.portal), msg)
170
+ # may be generated on right context
171
+ self.test_podtemplate.pod_portal_types = ['Plone Site']
172
+ self.assertTrue(self.test_podtemplate.can_be_generated(self.portal))
173
+
174
+ # Use a tal_condition, moreover test extra_expr_ctx
175
+ # context/here is the element we generate the template from, here self.portal
176
+ self.test_podtemplate.tal_condition = "python: context.portal_type == 'Document'"
177
+ self.assertFalse(self.test_podtemplate.can_be_generated(self.portal))
178
+ self.test_podtemplate.tal_condition = "python: context.portal_type == 'Plone Site'"
179
+ self.assertTrue(self.test_podtemplate.can_be_generated(self.portal))
180
+ self.test_podtemplate.tal_condition = "python: here.portal_type == 'Plone Site'"
181
+ self.assertTrue(self.test_podtemplate.can_be_generated(self.portal))
182
+ # we have also 'template' as extra_expr_ctx
183
+ self.test_podtemplate.tal_condition = "python: template.getId() == 'wrong_id'"
184
+ self.assertFalse(self.test_podtemplate.can_be_generated(self.portal))
185
+ self.test_podtemplate.tal_condition = "python: template.getId() == 'test_template_bis'"
186
+ self.assertTrue(self.test_podtemplate.can_be_generated(self.portal))
187
+
188
+ def test_get_style_template(self):
189
+ style_template = self.portal.podtemplates.test_style_template
190
+ pod_template = self.test_podtemplate
191
+ self.assertTrue(pod_template.get_style_template() == style_template)
192
+
193
+ def test_get_templates_to_merge(self):
194
+ pod_template = self.test_podtemplate
195
+
196
+ # empty the field
197
+ pod_template.merge_templates = []
198
+ to_merge = pod_template.get_templates_to_merge()
199
+ self.assertTrue(len(to_merge) == 0)
200
+
201
+ # set the field 'merge_templates' with some value
202
+ pod_template.merge_templates = [
203
+ {
204
+ 'template': pod_template.UID(),
205
+ 'pod_context_name': 'hello',
206
+ 'do_rendering': False,
207
+ }
208
+ ]
209
+ to_merge = pod_template.get_templates_to_merge()
210
+ self.assertTrue(len(to_merge) == 1)
211
+ self.assertTrue(to_merge['hello'] == (pod_template, False))
212
+
213
+ def test_get_available_formats(self):
214
+ self.assertEqual(self.test_podtemplate.get_available_formats(), self.test_podtemplate.pod_formats)
215
+
216
+ def test_get_context_variables(self):
217
+ self.assertDictEqual(self.test_podtemplate.get_context_variables(), {'details': '1'})
218
+
219
+ def test_validate_context_variables(self):
220
+ class Dummy(object):
221
+ def __init__(self, context_variables=None, merge_templates=None):
222
+ self.context_variables = context_variables
223
+ self.merge_templates = merge_templates
224
+
225
+ fct = IConfigurablePODTemplate.getTaggedValue('invariants')[0]
226
+ # check no sub template and no variable
227
+ self.assertIsNone(fct(Dummy()))
228
+
229
+ # check no sub template but variables present
230
+ # check forbidden name
231
+ data = Dummy(context_variables=[{'name': u'uids', 'value': u'1'}])
232
+ self.assertRaises(Invalid, fct, data)
233
+ # check duplicated name
234
+ data = Dummy(context_variables=[{'name': u'det', 'value': u'1'}, {'name': u'det', 'value': u'1'}])
235
+ self.assertRaises(Invalid, fct, data)
236
+ # no exception
237
+ data = Dummy(context_variables=[{'name': u'det', 'value': u'1'}])
238
+ self.assertIsNone(fct(data))
239
+
240
+ # check no variables but sub template present
241
+ # check forbidden name
242
+ data = Dummy(merge_templates=[{'pod_context_name': u'uids', 'value': u'1'}])
243
+ self.assertRaises(Invalid, fct, data)
244
+ # check duplicated name
245
+ data = Dummy(
246
+ merge_templates=[{'pod_context_name': u'det', 'value': u'1'}, {'pod_context_name': u'det', 'value': u'1'}])
247
+ self.assertRaises(Invalid, fct, data)
248
+ # no exception
249
+ data = Dummy(merge_templates=[{'pod_context_name': u'det', 'value': u'1'}])
250
+ self.assertIsNone(fct(data))
251
+
252
+ # check both variables but sub template present
253
+ # check forbidden name
254
+ data = Dummy(context_variables=[{'name': u'det', 'value': u'1'}],
255
+ merge_templates=[{'pod_context_name': u'uids', 'value': u'1'}])
256
+ self.assertRaises(Invalid, fct, data)
257
+ # revert
258
+ data = Dummy(merge_templates=[{'pod_context_name': u'det', 'value': u'1'}],
259
+ context_variables=[{'name': u'self', 'value': u'1'}])
260
+ self.assertRaises(Invalid, fct, data)
261
+ # check duplicated name
262
+ data = Dummy(merge_templates=[{'pod_context_name': u'same', 'value': u'1'},
263
+ {'pod_context_name': u'same', 'value': u'1'}],
264
+ context_variables=[{'name': u'random1', 'value': u'1'}, {'name': u'random2', 'value': u'1'}])
265
+ self.assertRaises(Invalid, fct, data)
266
+ # revert
267
+ data = Dummy(context_variables=[{'name': u'same', 'value': u'1'}, {'name': u'same', 'value': u'1'}],
268
+ merge_templates=[{'pod_context_name': u'random1', 'value': u'1'},
269
+ {'pod_context_name': u'random2', 'value': u'1'}])
270
+ self.assertRaises(Invalid, fct, data)
271
+ # duplicate in both lists
272
+ data = Dummy(
273
+ merge_templates=[{'pod_context_name': u'det', 'value': u'1'}, {'pod_context_name': u'det', 'value': u'1'}],
274
+ context_variables=[{'name': u'det', 'value': u'1'}, {'name': u'det', 'value': u'1'}])
275
+ self.assertRaises(Invalid, fct, data)
276
+ # duplicate 1 in each list
277
+ data = Dummy(merge_templates=[{'pod_context_name': u'same', 'value': u'1'},
278
+ {'pod_context_name': u'random1', 'value': u'1'}],
279
+ context_variables=[{'name': u'same', 'value': u'1'}, {'name': u'random2', 'value': u'1'}])
280
+ self.assertRaises(Invalid, fct, data)
281
+ # no exception
282
+ data = Dummy(merge_templates=[{'pod_context_name': u'det', 'value': u'1'}],
283
+ context_variables=[{'name': u'something else', 'value': u'1'}])
284
+ self.assertIsNone(fct(data))
285
+
286
+ def test_validate_pod_file(self):
287
+ class Dummy(object):
288
+ def __init__(self, odt_file=None, pod_template_to_use=None):
289
+ self.odt_file = odt_file
290
+ self.pod_template_to_use = pod_template_to_use
291
+
292
+ fct = IConfigurablePODTemplate.getTaggedValue('invariants')[1]
293
+
294
+ # check no odt_file and no pod_template_to_use
295
+ self.assertRaises(Invalid, fct, Dummy())
296
+ Dummy(odt_file=self.test_podtemplate.odt_file)
297
+ Dummy(pod_template_to_use=self.test_podtemplate.pod_template_to_use)
298
+ Dummy(odt_file=self.test_podtemplate.odt_file, pod_template_to_use=self.test_podtemplate.pod_template_to_use)
299
+
300
+ def test_validate_pod_template_to_use(self):
301
+ class Dummy(object):
302
+ def __init__(self, odt_file=None, pod_template_to_use=None, is_reusable=None):
303
+ self.odt_file = odt_file
304
+ self.pod_template_to_use = pod_template_to_use
305
+ self.is_reusable = is_reusable
306
+
307
+ fct = IConfigurablePODTemplate.getTaggedValue('invariants')[2]
308
+
309
+ Dummy(odt_file=self.test_podtemplate.odt_file)
310
+ Dummy(odt_file=self.test_podtemplate.odt_file, is_reusable=True)
311
+ Dummy(odt_file=self.test_podtemplate.odt_file, is_reusable=False)
312
+ Dummy(is_reusable=True)
313
+ Dummy(is_reusable=False)
314
+
315
+ data = Dummy(odt_file=self.test_podtemplate.odt_file, pod_template_to_use="test")
316
+ self.assertRaises(Invalid, fct, data)
317
+
318
+ data = Dummy(odt_file=self.test_podtemplate.odt_file, is_reusable=True, pod_template_to_use="test")
319
+ self.assertRaises(Invalid, fct, data)
320
+
321
+ data = Dummy(odt_file=self.test_podtemplate.odt_file, is_reusable=False, pod_template_to_use="test")
322
+ self.assertRaises(Invalid, fct, data)
323
+
324
+ data = Dummy(is_reusable=True, pod_template_to_use="test")
325
+ self.assertRaises(Invalid, fct, data)
326
+
327
+ Dummy(pod_template_to_use="test", is_reusable=False)
328
+
329
+ def test_children_pod_template_content_provider(self):
330
+ """Test how children_pod_template ContentProvider is rendered."""
331
+ mother_template = self.portal.podtemplates.test_template_reusable
332
+ child_template = self.portal.podtemplates.test_template_reuse
333
+ self.assertTrue(child_template in mother_template.get_children_pod_template())
334
+ # link to child is displayed in the mother view by the content provider
335
+ self.assertTrue(child_template.absolute_url() in mother_template())
336
+
337
+ # content provider is displayed in the view as well as in the edit form
338
+ # view
339
+ view_form = mother_template.restrictedTraverse('view')
340
+ view_form.update()
341
+ view_content_provider_widget = view_form.widgets['children_pod_template']
342
+ rendered_view_form = view_form()
343
+ rendered_view_widget = view_content_provider_widget.render()
344
+ self.assertTrue(child_template.absolute_url() in view_form())
345
+ self.assertTrue(rendered_view_widget in rendered_view_form)
346
+ # edit
347
+ edit_form = mother_template.restrictedTraverse('edit')
348
+ edit_form.update()
349
+ edit_content_provider_widget = edit_form.widgets['children_pod_template']
350
+ rendered_edit_form = edit_form()
351
+ rendered_edit_widget = view_content_provider_widget.render()
352
+ self.assertTrue(child_template.absolute_url() in edit_form())
353
+ self.assertTrue(rendered_edit_widget in rendered_edit_form)
354
+
355
+ # we added convenient methods on the provider so it is displayed correctly
356
+ # on forms calling widget.name, widget.value
357
+ self.assertEqual(view_content_provider_widget.label, '')
358
+ self.assertEqual(edit_content_provider_widget.label, '')
359
+ self.assertEqual(view_content_provider_widget.name, 'children_pod_template')
360
+ self.assertEqual(edit_content_provider_widget.name, 'children_pod_template')
361
+ self.assertEqual(view_content_provider_widget.value, rendered_view_widget)
362
+ self.assertEqual(edit_content_provider_widget.value, rendered_edit_widget)
363
+
364
+
365
+ class TestConfigurablePODTemplateValidator(ConfigurablePODTemplateIntegrationTest):
366
+ def test_add_bad_formats_and_get_errormessage(self):
367
+ pod_template = self.test_podtemplate
368
+ pod_template.pod_formats.append('xls')
369
+ view = pod_template.restrictedTraverse('edit')
370
+ view.update()
371
+ validator = PodFormatsValidator(pod_template,
372
+ pod_template.REQUEST,
373
+ view,
374
+ IConfigurablePODTemplate['pod_formats'],
375
+ view.widgets['pod_formats'])
376
+ msg = translate(u"element_not_valid",
377
+ default=u"Element ${elem} is not valid for .${extension} template : \"${template}\"",
378
+ mapping={u"elem": "Microsoft Excel (.xls)",
379
+ u"extension": "odt",
380
+ u"template": pod_template.odt_file.filename})
381
+ with self.assertRaises(Invalid) as cm:
382
+ validator.validate(pod_template.pod_formats)
383
+ self.assertEqual(msg, translate(cm.exception.args[0]))
@@ -0,0 +1,115 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from collective.documentgenerator.testing import TEST_INSTALL_INTEGRATION
4
+ from plone import api
5
+ from plone.app.testing import applyProfile
6
+
7
+ import unittest
8
+
9
+
10
+ class TestDemoProfile(unittest.TestCase):
11
+
12
+ layer = TEST_INSTALL_INTEGRATION
13
+
14
+ def test_demo_profile_is_registered(self):
15
+ portal_setup = api.portal.get_tool(name='portal_setup')
16
+ demo_profile_name = u'collective.documentgenerator:demo'
17
+ profile_ids = [info['id'] for info in portal_setup.listProfileInfo()]
18
+ msg = 'demo profile is not registered'
19
+ self.assertTrue(demo_profile_name in profile_ids, msg)
20
+
21
+ def test_PODTemplate_folder_creation(self):
22
+ site = api.portal.get()
23
+
24
+ msg = 'Pod templates folder should not exist'
25
+ self.assertTrue(not hasattr(site, 'podtemplates'), msg)
26
+
27
+ applyProfile(site, 'collective.documentgenerator:demo')
28
+
29
+ msg = 'Pod templates folder doesn\'t exist'
30
+ self.assertTrue(hasattr(site, 'podtemplates'), msg)
31
+ self.assertTrue(site.podtemplates.portal_type == 'Folder')
32
+
33
+ applyProfile(site, 'collective.documentgenerator:demo')
34
+
35
+ msg = 'Pod templates folder should be unique'
36
+ self.assertTrue(not hasattr(site, 'podtemplates-1'), msg)
37
+
38
+ def test_PODTemplate_folder_out_of_navigation(self):
39
+ site = api.portal.get()
40
+
41
+ applyProfile(site, 'collective.documentgenerator:demo')
42
+
43
+ msg = 'Pod templates folder should be out of navigation'
44
+ self.assertTrue(site.podtemplates.exclude_from_nav, msg)
45
+
46
+ def test_PODTemplateModel_creation(self):
47
+ site = api.portal.get()
48
+
49
+ applyProfile(site, 'collective.documentgenerator:demo')
50
+
51
+ msg = 'Test podtemplate doesn\'t exist'
52
+ self.assertTrue(hasattr(site.podtemplates, 'test_template'), msg)
53
+ self.assertTrue(site.podtemplates.test_template.portal_type == 'PODTemplate')
54
+
55
+ msg = 'The second podtemplate doesn\'t exist'
56
+ self.assertTrue(hasattr(site.podtemplates, 'test_template_bis'), msg)
57
+ self.assertTrue(site.podtemplates.test_template_bis.portal_type == 'ConfigurablePODTemplate')
58
+
59
+ applyProfile(site, 'collective.documentgenerator:demo')
60
+
61
+ msg = 'Test pod templates should be unique'
62
+ self.assertTrue(not hasattr(site.podtemplates, 'test_template-1'), msg)
63
+ self.assertTrue(not hasattr(site.podtemplates, 'test_template_bis-1'), msg)
64
+
65
+ def test_PODTemplateModel_out_of_navigation(self):
66
+ site = api.portal.get()
67
+
68
+ applyProfile(site, 'collective.documentgenerator:demo')
69
+
70
+ msg = 'Test pod templates should be out of navigation'
71
+ self.assertTrue(site.podtemplates.test_template.exclude_from_nav, msg)
72
+
73
+ def test_StyleTemplate_creation(self):
74
+ site = api.portal.get()
75
+
76
+ applyProfile(site, 'collective.documentgenerator:demo')
77
+
78
+ msg = 'Test style template doesn\'t exist'
79
+ self.assertTrue(hasattr(site.podtemplates, 'test_style_template'), msg)
80
+ self.assertTrue(site.podtemplates.test_style_template.portal_type == 'StyleTemplate')
81
+
82
+ applyProfile(site, 'collective.documentgenerator:demo')
83
+
84
+ msg = 'Test style templates should be unique'
85
+ self.assertTrue(not hasattr(site.podtemplates, 'test_style_template-1'), msg)
86
+
87
+ def test_StyleTemplate_out_of_navigation(self):
88
+ site = api.portal.get()
89
+
90
+ applyProfile(site, 'collective.documentgenerator:demo')
91
+
92
+ msg = 'Test style templates should be out of navigation'
93
+ self.assertTrue(site.podtemplates.test_style_template.exclude_from_nav, msg)
94
+
95
+ def test_PODTemplateOds_creation(self):
96
+ site = api.portal.get()
97
+
98
+ applyProfile(site, 'collective.documentgenerator:demo')
99
+
100
+ msg = 'Ods test podtemplate doesn\'t exist'
101
+ self.assertTrue(hasattr(site.podtemplates, 'test_ods_template'), msg)
102
+ self.assertEqual(site.podtemplates.test_ods_template.portal_type, 'ConfigurablePODTemplate')
103
+
104
+ applyProfile(site, 'collective.documentgenerator:demo')
105
+
106
+ msg = 'Ods test pod templates should be unique'
107
+ self.assertTrue(not hasattr(site.podtemplates, 'test_ods_template-1'), msg)
108
+
109
+ def test_PODTemplateOds_out_of_navigation(self):
110
+ site = api.portal.get()
111
+
112
+ applyProfile(site, 'collective.documentgenerator:demo')
113
+
114
+ msg = 'Ods test pod templates should be out of navigation'
115
+ self.assertTrue(site.podtemplates.test_ods_template.exclude_from_nav, msg)
@@ -0,0 +1,169 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from collective.documentgenerator.events.styles_events import _update_template_styles
4
+ from collective.documentgenerator.events.styles_events import update_styles_of_all_PODtemplate
5
+ from collective.documentgenerator.testing import PODTemplateIntegrationTest
6
+ from plone import api
7
+ from plone.namedfile.file import NamedBlobFile
8
+ from zExceptions import Redirect
9
+ from zope.event import notify
10
+ from zope.interface import Interface
11
+ from zope.lifecycleevent import Attributes
12
+ from zope.lifecycleevent import ObjectModifiedEvent
13
+
14
+ import os
15
+
16
+
17
+ class TestEvents(PODTemplateIntegrationTest):
18
+ """
19
+ Test events methods.
20
+ """
21
+
22
+ def test_update_styles_of_all_PODtemplate(self):
23
+ # we use a ConfigurablePODTemplate to test style modification
24
+ style_template = self.portal.podtemplates.get('test_style_template')
25
+ # just call the function to pass on code
26
+ update_styles_of_all_PODtemplate(style_template, None)
27
+
28
+ def test__update_template_styles(self):
29
+ # style update is already tested in test_utils.py
30
+ # this is done to check error management
31
+ template = self.portal.podtemplates.get('test_template_multiple')
32
+ self.assertRaises(Redirect, _update_template_styles, template, None)
33
+
34
+ def _get_new_template_reusing_another(self, id='test_template_reuse_temp', reuse_other=True):
35
+ uid = None
36
+ if reuse_other:
37
+ uid = self.portal.podtemplates.get('test_template_reusable').UID()
38
+
39
+ portal = api.portal.get()
40
+ pod_folder = getattr(portal, 'podtemplates')
41
+ api.content.create(
42
+ pod_template_to_use=uid,
43
+ type='ConfigurablePODTemplate',
44
+ id=id,
45
+ title=u'Temporary Reuse Test Template',
46
+ container=pod_folder,
47
+ exclude_from_nav=True,
48
+ pod_formats=['odt', 'pdf', 'doc', 'docx'],
49
+ pod_portal_types=['Document'],
50
+ )
51
+ return getattr(pod_folder, id)
52
+
53
+ def test_crud_configurable_template_reusing_another(self):
54
+ reusable_template = self.portal.podtemplates.get('test_template_reusable')
55
+ template_reuse = self.portal.podtemplates.get('test_template_reuse')
56
+ self.assertSetEqual(reusable_template.get_children_pod_template(), {template_reuse})
57
+
58
+ temp_template = self._get_new_template_reusing_another()
59
+ self.assertSetEqual(reusable_template.get_children_pod_template(), {temp_template, template_reuse})
60
+
61
+ temp_template.pod_template_to_use = None
62
+ self.assertSetEqual(reusable_template.get_children_pod_template(), {template_reuse})
63
+
64
+ temp_template.pod_template_to_use = reusable_template.UID()
65
+ self.assertSetEqual(reusable_template.get_children_pod_template(), {temp_template, template_reuse})
66
+
67
+ api.content.delete(temp_template)
68
+ self.assertEqual(reusable_template.get_children_pod_template(), {template_reuse})
69
+
70
+ def test_clean_notes(self):
71
+ """When PODTemplate created or modified, the "odt_file" note are cleaned."""
72
+ # original template_to_clean.odt holds dirty note
73
+ filename = u'template_to_clean.odt'
74
+ dirty_note = 'from xhtml(self.getMotivation() + </text:span>' \
75
+ '<text:span text:style-name="T1">self.getDecision())</text:span>'
76
+ cleaned_note = 'from xhtml(self.getMotivation() + self.getDecision())'
77
+ current_path = os.path.dirname(__file__)
78
+ dirty_data = open(os.path.join(current_path, filename), 'r').read()
79
+ dirty_content_xml = self.get_odt_content_xml(dirty_data)
80
+ self.assertTrue(dirty_note in dirty_content_xml)
81
+ self.assertFalse(cleaned_note in dirty_content_xml)
82
+
83
+ # create a new pod template it will be cleaned
84
+ pod_template = api.content.create(
85
+ type='ConfigurablePODTemplate',
86
+ id='template_to_clean',
87
+ title=u'Template to clean',
88
+ odt_file=NamedBlobFile(
89
+ data=dirty_data,
90
+ contentType='application/vnd.oasis.opendocument.text',
91
+ filename=filename,
92
+ ),
93
+ pod_formats=['odt'],
94
+ container=self.portal.podtemplates
95
+ )
96
+ cleaned_content_xml = self.get_odt_content_xml(pod_template.odt_file.data)
97
+ self.assertFalse(dirty_note in cleaned_content_xml)
98
+ self.assertTrue(cleaned_note in cleaned_content_xml)
99
+ # same behavior than style modification: template is considered unchanged
100
+ self.assertFalse(pod_template.has_been_modified())
101
+
102
+ # when updating file, new file is cleaned as well
103
+ pod_template.odt_file = NamedBlobFile(
104
+ data=dirty_data,
105
+ contentType='application/vnd.oasis.opendocument.text',
106
+ filename=filename,
107
+ )
108
+ self.assertTrue(pod_template.has_been_modified()) # template is manually changed
109
+ notify(ObjectModifiedEvent(pod_template, Attributes(Interface, 'odt_file')))
110
+ cleaned_content_xml = self.get_odt_content_xml(pod_template.odt_file.data)
111
+ self.assertFalse(dirty_note in cleaned_content_xml)
112
+ self.assertTrue(cleaned_note in cleaned_content_xml)
113
+
114
+ def test_default_page_style_for_mailing(self):
115
+ """When a mailing PODTemplate created or modified, set a default page style on it."""
116
+ filename = u'template_without_style_page.odt'
117
+ current_path = os.path.dirname(__file__)
118
+ odt_data = open(os.path.join(current_path, filename), 'r').read()
119
+ # activate the auto page style option
120
+ api.portal.set_registry_record(
121
+ 'collective.documentgenerator.browser.controlpanel.'
122
+ 'IDocumentGeneratorControlPanelSchema.force_default_page_style_for_mailing',
123
+ True
124
+ )
125
+ pod_template = api.content.create(
126
+ type='ConfigurablePODTemplate',
127
+ id='template_to_style',
128
+ title=u'Template to clean',
129
+ odt_file=NamedBlobFile(
130
+ data=odt_data,
131
+ contentType='application/vnd.oasis.opendocument.text',
132
+ filename=filename,
133
+ ),
134
+ pod_formats=['odt'],
135
+ container=self.portal.podtemplates,
136
+ mailing_loop_template=1,
137
+ )
138
+ notify(ObjectModifiedEvent(pod_template))
139
+ # the page style should have been set -> odt contents are different
140
+ self.assertNotEqual(odt_data, pod_template.odt_file.data)
141
+
142
+ def test_default_page_style_for_mailing_disabled(self):
143
+ """When a mailing PODTemplate created or modified, set a default page style on it
144
+ only if the setting 'force_default_page_style_for_mailing' is set to True."""
145
+ filename = u'template_without_style_page.odt'
146
+ current_path = os.path.dirname(__file__)
147
+ odt_data = open(os.path.join(current_path, filename), 'r').read()
148
+ # activate the auto page style option
149
+ api.portal.set_registry_record(
150
+ 'collective.documentgenerator.browser.controlpanel.'
151
+ 'IDocumentGeneratorControlPanelSchema.force_default_page_style_for_mailing',
152
+ False
153
+ )
154
+ pod_template = api.content.create(
155
+ type='ConfigurablePODTemplate',
156
+ id='template_to_style',
157
+ title=u'Template to clean',
158
+ odt_file=NamedBlobFile(
159
+ data=odt_data,
160
+ contentType='application/vnd.oasis.opendocument.text',
161
+ filename=filename,
162
+ ),
163
+ pod_formats=['odt'],
164
+ container=self.portal.podtemplates,
165
+ mailing_loop_template=1,
166
+ )
167
+ notify(ObjectModifiedEvent(pod_template))
168
+ # no page style should have been set -> odt contents are still the same
169
+ self.assertEqual(odt_data, pod_template.odt_file.data)