[IMP] survey_sign_oca: review changes

Author: kobros-tech

survey_sign_oca/README.rst

@@ -113,6 +113,9 @@ fields as checked/unchecked.
 Answers of type binary can be trated as signature fields if the survey
 question is the same as the signature placeholder in sign request.
 
+In that case make sure to have this module:
+``survey_question_type_binary`` from OCA installed.
+
 Signers can still update the input values if they want.
 
 Bug Tracker

survey_sign_oca/__manifest__.py

@@ -7,7 +7,7 @@
     "website": "https://github.com/OCA/sign",
     "author": "Kencove, Odoo Community Association (OCA)",
     "license": "AGPL-3",
-    "depends": ["sign_oca", "survey", "survey_question_type_binary"],
+    "depends": ["sign_oca", "survey"],
     "data": [
         "views/survey_user_views.xml",
         "views/res_config_settings_view.xml",

survey_sign_oca/models/sign_oca_request.py

@@ -3,6 +3,8 @@
 from odoo import api, fields, models
 
 
+# This class is to format questions of type (yes, no)
+# in case we need the answer as (True, False) in case of filling checkboxes
 class SurveyUtils:
     @staticmethod
     def is_yes_no_answer(value):
@@ -22,7 +24,7 @@ def format_answer(answer):
 class SignOcaRequest(models.Model):
     _inherit = "sign.oca.request"
 
-    # This field is required for the inverse of maintenance.equipment.
+    # This field is required for the inverse of survey.user.input.
     survey_user_input_id = fields.Many2one(
         comodel_name="survey.user_input",
         compute="_compute_survey_user_input_id",
@@ -51,6 +53,8 @@ def get_related_survey_answers(self):
         survey = {}
         if survey_participation and model_id and model_id.model == "survey.user_input":
             for line in survey_participation.user_input_line_ids:
+                # Questions of type matrix have questions and suggested answers like a matrix
+                # We map the answeres to the questions for each matrix type
                 if line.question_id.question_type == "matrix":
                     answer = line.suggested_answer_id.value
                     survey.update({line.matrix_row_id.value: answer})
@@ -68,6 +72,9 @@ def fill_survey_related_items(self, vals):
         for key in items:
             item = items[key]
             placeholder = item.get("placeholder")
+            # According to placeholder we target the answer of a question
+            # having same text as the placeholder
+            # and we choose the answer format based on the item field_typ
             if survey.get(placeholder) and item["role_id"] == self.role_id.id:
                 if survey.get(placeholder) and item["field_type"] == "text":
                     item["value"] = survey.get(placeholder)

survey_sign_oca/models/survey_invite.py

@@ -42,8 +42,8 @@ def action_view_sign_requests(self):
         ctx = dict(self.env.context)
         ctx.update(
             {
-                "default_maintenance_equipment_id": self.id,
-                "search_default_maintenance_equipment_id": self.id,
+                "default_survey_user_input_id": self.id,
+                "search_default_survey_user_input_id": self.id,
             }
         )
         result["context"] = ctx

survey_sign_oca/readme/USAGE.md

@@ -23,4 +23,7 @@ checked/unchecked.
 Answers of type binary can be trated as signature fields if the survey question is the
 same as the signature placeholder in sign request.
 
+In that case make sure to have this module: `survey_question_type_binary` from OCA
+installed.
+
 Signers can still update the input values if they want.

survey_sign_oca/static/description/index.html

@@ -456,6 +456,8 @@ <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
 fields as checked/unchecked.</p>
 <p>Answers of type binary can be trated as signature fields if the survey
 question is the same as the signature placeholder in sign request.</p>
+<p>In that case make sure to have this module:
+<tt class="docutils literal">survey_question_type_binary</tt> from OCA installed.</p>
 <p>Signers can still update the input values if they want.</p>
 </div>
 <div class="section" id="bug-tracker">

survey_sign_oca/views/survey_survey_views.xml

@@ -5,8 +5,7 @@
         <field name="model">survey.survey</field>
         <field name="inherit_id" ref="survey.survey_survey_view_form" />
         <field name="arch" type="xml">
-            <field name="description" position="before">
-                <label for="start_button_name" string="Survey Start Button" />
+            <field name="users_can_go_back" position="after">
                 <field name="start_button_name" />
             </field>
         </field>