aa-fleetfinder 0.1.0a12__py3-none-any.whl → 3.0.0b2__py3-none-any.whl

fleetfinder/templates/fleetfinder/dashboard.html

@@ -0,0 +1,53 @@
+{% extends "fleetfinder/base.html" %}
+
+{% load aa_i18n %}
+{% load i18n %}
+
+{% block aa_fleetfinder_body %}
+    <div class="card card-default border-0">
+        <div class="card-header card-default">
+            <div class="card-title mb-0">
+                {% translate "Fleets available to you" %}
+            </div>
+        </div>
+
+        <div class="card-body">
+            <div class="table-responsive">
+                <table class="table table-striped table-hover table-vertical-middle" id="table_available-fleets" style="width: 100%;">
+                    <thead>
+                        <tr>
+                            <th>{% translate "Fleet commander" %}</th>
+                            <th>{% translate "Fleet name" %}</th>
+                            <th>{% translate "Created at" %}</th>
+                            <th class="text-end"><!-- {% translate "Join" %} --></th>
+                        </tr>
+                    </thead>
+
+                    <tbody></tbody>
+                </table>
+            </div>
+        </div>
+    </div>
+{% endblock %}
+
+{% block extra_css %}
+    {% include "bundles/datatables-css-bs5.html" %}
+    {% include "fleetfinder/bundles/css/fleetfinder-css.html" %}
+{% endblock %}
+
+{% block extra_javascript %}
+    {% include "bundles/datatables-js-bs5.html" %}
+    {% include "bundles/moment-js.html" with locale=True %}
+
+    <script>
+        const aaFleetFinderSettingsOverride = {
+            dataTables: {
+                url: {
+                    dashboard: '{% url "fleetfinder:ajax_dashboard" %}'
+                }
+            }
+        };
+    </script>
+
+    {% include "fleetfinder/bundles/js/fleetfinder-js.html" with view="dashboard" %}
+{% endblock %}

fleetfinder/templates/fleetfinder/edit-fleet.html

@@ -0,0 +1,42 @@
+{% extends "fleetfinder/base.html" %}
+
+{% load i18n %}
+
+{% block page_title %}
+    {% translate "Edit fleet" as page_title %}
+    {{ page_title|title }} » {% translate "Fleet Finder" %}
+{% endblock %}
+
+{% block aa_fleetfinder_body %}
+    <div class="card card-primary border-0">
+        <div class="card-header card-default">
+            <div class="card-title mb-0">
+                {% translate "Edit fleet" %}
+            </div>
+        </div>
+
+        <div class="card-body container">
+            <div class="row">
+                <div class="align-self-center">
+                    {% include "fleetfinder/partials/body/form-fleet-details.html" with name=fleet.name origin="edit" groups=fleet.groups.all %}
+                </div>
+            </div>
+        </div>
+    </div>
+{% endblock %}
+
+{% block extra_css %}
+    {% include "fleetfinder/bundles/css/slim-select-css.html" %}
+    {% include "fleetfinder/bundles/css/fleetfinder-css.html" %}
+{% endblock %}
+
+{% block extra_javascript %}
+    {% include "fleetfinder/bundles/js/slim-select-js.html" %}
+
+    <script>
+        new SlimSelect({
+            select: '#groups',
+            hideSelectedOption: true
+        });
+    </script>
+{% endblock %}

fleetfinder/templates/fleetfinder/fleet-details.html

