trivial: Rename 'CoverLetter' references to 'Cover'

We're going to be doing some model surgery shortly. Do the necessary
renaming of variables ahead of this.

Signed-off-by: Stephen Finucane <stephen@that.guru>

diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
index 20ca90e3a8e8e6835bba1edee93daf94068c6658..a8910a7c4238f6ca1beb4b0eb4666d13ea64a3a3 100644 (file)
--- a/docs/api/schemas/latest/patchwork.yaml
+++ b/docs/api/schemas/latest/patchwork.yaml
@@ -249,7 +249,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/CoverLetterList'
+                  $ref: '#/components/schemas/CoverList'
       tags:
         - covers
   /api/covers/{id}/:
@@ -270,7 +270,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CoverLetterDetail'
+                $ref: '#/components/schemas/CoverDetail'
         '404':
           description: Not found
           content:
@@ -1528,7 +1528,7 @@ components:
               additionalProperties:
                 type: string
           readOnly: true
-    CoverLetterList:
+    CoverList:
       type: object
       properties:
         id:
@@ -1590,9 +1590,9 @@ components:
           type: string
           format: uri
           readOnly: true
-    CoverLetterDetail:
+    CoverDetail:
       allOf:
-        - $ref: '#/components/schemas/CoverLetterList'
+        - $ref: '#/components/schemas/CoverList'
         - properties:
             headers:
               title: Headers
@@ -1652,7 +1652,7 @@ components:
             payload:
               properties:
                 cover:
-                  $ref: '#/components/schemas/CoverLetterEmbedded'
+                  $ref: '#/components/schemas/CoverEmbedded'
     EventPatchCreated:
       allOf:
         - $ref: '#/components/schemas/EventBase'
@@ -2131,7 +2131,7 @@ components:
           format: uri
           readOnly: true
         cover_letter:
-          $ref: '#/components/schemas/CoverLetterEmbedded'
+          $ref: '#/components/schemas/CoverEmbedded'
         patches:
           title: Patches
           type: array
@@ -2244,7 +2244,7 @@ components:
           maxLength: 255
           minLength: 1
           readOnly: true
-    CoverLetterEmbedded:
+    CoverEmbedded:
       type: object
       properties:
         id:

diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2
index 1ec3848a3f3e85339a80bb0fb14c658a8a0d1435..c55f6f45a2a945a5807b68d5b25739e32e6c6a70 100644 (file)
--- a/docs/api/schemas/patchwork.j2
+++ b/docs/api/schemas/patchwork.j2
@@ -256,7 +256,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/CoverLetterList'
+                  $ref: '#/components/schemas/CoverList'
       tags:
         - covers
   /api/{{ version_url }}covers/{id}/:
@@ -277,7 +277,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CoverLetterDetail'
+                $ref: '#/components/schemas/CoverDetail'
         '404':
           description: Not found
           content:
@@ -1586,7 +1586,7 @@ components:
               additionalProperties:
                 type: string
           readOnly: true
-    CoverLetterList:
+    CoverList:
       type: object
       properties:
         id:
@@ -1656,9 +1656,9 @@ components:
           format: uri
           readOnly: true
 {% endif %}
-    CoverLetterDetail:
+    CoverDetail:
       allOf:
-        - $ref: '#/components/schemas/CoverLetterList'
+        - $ref: '#/components/schemas/CoverList'
         - properties:
             headers:
               title: Headers
@@ -1720,7 +1720,7 @@ components:
             payload:
               properties:
                 cover:
-                  $ref: '#/components/schemas/CoverLetterEmbedded'
+                  $ref: '#/components/schemas/CoverEmbedded'
     EventPatchCreated:
       allOf:
         - $ref: '#/components/schemas/EventBase'
@@ -2217,7 +2217,7 @@ components:
           format: uri
           readOnly: true
         cover_letter:
-          $ref: '#/components/schemas/CoverLetterEmbedded'
+          $ref: '#/components/schemas/CoverEmbedded'
         patches:
           title: Patches
           type: array
@@ -2332,7 +2332,7 @@ components:
           maxLength: 255
           minLength: 1
           readOnly: true
