aa-fleetfinder 2.6.0__py3-none-any.whl → 2.7.0__py3-none-any.whl

fleetfinder/templates/fleetfinder/dashboard.html

@@ -19,12 +19,7 @@
                             <th>{% translate "Fleet commander" %}</th>
                             <th>{% translate "Fleet name" %}</th>
                             <th>{% translate "Created at" %}</th>
-                            <th>{% translate "Join" %}</th>
-
-                            {% if perms.fleetfinder.manage_fleets %}
-                                <th>{% translate "Details" %}</th>
-                                <th>{% translate "Edit" %}</th>
-                            {% endif %}
+                            <th class="text-end"><!-- {% translate "Join" %} --></th>
                         </tr>
                     </thead>
 
@@ -43,20 +38,33 @@
 {% block extra_javascript %}
     {% include "bundles/datatables-js-bs5.html" %}
     {% include "bundles/moment-js.html" with locale=True %}
+    {% include "fleetfinder/bundles/js/fleetfinder-js.html" %}
 
     {% get_datatables_language_static LANGUAGE_CODE as DT_LANG_PATH %}
 
     <script>
+        /* global fetchGet, fleetfinderBootstrapTooltip, DataTable */
+        'use strict';
+
         $(document).ready(() => {
             const DATETIME_FORMAT = 'YYYY-MM-DD, HH:mm';
             const table_fleet_overview = $('#table_available-fleets');
+            let dataTable = null;
 
             /**
-             * Initialize the datatable for fleet overview
+             * Initialize or update the datatable.
+             * If the table already exists, it will be updated with new data.
+             * If it does not exist, a new DataTable will be created.
+             *
+             * @param {Object} data - The fleet data to populate the table.
              */
-            fetchGet({url: '{% url "fleetfinder:ajax_dashboard" %}'})
-                .then((data) => {
-                    table_fleet_overview.DataTable({
+            const initializeOrUpdateTable = (data) => {
+                if (dataTable) {
+                    // Update existing table
+                    dataTable.clear().rows.add(data).draw();
+                } else {
+                    // Initialize new table
+                    dataTable = table_fleet_overview.DataTable({
                         language: {
                             url: '{{ DT_LANG_PATH }}'
                         },
@@ -69,15 +77,16 @@
                                     sort: 'sort'
                                 }
                             },
-                            {data: 'fleet_name'},
+                            {
+                                data: 'fleet_name'
+                            },
                             {
                                 data: 'created_at',
                             },
-                            {data: 'join'},
-                            {% if perms.fleetfinder.manage_fleets %}
-                                {data: 'details'},
-                                {data: 'edit'},
-                            {% endif %}
+                            {
+                                data: 'actions',
+                                className: 'text-end',
+                            },
                         ],
                         columnDefs: [
                             {
@@ -88,66 +97,32 @@
                                 orderable: false,
                                 targets: [3]
                             },
-                            {% if perms.fleetfinder.manage_fleets %}
-                                {
-                                    orderable: false,
-                                    targets: [4, 5]
-                                },
-                            {% endif %}
                         ],
                         order: [[0, 'asc']],
                         paging: false
                     });
-                })
-                .catch((error) => {
-                    console.error('Error fetching fleet data:', error);
-                });
+                }
 
-            /**
-             * Refresh the datatable information every 30 seconds
-             */
-            const intervalReloadDatatable = 30000; // ms
-            let expectedReloadDatatable = Date.now() + intervalReloadDatatable;
+                // Initialize Bootstrap tooltips
+                fleetfinderBootstrapTooltip({selector: '#table_available-fleets'});
+            };
 
             /**
-             * reload datatable "fleetfinderFleetsTable"
+             * Fetch and update fleet data
              */
-            const reloadDataTable = () => {
-                const dt = Date.now() - expectedReloadDatatable; // The drift (positive for overshooting)
-
-                if (dt > intervalReloadDatatable) {
-                    // Something awful happened. Maybe the browser (tab) was inactive?
-                    // Possibly special handling to avoid futile "catch up" run
-                    console.log('Something went wrong, reloading page ...');
-
-                    window.location.replace(
-                        window.location.pathname + window.location.search + window.location.hash
-                    );
-                }
-
+            const fetchFleetData = () => {
                 fetchGet({url: '{% url "fleetfinder:ajax_dashboard" %}'})
-                    .then((newData) => {
-                        const dataTable = table_fleet_overview.DataTable();
-
-                        dataTable.clear().rows.add(newData).draw();
-                    })
+                    .then(initializeOrUpdateTable)
                     .catch((error) => {
-                        console.error('Error fetching updated data:', error);
+                        console.error('Error fetching fleet data:', error);
                     });
-
-                expectedReloadDatatable += intervalReloadDatatable;
-
-                // Take drift into account
-                setTimeout(
-                    reloadDataTable,
-                    Math.max(0, intervalReloadDatatable - dt)
-                );
             };
 
-            setTimeout(
-                reloadDataTable,
-                intervalReloadDatatable
-            );
+            // Initial load
+            fetchFleetData();
+
+            // Refresh every 30 seconds
+            setInterval(fetchFleetData, 30000);
         });
     </script>
 {% endblock %}