@@ -0,0 +1,102 @@
+{% extends "fleetfinder/base.html" %}
+
+{% load aa_i18n %}
+{% load i18n %}
+
+{% block page_title %}
+    {% translate "Fleet details" %} » {% translate "Fleet Finder" %}
+{% endblock %}
+
+{% block aa_fleetfinder_body %}
+    {% include "framework/header/page-header.html" with title=fleet.name subtitle=fleet.fleet_commander.character_name %}
+
+    <div class="alert alert-warning d-none" id="fleetfinder-fleet-details-warning"></div>
+
+    <div class="row">
+        <div class="col-lg-6 col-lg-push-6">
+            <div class="card card-primary">
+                <div class="card-header">
+                    <div class="card-title mb-0">
+                        {% translate "Fleet composition" %}
+                    </div>
+                </div>
+
+                <div class="card-body">
+                    <div class="table-responsive">
+                        <table class="table table-striped table-hover table-vertical-middle w-100" id="table-fleet-composition">
+                            <thead>
+                                <tr>
+                                    <th>{% translate "Ship class" %}</th>
+                                    <th>{% translate "Count" %}</th>
+                                </tr>
+                            </thead>
+
+                            <tbody></tbody>
+                        </table>
+                    </div>
+                </div>
+            </div>
+        </div>
+
+        <div class="col-lg-6 col-lg-pull-6">
+            <div class="card card-primary">
+                <div class="card-header">
+                    <div class="card-title mb-0">
+                        {% translate "Fleet members" %}
+                    </div>
+                </div>
+
+                <div class="card-body">
+                    <div class="table-responsive">
+                        <table class="table table-striped table-hover table-vertical-middle w-100" id="table-fleet-members">
+                            <thead>
+                                <tr>
+                                    <th>{% translate "Name" %}</th>
+                                    <th>{% translate "Ship class" %}</th>
+                                    <th>{% translate "System" %}</th>
+                                    <th><!-- {% translate "Action" %} --></th>
+                                </tr>
+                            </thead>
+
+                            <tbody></tbody>
+                        </table>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+
+    {% include "fleetfinder/modals/kick-fleet-member.html" %}
+{% endblock %}
+
+{% block extra_css %}
+    {% include "bundles/datatables-css-bs5.html" %}
+    {% include "fleetfinder/bundles/css/fleetfinder-css.html" %}
+{% endblock %}
+
+{% block extra_javascript %}
+    {% include "bundles/datatables-js-bs5.html" %}
+
+    {% translate "Fleet boss" as l10nFleetBoss %}
+    {% translate "Kick member from fleet" as l10nKickMemberFromFleet %}
+    {% translate "An unknown error occurred." as l10nUnknownError %}
+
+    <script>
+        const aaFleetFinderSettingsOverride = {
+            dataTables: {
+                url: {
+                    fleetDetails: '{% url "fleetfinder:ajax_fleet_details" fleet.fleet_id %}',
+                    kickFleetMember: '{% url "fleetfinder:ajax_fleet_kick_member" fleet.fleet_id %}'
+                }
+            },
+            l10n: {
+                fleetBoss: '{{ l10nFleetBoss|escapejs }}',
+                kickMemberFromFleet: '{{ l10nKickMemberFromFleet|escapejs }}',
+                unknownError: '{{ l10nUnknownError|escapejs }}'
+            },
+            csrfToken: '{{ csrf_token }}'
+        };
+    </script>
+
+    {% include "fleetfinder/bundles/js/fleetfinder-js.html" with view="fleet-details" %}
+{% endblock %}

fleetfinder/templates/fleetfinder/join-fleet.html

@@ -0,0 +1,68 @@
+{% extends "fleetfinder/base.html" %}
+
+{% load i18n %}
+
+{% block page_title %}
+    {% translate "Join fleet" as page_title %}
+    {{ page_title|title }} » {% translate "Fleet Finder" %}
+{% endblock %}
+
+{% block aa_fleetfinder_body %}
+    <div class="card card-primary border-0">
+        <div class="card-header">
+            <div class="card-title mb-0">
+                {% translate "Fleet invitation" %}
+            </div>
+        </div>
+
+        <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" 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 %}
+                                    <option value="{{ character.character_id }}" >{{ character.character_name }}</option>
+                                {% endfor %}
+                            </select>
+                        </div>
+
+                        <button class="btn btn-primary btn-block" style="margin-top: 10px;" type="submit">
+                            {% translate "Send fleet invites" %}
+                        </button>
+                    </form>
+                </div>
+            </div>
+        </div>
+    </div>
+{% endblock %}
+
+{% block extra_css %}
+    {% include "fleetfinder/bundles/css/slim-select-css.html" %}
+    {% include "fleetfinder/bundles/css/fleetfinder-css.html" %}
+{% endblock %}
+
+{% block extra_javascript %}
+    {% include "fleetfinder/bundles/js/slim-select-js.html" %}
+
+    <script>
+        new SlimSelect({
+            select: '#character_ids',
+            hideSelectedOption: true
+        });
+    </script>
+{% endblock %}

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

@@ -0,0 +1,50 @@
+{% load i18n %}
+
+<form class="form-signin" role="form" action="{% url 'fleetfinder:save_fleet' %}" method="POST">
+    {% csrf_token %}
+
+    <input type="hidden" name="character_id" id="character_id" value="{{ character_id }}">
+    <input type="hidden" name="origin" id="origin" value="{{ origin }}">
+
+    <div class="mb-3">
+        <label for="name" class="control-label">{% translate "Fleet name" %}</label>
+        <input type="text" class="form-control" name="name" id="name" {% if name %}value="{{ name }}"{% endif %}>
+    </div>
+
+    <div class="mb-3">
+        <label for="groups" style="margin-bottom: 0;">{% translate "Select groups" %}</label>
+
+        <select name="groups" id="groups" multiple>
+            {% for group in auth_groups %}
+                {% if groups %}
+                    {% if group in groups %}
+                        <option value="{{ group.group_id }}" selected>{{ group }}</option>
+                    {% else %}
+                        <option value="{{ group.group_id }}">{{ group }}</option>
+                    {% endif %}
+                {% else %}
+                    <option value="{{ group.group_id }}">{{ group }}</option>
+                {% endif %}
+            {% endfor %}
+        </select>
+
+        <p class="help-block text-muted small">
+            {% translate "Only selected groups will have access to the fleet. If no groups are selected the fleet will be available to all who have access to this module." %}
+        </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">
+        <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>
+
+    <button class="btn btn-primary btn-block" type="submit">{% translate "Submit" %}</button>
+</form>

