core-parser-app 2.10.0__tar.gz → 2.12.0__tar.gz

core_parser_app-2.12.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: core_parser_app
+Version: 2.12.0
+Summary: XSD parser tools for the curator core project
+Home-page: https://github.com/usnistgov/core_parser_app
+Author: NIST IT Lab
+Author-email: itl_inquiries@nist.gov
+License-File: LICENSE.md
+Requires-Dist: celery
+Requires-Dist: Django
+Requires-Dist: djangorestframework
+Requires-Dist: lxml==5.2.*
+Requires-Dist: core-main-app==2.12.*
+
+===============
+Core Parser App
+===============
+
+XSD parser, renderers and modules for the curator core project.
+
+Quick start
+===========
+
+1. Add "core_parser_app" to your INSTALLED_APPS setting
+-------------------------------------------------------
+
+.. code:: python
+
+    INSTALLED_APPS = [
+        ...
+        "core_parser_app",
+        "core_parser_app.tools.modules", 
+        "core_parser_app.tools.parser", 
+    ]
+
+2. Include the core_parser_app URLconf in your project urls.py
+--------------------------------------------------------------
+
+.. code:: python
+
+    url(r'^parser/', include("core_parser_app.urls")),
+
+
+Migration to the Bootstrap modal
+================================
+Breaking changes during the migration from the jQuery UI modal to the Bootstrap modal for the module :
+
+- The JavaScript global variables **openModule**, **openPopUp** and **initialState** from the popup.js file have been deleted.
+- The JavaScript variable **openModule** has been renamed to **moduleElement**.
+- The modal management has been changed. JQuery UI reused the same DOM element for all modal loaded in the page. Bootstrap use a unique DOM element for each modal. Consequently the main modal container will have the following unique ID : **modal-{{module_id}}**.
+- The save callback uses the new variable **openModule** to get the unique DOM container and get the value to save.
+- The Django form id must be changed be because it is not unique and can create conflict if the page includes a module more than one time (example with the BLOBHostForm):
+
+.. code:: python
+
+    form = BLOBHostForm()
+    form.fields["file"].widget.attrs.update(
+        {"id": "file-input-%s" % str(module_id)}
+    )

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/access_control.py

@@ -1,5 +1,6 @@
 """ Access control functions
 """
+
 import logging
 
 from django.contrib.auth.models import Group, User

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/admin.py

@@ -1,6 +1,7 @@
 """
 Url router for the administration views
 """
+
 from django.contrib import admin
 from django.contrib.admin.views.decorators import staff_member_required
 from django.urls import re_path

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/components/data_structure/admin_site.py

@@ -1,5 +1,6 @@
 """ Custom admin site for the Data Structure model
 """
+
 from django.contrib import admin
 
 

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/components/data_structure/models.py

@@ -1,5 +1,6 @@
 """ Data structure model
 """
+
 import logging
 from abc import abstractmethod
 
@@ -8,7 +9,6 @@ from django.db import models
 
 from core_main_app.commons import exceptions
 from core_main_app.components.template.models import Template
-from core_parser_app.tasks import delete_branch_task
 
 logger = logging.getLogger(__name__)
 
@@ -204,15 +204,15 @@ class DataStructure(models.Model):
             "No data structure found for the given id."
         )
 
-    @classmethod
-    def pre_delete(cls, sender, instance, **kwargs):
-        """Pre delete operations
+    def delete_data_structure_with_elements(self):
+        """delete_data_structure
 
         Returns:
-
         """
-        # Delete data structure elements
-        instance.delete_data_structure_elements_from_root()
+        from core_parser_app.tasks import delete_data_structure_task
+
+        # Delete data structure
+        delete_data_structure_task.apply_async((str(self.id),))
 
     def delete_data_structure_elements_from_root(self):
         """Delete all data structure elements from the root
@@ -220,6 +220,8 @@ class DataStructure(models.Model):
         Returns:
 
         """
+        from core_parser_app.tasks import delete_branch_task
+
         if self.data_structure_element_root is not None:
             delete_branch_task.apply_async(
                 (str(self.data_structure_element_root.id),)

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/components/data_structure_element/admin_site.py

@@ -1,5 +1,6 @@
 """ Custom admin site for the Data Structure Element model
 """
+
 from django.contrib import admin
 
 

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/components/data_structure_element/api.py

@@ -1,5 +1,6 @@
 """API for Data Structure Element
 """
+
 from core_main_app.access_control.decorators import access_control
 from core_parser_app import access_control as parser_access_control
 from core_parser_app.components.data_structure.models import (

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/components/module/admin_site.py

@@ -1,5 +1,6 @@
 """ Custom admin site for the Module model
 """
+
 from django.contrib import admin
 
 

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/components/module/api.py

@@ -1,5 +1,6 @@
 """API for modules
 """
+
 from core_main_app.commons.exceptions import XSDError
 from core_main_app.components.template import api as template_api
 from core_main_app.components.template.models import Template

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/components/module/models.py

@@ -1,5 +1,6 @@
 """Module models
 """
+
 from django.core.exceptions import ObjectDoesNotExist
 from django.db import models
 

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/management/commands/loadmodules.py

@@ -1,5 +1,6 @@
 """Load modules command
 """
+
 from django.core.management.base import BaseCommand
 from django.urls import get_resolver
 

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/settings.py

@@ -3,6 +3,7 @@
 Settings with the following syntax can be overwritten at the project level:
 SETTING_NAME = getattr(settings, "SETTING_NAME", "Default Value")
 """
