aa-bulletin-board 1.10.0__py3-none-any.whl → 1.11.0__py3-none-any.whl

aa_bulletin_board/templates/aa_bulletin_board/dashboard.html

@@ -1,16 +1,16 @@
-{% extends 'aa_bulletin_board/base.html' %}
+{% extends "aa_bulletin_board/base.html" %}
 
 {% load i18n %}
 
 {% block aabulletinboard_header %}
     {% translate "Bulletin Board" as translated_header %}
-    {% include 'aa_bulletin_board/partials/header/page-header.html' with header_text=translated_header %}
+    {% include "aa_bulletin_board/partials/header/page-header.html" with header_text=translated_header %}
 {% endblock %}
 
 {% block aabulletinboard_body %}
     {% if perms.aa_bulletin_board.manage_bulletins %}
         <div class="aa-bulletin-board-management text-right">
-            <a class="btn btn-success btn-read-more" href="{% url 'aa_bulletin_board:create_bulletin' %}">{% translate 'Add Bulletin' %}</a>
+            <a class="btn btn-success btn-read-more" href="{% url 'aa_bulletin_board:create_bulletin' %}">{% translate "Add Bulletin" %}</a>
         </div>
     {% endif %}
 
@@ -23,7 +23,7 @@
                             <div class="panel-title">
                                 {{ bulletin.title }}
                                 {% if bulletin.groups.all %}
-                                    <i class="far fa-eye-slash aa-bulletin-board-marker-group-restrictions" data-title="{% translate "This bulletin is restricted to the following group(s):" %}<br>{{ bulletin.groups.all|join:', ' }}"></i>
+                                    <i class="far fa-eye-slash aa-bulletin-board-marker-group-restrictions" data-title="{% translate 'This bulletin is restricted to the following group(s):' %}<br>{{ bulletin.groups.all|join:', ' }}"></i>
                                 {% endif %}
                             </div>
                         </div>
@@ -34,11 +34,11 @@
 
                         <div class="panel-footer-read-more-button panel-footer-no-background">
                             <p>
-                                <a class="btn btn-primary btn-sm btn-read-more" href="{% url 'aa_bulletin_board:view_bulletin' bulletin.slug %}">{% translate 'Read more' %}</a>
+                                <a class="btn btn-primary btn-sm btn-read-more" href="{% url 'aa_bulletin_board:view_bulletin' bulletin.slug %}">{% translate "Read more" %}</a>
 
                                 {% if perms.aa_bulletin_board.manage_bulletins %}
-                                    <a class="btn btn-warning btn-sm btn-read-more" href="{% url 'aa_bulletin_board:edit_bulletin' bulletin.slug %}">{% translate 'Edit' %}</a>
-                                    <a class="btn btn-danger btn-sm btn-read-more" href="{% url 'aa_bulletin_board:remove_bulletin' bulletin.slug %}">{% translate 'Delete' %}</a>
+                                    <a class="btn btn-warning btn-sm btn-read-more" href="{% url 'aa_bulletin_board:edit_bulletin' bulletin.slug %}">{% translate "Edit" %}</a>
+                                    <a class="btn btn-danger btn-sm btn-read-more" href="{% url 'aa_bulletin_board:remove_bulletin' bulletin.slug %}">{% translate "Delete" %}</a>
                                 {% endif %}
                             </p>
                         </div>