fleetfinder/templates/fleetfinder/partials/footer/app-translation-footer.html

@@ -0,0 +1,11 @@
+{% load i18n %}
+
+<div class="app-translation-footer text-muted">
+    <p class="small">
+        {% translate "Do you want to help translate this app into your language or improve the existing translation?" %}
+        -
+        <a href="https://weblate.ppfeufer.de/engage/alliance-auth-apps/" target="_blank" rel="noopener noreferer">
+            {% translate "Join our team of translators!" %}
+        </a>
+    </p>
+</div>

fleetfinder/templates/fleetfinder/partials/header/header-nav-left.html

@@ -0,0 +1,9 @@
+{% load navactive %}
+{% load i18n %}
+
+<li class="nav-item">
+    <a class="nav-link {% navactive request 'fleetfinder:dashboard' %}" href="{% url 'fleetfinder:dashboard' %}">
+        {% translate "Available fleets" as navigation_item %}
+        {{ navigation_item|title }}
+    </a>
+</li>

fleetfinder/templates/fleetfinder/partials/header/header-nav-right.html

@@ -0,0 +1,18 @@
+{% load i18n %}
+
+{% if perms.fleetfinder.manage_fleets %}
+    {% translate "Create fleet" as navigation_item %}
+
+    <li class="nav-item">
+        <a class="nav-link py-lg-0" href="{% url 'fleetfinder:create_fleet' %}">
+            <span class="btn btn-success btn-add-bulletin d-none d-lg-inline-block">
+                {{ navigation_item|title }}
+            </span>
+
+            <span class="d-inline-block d-lg-none">
+                <i class="fa-solid fa-plus me-2"></i>
+                {{ navigation_item|title }}
+            </span>
+        </a>
+    </li>
+{% endif %}

fleetfinder/templatetags/__init__.py

@@ -0,0 +1,3 @@
+"""
+Initialize the template tags
+"""

fleetfinder/templatetags/fleetfinder.py

@@ -0,0 +1,33 @@
+"""
+Versioned static URLs to break browser caches when changing the app version
+"""
+
+# Django
+from django.template.defaulttags import register
+
+# Alliance Auth
+from allianceauth.services.hooks import get_extension_logger
+
+# Alliance Auth (External Libs)
+from app_utils.logging import LoggerAddTag
+
+# AA Fleet Finder
+from fleetfinder import __title__
+
+logger = LoggerAddTag(my_logger=get_extension_logger(__name__), prefix=__title__)
+
+
+@register.filter
+def get_item(dictionary: dict | None, key: str) -> str | None:
+    """
+    Little helper: get a key from a dictionary
+
+    :param dictionary:
+    :param key:
+    :return:
+    """
+
+    if dictionary is None:
+        return None
+
+    return dictionary.get(key, None)

fleetfinder/tests/__init__.py

@@ -0,0 +1,41 @@
+"""
+Initializing our tests
+"""
+
+# Standard Library
+import socket
+
+# Django
+from django.test import TestCase
+
+
+class SocketAccessError(Exception):
+    """Error raised when a test script accesses the network"""
+
+
+class BaseTestCase(TestCase):
+    """Variation of Django's TestCase class that prevents any network use.
+
+    Example:
+
+        .. code-block:: python
+
+            class TestMyStuff(BaseTestCase):
+                def test_should_do_what_i_need(self): ...
+
+    """
+
+    @classmethod
+    def setUpClass(cls):
+        cls.socket_original = socket.socket
+        socket.socket = cls.guard
+        return super().setUpClass()
+
+    @classmethod
+    def tearDownClass(cls):
+        socket.socket = cls.socket_original
+        return super().tearDownClass()
+
+    @staticmethod
+    def guard(*args, **kwargs):
+        raise SocketAccessError("Attempted to access network")

fleetfinder/tests/test_access.py

