karambirov / githubsearch Goto Github PK

Codable and Realm objects should not be in the same class. It would be better if Realm object has convenience init with Codable object like so:

class UserRealm: Object {
    // ...
    convenience init(with: User) { 
        // ...
    }
}

https://github.com/volkanbicer/RealmStore

For navigation the app uses Tab Bar with Navigation Controller inside of it.

What needs to be done:

• Create Tab Bar that holds 2 tabs (Search and Favorites)
• Each tab must have Navigation Controller

The networking layer should be able to request search queries.

What needs to be done:

• Should be built on top of Moya
• It must be used in Services, not in View Controllers directly

If a user taps "Favorite" in Details, the repository saves to the Realm file (it works correctly, the entry appears in Realm Browser). However, fetching in Favorites doesn't work – the table stays empty.

• Fix Favorites fetching

When a cell is reused its labels are not replaced with the new ones. Instead, they just appear on top of the old labels.

• Cells should be reused correctly.

If you try to search something you'll get a list of results. But if you try to do a new search, the table won't be updated with the new results.

• Update the table after a new search.

If a user taps the clear button in the search field, the table should become empty.

• Clears the table if there's no any query in the search bar.

https://www.lordcodes.com/articles/a-modular-analytics-layer-in-swift
https://www.swiftbysundell.com/articles/building-an-enum-based-analytics-system-in-swift/

It is not the responsibility of SearchViewController to reuse and configure cells.

• Encapsulate data source from SearchViewController

https://matt.diephouse.com/2019/12/adopting-value-types-networking/

The views inside of a cell should be joined in one content view. Thus there should be another view that contains all of the UI elements. In RepositoryCell should be used only instance of that view.

Just after search's table view has been populated with data from a network everything works as expected. But if you decide to switch tab to Favorites and back, Search will be black (maybe it's been deallocated).

• Figure out what's wrong

Maybe it worth it to create a service for searching instead of doing a search in VC.

What needs to be done:

• Searching service that encapsulates searching logic. Search for "SearchComponent"

The second screen of the app is Favorites. A user should have the ability to see all favorite repositories without an Internet connection.

What needs to be done:

• Table View with all favorite repositories
• Should work without an Internet connection
• Should be possible to delete repo from favorites

Open a 'About repository' interface.

1. Click the 'Favorite' button,
2. then click the 'Unfavorite' button
3. finally click the 'Favorite' button.
   The APP crashed.

Reason:
When you click the 'Unfavorite' button, the repository is delete from Realm

    func delete(_ object: Object) {
        // Deletes an object from the Realm. Once the object is deleted it is considered invalidated.
        write { $0.delete(object) }
    }

Now, the repository is considered invalidated and can no longer be accessed.

When finally click the 'Favorite' button, you access the deleted repository, so that APP crashed.

    @objc func favoriteButtonTapped() {
        if !viewModel.repository.isFavorite {  // crash
        ...

UI must be user-friendly, so a user should be aware of loading, errors, absence of results.

• Handle error state. Show a message that something went wrong.
• Handle loading state. Show a spinner when trying to get results from a server.
• Handle empty state. Show a label in the middle of the screen that there are no results.

When a user reached the end of the search results a new request should be sent.

• Show 25 results at a time (twice of what iPhone screen can show).
• Send a new request when a user reached the end of the list. Or send the request after the first half of the results have been shown.

If you try to open from Search a repository that already has been saved, navigation bar button title in Details will be "Favorite".

• While opening Details, check if the repository already saved.

• Method create(_:completion:) won't be used. So it needs to be deleted.
• Method fetch(_:predicate:sorted:completion:) should't be generic.

From Details screen user should be able to open Readme screen.

• Should be opened from Details.
• Should be available without an Internet connection.
• Markdown should be rendered like in a browser.

In addition to #20, there should be a generic view controller for Search and Favorites because they share the same functionality.

https://github.com/hyperoslo/Imaginary

The Detail shows information about a repository such as an owner's full name, login, profile image, repo's name and description.

What needs to be done:

• Show information about the repository (full name, login, profile image)
• Show information about the owner (name, description)
• Ability to save the repository in Favorites

https://github.com/hyperoslo/Cache/blob/master/Source/Shared/Library/DataSerializer.swift

Right now all errors in the app are printed into the console. There should be correct error handling, not just printing.

• Add Result type
• Handle errors correctly.

https://www.swiftbysundell.com/articles/providing-a-unified-swift-error-api/
https://www.swiftbysundell.com/basics/result/
https://www.swiftbysundell.com/articles/the-power-of-result-types-in-swift/
https://www.swiftbysundell.com/tips/result-type-convenience-apis/

A user should be able to delete a repository from Favorites without opening details screen.

To open Details there should be some kind of navigation service. Because ViewController shouldn't be aware of how to open other screens.

• Create navigation

The first screen of the app is Search. A user should have the ability to search GitHub repositories.

What needs to be done:

• Search field to write queries
• Table View with results of a search