build.bika.lims.browser.analysisrequest.reject_samples.RejectSamplesView.__call__() - Code Metrics - Inspection of "Samples rejection view (#1309)" - senaite/senaite.core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c72550...021814 )

by Ramon

created 2019-03-29 05:50 UTC

RejectSamplesView.call() D

↳ Parent: build.bika.lims.browser.analysisrequest.reject_samples

Complexity

Conditions

Size

Total Lines	66
Code Lines	41

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	41
dl	0
loc	66
rs	4.8
c	0
b	0
f	0
cc	12
nop	1

How to fix Long Method Complexity

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

If many parameters/temporary variables are present:
- Replace temporary variables with Query
- Introduce parameter object; often combined with preserve whole object
- If the above two are insufficient: Replace method with method object
If you have long conditionals: Decompose Conditional
Otherwise: Extract method

Complexity

Complex classes like build.bika.lims.browser.analysisrequest.reject_samples.RejectSamplesView.__call__() often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

# -*- coding: utf-8 -*-
#
# This file is part of SENAITE.CORE
#
# Copyright 2019 by it's authors.
# Some rights reserved. See LICENSE.rst, CONTRIBUTORS.rst.

from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
from bika.lims import api
from bika.lims import bikaMessageFactory as _
from bika.lims import logger
from bika.lims import workflow as wf
from bika.lims.browser import BrowserView, ulocalized_time
from bika.lims.catalog.analysisrequest_catalog import \
    CATALOG_ANALYSIS_REQUEST_LISTING
from bika.lims.utils.analysisrequest import notify_rejection
from plone.memoize import view


class RejectSamplesView(BrowserView):
    """View that renders the Samples rejection view
    """
    template = ViewPageTemplateFile("templates/reject_samples.pt")

    def __init__(self, context, request):
        super(RejectSamplesView, self).__init__(context, request)
        self.context = context
        self.request = request
        self.back_url = self.context.absolute_url()

    @property
    def is_notification_enabled(self):
        """Returns whether the notification on sample rejection is enabled
        """
        return api.get_setup().getNotifyOnSampleRejection()

    @property
    def is_rejection_workflow_enabled(self):
        """Return whether the rejection workflow is enabled
        """
        return api.get_setup().isRejectionWorkflowEnabled()

    def __call__(self):
        form = self.request.form

        # Form submit toggle
        form_submitted = form.get("submitted", False)

        # Buttons
        form_continue = form.get("button_continue", False)
        form_cancel = form.get("button_cancel", False)

        # Is Rejection Workflow Enabled
        if not self.is_rejection_workflow_enabled:
            return self.redirect(message=_("Rejection workflow is not enabled"),
                                 level="warning")

        # Get the objects from request
        samples = self.get_samples_from_request()

        # No Samples selected
        if not samples:
            return self.redirect(message=_("No items selected"),
                                 level="warning")

        # Handle rejection
        if form_submitted and form_continue:
            logger.info("*** REJECT SAMPLES ***")
            processed = []
            for sample in form.get("samples", []):
                sample_uid = sample.get("uid", "")
                reasons = sample.get("reasons", [])
                other = sample.get("other_reasons", "")
                if not sample_uid:
                    continue

                # Omit if no rejection reason specified
                if not any([reasons, other]):
                    continue

                # This is quite bizarre!
                # AR's Rejection reasons is a RecordsField, but with one
                # record only, that contains both predefined and other reasons.
                obj = api.get_object_by_uid(sample_uid)
                rejection_reasons = {
                    "other": other,
                    "selected": reasons }
                obj.setRejectionReasons([rejection_reasons])
                wf.doActionFor(obj, "reject")
                processed.append(obj)

                # Client needs to be notified?
                if sample.get("notify", "") == "on":
                    notify_rejection(obj)

            if not processed:
                return self.redirect(message=_("No samples were rejected"))

            message = _("Rejected {} samples: {}").format(
                len(processed), ", ".join(map(api.get_id, processed)))
            return self.redirect(message=message)

        # Handle cancel
        if form_submitted and form_cancel:
            logger.info("*** CANCEL REJECTION ***")
            return self.redirect(message=_("Rejection cancelled"))

        return self.template()

    @view.memoize
    def get_samples_from_request(self):
        """Returns a list of objects coming from the "uids" request parameter
        """
        uids = self.request.form.get("uids", "")
        if isinstance(uids, basestring):
            uids = uids.split(",")

        uids = list(set(uids))
        if not uids:
            return []

        # Filter those analysis requests "reject" transition is allowed
        query = dict(portal_type="AnalysisRequest", UID=uids)
        brains = api.search(query, CATALOG_ANALYSIS_REQUEST_LISTING)
        samples = map(api.get_object, brains)
        return filter(lambda ob: wf.isTransitionAllowed(ob, "reject"), samples)

    @view.memoize
    def get_rejection_reasons(self):
        """Returns the list of available rejection reasons
        """
        return api.get_setup().getRejectionReasonsItems()

    def get_samples_data(self):
        """Returns a list of Samples data (dictionary)
        """
        for obj in self.get_samples_from_request():
            yield {
                "obj": obj,
                "id": api.get_id(obj),
                "uid": api.get_uid(obj),
                "title": api.get_title(obj),
                "path": api.get_path(obj),
                "url": api.get_url(obj),
                "sample_type": obj.getSampleTypeTitle(),
                "client_title": obj.getClientTitle(),
                "date": ulocalized_time(obj.created(), long_format=True),
            }

    def redirect(self, redirect_url=None, message=None, level="info"):
        """Redirect with a message
        """
        if redirect_url is None:
            redirect_url = self.back_url
        if message is not None:
            self.add_status_message(message, level)
        return self.request.response.redirect(redirect_url)

    def add_status_message(self, message, level="info"):
        """Set a portal status message
        """
        return self.context.plone_utils.addPortalMessage(message, level)


