django-fast-treenode 1.1.2__py3-none-any.whl → 2.0.0__py3-none-any.whl

treenode/static/treenode/css/treenode_admin.css

@@ -0,0 +1,106 @@
+/* 
+TreeNode Admin Stylesheet
+
+This CSS file defines styles for the TreeNode admin interface, 
+including tree structure visualization, interactive toggles, 
+and theme support.
+
+Features:
+- Tree node toggle styling for expanding/collapsing nodes.
+- Supports both light and dark themes.
+- Smooth hover effects and animations.
+- Consistent layout adjustments for better UI interaction.
+
+Version: 2.0.0
+Author: Timur Kady
+Email: timurkady@yandex.com
+*/
+
+
+@keyframes anim {
+    0% {width: 0px; height: 0px;}
+    100% {width: 100px; height: 100px;}
+}
+
+.treenode-space {
+    display: inline-block;
+    width: 10px;
+    height: 10px;
+    margin-top: 0px;
+    margin-bottom: 0px;
+    margin-right: 7px !important;
+    background-color: transparent;
+    border: 1px solid transparent;
+    padding: 1px;
+}
+
+.treenode-toggle {
+    display: inline-block;
+    text-align: center;
+    font-weight: bold;
+    font-size: 10px;
+    width: 10px;
+    height: 10px;
+    line-height: 10px;
+    padding: 1px;
+    cursor: pointer;
+    margin-top: 0px;
+    margin-bottom: 0px;
+    margin-right: 7px !important;
+    border: 1px solid #ddd;
+    border-radius: 4px;
+    transition: background-color 0.2s ease, color 0.2s ease;
+}
+
+.treenode-toggle:hover {
+    background-color: #e0e0e0;
+    color: #007bff;
+}
+
+.dark-theme .treenode-toggle {
+    color: #ccc;
+    background-color: #444;
+    border: 1px solid #555;
+}
+
+.dark-theme .treenode-toggle:hover {
+    background-color: #333;
+    color: #fff;
+}
+
+.treenode-toggle {
+    font-weight: bold;
+    display: inline-block;
+
+    text-align: center;
+    cursor: pointer;
+    margin-right: 5px;
+    border-radius: 4px;
+
+    padding: 2px;
+    transition: background-color 0.2s ease, color 0.2s ease;
+}
+
+.treenode-toggle:hover {
+    background-color: #e0e0e0;
+    color: #007bff;
+}
+
+.dark-theme .treenode-toggle {
+    color: #ccc;
+    background-color: #444;
+    border: 1px solid #555;
+}
+
+.dark-theme .treenode-toggle:hover {
+    background-color: #333;
+    color: #fff;
+}
+
+.treenode-wrapper {
+    display: inline-block;
+}
+
+.dark-theme .treenode-toggle {
+    color: #ccc;
+}

treenode/static/treenode/js/tree_widget.js

