yafowil.widget.array 2.0.0__py2.py3-none-any.whl

yafowil/widget/array/__init__.py

@@ -0,0 +1,211 @@
+from yafowil.base import factory
+from yafowil.utils import entry_point
+import os
+import webresource as wr
+
+
+resources_dir = os.path.join(os.path.dirname(__file__), 'resources')
+
+
+##############################################################################
+# Common
+##############################################################################
+
+# webresource ################################################################
+
+array_js = wr.ScriptResource(
+    name='yafowil-array-js',
+    directory=os.path.join(resources_dir, 'default'),
+    path='yafowil-array/default',
+    depends='jquery-js',
+    resource='widget.js',
+    compressed='widget.min.js'
+)
+
+# B/C resources ##############################################################
+
+js = [{
+    'group': 'yafowil.widget.array.common',
+    'resource': 'default/widget.js',
+    'order': 20,
+}]
+
+
+##############################################################################
+# Default
+##############################################################################
+
+# webresource ################################################################
+
+default_resources = wr.ResourceGroup(
+    name='yafowil.widget.array',
+    directory=resources_dir,
+    path='yafowil-array'
+)
+default_resources.add(array_js)
+default_resources.add(wr.StyleResource(
+    name='yafowil-array-css',
+    directory=os.path.join(resources_dir, 'default'),
+    path='yafowil-array/default',
+    resource='widget.min.css'
+))
+
+# B/C resources ##############################################################
+
+default_css = [{
+    'group': 'yafowil.widget.array.common',
+    'resource': 'default/widget.min.css',
+    'order': 20,
+}]
+
+
+##############################################################################
+# Bootstrap
+##############################################################################
+
+# webresource ################################################################
+
+bootstrap_resources = wr.ResourceGroup(
+    name='yafowil.widget.array',
+    directory=resources_dir,
+    path='yafowil-array'
+)
+bootstrap_resources.add(array_js)
+bootstrap_resources.add(wr.StyleResource(
+    name='yafowil-array-css',
+    directory=os.path.join(resources_dir, 'bootstrap'),
+    path='yafowil-array/bootstrap',
+    resource='widget.min.css'
+))
+
+# B/C resources ##############################################################
+
+bootstrap_css = [{
+    'group': 'yafowil.widget.array.common',
+    'resource': 'bootstrap/widget.min.css',
+    'order': 20,
+}]
+
+
+##############################################################################
+# Bootstrap 5
+##############################################################################
+
+# webresource ################################################################
+bootstrap5_resources = wr.ResourceGroup(
+    name='yafowil.widget.array',
+    directory=resources_dir,
+    path='yafowil-array'
+)
+bootstrap5_js = wr.ScriptResource(
+    name='yafowil-array-js',
+    directory=os.path.join(resources_dir, 'bootstrap5'),
+    path='yafowil-array/bootstrap5',
+    depends='jquery-js',
+    resource='widget.js',
+    compressed='widget.min.js'
+)
+bootstrap5_resources.add(bootstrap5_js)
+bootstrap5_resources.add(wr.StyleResource(
+    name='yafowil-array-css',
+    directory=os.path.join(resources_dir, 'bootstrap5'),
+    path='yafowil-array/bootstrap5',
+    resource='widget.min.css'
+))
+
+# B/C resources ##############################################################
+
+bootstrap5_css = [{
+    'group': 'yafowil.widget.array.common',
+    'resource': 'bootstrap5/widget.min.css',
+    'order': 20,
+}]
+
+
+
+##############################################################################
+# Plone5
+##############################################################################
+
+# webresource ################################################################
+
+plone5_resources = wr.ResourceGroup(
+    name='yafowil.widget.array',
+    directory=resources_dir,
+    path='yafowil-array'
+)
+plone5_resources.add(array_js)
+plone5_resources.add(wr.StyleResource(
+    name='yafowil-array-css',
+    directory=os.path.join(resources_dir, 'plone5'),
+    path='yafowil-array/plone5',
+    resource='widget.min.css'
+))
+
+# B/C resources ##############################################################
+
+plone5_css = [{
+    'group': 'yafowil.widget.array.common',
+    'resource': 'plone5/widget.min.css',
+    'order': 20,
+}]
+
+
+##############################################################################
+# Registration
+##############################################################################
+
+@entry_point(order=10)
+def register():
+    from yafowil.widget.array import widget  # noqa
+
+    widget_name = 'yafowil.widget.array'
+
+    # Default
+    factory.register_theme(
+        'default',
+        widget_name,
+        resources_dir,
+        js=js,
+        css=default_css
+    )
+    factory.register_resources('default', widget_name, default_resources)
+
+    # Bootstrap
+    factory.register_theme(
+        ['bootstrap', 'bootstrap3'],
+        widget_name,
+        resources_dir,
+        js=js,
+        css=bootstrap_css
+    )
+    factory.register_resources(
+        ['bootstrap', 'bootstrap3'],
+        widget_name,
+        bootstrap_resources
+    )
+
+    # Bootstrap 5
+    factory.register_theme(
+        ['bootstrap5'],
+        widget_name,
+        resources_dir,
+        js=bootstrap5_js,
+        css=bootstrap5_css
+    )
+
+    factory.register_resources(
+        ['bootstrap5'],
+        widget_name,
+        bootstrap5_resources
+    )
+
+    # Plone 5
+    factory.register_theme(
+        'plone5',
+        widget_name,
+        resources_dir,
+        js=js,
+        css=plone5_css
+    )
+    factory.register_resources('plone5', widget_name, plone5_resources)

