Merge branch 'develop' into Ayush0Chaudhary/organization_feed_test

Author: Ayush0Chaudhary

.github/workflows/pull-request.yml

@@ -41,42 +41,6 @@ jobs:
         run: ./.github/workflows/countline.py --exclude_directories test/ --exclude_files lib/custom_painters/talawa_logo.dart lib/custom_painters/language_icon.dart lib/custom_painters/whatsapp_logo.dart lib/utils/queries.dart lib/view_model/after_auth_view_models/profile_view_models/profile_page_view_model.dart lib/view_model/pre_auth_view_models/select_organization_view_model.dart lib/views/after_auth_screens/profile/profile_page.dart lib/view_model/main_screen_view_model.dart lib/views/after_auth_screens/events/create_event_page.dart
       - name: Analysing codebase for linting
         run: flutter analyze --no-pub
-      - uses: actions/checkout@v3
-      - uses: jitterbit/get-changed-files@v1
-        id: abc
-        with:
-          format: space-delimited
-          token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Checking doc updated
-        run: |
-          echo "${{ steps.abc.outputs.added_modified }}"
-          IFS=' '
-          read -ra ADDR <<<"${{ steps.abc.outputs.added_modified }}"
-          doc=0
-          source=0
-          for i in "${ADDR[@]}"; #accessing each element of array
-          do
-          echo "$i"
-          if [[ $i == ./doc* ]]
-          then
-            doc=doc+1
-          elif [[ $i == ./lib* ]]
-          then
-            source=source+1
-          fi
-          done
-          Red='0;31'
-          Green='0;32'
-          NoColor='\033[0m'
-          if [[ $doc == 0 ]] && [[ $source == 0 ]]
-          then
-            echo "🚀${Green} Hurrah! no source editted${NoColor}"; exit 0;
-          fi
-          if [[ $doc == 0 ]] && [[ $source -ge 0 ]]
-          then
-            echo "🔍${Red} DOCUMENTATION NOT UPDATED: Files with missing or not updated documentation found please consider fixing to get the PR approved${NoColor}";exit 1;
-          fi
-          echo "🚀 ${Green}Hurrah! documentation was updated in all modified/added files${NoColor}"; exit 0;
 
   Flutter-Testing:
     name: Testing codebase

.github/workflows/stale.yml

@@ -25,19 +25,19 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/stale@v4.1.0
+    - uses: actions/stale@v7
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
-        stale-issue-message: 'This issue did not get any activity in the past 60 days and will be closed in 365 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.'
-        stale-pr-message: 'This pull request did not get any activity in the past 60 days and will be closed in 365 days if no update occurs. Please verify it has no conflicts with the develop branch and rebase if needed. Mention it now if you need help or give permission to other people to finish your work.'
+        stale-issue-message: 'This issue did not get any activity in the past 14 days and will be closed in 365 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.'
+        stale-pr-message: 'This pull request did not get any activity in the past 14 days and will be closed in 365 days if no update occurs. Please verify it has no conflicts with the develop branch and rebase if needed. Mention it now if you need help or give permission to other people to finish your work.'
         close-issue-message: 'This issue did not get any activity in the past 365 days and thus has been closed. Please check if the newest release or develop branch has it fixed. Please, create a new issue if the issue is not fixed.'
         close-pr-message: 'This pull request did not get any activity in the past 365 days and thus has been closed.'
         stale-issue-label: 'no-issue-activity'
         stale-pr-label: 'no-pr-activity'
-        days-before-stale: 60
+        days-before-stale: 14
         days-before-close: 365
         remove-stale-when-updated: true
         exempt-all-milestones: true
-        exempt-pr-labels: 'bug'
-        exempt-issue-labels: 'bug, wip, test'
+        exempt-pr-labels: 'wip'
+        exempt-issue-labels: 'wip'
         operations-per-run: 30

lib/constants/constants.dart

@@ -1,5 +1,6 @@
 import 'package:talawa/models/language/language_model.dart';
 