fleetfinder/templates/fleetfinder/fleet-details.html

@@ -50,6 +50,7 @@
                                     <th>{% translate "Name" %}</th>
                                     <th>{% translate "Ship class" %}</th>
                                     <th>{% translate "System" %}</th>
+                                    <th><!-- {% translate "Action" %} --></th>
                                 </tr>
                             </thead>
 
@@ -60,6 +61,8 @@
             </div>
         </div>
     </div>
+
+    {% include "fleetfinder/modals/kick-fleet-member.html" %}
 {% endblock %}
 
 {% block extra_css %}
@@ -69,39 +72,83 @@
 
 {% block extra_javascript %}
     {% include "bundles/datatables-js-bs5.html" %}
+    {% include "fleetfinder/bundles/js/fleetfinder-js.html" %}
 
     {% get_datatables_language_static LANGUAGE_CODE as DT_LANG_PATH %}
 
+    {% translate "Fleet boss" as l10nFleetBoss %}
+    {% translate "Kick member from fleet" as l10nKickMemberFromFleet %}
+    {% translate "An unknown error occurred." as l10nUnknownError %}
+
     <script>
         $(document).ready(() => {
+            /* DataTables
+            ------------------------------------------------------------------------- */
             const table_fleet_members = $('#table_fleet_members');
-            const tabe_fleet_composition = $('#table_fleet_composition');
+            const table_fleet_composition = $('#table_fleet_composition');
+            const url = {
+                kickFleetMember: '{% url "fleetfinder:ajax_fleet_kick_member" fleet_id %}',
+                fleetDetails: '{% url "fleetfinder:ajax_fleet_details" fleet_id %}'
+            };
+            const dataTableConfig = {
+                language: {
+                    url: '{{ DT_LANG_PATH }}'
+                },
+                paging: false,
+                destroy: true
+            };
 
             const populateDatatables = () => {
                 fetchGet({
-                    url: '{% url "fleetfinder:ajax_fleet_details" fleet_id %}'
+                    url: url.fleetDetails,
                 })
                 .then((data) => {
                     table_fleet_members.DataTable({
-                        language: {
-                            url: '{{ DT_LANG_PATH }}'
-                        },
-                        destroy: true,
-                        paging: false,
+                        ...dataTableConfig,
                         data: data.fleet_member,
                         columns: [
-                            {data: 'character_name'},
+                            {
+                                render: (data, type, row) => {
+                                    const fwIcon = '<i class="fa-solid fa-star"></i>';
+
+                                    return row.is_fleet_boss
+                                        ? `${row.character_name} <sup data-bs-tooltip="aa-fleetfinder" title="{{ l10nFleetBoss|escapejs }}"><small>${fwIcon}</small></sup>`
+                                        : row.character_name;
+                                }
+                            },
                             {data: 'ship_type_name'},
-                            {data: 'solar_system_name'}
-                        ]
+                            {data: 'solar_system_name'},
+                            {
+                                render: (data, type, row) => {
+                                    const fwIcon = '<i class="fa-solid fa-user-minus"></i>';
+                                    const dataAttributes = Object.entries({
+                                        'data-character-id': row.character_id,
+                                        'data-character-name': row.character_name,
+                                        'data-bs-toggle': 'modal',
+                                        'data-bs-target': '#kick-fleet-member',
+                                        'data-bs-tooltip': 'aa-fleetfinder'
+                                    }).map(([key, value]) => {
+                                        return `${key}="${value}"`;
+                                    }).join(' ');
+
+                                    return row.is_fleet_boss
+                                        ? ''
+                                        : `<button type="button" class="btn btn-sm btn-danger" ${dataAttributes} title="{{ l10nKickMemberFromFleet|escapejs }}">${fwIcon}</button>`;
+                                },
+                                orderable: false,
+                                searchable: false,
+                                width: '50px',
+                                className: 'text-end'
+                            }
+                        ],
+                        createdRow: (row, data, rowIndex) => {
+                            $(row).attr('data-row-id', rowIndex);
+                            $(row).attr('data-character-id', data.character_id);
+                        }
                     });
 
-                    tabe_fleet_composition.DataTable({
-                        language: {
-                            url: '{{ DT_LANG_PATH }}'
-                        },
-                        destroy: true,
-                        paging: false,
+                    table_fleet_composition.DataTable({
+                        ...dataTableConfig,
                         data: data.fleet_composition,
                         columns: [
                             {data: 'ship_type_name'},
@@ -110,30 +157,74 @@
                         order: [[1, 'desc']]
                     });
                 })
+                .then(() => {
+                    // Initialize tooltips for the kick buttons
+                    fleetfinderBootstrapTooltip({selector: '#table_fleet_members'});
+                })
                 .catch((error) => {
                     console.error('Error fetching fleet details:', error);
                 });
             };
 
-            table_fleet_members.DataTable({
-                language: {
-                    url: '{{ DT_LANG_PATH }}'
-                },
-                paging: false,
-            });
-
-            tabe_fleet_composition.DataTable({
-                language: {
-                    url: '{{ DT_LANG_PATH }}'
-                },
-                paging: false,
-            });
-
             populateDatatables();
 
-            setInterval(function () {
-                populateDatatables();
-            }, 30000);
+            setInterval(populateDatatables, 30000);
+
+            /* Modals
+            ------------------------------------------------------------------------- */
+            // Handle the kick fleet member modal
+            $('#kick-fleet-member')
+                .on('show.bs.modal', (event) => {
+                    const button = $(event.relatedTarget);
+                    const characterId = button.data('character-id');
+                    const characterName = button.data('character-name');
+                    const link = url.kickFleetMember;
+                    const csrfToken = '{{ csrf_token }}';
+
+                    // Populate the modal content
+                    $('#kick-fleet-member-character-name').text(characterName);
+
+                    $('#modal-button-confirm-kick-fleet-member')
+                        // Remove any previous click handlers to avoid multiple bindings
+                        .off('click.kickMember')
+                        // Bind the click event for the confirmation button
+                        .on('click.kickMember', () => {
+                        fetchPost({
+                            url: link,
+                            csrfToken: csrfToken,
+                            payload: {
+                                memberId: characterId
+                            },
+                            responseIsJson: true
+                        })
+                        .then((data) => {
+                            if (data.success) {
+                                populateDatatables();
+
+                                $('#kick-fleet-member').modal('hide');
+                            } else {
+                                $('#kick-fleet-member .modal-kick-fleet-member-error')
+                                    .removeClass('d-none')
+                                    .find('.modal-kick-fleet-member-error-message')
+                                    .text(data.error || '{{ l10nUnknownError|escapejs }}');
+                            }
+                        })
+                        .catch((error) => {
+                            console.error('Error kicking fleet member:', error);
+                        });
+                    });
+                })
+                .on('hide.bs.modal', () => {
+                    // Reset modal content
+                    $('#kick-fleet-member-character-name').empty();
+                    $('#kick-fleet-member .modal-kick-fleet-member-error')
+                        .addClass('d-none')
+                        .find('.modal-kick-fleet-member-error-message')
+                        .empty();
+
+                    // Clean up event handler
+                    $('#modal-button-confirm-kick-fleet-member').off('click.kickMember');
+                });
         });
     </script>
 {% endblock %}

fleetfinder/templates/fleetfinder/join-fleet.html

@@ -18,11 +18,21 @@
         <div class="card-body container">
             <div class="row">
                 <div class="align-self-center">
+                    <p>
+                        {% translate "Please ensure you don't have any CSPA charges set on your characters, as this will prevent fleet invites from being sent." %}
+                        <br>
+                        {% translate "You can select multiple characters to invite them all at once." %}
+                    </p>
+
+                    <p>
+                        {% translate "The selected characters will receive a fleet invite in-game, which they can accept to join the fleet." %}
+                    </p>
+
                     <form class="form-signin" role="form" action="" method="POST">
                         {% csrf_token %}
 
                         <div class="mb-3">
-                            <label for="character_ids">{% translate "Select the characters to invite" %}</label>
+                            <label for="character_ids" class="mb-1">{% translate "Please select the characters you want to invite:" %}</label>
 
                             <select class="multiselect-ui" multiple="multiple" name="character_ids" id="character_ids">
                                 {% for character in characters %}

fleetfinder/templates/fleetfinder/modals/kick-fleet-member.html

@@ -0,0 +1,46 @@
+{% load bootstrap %}
+{% load i18n %}
+
+<!-- kick fleet member modal -->
+<div class="modal fade" id="kick-fleet-member" tabindex="-1" role="dialog" aria-hidden="true">
+    <div class="modal-dialog modal-dialog-centered" role="document">
+        <div class="modal-content">
+            <div class="modal-header">
+                <div class="modal-title fs-5">
+                    {% translate "Kick member from fleet" %}
+                </div>
+
+                <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="{% translate 'Close' %}"></button>
+            </div>
+
+            <div class="modal-body">
+                <p>
+                    {% translate "Are you sure you want to kick this member from the fleet?" %}
+                </p>
+
+                <p>
+                    <strong id="kick-fleet-member-character-name"></strong>
+                </p>
+
+                <p class="aa-callout aa-callout-danger modal-kick-fleet-member-error d-none">
+                    <i class="fa-solid fa-triangle-exclamation"></i>
+                    {% translate "Error" %}
+                    <br>
+                    <span class="modal-kick-fleet-member-error-message"></span>
+                </p>
+            </div>
+
+            <div class="modal-footer">
+                <button id="modal-button-cancel-kick-fleet-member" type="button" class="btn btn-secondary btn-sm" data-bs-dismiss="modal">
+                    <i class="fa-regular fa-hand"></i>
+                    {% translate "Cancel" %}
+                </button>
+
+                <button id="modal-button-confirm-kick-fleet-member" type="button" class="btn btn-success btn-sm">
+                    <i class="fa-solid fa-check"></i>
+                    {% translate "Confirm" %}
+                </button>
+            </div>
+        </div>
+    </div>
+</div>

fleetfinder/templates/fleetfinder/partials/body/form-fleet-details.html

@@ -33,16 +33,16 @@
         </p>
     </div>
 
-    <div class="mb-3">
-        <label for="motd" class="control-label">{% translate "Fleet MOTD" %}</label>
-
-        <div>
-            <textarea class="form-control" name="motd" id="motd" rows="10">{% if motd %}{{ motd }}{% endif %}</textarea>
-        </div>
-    </div>
+{#    <div class="mb-3">#}
+{#        <label for="motd" class="control-label">{% translate "Fleet MOTD" %}</label>#}
+{##}
+{#        <div>#}
+{#            <textarea class="form-control" name="motd" id="motd" rows="10">{% if motd %}{{ motd }}{% endif %}</textarea>#}
+{#        </div>#}
+{#    </div>#}
 
     <div class="mb-3">
-        <input type="checkbox" style="margin-right: 5px;" class="form-check-input" name="free_move" id="free_move" {% if is_free_move %}checked{% endif %}>
+        <input type="checkbox" style="margin-right: 5px;" class="form-check-input" name="free_move" id="free_move" {% if fleet.is_free_move %}checked{% endif %}>
         <label for="free_move" class="form-check-label">{% translate "Enable free move" %}</label>
     </div>
 

fleetfinder/tests/test_tasks.py

@@ -0,0 +1,140 @@
+"""
+Tests for the fleetfinder.tasks module.
+"""
+
+# Standard Library
+from unittest import TestCase
+from unittest.mock import Mock, patch
+
+# AA Fleet Finder
+from fleetfinder.tasks import (
+    _get_fleet_aggregate,
+    check_fleet_adverts,
+)
+
+
+class TestGetFleetAggregate(TestCase):
+    """
+    Tests for the _get_fleet_aggregate function.
+    """
+
+    def test_returns_correct_counts_for_valid_fleet_infos(self):
+        """
+        Test that _get_fleet_aggregate returns correct counts for valid fleet_infos.
+
+        :return:
+        :rtype:
+        """
+
+        fleet_infos = [
+            {"ship_type_name": "Cruiser"},
+            {"ship_type_name": "Cruiser"},
+            {"ship_type_name": "Battleship"},
+        ]
+
+        result = _get_fleet_aggregate(fleet_infos)
+
+        assert result == {"Cruiser": 2, "Battleship": 1}
+
+    def test_returns_empty_dict_for_empty_fleet_infos(self):
+        """
+        Test that _get_fleet_aggregate returns an empty dictionary for empty fleet_infos.
+
+        :return:
+        :rtype:
+        """
+
+        fleet_infos = []
+
+        result = _get_fleet_aggregate(fleet_infos)
+
+        assert result == {}
+
+    def test_returns_only_valid_ship_type_names(self):
+        """
+        Test that _get_fleet_aggregate returns only valid ship type names.
+
+        :return:
+        :rtype:
+        """
+
+        fleet_infos = [
+            {"ship_type_name": "Cruiser"},
+            {},
+            {"ship_type_name": None},
+            {"ship_type_name": "Battleship"},
+            {"other_key": "Frigate"},
+        ]
+
+        result = _get_fleet_aggregate(fleet_infos)
+
+        assert result == {"Cruiser": 1, "Battleship": 1}
+
+
+class TestCheckFleetAdvert(TestCase):
+    """
+    Tests for the check_fleet_adverts function.
+    """
+
+    @patch("fleetfinder.models.Fleet.objects.all")
+    @patch("fleetfinder.tasks.fetch_esi_status")
+    def test_processes_registered_fleets_when_available(
+        self, mock_fetch_esi_status, mock_fleet_objects
+    ):
+        """
+        Test that check_fleet_adverts processes registered fleets when ESI is available.
+
+        :param mock_fetch_esi_status:
+        :type mock_fetch_esi_status:
+        :param mock_fleet_objects:
+        :type mock_fleet_objects:
+        :return:
+        :rtype:
+        """
+
+        mock_fetch_esi_status.return_value.is_ok = True
+        mock_fleet_objects.return_value.exists.return_value = True
+        mock_fleet_objects.return_value.count.return_value = 2
+        mock_fleet_objects.return_value.__iter__.return_value = iter([Mock(), Mock()])
+
+        check_fleet_adverts()
+
+        mock_fleet_objects.return_value.__iter__.assert_called_once()
+        mock_fetch_esi_status.assert_called_once()
+
+    @patch("fleetfinder.models.Fleet.objects.all")
+    @patch("fleetfinder.tasks.fetch_esi_status")
+    def test_logs_no_registered_fleets_when_none_exist(
+        self, mock_fetch_esi_status, mock_fleet_objects
+    ):
+        """
+        Test that check_fleet_adverts logs a message when no registered fleets exist.
+
+        :param mock_fetch_esi_status:
+        :type mock_fetch_esi_status:
+        :param mock_fleet_objects:
+        :type mock_fleet_objects:
+        :return:
+        :rtype:
+        """
+
+        mock_fetch_esi_status.return_value.is_ok = True
+        mock_fleet_objects.return_value.exists.return_value = False
+
+        check_fleet_adverts()
+
+        mock_fleet_objects.return_value.exists.assert_called_once()
+        mock_fetch_esi_status.assert_not_called()
+
+    @patch("fleetfinder.models.Fleet.objects.all")
+    @patch("fleetfinder.tasks.fetch_esi_status")
+    def test_aborts_processing_when_esi_is_unavailable(
+        self, mock_fetch_esi_status, mock_fleet_objects
+    ):
+        mock_fetch_esi_status.return_value.is_ok = False
+        mock_fleet_objects.return_value.exists.return_value = True
+
+        check_fleet_adverts()
+
+        mock_fetch_esi_status.assert_called_once()
+        mock_fleet_objects.return_value.__iter__.assert_not_called()