Merge pull request #173 from code4romania/develop

v2.1 release

Author: CristiHabliuc

.github/CONTRIBUTING.MD

@@ -1,4 +1,4 @@
-# Monitorizare Vot - iOS app - Contributing guide
+# Vote Monitor - iOS - Contributing guide
 
 :two_hearts: First off all, thank you for your interest in the project and for taking the time to contribute!
 
@@ -40,7 +40,8 @@ To send us a suggestion, just [open an issue](https://github.com/code4romania/mo
 
 :computer: We'd love for you to get your hands dirty and code for the project.
 
-If you are unsure where to begin contributing to the project, you can start by looking through these issues:  
+If you are unsure where to begin contributing to the project, you can start by looking through these issues:
+• [How to contribute](.github/WORKFLOW.MD)
 * [Good first issues](https://github.com/code4romania/monitorizare-vot-ios/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
 * [Help wanted](https://github.com/code4romania/monitorizare-vot-ios/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
 

.github/WORKFLOW.MD

@@ -2,6 +2,20 @@ Whether you're trying to give back to the open source community or collaborating
 
 In an attempt to coallate this information for myself and others, this short tutorial is what I've found to be fairly standard procedure for creating a fork, doing your work, issuing a pull request, and merging that pull request back into the original project.
 
+## TL;DR
+
+Steps (details below):
+1. Create issue if it doesn't exist
+2. Pull the latest `upstream/develop` into your fork
+3. Create feature branch in your fork
+4. Code it up
+5. Commit the changes (can put multiple commits since you'll be basing the PR off the branch)
+6. Push the changes to `origin/develop` (your fork)
+7. Create PR on Code4Romania repo basing `develop` <- `your fork/your feature branch`
+8. Enjoy success
+
+Detailed instructions below.
+
 ## Creating a Fork
 
 Just head over to the GitHub page and click the "Fork" button. It's just that simple. Once you've done that, you can use your favorite git client to clone your repo or just head straight to the command line:
@@ -17,7 +31,7 @@ While this isn't an absolutely necessary step, if you plan on doing anything mor
 
 ```shell
 # Add 'upstream' repo to list of remotes
-git remote add upstream https://github.com/UPSTREAM-USER/ORIGINAL-PROJECT.git
+git remote add upstream https://github.com/code4romania/monitorizare-vot-ios.git
 
 # Verify the new remote named 'upstream'
 git remote -v
@@ -33,17 +47,17 @@ git fetch upstream
 git branch -va
 ```
 
-Now, checkout your own master branch and merge the upstream repo's master branch:
+From this point onward, it's important to know that we use the `develop` branch for work and we only merge in `master` final releases. You can disregard the `master` branch completely for the purpose of contributing to the project. So checkout the `develop` branch and merge the upstream `develop` branch.
 
 ```shell
 # Checkout your master branch and merge upstream
-git checkout master
-git merge upstream/master
+git checkout develop
+git merge upstream/develop
 ```
 
-If there are no unique commits on the local master branch, git will simply perform a fast-forward. However, if you have been making changes on master (in the vast majority of cases you probably shouldn't be - [see the next section](#doing-your-work), you may have to deal with conflicts. When doing so, be careful to respect the changes made upstream.
+If there are no unique commits on the local branch, git will simply perform a fast-forward. However, if you have been making changes on develop (in the vast majority of cases you probably shouldn't be - [see the next section](#doing-your-work), you may have to deal with conflicts. When doing so, be careful to respect the changes made upstream.
 
-Now, your local master branch is up-to-date with everything modified upstream.
+Now, your local develop branch is up-to-date with everything modified upstream.
 
 ## Doing Your Work
 
@@ -54,7 +68,7 @@ To create a new branch and start working on it:
 
 ```shell
 # Checkout the master branch - you want your new branch to come from master
-git checkout master
+git checkout develop
 
 # Create a new branch named newfeature (give your branch its own simple informative name)
 git branch newfeature
@@ -69,22 +83,22 @@ Now, go to town hacking away and making whatever changes you want to.
 
 ### Cleaning Up Your Work
 
-Prior to submitting your pull request, you might want to do a few things to clean up your branch and make it as simple as possible for the original repo's maintainer to test, accept, and merge your work.
+__IMPORTANT:__ Prior to submitting your pull request, you might want to do a few things to clean up your branch and make it as simple as possible for the original repo's maintainer to test, accept, and merge your work.
 
 If any commits have been made to the upstream master branch, you should rebase your development branch so that merging it will be a simple fast-forward that won't require any conflict resolution work.
 
 ```shell
 # Fetch upstream master and merge with your repo's master branch
 git fetch upstream
-git checkout master
-git merge upstream/master
+git checkout develop
+git merge upstream/develop
 
 # If there were any new commits, rebase your development branch
 git checkout newfeature
-git rebase master
+git rebase develop
 ```
 
-Now, it may be desirable to squash some of your smaller commits down into a small number of larger more cohesive commits. You can do this with an interactive rebase:
+_Optionally_ it may be desirable to squash some of your smaller commits down into a small number of larger more cohesive commits. You can do this with an interactive rebase:
 
 ```shell
 # Rebase all commits on your development branch
@@ -94,10 +108,18 @@ git rebase -i master
 
 This will open up a text editor where you can specify which commits to squash.
 
+### TL;DR
+
+Fetch from `upstream/develop` (the main repository's develop), commit and push to `origin/develop` (your fork's develop), then PR into `code4romania/develop` <- `<your_username>/newfeature`.
+Always fetch/merge `upstream/develop` into `origin/newfeature` before submitting the PR. This ensures that the reviewer will be able to merge your PR if approved.
+Also, keep an eye on any changes the reviewer might ask and don't delay their integration very much, otherwise your PR will become stale and it won't be merged anymore if it's too old and obsolete. 
+
 ### Submitting
 
 Once you've committed and pushed all of your changes to GitHub, go to the page for your fork on GitHub, select your development branch, and click the pull request button. If you need to make any adjustments to your pull request, just push the updates to GitHub. Your pull request will automatically track the changes on your development branch and update.
 
+Make sure you're creating the PR so that your `feature` branch will be merged into the upstream's `develop` branch. Again, do not base it on master, but rather the `develop` branch.
+
 ## Accepting and Merging a Pull Request
 
 Take note that unlike the previous sections which were written from the perspective of someone that created a fork and generated a pull request, this section is written from the perspective of the original repository owner who is handling an incoming pull request. Thus, where the "forker" was referring to the original repository as `upstream`, we're now looking at it as the owner of that original repository and the standard `origin` remote.

MonitorizareVot.xcodeproj/project.pbxproj

@@ -38,6 +38,9 @@
 		28735F83226B19F600B4DB0B /* CustomConfiguration.xcconfig in Resources */ = {isa = PBXBuildFile; fileRef = 28735F82226B19F600B4DB0B /* CustomConfiguration.xcconfig */; };
 		28735F84226B19F600B4DB0B /* CustomConfiguration.xcconfig in Resources */ = {isa = PBXBuildFile; fileRef = 28735F82226B19F600B4DB0B /* CustomConfiguration.xcconfig */; };
 		28735F85226B19F600B4DB0B /* CustomConfiguration.xcconfig in Resources */ = {isa = PBXBuildFile; fileRef = 28735F82226B19F600B4DB0B /* CustomConfiguration.xcconfig */; };
+		2879CA372381BA5E00CE4DC7 /* AppRouter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2879CA362381BA5E00CE4DC7 /* AppRouter.swift */; };
+		2879CA3A2381C04F00CE4DC7 /* EmptyDetailsViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2879CA382381C04F00CE4DC7 /* EmptyDetailsViewController.swift */; };
+		2879CA3B2381C04F00CE4DC7 /* EmptyDetailsViewController.xib in Resources */ = {isa = PBXBuildFile; fileRef = 2879CA392381C04F00CE4DC7 /* EmptyDetailsViewController.xib */; };
 		28844A50233F6F3B00DEEA44 /* ChooserButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 28844A4F233F6F3B00DEEA44 /* ChooserButton.swift */; };
 		28844A52233F775E00DEEA44 /* SectionHUDViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 28844A51233F775E00DEEA44 /* SectionHUDViewModel.swift */; };
 		28844A56233F94FD00DEEA44 /* GenericPickerViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 28844A54233F94FD00DEEA44 /* GenericPickerViewController.swift */; };
@@ -166,6 +169,9 @@
 		286D38652364398C0091B23F /* QuestionListViewController.xib */ = {isa = PBXFileReference; lastKnownFileType = file.xib; path = QuestionListViewController.xib; sourceTree = "<group>"; };
 		286D3868236439990091B23F /* QuestionListViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = QuestionListViewModel.swift; sourceTree = "<group>"; };
 		28735F82226B19F600B4DB0B /* CustomConfiguration.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = CustomConfiguration.xcconfig; sourceTree = "<group>"; };
+		2879CA362381BA5E00CE4DC7 /* AppRouter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppRouter.swift; sourceTree = "<group>"; };
+		2879CA382381C04F00CE4DC7 /* EmptyDetailsViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EmptyDetailsViewController.swift; sourceTree = "<group>"; };
+		2879CA392381C04F00CE4DC7 /* EmptyDetailsViewController.xib */ = {isa = PBXFileReference; lastKnownFileType = file.xib; path = EmptyDetailsViewController.xib; sourceTree = "<group>"; };
 		28844A4F233F6F3B00DEEA44 /* ChooserButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChooserButton.swift; sourceTree = "<group>"; };
 		28844A51233F775E00DEEA44 /* SectionHUDViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SectionHUDViewModel.swift; sourceTree = "<group>"; };
 		28844A54233F94FD00DEEA44 /* GenericPickerViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GenericPickerViewController.swift; sourceTree = "<group>"; };
@@ -472,6 +478,8 @@
 				28FB66B223699D7400336DBA /* TextEntryViewController.swift */,
 				28FB66B323699D7400336DBA /* TextEntryViewController.xib */,
 				289E1E9023604F9D000C92A0 /* MVViewController.swift */,
+				2879CA382381C04F00CE4DC7 /* EmptyDetailsViewController.swift */,
+				2879CA392381C04F00CE4DC7 /* EmptyDetailsViewController.xib */,
 			);
 			path = Utility;
 			sourceTree = "<group>";
