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

aa_bulletin_board/locale/zh_Hans/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-07-27 22:06+0200\n"
+"POT-Creation-Date: 2023-08-02 15:50+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -38,37 +38,37 @@ msgid ""
 "place, everyone who has access to this module can read this bulletin."
 msgstr ""
 
-#: models.py:74
+#: models.py:81
 msgid "Title"
 msgstr ""
 
-#: models.py:76
+#: models.py:83
 msgid "Content"
 msgstr ""
 
 #. Translators: This is the date and time the bulletin has been created
-#: models.py:81
+#: models.py:88
 msgid "Created"
 msgstr ""
 
 #. Translators: This is the date and time the bulletin has been updated
-#: models.py:87
+#: models.py:94
 msgid "Updated"
 msgstr ""
 
-#: models.py:96
+#: models.py:103
 msgid "User"
 msgstr ""
 
-#: models.py:102
+#: models.py:109
 msgid "Group restrictions"
 msgstr ""
 
-#: models.py:113
+#: models.py:120
 msgid "Bulletin"
 msgstr ""
 
-#: models.py:114
+#: models.py:121
 msgid "Bulletins"
 msgstr ""
 
@@ -116,44 +116,41 @@ msgstr ""
 msgid "Create Bulletin"
 msgstr ""
 
-#: templates/aa_bulletin_board/partials/app-translation-footer.html:4
-msgid "Join our team of translators!"
+#: templates/aa_bulletin_board/partials/footer/app-translation-footer.html:5
+msgid ""
+"Do you want to help translate this app into your language or improve the "
+"existing translation?"
 msgstr ""
 
-#: templates/aa_bulletin_board/partials/app-translation-footer.html:7
-#, python-format
-msgid ""
-"\n"
-"            Do you want to help translate this app into your language or "
-"improve the existing translation? - %(weblate_link)s\n"
-"        "
+#: templates/aa_bulletin_board/partials/footer/app-translation-footer.html:8
+msgid "Join our team of translators!"
 msgstr ""
 
-#: views.py:65
+#: views.py:80
 #, python-brace-format
 msgid "Bulletin \"{bulletin__title}\" created."
 msgstr ""
 
-#: views.py:92
+#: views.py:123
 msgid ""
 "The bulletin you are looking for does not exist, or you don't have access to "
 "it."
 msgstr ""
 
-#: views.py:129
+#: views.py:165
 #, python-brace-format
 msgid "Bulletin \"{bulletin__title}\" updated."
 msgstr ""
 
-#: views.py:140
+#: views.py:184
 msgid "The bulletin you are trying to edit does not exist."
 msgstr ""
 
-#: views.py:159
+#: views.py:208
 #, python-brace-format
 msgid "Bulletin \"{bulletin.title}\" deleted."
 msgstr ""
 
-#: views.py:164
+#: views.py:215
 msgid "The bulletin you are trying to delete does not exist."
 msgstr ""

aa_bulletin_board/managers.py

@@ -16,10 +16,15 @@ class BulletinQuerySet(models.QuerySet):
     def user_has_access(self, user: User) -> models.QuerySet:
         """
         Filter boards that given user has access to.
+
+        :param user:
+        :type user:
+        :return:
+        :rtype:
         """
 
         # Forum managers always have access, so assign this permission wisely
-        if user.has_perm("aa_bulletin_board.manage_bulletins"):
+        if user.has_perm(perm="aa_bulletin_board.manage_bulletins"):
             return self
 
         # If not a forum manager, check if the user has access to the board
@@ -36,4 +41,4 @@ class BulletinManagerBase(models.Manager):  # pylint: disable=too-few-public-met
     pass  # pylint: disable=unnecessary-pass
 
 
-BulletinManager = BulletinManagerBase.from_queryset(BulletinQuerySet)
+BulletinManager = BulletinManagerBase.from_queryset(queryset_class=BulletinQuerySet)

aa_bulletin_board/models.py

@@ -22,7 +22,9 @@ from aa_bulletin_board.managers import BulletinManager
 def get_sentinel_user() -> User:
     """
     Get the sentinel user or create one
+
     :return:
+    :rtype:
     """
 
     return User.objects.get_or_create(username="deleted")[0]
@@ -31,17 +33,22 @@ def get_sentinel_user() -> User:
 def get_bulletin_slug_from_title(bulletin_title: str) -> str:
     """
     Get the slug from the title
+
     :param bulletin_title:
+    :type bulletin_title:
     :return:
+    :rtype:
     """
 
     run = 0
-    bulletin_slug = slugify(unidecode.unidecode(bulletin_title), allow_unicode=True)
+    bulletin_slug = slugify(
+        value=unidecode.unidecode(bulletin_title), allow_unicode=True
+    )
 
     while Bulletin.objects.filter(slug=bulletin_slug).exists():
         run += 1
         bulletin_slug = slugify(
-            unidecode.unidecode(f"{bulletin_title}-{run}"), allow_unicode=True
+            value=unidecode.unidecode(f"{bulletin_title}-{run}"), allow_unicode=True
         )
 
     return bulletin_slug
@@ -120,9 +127,16 @@ class Bulletin(models.Model):
     def save(self, *args, **kwargs) -> None:
         """
         Add the slug on save
+
+        :param args:
+        :type args:
+        :param kwargs:
+        :type kwargs:
+        :return:
+        :rtype:
         """
 
-        self.content = string_cleanup(self.content)
+        self.content = string_cleanup(string=self.content)
 
         if self.slug == "":
             bulletin_slug = get_bulletin_slug_from_title(bulletin_title=self.title)

aa_bulletin_board/static/aa_bulletin_board/css/aa-bootstrap-fix.css

@@ -1,13 +1,13 @@
-/* attempting to fix AA's wrong usage of bootstrap classes
+/* Attempting to fix AA's wrong usage of bootstrap classes
 ------------------------------------------------------------------------------------- */
 @media all {
-    .aa-bulletin-board {
-        margin-left: 15px;
+    #site-body-wrapper.row {
+        margin-left: 0;
     }
 }
 
 @media all and (min-width: 768px) {
-    .aa-bulletin-board {
-        margin-left: 0;
+    #site-body-wrapper.row {
+        margin-left: -15px;
     }
 }

aa_bulletin_board/static/aa_bulletin_board/css/aa-bootstrap-fix.min.css

@@ -1 +1 @@
-@media all{.aa-bulletin-board{margin-left:15px}}@media all and (min-width:768px){.aa-bulletin-board{margin-left:0}}
+@media all{#site-body-wrapper.row{margin-left:0}}@media all and (min-width:768px){#site-body-wrapper.row{margin-left:-15px}}

aa_bulletin_board/templates/aa_bulletin_board/base.html

@@ -15,7 +15,7 @@
         </div>
 
         <div class="aa-bulletin-board-footer">
-            {% include "aa_bulletin_board/partials/app-translation-footer.html" %}
+            {% include "aa_bulletin_board/partials/footer/app-translation-footer.html" %}
         </div>
     </div>
 {% endblock %}

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)