+
 from os.path import join, dirname, realpath
 
 from django.conf import settings

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/system/api.py

@@ -2,14 +2,10 @@
 """
 
 
-# TODO: look into using delete cascade
-# FIXME: not removing all data structure elements
 def delete_branch_from_db(element_id):
     """Delete a branch from the database
-
     Args:
         element_id:
-
     Returns:
     """
     from core_parser_app.components.data_structure.models import (
@@ -17,8 +13,19 @@ def delete_branch_from_db(element_id):
     )
 
     element = DataStructureElement.get_by_id(element_id)
-
     for child in element.children.all():
         delete_branch_from_db(str(child.pk))
-
     element.delete()
+
+
+def get_data_structure_by_id(data_structure_id):
+    """get_data_structure_by_id
+    Args:
+        data_structure_id:
+    Returns:
+    """
+    from core_parser_app.components.data_structure.models import (
+        DataStructure,
+    )
+
+    return DataStructure.get_by_id(data_structure_id)

core_parser_app-2.12.0/core_parser_app/tasks.py

@@ -0,0 +1,27 @@
+""" Parser tasks
+"""
+
+from celery import shared_task
+
+
+@shared_task
+def delete_branch_task(data_structure_element_root_id):
+    """
+    Args:
+        data_structure_element_root_id: Data Structure Element Root id.
+    """
+    from core_parser_app.system import api as system_api
+
+    system_api.delete_branch_from_db(data_structure_element_root_id)
+
+
+@shared_task
+def delete_data_structure_task(data_structure_id):
+    """
+    Args:
+        data_structure_id: Data Structure id
+    """
+    from core_parser_app.system import api as system_api
+
+    data_structure = system_api.get_data_structure_by_id(data_structure_id)
+    data_structure.delete()

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/discover.py

@@ -1,5 +1,6 @@
 """Auto discovery of modules
 """
+
 import logging
 
 from django.db import IntegrityError

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/sanitize.py

@@ -1,5 +1,6 @@
 """Sanitize util
 """
+
 import json
 import logging
 from builtins import str

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/views/builtin/autocomplete_module.py

@@ -1,5 +1,6 @@
 """Auto Complete Module
 """
+
 from abc import ABCMeta
 
 from core_parser_app.tools.modules.views.module import AbstractModule

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/views/builtin/checkboxes_module.py

@@ -1,5 +1,6 @@
 """ Checkboxes Module
 """
+
 from abc import ABCMeta
 
 from core_parser_app.tools.modules.exceptions import ModuleError

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/views/builtin/input_button_module.py

@@ -1,5 +1,6 @@
 """ Input Button Module
 """
+
 from abc import ABCMeta
 
 from core_parser_app.tools.modules.views.module import AbstractModule

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/views/builtin/input_module.py

@@ -1,5 +1,6 @@
 """ Input Module
 """
+
 from abc import ABCMeta
 
 from core_parser_app.tools.modules.views.module import AbstractModule

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/views/builtin/options_module.py

@@ -1,5 +1,6 @@
 """ Options Module
 """
+
 from abc import ABCMeta
 
 from core_parser_app.tools.modules.views.module import AbstractModule

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/views/builtin/popup_module.py

@@ -1,5 +1,6 @@
 """ Pop up module
 """
+
 from abc import ABCMeta, abstractmethod
 
 from core_parser_app.tools.modules.views.module import AbstractModule

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/views/builtin/sync_input_module.py

@@ -1,5 +1,6 @@
 """ Synchronous Input Module
 """
+
 from abc import ABCMeta
 
 from core_parser_app.tools.modules.exceptions import ModuleError

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/views/builtin/textarea_module.py

@@ -1,5 +1,6 @@
 """ Text area Module
 """
+
 from abc import ABCMeta
 
 from core_parser_app.tools.modules.views.module import AbstractModule

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/views/module.py

@@ -1,5 +1,6 @@
 """Abstract Class Module
 """
+
 import importlib
 import json
 from abc import ABCMeta, abstractmethod

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/modules/views/views.py

@@ -1,5 +1,6 @@
 """Views for the module system
 """
+
 import json
 
 from django.contrib.staticfiles import finders

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/parser/parser.py

@@ -1,5 +1,6 @@
 """Parser class
 """
+
 import logging
 import numbers
 import re
@@ -1883,7 +1884,7 @@ class XSDParser:
                         )
                     )
 
-            for (counter, choiceChild) in enumerate(list(element)):
+            for counter, choiceChild in enumerate(list(element)):
                 # For unbounded choice, explicitly don't generate the choices not selected
                 if choiceChild.tag == "{0}element".format(
                     LXML_SCHEMA_NAMESPACE
@@ -1892,9 +1893,9 @@ class XSDParser:
                     xml_tree_str = XSDTree.tostring(xml_tree)
                     namespaces = get_namespaces(xml_tree_str)
                     # add the XSI prefix used by extensions
-                    namespaces[
-                        "xsi"
-                    ] = "http://www.w3.org/2001/XMLSchema-instance"
+                    namespaces["xsi"] = (
+                        "http://www.w3.org/2001/XMLSchema-instance"
+                    )
                     (
                         target_namespace,
                         target_namespace_prefix,
@@ -2137,9 +2138,9 @@ class XSDParser:
             "value": None,
             "children": [],
             "options": {
-                "name": element.attrib["name"]
-                if "name" in element.attrib
-                else "",
+                "name": (
+                    element.attrib["name"] if "name" in element.attrib else ""
+                ),
                 "xmlns": get_element_namespace(element, xml_tree),
             },
         }
@@ -2289,9 +2290,9 @@ class XSDParser:
             "value": None,
             "children": [],
             "options": {
-                "name": element.attrib["name"]
-                if "name" in element.attrib
-                else "",
+                "name": (
+                    element.attrib["name"] if "name" in element.attrib else ""
+                ),
                 "xmlns": get_element_namespace(element, xml_tree),
             },
         }
@@ -2524,7 +2525,7 @@ class XSDParser:
             }
             self.check_in_memory_elements()
 
-            for (counter, choiceChild) in enumerate(list(element)):
+            for counter, choiceChild in enumerate(list(element)):
 
                 if is_root:
                     if target_namespace_prefix != "":
@@ -2577,8 +2578,6 @@ class XSDParser:
 
                         if opt_label and ":" in opt_label:
                             opt_label = opt_label.split(":")[1]
-                        # if ":" in opt_label:
-                        #     opt_label = opt_label.split(":")[1]
 
                     # look for active choice when editing
                     if self.editing:

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/parser/renderer/__init__.py

@@ -1,5 +1,6 @@
 """Base Renderer class
 """
+
 import logging
 from os.path import join
 
@@ -226,9 +227,11 @@ class DefaultRenderer:
             "select_class": select_class,
             "option_list": option_list,
             "fixed": is_fixed,
-            "tooltip": element_options["tooltip"]
-            if "tooltip" in element_options
-            else "",
+            "tooltip": (
+                element_options["tooltip"]
+                if "tooltip" in element_options
+                else ""
+            ),
         }
 
         return self._load_template("select", data)

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/parser/renderer/checkbox.py

@@ -1,5 +1,6 @@
 """Checkbox Renderer class
 """
+
 import logging
 
 from core_parser_app.tools.parser.renderer.list import ListRenderer

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/parser/renderer/list.py

@@ -1,5 +1,6 @@
 """List Renderer class
 """
+
 import logging
 from os.path import join
 

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/parser/renderer/table.py

@@ -1,5 +1,6 @@
 """Table Renderer class
 """
+
 import logging
 from os.path import join
 

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/parser/renderer/xml.py

@@ -1,5 +1,6 @@
 """XML Renderer class
 """
+
 import logging
 import numbers
 from os.path import join

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/parser/utils/rendering.py

@@ -1,5 +1,6 @@
 """Form rendering utils
 """
+
 import re
 import textwrap
 

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/tools/parser/utils/xml.py

@@ -1,5 +1,6 @@
 """XML utils
 """
+
 import logging
 from urllib.parse import urlparse
 

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/urls.py

@@ -1,5 +1,6 @@
 """ Url router for the parser application
 """
+
 from django.conf.urls import include
 from django.urls import re_path
 

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/views/admin/views.py

@@ -1,5 +1,6 @@
 """Core parser app admin views
 """
+
 from django.views.generic import View
 
 from core_main_app.utils.rendering import admin_render

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/views/common/ajax.py

@@ -1,5 +1,6 @@
 """AJAX views
 """
+
 import json
 
 from django.contrib.auth.decorators import login_required

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/views/common/views.py

@@ -1,5 +1,6 @@
 """ Common views
 """
+
 from django.contrib.auth.decorators import login_required
 from django.urls import reverse, NoReverseMatch
 from django.utils.decorators import method_decorator

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app/views/user/ajax.py

@@ -1,5 +1,6 @@
 """AJAX views
 """
+
 import json
 
 from django.contrib.auth.decorators import login_required

core_parser_app-2.12.0/core_parser_app.egg-info/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: core_parser_app
+Version: 2.12.0
+Summary: XSD parser tools for the curator core project
+Home-page: https://github.com/usnistgov/core_parser_app
+Author: NIST IT Lab
+Author-email: itl_inquiries@nist.gov
+License-File: LICENSE.md
+Requires-Dist: celery
+Requires-Dist: Django
+Requires-Dist: djangorestframework
+Requires-Dist: lxml==5.2.*
+Requires-Dist: core-main-app==2.12.*
+
+===============
+Core Parser App
+===============
+
+XSD parser, renderers and modules for the curator core project.
+
+Quick start
+===========
+
+1. Add "core_parser_app" to your INSTALLED_APPS setting
+-------------------------------------------------------
+
+.. code:: python
+
+    INSTALLED_APPS = [
+        ...
+        "core_parser_app",
+        "core_parser_app.tools.modules", 
+        "core_parser_app.tools.parser", 
+    ]
+
+2. Include the core_parser_app URLconf in your project urls.py
+--------------------------------------------------------------
+
+.. code:: python
+
+    url(r'^parser/', include("core_parser_app.urls")),
+
+
+Migration to the Bootstrap modal
+================================
+Breaking changes during the migration from the jQuery UI modal to the Bootstrap modal for the module :
+
+- The JavaScript global variables **openModule**, **openPopUp** and **initialState** from the popup.js file have been deleted.
+- The JavaScript variable **openModule** has been renamed to **moduleElement**.
+- The modal management has been changed. JQuery UI reused the same DOM element for all modal loaded in the page. Bootstrap use a unique DOM element for each modal. Consequently the main modal container will have the following unique ID : **modal-{{module_id}}**.
+- The save callback uses the new variable **openModule** to get the unique DOM container and get the value to save.
+- The Django form id must be changed be because it is not unique and can create conflict if the page includes a module more than one time (example with the BLOBHostForm):
+
+.. code:: python
+
+    form = BLOBHostForm()
+    form.fields["file"].widget.attrs.update(
+        {"id": "file-input-%s" % str(module_id)}
+    )

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app.egg-info/SOURCES.txt

@@ -160,6 +160,8 @@ tests/components/module/__init__.py
 tests/components/module/tests_unit.py
 tests/discover/__init__.py
 tests/discover/tests_unit.py
+tests/tasks/__init__.py
+tests/tasks/tests_unit.py
 tests/tools/__init__.py
 tests/tools/modules/__init__.py
 tests/tools/modules/tests/__init__.py
@@ -169,6 +171,7 @@ tests/tools/modules/tests/tests_unit_sanitize.py
 tests/tools/parser/__init__.py
 tests/tools/parser/parser/__init__.py
 tests/tools/parser/parser/test_choice.py
+tests/tools/parser/parser/test_choice_extensions.py
 tests/tools/parser/parser/test_complex_content.py
 tests/tools/parser/parser/test_complex_type.py
 tests/tools/parser/parser/test_element.py

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/core_parser_app.egg-info/requires.txt

@@ -1,5 +1,5 @@
 celery
 Django
 djangorestframework
-lxml==4.9.*
-core-main-app==2.10.*
+lxml==5.2.*
+core-main-app==2.12.*

core_parser_app-2.12.0/requirements.core.txt

@@ -0,0 +1 @@
+core-main-app==2.12.*

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/requirements.txt

@@ -1,4 +1,4 @@
 celery
 Django
 djangorestframework
-lxml==4.9.*
+lxml==5.2.*

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/setup.py

@@ -1,5 +1,6 @@
 """ Setup for core parser app
 """
+
 from os import chdir, pardir
 from os.path import join, exists, dirname, normpath, abspath
 from re import sub
@@ -41,7 +42,7 @@ required = [req_link(r) if r.startswith("https://") else r for r in required]
 
 setup(
     name="core_parser_app",
-    version="2.10.0",
+    version="2.12.0",
     description="XSD parser tools for the curator core project",
     long_description=long_desc,
     author="NIST IT Lab",

{core_parser_app-2.10.0 → core_parser_app-2.12.0}/tests/commands/tests_unit.py

@@ -1,5 +1,6 @@
 """Module command unit testing
 """
+
 from io import StringIO
 from unittest.case import TestCase