@@ -522,6 +530,7 @@
 				28A4B775237364FE00E6D2A8 /* RemoteConfigManager.swift */,
 				28DBDAA1236EDDCA004EAD83 /* NotificationsManager.swift */,
 				28DBDAA5236F33CD004EAD83 /* MVAnalytics.swift */,
+				2879CA362381BA5E00CE4DC7 /* AppRouter.swift */,
 			);
 			name = Utils;
 			sourceTree = "<group>";
@@ -819,6 +828,7 @@
 				28844A5D233F9AB700DEEA44 /* TimePickerViewController.xib in Resources */,
 				28DBDABB23701DBD004EAD83 /* InfoPlist.strings in Resources */,
 				289E1E8D235F2ABE000C92A0 /* FormSetTableCell.xib in Resources */,
+				2879CA3B2381C04F00CE4DC7 /* EmptyDetailsViewController.xib in Resources */,
 				28508623236D9C6000189D94 /* Launch Screen.storyboard in Resources */,
 				286D38672364398C0091B23F /* QuestionListViewController.xib in Resources */,
 				28735F83226B19F600B4DB0B /* CustomConfiguration.xcconfig in Resources */,
@@ -1043,7 +1053,9 @@
 				271595B521465EBA00BECC9C /* String+Localization.swift in Sources */,
 				286D3869236439990091B23F /* QuestionListViewModel.swift in Sources */,
 				E74087241DDC90E800D9332F /* AppDelegate.swift in Sources */,