@@ -0,0 +1,161 @@
+/* 
+TreeNode Select2 Widget
+
+This script enhances the Select2 dropdown widget for hierarchical data 
+representation in Django admin. It supports AJAX data fetching and ensures 
+a structured tree-like display.
+
+Features:
+- Dynamically initializes Select2 on elements with the class `tree-widget`.
+- Retrieves data via AJAX and displays it with proper indentation.
+- Supports dark mode and automatically applies theme styling.
+- Handles parent-child relationships and updates node priorities.
+
+Version: 2.0.0
+Author: Timur Kady
+Email: timurkady@yandex.com
+*/
+
+
+(function ($) {
+    "use strict";
+
+    /**
+     * Initializes Select2 on all elements with the class "tree-widget".
+     * Ensures proper AJAX data fetching and hierarchical display.
+     */
+    function initializeSelect2() {
+        $(".tree-widget").each(function () {
+            var $widget = $(this);
+            var url = $widget.data("url"); // Fetch the data URL for AJAX requests
+
+            if (!url) {
+                console.error("Error: Missing data-url for", $widget.attr("id"));
+                return;
+            }
+
+            // Initialize Select2 with AJAX support
+            $widget.select2({
+                ajax: {
+                    url: url,
+                    dataType: "json",
+                    delay: 250, // Introduces a delay to avoid excessive API calls
+                    data: function (params) {
+                        var forwardData = $widget.data("forward") || {}; // Retrieve forwarded model data
+                        return {
+                            q: params.term, // Search query parameter
+                            model: forwardData.model || null, // Pass the model name
+                        };
+                    },
+                    processResults: function (data) {
+                        if (!data.results) {
+                            return { results: [] }; // Return an empty array if no results exist
+                        }
+                        return { results: data.results };
+                    },
+                },
+                minimumInputLength: 0, // Allows opening the dropdown without typing
+                allowClear: true, // Enables the "clear selection" button
+                width: "100%", // Expands the dropdown to fit the parent container
+                templateResult: formatTreeResult, // Custom rendering function for hierarchical display
+            });
+
+            // Immediately apply theme styling after Select2 initialization
+            var select2Instance = $widget.data("select2");
+            if (select2Instance && isDarkTheme()) {
+                select2Instance.$container
+                    .find(".select2-selection--single")
+                    .addClass("dark-theme"); // Apply dark mode styling if enabled
+            }
+        });
+    }
+
+    /**
+     * Checks whether dark mode is enabled.
+     * It relies on the presence of the `data-theme="dark"` attribute on the <html> tag.
+     * @returns {boolean} - True if dark mode is active, false otherwise.
+     */
+    function isDarkTheme() {
+        return document.documentElement.getAttribute("data-theme") === "dark";
+    }
+
+    /**
+     * Applies or removes the `.dark-theme` class to the Select2 dropdown and container.
+     * Ensures the dropdown styling follows the selected theme.
+     */
+    function applyTheme() {
+        var dark = isDarkTheme(); // Check if dark mode is enabled
+        var $dropdown = $(".select2-container--open .select2-dropdown"); // Get the currently open dropdown
+        var $container = $(".select2-container--open .select2-selection--single"); // Get the selection box
+
+        if (dark) {
+            $dropdown.addClass("dark-theme");
+            $container.addClass("dark-theme");
+        } else {
+            $dropdown.removeClass("dark-theme");
+            $container.removeClass("dark-theme");
+        }
+    }
+
+    /**
+     * Formats each result in the Select2 dropdown to visually represent hierarchy.
+     * Adds indentation based on node depth and assigns folder/file icons.
+     * @param {Object} result - A single result object from the AJAX response.
+     * @returns {jQuery} - A formatted span element with the tree structure.
+     */
+    function formatTreeResult(result) {
+        if (!result.id) {
+            return result.text; // Return plain text for placeholder options
+        }
+        var level = result.level || 0; // Retrieve node depth (default: 0)
+        var is_leaf = result.is_leaf || false; // Determine if it's a leaf node
+        var indent = "&nbsp;&nbsp;".repeat(level); // Create indentation based on depth
+        var icon = is_leaf ? "📄 " : "📂 "; // Use 📄 for leaves, 📂 for parent nodes
+        return $("<span>" + indent + icon + result.text + "</span>"); // Return formatted text
+    }
+
+    /**
+     * Binds event listeners and initializes Select2.
+     * Ensures correct theme application on page load and during interactions.
+     */
+    $(document).ready(function () {
+        initializeSelect2();
+        applyTheme();
+
+        // When a Select2 dropdown opens, update its theme
+        $(document).on("select2:open", function () {
+            applyTheme();
+        });
+
+        // When the theme toggle button is clicked, reapply the theme
+        $(document).on("click", ".theme-toggle", function () {
+            applyTheme();
+        });
+
+        // When a parent changes, get the number of its children and set tn_priority
+        $("#id_tn_parent").on("change", function () {
+            var parentId = $(this).val();
+            var model = $(this).data("forward") ? $(this).data("forward").model : null;
+
+            if (!parentId || !model) {
+                console.log("No parent selected or model is missing.");
+                return;
+            }
+
+            $.ajax({
+                url: "/treenode/get-children-count/",
+                data: { parent_id: parentId, model: model },
+                dataType: "json",
+                success: function (response) {
+                    if (response.children_count !== undefined) {
+                        $("#id_tn_priority").val(response.children_count);  // Set the value
+                    }
+                },
+                error: function () {
+                    console.error("Failed to fetch children count.");
+                }
+            });
+        });
+    });
+
+})(django.jQuery || window.jQuery);

treenode/static/treenode/js/treenode_admin.js