yafowil/widget/array/example.py

@@ -0,0 +1,418 @@
+from yafowil.base import factory
+
+
+DOC_ARRAY_WITH_LEAFS = """
+Array with single fields as array entries
+-----------------------------------------
+
+Array containing single field entries. Preset value is expected as list.
+
+.. code-block:: python
+
+    value = ['1', '2', '3']
+    array = factory('#array', value=value, props={
+        'label': 'My Array',
+        'help': 'I am an array',
+        'required': 'Array must at least contain one entry',
+    })
+    array['field'] = factory('#arrayfield:text', props={
+        'label': 'Entry',
+        'help': 'I am an array entry',
+        'required': 'Entry must not be empty',
+    })
+"""
+
+
+def array_with_leafs():
+    form = factory('fieldset',
+                   name='yafowil.widget.array.array_with_leafs')
+    value = ['1', '2', '3']
+    arr = form['array'] = factory('#array', value=value, props={
+        'label': 'My Array',
+        'help': 'I am an array',
+        'required': 'Array must at least contain one entry',
+    })
+    arr['field'] = factory('#arrayfield:text', props={
+        'label': 'Entry',
+        'help': 'I am an array entry',
+        'required': 'Entry must not be empty',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_LEAFS,
+        'title': 'Single field array',
+    }
+
+
+DOC_ARRAY_WITH_COMPOUNDS = """
+Array with compounds as array entries
+-------------------------------------
+
+Array containing compound entries. Preset value is expected as list containing
+dictionaries addressing array child compound fields by key.
+
+.. code-block:: python
+
+    value = [
+        {'f1': 'Value 1.1 F1', 'f2': 'Value 1.2 F2'},
+        {'f1': 'Value 2.1 F1', 'f2': 'Value 2.2 F2'},
+    ]
+    array = factory('#array', value=value, props={
+        'label': 'Compound Array'
+        'required': 'Array must at least contain one entry',
+    })
+    compound = array['compound'] = factory('compound')
+    compound['f1'] = factory('#arrayfield:text', props={
+        'label': 'Field 1',
+    })
+    compound['f2'] = factory('#arrayfield:text', props={
+        'label': 'Field 2',
+        'required': 'Field 2 is required',
+    })
+"""
+
+
+def array_with_compounds():
+    form = factory('fieldset',
+                   name='yafowil.widget.array.array_with_compounds')
+    value = [
+        {'f1': 'Value 1.1 F1', 'f2': 'Value 1.2 F2'},
+        {'f1': 'Value 2.1 F1', 'f2': 'Value 2.2 F2'},
+    ]
+    arr = form['array'] = factory('#array', value=value, props={
+        'label': 'Compound Array',
+        'required': 'Array must at least contain one entry',
+    })
+    comp = arr['compound'] = factory('compound')
+    comp['f1'] = factory('#arrayfield:text', props={
+        'label': 'Field 1',
+    })
+    comp['f2'] = factory('#arrayfield:text', props={
+        'label': 'Field 2',
+        'required': 'Field 2 is required',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_COMPOUNDS,
+        'title': 'Compound field array',
+    }
+
+
+DOC_ARRAY_WITH_ARRAY_WITH_LEAFS = """
+Array in array with single fields
+---------------------------------
+
+Array in array containing single field entries. Preset value is a 2-dimensional
+list
+
+.. code-block:: python
+
+    value = [['1', '2'], ['3', '4'], ['5', '6']]
+    array = factory('#array', value=value, props={
+        'label': 'Array',
+        'required': 'Array must at least contain one entry',
+    })
+    subarray = array['subarray'] = factory('error:array', props={
+        'label': 'Subarray',
+        'required': 'Subarray must at least contain one entry',
+    })
+    subarray['field'] = factory('#arrayfield:text', props={
+        'label': 'Entry',
+        'required': 'Entry must not be empty',
+    })
+"""
+
+
+def array_with_array_with_leafs():
+    form = factory('fieldset',
+                   name='yafowil.widget.array_with_array_with_leafs')
+    value = [['1', '2'], ['3', '4'], ['5', '6']]
+    arr = form['array'] = factory('#array', value=value, props={
+        'label': 'Array',
+        'required': 'Array must at least contain one entry',
+    })
+    subarr = arr['subarray'] = factory('error:array', props={
+        'label': 'Subarray',
+        'required': 'Subarray must at least contain one entry',
+    })
+    subarr['field'] = factory('#arrayfield:text', props={
+        'label': 'Entry',
+        'required': 'Entry must not be empty',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_ARRAY_WITH_LEAFS,
+        'title': 'Single field array in array',
+    }
+
+
+DOC_ARRAY_WITH_ARRAY_WITH_COMPOUNDS = """\
+Array in array with compounds as array entries
+----------------------------------------------
+
+Array in array containing compound entries. Preset value is lists in list
+containing dictionaries addressing inner array child compound fields by key.
+
+.. code-block:: python
+
+    value = [
+        [{
+            'f1': 'Value 0.0 F1',
+            'f2': 'Value 0.0 F2',
+        }, {
+            'f1': 'Value 0.1 F1',
+            'f2': 'Value 0.1 F2',
+        }], [{
+            'f1': 'Value 1.0 F1',
+            'f2': 'Value 1.0 F2',
+        }, {
+            'f1': 'Value 1.1 F1',
+            'f2': 'Value 1.1 F2',
+        }]
+    ]
+    array = factory('#array', value=value, props={
+        'label': 'Array 1',
+    })
+    subarray = array['subarray'] = factory('array', props={
+        'label': 'Array 2',
+    })
+    compound = subarray['comp'] = factory('compound')
+    compound['f1'] = factory('#arrayfield:text', props={
+        'label': 'F1',
+    })
+    compound['f2'] = factory('#arrayfield:text', props={
+        'label': 'F2',
+        'required': 'F2 is required',
+    })
+"""
+
+
+def array_with_array_with_compounds():
+    form = factory('fieldset',
+                   name='yafowil.widget.array_with_array_with_compounds')
+    value = [
+        [{
+            'f1': 'Value 0.0 F1',
+            'f2': 'Value 0.0 F2',
+        }, {
+            'f1': 'Value 0.1 F1',
+            'f2': 'Value 0.1 F2',
+        }], [{
+            'f1': 'Value 1.0 F1',
+            'f2': 'Value 1.0 F2',
+        }, {
+            'f1': 'Value 1.1 F1',
+            'f2': 'Value 1.1 F2',
+        }]
+    ]
+    arr = form['array'] = factory('#array', value=value, props={
+        'label': 'Array 1',
+    })
+    subarr = arr['subarray'] = factory('array', props={
+        'label': 'Array 2',
+    })
+    comp = subarr['comp'] = factory('compound')
+    comp['f1'] = factory('#arrayfield:text', props={
+        'label': 'F1',
+    })
+    comp['f2'] = factory('#arrayfield:text', props={
+        'label': 'F2',
+        'required': 'F2 is required',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_ARRAY_WITH_COMPOUNDS,
+        'title': 'Compound array in array',
+    }
+
+
+DOC_ARRAY_WITH_ARRAY_WITH_ARRAY_WITH_LEAFS = """\
+3-Dimensional Array with single fields
+--------------------------------------
+
+3-Dimensional array containing single field entries. Preset value is a
+3-dimensional list
+
+.. code-block:: python
+
+    value = [[['1', '2'], ['3']], [['4', '5']]]
+    arr_1 = factory('#array', value=value, props={
+        'label': 'Array 1',
+        'help': 'This is Array 1',
+        'required': 'Array 1 must not be empty',
+    })
+    arr_2 = arr_1['array_2'] = factory('help:error:array', props={
+        'label': 'Array 2',
+        'help': 'This is Array 2',
+        'required': 'Array 2 must not be empty',
+    })
+    arr_3 = arr_2['array_3'] = factory('help:error:array', props={
+        'label': 'Array 3',
+        'help': 'This is Array 3',
+        'required': 'Array 3 must not be empty',
+    })
+    arr_3['field'] = factory('#arrayfield:text', props={
+        'label': 'Text Field',
+        'help': 'This is the text field',
+        'required': 'Text Field is required',
+    })
+"""
+
+
+def array_with_array_with_array_with_leafs():
+    form = factory(
+        'fieldset',
+        name='yafowil.widget.array_with_array_with_array_with_leafs')
+    value = [[['1', '2'], ['3']], [['4', '5']]]
+    arr_1 = form['array_1'] = factory('#array', value=value, props={
+        'label': 'Array 1',
+        'help': 'This is Array 1',
+        'required': 'Array 1 must not be empty',
+    })
+    arr_2 = arr_1['array_2'] = factory('help:error:array', props={
+        'label': 'Array 2',
+        'help': 'This is Array 2',
+        'required': 'Array 2 must not be empty',
+    })
+    arr_3 = arr_2['array_3'] = factory('help:error:array', props={
+        'label': 'Array 3',
+        'help': 'This is Array 3',
+        'required': 'Array 3 must not be empty',
+    })
+    arr_3['textfield'] = factory('#arrayfield:text', props={
+        'label': 'Text Field',
+        'help': 'This is the text field',
+        'required': 'Text Field is required',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_ARRAY_WITH_ARRAY_WITH_LEAFS,
+        'title': 'Single fields in 3-dimensional array',
+    }
+
+
+DOC_ARRAY_WITH_ARRAY_WITH_ARRAY_WITH_COMPOUNDS = """\
+3-Dimensional Array with compounds
+----------------------------------
+
+3-Dimensional array containing compound entries. Preset value is a
+3-dimensional list containing dictionaries addressing most inner array child
+compound fields by key.
+
+.. code-block:: python
+
+    value = [
+        [[{
+            'f1': 'Value F1',
+            'f2': 'Value F2',
+        }]], [[{
+            'f1': 'Value F1',
+            'f2': 'Value F2',
+        }]]
+    ]
+    arr_1 = factory('#array', value=value, props={
+        'label': 'Array 1',
+    })
+    arr_2 = arr_1['array_2'] = factory('array', props={
+        'label': 'Array 2',
+    })
+    arr_3 = arr_2['array_3'] = factory('array', props={
+        'label': 'Array 3',
+    })
+    compound = arr_3['comp'] = factory('compound')
+    compound['f1'] = factory('#arrayfield:text', props={
+        'label': 'F1',
+    })
+    compound['f2'] = factory('#arrayfield:text', props={
+        'label': 'F2',
+        'required': 'F2 is required',
+    })
+"""
+
+
+def array_with_array_with_array_with_compounds():
+    form = factory(
+        'fieldset',
+        name='yafowil.widget.array_with_array_with_array_with_compounds')
+    value = [
+        [[{
+            'f1': 'Value F1',
+            'f2': 'Value F2',
+        }]], [[{
+            'f1': 'Value F1',
+            'f2': 'Value F2',
+        }]]]
+    arr_1 = form['array_1'] = factory('#array', value=value, props={
+        'label': 'Array 1',
+    })
+    arr_2 = arr_1['array_2'] = factory('array', props={
+        'label': 'Array 2',
+    })
+    arr_3 = arr_2['array_3'] = factory('array', props={
+        'label': 'Array 3',
+    })
+    comp = arr_3['comp'] = factory('compound')
+    comp['f1'] = factory('#arrayfield:text', props={
+        'label': 'F1',
+    })
+    comp['f2'] = factory('#arrayfield:text', props={
+        'label': 'F2',
+        'required': 'F2 is required',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_ARRAY_WITH_ARRAY_WITH_COMPOUNDS,
+        'title': 'Compounds in 3-dimensional array',
+    }
+
+
+DOC_ARRAY_DISPLAY = """\
+Display Mode
+------------
+
+Display mode renders the widget and its children uneditable.
+
+.. code-block:: python
+
+    value = ['1', '2', '3', '4']
+    array = factory('#array', value=value, mode='display', props={
+        'label': 'An Array in display mode',
+        'help': 'I am an array',
+    })
+    array['field'] = factory('#arrayfield:text', props={
+        'label': 'Entry in display mode',
+        'help': 'I am an array entry',
+    })
+"""
+
+
+def array_display():
+    form = factory(
+        'fieldset',
+        name='yafowil.widget.array_display')
+    value = ['I am not editable.', 'Me neither!']
+    array = form['array'] = factory('#array', mode='display', value=value, props={
+        'label': 'An Array in display mode',
+        'help': 'I am an array'
+    })
+    array['field'] = factory('#arrayfield:text', props={
+        'label': 'Entry in display mode',
+        'help': 'I am an array entry',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_DISPLAY,
+        'title': 'Display Mode',
+    }
+
+
+def get_example():
+    return [
+        array_with_leafs(),
+        array_with_compounds(),
+        array_with_array_with_leafs(),
+        array_with_array_with_compounds(),
+        array_with_array_with_array_with_leafs(),
+        array_with_array_with_array_with_compounds(),
+        array_display(),
+    ]

yafowil/widget/array/resources/bootstrap/widget.min.css

@@ -0,0 +1 @@
+.arraytemplate{display:none}.icon-circle-arrow-down,.icon-circle-arrow-up,.icon-minus-sign,.icon-plus-sign{display:inline-block;font-family:Glyphicons Halflings;font-style:normal;font-weight:400;line-height:1;margin-left:2px;position:relative;top:1px}.icon-plus-sign:before{content:""}.icon-minus-sign:before{content:""}.icon-circle-arrow-up:before{content:""}.icon-circle-arrow-down:before{content:""}.array table{border-radius:4px;margin-bottom:0}.array table table{border-right:1px solid #ddd;margin-top:10px}.array table table th{padding-left:0}.array table td.widget{padding:0 0 10px}.array table td.widget .form-group{margin:0}.array table th{vertical-align:middle}.array table td.actions,.array table th.head_actions{width:5.5em}.array .array_actions{display:inline-block;margin-top:.6em;padding-right:.45em;width:5.5em}.array .array_actions a{background:none;float:right}.array .array_actions a.array_row_down_disabled,.array .array_actions a.array_row_up_disabled{filter:alpha(opacity=40);opacity:.4}.array .array_actions span{color:var(--yafowil-accent-color,#0d6efd)}