ReviewApp

Modular Architecture demo iOS App

Table of contents

• General info
• Requirements
• Design Pattern
• Built-in Packages
• Technologies
• Dependencies
• Setup

General info

This is an iOS Project using UIKit for Modular Architecture demo app. It is a three pages application which lists reviews, filters reviews and displays detailed information about selected review. The first one is that ReviewList page contains a UITableView to display reviews. The second one is that FilterOptions page contains a vertical UIStackView to display filtering options and the last one is that ReviewDetail page contains a UIScrollView and vertial UIStackView to display detailed information.

Requirements

iOS13+
Note: I had to set minimum target iOS 13. Because, UIViewControllerRepresentable protocol requires minimum target as iOS 13 in UIKitPreview package.

Design Pattern

MVVM is used to make the project more readable and easily testable. One of the biggest advantage of MVVM design pattern is that it seperates business and UI logics. Besides, the slight difference between commonly known MVVM and the one used in this project is using IO(Input/Output) mechanism as protocols for view models.
Using protocol keeps view model private and decoupled. You can easily substitute it with another object conforming the protocol of the view model. It helps you mocking even view models.
Using output protocol helps you to test outputs triggered by view actions. In addition, you can easily test the orders of the outputs after trigger an input function.
Finally, builder pattern is used to create view controllers. Each page has own builder as a public access control and these builders are used for creation of contollers.

Navigation

Coordinator pattern is used to maintain navigation between controllers in order to decoupling them by using builders. The biggest advantage is that decreasing compile time by decoupling dependencies between controllers.

Built-in Packages

There are 10 Swift Packages included in the project totally. All Swift Packages are separated to two main folders that called Common & Screens.

Common folder contains;

• AppstoreAPI
  It is an API layer for AppStore Reviews. Also, It contains both live and mock version in the package. In addition, it proxies between requestor and core network layer. Also, this layer is responsible from the parsing & error handling operations. Besides, if we want to integrate another api such as Google Play Store Reviews, we will create a new Swift Package for it. The main purpose is that separating each APIs from each other. Because each APIs may have different request & response structure.

• Coordinators
  It is a navigation layer. Entire app navigation flows are managed by this layer. For the current situation, we have only one coordinator that called ReviewListCoordinator. We can scale our navigation layer by creating different flows in the app.

• Entities
  It is a simple Swift Package that contains common model objects used by multiple packages. All common model objects are kept inside this package.

• NetworkCore
  It is a core network layer. It operates all global network standards. Also, only API layers should access it.

• SwiftKit
  It is a layer that provides some useful and simplified swift extensions. All these kind of extensions should be defined in this layer.

• UIKitHelper
  It is a layer that provides some useful and simplified extensions of UIKit components. It also contains customized UIKit components such as LoadingView.

• UIKitPreview
  It is a layer that allows us to preview view controllers easily without the need of recompiling whole project. You can even preview a controller in live mode. It uses SwiftUI and UIViewControllerRepresentable even this project is not a SwiftUI Project. It is inspired by a Brian Voong's youtube video.

Screens folder contains;

• ReviewList
  It is a Swift Package that contains ReviewList view and its' all components, even unit tests. In addition, it is a root controller for the app. It navigates to both of FilterOptions & ReviewDetail.

• FilterOptions
  It is a Swift Package that contains FilterOptions view and its' all components, even unit tests and mock data. It is presented by the ReviewList controller by injecting 3 parameters that items as a String array, selectedIndex as an optional Int and a closure called completion.

• ReviewDetail
  It is a Swift Package that contains ReviewDetail view and its' all components, even unit tests and mock data. It is also presented by the ReviewList controller by injecting custom model object called Review.

Technologies

The app is developed using:

• Swift Language version: 5
• Swift Packages

Dependencies

There is no third party dependency in the app.

Setup

There is no dependency to wait for installation.
The project was developed by using Xcode Version 12.4 (12D4e).