diff --git a/setup/survey_question_type_five_star/odoo/addons/survey_question_type_five_star b/setup/survey_question_type_five_star/odoo/addons/survey_question_type_five_star new file mode 120000 index 00000000..3f9557ff --- /dev/null +++ b/setup/survey_question_type_five_star/odoo/addons/survey_question_type_five_star @@ -0,0 +1 @@ +../../../../survey_question_type_five_star \ No newline at end of file diff --git a/setup/survey_question_type_five_star/setup.py b/setup/survey_question_type_five_star/setup.py new file mode 100644 index 00000000..28c57bb6 --- /dev/null +++ b/setup/survey_question_type_five_star/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) diff --git a/survey_question_type_five_star/README.rst b/survey_question_type_five_star/README.rst new file mode 100644 index 00000000..e09c2368 --- /dev/null +++ b/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 `_. +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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* ACSONE SA/NV + +Contributors +~~~~~~~~~~~~ + +* Souheil Bejaoui +* Olga Marco +* Benoit Aimont + +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 `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/survey_question_type_five_star/__init__.py b/survey_question_type_five_star/__init__.py new file mode 100644 index 00000000..0650744f --- /dev/null +++ b/survey_question_type_five_star/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/survey_question_type_five_star/__manifest__.py b/survey_question_type_five_star/__manifest__.py new file mode 100644 index 00000000..cac1a462 --- /dev/null +++ b/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", + ], + }, +} diff --git a/survey_question_type_five_star/i18n/survey_question_type_five_star.pot b/survey_question_type_five_star/i18n/survey_question_type_five_star.pot new file mode 100644 index 00000000..9208c203 --- /dev/null +++ b/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 "" +"\n" +" \n" +" \n" +" \n" +" " +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 "" diff --git a/survey_question_type_five_star/models/__init__.py b/survey_question_type_five_star/models/__init__.py new file mode 100644 index 00000000..948dcfaf --- /dev/null +++ b/survey_question_type_five_star/models/__init__.py @@ -0,0 +1,2 @@ +from . import survey_question +from . import survey_user_input_line diff --git a/survey_question_type_five_star/models/survey_question.py b/survey_question_type_five_star/models/survey_question.py new file mode 100644 index 00000000..f3f484fc --- /dev/null +++ b/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 diff --git a/survey_question_type_five_star/models/survey_user_input_line.py b/survey_question_type_five_star/models/survey_user_input_line.py new file mode 100644 index 00000000..ba1030a6 --- /dev/null +++ b/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")) diff --git a/survey_question_type_five_star/readme/CONTRIBUTORS.rst b/survey_question_type_five_star/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..c3ef825a --- /dev/null +++ b/survey_question_type_five_star/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* Souheil Bejaoui +* Olga Marco +* Benoit Aimont diff --git a/survey_question_type_five_star/readme/DESCRIPTION.rst b/survey_question_type_five_star/readme/DESCRIPTION.rst new file mode 100644 index 00000000..f557db80 --- /dev/null +++ b/survey_question_type_five_star/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +This module adds five stars rating question type for survey page diff --git a/survey_question_type_five_star/readme/USAGE.rst b/survey_question_type_five_star/readme/USAGE.rst new file mode 100644 index 00000000..2bef1a22 --- /dev/null +++ b/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 diff --git a/survey_question_type_five_star/static/description/five_star_type.png b/survey_question_type_five_star/static/description/five_star_type.png new file mode 100644 index 00000000..b5240d95 Binary files /dev/null and b/survey_question_type_five_star/static/description/five_star_type.png differ diff --git a/survey_question_type_five_star/static/description/icon.png b/survey_question_type_five_star/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/survey_question_type_five_star/static/description/icon.png differ diff --git a/survey_question_type_five_star/static/description/index.html b/survey_question_type_five_star/static/description/index.html new file mode 100644 index 00000000..c2f3ef01 --- /dev/null +++ b/survey_question_type_five_star/static/description/index.html @@ -0,0 +1,430 @@ + + + + + + +Survey five stars question type + + + +
+

Survey five stars question type

+ + +

Beta License: AGPL-3 OCA/survey Translate me on Weblate Try me on Runboat

+

This module adds five stars rating question type for survey page

+

Table of contents

+ +
+

Usage

+

To use this module, you need to:

+
    +
  1. Go to Surveys, create a new survey, add a question of type “Five Stars Rating”
    2. +
