2.0

.github/workflows/docs.yml

@@ -11,10 +11,15 @@ jobs:
     - uses: actions/setup-python@v4
     - uses: actions/setup-node@v3
       with:
-        node-version: 16
+        node-version: 18 # minimum required for dependencies
 
     - run: npm install -g @mermaid-js/mermaid-cli
 
+    - name: Corepack
+      run: |
+        npm install --global corepack@latest
+        corepack enable
+
     - name: Install Project
       run: make install
 

.gitignore

@@ -12,17 +12,18 @@
 /constraints-mxdev.txt
 /coverage/
 /dist/
-/docs/Makefile
 /docs/cone.app.zip
 /docs/doctrees/
 /docs/html/
 /docs/latex/
 /docs/make.bat
+/docs/Makefile
 /htmlcov/
 /js/karma/
 /node_modules/
 /package-lock.json
 /pip-selfcheck.json
+/pnpm-lock.yaml
 /pyvenv.cfg
 /requirements-mxdev.txt
 /sources/

CHANGES.rst

@@ -1,6 +1,20 @@
 Changes
 =======
 
+2.0a1 (unreleased)
+------------------
+
+- Cleanup js widgets to prevent DOM memory leaks.
+  [lenadax]
+
+- Remove no longer used ``content_grid_width`` and ``sidebar_left_grid_width``
+  properties from ``ILayoutConfig``.
+  [rnix]
+
+- Run tests on bootstrap5 factory theme.
+  [lenadax]
+
+
 1.1.0 (unreleased)
 ------------------
 

Makefile

@@ -10,11 +10,12 @@
 #: docs.sphinx
 #: i18n.gettext
 #: i18n.lingua
-#: js.karma
 #: js.nodejs
 #: js.rollup
 #: js.scss
+#: js.wtr
 #: qa.coverage
+#: qa.ruff
 #: qa.test
 #
 # SETTINGS (ALL CHANGES MADE BELOW SETTINGS WILL BE LOST)
@@ -32,7 +33,7 @@ RUN_TARGET?=
 
 # Additional files and folders to remove when running clean target
 # No default value.
-CLEAN_FS?=
+CLEAN_FS?=pnpm-lock.yaml
 
 # Optional makefile to include before default targets. This can
 # be used to provide custom targets or hook up to existing targets.
@@ -45,20 +46,19 @@ INCLUDE_MAKEFILE?=include.mk
 # No default value.
 EXTRA_PATH?=
 
+## js.nodejs
+
+# The package manager to use. Defaults to `npm`. Possible values
+# are `npm` and `pnpm`
+# Default: npm
+NODEJS_PACKAGE_MANAGER?=pnpm
 # Path to Python project relative to Makefile (repository root).
 # Leave empty if Python project is in the same directory as Makefile.
 # For monorepo setups, set to subdirectory name (e.g., `backend`).
 # Future-proofed for multi-language monorepos (e.g., PROJECT_PATH_NODEJS).
 # No default value.
 PROJECT_PATH_PYTHON?=
 
-## js.nodejs
-
-# The package manager to use. Defaults to `npm`. Possible values
-# are `npm` and `pnpm`
-# Default: npm
-NODEJS_PACKAGE_MANAGER?=npm
-
 # Value for `--prefix` option when installing packages.
 # Default: .
 NODEJS_PREFIX?=.
@@ -84,6 +84,16 @@ NODEJS_OPT_PACKAGES?=
 # No default value.
 NODEJS_INSTALL_OPTS?=
 
+## js.wtr
+
+# Web test runner config file.
+# Default: wtr.config.mjs
+WTR_CONFIG?=js/wtr.config.mjs
+
+# Web test runner additional command line options.
+# Default: --coverage
+WTR_OPTIONS?=--coverage
+
 ## js.scss
 
 # The SCSS root source file.
@@ -108,16 +118,6 @@ SCSS_OPTIONS?=--no-source-map=none
 # Default: rollup.conf.js
 ROLLUP_CONFIG?=js/rollup.conf.js
 
-## js.karma
-
-# Karma config file.
-# Default: karma.conf.js
-KARMA_CONFIG?=js/karma.conf.js
-
-# Karma additional command line options.
-# Default: --single-run
-KARMA_OPTIONS?=--single-run
-
 ## core.mxenv
 
 # Primary Python interpreter to use. It is used to create the
@@ -174,6 +174,12 @@ MXDEV?=mxdev
 # Default: mxmake
 MXMAKE?=mxmake
 
+## qa.ruff
+
+# Source folder to scan for Python files to run ruff on.
+# Default: src
+RUFF_SRC?=src
+
 ## docs.sphinx
 
 # Documentation source folder.
