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,276 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from collective.documentgenerator.testing import ArchetypesIntegrationTests
4
+ from DateTime import DateTime
5
+ from imio.helpers import HAS_PLONE_5
6
+ from plone import api
7
+ from plone.app.testing import login
8
+ from plone.app.testing import logout
9
+
10
+ import unittest
11
+
12
+
13
+ @unittest.skipIf(HAS_PLONE_5, "Do not launch AT specific tests on Plone 5")
14
+ class TestArchetypesHelperView(ArchetypesIntegrationTests):
15
+ """
16
+ Test Archetypes helper view.
17
+ """
18
+
19
+ def test_AT_helper_view_registration(self):
20
+ """
21
+ Test that when we query a IDocumentGenerationHelper adpater on an AT object, we get
22
+ the AT implementation of DocumentGenerationHelperView.
23
+ """
24
+ from collective.documentgenerator.helper import ATDocumentGenerationHelperView
25
+
26
+ helper_view = self.AT_topic.unrestrictedTraverse('@@document_generation_helper_view')
27
+ msg = 'The helper should have been an instance of ATDocumentGenerationHelperView'
28
+ self.assertTrue(isinstance(helper_view, ATDocumentGenerationHelperView), msg)
29
+
30
+ def test_AT_proxy_object_registration(self):
31
+ """
32
+ Test that when we query a IDocumentGenerationHelper adpater on an AT object, we get
33
+ the AT implementation of DocumentGenerationHelperView.
34
+ """
35
+ from collective.documentgenerator.helper import ATDisplayProxyObject
36
+
37
+ helper_view = self.AT_topic.unrestrictedTraverse('@@document_generation_helper_view')
38
+ proxy = helper_view.context
39
+ msg = 'The proxy object should have been an instance of ATDisplayProxyObject'
40
+ self.assertTrue(isinstance(proxy, ATDisplayProxyObject), msg)
41
+
42
+ def test_AT_proxy_object_behaviour(self):
43
+ """
44
+ When trying to access an attribute attr_name on the object, the proxy should return
45
+ display(attr_name) if the attribute is a field of the object schema.
46
+ If attr_name is not a schema's field, it should delegate its access to the real object.
47
+
48
+ eg: proxy.title -> proxy.display(field_name='title', context=real_object)
49
+ proxy.some_method() -> real_object.some_method()
50
+ """
51
+ helper_view = self.AT_topic.unrestrictedTraverse('@@document_generation_helper_view')
52
+ proxy = helper_view.context
53
+
54
+ proxy.display = lambda field_name: 'yolo'
55
+
56
+ msg = "The proxy should have call proxy.display() method as 'title' is a schema's field."
57
+ self.assertTrue(proxy.description == 'yolo', msg)
58
+
59
+ msg = ("If we try to access the attribute value through the accessor, it should return the real value "
60
+ "stored on the schema's field.")
61
+ self.assertTrue(proxy.Title() != 'yolo', msg)
62
+
63
+ wrapped = helper_view.real_context
64
+ msg = "__str__ should return the same result as the wrapped object: {} != {}"
65
+ self.assertEqual(str(proxy), str(helper_view.real_context), msg.format(str(proxy), str(wrapped)))
66
+ msg = u" __unicode__ should return the same result as the wrapped object: {} != {}"
67
+ self.assertEqual(
68
+ unicode(proxy),
69
+ unicode(helper_view.real_context),
70
+ msg.format(unicode(proxy), unicode(wrapped))
71
+ )
72
+
73
+
74
+ @unittest.skipIf(HAS_PLONE_5, "Do not launch AT specific tests on Plone 5")
75
+ class TestArchetypesHelperViewMethods(ArchetypesIntegrationTests):
76
+ """
77
+ Test Archetypes implementation of helper view's methods.
78
+ """
79
+
80
+ def setUp(self):
81
+ super(TestArchetypesHelperViewMethods, self).setUp()
82
+ self.view = self.AT_topic.unrestrictedTraverse('@@document_generation_helper_view')
83
+ self.doc_view = self.AT_doc.unrestrictedTraverse('@@document_generation_helper_view')
84
+
85
+ def _test_display(self, field_name, expected, result):
86
+ msg = "Expected display of field '{}' to be '{}' but got '{}'".format(
87
+ field_name,
88
+ expected,
89
+ result
90
+ )
91
+ self.assertTrue(expected == result, msg)
92
+
93
+ def _test_display_method(self, field_name, expected, to_set=None):
94
+ if to_set is None:
95
+ to_set = expected
96
+
97
+ field = self.AT_topic.getField(field_name)
98
+ field.set(self.AT_topic, to_set)
99
+
100
+ result = self.view.display(field_name)
101
+ self._test_display(field_name, expected, result)
102
+
103
+ def test_display_method_on_unauthorized_field(self):
104
+ field_name = 'description'
105
+ to_set = 'Yolo!'
106
+ expected_text = ''
107
+
108
+ # hack the checkPermission method to always return False
109
+ description_field = self.AT_topic.getField(field_name)
110
+ description_field.checkPermission = lambda permission, context: False
111
+
112
+ self._test_display_method(field_name, expected_text, to_set)
113
+
114
+ def test_display_method_on_text_field(self):
115
+ field_name = 'description'
116
+ expected_text = 'Yolo!'
117
+ self._test_display_method(field_name, expected_text)
118
+
119
+ def test_display_method_on_multiselect_field(self):
120
+ field_name = 'customViewFields'
121
+ to_set = ['Title', 'Description', 'EffectiveDate']
122
+ expected_text = 'Titre, Description, Date de publication'
123
+ self._test_display_method(field_name, expected_text, to_set)
124
+
125
+ def test_display_method_on_datefield(self):
126
+ field_name = 'effectiveDate'
127
+ date_to_set = DateTime('23/06/1975')
128
+ expected_date = '23/06/1975 00:00'
129
+ self._test_display_method(field_name, expected_date, date_to_set)
130
+
131
+ def test_display_method_empty_value(self):
132
+ displayed = self.view.display('effectiveDate', no_value='yolo')
133
+ msg = "empty value display was expected to be 'yolo'"
134
+ self.assertTrue(displayed == 'yolo', msg)
135
+
136
+ displayed = self.doc_view.display('text', no_value='yolo')
137
+ self.assertEqual('', self.doc_view.real_context.getText())
138
+ self.assertTrue(displayed == 'yolo', msg)
139
+
140
+ def test_display_method_bypass_check_permission(self):
141
+ self.AT_topic.setEffectiveDate(DateTime('23/06/1975'))
142
+ expected_date = '23/06/1975 00:00'
143
+ self.assertFalse(api.user.is_anonymous())
144
+ self.assertEqual(self.view.display('effectiveDate', bypass_check_permission=False), expected_date)
145
+ self.assertEqual(self.view.display('effectiveDate', bypass_check_permission=True), expected_date)
146
+ logout()
147
+ self.assertTrue(api.user.is_anonymous())
148
+ self.assertEqual(self.view.display('effectiveDate', bypass_check_permission=False), u'')
149
+ self.assertEqual(self.view.display('effectiveDate', bypass_check_permission=True), expected_date)
150
+
151
+ def test_display_date_method(self):
152
+ effective_field_name = 'effectiveDate'
153
+ date_to_set = DateTime('18/09/1986')
154
+
155
+ field = self.AT_topic.getField(effective_field_name)
156
+ field.set(self.AT_topic, date_to_set)
157
+
158
+ # toLocalizedTime
159
+ expected_date = u'18/09/1986'
160
+ result = self.view.display_date(field_name=effective_field_name)
161
+ self.assertEqual(expected_date, result)
162
+ result = self.view.display_date(date=date_to_set)
163
+ self.assertEqual(expected_date, result)
164
+
165
+ expected_date = u'18/09/1986 00:00'
166
+ result = self.view.display_date(field_name=effective_field_name, long_format=True)
167
+ self.assertEqual(expected_date, result)
168
+ result = self.view.display_date(date=date_to_set, long_format=True)
169
+ self.assertEqual(expected_date, result)
170
+
171
+ expected_date = u'00:00'
172
+ result = self.view.display_date(field_name=effective_field_name, time_only=True)
173
+ self.assertEqual(expected_date, result)
174
+ result = self.view.display_date(date=date_to_set, time_only=True)
175
+ self.assertEqual(expected_date, result)
176
+
177
+ # custom_format
178
+ expected_date = '18 yolo 09 yolo 1986'
179
+ result = self.view.display_date(field_name=effective_field_name, custom_format='%d yolo %m yolo %Y')
180
+ self.assertEqual(expected_date, result)
181
+ result = self.view.display_date(date=date_to_set, custom_format='%d yolo %m yolo %Y')
182
+ self.assertEqual(expected_date, result)
183
+
184
+ def test_display_voc_method(self):
185
+ field_name = 'customViewFields'
186
+ to_set = ['Title', 'Description', 'EffectiveDate']
187
+ expected_text = 'Titre swag Description swag Date de publication'
188
+
189
+ field = self.AT_topic.getField(field_name)
190
+ field.set(self.AT_topic, to_set)
191
+
192
+ result = self.view.display_voc(field_name, separator=' swag ')
193
+
194
+ self._test_display(field_name, expected_text, result)
195
+
196
+ def test_display_list_method(self):
197
+ field_name = 'customViewFields'
198
+ to_set = ['Title', 'Description', 'EffectiveDate']
199
+ expected_text = 'Title ; Description ; EffectiveDate'
200
+
201
+ field = self.AT_topic.getField(field_name)
202
+ field.set(self.AT_topic, to_set)
203
+
204
+ result = self.view.display_list(field_name, separator=' ; ')
205
+
206
+ self._test_display(field_name, expected_text, result)
207
+
208
+ def test_list_method(self):
209
+ field_name = 'customViewFields'
210
+ expected = ['Title', 'Description', 'EffectiveDate']
211
+
212
+ field = self.AT_topic.getField(field_name)
213
+ field.set(self.AT_topic, expected)
214
+
215
+ result = list(self.view.list(field_name))
216
+
217
+ self._test_display(field_name, expected, result)
218
+
219
+ def test_display_text_as_html_method(self):
220
+ actual_field_name = 'description'
221
+ to_set = 'My description\r\nMy life\r\nhttp://www.imio.be'
222
+ expected = 'My description<br />My life<br /><a href="http://www.imio.be" rel="nofollow">http://www.imio.be</a>'
223
+
224
+ field = self.AT_topic.getField(actual_field_name)
225
+ field.set(self.AT_topic, to_set)
226
+
227
+ result = self.view.display_text_as_html(field_name=actual_field_name)
228
+ self.assertEqual(result, expected)
229
+
230
+ result = self.view.display_text_as_html(text=to_set)
231
+ self.assertEqual(result, expected)
232
+
233
+ result = self.view.display_text_as_html()
234
+ self.assertFalse(result, "Expected result to be None or '' but is " + result)
235
+
236
+ def test_display_html_as_text_method(self):
237
+ # use title because description does not allow mimetype text/html
238
+ actual_field_name = 'title'
239
+ to_set = '<p>My description<br />My life<br /><a href="http://www.imio.be" ' \
240
+ 'rel="nofollow">http://www.imio.be</a></p>'
241
+ expected = 'My description\nMy life\nhttp://www.imio.be'
242
+
243
+ field = self.AT_topic.getField(actual_field_name)
244
+ field.set(self.AT_topic, to_set)
245
+
246
+ result = self.view.display_html_as_text(field_name=actual_field_name)
247
+ self.assertEqual(result, expected)
248
+
249
+ result = self.view.display_html_as_text(html=to_set)
250
+ self.assertEqual(result, expected)
251
+
252
+ result = self.view.display_html_as_text()
253
+ self.assertFalse(result, "Expected result to be None or '' but is " + result)
254
+
255
+ def test_render_xhtml_method_without_appy_renderer(self):
256
+ field_name = 'description'
257
+ to_set = 'Yolo!'
258
+ expected = ''
259
+
260
+ field = self.AT_topic.getField(field_name)
261
+ field.set(self.AT_topic, to_set)
262
+
263
+ result = self.view.render_xhtml(field_name)
264
+ self._test_display(field_name, expected, result)
265
+
266
+ def test_check_permission(self):
267
+ # test user has permission
268
+ self.assertTrue(self.view.check_permission('description'))
269
+
270
+ # set field read permission to higher stuff
271
+ field = self.AT_topic.getField('description')
272
+ field.read_permission = 'Modify portal content'
273
+ # new user that doesn't have permission
274
+ api.user.create(username='foobar', email='foobar@example.com')
275
+ login(self.portal, 'foobar')
276
+ self.assertFalse(self.view.check_permission('description'))
@@ -0,0 +1,355 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from collective.documentgenerator.testing import DexterityIntegrationTests
4
+ from imio.helpers import HAS_PLONE_4
5
+ from imio.helpers import HAS_PLONE_5_1
6
+ from plone import api
7
+ from plone.app.testing import login
8
+ from plone.app.testing import logout
9
+ from plone.app.textfield.value import RichTextValue
10
+ from plone.autoform.interfaces import READ_PERMISSIONS_KEY
11
+ from plone.behavior.interfaces import IBehavior
12
+ from Products.CMFPlone.utils import safe_unicode
13
+ from z3c.form.interfaces import NO_VALUE
14
+ from zope.component import getUtility
15
+
16
+ import datetime
17
+
18
+
19
+ class TestDexterityHelperView(DexterityIntegrationTests):
20
+
21
+ """Test Dexterity helper view."""
22
+
23
+ def test_DX_helper_view_registration(self):
24
+ """Test that when we query a IDocumentGenerationHelper adpater on an DX object, we get
25
+ the DX implementation of DocumentGenerationHelperView."""
26
+ from collective.documentgenerator.helper import DXDocumentGenerationHelperView
27
+
28
+ helper_view = self.content.unrestrictedTraverse('@@document_generation_helper_view')
29
+ msg = 'The helper should have been an instance of DXDocumentGenerationHelperView'
30
+ self.assertTrue(isinstance(helper_view, DXDocumentGenerationHelperView), msg)
31
+
32
+ def test_DX_proxy_object_registration(self):
33
+ """Test that when we query a IDocumentGenerationHelper adpater on an DX object, we get
34
+ the DX implementation of DisplayProxyObject as context."""
35
+ from collective.documentgenerator.helper import DXDisplayProxyObject
36
+
37
+ helper_view = self.content.unrestrictedTraverse('@@document_generation_helper_view')
38
+ proxy = helper_view.context
39
+ msg = 'The proxy object should have been an instance of DXDisplayProxyObject'
40
+ self.assertTrue(isinstance(proxy, DXDisplayProxyObject), msg)
41
+
42
+ def test_DX_proxy_object_behaviour(self):
43
+ """When trying to access an attribute attr_name on the object, the proxy should return
44
+ display(attr_name) if the attribute is a field of the object schema.
45
+ If attr_name is not a schema's field, it should delegate its access to the real object.
46
+
47
+ eg: proxy.title -> proxy.display(field_name='title', context=real_object)
48
+ proxy.some_method() -> real_object.some_method()
49
+ """
50
+ helper_view = self.content.unrestrictedTraverse('@@document_generation_helper_view')
51
+ proxy = helper_view.context
52
+
53
+ proxy.display = lambda field_name: 'foobar'
54
+
55
+ msg = 'The proxy should have call proxy.display() method.'
56
+ self.assertTrue(proxy.fullname == 'foobar', msg)
57
+
58
+ # description is in IBasic behavior
59
+ self.assertTrue(proxy.description == 'foobar', msg)
60
+
61
+ msg = ("If we try to access the attribute value through the accessor, it should return the real value "
62
+ "stored on the schema's field.")
63
+ self.assertTrue(proxy.Description() != 'foobar', msg)
64
+
65
+ wrapped = helper_view.real_context
66
+ msg = " __repr__ and __str__ should return the same result as the wrapped object: {} != {}"
67
+ self.assertEqual(str(proxy), str(helper_view.real_context), msg.format(str(proxy), str(wrapped)))
68
+ msg = u" __unicode__ should return the same result as the wrapped object: {} != {}"
69
+ self.assertEqual(
70
+ unicode(proxy),
71
+ unicode(helper_view.real_context),
72
+ msg.format(unicode(proxy), unicode(wrapped))
73
+ )
74
+
75
+
76
+ class TestDexterityHelperViewMethods(DexterityIntegrationTests):
77
+
78
+ """Test Dexterity implementation of helper view's methods."""
79
+
80
+ def setUp(self):
81
+ super(TestDexterityHelperViewMethods, self).setUp()
82
+ self.view = self.content.unrestrictedTraverse(
83
+ '@@document_generation_helper_view')
84
+ self.doc_view = self.doc.unrestrictedTraverse(
85
+ '@@document_generation_helper_view')
86
+
87
+ def test_display_method_on_text_field(self):
88
+ field_name = 'fullname'
89
+ expected = 'John Doe'
90
+ self.content.fullname = expected
91
+ result = self.view.display(field_name)
92
+ self.assertEqual(expected, result)
93
+
94
+ def test_display_method_on_multiselect_field(self):
95
+ field_name = 'languages'
96
+ to_set = ['en', 'fr']
97
+ expected = u'English\nFrançais'
98
+ self.content.languages = to_set
99
+ result = self.view.display(field_name)
100
+ self.assertEqual(expected, result)
101
+
102
+ def test_display_method_on_datefield(self):
103
+ field_name = 'birth_date'
104
+ to_set = datetime.date(1986, 9, 18)
105
+ expected = u'18/09/1986'
106
+ self.content.birth_date = to_set
107
+ result = self.view.display(field_name)
108
+ self.assertEqual(expected, result)
109
+
110
+ def test_display_method_on_datetimefield(self):
111
+ field_name = 'birth_datetime'
112
+ to_set = datetime.datetime(1986, 9, 18, 10, 0)
113
+ expected = u'18/09/1986 10:00'
114
+ self.content.birth_datetime = to_set
115
+ result = self.view.display(field_name)
116
+ self.assertEqual(expected, result)
117
+
118
+ def test_display_method_empty_value(self):
119
+ displayed = self.view.display('amount', no_value='foobar')
120
+ msg = "empty value display was expected to be 'foobar'"
121
+ self.assertTrue(displayed == 'foobar', msg)
122
+
123
+ displayed = self.doc_view.display('text', no_value='yolo')
124
+
125
+ # in plone 4 DX, the attr doesn't exist before manually set but it's None with plone > 5.0
126
+ if HAS_PLONE_4:
127
+ self.assertFalse(hasattr(self.doc, 'text'))
128
+ else:
129
+ self.assertIsNone(self.doc.text)
130
+
131
+ self.assertTrue(displayed == 'yolo', msg)
132
+
133
+ self.doc.text = RichTextValue()
134
+ displayed = self.doc_view.display('text', no_value='yolo')
135
+ self.assertEqual('', self.doc_view.real_context.text.output)
136
+ self.assertTrue(displayed == 'yolo', msg)
137
+
138
+ def test_display_method_bypass_check_permission(self):
139
+ self.content.amount = 20
140
+ self.assertFalse(api.user.is_anonymous())
141
+ self.assertEqual(self.view.display('amount', bypass_check_permission=False), 20)
142
+ self.assertEqual(self.view.display('amount', bypass_check_permission=True), 20)
143
+ logout()
144
+ self.assertTrue(api.user.is_anonymous())
145
+ self.assertEqual(self.view.display('amount', bypass_check_permission=False), u'')
146
+ self.assertEqual(self.view.display('amount', bypass_check_permission=True), 20)
147
+
148
+ def test_display_date_method(self):
149
+ effective_field_name = 'birth_datetime'
150
+ self.content.birth_datetime = datetime.datetime(1986, 9, 18, 10, 0)
151
+
152
+ # toLocalizedTime in 'fr'
153
+ expected_date = u'18/09/1986'
154
+ result = self.view.display_date(field_name=effective_field_name)
155
+ self.assertEqual(expected_date, result)
156
+ result = self.view.display_date(date=self.content.birth_datetime)
157
+ self.assertEqual(expected_date, result)
158
+
159
+ expected_date = u'18/09/1986 10:00'
160
+ result = self.view.display_date(field_name=effective_field_name, long_format=True)
161
+ self.assertEqual(expected_date, result)
162
+ result = self.view.display_date(date=self.content.birth_datetime, long_format=True)
163
+ self.assertEqual(expected_date, result)
164
+
165
+ expected_date = u'10:00'
166
+ result = self.view.display_date(field_name=effective_field_name, time_only=True)
167
+ self.assertEqual(expected_date, result)
168
+ result = self.view.display_date(date=self.content.birth_datetime, time_only=True)
169
+ self.assertEqual(expected_date, result)
170
+
171
+ # custom_format
172
+ expected_date = '18 yolo 09 yolo 1986'
173
+ result = self.view.display_date(
174
+ field_name=effective_field_name, custom_format='%d yolo %m yolo %Y')
175
+ self.assertEqual(expected_date, result)
176
+ result = self.view.display_date(
177
+ date=self.content.birth_datetime, custom_format='%d yolo %m yolo %Y')
178
+ self.assertEqual(expected_date, result)
179
+
180
+ # translation format has changed in Plone5.1+
181
+ if HAS_PLONE_5_1:
182
+ expected_date = u'jeu. 18 sept. 1986'
183
+ else:
184
+ # Plone4
185
+ expected_date = u'jeu 18 sep 1986'
186
+ result = self.view.display_date(
187
+ field_name=effective_field_name, custom_format='%a %d %b %Y',
188
+ target_language='fr')
189
+ self.assertEqual(expected_date, result)
190
+
191
+ expected_date = u'jeudi 18 Septembre 1986'
192
+ result = self.view.display_date(
193
+ field_name=effective_field_name, custom_format='%A %d %B %Y',
194
+ target_language='fr', month_lc=False)
195
+ self.assertEqual(expected_date, result)
196
+
197
+ expected_date = u'%Jeudi 18 %B 1986'
198
+ result = self.view.display_date(
199
+ field_name=effective_field_name, custom_format='%%%A %d %%B %Y',
200
+ target_language='fr', day_lc=False)
201
+ self.assertEqual(expected_date, result)
202
+
203
+ # date
204
+ self.content.birth_datetime = datetime.date(1986, 9, 18)
205
+ expected_date = u'18/09/1986'
206
+ result = self.view.display_date(field_name=effective_field_name)
207
+ self.assertEqual(expected_date, result)
208
+ result = self.view.display_date(date=self.content.birth_datetime)
209
+ self.assertEqual(expected_date, result)
210
+
211
+ expected_date = u'18/09/1986 00:00'
212
+ result = self.view.display_date(field_name=effective_field_name, long_format=True)
213
+ self.assertEqual(expected_date, result)
214
+ result = self.view.display_date(date=self.content.birth_datetime, long_format=True)
215
+ self.assertEqual(expected_date, result)
216
+
217
+ expected_date = u'00:00'
218
+ result = self.view.display_date(field_name=effective_field_name, time_only=True)
219
+ self.assertEqual(expected_date, result)
220
+ result = self.view.display_date(date=self.content.birth_datetime, time_only=True)
221
+ self.assertEqual(expected_date, result)
222
+
223
+ # custom_format
224
+ expected_date = '18 yolo 09 yolo 1986'
225
+ result = self.view.display_date(
226
+ field_name=effective_field_name, custom_format='%d yolo %m yolo %Y')
227
+ self.assertEqual(expected_date, result)
228
+ result = self.view.display_date(
229
+ date=self.content.birth_datetime, custom_format='%d yolo %m yolo %Y')
230
+ self.assertEqual(expected_date, result)
231
+
232
+ def test_display_voc_method(self):
233
+ field_name = 'languages'
234
+ to_set = ('en', 'fr')
235
+ expected = u'English|Français'
236
+ self.content.languages = to_set
237
+ result = self.view.display_voc(field_name, separator=u'|')
238
+ self.assertEqual(expected, result)
239
+
240
+ def test_display_list_method(self):
241
+ field_name = 'languages'
242
+ to_set = ('en', 'fr')
243
+ expected = u'en|fr'
244
+ self.content.languages = to_set
245
+ result = self.view.display_list(field_name, separator=u'|')
246
+ self.assertEqual(expected, result)
247
+
248
+ def test_list_method(self):
249
+ field_name = 'languages'
250
+ expected = ('en', 'fr')
251
+ self.content.languages = expected
252
+ result = self.view.list(field_name)
253
+ self.assertEqual(expected, result)
254
+
255
+ def test_display_text_as_html_method(self):
256
+ actual_field_name = 'description'
257
+ to_set = 'My description\r\nMy life\r\nhttp://www.imio.be'
258
+ expected = 'My description<br />My life<br /><a href="http://www.imio.be" rel="nofollow">http://www.imio.be</a>'
259
+
260
+ self.content.description = to_set
261
+ result = self.view.display_text_as_html(field_name=actual_field_name)
262
+ self.assertEqual(expected, result)
263
+
264
+ result = self.view.display_text_as_html(text=to_set)
265
+ self.assertEqual(expected, result)
266
+
267
+ result = self.view.display_text_as_html()
268
+ self.assertFalse(result, "Expected result to be None or '' but is " + result)
269
+
270
+ def test_display_html_as_text_method(self):
271
+ actual_field_name = 'description'
272
+ to_set = '<p>My description<br />My life<br /><a href="http://www.imio.be" ' \
273
+ 'rel="nofollow">http://www.imio.be</a></p>'
274
+ expected = 'My description\nMy life\nhttp://www.imio.be'
275
+
276
+ self.content.description = to_set
277
+ result = self.view.display_html_as_text(field_name=actual_field_name)
278
+ self.assertEqual(expected, result)
279
+
280
+ result = self.view.display_html_as_text(html=to_set)
281
+ self.assertEqual(expected, result)
282
+
283
+ result = self.view.display_html_as_text()
284
+ self.assertFalse(result, "Expected result to be None or '' but is " + result)
285
+
286
+ def test_render_xhtml_method_without_appy_renderer(self):
287
+ field_name = 'fullname'
288
+ to_set = 'John Doe'
289
+ expected = ''
290
+ self.content.fullname = to_set
291
+ result = self.view.render_xhtml(field_name)
292
+ self.assertEqual(expected, result)
293
+
294
+ def test_display_widget_method(self):
295
+ field_name = 'subscription'
296
+ to_set = 'gold'
297
+ self.content.subscription = to_set
298
+ # simple call
299
+ result = self.view.display_widget(field_name)
300
+ expected = ('\n<span class="select-widget choice-field" id="form-widgets-subscription">'
301
+ '<span class="selected-option">gold</span></span>\n')
302
+ self.assertEqual(result, expected)
303
+ # call without cleaning
304
+ result = self.view.display_widget(field_name, clean=False)
305
+ expected = ('\n<span id="form-widgets-subscription" class="select-widget choice-field">'
306
+ '<span class="selected-option">gold</span></span>\n\n')
307
+ self.assertEqual(result, expected)
308
+ # call with soup
309
+ result = self.view.display_widget(field_name, soup=True)
310
+ expected = '<span class="selected-option">gold</span>'
311
+ self.assertEqual(str(result.find('span', class_='selected-option')), expected)
312
+ self.assertEqual(result.find('span', class_='selected-option').text, u'gold')
313
+
314
+ def test_check_permission(self):
315
+ # test user has permission
316
+ self.assertTrue(self.view.check_permission('amount'))
317
+
318
+ # new user that doesn't have permission
319
+ api.user.create(username='foobar', email='foobar@example.com')
320
+ login(self.portal, 'foobar')
321
+ self.assertFalse(self.view.check_permission('amount'))
322
+
323
+ # manually set permission on a behavior's field
324
+ schema = getUtility(
325
+ IBehavior,
326
+ 'plone.app.dexterity.behaviors.metadata.IBasic').interface
327
+ schema.setTaggedValue(
328
+ READ_PERMISSIONS_KEY, {'description': 'cmf.ManagePortal'})
329
+
330
+ self.assertFalse(self.view.check_permission('description'))
331
+
332
+ def test_get_value(self):
333
+ # default obj or given one
334
+ self.assertEqual(self.view.get_value('id'), 'johndoe')
335
+ self.assertEqual(self.view.get_value('id', obj=self.doc), 'doc')
336
+ # test unknown field name (a behavior field by example, that can be activated or not)
337
+ self.assertEqual(self.view.get_value('unknown', strict=False), None)
338
+ self.assertEqual(self.view.get_value('unknown', default='aa', strict=False), 'aa')
339
+ self.assertRaises(AttributeError, self.view.get_value, 'unknown')
340
+ # test None value
341
+ self.assertIsNone(self.content.amount)
342
+ self.assertEqual(self.view.get_value('amount'), None)
343
+ self.assertEqual(self.view.get_value('amount', default='aa'), 'aa')
344
+ # check NO_VALUE
345
+ self.content.subscription = NO_VALUE
346
+ self.assertEqual(self.content.subscription, NO_VALUE)
347
+ self.assertEqual(self.view.get_value('subscription', default='aa'), 'aa')
348
+ # check RichText
349
+ self.content.biography = RichTextValue(raw=safe_unicode('<h1>Hello</h1>'), mimeType='text/html',
350
+ outputMimeType='text/html', encoding='utf-8')
351
+ self.assertEqual(self.view.get_value('biography'), '<h1>Hello</h1>')
352
+ # check utf8
353
+ self.content.title = u'héhé'
354
+ self.assertEqual(self.view.get_value('title'), u'héhé')
355
+ self.assertEqual(self.view.get_value('title', as_utf8=True), 'héhé')