bika.lims.browser.fields.resultrangefield

Complexity

Total Complexity

10

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	ResultRangeField.get()	0	6	2
A	DefaultResultsRangeProvider.get_results_range_by()	0	10	2
A	DefaultResultsRangeProvider.__call__()	0	17	3
A	ResultRangeField.set()	0	8	2
A	DefaultResultsRangeProvider.__init__()	0	2	1

# -*- coding: utf-8 -*-
#
# This file is part of SENAITE.CORE.
#
# SENAITE.CORE is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, version 2.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright 2018-2024 by it's authors.
# Some rights reserved, see README and LICENSE.

from operator import itemgetter

from bika.lims import logger
from bika.lims import bikaMessageFactory as _
from bika.lims.interfaces.analysis import IRequestAnalysis
from Products.Archetypes.interfaces import IFieldDefaultProvider
from Products.Archetypes.Registry import registerField
from senaite.core.browser.fields.record import RecordField
from zope.interface import implements

# A tuple of (subfield_id, subfield_label,)
SUB_FIELDS = (
    ("keyword", _("Analysis Service")),
    ("min_operator", _("Min operator")),
    ("min", _('Min')),
    ("max_operator", _("Max operator")),
    ("max", _('Max')),
    ("warn_min", _('Min warn')),
    ("warn_max", _('Max warn')),
    ("hidemin", _('< Min')),
    ("hidemax", _('> Max')),
    ("rangecomment", _(
        u"label_specs_rangecomment",
        default=u"Out of range comment"
    )),
)


class ResultRangeField(RecordField):
    """A field that stores a results range
    """
    _properties = RecordField._properties.copy()
    _properties.update({
        "type": "results_range_field",
        "subfields": map(itemgetter(0), SUB_FIELDS),
        "subfield_labels": dict(SUB_FIELDS),
    })

    def set(self, instance, value, **kwargs):
        from bika.lims.content.analysisspec import ResultsRangeDict
        if isinstance(value, ResultsRangeDict):
            # Better store a built-in dict so it will always be available even
            # if ResultsRangeDict is removed or changed
            value = dict(value)

        super(ResultRangeField, self).set(instance, value, **kwargs)

    def get(self, instance, **kwargs):
        from bika.lims.content.analysisspec import ResultsRangeDict
        value = super(ResultRangeField, self).get(instance, **kwargs)
        if value:
            return ResultsRangeDict(dict(value.items()))
        return {}


registerField(ResultRangeField, title="ResultRange",
              description="Used for storing a result range",)


class DefaultResultsRangeProvider(object):
    """Default Results Range provider for analyses
    This is used for backwards-compatibility for when the analysis' ResultsRange
    was obtained directly from Sample's ResultsRanges field, before this:
    https://github.com/senaite/senaite.core/pull/1506
    """
    implements(IFieldDefaultProvider)

    def __init__(self, context):
        self.context = context

    def __call__(self):
        """Get the default value.
        """
        if not IRequestAnalysis.providedBy(self.context):
            return {}

        # Get the AnalysisRequest to look at
        analysis = self.context
        sample = analysis.getRequest()

        # Search by keyword
        # or service uid for backwards compatibility
        search_by = analysis.getKeyword() or analysis.getServiceUID()
        if not search_by:
            return {}

        return self.get_results_range_by(sample, search_by)

    def get_results_range_by(self, sample, search_by):
        rr = {}
        try:
            field = sample.getField("ResultRange", {})
            rr = field.get(sample, search_by=search_by)
        except AttributeError as e:
            logger.error("Failed to get results range for sample "
                         "'{}' by '{}': "
                         "{}".format(sample.getId(), search_by, str(e)))
        return rr