@@ -0,0 +1,171 @@
+/* 
+TreeNode Admin JavaScript
+
+This script enhances the Django admin interface with interactive 
+tree structure visualization. It provides expand/collapse functionality 
+for hierarchical data representation.
+
+Features:
+- Dynamically detects parent-child relationships in the admin table.
+- Allows nodes to be expanded and collapsed with smooth animations.
+- Saves expanded/collapsed states in localStorage for persistence.
+- Optimizes tree traversal with efficient DOM manipulation.
+
+Version: 2.0.0
+Author: Timur Kady
+Email: timurkady@yandex.com
+*/
+
+(function($) {
+    $(document).ready(function() {
+        // Mapping parent node -> list of child nodes
+        var childrenMap = {};
+
+        // Iterate over all tree nodes to build a mapping of parent-child relationships
+        $('.treenode, .treenode-wrapper').each(function() {
+            var parent = $(this).data('treenode-parent'); // Get parent ID
+            var pk = $(this).data('treenode-pk'); // Get node primary key
+            
+            if (parent) {
+                if (!childrenMap[parent]) {
+                    childrenMap[parent] = [];
+                }
+                childrenMap[parent].push(pk);
+            }
+        });
+
+        // Initialize tree nodes, set up toggles
+        $('.treenode, .treenode-wrapper').each(function() {
+            var $node = $(this);
+            var pk = $node.data('treenode-pk'); // Get current node ID
+            var depth = parseInt($node.data('treenode-depth'), 10) || 0; // Get tree depth level
+            var $tr = $node.closest('tr'); // Find the corresponding row in the table
+            $tr.attr('data-treenode-depth', depth);
+            $tr.attr('data-treenode-pk', pk);
+
+            var $th = $tr.find('th:first');
+            if ($th.find('.treenode-space, .treenode-toggle').length === 0) {
+                var $placeholder = $('<span class="treenode-space"> </span>')
+                    .css('margin-left', (depth * 20) + 'px'); // Indentation based on depth
+                $th.prepend($placeholder);
+            }
+
+            // If node has children, add expand/collapse toggle
+            if (childrenMap[pk]) {
+                var expanded = loadState(pk);
+                var $placeholder = $th.find('.treenode-space');
+                var $toggle = $('<span class="treenode-toggle button"></span>')
+                    .css('margin-left', (depth * 20) + 'px');
+                
+                if (expanded) {
+                    $toggle.addClass('expanded').text('-');
+                } else {
+                    $toggle.addClass('collapsed').text('+');
+                }
+                $placeholder.replaceWith($toggle);
+                
+                if (!expanded) {
+                    collapseNode($tr, true);
+                }
+
+                // Toggle node expansion/collapse on click
+                $toggle.on('click', function() {
+                    if ($(this).hasClass('expanded')) {
+                        collapseNode($tr, false);
+                        $(this).removeClass('expanded').addClass('collapsed').text('+');
+                        saveState(pk, false);
+                    } else {
+                        expandNode($tr);
+                        $(this).removeClass('collapsed').addClass('expanded').text('-');
+                        saveState(pk, true);
+                    }
+                });
+            }
+        });
+
+        // Apply initial collapsed states based on saved preferences
+        function applyCollapsedStates() {
+            $('tr').each(function() {
+                var $tr = $(this);
+                var currentDepth = parseInt($tr.attr('data-treenode-depth'), 10);
+                var hide = false;
+                
+                // Check if any ancestor is collapsed
+                $tr.prevAll('tr').each(function() {
+                    var $prev = $(this);
+                    var prevDepth = parseInt($prev.attr('data-treenode-depth'), 10);
+                    if (prevDepth < currentDepth) {
+                        var parentPk = $prev.attr('data-treenode-pk');
+                        if (loadState(parentPk) === false) {
+                            hide = true;
+                        }
+                        return false;
+                    }
+                });
+                
+                if (hide) {
+                    $tr.hide();
+                }
+            });
+        }
+        applyCollapsedStates();
+
+        // Collapse a node and all its descendants
+        function collapseNode($tr, immediate) {
+            var parentDepth = parseInt($tr.attr('data-treenode-depth'), 10);
+            var $nextRows = $tr.nextAll('tr');
+            $nextRows.each(function() {
+                var $row = $(this);
+                var rowDepth = parseInt($row.attr('data-treenode-depth'), 10);
+                if (rowDepth > parentDepth) {
+                    if (immediate) {
+                        $row.hide();
+                    } else {
+                        $row.slideUp(300);
+                    }
+                    var childPk = $row.attr('data-treenode-pk');
+                    saveState(childPk, false);
+                } else {
+                    return false;
+                }
+            });
+        }
+
+        // Expand a node and reveal its immediate children
+        function expandNode($tr) {
+            var parentDepth = parseInt($tr.attr('data-treenode-depth'), 10);
+            var $nextRows = $tr.nextAll('tr');
+            $nextRows.each(function() {
+                var $row = $(this);
+                var rowDepth = parseInt($row.attr('data-treenode-depth'), 10);
+                if (rowDepth > parentDepth) {
+                    if (rowDepth === parentDepth + 1) {
+                        $row.slideDown('slow');
+                        var childPk = $row.attr('data-treenode-pk');
+                        if (loadState(childPk)) {
+                            expandNode($row);
+                        }
+                    }
+                } else {
+                    return false;
+                }
+            });
+        }
+
+        // Save expansion state to localStorage
+        function saveState(pk, isExpanded) {
+            if (window.localStorage) {
+                localStorage.setItem('treenode_state_' + pk, isExpanded ? '1' : '0');
+            }
+        }
+
+        // Load expansion state from localStorage
+        function loadState(pk) {
+            if (window.localStorage) {
+                var state = localStorage.getItem('treenode_state_' + pk);
+                return state === '1';
+            }
+            return true;
+        }
+    });
+})(django.jQuery || window.jQuery);

