Feature/SCKAN-364 - Add statement preview row to the export + persist statement preview suffix and prefix

backend/composer/api/serializers.py

@@ -27,8 +27,8 @@
 )
 from ..services.connections_service import get_complete_from_entities_for_destination, \
     get_complete_from_entities_for_via
+from ..services.statement_service import create_statement_preview
 from ..services.errors_service import get_connectivity_errors
-from ..utils import join_entities
 
 
 # MixIns
@@ -644,53 +644,7 @@ def get_entities_journey(self, instance):
     def get_statement_preview(self, instance):
         if 'journey' not in self.context:
             self.context['journey'] = instance.get_journey()
-        return self.create_statement_preview(instance, self.context['journey'])
-
-    def create_statement_preview(self, instance, journey):
-        sex = instance.sex.sex_str if instance.sex else None
-
-        species_list = [specie.name for specie in instance.species.all()]
-        species = join_entities(species_list)
-        if not species:
-            species = ""
-
-        phenotype = instance.phenotype.phenotype_str if instance.phenotype else ''
-        origin_names = [origin.name for origin in instance.origins.all()]
-        origins = join_entities(origin_names)
-        if not origins:
-            origins = ""
-
-        circuit_type = instance.get_circuit_type_display() if instance.circuit_type else None
-        projection = instance.get_projection_display() if instance.projection else None
-        projection_phenotype = str(instance.projection_phenotype) if instance.projection_phenotype else ''
-
-        laterality_description = instance.get_laterality_description()
-
-        apinatomy = instance.apinatomy_model if instance.apinatomy_model else ""
-        journey_sentence = ';  '.join(journey)
-
-        # Creating the statement
-        if sex or species != "":
-            statement = f"In {sex or ''} {species}, the {phenotype.lower()} connection goes {journey_sentence}.\n"
-        else:
-            statement = f"A {phenotype.lower()} connection goes {journey_sentence}.\n"
-
-        statement += f"This "
-        if projection:
-            statement += f"{projection.lower()} "
-        if projection_phenotype:
-            statement += f"{projection_phenotype.lower()} "
-        if circuit_type:
-            statement += f"{circuit_type.lower()} "
-
-        statement += f"connection projects from the {origins}."
-        if laterality_description:
-            statement = statement[:-1] + f" and is found {laterality_description}.\n"
-
-        if apinatomy:
-            statement += f" It is described in {apinatomy} model."
-
-        return statement.strip().replace("  ", " ")
+        return create_statement_preview(instance, self.context['journey'])
 
     def get_errors(self, instance) -> List:
         return get_connectivity_errors(instance)

backend/composer/migrations/0068_connectivitystatement_statement_prefix_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 4.1.4 on 2024-12-18 15:59
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("composer", "0067_auto_20241218_0928"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="connectivitystatement",
+            name="statement_prefix",
+            field=models.TextField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="connectivitystatement",
+            name="statement_suffix",
+            field=models.TextField(blank=True, null=True),
+        ),
+    ]

backend/composer/migrations/0069_auto_20241218_1659.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.1.4 on 2024-12-18 15:59
+
+from composer.services.statement_service import get_prefix_for_statement_preview, get_suffix_for_statement_preview
+from django.db import migrations
+
+
+def update_suffix_prefix_for_connectivity_statement_fields(apps, schema_editor):
+    ConnectivityStatement = apps.get_model('composer', 'ConnectivityStatement')
+    for cs in ConnectivityStatement.objects.all():
+        cs.statement_prefix = get_prefix_for_statement_preview(cs)
+        cs.statement_suffix = get_suffix_for_statement_preview(cs)
+        cs.save(update_fields=["statement_prefix", "statement_suffix"])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("composer", "0068_connectivitystatement_statement_prefix_and_more"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            update_suffix_prefix_for_connectivity_statement_fields)
+    ]

backend/composer/models.py

@@ -191,10 +191,6 @@ class Sex(models.Model):
     def __str__(self):
         return self.name
 
-    @property
-    def sex_str(self):
-        return str(self.name) if self.name else ''
-
     class Meta:
         ordering = ["name"]
         verbose_name_plural = "Sex"
@@ -568,6 +564,8 @@ class ConnectivityStatement(models.Model):
     created_date = models.DateTimeField(auto_now_add=True, db_index=True)
     modified_date = models.DateTimeField(auto_now=True, db_index=True)
     journey_path = models.JSONField(null=True, blank=True)