1			# -- coding: utf-8 --
2			#
3			# This file is part of SENAITE.CORE
4			#
5			# Copyright 2019 by it's authors.
6			# Some rights reserved. See LICENSE.rst, CONTRIBUTORS.rst.
7
8			from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
9			from bika.lims import api
10			from bika.lims import bikaMessageFactory as _
11			from bika.lims import logger
12			from bika.lims import workflow as wf
13			from bika.lims.browser import BrowserView, ulocalized_time
14			from bika.lims.catalog.analysisrequest_catalog import \
15			CATALOG_ANALYSIS_REQUEST_LISTING
16			from bika.lims.utils.analysisrequest import notify_rejection
17			from plone.memoize import view
18
19
20			class RejectSamplesView(BrowserView):
21			"""View that renders the Samples rejection view
22			"""
23			template = ViewPageTemplateFile("templates/reject_samples.pt")
24
25			def __init__(self, context, request):
26			super(RejectSamplesView, self).__init__(context, request)
27			self.context = context
28			self.request = request
29			self.back_url = self.context.absolute_url()
30
31			@property
32			def is_notification_enabled(self):
33			"""Returns whether the notification on sample rejection is enabled
34			"""
35			return api.get_setup().getNotifyOnSampleRejection()
36
37			@property
38			def is_rejection_workflow_enabled(self):
39			"""Return whether the rejection workflow is enabled
40			"""
41			return api.get_setup().isRejectionWorkflowEnabled()
42
43			def __call__(self):
44			form = self.request.form
45
46			# Form submit toggle
47			form_submitted = form.get("submitted", False)
48
49			# Buttons
50			form_continue = form.get("button_continue", False)
51			form_cancel = form.get("button_cancel", False)
52
53			# Is Rejection Workflow Enabled
54			if not self.is_rejection_workflow_enabled:
55			return self.redirect(message=_("Rejection workflow is not enabled"),
56			level="warning")
57
58			# Get the objects from request
59			samples = self.get_samples_from_request()
60
61			# No Samples selected
62			if not samples:
63			return self.redirect(message=_("No items selected"),
64			level="warning")
65
66			# Handle rejection
67			if form_submitted and form_continue:
68			logger.info("* REJECT SAMPLES *")
69			processed = []
70			for sample in form.get("samples", []):
71			sample_uid = sample.get("uid", "")
72			reasons = sample.get("reasons", [])
73			other = sample.get("other_reasons", "")
74			if not sample_uid:
75			continue
76
77			# Omit if no rejection reason specified
78			if not any([reasons, other]):
79			continue
80
81			# This is quite bizarre!
82			# AR's Rejection reasons is a RecordsField, but with one
83			# record only, that contains both predefined and other reasons.
84			obj = api.get_object_by_uid(sample_uid)
85			rejection_reasons = {
86			"other": other,
87			"selected": reasons }
88			obj.setRejectionReasons([rejection_reasons])
89			wf.doActionFor(obj, "reject")
90			processed.append(obj)
91
92			# Client needs to be notified?
93			if sample.get("notify", "") == "on":
94			notify_rejection(obj)
95
96			if not processed:
97			return self.redirect(message=_("No samples were rejected"))
98
99			message = _("Rejected {} samples: {}").format(
100			len(processed), ", ".join(map(api.get_id, processed)))
101			return self.redirect(message=message)
102
103			# Handle cancel
104			if form_submitted and form_cancel:
105			logger.info("* CANCEL REJECTION *")
106			return self.redirect(message=_("Rejection cancelled"))
107
108			return self.template()
109
110			@view.memoize
111			def get_samples_from_request(self):
112			"""Returns a list of objects coming from the "uids" request parameter
113			"""
114			uids = self.request.form.get("uids", "")
115			if isinstance(uids, basestring):
116			uids = uids.split(",")
117
118			uids = list(set(uids))
119			if not uids:
120			return []
121
122			# Filter those analysis requests "reject" transition is allowed
123			query = dict(portal_type="AnalysisRequest", UID=uids)
124			brains = api.search(query, CATALOG_ANALYSIS_REQUEST_LISTING)
125			samples = map(api.get_object, brains)
126			return filter(lambda ob: wf.isTransitionAllowed(ob, "reject"), samples)
127
128			@view.memoize
129			def get_rejection_reasons(self):
130			"""Returns the list of available rejection reasons
131			"""
132			return api.get_setup().getRejectionReasonsItems()
133
134			def get_samples_data(self):
135			"""Returns a list of Samples data (dictionary)
136			"""
137			for obj in self.get_samples_from_request():
138			yield {
139			"obj": obj,
140			"id": api.get_id(obj),
141			"uid": api.get_uid(obj),
142			"title": api.get_title(obj),
143			"path": api.get_path(obj),
144			"url": api.get_url(obj),
145			"sample_type": obj.getSampleTypeTitle(),
146			"client_title": obj.getClientTitle(),
147			"date": ulocalized_time(obj.created(), long_format=True),
148			}
149
150			def redirect(self, redirect_url=None, message=None, level="info"):
151			"""Redirect with a message
152			"""
153			if redirect_url is None:
154			redirect_url = self.back_url
155			if message is not None:
156			self.add_status_message(message, level)
157			return self.request.response.redirect(redirect_url)
158
159			def add_status_message(self, message, level="info"):
160			"""Set a portal status message
161			"""
162			return self.context.plone_utils.addPortalMessage(message, level)
163

senaite / senaite.core

Push — master ( c72550...021814 )

RejectSamplesView.__call__() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Complexity

Duplication Side-by-Side

Filter issues like

RejectSamplesView.call() D