Support more series statuses

Author: ObserverOfTime

MangAdventure/search.py

@@ -89,10 +89,8 @@ def qsfilter(params: _SearchParams) -> Q:
             Q(authors__aliases__name__icontains=params.author) |
             Q(artists__aliases__name__icontains=params.author)
         )
-    if params.status == 'completed':
-        filters &= Q(completed=True)
-    elif params.status == 'ongoing':
-        filters &= Q(completed=False)
+    if params.status and params.status != 'any':
+        filters &= Q(status=params.status)
     included, excluded = params.categories
     if excluded:
         filters &= ~Q(categories__in=excluded)

MangAdventure/templates/search.html

@@ -31,6 +31,7 @@ <h1 class="text-shadow alter-bg">Search</h1>
         </div>
         <div id="search-status">
           <label for="status">Series Status: </label>
+          {# TODO: clean this up #}
           <input {% if status == 'any' %}checked="checked"{% endif %}
                  name="status" id="status-any" value="any" type="radio">
           <label for="status-any">Any</label>
@@ -40,6 +41,12 @@ <h1 class="text-shadow alter-bg">Search</h1>
           <input {% if status == 'ongoing' %}checked="checked"{% endif %}
                  name="status" id="status-ongoing" value="ongoing" type="radio">
           <label for="status-ongoing">Ongoing</label>
+          <input {% if status == 'hiatus' %}checked="checked"{% endif %}
+                 name="status" id="status-hiatus" value="hiatus" type="radio">
+          <label for="status-hiatus">On Hiatus</label>
+          <input {% if status == 'canceled' %}checked="checked"{% endif %}
+                 name="status" id="status-canceled" value="canceled" type="radio">
+          <label for="status-canceled">Canceled</label>
         </div>
         <fieldset id="search-categories">
           <legend>Categories:</legend>
@@ -85,10 +92,14 @@ <h1 class="text-shadow alter-bg">Search</h1>
           {% for series in results %}
             <tr class="result">
               <td class="result-title">
-                {% if series.completed %}
-                  <i class="mi mi-book" title="Completed"></i>
-                {% else %}
-                  <i class="mi mi-book-o" title="Ongoing"></i>
+                {% if series.status == "completed" %}
+                  <i class="mi mi-book orange" title="Completed"></i>
+                {% elif series.status == "ongoing" %}
+                  <i class="mi mi-book-o green" title="Ongoing"></i>
+                {% elif series.status == "canceled" %}
+                  <i class="mi mi-book red" title="Canceled"></i>
+                {% elif series.status == "hiatus" %}
+                  <i class="mi mi-book-o yellow" title="On Hiatus"></i>
                 {% endif %}
                 <a href="{{ series.get_absolute_url }}"
                    title="{{ series.title }}">

MangAdventure/tests/test_views.py

@@ -29,7 +29,7 @@ def setup_method(self):
             title='chapter', number=1, file=get_valid_zip_file()
         )
 
-        series2 = Series.objects.create(title='series2', completed=True)
+        series2 = Series.objects.create(title='series2', status='completed')
         author2 = series2.authors.create(name='Author 2')
         author2.aliases.create(name='author2')
         artist2 = series2.artists.create(name='Artist 2')

api/tests/fixtures/series.json

@@ -7,7 +7,7 @@
       "slug": "test-series",
       "description": "",
       "cover": "series/test-series/cover.png",
-      "completed": false,
+      "status": "OG",
       "created": "2019-12-30T13:58:18.645Z",
       "modified": "2019-12-30T13:58:18.645Z",
       "authors": [
@@ -29,7 +29,7 @@
       "slug": "test-series-2",
       "description": "",
       "cover": "series/test-series/cover.png",
-      "completed": false,
+      "status": "OG",
       "created": "2019-12-30T13:58:18.645Z",
       "modified": "2019-12-30T13:58:18.645Z",
       "authors": [],

api/v1/views.py

@@ -17,7 +17,7 @@
 from MangAdventure.search import get_response
 
 from groups.models import Group, Member
-from reader.models import Artist, Author, Category, Chapter, Series
+from reader.models import Artist, Author, Category, Chapter, Series, Status
 
 from .response import JsonError, deprecate_api, require_methods_api
 
@@ -89,7 +89,7 @@ def _series_response(request: HttpRequest, _series: Series) -> Dict:
             _series.categories.values('name', 'description')
         ),
         'cover': request.build_absolute_uri(_series.cover.url),
-        'completed': _series.completed,
+        'completed': _series.status in (Status.COMPLETED, Status.CANCELED),
         'volumes': {},
     }
     chapters = _series.chapters.filter(published__lte=tz.now())

api/v2/schema.py

@@ -34,6 +34,9 @@ def map_field(self, field: Any) -> Dict:
         if isinstance(field, PrimaryKeyRelatedField):
             return {'type': 'integer'}
         result = super().map_field(field)
