SimpleDomControl 0.55.3__tar.gz → 0.56.0__tar.gz

{simpledomcontrol-0.55.3 → simpledomcontrol-0.56.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: SimpleDomControl
-Version: 0.55.3
+Version: 0.56.0
 Summary: Simple DOM control -> a django MVC framework
 Home-page: https://github.com/StarmanMartin/sdc
 License: Apache-2.0
@@ -26,5 +26,8 @@ Requires-Dist: psycopg2-binary (>=2.9.9,<3.0.0)
 Requires-Dist: regex (>=2024.5.15,<2025.0.0)
 Description-Content-Type: text/markdown
 
-simpleDomControl
+# Simple Dom Control (SDC)
 
+SDC is a framework that combines elements of both the MVC (Model-View-Controller) and MVT (Model-View-Template) patterns. Its main goal is to provide a tool for simple and efficient web development. The name ‘SDC’ is an abbreviation for ‘Simple DOM Control,’ indicating its focus on controlling and manipulating the Document Object Model (DOM), which is crucial for web development, particularly in dynamic web pages.
+
+For detailed docs go to [rtd](https://simpledomcontrol.readthedocs.io/en/latest/)

simpledomcontrol-0.56.0/README.md

@@ -0,0 +1,5 @@
+# Simple Dom Control (SDC)
+
+SDC is a framework that combines elements of both the MVC (Model-View-Controller) and MVT (Model-View-Template) patterns. Its main goal is to provide a tool for simple and efficient web development. The name ‘SDC’ is an abbreviation for ‘Simple DOM Control,’ indicating its focus on controlling and manipulating the Document Object Model (DOM), which is crucial for web development, particularly in dynamic web pages.
+
+For detailed docs go to [rtd](https://simpledomcontrol.readthedocs.io/en/latest/)

{simpledomcontrol-0.55.3 → simpledomcontrol-0.56.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "SimpleDomControl"
-version = "0.55.3"
+version = "0.56.0"
 authors = [ "Martin Starman <private@martin-starman.com>", ]
 description = "Simple DOM control -> a django MVC framework"
 readme = "README.md"
@@ -38,6 +38,9 @@ testpaths = [
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.2.2"
 pillow = "^10.1.0"
+sphinx-toolbox = "^3.6.0"
+sphinx-rtd-theme = "^2.0.0"
+sphinx-markdown-builder = "^0.6.6"
 
 [build-system]
 requires = ["poetry-core"]

{simpledomcontrol-0.55.3 → simpledomcontrol-0.56.0}/sdc_core/consumers.py

@@ -277,7 +277,9 @@ class SDCModelConsumer(WebsocketConsumer):
                 traceback.print_tb(e.__traceback__)
             else:
                 logger.error(e_text)
-                e_text = _f('Something went wrong')
+                e_text_details = str(e)
+                e_text = _f('Something went wrong! {e}').format(e=e_text_details)
+
             self.state_error({
                 'type': msg_type,
                 'msg': e_text,
@@ -315,12 +317,12 @@ class SDCModelConsumer(WebsocketConsumer):
     def _load_create_form(self, json_data):
         instance: SdcModel = self.model()
         instance.scope = self.scope
-        return self._load_form(json_data, self.model.create_form, instance)
+        return self._load_form(json_data, self.model.SdcMeta.create_form, instance)
 
     def _load_edit_form(self, json_data):
         instance = self._load_model().get(pk=json_data['args']['pk'])
         instance.scope = self.scope
-        return self._load_form(json_data, self.model.edit_form, instance)
+        return self._load_form(json_data, self.model.SdcMeta.edit_form, instance)
 
     def _load_named_form(self, json_data):
         instance = self._load_model().get(pk=json_data['args']['pk'])
@@ -345,7 +347,7 @@ class SDCModelConsumer(WebsocketConsumer):
         self.send(text_data=json.dumps({
             'type': json_data['event_type'],
             'event_id': json_data['event_id'],
-            'html': self._render(self.model.html_form_template, {'instance': instance, 'form': form(instance=instance)},
+            'html': self._render(self.model.SdcMeta.html_form_template, {'instance': instance, 'form': form(instance=instance)},
                                  json_data),
             'is_error': False
         }))
@@ -353,12 +355,12 @@ class SDCModelConsumer(WebsocketConsumer):
     def _create_element(self, json_data):
         instance: SdcModel = self.model()
         instance.scope = self.scope
-        return self._submit_element(json_data, self.model.create_form, instance)
+        return self._submit_element(json_data, self.model.SdcMeta.create_form, instance)
 
     def _save_element(self, json_data):
         instance = self._load_model().get(pk=json_data['args']['data']['pk'])
         instance.scope = self.scope
-        return self._submit_element(json_data, self.model.edit_form, instance)
+        return self._submit_element(json_data, self.model.SdcMeta.edit_form, instance)
 
     def _upload_file(self, json_data):
         file_data = json_data['args']
@@ -416,20 +418,20 @@ class SDCModelConsumer(WebsocketConsumer):
             'type': json_data['event_type'],
             'event_id': json_data['event_id'],
             'data': {'instance': new_instance},
-            'html': self._render(self.model.html_form_template,
+            'html': self._render(self.model.SdcMeta.html_form_template,
                                  {'instance': form_instance.instance, 'form': form_instance},
                                  json_data),
             'is_error': not is_valid
         }))
 
     def _load_list_view(self, json_data):
-        if self.model.html_list_template is None:
+        if self.model.SdcMeta.html_list_template is None:
             raise NotImplemented()
 
         self.send(text_data=json.dumps({
             'type': json_data['event_type'],
             'event_id': json_data['event_id'],
-            'html': self._render(self.model.html_list_template, {'instances': self._load_model()}, json_data),
+            'html': self._render(self.model.SdcMeta.html_list_template, {'instances': self._load_model()}, json_data),
             'is_error': False
         }))
 

{simpledomcontrol-0.55.3 → simpledomcontrol-0.56.0}/sdc_core/management/commands/init_add/add_model_manager.py

@@ -49,22 +49,25 @@ class AddModelManager():
         self._check_if_sdcmodel_imported(model_path)
         f = open(model_path, 'a')
 
-        search_form_def = "\n".join([
-            'class {2}SearchForm(AbstractSearchForm):',
-            '{0}CHOICES = (("id", "Id"),)',
-            '{0}PLACEHOLDER = ""',
-            '{0}DEFAULT_CHOICES = CHOICES[0][0]',
-            '{0}SEARCH_FIELDS = ("id",)',
-        ]).format(options.SEP, self.app_name, self.model_name)
+        search_form_def = "\n".join([]).format(options.SEP, self.app_name, self.model_name)
 
         class_def = "\n".join([
             'class {2}(models.Model, SdcModel):',
-            '{0}edit_form = "{1}.forms.{2}Form"',
-            '{0}create_form = "{1}.forms.{2}Form"',
-            '{0}html_list_template = "{1}/models/{2}/{2}_list.html"',
-            '{0}html_detail_template = "{1}/models/{2}/{2}_details.html"',
+            '{0}class SearchForm(AbstractSearchForm):',
+            '{0}{0}"""A default search form used in the list view. You can delete it if you dont need it"""',
+            '{0}{0}CHOICES = (("id", "Id"),)',
+            '{0}{0}PLACEHOLDER = ""',
+            '{0}{0}DEFAULT_CHOICES = CHOICES[0][0]',
+            '{0}{0}SEARCH_FIELDS = ("id",)',
+            '',
+            '{0}class _SdcMeta:',
+            '{0}{0}"""Meta data information needed to manage all SDC operations."""',
+            '{0}{0}edit_form = "{1}.forms.{2}Form"',
+            '{0}{0}create_form = "{1}.forms.{2}Form"',
+            '{0}{0}html_list_template = "{1}/models/{2}/{2}_list.html"',
+            '{0}{0}html_detail_template = "{1}/models/{2}/{2}_details.html"',
             '',
-            '{0}@classmethod\n{0}def render(cls, template_name, context=None, request=None, using=None):\n{0}{0}if template_name == cls.html_list_template:\n{0}{0}{0}sf = {2}SearchForm(data=context.get("filter", {{}}))\n{0}{0}{0}context = context | handle_search_form(context["instances"], sf,  range=10)\n{0}{0}return render_to_string(template_name=template_name, context=context, request=request, using=using)',
+            '{0}@classmethod\n{0}def render(cls, template_name, context=None, request=None, using=None):\n{0}{0}if template_name == cls.SdcMeta.html_list_template:\n{0}{0}{0}sf = cls.SearchForm(data=context.get("filter", {{}}))\n{0}{0}{0}context = context | handle_search_form(context["instances"], sf,  range=10)\n{0}{0}return render_to_string(template_name=template_name, context=context, request=request, using=using)',
             '',
             '{0}@classmethod\n{0}def is_authorised(cls, user, action, obj):\n{0}{0}return True',
             '',

{simpledomcontrol-0.55.3 → simpledomcontrol-0.56.0}/sdc_core/management/commands/sdc_get_model_infos.py

@@ -44,26 +44,26 @@ class Command(BaseCommand):
             'model_file': os.path.join(options.PROJECT_ROOT, model.__module__.replace('.', os.path.sep) + '.py'),
             'model_file_line': self._get_class_line_number(
                 os.path.join(options.PROJECT_ROOT, model.__module__.replace('.', os.path.sep) + '.py'), model.__name__),
-            'create_form': self._separate_file_class(model.create_form),
-            'edit_form': self._separate_file_class(model.edit_form)
+            'create_form': self._separate_file_class(model.SdcMeta.create_form),
+            'edit_form': self._separate_file_class(model.SdcMeta.edit_form)
 
         }
 
-        if model.html_detail_template:
+        if model.SdcMeta.html_detail_template:
             try:
-                mi['html_detail_template'] = get_template(model.html_detail_template).origin.name
+                mi['html_detail_template'] = get_template(model.SdcMeta.html_detail_template).origin.name
             except:
                 pass
 
-        if model.html_list_template:
+        if model.SdcMeta.html_list_template:
             try:
-                mi['html_list_template'] = get_template(model.html_list_template).origin.name
+                mi['html_list_template'] = get_template(model.SdcMeta.html_list_template).origin.name
             except:
                 pass
 
-        if model.html_form_template:
+        if model.SdcMeta.html_form_template:
             try:
-                mi['html_form_template'] = get_template(model.html_form_template).origin.name
+                mi['html_form_template'] = get_template(model.SdcMeta.html_form_template).origin.name
             except:
                 pass
 

{simpledomcontrol-0.55.3 → simpledomcontrol-0.56.0}/sdc_core/sdc_extentions/models.py

@@ -11,10 +11,13 @@ from django.apps import apps
 from channels.layers import get_channel_layer
 from django.contrib.auth import get_user_model
 
+from sdc_core.sdc_extentions.forms import AbstractSearchForm
+
 User = get_user_model()
 
 _ALL_MODELS = None
 
+
 def all_models():
     global _ALL_MODELS
     if _ALL_MODELS is None:
@@ -23,6 +26,7 @@ def all_models():
         }
     return _ALL_MODELS
 
+
 class ConsumerSerializer(Serializer):
 
     def handle_m2m_field(self, obj, field):
@@ -42,16 +46,47 @@ class ConsumerSerializer(Serializer):
             return field.value_from_object(obj).url
         return super()._value_from_field(obj, field)
 
+
+_SDC_META_DEFAULT = {'edit_form': None,
+                     'create_form': None,
+                     'html_list_template': None,
+                     'html_detail_template': None,
+                     'html_form_template': getattr(settings, 'MODEL_FORM_TEMPLATE', "elements/form.html")
+                     }
+
+class classproperty(property):
+    def __get__(self, obj, objtype=None):
+        return super().__get__(objtype)
+    def __set__(self, obj, value):
+        super().__set__(type(obj), value)
+
+class _SdcMetaDummy:
+    _sdc_checked = False
+
 class SdcModel():
     __is_sdc_model__ = True
-    edit_form = None
-    create_form = None
-    html_list_template = None
-    html_detail_template = None
-    html_form_template = getattr(settings, 'MODEL_FORM_TEMPLATE', "elements/form.html")
-    apply_filter = None
     _scope = None
 
+    class SearchForm(AbstractSearchForm):
+        CHOICES = (("id", "Id"),)
+        PLACEHOLDER = ""
+        DEFAULT_CHOICES = CHOICES[0][0]
+        SEARCH_FIELDS = ("id",)
+
+    @classproperty
+    def SdcMeta(cls):
+        if not hasattr(cls, '_SdcMeta'):
+            setattr(cls, '_SdcMeta', _SdcMetaDummy())
+
+        sdc_meta = getattr(cls, '_SdcMeta')
+
+        if not getattr(sdc_meta, '_sdc_checked', False):
+            setattr(sdc_meta,'_sdc_checked', True)
+            for k, v in _SDC_META_DEFAULT.items():
+                if not hasattr(sdc_meta, k):
+                    setattr(sdc_meta, k, getattr(cls, k, v))
+        return sdc_meta
+
     @property
     def scope(self) -> dict[str: any]:
         return self._scope
@@ -73,7 +108,7 @@ class SdcModel():
         raise NotImplemented
 
     @classmethod
-    def data_load(cls, user: User, action: str, obj: dict[str: any]) -> QuerySet|None:
+    def data_load(cls, user: User, action: str, obj: dict[str: any]) -> QuerySet | None:
         return None
 
 

{simpledomcontrol-0.55.3 → simpledomcontrol-0.56.0}/sdc_core/sdc_extentions/response.py

@@ -5,13 +5,12 @@ from django.http import HttpResponse
 from django.template.loader import render_to_string
 from django.core.serializers.json import DjangoJSONEncoder
 
-
 NEXT = 'next_controller'
 
 
-
-def sdc_link_factory(controller: str = None, link_data: dict = None, add_sdc_index : bool = True) -> str:
+def sdc_link_factory(controller: str = None, link_data: dict = None, add_sdc_index: bool = True) -> str:
     """
+
     :param controller: path to controller
     :type controller: str, optional
     :param link_data: arguments passed to the new redirected controller
@@ -51,16 +50,14 @@ def send_redirect(controller: str = None, back: bool = False, link_data: dict =
     send_redirect is a simple way to redirect a client to another SDC controller. Set the controller argument according to
     the rules of the sdc_tools.sdc_navigator. Following you see some examples:
 
-
     - /view-a/view-b -> view-b as subview of view-a
     - */view-b -> keeps first view as it is and view-b as subview
     - ../view-b -> replaces current latest subview by view-b
     - ./view-b -> adds view-b as next latest subview to the current path
 
-
     :param controller: path to controller
     :type controller: str, optional
-    :param back: if 'True' the redirect url is equal to '..', default is 'False'
+    :param back: if ``True`` the redirect url is equal to ``..``, default is ``False``
     :type back: boolean, optional
     :param link_data: arguments passed to the new redirected controller
     :type link_data: dict, optional
@@ -86,7 +83,7 @@ def send_redirect(controller: str = None, back: bool = False, link_data: dict =
     return HttpResponse(json.dumps(kwargs, cls=DjangoJSONEncoder), status=301, content_type="application/json")
 
 
-def send_success(template_name: str = None, context: dict = None, request = None, status= 'success', **kwargs):
+def send_success(template_name: str = None, context: dict = None, request=None, status='success', **kwargs):
     """
 
     :param template_name: HTML template name
@@ -110,5 +107,6 @@ def send_error(template_name: str = None, context: dict = None, request=None, st
         kwargs['html'] = render_to_string(template_name, request=request, context=context)
     return HttpResponse(json.dumps(kwargs, cls=DjangoJSONEncoder), status=status, content_type="application/json")
 
+
 def send_controller(controller_name: str):
-    return HttpResponse('<%s></%s>' % (controller_name,controller_name), content_type="text/html")
+    return HttpResponse('<%s></%s>' % (controller_name, controller_name), content_type="text/html")

{simpledomcontrol-0.55.3 → simpledomcontrol-0.56.0}/sdc_core/template_files/Assets/gulpfile.jsx

@@ -1,8 +1,10 @@
 'use strict'
 
 const {src, dest, series, parallel} = require('gulp');
-const path = require("path");
 const webpack = require('webpack-stream');
+const copy = require('gulp-copy');
+
+process.env.JS_CILENT_FILE_EXTENTIONS = ['.js', '.json'];
 
 const {
     sdc_scss,
@@ -20,11 +22,20 @@ function webpack_javascript() {
         .pipe(dest('../static'));
 }
 
+function copy_statics() {
+    return src('./static/**/*')
+        .pipe(copy('../static', { prefix: 1 }))
+        .on('end', () => {
+            console.log('Contents copied successfully!');
+        });
+}
+
 exports.webpack = webpack_javascript;
 exports.scss = sdc_scss;
 exports.link_files = sdc_link_files;
 exports.clean = sdc_clean;
-exports.default = sdc_default_build_factory(webpack_javascript);
+exports.copy_statics = copy_statics;
+exports.default = series(copy_statics, sdc_default_build_factory(webpack_javascript));
 exports.watch_scss = sdc_watch_scss;
 exports.watch_webpack = sdc_watch_webpack_factory(webpack_javascript);
 

{simpledomcontrol-0.55.3 → simpledomcontrol-0.56.0}/sdc_core/template_files/controller/template_controller.js.txt

@@ -7,12 +7,26 @@ class §CONTROLLERNAMETITLE§Controller extends AbstractSDC {
         super();
         this.contentUrl = "§TEMPLATEURL§"; //§TAGNAME§
 
+        /**
+         * Uncomment the following line to make sure the HTML template
+         * of this controller is not cached and reloaded for every instance
+         * of this controller.
+         */
+        // this.contentReload = true;
+
+        /**
+         * Uncomment the following line to make this controller asynchronous.
+         * This means that the parent controller finishes loading without
+         * waiting for this controller
+         */
+        // this.load_async = true;
+
         /**
          * Events is an array of dom events.
          * The pattern is {'event': {'dom_selector': handler}}
-         * Uncommend the following line to add events;
+         * Uncomment the following line to add events;
          */
-        // this.events.unshift({'click': {'.header-sample': (ev, $elem)=> $elem.css('border', '2px solid black')}}});
+        // this.events.unshift({'click': {'.header-sample': (ev, $elem)=> $elem.css('border', '2px solid black')}});
     }
 
     //-------------------------------------------------//

{simpledomcontrol-0.55.3 → simpledomcontrol-0.56.0}/sdc_core/template_files/package.json

@@ -75,6 +75,6 @@
     "esm": "^3.2.25",
     "jquery": "^3.7.0",
     "lodash": "^4.17.21",
-    "sdc_client": "^0.55.3"
+    "sdc_client": "^0.56.0"
   }
 }

{simpledomcontrol-0.55.3 → simpledomcontrol-0.56.0}/sdc_tools/Assets/src/sdc_tools/controller/sdc_navigator/sdc_navigator.js

@@ -549,10 +549,6 @@ export class SdcNavigatorController extends AbstractSDC {
     }
 
     login() {
-        window.addEventListener("beforeunload", function(e){
-            // Do something
-            e.preventDefault();
-        }, false);
         location.reload();
     }
 

simpledomcontrol-0.55.3/README.md

@@ -1 +0,0 @@
-simpleDomControl