+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. +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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • ACSONE SA/NV
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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 project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/survey_question_type_five_star/static/src/js/survey.js b/survey_question_type_five_star/static/src/js/survey.js new file mode 100644 index 00000000..145368a1 --- /dev/null +++ b/survey_question_type_five_star/static/src/js/survey.js @@ -0,0 +1,40 @@ +/* Copyright 2018 ACSONE SA/NV +License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).*/ +odoo.define("survey_question_type_five_star.survey", function (require) { + "use strict"; + var SurveyFormWidget = require("survey.form"); + SurveyFormWidget.include({ + events: _.extend({}, SurveyFormWidget.prototype.events, { + "click .rate > label": "_onClickFiveStarLabel", + }), + _onClickFiveStarLabel: function (event) { + if (this.readonly) { + return; + } + var target = event.target; + var label_items = $(target).parent().find("label"); + + var value = label_items.length - $(target).index(); + label_items.removeClass("checked fa-star").addClass("fa-star-o"); + label_items + .slice($(target).index()) + .addClass("checked fa-star") + .removeClass("fa-star-o"); + var $input = $(target).parent().find("input"); + $input.val(value); + // We will trigger the change in order to make it compatible with conditional. + // If it is not installed, it has no effects + $input.trigger("change"); + }, + _prepareSubmitValues: function (formData, params) { + this._super.apply(this, arguments); + this.$("[data-question-type]").each(function () { + switch ($(this).data("questionType")) { + case "star_rate": + params[this.name] = this.value; + break; + } + }); + }, + }); +}); diff --git a/survey_question_type_five_star/static/src/scss/parameters.scss b/survey_question_type_five_star/static/src/scss/parameters.scss new file mode 100644 index 00000000..f1d6402e --- /dev/null +++ b/survey_question_type_five_star/static/src/scss/parameters.scss @@ -0,0 +1,2 @@ +/* survey.scss parameters */ +$star-widget-color: #deb217; diff --git a/survey_question_type_five_star/static/src/scss/survey.scss b/survey_question_type_five_star/static/src/scss/survey.scss new file mode 100644 index 00000000..f878f258 --- /dev/null +++ b/survey_question_type_five_star/static/src/scss/survey.scss @@ -0,0 +1,24 @@ +/* Copyright 2018 ACSONE SA/NV +License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). */ + +.rate_widget { + float: left; + height: 46px; + padding: 0 10px; +} +.rate_widget > input { + display: none; +} +.rate > label:hover, +.rate > label:hover ~ label, +.rate .checked { + color: $star-widget-color; +} +.rate_widget > label { + float: right; + width: 1em; + white-space: nowrap; + cursor: pointer; + font-size: 30px; + color: $star-widget-color; +} diff --git a/survey_question_type_five_star/templates/survey_template.xml b/survey_question_type_five_star/templates/survey_template.xml new file mode 100644 index 00000000..e21e9abd --- /dev/null +++ b/survey_question_type_five_star/templates/survey_template.xml @@ -0,0 +1,77 @@ + + + + + + + + diff --git a/survey_question_type_five_star/tests/__init__.py b/survey_question_type_five_star/tests/__init__.py new file mode 100644 index 00000000..df7702e6 --- /dev/null +++ b/survey_question_type_five_star/tests/__init__.py @@ -0,0 +1 @@ +from . import test_survey diff --git a/survey_question_type_five_star/tests/test_survey.py b/survey_question_type_five_star/tests/test_survey.py new file mode 100644 index 00000000..8863999b --- /dev/null +++ b/survey_question_type_five_star/tests/test_survey.py @@ -0,0 +1,108 @@ +# Copyright 2018 ACSONE SA/NV +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo.exceptions import ValidationError + +from odoo.addons.survey.tests import common + + +class TestSurvey(common.SurveyCase): + def setUp(self): + super().setUp() + User = self.env["res.users"].with_context(no_reset_password=True) + (group_survey_user, group_employee) = ( + self.ref("survey.group_survey_user"), + self.ref("base.group_user"), + ) + self.survey_manager = User.create( + { + "name": "Nerea Riera", + "login": "Riera", + "email": "nerea.riera@example.com", + "groups_id": [ + ( + 6, + 0, + [ + self.ref("survey.group_survey_manager"), + group_survey_user, + group_employee, + ], + ) + ], + } + ) + self.survey1 = ( + self.env["survey.survey"] + .with_user(self.survey_manager) + .create({"title": "S0", "page_ids": [(0, 0, {"title": "P0"})]}) + ) + self.page1 = ( + self.env["survey.question"] + .with_user(self.survey_manager) + .create( + { + "title": "First page", + "survey_id": self.survey1.id, + "sequence": 1, + "is_page": True, + } + ) + ) + self.user_input1 = ( + self.env["survey.user_input"] + .with_user(self.survey_manager) + .create( + { + "survey_id": self.survey1.id, + "partner_id": self.survey_manager.partner_id.id, + } + ) + ) + self.question1 = ( + self.env["survey.question"] + .with_user(self.survey_manager) + .create( + { + "title": "Test Star Rate", + "page_id": self.page1.id, + "question_type": "star_rate", + "validation_required": True, + } + ) + ) + self.answer_tag1 = "{}_{}_{}".format( + self.survey1.id, + self.page1.id, + self.question1.id, + ) + self._type_match["star_rate"] = ("numerical_box", "value_numerical_box") + + def test_01_question_star_rate_with_error_values(self): + error_results = [ + ("aaa", "This is not a number"), + ("-1", "Answer is not in the right range"), + ("6", "Answer is not in the right range"), + ] + for i in range(len(error_results)): + self.assertEqual( + self.question1.validate_star_rate( + {self.answer_tag1: error_results[i][0]}, self.answer_tag1 + ), + {self.answer_tag1: error_results[i][1]}, + ) + + def test_02_question_star_rate_with_valid_values(self): + for i in ("0", "3", "5"): + self.user_input1.save_lines(question=self.question1, answer=i) + self.assertEqual( + self.user_input1.user_input_line_ids.filtered( + lambda r: r.question_id == self.question1 + ).value_numerical_box, + float(i), + ) + + def test_03_question_star_rate_with_constr_mandatory(self): + self.question1.constr_mandatory = True + with self.assertRaises(ValidationError): + self.user_input1.save_lines(question=self.question1, answer="0") diff --git a/survey_question_type_five_star/views/survey_question.xml b/survey_question_type_five_star/views/survey_question.xml new file mode 100644 index 00000000..f10874a2 --- /dev/null +++ b/survey_question_type_five_star/views/survey_question.xml @@ -0,0 +1,22 @@ + + + + + survey.question.form + survey.question + + + + +
+ + + + + +
+ + + +