fix (improve): replace description to notes and work without app context

Author: sagargg

ckanext/versions/logic/action.py

@@ -27,7 +27,7 @@ def package_version_create(context, data_dict):
     )
 
     # Check if the version already exists
-    existing_version = DatasetVersion.get(name=data_dict["name"])
+    existing_version = DatasetVersion.get(name=data_dict["name"], package_id=data_dict["package_id"])
     if existing_version:
         raise tk.ValidationError(
             f"Version with name '{data_dict['name']}' already exists."
@@ -36,7 +36,7 @@ def package_version_create(context, data_dict):
     version = DatasetVersion.create(
         package_id=data_dict["package_id"],
         name=data_dict["name"],
-        description=data_dict.get("description"),
+        notes=data_dict.get("notes"),
         data=package_dict,
         creator_user_id=package_dict.get("creator_user_id"),
     )
@@ -82,7 +82,7 @@ def package_version_show(context, data_dict):
         print(e)
     data_dict = dataset_version.as_dict().get("data", {})
     data_dict["version_id"] = dataset_version.id
-    data_dict["version_description"] = dataset_version.description
+    data_dict["version_notes"] = dataset_version.notes
     return data_dict
 
 
@@ -142,15 +142,19 @@ def _version_create_or_update(context, data_dict):
     :param data_dict: The data dictionary containing version details
     """
     current_version = data_dict.get("version")
+    notes = data_dict.get("version_notes")
+    package_id = data_dict.get("id")
+    existing_version = DatasetVersion.get(name=current_version, package_id=package_id)
+    print(notes)
 
-    if getattr(tk.g, "update_version", False):
-
+    if existing_version:
         try:
             tk.get_action("package_version_update")(
                 context,
                 {
                     "name": current_version,
                     "data": data_dict,
+                    "notes": notes,
                 },
             )
             log.info(
@@ -165,15 +169,14 @@ def _version_create_or_update(context, data_dict):
                     "error": [f"Version with name '{current_version}' already exists."],
                 }
             )
-
     else:
         try:
             tk.get_action("package_version_create")(
                 context,
                 {
                     "package_id": data_dict.get("id"),
                     "name": current_version,
-                    "description": data_dict.get("description"),
+                    "notes": notes,
                     "creator_user_id": data_dict.get("creator_user_id"),
                 },
             )

ckanext/versions/logic/schema.py

@@ -16,7 +16,7 @@ def package_version_create(
     return {
         "name": [not_empty, unicode_only],
         "package_id": [not_empty, unicode_only, package_id_exists],
-        "description": [ignore_missing],
+        "notes": [ignore_missing],
         "created": [ignore_missing, isodate],
         "creator_user_id": [ignore_missing, user_id_or_name_exists],
     }
@@ -37,7 +37,7 @@ def package_version_update(
         "id": [ignore_missing, unicode_only],
         "name": [ignore_missing, unicode_only],
         "package_id": [ignore_missing, unicode_only, package_id_exists],
-        "description": [ignore_missing],
+        "notes": [ignore_missing],
         "data": [ignore_missing],
         "created": [ignore_missing, isodate],
         "creator_user_id": [ignore_missing, user_id_or_name_exists],

ckanext/versions/logic/validators.py

@@ -19,7 +19,6 @@ def package_version(key, data, errors, context):
 
     previous_version = DatasetVersion.recent_versions(pkg.id)
     if previous_version and current_version == previous_version.name:
-        tk.g.update_version = True # Even if the version is the same, we want to update it
         return data.get(key)
 
     existing_version = DatasetVersion.get(name=current_version, package_id=pkg.id)

ckanext/versions/migration/versions/versions/908a228d3f7a.py

@@ -27,7 +27,7 @@ def upgrade():
         sa.Column("id", UuidType, primary_key=True),
         sa.Column("package_id", UuidType, sa.ForeignKey("package.id"), nullable=False),
         sa.Column("name", sa.Unicode, nullable=False),
-        sa.Column("description", sa.Unicode, nullable=True),
+        sa.Column("notes", sa.Unicode, nullable=True),
         sa.Column("data", JSONB, nullable=False),
         sa.Column("creator_user_id", UuidType, sa.ForeignKey("user.id"), nullable=True),
         sa.Column("created", sa.DateTime, server_default=sa.func.current_timestamp()),

ckanext/versions/model.py

@@ -30,7 +30,7 @@ class DatasetVersion(DomainObject.DomainObject, tk.BaseModel):
     id = Column(UuidType, primary_key=True, default=UuidType.default)
     package_id = Column(UuidType, ForeignKey("package.id"), nullable=False)
     name = Column(Unicode, nullable=False)
-    description = Column(Unicode, nullable=True)
+    notes = Column(Unicode, nullable=True)
     data = Column(JSONB, nullable=False)
     creator_user_id = Column(UuidType, ForeignKey("user.id"), nullable=True)
     created = Column(DateTime, default=datetime.datetime.utcnow)

ckanext/versions/templates/package/snippets/version_info.html

@@ -7,7 +7,7 @@ <h3>Versions</h3>
     <thead>
         <tr>
             <th scope="col">Version</th>
-            <th scope="col">Description</th>
+            <th scope="col">Notes</th>
             <th scope="col">Published</th>
         </tr>
     </thead>
@@ -23,7 +23,7 @@ <h3>Versions</h3>
                     </a>
                 {% endif %}
             </td>
-            <td>{{ version.description or "" }}</td>
+            <td>{{ version.notes or "" }}</td>
             <td>{{ version.created }}</td>
         </tr>
         {% endfor %}