@@ -52,6 +52,8 @@
 {% block extra_javascript %}
     <script>
         $(document).ready(() => {
+            'use strict';
+
             const resizeBulletinPanel = () => {
                 let highestBox = 0;
 

aa_bulletin_board/templates/aa_bulletin_board/edit-bulletin.html

@@ -1,4 +1,4 @@
-{% extends 'aa_bulletin_board/base.html' %}
+{% extends "aa_bulletin_board/base.html" %}
 
 {% load bootstrap %}
 {% load i18n %}
@@ -14,9 +14,9 @@
 
 {% block aabulletinboard_header %}
     {% if bulletin %}
-        {% include 'aa_bulletin_board/partials/header/page-header.html' with header_text=bulletin.title %}
+        {% include "aa_bulletin_board/partials/header/page-header.html" with header_text=bulletin.title %}
     {% else %}
-        {% include 'aa_bulletin_board/partials/header/page-header.html' with header_text='Create New Bulletin' %}
+        {% include "aa_bulletin_board/partials/header/page-header.html" with header_text="Create New Bulletin" %}
     {% endif %}
 {% endblock %}
 
@@ -24,7 +24,7 @@
     <div class="panel panel-default">
         <div class="panel-heading">
             <div class="panel-title">
-                <a class="btn btn-default btn-sm" href="{% if bulletin %}{% url 'aa_bulletin_board:view_bulletin' bulletin.slug %}{% else %}{% url 'aa_bulletin_board:dashboard' %}{% endif %}">{% translate 'Back' %}</a>
+                <a class="btn btn-default btn-sm" href="{% if bulletin %}{% url 'aa_bulletin_board:view_bulletin' bulletin.slug %}{% else %}{% url 'aa_bulletin_board:dashboard' %}{% endif %}">{% translate "Back" %}</a>
             </div>
         </div>
 
@@ -35,7 +35,7 @@
                 {{ form|bootstrap }}
 
                 <div class="form-group text-right clearfix">
-                    <button class="btn btn-success" type="submit">{% if bulletin %}{% translate 'Update Bulletin' %}{% else %}{% translate 'Create Bulletin' %}{% endif %}</button>
+                    <button class="btn btn-success" type="submit">{% if bulletin %}{% translate "Update Bulletin" %}{% else %}{% translate "Create Bulletin" %}{% endif %}</button>
                 </div>
             </form>
         </div>
@@ -48,6 +48,8 @@
     <script src="{% static "ckeditor/ckeditor-init.js" %}"></script>
     <script src="{% static "ckeditor/ckeditor/ckeditor.js" %}"></script>
     <script>
+        'use strict';
+
         $('.aa-bulletin-boad-edit-bulletin select').SumoSelect(
             {okCancelInMulti: true, selectAll: true}
         );

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

@@ -0,0 +1,11 @@
+{% load i18n %}
+
+<div class="app-translation-footer text-muted">
+    <p>
+        {% 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>

aa_bulletin_board/templatetags/aa_bulletin_board_versioned_static.py

@@ -14,13 +14,14 @@ from aa_bulletin_board import __version__
 def aa_bulletin_board_static(path: str) -> str:
     """
     Versioned static URL
+
     :param path:
     :type path:
     :return:
     :rtype:
     """
 
-    static_url = static(path)
+    static_url = static(path=path)
     versioned_url = static_url + "?v=" + __version__
 
     return versioned_url

aa_bulletin_board/tests/test_access.py

@@ -1,6 +1,8 @@
 """
 Testing access to bulletins
 """
+# Standard Library
+from http import HTTPStatus
 
 # Third Party
 from faker import Faker
@@ -26,48 +28,57 @@ class TestAccess(TestCase):
     def setUpClass(cls) -> None:
         """
         Set up groups and users
+
+        :return:
+        :rtype:
         """
 
         super().setUpClass()
         cls.group = Group.objects.create(name="Superhero")
 
         # User cannot access bulletins
-        cls.user_1001 = create_fake_user(1001, "Peter Parker")
+        cls.user_1001 = create_fake_user(
+            character_id=1001, character_name="Peter Parker"
+        )
 
         # User can access bulletins
         cls.user_1002 = create_fake_user(
-            1002, "Bruce Wayne", permissions=["aa_bulletin_board.basic_access"]
+            character_id=1002,
+            character_name="Bruce Wayne",
+            permissions=["aa_bulletin_board.basic_access"],
         )
 
         # User can manage bulletins
         cls.user_1003 = create_fake_user(
-            1003,
-            "Clark Kent",
+            character_id=1003,
+            character_name="Clark Kent",
             permissions=[
                 "aa_bulletin_board.basic_access",
                 "aa_bulletin_board.manage_bulletins",
             ],
         )
 
-    def test_should_show_dashboard(self):
+    def test_should_show_dashboard(self) -> None:
         """
         Test that a user with basic_access can see the bulletin board
+
         :return:
         :rtype:
         """
 
         # given
-        self.client.force_login(self.user_1002)
+        self.client.force_login(user=self.user_1002)
 
         # when
-        res = self.client.get(reverse("aa_bulletin_board:dashboard"))
+        res = self.client.get(path=reverse(viewname="aa_bulletin_board:dashboard"))
 
         # then
-        self.assertEqual(res.status_code, 200)
+        self.assertEqual(first=res.status_code, second=HTTPStatus.OK)
 
-    def test_should_show_bulletin(self):
+    def test_should_show_bulletin(self) -> None:
         """
         Test that a user with basic_access can see the bulletin
+
         :return:
         :rtype:
         """
@@ -78,37 +89,42 @@ class TestAccess(TestCase):
             content=f"<p>{fake.sentence()}</p>",
             created_by=self.user_1001,
         )
-        self.client.force_login(self.user_1002)
+        self.client.force_login(user=self.user_1002)
 
         # when
         res = self.client.get(
-            reverse("aa_bulletin_board:view_bulletin", kwargs={"slug": bulletin.slug})
+            path=reverse(
+                viewname="aa_bulletin_board:view_bulletin",
+                kwargs={"slug": bulletin.slug},
+            )
         )
-        result = Bulletin.objects.user_has_access(self.user_1002)
+        result = Bulletin.objects.user_has_access(user=self.user_1002)
 
         # then
-        self.assertEqual(res.status_code, 200)
-        self.assertIn(bulletin, result)
+        self.assertEqual(first=res.status_code, second=HTTPStatus.OK)
+        self.assertIn(member=bulletin, container=result)
 
-    def test_should_not_show_dashboard(self):
+    def test_should_not_show_dashboard(self) -> None:
         """
         Test that a user without basic_access can't see the bulletin board
+
         :return:
         :rtype:
         """
 
         # given
-        self.client.force_login(self.user_1001)
+        self.client.force_login(user=self.user_1001)
 
         # when
-        res = self.client.get(reverse("aa_bulletin_board:dashboard"))
+        res = self.client.get(path=reverse(viewname="aa_bulletin_board:dashboard"))
 
         # then
-        self.assertIsNot(res.status_code, 200)
+        self.assertIsNot(expr1=res.status_code, expr2=HTTPStatus.OK)
 
-    def test_should_not_show_bulletin(self):
+    def test_should_not_show_bulletin(self) -> None:
         """
         Test that a user without basic_access can't see the bulletin
+
         :return:
         :rtype:
         """
@@ -119,19 +135,23 @@ class TestAccess(TestCase):
             content=f"<p>{fake.sentence()}</p>",
             created_by=self.user_1001,
         )
-        self.client.force_login(self.user_1001)
+        self.client.force_login(user=self.user_1001)
 
         # when
         res = self.client.get(
-            reverse("aa_bulletin_board:view_bulletin", kwargs={"slug": bulletin.slug})
+            path=reverse(
+                viewname="aa_bulletin_board:view_bulletin",
+                kwargs={"slug": bulletin.slug},
+            )
         )
 
         # then
-        self.assertIsNot(res.status_code, 200)
+        self.assertIsNot(expr1=res.status_code, expr2=HTTPStatus.OK)
 
-    def test_should_return_bulletin_for_user_with_perm_manage_bulletins(self):
+    def test_should_return_bulletin_for_user_with_perm_manage_bulletins(self) -> None:
         """
         Test that a user with "aa_bulletin_board.manage_bulletins" can see all bulletins
+
         :return:
         :rtype:
         """
@@ -144,17 +164,18 @@ class TestAccess(TestCase):
         )
 
         # when
-        result = Bulletin.objects.user_has_access(self.user_1003)
+        result = Bulletin.objects.user_has_access(user=self.user_1003)
 
         # then
-        self.assertIn(bulletin, result)
+        self.assertIn(member=bulletin, container=result)
 
     def test_should_return_restricted_bulletin_for_user_with_perm_manage_bulletins(
         self,
-    ):
+    ) -> None:
         """
         Test that a user with "aa_bulletin_board.manage_bulletins"
         can see all bulletins, even restricted
+
         :return:
         :rtype:
         """