@@ -343,6 +349,18 @@ INSTALL_TARGETS+=nodejs
 DIRTY_TARGETS+=nodejs-dirty
 CLEAN_TARGETS+=nodejs-clean
 
+##############################################################################
+# web test runner
+##############################################################################
+
+NODEJS_DEV_PACKAGES+=\
+	@web/test-runner \
+	@web/dev-server-import-maps
+
+.PHONY: wtr
+wtr: $(NODEJS_TARGET)
+	@web-test-runner $(WTR_OPTIONS) --config $(WTR_CONFIG)
+
 ##############################################################################
 # scss
 ##############################################################################
@@ -367,25 +385,11 @@ NODEJS_DEV_PACKAGES+=\
 rollup: $(NODEJS_TARGET)
 	@rollup --config $(ROLLUP_CONFIG)
 
-##############################################################################
-# karma
-##############################################################################
-
-NODEJS_DEV_PACKAGES+=\
-	karma \
-	karma-coverage \
-	karma-chrome-launcher \
-	karma-module-resolver-preprocessor
-
-.PHONY: karma
-karma: $(NODEJS_TARGET)
-	@karma start $(KARMA_CONFIG) $(KARMA_OPTIONS)
-
 ##############################################################################
 # mxenv
 ##############################################################################
 
-OS?=
+export OS:=$(OS)
 
 # Determine the executable path
 ifeq ("$(VENV_ENABLED)", "true")
@@ -500,6 +504,41 @@ INSTALL_TARGETS+=mxenv
 DIRTY_TARGETS+=mxenv-dirty
 CLEAN_TARGETS+=mxenv-clean
 
+##############################################################################
+# ruff
+##############################################################################
+
+RUFF_TARGET:=$(SENTINEL_FOLDER)/ruff.sentinel
+$(RUFF_TARGET): $(MXENV_TARGET)
+	@echo "Install Ruff"
+	@$(PYTHON_PACKAGE_COMMAND) install ruff
+	@touch $(RUFF_TARGET)
+
+.PHONY: ruff-check
+ruff-check: $(RUFF_TARGET)
+	@echo "Run ruff check"
+	@ruff check $(RUFF_SRC)
+
+.PHONY: ruff-format
+ruff-format: $(RUFF_TARGET)
+	@echo "Run ruff format"
+	@ruff format $(RUFF_SRC)
+
+.PHONY: ruff-dirty
+ruff-dirty:
+	@rm -f $(RUFF_TARGET)
+
+.PHONY: ruff-clean
+ruff-clean: ruff-dirty
+	@test -e $(MXENV_PYTHON) && $(MXENV_PYTHON) -m pip uninstall -y ruff || :
+	@rm -rf .ruff_cache
+
+INSTALL_TARGETS+=$(RUFF_TARGET)
+CHECK_TARGETS+=ruff-check
+FORMAT_TARGETS+=ruff-format
+DIRTY_TARGETS+=ruff-dirty
+CLEAN_TARGETS+=ruff-clean
+
 ##############################################################################
 # sphinx
 ##############################################################################

README.rst

@@ -29,6 +29,14 @@ The sources are in a GIT DVCS with its main branches at
 `github <http://github.com/conestack/cone.app>`_.
 
 
+Third Party Resources
+=====================
+
+- https://github.com/jquery/jquery
+- https://github.com/twbs/bootstrap
+- https://github.com/HatScripts/circle-flags
+
+
 Copyright
 =========
 

TODO.rst

@@ -1,65 +1,15 @@
-====
 TODO
 ====
 