@@ -0,0 +1,74 @@
+"""
+Test checks for access to fleetfinder
+"""
+
+# Standard Library
+from http import HTTPStatus
+
+# Django
+from django.contrib.auth.models import Group
+from django.urls import reverse
+
+# AA Fleet Finder
+from fleetfinder.tests import BaseTestCase
+from fleetfinder.tests.utils import create_fake_user
+
+
+class TestAccess(BaseTestCase):
+    """
+    Testing module access
+    """
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        """
+        Set up groups and users
+        """
+
+        super().setUpClass()
+
+        cls.group = Group.objects.create(name="Superhero")
+
+        # User cannot access fleetfinder
+        cls.user_1001 = create_fake_user(
+            character_id=1001, character_name="Peter Parker"
+        )
+
+        # User can access fleetfinder
+        cls.user_1002 = create_fake_user(
+            character_id=1002,
+            character_name="Bruce Wayne",
+            permissions=["fleetfinder.access_fleetfinder"],
+        )
+
+    def test_has_no_access(self):
+        """
+        Test that a user without access gets a 302
+
+        :return:
+        """
+
+        # given
+        self.client.force_login(user=self.user_1001)
+
+        # when
+        res = self.client.get(path=reverse(viewname="fleetfinder:dashboard"))
+
+        # then
+        self.assertEqual(first=res.status_code, second=HTTPStatus.FOUND)
+
+    def test_has_access(self):
+        """
+        Test that a user with access gets to see it
+
+        :return:
+        """
+
+        # given
+        self.client.force_login(user=self.user_1002)
+
+        # when
+        res = self.client.get(path=reverse(viewname="fleetfinder:dashboard"))
+
+        # then
+        self.assertEqual(first=res.status_code, second=HTTPStatus.OK)

fleetfinder/tests/test_auth_hooks.py

@@ -0,0 +1,79 @@
+"""
+Test auth_hooks
+"""
+
+# Standard Library
+from http import HTTPStatus
+
+# Django
+from django.urls import reverse
+
+# AA Fleet Finder
+from fleetfinder.tests import BaseTestCase
+from fleetfinder.tests.utils import create_fake_user
+
+
+class TestHooks(BaseTestCase):
+    """
+    Test the app hook into allianceauth
+    """
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        """
+        Set up groups and users
+        """
+
+        super().setUpClass()
+
+        # User cannot access
+        cls.user_1001 = create_fake_user(
+            character_id=1001, character_name="Peter Parker"
+        )
+
+        # User can access
+        cls.user_1002 = create_fake_user(
+            character_id=1002,
+            character_name="Bruce Wayne",
+            permissions=["fleetfinder.access_fleetfinder"],
+        )
+
+        cls.html_menu = f"""
+            <li class="d-flex flex-wrap m-2 p-2 pt-0 pb-0 mt-0 mb-0 me-0 pe-0">
+                <i class="nav-link fa-solid fa-users fa-fw align-self-center me-3 "></i>
+                <a class="nav-link flex-fill align-self-center me-auto" href="{reverse(viewname='fleetfinder:dashboard')}">
+                    Fleet Finder
+                </a>
+            </li>
+        """
+
+    def test_render_hook_success(self):
+        """
+        Test should show the link to the app in the navigation to user with access
+
+        :return:
+        :rtype:
+        """
+
+        self.client.force_login(user=self.user_1002)
+
+        response = self.client.get(path=reverse(viewname="authentication:dashboard"))
+
+        self.assertEqual(first=response.status_code, second=HTTPStatus.OK)
+        self.assertContains(response=response, text=self.html_menu, html=True)
+
+    def test_render_hook_fail(self):
+        """
+        Test should not show the link to the app in the
+        navigation to user without access
+
+        :return:
+        :rtype:
+        """
+
+        self.client.force_login(user=self.user_1001)
+
+        response = self.client.get(path=reverse(viewname="authentication:dashboard"))
+
+        self.assertEqual(first=response.status_code, second=HTTPStatus.OK)
+        self.assertNotContains(response=response, text=self.html_menu, html=True)

fleetfinder/tests/test_settings.py

@@ -0,0 +1,38 @@
+"""
+Test the settings
+"""
+
+# Django
+from django.test import override_settings
+
+# AA Fleet Finder
+from fleetfinder.app_settings import debug_enabled
+from fleetfinder.tests import BaseTestCase
+
+
+class TestSettings(BaseTestCase):
+    """
+    Test the settings
+    """
+
+    @override_settings(DEBUG=True)
+    def test_debug_enabled_with_debug_true(self) -> None:
+        """
+        Test debug_enabled with DEBUG = True
+
+        :return:
+        :rtype:
+        """
+
+        self.assertTrue(debug_enabled())
+
+    @override_settings(DEBUG=False)
+    def test_debug_enabled_with_debug_false(self) -> None:
+        """
+        Test debug_enabled with DEBUG = False
+
+        :return:
+        :rtype:
+        """
+
+        self.assertFalse(debug_enabled())