+    statement_prefix = models.TextField(null=True, blank=True)
+    statement_suffix = models.TextField(null=True, blank=True)
 
     def __str__(self):
         suffix = ""
@@ -1030,7 +1028,7 @@ class AlertType(models.Model):
 
     def __str__(self):
         return self.name
-    
+
 
 class StatementAlert(models.Model):
     connectivity_statement = models.ForeignKey(

backend/composer/services/export_services.py

@@ -39,6 +39,7 @@
     get_complete_from_entities_for_destination,
     get_complete_from_entities_for_via,
 )
+from ..services.statement_service import create_statement_preview
 from composer.services.filesystem_service import create_dir_if_not_exists
 from composer.services.state_services import ConnectivityStatementStateService
 
@@ -106,8 +107,12 @@ def get_statement_uri(cs: ConnectivityStatement, row: Row):
     return cs.reference_uri
 
 
-def get_alert_text(cs: ConnectivityStatement, row: Row):
-    return row.object_text__from_alert_notes
+def get_object_text(cs: ConnectivityStatement, row: Row):
+    # object text can be either from - alert notes or statement preview
+    if row.object_text__from_alert_notes:
+        return row.object_text__from_alert_notes
+    else:
+        return create_statement_preview(cs, cs.get_journey())
 
 def get_nlp_id(cs: ConnectivityStatement, row: Row):
     return cs.export_id
@@ -206,7 +211,7 @@ def generate_csv_attributes_mapping() -> Dict[str, Callable]:
         "Predicate Relationship": get_relationship,
         "Object": get_structure,
         "Object URI": get_identifier,
-        "Object Text": get_alert_text,
+        "Object Text": get_object_text,
         "Axonal course poset": get_layer,
         "Connected from": get_connected_from_names,
         "Connected from uri": get_connected_from_uri,

backend/composer/services/statement_service.py

@@ -0,0 +1,73 @@
+from ..utils import join_entities
+from django.apps import apps
+
+
+def get_prefix_for_statement_preview(cs) -> str:
+    connectivity_statement_obj = apps.get_model(
+        'composer', 'ConnectivityStatement')
+    connectivity_statement = connectivity_statement_obj.objects.get(
+        id=cs.id)
+
+    sex = connectivity_statement.sex.name if connectivity_statement.sex else None
+
+    species_list = [
+        specie.name for specie in connectivity_statement.species.all()]
+    species = join_entities(species_list)
+    if not species:
+        species = ""
+
+    phenotype = connectivity_statement.phenotype.name if connectivity_statement.phenotype else ''
+    if sex or species != "":
+        statement = f"In {sex or ''} {species}, the {phenotype.lower()} connection goes"
+    else:
+        statement = f"A {phenotype.lower()} connection goes"
+    return statement
+
+
+def get_suffix_for_statement_preview(cs):
+    connectivity_statement_obj = apps.get_model(
+        'composer', 'ConnectivityStatement')
+    connectivity_statement = connectivity_statement_obj.objects.get(
+        id=cs.id)
+
+    circuit_type = connectivity_statement.get_circuit_type_display(
+    ) if connectivity_statement.circuit_type else None
+    projection = connectivity_statement.get_projection_display(
+    ) if connectivity_statement.projection else None
+    projection_phenotype = str(
+        connectivity_statement.projection_phenotype) if connectivity_statement.projection_phenotype else ''
+
+    laterality_description = connectivity_statement.get_laterality_description()
+    apinatomy = connectivity_statement.apinatomy_model if connectivity_statement.apinatomy_model else ""
+
+    origin_names = [
+        origin.name for origin in connectivity_statement.origins.all()]
+    origins = join_entities(origin_names)
+
+    if not origins:
+        origins = ""
+
+    statement = f"This "
+    if projection:
+        statement += f"{projection.lower()} "
+    if projection_phenotype:
+        statement += f"{projection_phenotype.lower()} "
+    if circuit_type:
+        statement += f"{circuit_type.lower()} "
+
+    statement += f"connection projects from the {origins}."
+    if laterality_description:
+        statement = statement[:-1] + \
+            f" and is found {laterality_description}.\n"
+
+    if apinatomy:
+        statement += f" It is described in {apinatomy} model."
+    return statement
+
+
+def create_statement_preview(cs, journey):
+    prefix = cs.statement_prefix
+    journey_sentence = ';  '.join(journey)
+    suffix = cs.statement_suffix
+    statement = f'{prefix} {journey_sentence}.\n{suffix}'
+    return statement.strip().replace("  ", " ")

