senaite.core.z3cform.widgets.queryselect.widget.QuerySelectWidget.attr() - Code Metrics - Inspection of "Dexterity Queryselect Widget (#2177)" - senaite/senaite.core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 2.x ( dfb5c5...7c9886 )

by Jordi

created 2022-11-07 09:25 UTC

QuerySelectWidget.attr() B

↳ Parent: senaite.core.z3cform.widgets.queryselect.widget

Complexity

Conditions

Size

Total Lines	15
Code Lines	13

Duplication

Lines	15
Ratio	100 %

Importance

Changes

Metric	Value
eloc	13
dl	15
loc	15
rs	8.6666
c	0
b	0
f	0
cc	6
nop	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):

        """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):

        """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):

        """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))


1		# -- coding: utf-8 --
2
3		import json
4
5		import six
6
7		from bika.lims import api
8		from plone.z3cform.fieldsets.interfaces import IDescriptiveGroup
9		from Products.CMFPlone.utils import base_hasattr
10		from senaite.core.interfaces import ISenaiteFormLayer
11		from senaite.core.z3cform.interfaces import IQuerySelectWidget
12		from z3c.form.browser import widget
13		from z3c.form.converter import TextLinesConverter
14		from z3c.form.interfaces import IDataConverter
15		from z3c.form.interfaces import IFieldWidget
16		from z3c.form.interfaces import ISubForm
17		from z3c.form.widget import FieldWidget
18		from z3c.form.widget import Widget
19		from zope.component import adapter
20		from zope.component import getUtility
21		from zope.component.interfaces import IFactory
22		from zope.interface import implementer
23		from zope.interface import implementer_only
24		from zope.schema.interfaces import IField
25		from zope.schema.interfaces import ISequence
26
27		_marker = object
28
29
30		@adapter(ISequence, IQuerySelectWidget)
31		class QuerySelectDataConverter(TextLinesConverter):
32		"""Converter for multi valued List fields
33		"""
34		def toWidgetValue(self, value):
35		"""Return the value w/o changes
36
37		Note:
38
39		All widget templates use the `get_value` method,
40		which ensures a list of UIDs.
41
42		However, `toWidgetValue` is called by `widget.update()` implicitly for
43		`self.value`, which is then used by the `get_value` method again.
44		"""
45		return value
46
47		def toFieldValue(self, value):
48		"""Converts a unicode string to a list of UIDs
49		"""
50		# remove any blank lines at the end
51		value = value.rstrip("\r\n")
52		return super(QuerySelectDataConverter, self).toFieldValue(value)
53
54
55		@implementer_only(IQuerySelectWidget)
56		class QuerySelectWidget(widget.HTMLInputWidget, Widget):
57		"""A widget to select one or more items from catalog search
58		"""
59		klass = u"senaite-queryselect-widget-input"
60
61		def update(self):
62		super(QuerySelectWidget, self).update()
63		widget.addFieldClass(self)
64
65		def get_form(self):
66		"""Return the current form of the widget
67		"""
68		form = self.form
69		# form is a fieldset group
70		if IDescriptiveGroup.providedBy(form):
71		form = form.parentForm
72		# form is a subform (e.g. DataGridFieldObjectSubForm)
73		if ISubForm.providedBy(form):
74		form = form.parentForm
75		return form
76
77	View Code Duplication	def get_context(self):
		0 ignored issues – show Duplication introduced 2022-11-07 09:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
78		"""Get the current context
79
80		NOTE: If we are in the ++add++ form, `self.context` is the container!
81		Therefore, we create one here to have access to the methods.
82		"""
83		schema_iface = self.field.interface
84		if schema_iface and schema_iface.providedBy(self.context):
85		return self.context
86
87		# we might be in a subform, so try first to retrieve the object from
88		# the base form itself first
89		form = self.get_form()
90		portal_type = getattr(form, "portal_type", None)
91		context = getattr(form, "context", None)
92		if api.is_object(context):
93		if api.get_portal_type(context) == portal_type:
94		return context
95
96		# Hack alert!
97		# we are in ++add++ form and have no context!
98		# Create a temporary object to be able to access class methods
99		if not portal_type:
100		portal_type = api.get_portal_type(self.context)
101		portal_types = api.get_tool("portal_types")
102		fti = portal_types[portal_type]
103		factory = getUtility(IFactory, fti.factory)
104		context = factory("temporary")
105		# hook into acquisition chain
106		context = context.__of__(self.context)
107		return context
108
109	View Code Duplication	def attr(self, name, default=None):
		0 ignored issues – show Duplication introduced 2022-11-07 09:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
110		"""Get the named attribute of the widget or the field
111		"""
112		value = getattr(self, name, _marker)
113		if value is _marker:
114		return default
115		if isinstance(value, six.string_types):
116		context = self.get_context()
117		if base_hasattr(context, value):
118		attr = getattr(context, value)
119		if callable(attr):
120		attr = attr()
121		if attr:
122		value = attr
123		return value
124
125	View Code Duplication	def get_value(self):
		0 ignored issues – show Duplication introduced 2022-11-07 09:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
126		"""Extract the value from the request or get it from the field
127		"""
128		# get the processed value from the `update` method
129		value = self.value
130		# the value might come from the request, e.g. on object creation
131		if isinstance(value, six.string_types):
132		value = IDataConverter(self).toFieldValue(value)
133		# we handle always lists in the templates
134		if value is None:
135		return []
136		if not isinstance(value, (list, tuple)):
137		value = [value]
138		return value
139
140		def get_catalog(self):
141		return self.attr("catalog", "portal_catalog")
142
143		def get_query(self):
144		return self.attr("query", {})
145
146		def get_search_index(self):
147		return self.attr("search_index", "")
148
149		def get_value_key(self):
150		return self.attr("value_key", "uid")
151
152		def get_limit(self):
153		return self.attr("limit", 25)
154
155		def get_search_wildcard(self):
156		return self.attr("search_wildcard", True)
157
158		def get_allow_user_value(self):
159		"""Allow the user to enter a custom value
160		"""
161		return self.attr("allow_user_value", False)
162
163		def get_columns(self):
164		return self.attr("columns", [])
165
166		def is_multi_valued(self):
167		return self.attr("multi_valued", False)
168
169		def get_hide_input_after_select(self):
170		return self.attr("hide_input_after_select", False)
171
172		def get_input_widget_attributes(self):
173		"""Return input widget attributes for the ReactJS component
174		"""
175		values = self.get_value()
176		attributes = {
177		"data-id": self.id,
178		"data-name": self.name,
179		"data-values": values,
180		"data-value_key": self.get_value_key(),
181		"data-api_url": self.get_api_url(),
182		"data-query": self.get_query(),
183		"data-catalog": self.get_catalog(),
184		"data-search_index": self.get_search_index(),
185		"data-search_wildcard": self.get_search_wildcard(),
186		"data-allow_user_value": self.get_allow_user_value(),
187		"data-columns": self.get_columns(),
188		"data-display_template": None,
189		"data-limit": self.get_limit(),
190		"data-multi_valued": self.is_multi_valued(),
191		"data-disabled": self.disabled or False,
192		"data-readonly": self.readonly or False,
193		"data-hide_input_after_select": self.get_hide_input_after_select(),
194		}
195
196		# convert all attributes to JSON
197		for key, value in attributes.items():
198		attributes[key] = json.dumps(value)
199
200		return attributes
201
202		def get_api_url(self):
203		"""JSON API URL to use for this widget
204		"""
205		portal = api.get_portal()
206		portal_url = api.get_url(portal)
207		api_url = "{}/@@API/senaite/v1".format(portal_url)
208		return api_url
209
210
211		@adapter(IField, ISenaiteFormLayer)
212		@implementer(IFieldWidget)
213		def QuerySelectWidgetFactory(field, request):
214		"""Widget factory
215		"""
216		return FieldWidget(field, QuerySelectWidget(request))
217

senaite / senaite.core

Push — 2.x ( dfb5c5...7c9886 )

QuerySelectWidget.attr() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like