+        # deprecate the Series.completed field
+        if field.field_name == 'completed':
+            result['deprecated'] = True
         # specify pattern for slug related fields
         if isinstance(field, SlugRelatedField):
             result['pattern'] = '^[-a-zA-Z0-9_]+$'

api/v2/views.py

@@ -22,7 +22,7 @@
 #: The generated OpenAPI schema as a view.
 openapi = cache_control(public=True, max_age=1296000, immutable=True)(
     CORSMixin.decorator(get_schema_view(
-        title='MangAdventure API', version='2.3',
+        title='MangAdventure API', version='2.4',
         generator_class=OpenAPISchemaGenerator, public=True,
         renderer_classes=[JSONOpenAPIRenderer]  # type: ignore
     ))

docs/changelog.rst

@@ -4,6 +4,7 @@ Changelog
 v0.9.3
 ^^^^^^
 
+* Added more series statuses
 * Readded CSRF token
 
 v0.9.2

groups/models.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-from enum import Enum, EnumMeta
 from pathlib import PurePath
 from typing import List
 
@@ -23,17 +22,6 @@ def _logo_uploader(obj: Group, name: str) -> str:
     return str(obj.get_directory() / name)
 
 
-class _ChoiceMeta(EnumMeta):
-    def __new__(cls, name, bases, attrs):
-        klass = super().__new__(cls, name, (Enum,) + bases, attrs)
-        klass.do_not_call_in_templates = True
-        klass.__str__ = lambda self: self.name
-        return klass
-
-    def __iter__(cls):
-        return ((e.name, e.value) for e in super().__iter__())
-
-
 class Group(models.Model):
     """A model representing a group."""
     #: The group's ID.
@@ -168,16 +156,16 @@ def __str__(self) -> str:
 class Role(models.Model):
     """A model representing a role."""
 
-    class Choices(metaclass=_ChoiceMeta):
+    class Choices(models.TextChoices):
         """The possible role choices."""
-        LD = 'Leader'
-        TL = 'Translator'
-        PR = 'Proofreader'
-        CL = 'Cleaner'
-        RD = 'Redrawer'
-        TS = 'Typesetter'
-        RP = 'Raw Provider'
-        QC = 'Quality Checker'
+        LD = 'LD', 'Leader'
+        TL = 'TL', 'Translator'
+        PR = 'PR', 'Proofreader'
+        CL = 'CL', 'Cleaner'
+        RD = 'RD', 'Redrawer'
+        TS = 'TS', 'Typesetter'
+        RP = 'RP', 'Raw Provider'
+        QC = 'QC', 'Quality Checker'
 
     #: The member this role belongs to.
     member = models.ForeignKey(
@@ -188,7 +176,9 @@ class Choices(metaclass=_ChoiceMeta):
         Group, on_delete=models.CASCADE, related_name='roles'
     )
     #: The value of the role.
-    role = models.CharField(blank=False, max_length=2, choices=Choices)
+    role = models.CharField(
+        blank=False, max_length=2, choices=Choices.choices
+    )
 
     class Meta:
         verbose_name = 'role'

reader/admin.py

@@ -218,7 +218,7 @@ class SeriesAdmin(admin.ModelAdmin):
     inlines = (alias_inline('series'),)
     list_display = (
         'cover_image', 'title', 'manager', 'created',
-        'modified', 'views', 'completed', 'licensed'
+        'modified', 'views', 'status', 'licensed'
     )
     list_display_links = ('title',)
     date_hierarchy = 'created'
@@ -227,15 +227,13 @@ class SeriesAdmin(admin.ModelAdmin):
     search_fields = ('title', 'aliases__name')
     autocomplete_fields = ('categories',)
     list_filter = (
+        'status',
         ('authors', filters.related_filter('author')),
         ('artists', filters.related_filter('artist')),
         ('categories', filters.related_filter('category')),
-        filters.boolean_filter(
-            'status', 'completed', ('Completed', 'Ongoing')
-        ),
         ('manager', filters.related_filter('manager')),
     )
-    actions = ('toggle_completed', 'toggle_licensed')
+    actions = ('toggle_licensed',)
     empty_value_display = 'N/A'
 
     def get_form(self, request: HttpRequest, obj: Optional[Series]
@@ -286,17 +284,6 @@ def cover_image(self, obj: Series) -> str:
         """
         return utils.img_tag(obj.cover, 'cover', height=75)
 
-    @admin.display(   # type: ignore
-        description='Toggle status of selected series')
-    def toggle_completed(self, request: HttpRequest, queryset: QuerySet):
-        """
-        Toggle the publication status of the selected series.
-
-        :param request: The original request.
-        :param queryset: The original queryset.
-        """
-        queryset.update(completed=Q(completed=False))
-
     @admin.display(   # type: ignore
         description='Toggle licensing of selected series')
     def toggle_licensed(self, request: HttpRequest, queryset: QuerySet):