[16.0] [MIG] survey_question_type_five_star

setup/survey_question_type_five_star/odoo/addons/survey_question_type_five_star

@@ -0,0 +1 @@
+../../../../survey_question_type_five_star

setup/survey_question_type_five_star/setup.py

@@ -0,0 +1,6 @@
+import setuptools
+
+setuptools.setup(
+    setup_requires=['setuptools-odoo'],
+    odoo_addon=True,
+)

survey_question_type_five_star/README.rst

@@ -0,0 +1,84 @@
+===============================
+Survey five stars question type
+===============================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsurvey-lightgray.png?logo=github
+    :target: https://github.com/OCA/survey/tree/16.0/survey_question_type_five_star
+    :alt: OCA/survey
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/survey-16-0/survey-16-0-survey_question_type_five_star
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/webui/builds.html?repo=OCA/survey&target_branch=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+This module adds five stars rating question type for survey page
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+To use this module, you need to:
+
+#. Go to Surveys, create a new survey, add a question of type "Five Stars Rating"
+
+.. image:: https://raw.githubusercontent.com/OCA/survey/survey_question_type_five_star/static/description/five_star_type.png
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/survey/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/survey/issues/new?body=module:%20survey_question_type_five_star%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* ACSONE SA/NV
+
+Contributors
+~~~~~~~~~~~~
+
+* Souheil Bejaoui <[email protected]>
+* Olga Marco <[email protected]>
+* Benoit Aimont <[email protected]>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/survey <https://github.com/OCA/survey/tree/16.0/survey_question_type_five_star>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

survey_question_type_five_star/__init__.py

@@ -0,0 +1 @@
+from . import models

survey_question_type_five_star/__manifest__.py

@@ -0,0 +1,21 @@
+# Copyright 2018 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Survey five stars question type",
+    "summary": """
+        This module adds five stars rating as question type for survey page""",
+    "version": "16.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "ACSONE SA/NV,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/survey",
+    "depends": ["survey"],
+    "data": ["views/survey_question.xml", "templates/survey_template.xml"],
+    "assets": {
+        "survey.survey_assets": [
+            "survey_question_type_five_star/static/src/js/survey.js",
+            "survey_question_type_five_star/static/src/scss/parameters.scss",
+            "survey_question_type_five_star/static/src/scss/survey.scss",
+        ],
+    },
+}

survey_question_type_five_star/i18n/survey_question_type_five_star.pot

@@ -0,0 +1,83 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* survey_question_type_five_star
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 16.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: survey_question_type_five_star
+#: model_terms:ir.ui.view,arch_db:survey_question_type_five_star.survey_question_form
+msgid ""
+"<i class=\"fa fa-star fa-2x\" title=\"star1\"/>\n"
+"                    <i class=\"fa fa-star fa-2x\" title=\"star2\"/>\n"
+"                    <i class=\"fa fa-star fa-2x\" title=\"star3\"/>\n"
+"                    <i class=\"fa fa-star-o fa-2x\" title=\"star4\"/>\n"
+"                    <i class=\"fa fa-star-o fa-2x\" title=\"star5\"/>"
+msgstr ""
+
+#. module: survey_question_type_five_star
+#: code:addons/survey_question_type_five_star/models/survey_user_input_line.py:0
+#: code:addons/survey_question_type_five_star/models/survey_user_input_line.py:0
+#, python-format
+msgid "Answer is not in the right range"
+msgstr ""
+
+#. module: survey_question_type_five_star
+#: model:ir.model.fields,field_description:survey_question_type_five_star.field_survey_question__display_name
+#: model:ir.model.fields,field_description:survey_question_type_five_star.field_survey_user_input__display_name
+#: model:ir.model.fields,field_description:survey_question_type_five_star.field_survey_user_input_line__display_name
+msgid "Display Name"
+msgstr ""
+
+#. module: survey_question_type_five_star
+#: model:ir.model.fields.selection,name:survey_question_type_five_star.selection__survey_question__question_type__star_rate
+msgid "Five Stars Rating"
+msgstr ""
+
+#. module: survey_question_type_five_star
+#: code:addons/survey_question_type_five_star/models/survey_user_input_line.py:0
+#, python-format
+msgid "Five stars rate question must have numeric answer"
+msgstr ""
+
+#. module: survey_question_type_five_star
+#: model:ir.model.fields,field_description:survey_question_type_five_star.field_survey_question__id
+#: model:ir.model.fields,field_description:survey_question_type_five_star.field_survey_user_input__id
+#: model:ir.model.fields,field_description:survey_question_type_five_star.field_survey_user_input_line__id
+msgid "ID"
+msgstr ""
+
+#. module: survey_question_type_five_star
+#: model:ir.model.fields,field_description:survey_question_type_five_star.field_survey_question____last_update
+#: model:ir.model.fields,field_description:survey_question_type_five_star.field_survey_user_input____last_update
+#: model:ir.model.fields,field_description:survey_question_type_five_star.field_survey_user_input_line____last_update
+msgid "Last Modified on"
+msgstr ""
+
+#. module: survey_question_type_five_star
+#: model:ir.model.fields,field_description:survey_question_type_five_star.field_survey_question__question_type
+msgid "Question Type"
+msgstr ""
+
+#. module: survey_question_type_five_star
+#: model:ir.model,name:survey_question_type_five_star.model_survey_question
+msgid "Survey Question"
+msgstr ""
+
+#. module: survey_question_type_five_star
+#: model:ir.model,name:survey_question_type_five_star.model_survey_user_input
+msgid "Survey User Input"
+msgstr ""
+
+#. module: survey_question_type_five_star
+#: model:ir.model,name:survey_question_type_five_star.model_survey_user_input_line
+msgid "Survey User Input Line"
+msgstr ""