@@ -168,14 +189,15 @@ class TestAccess(TestCase):
         bulletin.groups.add(self.group)
 
         # when
-        result = Bulletin.objects.user_has_access(self.user_1003)
+        result = Bulletin.objects.user_has_access(user=self.user_1003)
 
         # then
-        self.assertIn(bulletin, result)
+        self.assertIn(member=bulletin, container=result)
 
-    def test_should_return_bulletin_with_no_groups(self):
+    def test_should_return_bulletin_with_no_groups(self) -> None:
         """
         Test that any user with access can se non-restricted bulletins
+
         :return:
         :rtype:
         """
@@ -188,14 +210,15 @@ class TestAccess(TestCase):
         )
 
         # when
-        result = Bulletin.objects.user_has_access(self.user_1002)
+        result = Bulletin.objects.user_has_access(user=self.user_1002)
 
         # then
-        self.assertIn(bulletin, result)
+        self.assertIn(member=bulletin, container=result)
 
-    def test_should_return_bulletin_for_group_member(self):
+    def test_should_return_bulletin_for_group_member(self) -> None:
         """
         Test that group restricted bulletins are visible for users who have this group
+
         :return:
         :rtype:
         """
@@ -210,15 +233,16 @@ class TestAccess(TestCase):
         self.user_1001.groups.add(self.group)
 
         # when
