senaite.core.z3cform.widgets.queryselect.widget

Complexity

Total Complexity

36

Size/Duplication

Total Lines	217
Duplicated Lines	27.65 %

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	QuerySelectWidget.get_allow_user_value()	0	4	1
A	QuerySelectWidget.get_query()	0	2	1
B	QuerySelectWidget.get_context()	31	31	6
A	QuerySelectWidget.update()	0	3	1
A	QuerySelectWidget.get_search_wildcard()	0	2	1
A	QuerySelectWidget.get_hide_input_after_select()	0	2	1
A	QuerySelectDataConverter.toWidgetValue()	0	12	1
A	QuerySelectWidget.get_value_key()	0	2	1
A	QuerySelectWidget.get_input_widget_attributes()	0	29	2
A	QuerySelectWidget.get_api_url()	0	7	1
A	QuerySelectWidget.get_catalog()	0	2	1
A	QuerySelectWidget.get_search_index()	0	2	1
A	QuerySelectWidget.get_value()	14	14	4
A	QuerySelectDataConverter.toFieldValue()	0	6	1
A	QuerySelectWidget.get_columns()	0	2	1
A	QuerySelectWidget.is_multi_valued()	0	2	1
A	QuerySelectWidget.get_limit()	0	2	1
B	QuerySelectWidget.attr()	15	15	6
A	QuerySelectWidget.get_form()	0	11	3

# -*- coding: utf-8 -*-

import json

import six

from bika.lims import api
from plone.z3cform.fieldsets.interfaces import IDescriptiveGroup
from Products.CMFPlone.utils import base_hasattr
from senaite.core.interfaces import ISenaiteFormLayer
from senaite.core.z3cform.interfaces import IQuerySelectWidget
from z3c.form.browser import widget
from z3c.form.converter import TextLinesConverter
from z3c.form.interfaces import IDataConverter
from z3c.form.interfaces import IFieldWidget
from z3c.form.interfaces import ISubForm
from z3c.form.widget import FieldWidget
from z3c.form.widget import Widget
from zope.component import adapter
from zope.component import getUtility
from zope.component.interfaces import IFactory
from zope.interface import implementer
from zope.interface import implementer_only
from zope.schema.interfaces import IField
from zope.schema.interfaces import ISequence

_marker = object


@adapter(ISequence, IQuerySelectWidget)
class QuerySelectDataConverter(TextLinesConverter):
    """Converter for multi valued List fields
    """
    def toWidgetValue(self, value):
        """Return the value w/o changes

        Note:

        All widget templates use the `get_value` method,
        which ensures a list of UIDs.

        However, `toWidgetValue` is called by `widget.update()` implicitly for
        `self.value`, which is then used by the `get_value` method again.
        """
        return value

    def toFieldValue(self, value):
        """Converts a unicode string to a list of UIDs
        """
        # remove any blank lines at the end
        value = value.rstrip("\r\n")
        return super(QuerySelectDataConverter, self).toFieldValue(value)


@implementer_only(IQuerySelectWidget)
class QuerySelectWidget(widget.HTMLInputWidget, Widget):
    """A widget to select one or more items from catalog search
    """
    klass = u"senaite-queryselect-widget-input"

    def update(self):
        super(QuerySelectWidget, self).update()
        widget.addFieldClass(self)

    def get_form(self):
        """Return the current form of the widget
        """
        form = self.form
        # form is a fieldset group
        if IDescriptiveGroup.providedBy(form):
            form = form.parentForm
        # form is a subform (e.g. DataGridFieldObjectSubForm)
        if ISubForm.providedBy(form):
            form = form.parentForm
        return form

    def get_context(self):

This code seems to be duplicated in your project.

        """Get the current context

        NOTE: If we are in the ++add++ form, `self.context` is the container!
              Therefore, we create one here to have access to the methods.
        """
        schema_iface = self.field.interface
        if schema_iface and schema_iface.providedBy(self.context):
            return self.context

        # we might be in a subform, so try first to retrieve the object from
        # the base form itself first
        form = self.get_form()
        portal_type = getattr(form, "portal_type", None)
        context = getattr(form, "context", None)
        if api.is_object(context):
            if api.get_portal_type(context) == portal_type:
                return context

        # Hack alert!
        # we are in ++add++ form and have no context!
        # Create a temporary object to be able to access class methods
        if not portal_type:
            portal_type = api.get_portal_type(self.context)
        portal_types = api.get_tool("portal_types")
        fti = portal_types[portal_type]
        factory = getUtility(IFactory, fti.factory)
        context = factory("temporary")
        # hook into acquisition chain
        context = context.__of__(self.context)
        return context

    def attr(self, name, default=None):

This code seems to be duplicated in your project.

        """Get the named attribute of the widget or the field
        """
        value = getattr(self, name, _marker)
        if value is _marker:
            return default
        if isinstance(value, six.string_types):
            context = self.get_context()
            if base_hasattr(context, value):
                attr = getattr(context, value)
                if callable(attr):
                    attr = attr()
                if attr:
                    value = attr
        return value

    def get_value(self):

This code seems to be duplicated in your project.

        """Extract the value from the request or get it from the field
        """
        # get the processed value from the `update` method
        value = self.value
        # the value might come from the request, e.g. on object creation
        if isinstance(value, six.string_types):
            value = IDataConverter(self).toFieldValue(value)
        # we handle always lists in the templates
        if value is None:
            return []
        if not isinstance(value, (list, tuple)):
            value = [value]
        return value

    def get_catalog(self):
        return self.attr("catalog", "portal_catalog")

    def get_query(self):
        return self.attr("query", {})

    def get_search_index(self):
        return self.attr("search_index", "")

    def get_value_key(self):
        return self.attr("value_key", "uid")

    def get_limit(self):
        return self.attr("limit", 25)

    def get_search_wildcard(self):
        return self.attr("search_wildcard", True)

    def get_allow_user_value(self):
        """Allow the user to enter a custom value
        """
        return self.attr("allow_user_value", False)

    def get_columns(self):
        return self.attr("columns", [])

    def is_multi_valued(self):
        return self.attr("multi_valued", False)

    def get_hide_input_after_select(self):
        return self.attr("hide_input_after_select", False)

    def get_input_widget_attributes(self):
        """Return input widget attributes for the ReactJS component
        """
        values = self.get_value()
        attributes = {
            "data-id": self.id,
            "data-name": self.name,
            "data-values": values,
            "data-value_key": self.get_value_key(),
            "data-api_url": self.get_api_url(),
            "data-query": self.get_query(),
            "data-catalog": self.get_catalog(),
            "data-search_index": self.get_search_index(),
            "data-search_wildcard": self.get_search_wildcard(),
            "data-allow_user_value": self.get_allow_user_value(),
            "data-columns": self.get_columns(),
            "data-display_template": None,
            "data-limit": self.get_limit(),
            "data-multi_valued": self.is_multi_valued(),
            "data-disabled": self.disabled or False,
            "data-readonly": self.readonly or False,
            "data-hide_input_after_select": self.get_hide_input_after_select(),
        }

        # convert all attributes to JSON
        for key, value in attributes.items():
            attributes[key] = json.dumps(value)

        return attributes

    def get_api_url(self):
        """JSON API URL to use for this widget
        """
        portal = api.get_portal()
        portal_url = api.get_url(portal)
        api_url = "{}/@@API/senaite/v1".format(portal_url)
        return api_url


@adapter(IField, ISenaiteFormLayer)
@implementer(IFieldWidget)
def QuerySelectWidgetFactory(field, request):
    """Widget factory
    """
    return FieldWidget(field, QuerySelectWidget(request))