+				2879CA3A2381C04F00CE4DC7 /* EmptyDetailsViewController.swift in Sources */,
 				28A7DCB6235CC7EB000B00C4 /* ApiModels.swift in Sources */,
+				2879CA372381BA5E00CE4DC7 /* AppRouter.swift in Sources */,
 				28C4343C2370C5C9001E6268 /* UITableView+HeaderAutoLayout.swift in Sources */,
 				67EE98CB22A296F7006E4762 /* Logger.swift in Sources */,
 				F553E3BE1DF9D67A000D0902 /* Answer+CoreDataProperties.swift in Sources */,
@@ -1228,10 +1240,11 @@
 				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_ENTITLEMENTS = MonitorizareVot/MonitorizareVot.entitlements;
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
-				CURRENT_PROJECT_VERSION = 9;
+				CURRENT_PROJECT_VERSION = 11;
 				INFOPLIST_FILE = MonitorizareVot/Info.plist;
 				IPHONEOS_DEPLOYMENT_TARGET = 9.3;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
+				MARKETING_VERSION = 2.1;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_OBJC_BRIDGING_HEADER = "";
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
@@ -1247,10 +1260,11 @@
 				CLANG_ENABLE_MODULES = YES;
 				CODE_SIGN_ENTITLEMENTS = MonitorizareVot/MonitorizareVot.entitlements;
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
-				CURRENT_PROJECT_VERSION = 9;
+				CURRENT_PROJECT_VERSION = 11;
 				INFOPLIST_FILE = MonitorizareVot/Info.plist;
 				IPHONEOS_DEPLOYMENT_TARGET = 9.3;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
+				MARKETING_VERSION = 2.1;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_OBJC_BRIDGING_HEADER = "";
 				SWIFT_VERSION = 5.0;

MonitorizareVot/AppDelegate.swift

@@ -103,27 +103,8 @@ extension AppDelegate {
             window?.overrideUserInterfaceStyle = .light
         }
 
-        if OnboardingViewModel.shouldShowOnboarding {
-            goToOnboarding()
-        } else {
-            goToLogin()
-        }
+        AppRouter.shared.showAppEntry()
     }
 
-    func goToLogin() {
-        let entryViewController = LoginViewController()
-        if let currentNavigation = window?.rootViewController as? UINavigationController {
-            currentNavigation.setViewControllers([entryViewController], animated: true)
-        } else {
-            let navigation = UINavigationController(rootViewController: entryViewController)
-            window?.rootViewController = navigation
-        }
-    }
-    
-    func goToOnboarding() {
-        let entryViewController = OnboardingLanguageViewController()
-        let navigation = UINavigationController(rootViewController: entryViewController)
-        window?.rootViewController = navigation
-    }
 
 }

