feat: add support to write a content warning for posts

Author: aitorres

lib/data/status.dart

@@ -53,6 +53,9 @@ class Status {
   // Status visibility
   final StatusVisibility visibility;
 
+  // Spoiler text (content warning)
+  final String spoilerText;
+
   Status({
     required this.id,
     required this.createdAt,
@@ -65,6 +68,7 @@ class Status {
     required this.reblogsCount,
     required this.repliesCount,
     required this.visibility,
+    required this.spoilerText,
     this.reblog,
   });
 
@@ -83,6 +87,7 @@ class Status {
       reblogsCount: data["reblogs_count"]!,
       repliesCount: data["replies_count"]!,
       visibility: StatusVisibility.values.byName(data["visibility"]!),
+      spoilerText: data["spoiler_text"]!,
       reblog: data["reblog"] == null ? null : Status.fromJson(data["reblog"]),
     );
   }

lib/services/api.dart

@@ -272,12 +272,15 @@ class ApiService {
   /// on the user's timeline. Returns the (new) [Status] instance the API
   /// responds with.
   Future<Status> postStatus(String content,
-      {Status? replyToStatus, StatusVisibility? visibility}) async {
+      {Status? replyToStatus,
+      StatusVisibility visibility = StatusVisibility.public,
+      String spoilerText = ""}) async {
     final apiUrl = "${instanceUrl!}/api/v1/statuses";
     // TODO: Support sensitivity, language, scheduling, polls and media
     Map<String, String> body = {
       "status": content,
-      "visibility": (visibility ?? StatusVisibility.public).name,
+      "visibility": visibility.name,
+      "spoiler_text": spoilerText,
     };
     if (replyToStatus != null) {
       body["in_reply_to_id"] = replyToStatus.id;

lib/widgets/status_form.dart

@@ -72,6 +72,10 @@ class StatusFormState extends State<StatusForm> {
   /// value set on the input field on this class.
   final statusController = TextEditingController();
 
+  /// Controller for the `spoilerText` text field, to preserve and access the
+  /// value set on the input field on this class.
+  final spoilerTextController = TextEditingController();
+
   /// Selected visibility for the status.
   StatusVisibility selectedVisibility = StatusVisibility.public;
 
@@ -128,6 +132,13 @@ class StatusFormState extends State<StatusForm> {
             });
           },
         ),
+        TextFormField(
+          keyboardType: TextInputType.text,
+          decoration: InputDecoration(
+            helperText: "Content warning (optional)",
+          ),
+          controller: spoilerTextController,
+        ),
         FeathrActionButton(
           onPressed: () async {
             if (_formKey.currentState!.validate()) {
@@ -140,6 +151,7 @@ class StatusFormState extends State<StatusForm> {
                   statusController.text,
                   replyToStatus: widget.replyToStatus,
                   visibility: selectedVisibility,
+                  spoilerText: spoilerTextController.text,
                 );
               } catch (e) {
                 // Show an error message if the status couldn't be posted

test/data_test/status_test.dart

@@ -14,6 +14,7 @@ void main() {
     "favourites_count": 1,
     "reblogs_count": 0,
     "replies_count": 0,
+    "spoiler_text": "",
     "account": {
       "id": "this is an id",
       "username": "username123",
@@ -38,6 +39,7 @@ void main() {
     "favourites_count": 1,
     "reblogs_count": 0,
     "replies_count": 0,
+    "spoiler_text": "",
     "account": {
       "id": "this is an id",
       "username": "username123",
@@ -59,6 +61,7 @@ void main() {
       "favourites_count": 1,
       "replies_count": 0,
       "reblogs_count": 0,
+      "spoiler_text": "",
       "account": {
         "id": "this is another id",
         "username": "username456",

test/services_test/api_test.dart

@@ -115,7 +115,7 @@ void main() {
                 httpClient: mockClient))
             .thenAnswer(
           (_) async => http.Response(
-            '{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"public","content":"<p>I am a toot!</p>","favourited":true,"bookmarked":false,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}',
+            '{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"public","content":"<p>I am a toot!</p>","favourited":true,"bookmarked":false,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"spoiler_text":"","account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}',
             200,
           ),
         );
@@ -186,7 +186,7 @@ void main() {
                 httpClient: mockClient))
             .thenAnswer(
           (_) async => http.Response(
-            '{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"private","content":"<p>I am a toot!</p>","favourited":false,"bookmarked":false,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}',
+            '{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"private","content":"<p>I am a toot!</p>","favourited":false,"bookmarked":false,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"spoiler_text":"","account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}',
             200,
           ),
         );
@@ -254,7 +254,7 @@ void main() {
                 httpClient: mockClient))
             .thenAnswer(
           (_) async => http.Response(
-            '{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"unlisted","content":"<p>I am a toot!</p>","favourited":true,"bookmarked":true,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}',
+            '{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"unlisted","content":"<p>I am a toot!</p>","favourited":true,"bookmarked":true,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"spoiler_text":"","account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}',
             200,
           ),
         );
@@ -322,7 +322,7 @@ void main() {
                 httpClient: mockClient))
             .thenAnswer(
           (_) async => http.Response(
-            '{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"public","content":"<p>I am a toot!</p>","favourited":false,"bookmarked":false,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}',
+            '{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"public","content":"<p>I am a toot!</p>","favourited":false,"bookmarked":false,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"spoiler_text":"","account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}',
             200,
           ),
         );
@@ -386,7 +386,7 @@ void main() {
                 httpClient: mockClient))
             .thenAnswer(
           (_) async => http.Response(
-            '{"reblog":{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"public","content":"<p>I am a toot!</p>","favourited":true,"bookmarked":true,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}}',
+            '{"reblog":{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"public","content":"<p>I am a toot!</p>","favourited":true,"bookmarked":true,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"spoiler_text":"","account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}}',
             200,
           ),
         );
@@ -453,7 +453,7 @@ void main() {
                 httpClient: mockClient))
             .thenAnswer(
           (_) async => http.Response(
-            '{"reblog":{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"public","content":"<p>I am a toot!</p>","favourited":true,"bookmarked":true,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}}',
+            '{"reblog":{"id":"$testStatusId","created_at": "2025-01-01T00:00:00Z","visibility":"public","content":"<p>I am a toot!</p>","favourited":true,"bookmarked":true,"reblogged":true,"favourites_count":1,"reblogs_count":3,"replies_count":2,"spoiler_text":"","account":{"id":"this is an id","username":"username123","acct":"username123","display_name":"user display name","locked":false,"bot":true,"avatar":"avatar-url","header":"header-url"}}}',
             200,
           ),
         );
@@ -698,7 +698,7 @@ void main() {
         httpClient: mockClient,
       )).thenAnswer(
         (_) async => http.Response(
-          '[{"id": "1", "created_at": "2025-01-01T00:00:00Z", "visibility": "public", "content": "<p>Status 1</p>", "favourited": false, "bookmarked": false, "reblogged": false, "favourites_count": 0, "reblogs_count": 0, "replies_count": 2, "account": {"id": "account1", "username": "user1", "acct": "user1", "display_name": "User One", "locked": false, "bot": false, "avatar": "avatar1-url", "header": "header1-url"}}, {"id": "2", "created_at": "2025-01-02T00:00:00Z", "visibility": "public", "content": "<p>Status 2</p>", "favourited": false, "bookmarked": false, "reblogged": false, "favourites_count": 0, "reblogs_count": 0, "replies_count": 2, "account": {"id": "account2", "username": "user2", "acct": "user2", "display_name": "User Two", "locked": false, "bot": false, "avatar": "avatar2-url", "header": "header2-url"}}]',
+          '[{"id": "1", "created_at": "2025-01-01T00:00:00Z", "visibility": "public", "content": "<p>Status 1</p>", "favourited": false, "bookmarked": false, "reblogged": false, "favourites_count": 0, "reblogs_count": 0, "replies_count": 2, "spoiler_text": "", "account": {"id": "account1", "username": "user1", "acct": "user1", "display_name": "User One", "locked": false, "bot": false, "avatar": "avatar1-url", "header": "header1-url"}}, {"id": "2", "created_at": "2025-01-02T00:00:00Z", "visibility": "public", "content": "<p>Status 2</p>", "favourited": false, "bookmarked": false, "reblogged": false, "favourites_count": 0, "reblogs_count": 0, "replies_count": 2, "spoiler_text": "", "account": {"id": "account2", "username": "user2", "acct": "user2", "display_name": "User Two", "locked": false, "bot": false, "avatar": "avatar2-url", "header": "header2-url"}}]',
           200,
         ),
       );
@@ -728,11 +728,15 @@ void main() {
 
       when(mockHelper.post(
         "https://example.org/api/v1/statuses",
-        body: {"status": "Hello, world!", "visibility": "public"},
+        body: {
+          "status": "Hello, world!",
+          "visibility": "public",
+          "spoiler_text": ""
+        },
         httpClient: mockClient,
       )).thenAnswer(
         (_) async => http.Response(
-          '{"id": "1", "created_at": "2025-01-01T00:00:00Z", "visibility": "public", "content": "<p>Hello, world!</p>", "favourited": false, "bookmarked": false, "reblogged": false, "favourites_count": 0, "reblogs_count": 0, "replies_count": 2, "account": {"id": "account1", "username": "user1", "acct": "user1", "display_name": "User One", "locked": false, "bot": false, "avatar": "avatar1-url", "header": "header1-url"}}',
+          '{"id": "1", "created_at": "2025-01-01T00:00:00Z", "visibility": "public", "content": "<p>Hello, world!</p>", "favourited": false, "bookmarked": false, "reblogged": false, "favourites_count": 0, "reblogs_count": 0, "replies_count": 2, "spoiler_text": "", "account": {"id": "account1", "username": "user1", "acct": "user1", "display_name": "User One", "locked": false, "bot": false, "avatar": "avatar1-url", "header": "header1-url"}}',
           200,
         ),
       );

test/widgets_test/status_card_test.dart

@@ -24,7 +24,8 @@ void main() {
           favouritesCount: 10,
           reblogsCount: 5,
           repliesCount: 2,
-          visibility: StatusVisibility.public);
+          visibility: StatusVisibility.public,
+          spoilerText: "");
 
       await tester.pumpWidget(
         MaterialApp(

test/widgets_test/status_form_test.dart

@@ -28,6 +28,7 @@ void main() {
       expect(find.text('What\'s on your mind?'), findsOneWidget);
       expect(find.text('Post'), findsOneWidget);
       expect(find.text('This field should not be empty'), findsNothing);
+      expect(find.text('Content warning (optional)'), findsOneWidget);
 
       // Attempting to post without a value
       await tester.tap(find.text('Post'));