backend/composer/signals.py

@@ -4,6 +4,7 @@
 from django_fsm.signals import post_transition
 
 from composer.services.layers_service import update_from_entities_on_deletion
+from composer.services.statement_service import get_suffix_for_statement_preview, get_prefix_for_statement_preview
 from .utils import update_modified_date
 from .enums import CSState, NoteType
 from .models import (
@@ -17,12 +18,12 @@
     Layer,
     Region,
     Via,
+    Specie,
 )
 from .services.export_services import compute_metrics, ConnectivityStatementStateService
 from .services.graph_service import recompile_journey_path
 
 
-
 @receiver(post_save, sender=ExportBatch)
 def export_batch_post_save(sender, instance=None, created=False, **kwargs):
     if created and instance:
@@ -105,7 +106,6 @@ def connectivity_statement_origins_changed(sender, instance, action, pk_set, **k
             pass
         recompile_journey_path(instance)
 
-
     # Call `update_from_entities_on_deletion` for each removed entity
     if action == "post_remove" and pk_set:
         for deleted_entity_id in pk_set:
@@ -143,7 +143,6 @@ def via_from_entities_changed(sender, instance, action, **kwargs):
         recompile_journey_path(instance.connectivity_statement)
 
 
-
 # Signals for Destination anatomical_entities
 @receiver(m2m_changed, sender=Destination.anatomical_entities.through)
 def destination_anatomical_entities_changed(sender, instance, action, **kwargs):
@@ -157,7 +156,6 @@ def destination_anatomical_entities_changed(sender, instance, action, **kwargs):
         recompile_journey_path(instance.connectivity_statement)
 
 
-
 # Signals for Destination from_entities
 @receiver(m2m_changed, sender=Destination.from_entities.through)
 def destination_from_entities_changed(sender, instance, action, **kwargs):
@@ -171,7 +169,6 @@ def destination_from_entities_changed(sender, instance, action, **kwargs):
         recompile_journey_path(instance.connectivity_statement)
 
 
-
 # Signals for Via model changes
 @receiver(post_save, sender=Via)
 @receiver(post_delete, sender=Via)
@@ -210,3 +207,29 @@ def note_post_save_and_delete(sender, instance, **kwargs):
         update_modified_date(instance.sentence)
     if instance.connectivity_statement:
         update_modified_date(instance.connectivity_statement)
+
+
+@receiver(m2m_changed, sender=ConnectivityStatement.species.through, dispatch_uid="update_prefix_suffix_for_connectivity_statement_preview")
+@receiver(m2m_changed, sender=ConnectivityStatement.origins.through, dispatch_uid="update_prefix_suffix_for_connectivity_statement_preview")
+@receiver([post_save, post_delete], sender=ConnectivityStatement, dispatch_uid="update_prefix_suffix_for_connectivity_statement_preview")
+def update_prefix_suffix_for_connectivity_statement_preview(sender, instance, action=None, **kwargs):
+    if isinstance(instance, ConnectivityStatement):
+        relevant_fields_for_suffix = ['circuit_type', 'projection',
+                                      'projection_phenotype_id', 'laterality', 'apinatomy_model']
+
+        relevant_fields_for_prefix = ['sex', 'phenotype']
+        relevant_fields = relevant_fields_for_suffix + relevant_fields_for_prefix
+        updated_fields = kwargs.get('update_fields', [])
+        updated_fields = updated_fields if updated_fields else []
+
+        has_species_or_origin_changed = action in [
+            "post_add", "post_remove", "post_clear"]
+        has_relevant_field_changed = any(
+            [field in updated_fields for field in relevant_fields])
+        if has_species_or_origin_changed or has_relevant_field_changed:
+            instance.statement_prefix = get_prefix_for_statement_preview(
+                instance)
+            instance.statement_suffix = get_suffix_for_statement_preview(
+                instance)
+            instance.save(
+                update_fields=["statement_prefix", "statement_suffix"])