-    CoverLetterEmbedded:
+    CoverEmbedded:
       type: object
       properties:
         id:

diff --git a/docs/api/schemas/v1.0/patchwork.yaml b/docs/api/schemas/v1.0/patchwork.yaml
index e946c9e8e294f636d17e1eade77ab5f0785d7695..23e8930a3f6c86a6f99bb8a9a67910cf0628f278 100644 (file)
--- a/docs/api/schemas/v1.0/patchwork.yaml
+++ b/docs/api/schemas/v1.0/patchwork.yaml
@@ -142,7 +142,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/CoverLetterList'
+                  $ref: '#/components/schemas/CoverList'
       tags:
         - covers
   /api/1.0/covers/{id}/:
@@ -163,7 +163,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CoverLetterDetail'
+                $ref: '#/components/schemas/CoverDetail'
         '404':
           description: Not found
           content:
@@ -1344,7 +1344,7 @@ components:
               additionalProperties:
                 type: string
           readOnly: true
-    CoverLetterList:
+    CoverList:
       type: object
       properties:
         id:
@@ -1386,9 +1386,9 @@ components:
           items:
             $ref: '#/components/schemas/SeriesEmbedded'
           readOnly: true
-    CoverLetterDetail:
+    CoverDetail:
       allOf:
-        - $ref: '#/components/schemas/CoverLetterList'
+        - $ref: '#/components/schemas/CoverList'
         - properties:
             headers:
               title: Headers
@@ -1440,7 +1440,7 @@ components:
             payload:
               properties:
                 cover:
-                  $ref: '#/components/schemas/CoverLetterEmbedded'
+                  $ref: '#/components/schemas/CoverEmbedded'
     EventPatchCreated:
       allOf:
         - $ref: '#/components/schemas/EventBase'
@@ -1842,7 +1842,7 @@ components:
           format: uri
           readOnly: true
         cover_letter:
-          $ref: '#/components/schemas/CoverLetterEmbedded'
+          $ref: '#/components/schemas/CoverEmbedded'
         patches:
           title: Patches
           type: array
@@ -1928,7 +1928,7 @@ components:
           maxLength: 255
           minLength: 1
           readOnly: true
-    CoverLetterEmbedded:
+    CoverEmbedded:
       type: object
       properties:
         id:

diff --git a/docs/api/schemas/v1.1/patchwork.yaml b/docs/api/schemas/v1.1/patchwork.yaml
index 614a7fb82f34ff6f9e8d9b325ad5c1871e9809cd..5acd33a7a19e79b8eaa0af32e9555685833f5695 100644 (file)
--- a/docs/api/schemas/v1.1/patchwork.yaml
+++ b/docs/api/schemas/v1.1/patchwork.yaml
@@ -142,7 +142,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/CoverLetterList'
+                  $ref: '#/components/schemas/CoverList'
       tags:
         - covers
   /api/1.1/covers/{id}/:
@@ -163,7 +163,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CoverLetterDetail'
+                $ref: '#/components/schemas/CoverDetail'
         '404':
           description: Not found
           content:
@@ -1354,7 +1354,7 @@ components:
               additionalProperties:
                 type: string
           readOnly: true
-    CoverLetterList:
+    CoverList:
       type: object
       properties:
         id:
@@ -1411,9 +1411,9 @@ components:
           type: string
           format: uri
           readOnly: true
-    CoverLetterDetail:
+    CoverDetail:
       allOf:
-        - $ref: '#/components/schemas/CoverLetterList'
+        - $ref: '#/components/schemas/CoverList'
         - properties:
             headers:
               title: Headers
@@ -1465,7 +1465,7 @@ components:
             payload:
               properties:
                 cover:
-                  $ref: '#/components/schemas/CoverLetterEmbedded'
+                  $ref: '#/components/schemas/CoverEmbedded'
     EventPatchCreated:
       allOf:
         - $ref: '#/components/schemas/EventBase'
@@ -1911,7 +1911,7 @@ components:
           format: uri
           readOnly: true
         cover_letter:
-          $ref: '#/components/schemas/CoverLetterEmbedded'
+          $ref: '#/components/schemas/CoverEmbedded'
         patches:
           title: Patches
           type: array
@@ -1997,7 +1997,7 @@ components:
           maxLength: 255
           minLength: 1
           readOnly: true
-    CoverLetterEmbedded:
+    CoverEmbedded:
       type: object
       properties:
         id:

diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml
index 654549310853b2f932baf8790d2d3ab9a0adea71..712d137ed04038ae218b7045a5009ec0a818b037 100644 (file)
--- a/docs/api/schemas/v1.2/patchwork.yaml
+++ b/docs/api/schemas/v1.2/patchwork.yaml
@@ -249,7 +249,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/CoverLetterList'
+                  $ref: '#/components/schemas/CoverList'
       tags:
         - covers
   /api/1.2/covers/{id}/:
@@ -270,7 +270,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CoverLetterDetail'
+                $ref: '#/components/schemas/CoverDetail'
         '404':
           description: Not found
           content:
@@ -1528,7 +1528,7 @@ components:
               additionalProperties:
                 type: string
           readOnly: true
-    CoverLetterList:
+    CoverList:
       type: object
       properties:
         id:
@@ -1590,9 +1590,9 @@ components:
           type: string
           format: uri
           readOnly: true
-    CoverLetterDetail:
+    CoverDetail:
       allOf:
-        - $ref: '#/components/schemas/CoverLetterList'
+        - $ref: '#/components/schemas/CoverList'
         - properties:
             headers:
               title: Headers
@@ -1652,7 +1652,7 @@ components:
             payload:
               properties:
                 cover:
-                  $ref: '#/components/schemas/CoverLetterEmbedded'
+                  $ref: '#/components/schemas/CoverEmbedded'
     EventPatchCreated:
       allOf:
         - $ref: '#/components/schemas/EventBase'
@@ -2131,7 +2131,7 @@ components:
           format: uri
           readOnly: true
         cover_letter:
-          $ref: '#/components/schemas/CoverLetterEmbedded'
+          $ref: '#/components/schemas/CoverEmbedded'
         patches:
           title: Patches
           type: array
@@ -2244,7 +2244,7 @@ components:
           maxLength: 255
           minLength: 1
           readOnly: true
-    CoverLetterEmbedded:
+    CoverEmbedded:
       type: object
       properties:
         id:

diff --git a/patchwork/api/cover.py b/patchwork/api/cover.py
index c0c27fe8ece4f1411bb31dca742cc2fee3488054..66d2146cc9b2b9b670a78272490a9fce50e82a1f 100644 (file)
--- a/patchwork/api/cover.py
+++ b/patchwork/api/cover.py
@@ -11,14 +11,14 @@ from rest_framework.reverse import reverse
 from rest_framework.serializers import SerializerMethodField
 
 from patchwork.api.base import BaseHyperlinkedModelSerializer
-from patchwork.api.filters import CoverLetterFilterSet
+from patchwork.api.filters import CoverFilterSet
 from patchwork.api.embedded import PersonSerializer
 from patchwork.api.embedded import ProjectSerializer
 from patchwork.api.embedded import SeriesSerializer
 from patchwork.models import CoverLetter
 
 
-class CoverLetterListSerializer(BaseHyperlinkedModelSerializer):
+class CoverListSerializer(BaseHyperlinkedModelSerializer):
 
     web_url = SerializerMethodField()
     project = ProjectSerializer(read_only=True)
@@ -43,7 +43,7 @@ class CoverLetterListSerializer(BaseHyperlinkedModelSerializer):
         # NOTE(stephenfin): This is here to ensure our API looks the same even
         # after we changed the series-patch relationship from M:N to 1:N. It
         # will be removed in API v2
-        data = super(CoverLetterListSerializer, self).to_representation(
+        data = super(CoverListSerializer, self).to_representation(
             instance)
         data['series'] = [data['series']] if data['series'] else []
         return data
@@ -63,7 +63,7 @@ class CoverLetterListSerializer(BaseHyperlinkedModelSerializer):
         }
 
 
