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,398 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from collective.documentgenerator.testing import DexterityIntegrationTests
4
+ from plone import api
5
+ from plone.app.testing import login
6
+ from plone.app.testing import logout
7
+ from plone.app.textfield.value import RichTextValue
8
+ from plone.autoform.interfaces import READ_PERMISSIONS_KEY
9
+ from plone.behavior.interfaces import IBehavior
10
+ from Products.CMFPlone.utils import safe_unicode
11
+ from z3c.form.interfaces import NO_VALUE
12
+ from zope.component import getUtility
13
+
14
+ import datetime
15
+
16
+
17
+ class TestDexterityHelperView(DexterityIntegrationTests):
18
+
19
+ """Test Dexterity helper view."""
20
+
21
+ def test_DX_helper_view_registration(self):
22
+ """Test that when we query a IDocumentGenerationHelper adpater on an DX object, we get
23
+ the DX implementation of DocumentGenerationHelperView."""
24
+ from collective.documentgenerator.helper import DXDocumentGenerationHelperView
25
+
26
+ helper_view = self.content.unrestrictedTraverse(
27
+ "@@document_generation_helper_view"
28
+ )
29
+ msg = (
30
+ "The helper should have been an instance of DXDocumentGenerationHelperView"
31
+ )
32
+ self.assertTrue(isinstance(helper_view, DXDocumentGenerationHelperView), msg)
33
+
34
+ def test_DX_proxy_object_registration(self):
35
+ """Test that when we query a IDocumentGenerationHelper adpater on an DX object, we get
36
+ the DX implementation of DisplayProxyObject as context."""
37
+ from collective.documentgenerator.helper import DXDisplayProxyObject
38
+
39
+ helper_view = self.content.unrestrictedTraverse(
40
+ "@@document_generation_helper_view"
41
+ )
42
+ proxy = helper_view.context
43
+ msg = "The proxy object should have been an instance of DXDisplayProxyObject"
44
+ self.assertTrue(isinstance(proxy, DXDisplayProxyObject), msg)
45
+
46
+ def test_DX_proxy_object_behaviour(self):
47
+ """When trying to access an attribute attr_name on the object, the proxy should return
48
+ display(attr_name) if the attribute is a field of the object schema.
49
+ If attr_name is not a schema's field, it should delegate its access to the real object.
50
+
51
+ eg: proxy.title -> proxy.display(field_name='title', context=real_object)
52
+ proxy.some_method() -> real_object.some_method()
53
+ """
54
+ helper_view = self.content.unrestrictedTraverse(
55
+ "@@document_generation_helper_view"
56
+ )
57
+ proxy = helper_view.context
58
+
59
+ proxy.display = lambda field_name: "foobar"
60
+
61
+ msg = "The proxy should have call proxy.display() method."
62
+ self.assertTrue(proxy.fullname == "foobar", msg)
63
+
64
+ # description is in IBasic behavior
65
+ self.assertTrue(proxy.description == "foobar", msg)
66
+
67
+ msg = (
68
+ "If we try to access the attribute value through the accessor, it should return the real value "
69
+ "stored on the schema's field."
70
+ )
71
+ self.assertTrue(proxy.Description() != "foobar", msg)
72
+
73
+ wrapped = helper_view.real_context
74
+ msg = " __repr__ and __str__ should return the same result as the wrapped object: {} != {}"
75
+ self.assertEqual(
76
+ str(proxy),
77
+ str(helper_view.real_context),
78
+ msg.format(str(proxy), str(wrapped)),
79
+ )
80
+ msg = u" __unicode__ should return the same result as the wrapped object: {} != {}"
81
+ self.assertEqual(
82
+ str(proxy),
83
+ str(helper_view.real_context),
84
+ msg.format(str(proxy), str(wrapped)),
85
+ )
86
+
87
+
88
+ class TestDexterityHelperViewMethods(DexterityIntegrationTests):
89
+
90
+ """Test Dexterity implementation of helper view's methods."""
91
+
92
+ def setUp(self):
93
+ super(TestDexterityHelperViewMethods, self).setUp()
94
+ self.view = self.content.unrestrictedTraverse(
95
+ "@@document_generation_helper_view"
96
+ )
97
+ self.doc_view = self.doc.unrestrictedTraverse(
98
+ "@@document_generation_helper_view"
99
+ )
100
+
101
+ def test_display_method_on_text_field(self):
102
+ field_name = "fullname"
103
+ expected = "John Doe"
104
+ self.content.fullname = expected
105
+ result = self.view.display(field_name)
106
+ self.assertEqual(expected, result)
107
+
108
+ def test_display_method_on_multiselect_field(self):
109
+ field_name = "languages"
110
+ to_set = ["en", "fr"]
111
+ expected = u"English\nFrançais"
112
+ self.content.languages = to_set
113
+ result = self.view.display(field_name)
114
+ self.assertEqual(expected, result)
115
+
116
+ def test_display_method_on_datefield(self):
117
+ field_name = "birth_date"
118
+ to_set = datetime.date(1986, 9, 18)
119
+ expected = u"18/09/1986"
120
+ self.content.birth_date = to_set
121
+ result = self.view.display(field_name)
122
+ self.assertEqual(expected, result)
123
+
124
+ def test_display_method_on_datetimefield(self):
125
+ field_name = "birth_datetime"
126
+ to_set = datetime.datetime(1986, 9, 18, 10, 0)
127
+ expected = u"18/09/1986 10:00"
128
+ self.content.birth_datetime = to_set
129
+ result = self.view.display(field_name)
130
+ self.assertEqual(expected, result)
131
+
132
+ def test_display_method_empty_value(self):
133
+ displayed = self.view.display("amount", no_value="foobar")
134
+ msg = "empty value display was expected to be 'foobar'"
135
+ self.assertTrue(displayed == "foobar", msg)
136
+
137
+ displayed = self.doc_view.display("text", no_value="yolo")
138
+
139
+ self.assertIsNone(self.doc.text)
140
+
141
+ self.assertTrue(displayed == "yolo", msg)
142
+
143
+ self.doc.text = RichTextValue("")
144
+ displayed = self.doc_view.display("text", no_value="yolo")
145
+ self.assertEqual("", self.doc_view.real_context.text.output)
146
+ self.assertTrue(displayed == "yolo", msg)
147
+
148
+ def test_display_method_bypass_check_permission(self):
149
+ self.content.amount = 20
150
+ self.assertFalse(api.user.is_anonymous())
151
+ self.assertEqual(self.view.display("amount", bypass_check_permission=False), 20)
152
+ self.assertEqual(self.view.display("amount", bypass_check_permission=True), 20)
153
+ logout()
154
+ self.assertTrue(api.user.is_anonymous())
155
+ self.assertEqual(
156
+ self.view.display("amount", bypass_check_permission=False), u""
157
+ )
158
+ self.assertEqual(self.view.display("amount", bypass_check_permission=True), 20)
159
+
160
+ def test_display_date_method(self):
161
+ effective_field_name = "birth_datetime"
162
+ self.content.birth_datetime = datetime.datetime(1986, 9, 18, 10, 0)
163
+
164
+ # toLocalizedTime in 'fr'
165
+ expected_date = u"18/09/1986"
166
+ result = self.view.display_date(field_name=effective_field_name)
167
+ self.assertEqual(expected_date, result)
168
+ result = self.view.display_date(date=self.content.birth_datetime)
169
+ self.assertEqual(expected_date, result)
170
+
171
+ expected_date = u"18/09/1986 10:00"
172
+ result = self.view.display_date(
173
+ field_name=effective_field_name, long_format=True
174
+ )
175
+ self.assertEqual(expected_date, result)
176
+ result = self.view.display_date(
177
+ date=self.content.birth_datetime, long_format=True
178
+ )
179
+ self.assertEqual(expected_date, result)
180
+
181
+ expected_date = u"10:00"
182
+ result = self.view.display_date(field_name=effective_field_name, time_only=True)
183
+ self.assertEqual(expected_date, result)
184
+ result = self.view.display_date(
185
+ date=self.content.birth_datetime, time_only=True
186
+ )
187
+ self.assertEqual(expected_date, result)
188
+
189
+ # custom_format
190
+ expected_date = "18 yolo 09 yolo 1986"
191
+ result = self.view.display_date(
192
+ field_name=effective_field_name, custom_format="%d yolo %m yolo %Y"
193
+ )
194
+ self.assertEqual(expected_date, result)
195
+ result = self.view.display_date(
196
+ date=self.content.birth_datetime, custom_format="%d yolo %m yolo %Y"
197
+ )
198
+ self.assertEqual(expected_date, result)
199
+
200
+ # translation format has changed in Plone5.1+
201
+ expected_date = u"jeu. 18 sept. 1986"
202
+ result = self.view.display_date(
203
+ field_name=effective_field_name,
204
+ custom_format="%a %d %b %Y",
205
+ target_language="fr",
206
+ )
207
+ self.assertEqual(expected_date, result)
208
+
209
+ expected_date = u"jeudi 18 Septembre 1986"
210
+ result = self.view.display_date(
211
+ field_name=effective_field_name,
212
+ custom_format="%A %d %B %Y",
213
+ target_language="fr",
214
+ month_lc=False,
215
+ )
216
+ self.assertEqual(expected_date, result)
217
+
218
+ expected_date = u"%Jeudi 18 %B 1986"
219
+ result = self.view.display_date(
220
+ field_name=effective_field_name,
221
+ custom_format="%%%A %d %%B %Y",
222
+ target_language="fr",
223
+ day_lc=False,
224
+ )
225
+ self.assertEqual(expected_date, result)
226
+
227
+ # date
228
+ self.content.birth_datetime = datetime.date(1986, 9, 18)
229
+ expected_date = u"18/09/1986"
230
+ result = self.view.display_date(field_name=effective_field_name)
231
+ self.assertEqual(expected_date, result)
232
+ result = self.view.display_date(date=self.content.birth_datetime)
233
+ self.assertEqual(expected_date, result)
234
+
235
+ expected_date = u"18/09/1986 00:00"
236
+ result = self.view.display_date(
237
+ field_name=effective_field_name, long_format=True
238
+ )
239
+ self.assertEqual(expected_date, result)
240
+ result = self.view.display_date(
241
+ date=self.content.birth_datetime, long_format=True
242
+ )
243
+ self.assertEqual(expected_date, result)
244
+
245
+ expected_date = u"00:00"
246
+ result = self.view.display_date(field_name=effective_field_name, time_only=True)
247
+ self.assertEqual(expected_date, result)
248
+ result = self.view.display_date(
249
+ date=self.content.birth_datetime, time_only=True
250
+ )
251
+ self.assertEqual(expected_date, result)
252
+
253
+ # custom_format
254
+ expected_date = "18 yolo 09 yolo 1986"
255
+ result = self.view.display_date(
256
+ field_name=effective_field_name, custom_format="%d yolo %m yolo %Y"
257
+ )
258
+ self.assertEqual(expected_date, result)
259
+ result = self.view.display_date(
260
+ date=self.content.birth_datetime, custom_format="%d yolo %m yolo %Y"
261
+ )
262
+ self.assertEqual(expected_date, result)
263
+
264
+ def test_display_voc_method(self):
265
+ field_name = "languages"
266
+ to_set = ("en", "fr")
267
+ expected = u"English|Français"
268
+ self.content.languages = to_set
269
+ result = self.view.display_voc(field_name, separator=u"|")
270
+ self.assertEqual(expected, result)
271
+
272
+ def test_display_list_method(self):
273
+ field_name = "languages"
274
+ to_set = ("en", "fr")
275
+ expected = u"en|fr"
276
+ self.content.languages = to_set
277
+ result = self.view.display_list(field_name, separator=u"|")
278
+ self.assertEqual(expected, result)
279
+
280
+ def test_list_method(self):
281
+ field_name = "languages"
282
+ expected = ("en", "fr")
283
+ self.content.languages = expected
284
+ result = self.view.list(field_name)
285
+ self.assertEqual(expected, result)
286
+
287
+ def test_display_text_as_html_method(self):
288
+ actual_field_name = "description"
289
+ to_set = "My description\r\nMy life\r\nhttp://www.imio.be"
290
+ expected = 'My description<br />My life<br /><a href="http://www.imio.be" rel="nofollow">http://www.imio.be</a>'
291
+
292
+ self.content.description = to_set
293
+ result = self.view.display_text_as_html(field_name=actual_field_name)
294
+ self.assertEqual(expected, result)
295
+
296
+ result = self.view.display_text_as_html(text=to_set)
297
+ self.assertEqual(expected, result)
298
+
299
+ result = self.view.display_text_as_html()
300
+ self.assertFalse(result, "Expected result to be None or '' but is " + result)
301
+
302
+ def test_display_html_as_text_method(self):
303
+ actual_field_name = "description"
304
+ to_set = (
305
+ '<p>My description<br />My life<br /><a href="http://www.imio.be" '
306
+ 'rel="nofollow">http://www.imio.be</a></p>'
307
+ )
308
+ expected = "My description\nMy life\nhttp://www.imio.be"
309
+
310
+ self.content.description = to_set
311
+ result = self.view.display_html_as_text(field_name=actual_field_name)
312
+ self.assertEqual(expected, result)
313
+
314
+ result = self.view.display_html_as_text(html=to_set)
315
+ self.assertEqual(expected, result)
316
+
317
+ result = self.view.display_html_as_text()
318
+ self.assertFalse(result, "Expected result to be None or '' but is " + result)
319
+
320
+ def test_render_xhtml_method_without_appy_renderer(self):
321
+ field_name = "fullname"
322
+ to_set = "John Doe"
323
+ expected = ""
324
+ self.content.fullname = to_set
325
+ result = self.view.render_xhtml(field_name)
326
+ self.assertEqual(expected, result)
327
+
328
+ def test_display_widget_method(self):
329
+ field_name = "subscription"
330
+ to_set = "gold"
331
+ self.content.subscription = to_set
332
+ # simple call
333
+ result = self.view.display_widget(field_name)
334
+ expected = (
335
+ '\n<span class="select-widget choice-field" id="form-widgets-subscription">'
336
+ '<span class="selected-option">gold</span></span>\n'
337
+ )
338
+ self.assertEqual(result, expected)
339
+ # call without cleaning
340
+ result = self.view.display_widget(field_name, clean=False)
341
+ expected = (
342
+ b'\n<span id="form-widgets-subscription" class="select-widget choice-field">'
343
+ b'<span class="selected-option">gold</span></span>\n\n'
344
+ )
345
+ self.assertEqual(result, expected)
346
+ # call with soup
347
+ result = self.view.display_widget(field_name, soup=True)
348
+ expected = '<span class="selected-option">gold</span>'
349
+ self.assertEqual(str(result.find("span", class_="selected-option")), expected)
350
+ self.assertEqual(result.find("span", class_="selected-option").text, u"gold")
351
+
352
+ def test_check_permission(self):
353
+ # test user has permission
354
+ self.assertTrue(self.view.check_permission("amount"))
355
+
356
+ # new user that doesn't have permission
357
+ api.user.create(username="foobar", email="foobar@example.com")
358
+ login(self.portal, "foobar")
359
+ self.assertFalse(self.view.check_permission("amount"))
360
+
361
+ # manually set permission on a behavior's field
362
+ schema = getUtility(
363
+ IBehavior, "plone.app.dexterity.behaviors.metadata.IBasic"
364
+ ).interface
365
+ schema.setTaggedValue(READ_PERMISSIONS_KEY, {"description": "cmf.ManagePortal"})
366
+
367
+ self.assertFalse(self.view.check_permission("description"))
368
+
369
+ def test_get_value(self):
370
+ # default obj or given one
371
+ self.assertEqual(self.view.get_value("id"), "johndoe")
372
+ self.assertEqual(self.view.get_value("id", obj=self.doc), "doc")
373
+ # test unknown field name (a behavior field by example, that can be activated or not)
374
+ self.assertEqual(self.view.get_value("unknown", strict=False), None)
375
+ self.assertEqual(
376
+ self.view.get_value("unknown", default="aa", strict=False), "aa"
377
+ )
378
+ self.assertRaises(AttributeError, self.view.get_value, "unknown")
379
+ # test None value
380
+ self.assertIsNone(self.content.amount)
381
+ self.assertEqual(self.view.get_value("amount"), None)
382
+ self.assertEqual(self.view.get_value("amount", default="aa"), "aa")
383
+ # check NO_VALUE
384
+ self.content.subscription = NO_VALUE
385
+ self.assertEqual(self.content.subscription, NO_VALUE)
386
+ self.assertEqual(self.view.get_value("subscription", default="aa"), "aa")
387
+ # check RichText
388
+ self.content.biography = RichTextValue(
389
+ raw=safe_unicode("<h1>Hello</h1>"),
390
+ mimeType="text/html",
391
+ outputMimeType="text/html",
392
+ encoding="utf-8",
393
+ )
394
+ self.assertEqual(self.view.get_value("biography"), "<h1>Hello</h1>")
395
+ # check utf8
396
+ self.content.title = u"héhé"
397
+ self.assertEqual(self.view.get_value("title"), u"héhé")
398
+ self.assertEqual(self.view.get_value("title", as_utf8=True), "héhé")
@@ -0,0 +1,216 @@
1
+ # -*- coding: utf-8 -*-
2
+
3
+ from collective.documentgenerator.demo.helper import BaseDemoHelperView
4
+ from collective.documentgenerator.demo.helper import DXDemoHelperView
5
+ from collective.documentgenerator.testing import DexterityIntegrationTests
6
+ from plone import api
7
+
8
+ import appy
9
+ import io
10
+
11
+
12
+ class TestBaseHelperViewMethods(DexterityIntegrationTests):
13
+ """
14
+ Test base helper view's methods.
15
+ """
16
+
17
+ def setUp(self):
18
+ super(TestBaseHelperViewMethods, self).setUp()
19
+ self.view = self.content.unrestrictedTraverse(
20
+ "@@document_generation_helper_view"
21
+ )
22
+
23
+ def test_translate_method(self):
24
+ msgid = u"month_may"
25
+ translation = self.view.translate(msgid, domain="plonelocales")
26
+ self.assertTrue(translation == u"Mai")
27
+
28
+ def test_getDGHV(self):
29
+ new_dghv = self.view.getDGHV(self.portal["podtemplates"])
30
+ self.assertTrue(isinstance(new_dghv, BaseDemoHelperView))
31
+ self.assertTrue(isinstance(new_dghv, DXDemoHelperView))
32
+ self.assertEqual(new_dghv.real_context, self.portal["podtemplates"])
33
+ self.assertEqual(new_dghv.display("title"), "POD Templates")
34
+
35
+ def test_get_state(self):
36
+ # use 'simple_publication_workflow'
37
+ self.assertEqual(self.view.get_state(title=True), "Private")
38
+
39
+ def test_context_var(self):
40
+ pod_template = self.portal.podtemplates.get("test_template_multiple")
41
+ # Empty context_variables attribute
42
+ self.assertIsNone(pod_template.context_variables)
43
+
44
+ doc = api.content.create(type="Document", id="mydoc", container=self.portal)
45
+ view = doc.restrictedTraverse("@@document-generation")
46
+ view(template_uid=pod_template.UID(), output_format="odt")
47
+ document_template = pod_template.get_file()
48
+ helper_view = view.get_generation_context_helper()
49
+
50
+ generation_context = view._get_generation_context(
51
+ helper_view, pod_template=pod_template
52
+ )
53
+ template_data = io.BytesIO(document_template.data)
54
+ renderer = appy.pod.renderer.Renderer(
55
+ template_data, generation_context, "dummy.odt"
56
+ )
57
+ helper_view._set_appy_renderer(renderer)
58
+
59
+ # unknown variable
60
+ self.assertEqual(helper_view.context_var("dexter", "undefined"), "undefined")
61
+
62
+ # None value (after edition, an empty value is replaced by None)
63
+ pod_template.context_variables = [{"name": u"dexter", "value": None}]
64
+ generation_context = view._get_generation_context(
65
+ helper_view, pod_template=pod_template
66
+ )
67
+ renderer = appy.pod.renderer.Renderer(
68
+ template_data, generation_context, "dummy.odt"
69
+ )
70
+ helper_view._set_appy_renderer(renderer)
71
+ self.assertEqual(
72
+ helper_view.context_var("dexter"), ""
73
+ ) # default is '' by default
74
+
75
+ # add a context variable on pod template
76
+ pod_template.context_variables = [{"name": u"dexter", "value": u"1"}]
77
+ generation_context = view._get_generation_context(
78
+ helper_view, pod_template=pod_template
79
+ )
80
+ renderer = appy.pod.renderer.Renderer(
81
+ template_data, generation_context, "dummy.odt"
82
+ )
83
+ helper_view._set_appy_renderer(renderer)
84
+ self.assertEqual(helper_view.context_var("dexter", "undefined"), u"1")
85
+
86
+ def test_display_phone(self):
87
+ # belgian phone numbers
88
+ self.assertEqual(self.view.display_phone(phone=u"081000000"), u"081 00 00 00")
89
+ self.assertEqual(self.view.display_phone(phone=u"+3281000000"), u"081 00 00 00")
90
+ self.assertEqual(
91
+ self.view.display_phone(phone=u"081000000", country="BE"), u"081 00 00 00"
92
+ )
93
+ self.assertEqual(
94
+ self.view.display_phone(phone=u"081000000", format="nat"), u"081 00 00 00"
95
+ )
96
+ self.assertEqual(
97
+ self.view.display_phone(phone=u"081000000", format="int"),
98
+ u"+32 81 00 00 00",
99
+ )
100
+ # bad phone numbers
101
+ # self.assertEqual(self.view.display_phone(phone=u'abcdefgh'), u"Bad phone number: 'abcdefgh'")
102
+ self.assertEqual(
103
+ self.view.display_phone(phone=u"abcdefgh"),
104
+ u"Numéro de téléphone non reconnu: 'abcdefgh'",
105
+ )
106
+
107
+ # self.assertEqual(self.view.display_phone(phone='0810000000'), u"Invalid phone number: '0810000000'")
108
+ self.assertEqual(
109
+ self.view.display_phone(phone="0810000000"),
110
+ u"Numéro de téléphone non valide: '0810000000'",
111
+ )
112
+ # self.assertEqual(self.view.display_phone(phone='081000000', country='FR'),
113
+ # u"Invalid phone number: '081000000'")
114
+ self.assertEqual(
115
+ self.view.display_phone(phone="081000000", country="FR"),
116
+ u"Numéro de téléphone non valide: '081000000'",
117
+ )
118
+ # international phone numbers
119
+ self.assertEqual(
120
+ self.view.display_phone(phone=u"0033100000000"), u"+33 1 00 00 00 00"
121
+ )
122
+ self.assertEqual(
123
+ self.view.display_phone(phone=u"+33100000000"), u"+33 1 00 00 00 00"
124
+ )
125
+ self.assertEqual(
126
+ self.view.display_phone(phone=u"+33100000000", country="FR"),
127
+ u"01 00 00 00 00",
128
+ )
129
+ # formating phone numbers
130
+ self.assertEqual(
131
+ self.view.display_phone(phone="081000000", pattern="/."), u"081/00.00.00"
132
+ )
133
+ self.assertEqual(
134
+ self.view.display_phone(phone="081000000", pattern="/.,"), u"081/00.00,00"
135
+ )
136
+ self.assertEqual(
137
+ self.view.display_phone(phone="081000000", pattern="/ "), u"081/00 00 00"
138
+ )
139
+ self.assertEqual(
140
+ self.view.display_phone(phone="081000000", pattern="."), u"081.00.00.00"
141
+ )
142
+ self.assertEqual(
143
+ self.view.display_phone(phone="081000000", pattern=".|"), u"081.00.00.00"
144
+ )
145
+ self.assertEqual(
146
+ self.view.display_phone(phone="081000000", pattern=""), u"081 00 00 00"
147
+ )
148
+ self.assertEqual(
149
+ self.view.display_phone(phone="081000000", format="int", pattern="|-."),
150
+ u"+32-81.00.00.00",
151
+ )
152
+ self.assertEqual(
153
+ self.view.display_phone(phone="081000000", format="int", pattern=".|-."),
154
+ u"+32-81.00.00.00",
155
+ )
156
+ self.assertEqual(
157
+ self.view.display_phone(phone="081000000", format="int", pattern="."),
158
+ u"+32 81 00 00 00",
159
+ )
160
+ self.assertEqual(
161
+ self.view.display_phone(phone="081000000", pattern=[["/", "."]]),
162
+ u"081/00.00.00",
163
+ )
164
+ self.assertEqual(
165
+ self.view.display_phone(phone="081000000", pattern=[["/", " "]]),
166
+ u"081/00 00 00",
167
+ )
168
+ self.assertEqual(
169
+ self.view.display_phone(phone="081000000", pattern=[["."]]), u"081.00.00.00"
170
+ )
171
+ self.assertEqual(
172
+ self.view.display_phone(phone="081000000", pattern=[["."], [""]]),
173
+ u"081.00.00.00",
174
+ )
175
+ self.assertEqual(
176
+ self.view.display_phone(phone="081000000", pattern=[[""]]), u"081000000"
177
+ )
178
+ self.assertEqual(
179
+ self.view.display_phone(
180
+ phone="081000000", format="int", pattern=[[], ["-", "."]]
181
+ ),
182
+ u"+32-81.00.00.00",
183
+ )
184
+ self.assertEqual(
185
+ self.view.display_phone(
186
+ phone="081000000", format="int", pattern=[["."], ["-", "."]]
187
+ ),
188
+ u"+32-81.00.00.00",
189
+ )
190
+ self.assertEqual(
191
+ self.view.display_phone(phone="081000000", format="int", pattern=[["."]]),
192
+ u"+32 81 00 00 00",
193
+ )
194
+ self.assertEqual(
195
+ self.view.display_phone(
196
+ phone="081000000", format="int", pattern=[[], [" (0)", " "]]
197
+ ),
198
+ u"+32 (0)81 00 00 00",
199
+ )
200
+
201
+ def test_iterable_as_columns(self):
202
+ self.assertListEqual(self.view.iterable_in_columns(None), [])
203
+ self.assertListEqual(self.view.iterable_in_columns([]), [])
204
+ self.assertListEqual(self.view.iterable_in_columns([1, 2, 3]), [[1], [2], [3]])
205
+ self.assertListEqual(
206
+ self.view.iterable_in_columns([1, 2, 3, 4, 5], 2), [[1, 2], [3, 4], [5]]
207
+ )
208
+ self.assertListEqual(
209
+ self.view.iterable_in_columns([1, 2, 3, 4, 5], 3), [[1, 2, 3], [4, 5]]
210
+ )
211
+ self.assertListEqual(
212
+ self.view.iterable_in_columns([1, 2, 3, 4, 5], 5), [[1, 2, 3, 4, 5]]
213
+ )
214
+ self.assertListEqual(
215
+ self.view.iterable_in_columns("12345", 5), [["1", "2", "3", "4", "5"]]
216
+ )