-Docs
-====
-
-- Document expected permissions for tiles and actions
-- Create writing tests documenatation
-- Create twisted integration documentation
-- Create websocket integration documentation
-- Create tutorial extending ``cone.example``
-- Proper cross linking all over the place
-- Add proper API docs to code and include in docs.
-- Update javascript development docs (treibstoff/rollup)
-
-Upcoming
-========
-
-- Treibstoff migration docs.
-- Treibtroff AjaxOverlay docs.
-- Context bound toolbar and action (named utilities?).
-- Layout property for excluding entire navbar.
-- Reference blueprint -> use lookup function also for single value references
-  if present.
-- Consolidate "Unauthorized" and "Insufficient Privileges" tiles.
-- Check ``title`` of transition names before using ``name`` in workflow
-  dropdown.
-- Bind sharing view to ``cone.app.interfaces.IPrincipalACL``.
-- Fix ACL registry lookup. First check by cls and node info name, then by
-  class only and finally return default.
-- CopySupport is used both for marking containers supporting cut/copy/paste
-  and objects being copyable. Make dedicated interface/mechanism for marking
-  objects copyable.
-- Add template for creating ``cone.app`` plugins.
-- Overhaul plugin entry hooks staying closer to pyramid if possible.
-- Pyramid request wrapper for autobahn websocket requests to enable proper
-  security integration.
-- ``cone.tile.Tile`` should point to template at ``template`` instead of
-  ``path``.
-- Use ``BatchedItems`` as base for ``Table``.
-- Rename ``cone.app.browser.batch.Batch`` to
-  ``cone.app.browser.batch.Pagination`` providing B/C.
-- Provide a ``form_action`` property on ``cone.app.browser.form.Form``
-  considering ``action_resource`` attribute. Consolidate with
-  ``cone.app.browser.Form.YAMLForm.form_action``.
-- Test ``cone.app.browser.actions.DropdownAction`` with BS3.
-- ``cone.app.browser.copysupport#124``: trigger ``contextchanged`` on
-  ``#layout`` instead of ``.contextsensitiv``.
-- Get rid of remaining ``contextsensitiv`` CSS class related bdajax
-  bindings and remove ``contextsensitiv`` CSS class entirly from markup and
-  tests.
-- Consolidate ``cone.app.model.AppSettings.__acl__```and
-  ``cone.app.security.DEFAULT_SETTINGS_ACL`` which is not used yet in
-  ``cone.app``.
-- Fix lookup in ACL registry. First node by class or base class and node
-  info name if given, Then by class or base class only if not found, then
-  by node info name only if no class given at lookup. Or so...
-- Create and use constants for all default roles and permissions.
-- Adopt livesearch JS intergration to provide hooks for passing typeahead
-  options and datasets instead of just datasets.
-- Sharing tile table sorting by principal title instead of principal id
-- Bind navtree to ``list`` permission?
-- Update jQuery.
-- Update bootstrap.
+- Upgrade pyramid to 2.0 for python 3.12 and higher. This is necessary because pyramid 1.9.4
+  depends on the imp module, which has been removed since python 3.12.
+- Main menu display children.
+- Custom root node in example.
+- Referencebrowser widget.
+- Treibstoff styles.
+- Yafowil bootstrap 5 styles.
+- Yafowil addon widgets.
+- SCSS splitting.
+- Reduce CSS class noise and add some custom rules to SCSS files.
+- Check if we can retrieve Bootstrap sources other than including in this repo
+  for development.

docs/source/layout.rst

@@ -64,8 +64,7 @@ one or more model classes with ``cone.app.layout_config`` decorator.
             self.columns_fluid = False
             self.pathbar = True
             self.sidebar_left = ['navtree']
-            self.sidebar_left_grid_width = 3
-            self.content_grid_width = 9
+            self.sidebar_right = ['my_tile']
 
 Provided layout settings:
 

docs/source/widgets.rst

@@ -422,7 +422,7 @@ Furthermore it's possible to register a view action for the contextmenu's
         interface=ExamplePlugin,
         permission='view',
         text='Details',
-        icon='glyphicons glyphicons-magic')
+        icon='bi bi-magic')
     class DetailsContentTile(Tile):
         """For this class a pyramid view is registered which is reachable
         under 'http://domain.com/path/to/node/details'. This view renders
@@ -1083,8 +1083,8 @@ More customization options on ``BatchedItems`` class:
 - **show_title**: Flag whether to show title in the listing header. Defaults
   to ``True``.
 
-- **title_css**: CSS classes to set on title container DOM element. Defaults
-  to ``col-xs-4``. Can be used to change the size of the title area.
+- **title_css**: CSS classes to set on title container DOM element.
+Can be used to change the size of the title area.
 
 - **default_slice_size**: Default number of items displayed in slice. Defaults
   to ``15``.
@@ -1095,14 +1095,14 @@ More customization options on ``BatchedItems`` class:
   listing header. Defaults to ``True``.
 
 - **slice_size_css**: CSS classes to set on slice size selection container DOM
-  element. Defaults to ``col-xs-4 col-sm3``. Can be used to change the size
+  element. Can be used to change the size
   of the slice size selection.
 
 - **show_filter**: Flag whether to display the search filter input in listing
   header. Defaults to ``True``.
 
 - **filter_css**: CSS classes to set on search filter input container DOM
-  element. Defaults to ``col-xs-3``. Can be used to change the size
+  Can be used to change the size
   of the search filter input.
 
 - **head_additional**: Additional arbitrary markup rendered in listing header.