From patchwork Thu Apr 9 17:12:57 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 1268691 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [203.11.71.2]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 48ynm371gnz9sSM for ; Fri, 10 Apr 2020 03:13:23 +1000 (AEST) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=that.guru Authentication-Results: ozlabs.org; dkim=fail reason="key not found in DNS" header.d=that.guru header.i=@that.guru header.a=rsa-sha256 header.s=default header.b=K1TMLFIW; dkim-atps=neutral Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 48ynm35s8hzDqjc for ; Fri, 10 Apr 2020 03:13:23 +1000 (AEST) X-Original-To: patchwork@lists.ozlabs.org Delivered-To: patchwork@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=none (no SPF record) smtp.mailfrom=that.guru (client-ip=172.82.139.228; helo=qrelay228.mxroute.com; envelope-from=stephen@that.guru; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=that.guru Authentication-Results: lists.ozlabs.org; dkim=fail reason="key not found in DNS" header.d=that.guru header.i=@that.guru header.a=rsa-sha256 header.s=default header.b=K1TMLFIW; dkim-atps=neutral Received: from qrelay228.mxroute.com (qrelay228.mxroute.com [172.82.139.228]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 48ynlx6WQxzDqH6 for ; Fri, 10 Apr 2020 03:13:16 +1000 (AEST) Received: from filter003.mxroute.com ([168.235.111.26] 168-235-111-26.cloud.ramnode.com) (Authenticated sender: mN4UYu2MZsgR) by qrelay228.mxroute.com (ZoneMTA) with ESMTPA id 1715fee69ca0000d83.001 for ; Thu, 09 Apr 2020 17:13:12 +0000 X-Zone-Loop: dcc06ae7dd9186b15252b7e36b3fc1a4d94062900e10 X-Originating-IP: [168.235.111.26] Received: from one.mxroute.com (one.mxroute.com [195.201.59.211]) by filter003.mxroute.com (Postfix) with ESMTPS id 1384D60038 for ; Thu, 9 Apr 2020 17:13:11 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru; s=default; h=Content-Transfer-Encoding:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=S+b86Yu9K8tBrzKLdpjM7yvpuw+IewHJwNmcqz0EltM=; b=K1TMLFIW3pFurg3dbVHA4t8xDI EwisWcjiwyqBTDh0usSH/5duATeUGx5/UUWTG0VF9DEHId9OtTuabqe5sKIPl426vKmKwRLh/qvxe cp34QHKySe/d3mvqVKwtxLWKclydDSmBchJYB95AKi3S7awej6LwRqQumOq1IU4WocIDyqoFgSzsc TrUtkbMC1j0qjK+R17DQbl7dfZKbqW2aJ93hWAiYZKfbkuUgWXsQ3bFWL3GmrBqm37b9mc76NzLUr Fix26yWgefE5abNTPcI0HVDWQwixTRniyUXtgkn7HCVoUs/w8MEysVWXH342FCg408WROLOZvwiQD 8OCIpntw==; From: Stephen Finucane To: patchwork@lists.ozlabs.org Subject: [PATCH v2 1/6] trivial: Rename 'CoverLetter' references to 'Cover' Date: Thu, 9 Apr 2020 18:12:57 +0100 Message-Id: <20200409171302.105869-2-stephen@that.guru> X-Mailer: git-send-email 2.25.2 In-Reply-To: <20200409171302.105869-1-stephen@that.guru> References: <20200409171302.105869-1-stephen@that.guru> MIME-Version: 1.0 X-AuthUser: stephen@that.guru X-BeenThere: patchwork@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Patchwork development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Patchwork" We're going to be doing some model surgery shortly. Do the necessary renaming of variables ahead of this. Signed-off-by: Stephen Finucane --- docs/api/schemas/latest/patchwork.yaml | 14 +++++++------- docs/api/schemas/patchwork.j2 | 14 +++++++------- docs/api/schemas/v1.0/patchwork.yaml | 14 +++++++------- docs/api/schemas/v1.1/patchwork.yaml | 14 +++++++------- docs/api/schemas/v1.2/patchwork.yaml | 14 +++++++------- patchwork/api/cover.py | 24 ++++++++++++------------ patchwork/api/embedded.py | 2 +- patchwork/api/event.py | 4 ++-- patchwork/api/filters.py | 2 +- patchwork/api/series.py | 4 ++-- patchwork/tests/api/test_cover.py | 2 +- patchwork/tests/test_detail.py | 2 +- patchwork/urls.py | 4 ++-- 13 files changed, 57 insertions(+), 57 deletions(-) diff --git docs/api/schemas/latest/patchwork.yaml docs/api/schemas/latest/patchwork.yaml index 13cdc9cd..082248a3 100644 --- docs/api/schemas/latest/patchwork.yaml +++ docs/api/schemas/latest/patchwork.yaml @@ -257,7 +257,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/CoverLetterList' + $ref: '#/components/schemas/CoverList' tags: - covers /api/covers/{id}/: @@ -278,7 +278,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CoverLetterDetail' + $ref: '#/components/schemas/CoverDetail' '404': description: Not found content: @@ -1573,7 +1573,7 @@ components: items: type: string readOnly: true - CoverLetterList: + CoverList: type: object properties: id: @@ -1635,9 +1635,9 @@ components: type: string format: uri readOnly: true - CoverLetterDetail: + CoverDetail: allOf: - - $ref: '#/components/schemas/CoverLetterList' + - $ref: '#/components/schemas/CoverList' - properties: headers: title: Headers @@ -2169,7 +2169,7 @@ components: format: uri readOnly: true cover_letter: - $ref: '#/components/schemas/CoverLetterEmbedded' + $ref: '#/components/schemas/CoverEmbedded' patches: title: Patches type: array @@ -2282,7 +2282,7 @@ components: maxLength: 255 minLength: 1 readOnly: true - CoverLetterEmbedded: + CoverEmbedded: type: object properties: id: diff --git docs/api/schemas/patchwork.j2 docs/api/schemas/patchwork.j2 index bd714d5e..91faef88 100644 --- docs/api/schemas/patchwork.j2 +++ docs/api/schemas/patchwork.j2 @@ -262,7 +262,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/CoverLetterList' + $ref: '#/components/schemas/CoverList' tags: - covers /api/{{ version_url }}covers/{id}/: @@ -283,7 +283,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CoverLetterDetail' + $ref: '#/components/schemas/CoverDetail' '404': description: Not found content: @@ -1629,7 +1629,7 @@ components: items: type: string readOnly: true - CoverLetterList: + CoverList: type: object properties: id: @@ -1699,9 +1699,9 @@ components: format: uri readOnly: true {% endif %} - CoverLetterDetail: + CoverDetail: allOf: - - $ref: '#/components/schemas/CoverLetterList' + - $ref: '#/components/schemas/CoverList' - properties: headers: title: Headers @@ -2253,7 +2253,7 @@ components: format: uri readOnly: true cover_letter: - $ref: '#/components/schemas/CoverLetterEmbedded' + $ref: '#/components/schemas/CoverEmbedded' patches: title: Patches type: array @@ -2368,7 +2368,7 @@ components: maxLength: 255 minLength: 1 readOnly: true - CoverLetterEmbedded: + CoverEmbedded: type: object properties: id: diff --git docs/api/schemas/v1.0/patchwork.yaml docs/api/schemas/v1.0/patchwork.yaml index 6c7c068a..642c7773 100644 --- docs/api/schemas/v1.0/patchwork.yaml +++ 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: @@ -1389,7 +1389,7 @@ components: items: type: string readOnly: true - CoverLetterList: + CoverList: type: object properties: id: @@ -1431,9 +1431,9 @@ components: items: $ref: '#/components/schemas/SeriesEmbedded' readOnly: true - CoverLetterDetail: + CoverDetail: allOf: - - $ref: '#/components/schemas/CoverLetterList' + - $ref: '#/components/schemas/CoverList' - properties: headers: title: Headers @@ -1881,7 +1881,7 @@ components: format: uri readOnly: true cover_letter: - $ref: '#/components/schemas/CoverLetterEmbedded' + $ref: '#/components/schemas/CoverEmbedded' patches: title: Patches type: array @@ -1967,7 +1967,7 @@ components: maxLength: 255 minLength: 1 readOnly: true - CoverLetterEmbedded: + CoverEmbedded: type: object properties: id: diff --git docs/api/schemas/v1.1/patchwork.yaml docs/api/schemas/v1.1/patchwork.yaml index 6b497aba..e91457e5 100644 --- docs/api/schemas/v1.1/patchwork.yaml +++ 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: @@ -1399,7 +1399,7 @@ components: items: type: string readOnly: true - CoverLetterList: + CoverList: type: object properties: id: @@ -1456,9 +1456,9 @@ components: type: string format: uri readOnly: true - CoverLetterDetail: + CoverDetail: allOf: - - $ref: '#/components/schemas/CoverLetterList' + - $ref: '#/components/schemas/CoverList' - properties: headers: title: Headers @@ -1950,7 +1950,7 @@ components: format: uri readOnly: true cover_letter: - $ref: '#/components/schemas/CoverLetterEmbedded' + $ref: '#/components/schemas/CoverEmbedded' patches: title: Patches type: array @@ -2036,7 +2036,7 @@ components: maxLength: 255 minLength: 1 readOnly: true - CoverLetterEmbedded: + CoverEmbedded: type: object properties: id: diff --git docs/api/schemas/v1.2/patchwork.yaml docs/api/schemas/v1.2/patchwork.yaml index db2ed122..ed1cb5af 100644 --- docs/api/schemas/v1.2/patchwork.yaml +++ docs/api/schemas/v1.2/patchwork.yaml @@ -257,7 +257,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/CoverLetterList' + $ref: '#/components/schemas/CoverList' tags: - covers /api/1.2/covers/{id}/: @@ -278,7 +278,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CoverLetterDetail' + $ref: '#/components/schemas/CoverDetail' '404': description: Not found content: @@ -1573,7 +1573,7 @@ components: items: type: string readOnly: true - CoverLetterList: + CoverList: type: object properties: id: @@ -1635,9 +1635,9 @@ components: type: string format: uri readOnly: true - CoverLetterDetail: + CoverDetail: allOf: - - $ref: '#/components/schemas/CoverLetterList' + - $ref: '#/components/schemas/CoverList' - properties: headers: title: Headers @@ -2169,7 +2169,7 @@ components: format: uri readOnly: true cover_letter: - $ref: '#/components/schemas/CoverLetterEmbedded' + $ref: '#/components/schemas/CoverEmbedded' patches: title: Patches type: array @@ -2282,7 +2282,7 @@ components: maxLength: 255 minLength: 1 readOnly: true - CoverLetterEmbedded: + CoverEmbedded: type: object properties: id: diff --git patchwork/api/cover.py patchwork/api/cover.py index c0c27fe8..66d2146c 100644 --- patchwork/api/cover.py +++ 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 patchwork/api/embedded.py patchwork/api/embedded.py index 85a30cae..d2300dff 100644 --- patchwork/api/embedded.py +++ patchwork/api/embedded.py @@ -103,7 +103,7 @@ class CheckSerializer(SerializedRelatedField): } -class CoverLetterSerializer(SerializedRelatedField): +class CoverSerializer(SerializedRelatedField): class _Serializer(MboxMixin, WebURLMixin, BaseHyperlinkedModelSerializer): diff --git patchwork/api/event.py patchwork/api/event.py index d7a99c7d..7ed9efb1 100644 --- patchwork/api/event.py +++ 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 patchwork/api/filters.py patchwork/api/filters.py index deb5ace1..80b17232 100644 --- patchwork/api/filters.py +++ patchwork/api/filters.py @@ -184,7 +184,7 @@ class SeriesFilterSet(TimestampMixin, BaseFilterSet): fields = ('submitter', 'project') -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 patchwork/api/series.py patchwork/api/series.py index e4cffaa3..106e60f0 100644 --- patchwork/api/series.py +++ 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 patchwork/tests/api/test_cover.py patchwork/tests/api/test_cover.py index 5eeb1902..4f3ad841 100644 --- patchwork/tests/api/test_cover.py +++ 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 patchwork/tests/test_detail.py patchwork/tests/test_detail.py index 92fe2d7e..ddc2b937 100644 --- patchwork/tests/test_detail.py +++ 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 patchwork/urls.py patchwork/urls.py index dcdcfb49..9c3b85f0 100644 --- patchwork/urls.py +++ 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[^/]+)/$', - 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(),