feat(cat-voices): proposal details integration - Part 2 (#2090)

* feat: watching active account + rename some parent fields to reply

* feat: proposal error and loading states

* chore: integrate loading ProposalDocument

* chore: safe check finally state change

* refactor: ProposalCubit cache extracted into a object

* feat: CommentService

* refactor: move credentials logic to separate service

* chore: DocumentDataMetadata reply and section fields

* chore: TODO for later

* feat: CommentService and Repository

* chore: add refTo filter

* feat: building comment with replies tree

* refactor: make canReply list item argument

* feat: publish a comment

* test: comment template fixture

* chore: hide comments segment when cannot comment or has no comments

* fix: removing local failed comments

* chore: comments list items spacings

* chore: hide sort comments when empty

* fix: missing comment template ref

* chore: saving comment after publishing

* chore: adjust publish comment document metadata

* fix: nesting replies

* feat: filter out category node from proposal view

* refactor: move document props getters to ProposalDocument

* feat: integrate ProposalDocumentDetails

* feat: make rotation a parameter

* chore: PR review adjustments

* refactor: use Coin.fromWholeAda

Author: damian-molinski

catalyst_voices/apps/voices/lib/dependency/dependencies.dart

@@ -128,6 +128,7 @@ final class Dependencies extends DependencyProvider {
           get<UserService>(),
           get<ProposalService>(),
           get<CommentService>(),
+          get<CampaignService>(),
           get<DocumentMapper>(),
         );
       })

catalyst_voices/apps/voices/lib/pages/proposal/tiles/proposal_metadata_tile.dart

@@ -1,3 +1,4 @@
+import 'package:catalyst_cardano_serialization/catalyst_cardano_serialization.dart';
 import 'package:catalyst_voices/common/ext/build_context_ext.dart';
 import 'package:catalyst_voices/pages/proposal/widget/proposal_delivery_card.dart';
 import 'package:catalyst_voices/pages/proposal/widget/proposal_version.dart';
