Merge branch 'master' into 189-Cleanup-CSS-Foundation

Author: Sundraiz-Shah

.gitignore

@@ -19,3 +19,7 @@ env/
 .hermes/process/hermes.json
 hermes.log
 hermes.toml
+
+*.sln
+*.pyproj
+*.user

docs/field_types_in_curation.md

@@ -19,6 +19,13 @@ SMECS supports typical field types in the curation interface. The following type
      * Cardinality: 1
      * Type: string
 
+### Big Field
+* tag: big_field
+* full page field for longer text with multiple rows
+* Typical used for:
+     * Cardinality: 1
+     * Type: string
+
 ### Dropdown
 * tag: dropdown
 * full page dropdown field

meta_creator/hermes_process.py

@@ -34,6 +34,7 @@ def run_hermes_commands(url, token=None):
         print(error_msg)
         errors.append(error_msg)
         return {
+            'metadata': {"codeRepository": url },
             'success': False,
             'errors': errors,
             'warnings': warnings
@@ -71,15 +72,32 @@ def run_hermes_commands(url, token=None):
     # Step 3: Run hermes process
     print("Running hermes process...")
     process_command = subprocess.run(['hermes', 'process'], capture_output=True, text=True, cwd=base_directory)
+    
+    ## Check result and create correct path
     if process_command.returncode != 0:
         error_msg = f"Error in hermes process: {process_command.stderr}"
         print(error_msg)
         errors.append(error_msg)
-        return {
-            'success': False,
-            'errors': errors,
-            'warnings': warnings
-        }
+        file_names = ["codemeta.json", "cff.json", "githublab.json"]
+        for file_name in file_names:
+            file_path = os.path.join(base_directory, ".hermes", "harvest", file_name)
+            os.remove(file_path)
+            print(f"Removed {file_path}")
+            process_command = subprocess.run(['hermes', 'process'], capture_output=True, text=True, cwd=base_directory)
+
+            if process_command.returncode == 0:
+                break
+
+        if process_command.returncode != 0:
+            errors.append(error_msg)
+            return {
+                'metadata': {"codeRepository": url },
+                'success': False,
+                'errors': errors,
+                'warnings': warnings
+            }
+        else:
+            errors = []
 
     # Construct the path to hermes.json
     hermes_json_path = os.path.join(base_directory, ".hermes", "process", "hermes.json")

meta_creator/init_curated_metadata.py

@@ -56,6 +56,12 @@ def load_description_dict_from_schema(schema: dict) -> dict[str, str]:
                 if desc and key not in description_dict:
                     description_dict[key] = desc
 
+    ## Define descriptions for tabs
+    description_dict['GeneralInformation'] = "This section gives general information about the software."
+    description_dict['Provenance'] = "This section describes the creation history of the software."
+    description_dict['RelatedPersons'] = "This section lists all relevant persons who are connected to the software."
+    description_dict['TechnicalAspects'] = "This section describes the technical aspects of the software."
+
     return description_dict
 
 # Define required field_type per element
@@ -94,15 +100,16 @@ def define_field_type(schema: dict, types: dict, array = False) -> dict[str, str
             else:
                 type_dict[key] = "single_input_object"
         elif value.get("type") == "string":
-            type_dict[key] = "long_field" if key == "description" else "single_inputs"
+            if key == "description":
+                type_dict[key] = "big_field"
+            elif key == "abstract":
+                type_dict[key] = "long_field"
+            else:
+                type_dict[key] = "single_inputs"
         elif value.get("type") == "array":
             items = value.get("items", {})  # Safely get "items" or default to an empty dict
-            if "enum" in items:
-                enum_values = items.get("enum")
-                if enum_values is not None and len(enum_values) > 10:
-                    type_dict[key] = "tagging_autocomplete"
-                else:
-                    type_dict[key] = "tagging_dropdown"
+            if "enum" in items:            
+                type_dict[key] = "tagging_autocomplete"
             elif items.get("type") == "string":
                 type_dict[key] = "tagging"
             elif "$ref" in items:
@@ -205,7 +212,7 @@ def create_empty_metadata(schema: dict) -> dict[str, dict[str, str]]:
     properties_list = load_properties_list_from_schema(schema)
     metadata = {"GeneralInformation": create_empty_metadata_dict_from_properties_list(properties_list, schema, "name", "copyrightHolder"),
                 "Provenance": create_empty_metadata_dict_from_properties_list(properties_list, schema, "softwareVersion", "funding"),
-                "Contributors": create_empty_metadata_dict_from_properties_list(properties_list, schema, "contributor", "maintainer"),
+                "RelatedPersons": create_empty_metadata_dict_from_properties_list(properties_list, schema, "contributor", "maintainer"),
                 "TechnicalAspects": create_empty_metadata_dict_from_properties_list(properties_list, schema, "downloadUrl", "targetProduct")
         }
     return metadata

meta_creator/templates/meta_creator/index.html

@@ -64,7 +64,7 @@ <h6 class="custom-tooltip">
           type="text"
           id="token_input"
           name="personal_token_key"
-          placeholder="Enter your personal token key from GitHub"
+          placeholder="(Optional) Enter your personal token key from GitHub or GitLab"
           value="" />
         {% if error_message_token %}
         <span id="token_error" class="error_message"
@@ -80,7 +80,9 @@ <h6 class="custom-tooltip">
         </button>
       </form>
     </div>
+
   </div>
+
 </div>
 
 <!-- Pop-up modal overlay for loading spinner -->

meta_creator/templates/meta_creator/showdata.html

@@ -13,6 +13,7 @@
                             {% csrf_token %}
                             <h4>Metdata in JSON format</h4>
 
+
                             <div class="metadata-container">
                                 <div class="left">
                                     <span id="actionFeedback" class="feedback"></span>
@@ -47,11 +48,11 @@ <h4>Metdata in JSON format</h4>
                         <div class="row">
                             <div class="col-3 color-code">
                                 <span class="red"></span>
-                                <span class="fs-6">Missing required or recommended metadata</span>
+                                <span class="fs-6">Missing required metadata</span>
                             </div>
                             <div class="col-3 color-code">
                                 <span class="yellow"></span>
-                                <span class="fs-6">Better to curate the metadata</span>
+                                <span class="fs-6">Missing recommended metadata</span>
                             </div>
                             <div class="col-3 color-code">
                                 <span class="symbol"></span>
@@ -102,10 +103,19 @@ <h1>Extra Hints!</h1>
                             {% with unique_tab=type_metadata|all_types_same:metadata_dict %}
                             <!-- {{tab_name}}_info -->
                             {% if forloop.first %}
-                            <div id="{{ tab_name }}" class="tab active">
+                             <div id="{{ tab_name }}" class="tab active{% if unique_tab %} unique-tab{% endif %}">
                                 {% else %}
-                                <div id="{{ tab_name }}" class="tab">
+                                <div id="{{ tab_name }}" class="tab{% if unique_tab %} unique-tab{% endif %}">
                                     {% endif %}
+                                  {% if unique_tab %}
+                            <div class="unique-tab-inner">
+                                {% endif %}
+
+                                {% if description_metadata|get:tab_name %}
+                                <div class="tab-description">
+                                    {{ description_metadata|get:tab_name }}
+                                </div>
+                                {% endif %}
                                     {% for key, value in metadata_dict.items %}
                                     <div class="form-group">
                                         {% if type_metadata|get:key == "hidden" %}
@@ -255,6 +265,18 @@ <h1>Extra Hints!</h1>
                                             </div>
                                             <input title="{{ value }}" id="{{ key }}" name="{{ key }}" type="text" value="{{ value }}"><br>
                                         </div>
+                                      {% elif type_metadata|get:key == "big_field" %}
+                                    <!-- Single input and long field element -->
+                                    <div class={{type_metadata|get:key}}>
+                                        <label for="{{ key }}">{{ key|camel_to_spaces_lower }}</label>
+                                        <div class="custom-tooltip-metadata">
+                                            <span class="tooltip-text-metadata">
+                                                {% if key in description_metadata %}{{ description_metadata|get:key }}{% endif %}
+                                            </span>
+                                            <i class="fa fa-info-circle" aria-hidden="true"></i>
+                                        </div>
+                                        <textarea title="{{ value }}" id="{{ key }}" name="{{ key }}" rows="3">{{ value }}</textarea><br>
+                                    </div>
                                         {% elif forloop.first or not unique_tab %}
                                         <!-- small_table -->
                                         <div class="long_field">
@@ -416,14 +438,18 @@ <h1>Extra Hints!</h1>
                                     </div>
                                 </div>
                                 <!-- tab_contributors -->
+                            {% if unique_tab %}
+                        </div>
+                               {% endif %}
                                 {% endwith %}
                                 {% endfor %}
                                 <!-- </form> -->
+
                             </div>
-                        </div>
+                           
+
                     </form>
         </div> 
-         
     </div><!-- main div -->
 </div><!-- whole-extraction-page -->
 {% endblock content %}

meta_creator/validate_jsonLD.py

@@ -11,30 +11,36 @@ def validate_codemeta(json):
         print("Not a JSON-LD file")
         return False
 
-    if context == "https://doi.org/10.5063/schema/codemeta-2.0":
+    # if context == "https://doi.org/10.5063/schema/codemeta-2.0":
+    if context == "https://w3id.org/codemeta/3.0":
         # Temp replacement for https resolution issues for schema.org
-        context = "https://raw.githubusercontent.com/caltechlibrary/convert_codemeta/main/codemeta.jsonld"
+        # context = "https://raw.githubusercontent.com/caltechlibrary/convert_codemeta/main/codemeta.jsonld"
+        context = "https://raw.githubusercontent.com/codemeta/codemeta/3.0/codemeta.jsonld"
         json["@context"] = context
-    cp = copy.deepcopy(json)
-    # Expand and contract to check mapping
-    cp = jsonld.expand(cp)
-    cp = jsonld.compact(cp, context)
-    keys = cp.keys()
-    # Using len because @type elements get returned as type
-    same = len(set(keys)) == len(set(json.keys()))
-    if not same:
-        print("Unsupported terms in Codemeta file")
-        diff = set(json.keys()) - set(keys)
-        if "@type" in diff:
-            diff.remove("@type")
-        print(sorted(diff))
-    fail = ":" in keys
-    if fail:
-        print("Not in schema")
-        for k in keys:
-            if ":" in k:
-                print(k)
 
-    # Restore the original context
-    json["@context"] = original_context
-    return same and not fail
+    if context == "https://w3id.org/codemeta/3.0":
+        cp = copy.deepcopy(json)
+        # Expand and contract to check mapping
+        cp = jsonld.expand(cp)
+        cp = jsonld.compact(cp, context)
+        keys = cp.keys()
+        # Using len because @type elements get returned as type
+        same = len(set(keys)) == len(set(json.keys()))
+        if not same:
+            print("Unsupported terms in Codemeta file")
+            diff = set(json.keys()) - set(keys)
+            if "@type" in diff:
+                diff.remove("@type")
+            print(sorted(diff))
+        fail = ":" in keys
+        if fail:
+            print("Not in schema")
+            for k in keys:
+                if ":" in k:
+                    print(k)
+
+        # Restore the original context
+        json["@context"] = original_context
+        return same and not fail
+
+    return True  # If the context is not recognized, we assume it's valid for now

meta_creator/views.py

@@ -46,7 +46,13 @@ def index(request):
         result = data_extraction(request)
 
         if not result.get('success'):
-            error_messages = ['Error in extraction:', result.get('errors')]
+            errors = result.get('errors')
+
+            # Check if errors is a list or a string and format accordingly
+            if isinstance(errors, list):
+                error_messages = ['Error in extraction:'] + errors
+            else:
+                error_messages = ['Error in extraction:', errors]          
             return render(request, 'meta_creator/error.html', {
                 'error_message': "; ".join(error_messages)
                 })

requirements.txt

@@ -1,5 +1,5 @@
 # Core Django and JSON handling
-django==4.1.10
+Django>=4.2.22
 django_jsonforms==1.1.2
 environs==9.3.5
 marshmallow>=3.10,<3.20
@@ -11,6 +11,6 @@ python-gitlab==3.13.0
 GitPython>=3.1.41
 
 # Git-based packages pinned to specific commits/branches
-git+https://github.com/softwarepub/hermes-plugin-github-gitlab@2a28c038bd87a3050f365ed103702554786ad66f#egg=hermes_plugin_githublab
+git+https://github.com/softwarepub/hermes-plugin-github-gitlab
 git+https://github.com/Aidajafarbigloo/hermes@14fc040afd4b7f7268b937477dce56bd7695fbf3#egg=hermes