MonitorizareVot/AppRouter.swift

@@ -0,0 +1,106 @@
+//
+//  AppRouter.swift
+//  MonitorizareVot
+//
+//  Created by Cristi Habliuc on 17/11/2019.
+//  Copyright © 2019 Code4Ro. All rights reserved.
+//
+
+import UIKit
+
+/// Handles navigation inside the app
+class AppRouter: NSObject {
+    static let shared = AppRouter()
+    
+    var isPad: Bool { return UIDevice.current.userInterfaceIdiom == .pad }
+    var isPhone: Bool { return UIDevice.current.userInterfaceIdiom == .phone }
+    
+    var window: UIWindow? { return AppDelegate.shared.window }
+    var splitViewController: UISplitViewController? { return AppDelegate.shared.window?.rootViewController as? UISplitViewController }
+    var navigationController: UINavigationController? {
+        return splitViewController?.viewControllers.first as? UINavigationController
+        ?? AppDelegate.shared.window?.rootViewController as? UINavigationController
+    }
+
+    func showAppEntry() {
+        if OnboardingViewModel.shouldShowOnboarding {
+            goToOnboarding()
+        } else {
+            goToLogin()
+        }
+    }
+    
+    func goToLogin() {
+        let entryViewController = LoginViewController()
+        window?.rootViewController = entryViewController
+    }
+    
+    func goToOnboarding() {
+        let entryViewController = OnboardingLanguageViewController()
+        let navigation = UINavigationController(rootViewController: entryViewController)
+        window?.rootViewController = navigation
+    }
+    
+    func createSplitControllerIfNecessary() {
+        guard splitViewController == nil else { return }
+    }
+    
+    func goToChooseStation() {
+        let sectionModel = SectionPickerViewModel()
+        let sectionController = SectionPickerViewController(withModel: sectionModel)
+        if isPad && splitViewController == nil {
+            AppDelegate.shared.window?.rootViewController = UISplitViewController()
+            splitViewController?.viewControllers = [UINavigationController()]
+            if isPad {
+                splitViewController?.preferredDisplayMode = UISplitViewController.DisplayMode.allVisible
+            }
+        } else if isPhone {
+            AppDelegate.shared.window?.rootViewController = UINavigationController()
+        }
+        navigationController?.setViewControllers([sectionController], animated: true)
+        resetDetailsPane()
+    }
+    
+    func proceedToAuthenticated() {
+        goToChooseStation()
+    }
+
+    func goToForms(from vc: UIViewController) {
+        let formsModel = FormListViewModel()
+        let formsVC = FormListViewController(withModel: formsModel)
+        navigationController?.setViewControllers([formsVC], animated: true)
+        resetDetailsPane()
+    }
+    
+    func open(questionModel: QuestionAnswerViewModel) {
+        let controller = QuestionAnswerViewController(withModel: questionModel)
+        if isPad,
+            let split = splitViewController {
+            let navigation = UINavigationController(rootViewController: controller)
+            split.showDetailViewController(navigation, sender: nil)
+        } else {
+            navigationController?.pushViewController(controller, animated: true)
+        }
+    }
+    
+    func openAddNote() {
+        let noteModel = NoteViewModel()
+        let controller = NoteViewController(withModel: noteModel)
+        if isPad,
+            let split = splitViewController {
+            let navigation = UINavigationController(rootViewController: controller)
+            split.showDetailViewController(navigation, sender: nil)
+        } else {
+            navigationController?.pushViewController(controller, animated: true)
+        }
+    }
+    
+    /// Will make the details pane go back to blank
+    func resetDetailsPane() {
+        guard isPad else { return }
+        guard let split = AppDelegate.shared.window?.rootViewController as? UISplitViewController else { return}
+        let controller = EmptyDetailsViewController()
+        let navigation = UINavigationController(rootViewController: controller)
+        split.showDetailViewController(navigation, sender: nil)
+    }
+}

MonitorizareVot/Base.lproj/Localizable.strings

@@ -1,5 +1,6 @@
 //  Created by Code4Romania
 
+"Button_Login" = "Login";
 "Button_Continue" = "Continue";
 "Button_ChangeDepartemnt" = "Change";
 "Button_Urban" = "Urban";
@@ -35,6 +36,7 @@
 "Label_AddNote" = "Add a note";
 "Label_TypeNote" = "Type your note here";
 "Label_EnterStation" = "Enter station number (i.e. 34)";
+"Label_Empty" = "Choose a question or add a note";
 
 "Option.Gallery" = "Load from gallery";
 "Option.TakePhoto" = "Take a photo";