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,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,190 @@
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
+
42
+ self.assertTrue(self.test_podtemplate.__class__ == PODTemplate)
43
+
44
+ def test_schema_registration(self):
45
+ portal_types = api.portal.get_tool("portal_types")
46
+ podtemplate_type = portal_types.get(self.test_podtemplate.portal_type)
47
+ self.assertTrue("IPODTemplate" in podtemplate_type.schema)
48
+
49
+ def test_odt_file_attribute(self):
50
+ test_podtemplate = aq_base(self.test_podtemplate)
51
+ self.assertTrue(hasattr(test_podtemplate, "odt_file"))
52
+
53
+ def test_odt_file_field_display(self):
54
+ self.browser.open(self.test_podtemplate.absolute_url())
55
+ contents = self.browser.contents
56
+ msg = "field 'odt_file' is not displayed"
57
+ self.assertTrue('id="form-widgets-odt_file"' in contents, msg)
58
+ msg = "field 'odt_file' is not translated"
59
+ self.assertTrue("Canevas" in contents, msg)
60
+
61
+ def test_odt_file_field_edit(self):
62
+ contents = self._edit_object(self.test_podtemplate)
63
+ msg = "field 'odt_file' is not editable"
64
+ self.assertTrue("Canevas" in contents, msg)
65
+
66
+ def test_initial_md5_attribute(self):
67
+ test_podtemplate = aq_base(self.test_podtemplate)
68
+ self.assertTrue(hasattr(test_podtemplate, "initial_md5"))
69
+
70
+ def test_initial_md5_field_display(self):
71
+ self.browser.open(self.test_podtemplate.absolute_url())
72
+ contents = self.browser.contents
73
+ msg = "field 'initial_md5' is displayed"
74
+ self.assertTrue('id="form-widgets-initial_md5"' not in contents, msg)
75
+
76
+ def test_initial_md5_field_edit(self):
77
+ contents = self._edit_object(self.test_podtemplate)
78
+ msg = "field 'initial_md5' is editable"
79
+ self.assertTrue("md5" not in contents, msg)
80
+
81
+ def test_enabled_attribute(self):
82
+ test_podtemplate = aq_base(self.test_podtemplate)
83
+ self.assertTrue(hasattr(test_podtemplate, "enabled"))
84
+
85
+ def test_enabled_field_display(self):
86
+ self.browser.open(self.test_podtemplate.absolute_url())
87
+ contents = self.browser.contents
88
+ msg = "field 'enabled' is not displayed"
89
+ self.assertTrue('id="form-widgets-enabled"' in contents, msg)
90
+ msg = "field 'enabled' is not translated"
91
+ self.assertTrue("Activé" in contents, msg)
92
+
93
+ def test_enabled_field_edit(self):
94
+ contents = self._edit_object(self.test_podtemplate)
95
+ msg = "field 'enabled' is not editable"
96
+ self.assertTrue("Activé" in contents, msg)
97
+
98
+
99
+ class TestPODTemplateIntegration(PODTemplateIntegrationTest):
100
+ """
101
+ Test PODTemplate methods.
102
+ """
103
+
104
+ def test_get_file(self):
105
+ expected_file = self.test_podtemplate.odt_file
106
+
107
+ self.test_podtemplate.odt_file = expected_file
108
+ odt_file = self.test_podtemplate.get_file()
109
+ msg = "Accessor 'get_file' does not return odt_file field value."
110
+ self.assertTrue(odt_file == expected_file, msg)
111
+
112
+ def test_default_generation_condition_registration(self):
113
+ context = self.portal
114
+ condition_obj = queryMultiAdapter(
115
+ (self.test_podtemplate, context),
116
+ IPODTemplateCondition,
117
+ )
118
+
119
+ self.assertTrue(isinstance(condition_obj, PODTemplateCondition))
120
+
121
+ def test_can_be_generated(self):
122
+ self.assertTrue(self.test_podtemplate.can_be_generated(self.portal))
123
+
124
+ # Disable the template.
125
+ self.test_podtemplate.enabled = False
126
+ msg = "disabled template should not be generated"
127
+ self.assertTrue(not self.test_podtemplate.can_be_generated(self.portal), msg)
128
+
129
+ def test_custom_generation_condition(self):
130
+ """
131
+ Register a custom condition and see if its taken into account by our test_podtemplate.
132
+ """
133
+ pod_template = self.test_podtemplate
134
+ can_be_generated = pod_template.can_be_generated(self.portal)
135
+ self.assertTrue(can_be_generated is True)
136
+
137
+ class CustomCondition(PODTemplateCondition):
138
+ def evaluate(self):
139
+ return "yolo"
140
+
141
+ gsm = getGlobalSiteManager()
142
+ gsm.registerAdapter(
143
+ CustomCondition, (IPODTemplate, Interface), IPODTemplateCondition
144
+ )
145
+
146
+ can_be_generated = pod_template.can_be_generated(self.portal)
147
+ self.assertTrue(can_be_generated == "yolo")
148
+
149
+ # finally, unregister our adapter...
150
+ gsm.registerAdapter(
151
+ PODTemplateCondition, (IPODTemplate, Interface), IPODTemplateCondition
152
+ )
153
+
154
+ def test_get_style_template(self):
155
+ pod_template = self.test_podtemplate
156
+ self.assertTrue(pod_template.get_style_template() is None)
157
+
158
+ def test_default_merge_templates_registration(self):
159
+ adapter = queryAdapter(self.test_podtemplate, ITemplatesToMerge)
160
+ self.assertTrue(isinstance(adapter, TemplatesToMergeForPODTemplate))
161
+
162
+ def test_template_has_been_modified_method(self):
163
+ pod_template = self.test_podtemplate
164
+
165
+ setup_tool = api.portal.get_tool("portal_setup")
166
+ demo_profile = setup_tool.getProfileInfo("collective.documentgenerator:demo")
167
+ template_path = "{}/templates/styles.odt".format(demo_profile.get("path"))
168
+ template_file = open(template_path, "rb").read()
169
+ blob_file = NamedBlobFile(
170
+ data=template_file, contentType="application/vnd.oasis.opendocument.text"
171
+ )
172
+
173
+ pod_template.odt_file = blob_file
174
+
175
+ self.assertTrue(pod_template.has_been_modified())
176
+
177
+ def test_get_available_formats(self):
178
+ self.assertEqual(
179
+ self.test_podtemplate.get_available_formats(),
180
+ [
181
+ "odt",
182
+ ],
183
+ )
184
+
185
+
186
+ class TestPODTemplateValidator(PODTemplateIntegrationTest):
187
+ def test_file_extension_is_odt(self):
188
+ pod_template = self.test_podtemplate
189
+ extension = pod_template.odt_file.filename.split(".")[-1]
190
+ 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)
17
+ for doc in os.listdir(robot_dir)
18
+ if doc.endswith(".robot") and doc.startswith("test_")
19
+ ]
20
+ for test in robot_tests:
21
+ suite.addTests(
22
+ [
23
+ layered(robotsuite.RobotTestSuite(test), layer=ACCEPTANCE),
24
+ ]
25
+ )
26
+ return suite