treenode/templates/admin/export_success.html

@@ -0,0 +1,26 @@
+{% extends "admin/base_site.html" %}
+{% load i18n %}
+{% block title %}{% trans "Export Successful" %}{% endblock %}
+
+{% block content %}
+<div class="module" style="margin-top: 20px;">
+  <h2>{{ message }}</h2>
+  <div class="module ">
+    <p>{{ manual_download_label }}</p>
+    <p><a id="dl" href="{{ download_url }}" class="button">Download</a></p>
+  </div>
+  <p>
+    <input type="button" class="button" value="{{ button_text }}" onclick="window.location.href='{{ redirect_url }}';">
+  </p>
+
+</div>
+
+<script type="text/javascript">
+    // When the page loads, create a hidden iframe to initiate the download
+
+    window.onload = function() {
+        document.getElementById("dl").click();
+    };
+</script>
+{% endblock %}
+

treenode/templates/admin/tree_node_changelist.html

@@ -0,0 +1,11 @@
+{% extends "admin/change_list.html" %}
+
+{% block object-tools-items %}
+    {{ block.super }}
+    <li>
+        <a href="import/" class="button">Import</a>
+    </li>
+    <li>
+        <a href="export/" class="button">Export</a>
+    </li>
+{% endblock %}

treenode/templates/admin/tree_node_export.html

@@ -0,0 +1,27 @@
+{% extends "admin/base_site.html" %}
+{% load i18n %}
+{% block content %}
+<div class="module">
+  <h2>{% trans "Export Tree Node Data" %}</h2>
+  <form method="get" class="form-horizontal" style="margin-top: 20px;">
+    <div class="form-group">
+      <label for="format" class="col-sm-2 control-label">{% trans "Select format:" %}</label>
+      <div class="col-sm-10">
+        <select name="format" id="format" class="form-control">
+          <option value="csv">CSV</option>
+          <option value="json">JSON</option>
+          <option value="xlsx">{% trans "Excel (XLSX)" %}</option>
+          <option value="yaml">YAML</option>
+          <option value="tsv">TSV</option>
+        </select>
+      </div>
+    </div>
+    <div class="form-group" style="margin-top: 35px;">
+      <div class="col-sm-offset-2 col-sm-10">
+        <button type="submit" class="button">{% trans "Export" %}</button>
+        <a href=".." class="button default">{% trans "Cancel" %}</a>
+      </div>
+    </div>
+  </form>
+</div>
+{% endblock %}

treenode/templates/admin/tree_node_import.html