-class CoverLetterDetailSerializer(CoverLetterListSerializer):
+class CoverDetailSerializer(CoverListSerializer):
 
     headers = SerializerMethodField()
 
@@ -83,18 +83,18 @@ class CoverLetterDetailSerializer(CoverLetterListSerializer):
 
     class Meta:
         model = CoverLetter
-        fields = CoverLetterListSerializer.Meta.fields + (
+        fields = CoverListSerializer.Meta.fields + (
             'headers', 'content')
         read_only_fields = fields
-        extra_kwargs = CoverLetterListSerializer.Meta.extra_kwargs
-        versioned_fields = CoverLetterListSerializer.Meta.versioned_fields
+        extra_kwargs = CoverListSerializer.Meta.extra_kwargs
+        versioned_fields = CoverListSerializer.Meta.versioned_fields
 
 
-class CoverLetterList(ListAPIView):
+class CoverList(ListAPIView):
     """List cover letters."""
 
-    serializer_class = CoverLetterListSerializer
-    filter_class = filterset_class = CoverLetterFilterSet
+    serializer_class = CoverListSerializer
+    filter_class = filterset_class = CoverFilterSet
     search_fields = ('name',)
     ordering_fields = ('id', 'name', 'date', 'submitter')
     ordering = 'id'
@@ -106,10 +106,10 @@ class CoverLetterList(ListAPIView):
             .defer('content', 'headers')
 
 
-class CoverLetterDetail(RetrieveAPIView):
+class CoverDetail(RetrieveAPIView):
     """Show a cover letter."""
 
-    serializer_class = CoverLetterDetailSerializer
+    serializer_class = CoverDetailSerializer
 
     def get_queryset(self):
         return CoverLetter.objects.all()\

diff --git a/patchwork/api/embedded.py b/patchwork/api/embedded.py
index cb3f07e6b998da8373976de6aaeec6131d62b2df..1478e748865e9b2a9f724f4d69a6f69d237924de 100644 (file)
--- a/patchwork/api/embedded.py
+++ b/patchwork/api/embedded.py
@@ -103,7 +103,7 @@ class CheckSerializer(SerializedRelatedField):
             }
 
 
-class CoverLetterSerializer(SerializedRelatedField):
+class CoverSerializer(SerializedRelatedField):
 
     class _Serializer(MboxMixin, WebURLMixin, BaseHyperlinkedModelSerializer):
 

diff --git a/patchwork/api/event.py b/patchwork/api/event.py
index d7a99c7dfa0873effc16e93ede93b8e36d9933d8..7ed9efb1ecc977ff621ca25f37eca155246f8b9f 100644 (file)
--- a/patchwork/api/event.py
+++ b/patchwork/api/event.py
@@ -11,7 +11,7 @@ from rest_framework.serializers import SerializerMethodField
 from rest_framework.serializers import SlugRelatedField
 
 from patchwork.api.embedded import CheckSerializer
-from patchwork.api.embedded import CoverLetterSerializer
+from patchwork.api.embedded import CoverSerializer
 from patchwork.api.embedded import PatchSerializer
 from patchwork.api.embedded import PatchRelationSerializer
 from patchwork.api.embedded import ProjectSerializer
@@ -27,7 +27,7 @@ class EventSerializer(ModelSerializer):
     actor = UserSerializer()
     patch = PatchSerializer(read_only=True)
     series = SeriesSerializer(read_only=True)
-    cover = CoverLetterSerializer(read_only=True)
+    cover = CoverSerializer(read_only=True)
     previous_state = SlugRelatedField(slug_field='slug', read_only=True)
     current_state = SlugRelatedField(slug_field='slug', read_only=True)
     previous_delegate = UserSerializer()

diff --git a/patchwork/api/filters.py b/patchwork/api/filters.py
index 93e6281bf5e66141208afb21f40cc0f542eeb5c6..a328d594f5b5a01615978193e62113ec45d36950 100644 (file)
--- a/patchwork/api/filters.py
+++ b/patchwork/api/filters.py
@@ -188,7 +188,7 @@ def msgid_filter(queryset, name, value):
     return queryset.filter(**{name: '<' + value + '>'})
 
 