@@ -18,9 +19,9 @@ class ProposalMetadataTile extends StatelessWidget {
   final bool warningCreatedAt;
   final String? tag;
   final int commentsCount;
-  final int fundsRequested;
-  final int projectDuration;
-  final int milestoneCount;
+  final Coin? fundsRequested;
+  final int? projectDuration;
+  final int? milestoneCount;
 
   const ProposalMetadataTile({
     super.key,

catalyst_voices/apps/voices/lib/pages/proposal/widget/proposal_delivery_card.dart

@@ -1,12 +1,13 @@
+import 'package:catalyst_cardano_serialization/catalyst_cardano_serialization.dart';
 import 'package:catalyst_voices/common/ext/build_context_ext.dart';
 import 'package:catalyst_voices_localization/catalyst_voices_localization.dart';
-import 'package:catalyst_voices_models/catalyst_voices_models.dart';
+import 'package:catalyst_voices_shared/catalyst_voices_shared.dart';
 import 'package:flutter/material.dart';
 
 class ProposalDeliveryCard extends StatelessWidget {
-  final int fundsRequested;
-  final int projectDuration;
-  final int milestoneCount;
+  final Coin? fundsRequested;
+  final int? projectDuration;
+  final int? milestoneCount;
 
   const ProposalDeliveryCard({
     super.key,
@@ -17,6 +18,10 @@ class ProposalDeliveryCard extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
+    final fundsRequested = this.fundsRequested;
+    final projectDuration = this.projectDuration;
+    final milestoneCount = this.milestoneCount;
+
     return Container(
       width: double.infinity,
       padding: const EdgeInsets.symmetric(vertical: 12, horizontal: 16),
@@ -30,30 +35,32 @@ class ProposalDeliveryCard extends StatelessWidget {
         alignment: WrapAlignment.spaceAround,
         runAlignment: WrapAlignment.center,
         children: [
-          _ValueCell(
-            title: context.l10n.proposalViewFundingRequested,
-            value: '',
-            valueSuffix: const Currency.ada().format(
-              fundsRequested,
-              separator: ' ',
+          if (fundsRequested != null)
+            _ValueCell(
+              title: context.l10n.proposalViewFundingRequested,
+              value: '',
+              valueSuffix: CryptocurrencyFormatter.decimalFormat(
+                fundsRequested,
+              ),
+            ),
+          if (projectDuration != null)
+            _ValueCell(
+              title: context.l10n.proposalViewProjectDuration,
+              value: context.l10n
+                  .valueMonths(projectDuration)
+                  .replaceAll('$projectDuration', '')
+                  .trim(),
+              valueSuffix: '$projectDuration',
+            ),
+          if (milestoneCount != null)
+            _ValueCell(
+              title: context.l10n.proposalViewProjectDelivery,
+              value: context.l10n
+                  .valueMilestones(milestoneCount)
+                  .replaceAll('$milestoneCount', '')
+                  .trim(),
+              valueSuffix: '$milestoneCount',
             ),
-          ),
-          _ValueCell(
-            title: context.l10n.proposalViewProjectDuration,
-            value: context.l10n
-                .valueMonths(projectDuration)
-                .replaceAll('$projectDuration', '')
-                .trim(),
-            valueSuffix: '$projectDuration',
-          ),
-          _ValueCell(
-            title: context.l10n.proposalViewProjectDelivery,
-            value: context.l10n
-                .valueMilestones(milestoneCount)
-                .replaceAll('$milestoneCount', '')
-                .trim(),
-            valueSuffix: '$milestoneCount',
-          ),
         ],
       ),
     );

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/document/document_to_segment_mixin.dart

@@ -6,12 +6,18 @@ mixin DocumentToSegmentMixin {
   List<DocumentSegment> mapDocumentToSegments(
     Document document, {
     bool showValidationErrors = false,
+    List<DocumentNodeId> filterOut = const [],
   }) {
     final result = <DocumentSegment>[];
 
-    for (final segment in document.segments) {
+    final effectiveSegments = document.segments
+        .where((element) => !filterOut.contains(element.nodeId))
+        .toList();
+
+    for (final segment in effectiveSegments) {
       final sections = segment.sections
           .expand(DocumentNodeTraverser.findSectionsAndSubsections)
+          .where((element) => !filterOut.contains(element.nodeId))
           .map((section) {
         return DocumentSection(
           id: section.schema.nodeId,

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/proposal/proposal_cubit.dart

@@ -21,6 +21,7 @@ final class ProposalCubit extends Cubit<ProposalState>
   final UserService _userService;
   final ProposalService _proposalService;
   final CommentService _commentService;
+  final CampaignService _campaignService;
   final DocumentMapper _documentMapper;
 
   ProposalCubitCache _cache = const ProposalCubitCache();
@@ -32,6 +33,7 @@ final class ProposalCubit extends Cubit<ProposalState>
     this._userService,
     this._proposalService,
     this._commentService,
+    this._campaignService,
     this._documentMapper,
   ) : super(const ProposalState()) {
     _cache = _cache.copyWith(
@@ -63,6 +65,7 @@ final class ProposalCubit extends Cubit<ProposalState>
       emit(state.copyWith(isLoading: true));
 
       final proposal = await _proposalService.getProposal(ref: ref);
+      final category = await _campaignService.getCategory(proposal.categoryId);
       final commentTemplate = await _commentService.getCommentTemplateFor(
         category: proposal.categoryId,
       );
@@ -71,6 +74,7 @@ final class ProposalCubit extends Cubit<ProposalState>
 
       _cache = _cache.copyWith(
         proposal: Optional(proposal),
+        category: Optional(category),
         commentTemplate: Optional(commentTemplate),
         comments: const Optional([]),
         isFavorite: Optional(isFavorite),
@@ -248,6 +252,7 @@ final class ProposalCubit extends Cubit<ProposalState>
   ProposalViewData _buildProposalViewData({
     required bool hasActiveAccount,
     required ProposalData? proposal,
+    required CampaignCategory? category,
     required List<CommentWithReplies> comments,
     required DocumentSchema? commentSchema,
     required ProposalCommentsSort commentsSort,
@@ -256,7 +261,6 @@ final class ProposalCubit extends Cubit<ProposalState>
     final proposalDocument = proposal?.document;
     final proposalDocumentRef = proposalDocument?.metadata.selfRef;
 
-    /* cSpell:disable */
     final proposalVersions = proposal?.versions ?? const [];
     final versions = proposalVersions.mapIndexed((index, version) {
       final ver = version.document.metadata.selfRef.version;
@@ -273,6 +277,7 @@ final class ProposalCubit extends Cubit<ProposalState>
     final segments = proposal != null
         ? _buildSegments(
             proposal: proposal,
+            category: category,
             version: currentVersion,
             comments: comments,
             commentSchema: commentSchema,
@@ -281,57 +286,58 @@ final class ProposalCubit extends Cubit<ProposalState>
           )
         : const <Segment>[];
 
+    final header = ProposalViewHeader(
+      title: proposalDocument?.title ?? '',
+      authorDisplayName: proposalDocument?.authorName ?? '',
+      createdAt: proposalDocumentRef?.version?.tryDateTime,
+      commentsCount: comments.length,
+      versions: versions,
+      isFavorite: isFavorite,
+    );
+
     return ProposalViewData(
       isCurrentVersionLatest: currentVersion?.isLatest,
-      header: ProposalViewHeader(
-        title: 'Project Mayhem: Freedom by Chaos',
-        authorDisplayName: 'Tyler Durden',
-        createdAt: DateTime.timestamp(),
-        commentsCount: comments.length,
-        versions: versions,
-        isFavorite: isFavorite,
-      ),
+      header: header,
       segments: segments,
       commentsSort: commentsSort,
     );
-    /* cSpell:enable */
   }
 
-  /* cSpell:disable */
   List<Segment> _buildSegments({
     required ProposalData proposal,
+    required CampaignCategory? category,
     required DocumentVersion? version,
     required List<CommentWithReplies> comments,
     required DocumentSchema? commentSchema,
     required ProposalCommentsSort commentsSort,
     required bool hasActiveAccount,
   }) {
-    final isDraftProposal = proposal.document.metadata.selfRef is DraftRef;
+    final document = proposal.document;
+    final isDraftProposal = document.metadata.selfRef is DraftRef;
 
     final overviewSegment = ProposalOverviewSegment.build(
-      categoryName: 'Cardano Partners: Growth & Acceleration',
-      proposalTitle: 'Project Mayhem: Freedom by Chaos',
+      categoryName: category?.categoryName ?? '',
+      proposalTitle: document.title ?? '',
       data: ProposalViewMetadata(
         author: Profile(catalystId: DummyCatalystIdFactory.create()),
-        description: 'Project Mayhem is a disruptive initiative to dismantle '
-            'societal hierarchies through acts of controlled chaos. '
-            'By targeting oppressive systems like credit structures and '
-            'consumerist propaganda, we empower individuals to reclaim their '
-            'agency. This ?decentralised movement fosters self-replication, '
-            'inspiring global action for liberation and a return to human '
-            'authenticity.',
+        description: document.description,
         status: ProposalStatus.draft,
         createdAt: version?.id.tryDateTime ?? DateTime.now(),
         warningCreatedAt: version?.isLatest == false,
-        tag: 'Community Outreach',
+        tag: document.tag,
         commentsCount: comments.length,
-        fundsRequested: 200000,
-        projectDuration: 12,
-        milestoneCount: 3,
+        fundsRequested: document.fundsRequested,
+        projectDuration: document.duration,
+        milestoneCount: document.milestoneCount,
       ),
     );
 
-    final proposalSegments = mapDocumentToSegments(proposal.document.document);
+    final proposalSegments = mapDocumentToSegments(
+      document.document,
+      filterOut: [
+        ProposalDocument.categoryNodeId,
+      ],
+    );
 
     final canReply = !isDraftProposal && hasActiveAccount;
     final canComment = canReply && commentSchema != null;
@@ -372,10 +378,9 @@ final class ProposalCubit extends Cubit<ProposalState>
     emit(state.copyWith(data: _rebuildProposalState()));
   }
 
-  /* cSpell:enable */
-
   ProposalViewData _rebuildProposalState() {
     final proposal = _cache.proposal;
+    final category = _cache.category;
     final commentTemplate = _cache.commentTemplate;
     final comments = _cache.comments ?? const [];
     final commentsSort = state.data.commentsSort;
@@ -385,6 +390,7 @@ final class ProposalCubit extends Cubit<ProposalState>
     return _buildProposalViewData(
       hasActiveAccount: activeAccountId != null,
       proposal: proposal,
+      category: category,
       comments: comments,
       commentSchema: commentTemplate?.schema,
       commentsSort: commentsSort,

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/proposal/proposal_cubit_cache.dart

@@ -5,6 +5,7 @@ final class ProposalCubitCache extends Equatable {
   final CatalystId? activeAccountId;
   final DocumentRef? ref;
   final ProposalData? proposal;
+  final CampaignCategory? category;
   final CommentTemplate? commentTemplate;
   final List<CommentWithReplies>? comments;
   final bool? isFavorite;
@@ -13,6 +14,7 @@ final class ProposalCubitCache extends Equatable {
     this.activeAccountId,
     this.ref,
     this.proposal,
+    this.category,
     this.commentTemplate,
     this.comments,
     this.isFavorite,
@@ -23,6 +25,7 @@ final class ProposalCubitCache extends Equatable {
         activeAccountId,
         ref,
         proposal,
+        category,
         commentTemplate,
         comments,
         isFavorite,
@@ -32,6 +35,7 @@ final class ProposalCubitCache extends Equatable {
     Optional<CatalystId>? activeAccountId,
     Optional<DocumentRef>? ref,
     Optional<ProposalData>? proposal,
+    Optional<CampaignCategory>? category,
     Optional<CommentTemplate>? commentTemplate,
     Optional<List<CommentWithReplies>>? comments,
     Optional<bool>? isFavorite,
@@ -40,6 +44,7 @@ final class ProposalCubitCache extends Equatable {
       activeAccountId: activeAccountId.dataOr(this.activeAccountId),
       ref: ref.dataOr(this.ref),
       proposal: proposal.dataOr(this.proposal),
+      category: category.dataOr(this.category),
       commentTemplate: commentTemplate.dataOr(this.commentTemplate),
       comments: comments.dataOr(this.comments),
       isFavorite: isFavorite.dataOr(this.isFavorite),