+/// This file contains the prototypes of all the languages available and supported currencies.
 List<Language> languages = [
   Language(
     countryCode: 'US',

lib/constants/custom_theme.dart

@@ -1,5 +1,8 @@
 import 'package:flutter/material.dart';
 
+///This file contains various custom themes.
+///For instance, lightTheme, darkTheme, _lightTextTheme, _darkTextTheme, etc.
+///These are imported to other files/widgets to apply the required themes.
 class TalawaTheme {
   static const Color _lightCursorColor = Color(0xff34AD64);
   static const Color _lightAccentColor = Color(0xff34AD64);

lib/constants/quick_actions.dart

@@ -1,5 +1,7 @@
 import 'package:quick_actions/quick_actions.dart';
 
+///This file contains the shortcuts by which user can manage and interact with the
+///application. quick_actions package is used for this purpose.
 class ShortCutMenu {
   static final quickActionsList = <ShortcutItem>[
     eventAction,

lib/constants/routing_constants.dart

@@ -1,4 +1,4 @@
-//routes
+///This file contains the routes.
 
 class Routes {
   static const String demoPageViewRoute = "/demoPageViewRoute";

lib/custom_painters/language_icon.dart

@@ -1,5 +1,8 @@
 import 'package:flutter/material.dart';
 
+///This class draws the language icon using custom paint.
+///CustomPaint is a widget from the Flutter SDK, which enables
+/// you to use a canvas to draw different shapes.
 class LanguageIcon extends CustomPainter {
   @override
   void paint(Canvas canvas, Size size) {

lib/custom_painters/talawa_logo.dart

@@ -1,5 +1,8 @@
 import 'package:flutter/material.dart';
 
+///This class draws the app logo using custom paint.
+///CustomPaint is a widget from the Flutter SDK, which enables
+/// you to use a canvas to draw different shapes.
 class AppLogo extends CustomPainter {
   @override
   void paint(Canvas canvas, Size size) {

lib/custom_painters/telegram_logo.dart

@@ -2,6 +2,10 @@ import 'dart:ui' as ui;
 
 import 'package:flutter/material.dart';
 
+///This class draws the telegram logo using custom paint.
+///CustomPaint is a widget from the Flutter SDK, which enables
+/// you to use a canvas to draw different shapes.
+
 //Copy this CustomPainter code to the Bottom of the File
 class TelegramLogo extends CustomPainter {
   @override

lib/custom_painters/whatsapp_logo.dart

@@ -1,5 +1,8 @@
 import 'package:flutter/material.dart';
 
+///This class draws the whatsapp logo using custom paint.
+///CustomPaint is a widget from the Flutter SDK, which enables
+/// you to use a canvas to draw different shapes.
 class WhatsappLogo extends CustomPainter {
   @override
   void paint(Canvas canvas, Size size) {

lib/demo_server_data/direct_chat_demo_data.dart

@@ -1,3 +1,5 @@
+///This file contains demo data. It contains a list of type Map<String, Object>
+/// and sample data of chats.
 const directChatDemoData = [
   {
     "sender": {

lib/demo_server_data/events_demo_data.dart

@@ -1,3 +1,5 @@
+///This file contains demo data. It contains a list of type Map<String, Object>
+/// and sample data of events.
 const eventsDemoData = [
   {
     "title": "Calculus",

lib/demo_server_data/pinned_post_demo_data.dart

@@ -1,3 +1,5 @@
+///This file contains demo data for pinned posts. It contains a list of type Map<String, Object>
+/// and sample data.
 const pinnedPostsDemoData = [
   {
     "_id": "1",

lib/demo_server_data/post_demo_data.dart

@@ -1,3 +1,5 @@
+///This file contains demo data for posts. It contains a list of type Map<String, Object>
+/// and sample data of posts.
 const postsDemoData = [
   {
     "_id": "asdasdasd",

lib/enums/enums.dart

@@ -1,11 +1,17 @@
+///This file contains different enums.
+///The enum keyword is used to define an enumeration type in Dart.
+/// The use case of enumeration is to store finite data members under the same type definition.
+
 /// Represents the state of the view
 enum ViewState {
   idle,
   busy,
 }
 
+/// Represents the state of the chat
 enum ChatState { initial, loading, complete }
 
+/// Represents the type of the tile
 enum TileType { user, org, option }
 
 enum CallFor { login, signup, joinPublicOrg }

lib/locator.dart

@@ -39,6 +39,7 @@ import 'package:talawa/view_model/widgets_view_models/custom_drawer_view_model.d
 import 'package:talawa/view_model/widgets_view_models/like_button_view_model.dart';
 import 'package:talawa/view_model/widgets_view_models/progress_dialog_view_model.dart';
 
+// Creating an instance of GetIt and storing it in a global variable
 GetIt locator = GetIt.instance;
 final userConfig = locator<UserConfig>();
 final navigationService = locator<NavigationService>();
@@ -49,6 +50,7 @@ final queries = locator<Queries>();
 final connectivity = locator<Connectivity>();
 final organizationService = locator<OrganizationService>();
 
+/// This function registers the widgets/objects in "GetIt"
 void setupLocator() {
   //services
   locator.registerSingleton(NavigationService());

lib/main.dart

@@ -57,6 +57,7 @@ late FlutterLocalNotificationsPlugin flutterLocalNotificationsPlugin;
 
 /// This is the main function
 Future<void> main() async {
+  // Returns an instance of the binding that implements WidgetsBinding.
   WidgetsFlutterBinding.ensureInitialized();
 
   if (!kIsWeb) {
@@ -102,6 +103,7 @@ Future<void> main() async {
   }
 
   setupLocator();
+  // The runApp() function takes the given Widget and makes it the root of the widget tree.
   runApp(MyApp());
 }
 
@@ -132,12 +134,17 @@ class MyApp extends StatefulWidget {
   _MyAppState createState() => _MyAppState();
 }
 
+/// The _MyAppState class extends the State.
+/// All the coding related to state updation is inside this class.
 class _MyAppState extends State<MyApp> {
   final quickActions = const QuickActions();
   late int mainScreenQuickActionindex = 0;
   @override
   void initState() {
-    // TODO: implement initState
+    // initState() is a method that is called once when the Stateful Widget
+    // is inserted in the widget tree. We generally override this method if
+    // we need to do some sort of initialization work like
+    // registering a listener because, unlike build(), this method is called once.
     initQuickActions();
     FetchPluginList();
     super.initState();
@@ -149,6 +156,7 @@ class _MyAppState extends State<MyApp> {
     );
   }
 
+  // It allows to manage and interact with the application’s home screen quick actions.
   initQuickActions() async {
     final bool userLoggedIn = await userConfig.userLoggedIn();
     if (userLoggedIn &&
@@ -166,6 +174,8 @@ class _MyAppState extends State<MyApp> {
     }
   }
 
+  // The build method is called any time you call setState ,your widget's
+  // dependencies update, or any of the parent widgets are rebuilt.
   @override
   Widget build(BuildContext context) {
     return BaseView<AppLanguage>(
@@ -231,6 +241,8 @@ class _MyAppState extends State<MyApp> {
   }
 }
 
+/// PageView is a scrollable list that works page by page.
+/// DemoPageView is demo PageView of Talawa Mobile App.
 class DemoPageView extends StatelessWidget {
   const DemoPageView({required Key key}) : super(key: key);
 
@@ -251,6 +263,9 @@ class DemoPageView extends StatelessWidget {
   }
 }
 
+/// ViewModel uses property-based data binding to establish a connection
+/// between the ViewModel and the View, and drives the View changes
+/// through the ViewModel. DemoViewModel is the ViewModel for DemoPageView.
 class DemoViewModel extends BaseModel {
   final String _title = "Title from the viewMode GSoC branch";
   String get title => _title;

lib/models/chats/chat_list_tile_data_model.dart

@@ -4,12 +4,17 @@ import 'package:talawa/models/chats/chat_user.dart';
 part 'chat_list_tile_data_model.g.dart';
 
 @JsonSerializable()
+
+/// This class creates JSON code using the JsonSerializable package.
 class ChatListTileDataModel {
   ChatListTileDataModel(this.users, this.id);
 
+  // Connect the generated [_$ChatListTileDataModelFromJson] function to the `fromJson`
+  // factory.
   factory ChatListTileDataModel.fromJson(Map<String, dynamic> json) =>
       _$ChatListTileDataModelFromJson(json);
 
+  // Connect the generated [_$ChatListTileDataModelToJson] function to the `toJson` method.
   Map<String, dynamic> toJson() => _$ChatListTileDataModelToJson(this);
 
   List<ChatUser>? users;

lib/models/chats/chat_message.dart

@@ -3,16 +3,22 @@ import 'package:talawa/models/chats/chat_user.dart';
 part 'chat_message.g.dart';
 
 @JsonSerializable(explicitToJson: true)
+
+/// This class creates JSON code for chat message using the JsonSerializable package.
+
 class ChatMessage {
   ChatMessage(
     this.id,
     this.sender,
     this.messageContent,
     this.receiver,
   );
-
+  // Connect the generated [_$ChatMessageFromJson] function to the `fromJson`
+  // factory.
   factory ChatMessage.fromJson(Map<String, dynamic> json) =>
       _$ChatMessageFromJson(json);
+
+  // Connect the generated [_$ChatMessageToJson] function to the `toJson` method.
   Map<String, dynamic> toJson() => _$ChatMessageToJson(this);
 
   String? id;

lib/models/chats/chat_user.dart

@@ -2,11 +2,17 @@ import 'package:json_annotation/json_annotation.dart';
 part 'chat_user.g.dart';
 
 @JsonSerializable()
+
+/// This class creates JSON code for chat user using the JsonSerializable package.
 class ChatUser {
   ChatUser({this.firstName, this.id, this.image});
 
+  // Connect the generated [_$ChatUserFromJson] function to the `fromJson`
+  // factory.
   factory ChatUser.fromJson(Map<String, dynamic> json) =>
       _$ChatUserFromJson(json);
+
+  // Connect the generated [_$ChatUserFromJson] function to the `toJson` method.
   Map<String, dynamic> toJson() => _$ChatUserToJson(this);
 
   String? firstName;

lib/models/comment/comment_model.dart

@@ -1,14 +1,16 @@
 import 'package:talawa/models/user/user_info.dart';
 
+///This class returns a Comment instance.
 class Comment {
   Comment({this.text, this.createdAt, this.creator, this.post, this.likeCount});
-
+  //Creating a new Comment instance from a map structure.
   factory Comment.fromJson(Map<String, dynamic> json) {
     return Comment(
       text: json['text'] as String?,
       createdAt: json['createdAt'] as String?,
       creator: json['creator'] == null
           ? null
+          //Creating a new User instance from a map structure.
           : User.fromJson(
               json['creator'] as Map<String, dynamic>,
               fromOrg: true,

lib/models/events/event_model.dart

@@ -1,6 +1,7 @@
 import 'package:talawa/models/organization/org_info.dart';
 import 'package:talawa/models/user/user_info.dart';
 
+///This class creates an event model and returns an Event instance.
 class Event {
   Event({
     this.id,
@@ -25,7 +26,7 @@ class Event {
     this.admins,
     this.registrants,
   });
-
+  //Creating a new Event instance from a map structure.
   factory Event.fromJson(
     Map<String, dynamic> json,
   ) {
@@ -49,12 +50,14 @@ class Event {
       isRegisterable: json['isRegisterable'] as bool?,
       creator: json['creator'] == null
           ? null
+          //Creating a new User instance from a map structure.
           : User.fromJson(
               json['creator'] as Map<String, dynamic>,
               fromOrg: true,
             ),
       organization: json['organization'] == null
           ? null
+          //Creating a new OrgInfo instance from a map structure.
           : OrgInfo.fromJson(json['organization'] as Map<String, dynamic>),
       admins: json['admins'] == null
           ? null

lib/models/language/language_model.dart

@@ -1,3 +1,4 @@
+///This class creates an langauge model.
 class Language {
   Language({
     required this.countryCode,

lib/models/options/options.dart

@@ -1,5 +1,6 @@
 import 'package:flutter/material.dart';
 
+///This class creates a Option model.
 class Options {
   Options({
     required this.icon,