-class CoverLetterFilterSet(TimestampMixin, BaseFilterSet):
+class CoverFilterSet(TimestampMixin, BaseFilterSet):
 
     project = ProjectFilter(queryset=Project.objects.all(), distinct=False)
     # NOTE(stephenfin): We disable the select-based HTML widgets for these

diff --git a/patchwork/api/series.py b/patchwork/api/series.py
index e4cffaa3b384627855f2e5ab06fe5d2986c5a974..106e60f036fd817d7725fce104deb262f38d0406 100644 (file)
--- a/patchwork/api/series.py
+++ b/patchwork/api/series.py
@@ -10,7 +10,7 @@ from rest_framework.serializers import SerializerMethodField
 from patchwork.api.base import BaseHyperlinkedModelSerializer
 from patchwork.api.base import PatchworkPermission
 from patchwork.api.filters import SeriesFilterSet
-from patchwork.api.embedded import CoverLetterSerializer
+from patchwork.api.embedded import CoverSerializer
 from patchwork.api.embedded import PatchSerializer
 from patchwork.api.embedded import PersonSerializer
 from patchwork.api.embedded import ProjectSerializer
@@ -23,7 +23,7 @@ class SeriesSerializer(BaseHyperlinkedModelSerializer):
     project = ProjectSerializer(read_only=True)
     submitter = PersonSerializer(read_only=True)
     mbox = SerializerMethodField()
-    cover_letter = CoverLetterSerializer(read_only=True)
+    cover_letter = CoverSerializer(read_only=True)
     patches = PatchSerializer(read_only=True, many=True)
 
     def get_web_url(self, instance):

diff --git a/patchwork/tests/api/test_cover.py b/patchwork/tests/api/test_cover.py
index 1b19ded1b4d51d138d1f256ca6e42eff11b1cdb6..806ee6a4834d51ecc9d6f3d29fe1c01be8ee62f8 100644 (file)
--- a/patchwork/tests/api/test_cover.py
+++ b/patchwork/tests/api/test_cover.py
@@ -21,7 +21,7 @@ if settings.ENABLE_REST_API:
 
 
 @unittest.skipUnless(settings.ENABLE_REST_API, 'requires ENABLE_REST_API')
-class TestCoverLetterAPI(utils.APITestCase):
+class TestCoverAPI(utils.APITestCase):
     fixtures = ['default_tags']
 
     @staticmethod

diff --git a/patchwork/tests/test_detail.py b/patchwork/tests/test_detail.py
index 92fe2d7e6cc4962eb70576f19d496ee247aaa440..ddc2b937b074451883f4e798e43b49bf7c729cde 100644 (file)
--- a/patchwork/tests/test_detail.py
+++ b/patchwork/tests/test_detail.py
@@ -12,7 +12,7 @@ from patchwork.tests.utils import create_patch
 from patchwork.tests.utils import create_project
 
 
-class CoverLetterViewTest(TestCase):
+class CoverViewTest(TestCase):
 
     def test_redirect(self):
         patch = create_patch()

diff --git a/patchwork/urls.py b/patchwork/urls.py
index dcdcfb49e67ec0fbe2a1771af93281c398b501c6..9c3b85f007a74369bf8332ea00a9c7ca9851fc27 100644 (file)
--- a/patchwork/urls.py
+++ b/patchwork/urls.py
@@ -207,10 +207,10 @@ if settings.ENABLE_REST_API:
             api_person_views.PersonDetail.as_view(),
             name='api-person-detail'),
         url(r'^covers/$',
-            api_cover_views.CoverLetterList.as_view(),
+            api_cover_views.CoverList.as_view(),
             name='api-cover-list'),
         url(r'^covers/(?P<pk>[^/]+)/$',
-            api_cover_views.CoverLetterDetail.as_view(),
+            api_cover_views.CoverDetail.as_view(),
             name='api-cover-detail'),
         url(r'^patches/$',
             api_patch_views.PatchList.as_view(),