-        result = Bulletin.objects.user_has_access(self.user_1001)
+        result = Bulletin.objects.user_has_access(user=self.user_1001)
 
         # then
-        self.assertIn(bulletin, result)
+        self.assertIn(member=bulletin, container=result)
 
-    def test_should_not_return_bulletin_for_non_group_member(self):
+    def test_should_not_return_bulletin_for_non_group_member(self) -> None:
         """
         Test that group restricted bulletins are not visible for
         users who don't have this group
+
         :return:
         :rtype:
         """
@@ -232,7 +256,7 @@ class TestAccess(TestCase):
         bulletin.groups.add(self.group)
 
         # when
-        result = Bulletin.objects.user_has_access(self.user_1002)
+        result = Bulletin.objects.user_has_access(user=self.user_1002)
 
         # then
-        self.assertNotIn(bulletin, result)
+        self.assertNotIn(member=bulletin, container=result)

aa_bulletin_board/tests/test_auth_hooks.py

@@ -22,51 +22,60 @@ class TestHooks(TestCase):
     def setUpClass(cls) -> None:
         """
         Set up groups and users
+
+        :return:
+        :rtype:
         """
 
         super().setUpClass()
 
         # User cannot access bulletins
-        cls.user_1001 = create_fake_user(1001, "Peter Parker")
+        cls.user_1001 = create_fake_user(
+            character_id=1001, character_name="Peter Parker"
+        )
 
         # User can access bulletins
         cls.user_1002 = create_fake_user(
-            1002, "Bruce Wayne", permissions=["aa_bulletin_board.basic_access"]
+            character_id=1002,
+            character_name="Bruce Wayne",
+            permissions=["aa_bulletin_board.basic_access"],
         )
 
         cls.html_menu = f"""
             <li>
-                <a class href="{reverse('aa_bulletin_board:dashboard')}">
+                <a class href="{reverse(viewname='aa_bulletin_board:dashboard')}">
                     <i class="fas fa-clipboard-list fa-fw"></i> Bulletin Board
                 </a>
             </li>
         """
 
-    def test_render_hook_success(self):
+    def test_render_hook_success(self) -> None:
         """
         Test should show the link to the app in the navigation to user with access
+
         :return:
         :rtype:
         """
 
-        self.client.force_login(self.user_1002)
+        self.client.force_login(user=self.user_1002)
 
-        response = self.client.get(reverse("authentication:dashboard"))
+        response = self.client.get(path=reverse(viewname="authentication:dashboard"))
 
         self.assertEqual(response.status_code, HTTPStatus.OK)
         self.assertContains(response, self.html_menu, html=True)
 
-    def test_render_hook_fail(self):
+    def test_render_hook_fail(self) -> None:
         """
         Test should not show the link to the app in the
         navigation to user without access
+
         :return:
         :rtype:
         """
 
-        self.client.force_login(self.user_1001)
+        self.client.force_login(user=self.user_1001)
 
-        response = self.client.get(reverse("authentication:dashboard"))
+        response = self.client.get(path=reverse(viewname="authentication:dashboard"))
 
         self.assertEqual(response.status_code, HTTPStatus.OK)
         self.assertNotContains(response, self.html_menu, html=True)