survey_question_type_five_star/models/__init__.py

@@ -0,0 +1,2 @@
+from . import survey_question
+from . import survey_user_input_line

survey_question_type_five_star/models/survey_question.py

@@ -0,0 +1,58 @@
+# Copyright 2018 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+import collections
+
+from odoo import fields, models, tools
+
+
+class SurveyQuestion(models.Model):
+
+    _inherit = "survey.question"
+
+    question_type = fields.Selection(
+        selection_add=[("star_rate", "Five Stars Rating")], ondelete={"foo": "set null"}
+    )
+
+    def _get_stats_summary_data(self, user_input_lines):
+        stats = super()._get_stats_summary_data(user_input_lines)
+        if self.question_type in ["star_rate"]:
+            stats.update(self._get_stats_summary_data_numerical(user_input_lines))
+            stats.update(
+                {
+                    "common_lines": collections.Counter(
+                        user_input_lines.filtered(lambda line: not line.skipped).mapped(
+                            "value_numerical_box"
+                        )
+                    ).most_common(5),
+                    "right_inputs_count": len(
+                        user_input_lines.filtered(
+                            lambda line: line.answer_is_correct
+                        ).mapped("user_input_id")
+                    ),
+                }
+            )
+        return stats
+
+    def validate_star_rate(self, post, answer_tag):
+        self.ensure_one()
+        errors = {}
+        answer = post[answer_tag].strip()
+        # Empty answer to mandatory question
+        if self.constr_mandatory and not answer:
+            errors.update({answer_tag: self.constr_error_msg})
+        # Checks if user input is a number
+        if answer:
+            try:
+                floatanswer = float(answer)
+            except ValueError:
+                errors.update({answer_tag: "This is not a number"})
+                return errors
+            # Answer is not in the right range
+            with tools.ignore(Exception):
+                # 0 answer to mandatory question
+                if self.constr_mandatory:
+                    if floatanswer == 0:
+                        errors.update({answer_tag: self.constr_error_msg})
+                if not (0 <= floatanswer <= 5):
+                    errors.update({answer_tag: "Answer is not in the right range"})
+        return errors

survey_question_type_five_star/models/survey_user_input_line.py

@@ -0,0 +1,51 @@
+# Copyright 2018 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import _, api, models
+from odoo.exceptions import ValidationError
+
+
+class SurveyUserInput(models.Model):
+    _inherit = "survey.user_input"
+
+    def save_lines(self, question, answer, comment=None):
+        old_answers = self.env["survey.user_input.line"].search(
+            [("user_input_id", "=", self.id), ("question_id", "=", question.id)]
+        )
+
+        if question.question_type in ["star_rate"]:
+            self._save_line_simple_answer(question, old_answers, answer)
+        else:
+            return super().save_lines(question, answer, comment=comment)
+
+    def _get_line_answer_values(self, question, answer, answer_type):
+        vals = super()._get_line_answer_values(question, answer, answer_type)
+        if answer_type == "star_rate" and answer:
+            vals.update(
+                {"value_numerical_box": float(answer), "answer_type": "numerical_box"}
+            )
+            vals.pop("value_star_rate")
+        return vals
+
+
+class SurveyUserInputLine(models.Model):
+    _inherit = "survey.user_input.line"
+
+    @api.constrains("question_id", "answer_type", "value_numerical_box")
+    def _check_star_rate_answer(self):
+        for rec in self:
+            if rec.question_id.question_type == "star_rate":
+                if not rec.answer_type:
+                    continue
+                if rec.answer_type != "numerical_box":
+                    raise ValidationError(
+                        _("Five stars rate question must have numeric answer")
+                    )
+                if rec.question_id.constr_mandatory and not (
+                    0 < rec.value_numerical_box <= 5
+                ):
+                    raise ValidationError(_("Answer is not in the right range"))
+                if not rec.question_id.constr_mandatory and not (
+                    0 <= rec.value_numerical_box <= 5
+                ):
+                    raise ValidationError(_("Answer is not in the right range"))

survey_question_type_five_star/readme/CONTRIBUTORS.rst

@@ -0,0 +1,3 @@
+* Souheil Bejaoui <[email protected]>
+* Olga Marco <[email protected]>
+* Benoit Aimont <[email protected]>

survey_question_type_five_star/readme/DESCRIPTION.rst

@@ -0,0 +1 @@
+This module adds five stars rating question type for survey page

survey_question_type_five_star/readme/USAGE.rst

@@ -0,0 +1,5 @@
+To use this module, you need to:
+
+#. Go to Surveys, create a new survey, add a question of type "Five Stars Rating"
+
+.. image:: /OCA/survey/survey_question_type_five_star/static/description/five_star_type.png