@@ -0,0 +1,27 @@
+{% extends "admin/base_site.html" %}
+{% block content %}
+    <div class="module">
+        <h2>Import Data</h2>
+        {% if errors %}
+            <div class="errornote">
+                <p>Errors occurred while importing the data:</p>
+                <ul>
+                    {% for error in errors %}
+                        <li>{{ error }}</li>
+                    {% endfor %}
+                </ul>
+            </div>
+        {% endif %}
+        <form method="post" enctype="multipart/form-data">
+            {% csrf_token %}
+            <div>
+                <label for="file">Choose file:</label>
+                <input type="file" name="file" id="file" required>
+            </div>
+            <div class="form-group" style="margin-top: 35px;">
+                <button type="submit" class="button">Import</button>
+                <a href=".." class="button cancel">Cancel</a>
+            </div>
+        </form>
+    </div>
+{% endblock %}

treenode/templates/widgets/tree_widget.css

@@ -0,0 +1,23 @@
+/* Light mode */
+.select2-container--default.select2-light .select2-selection {
+    background-color: #fff;
+    color: #333;
+    border: 1px solid #ccc;
+}
+
+.select2-container--default.select2-light .select2-dropdown {
+    background-color: #fff;
+    color: #333;
+}
+
+/* Dark mode */
+.select2-container--default.select2-dark .select2-selection {
+    background-color: #222;
+    color: #ddd;
+    border: 1px solid #444;
+}
+
+.select2-container--default.select2-dark .select2-dropdown {
+    background-color: #222;
+    color: #ddd;
+}

treenode/templates/widgets/tree_widget.html

@@ -0,0 +1,21 @@
+{# templates/widgets/tree_widget.html #}
+{% load widget_tweaks %}
+<select name="{{ widget.name }}" {% include "django/forms/widgets/attrs.html" %}>
+  {% if widget.optgroups %}
+    {% for group, options, index in widget.optgroups %}
+      {% if group %}
+        <optgroup label="{{ group }}">
+      {% endif %}
+      {% for option in options %}
+        <option value="{{ option.value|stringformat:'s' }}"
+                data-level="{{ option.attrs.data_level|default:"0" }}"
+                {% if option.selected %}selected{% endif %}>
+          {{ option.label }}
+        </option>
+      {% endfor %}
+      {% if group %}
+        </optgroup>
+      {% endif %}
+    {% endfor %}
+  {% endif %}
+</select>

treenode/urls.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+"""
+TreeNode URL Configuration
+
+This module defines URL patterns for handling AJAX requests related
+to tree-structured data in Django. It includes endpoints for Select2
+autocomplete and retrieving child node counts.
+
+Routes:
+- `tree-autocomplete/`: Returns JSON data for Select2 hierarchical selection.
+- `get-children-count/`: Retrieves the number of children for a given 
+  parent node.
+
+Version: 2.0.0
+Author: Timur Kady
+Email: timurkady@yandex.com
+"""
+
+
+from django.urls import path
+from .views import TreeNodeAutocompleteView, GetChildrenCountView
+
+urlpatterns = [
+    path(
+        "tree-autocomplete/",
+        TreeNodeAutocompleteView.as_view(),
+        name="tree_autocomplete"
+    ),
+    path(
+        "get-children-count/",
+        GetChildrenCountView.as_view(),
+        name="get_children_count"
+    ),
+]

treenode/utils/__init__.py

@@ -0,0 +1,4 @@
+from .exporter import TreeNodeExporter
+from .importer import TreeNodeImporter
+
+__all__ = ["TreeNodeExporter", "TreeNodeImporter"]

treenode/utils/base36.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+"""
+Base36 Utility Module
+
+This module provides a utility function for converting integers
+to Base36 string representation.
+
+Features:
+- Converts integers into a more compact Base36 format.
+- Maintains lexicographic order when padded with leading zeros.
+- Supports negative numbers.
+
+Version: 2.0.0
+Author: Timur Kady
+Email: timurkady@yandex.com
+"""
+
+
+def to_base36(num):
+    """
+    Convert an integer to a base36 string.
+
+    For example: 10 -> 'A', 35 -> 'Z', 36 -> '10', etc.
+    """
+    digits = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+
+    if num == 0:
+        return '0'
+    sign = '-' if num < 0 else ''
+    num = abs(num)
+    result = []
+    while num:
+        num, rem = divmod(num, 36)
+        result.append(digits[rem])
+    return sign + ''.join(reversed(result))