Code Monkey home page Code Monkey logo

ios-engineer-codecheck's Introduction

株式会社ゆめみ iOS エンジニアコードチェック課題

概要

本プロジェクトは株式会社ゆめみ(以下弊社)が、弊社に iOS エンジニアを希望する方に出す課題のベースプロジェクトです。本課題が与えられた方は、下記の概要を詳しく読んだ上で課題を取り組んでください。

アプリ仕様

本アプリは GitHub のリポジトリーを検索するアプリです。

動作イメージ

環境

  • IDE:基本最新の安定版(本概要更新時点では Xcode 13.0)
  • Swift:基本最新の安定版(本概要更新時点では Swift 5.5)
  • 開発ターゲット:基本最新の安定版(本概要更新時点では iOS 15.0)
  • サードパーティーライブラリーの利用:オープンソースのものに限り制限しない

動作

  1. 何かしらのキーワードを入力
  2. GitHub API(search/repositories)でリポジトリーを検索し、結果一覧を概要(リポジトリ名)で表示
  3. 特定の結果を選択したら、該当リポジトリの詳細(リポジトリ名、オーナーアイコン、プロジェクト言語、Star 数、Watcher 数、Fork 数、Issue 数)を表示

課題取り組み方法

Issues を確認した上、本プロジェクトを Duplicate してください(Fork しないようにしてください。必要ならプライベートリポジトリーにしても大丈夫です)。今後のコミットは全てご自身のリポジトリーで行ってください。

コードチェックの課題 Issue は全て 課題 Milestone がついており、難易度に応じて Label が 初級中級ボーナス に分けられています。課題の必須/選択は下記の表とします:

初級 中級 ボーナス
新卒/未経験者 必須 選択 選択
中途/経験者 必須 必須 選択

課題 Issueをご自身のリポジトリーにコピーするGitHub Actionsをご用意しております。
こちらのWorkflow手動でトリガーすることでコピーできますのでご活用下さい。

課題が完成したら、リポジトリーのアドレスを教えてください。

参考記事

提出された課題の評価ポイントに関しては、こちらの記事に詳しく書かれてありますので、ぜひご覧ください。

ios-engineer-codecheck's People

Contributors

el-hoshino avatar watanavex avatar

Watchers

 avatar

ios-engineer-codecheck's Issues

検索結果の表示件数を増やす

現在のAPIの使い方では最大30個しか検索結果が表示できない。
search-repositories
検索結果を増やすために以下の対策を検討する。

対策1

1ページ当たりの検索結果を100まで増やしてみる。
検索パラメータにper_page=100を追加する。

対策2

リストの最後に[もっと見る]ボタンを設置して続きの検索結果が取得できるようにする。
検索パラメータにpage=<ページ番号>を追加する。

Fat VC の回避

本プロジェクトは ViewController が必要以上の責務を抱えており、いわゆる Fat VC 状態です。最低限の責務の切り出しをしてあげましょう。

※本課題は #6 の下位互換です。

検索画面に並び替えメニューを追加

AS IS

検索結果のリストが 何の順番で並んでいるか? 分からない。

TO BE

現在の並び順を表示すると同時に「starが多い順」「更新が新しい順」などで
並び替えができる機能を追加する。

アーキテクチャを適用

最近巷では MVC や MVVM などの GUI アーキテクチャから、Redux や VIPER などのアプリアーキテクチャまで様々なアーキテクチャが話題になっています。どれでもいいので本プロジェクトを自分の慣れたアーキテクチャに修正してください。

※本課題は #4 の上位互換です。

文字列を.stringsで設定する

文字列がソースコード上にハードコーディングされているので、
.stringsファイルに設定した方が望ましい。

プログラム構造をリファクタリング

本プロジェクトは様々な原則に違反しています。下記のリストを参考にプログラムをリファクタリングしましょう:

  • DRY 原則
  • CQS 原則
  • 単一責任原則
  • インターフェイス分離の原則
  • 驚き最小の原則

検索結果が0件だったときの表示

AS IS

検索結果が0件だったとき、リスト上に何も表示されない。
ユーザーは何が起きたのか?次にどんな操作をすれば良いのか?混乱する恐れがある。

TO BE

検索結果が0件だったとき、画面上に「検索結果が見つかりませんでした。」を表示する。

ソースコードの可読性の向上

本プロジェクトのソースコードはとても読みにくいです。下記のリストを参考に読みやすいように修正してください。

  • 命名規約(参考:Swift API Design Guidelines
  • ネスト
  • インデント
  • コメントの適切性
  • スペースや改行
  • その他

無用なtagの設定を削除

検索画面のtableView(_:cellForRowAt:)内で
cell.tag = indexPath.row このようにcellに対してtagを設定しているが、
どこからも参照されていないのでこの処理は削除しても構わない。

getAvatarImage()からfullNameLabelを移動する

詳細画面のgetAvatarImage()中でfullNameLabelの設定を行っている。
getAvatarImage()はavatar_imageの取得・表示に専念させたいので、
fullNameLabelの設定はviewDidLoadに移動しても問題ない。

テストを追加

現在のプログラムではテストがありません。UnitTest や UITest を追加してください。

SearchBarにキャンセルボタンを設置する

SearchBarに文字列を入力するモード抜けてキーボードを非表示にすることができないので、
SearchBarにキャンセルボタンを設置して入力モードを抜けられるようにするのが望ましい。

watchers_count の廃止に対応

GitHub APIの仕様が変更となり、watchers_count は 廃止となり、
stargazers_countと同じ値がセットされるようになったので、
以下の資料を調査して適切なデータを取得する。

watchers_count の代わりに subscribers_count を使えば良いらしいが、
search-repositories のレスポンスに含まれていなかった。

参考資料

watchers & watchers_count are incorrect
BUG “watchers_count” is the duplicate of “stargazers_count”
Upcoming Changes to Watcher and Star APIs

通信中はProgressViewを表示する

AS IS

通信中に何も表示していない。

TO BE

通信中はProgressViewを表示して通信中であることをユーザーに伝えること。

新機能を追加

本アプリの機能は極めて単純です。使いやすさが損なわれない前提で、様々な新機能を追加してあげてください。

ソースコードの安全性の向上

本プロジェクトは安全性の低いコードたくさんあります。下記のリストを参考に、安全性の低いコードを撲滅し、安全性を高めましょう。

  • 強制アンラップ
  • 強制ダウンキャスト
  • 不必要なIUO
  • 想定外の nil の握り潰し

詳細画面から検索画面に戻ったときにスクロール位置が先頭に戻る

詳細画面から検索画面に戻ったときに、スクロール位置が先頭に戻ってしまう。

Expected

詳細画面から検索画面に戻ったとき、スクロール位置が保持されていること。

Operation

1 検索画面を表示する。
2 検索結果が30件以上ありそうなリポジトリを検索する。
3 検索結果を下の方までスクロールする。
4 リポジトリの1つをタップして、詳細画面に遷移する。
5 詳細画面から検索画面に戻る。

ViewをSwiftUIに変更する

MVVMアーキテクチャを採用したので、ViewだけSwiftUIに変更すれば問題なく動作するはず。

UI をブラッシュアップ

本アプリの UI は極めてシンプルです。これでも特に問題はありませんが、やはりいまいち映えないです。使いやすさが損なわれない前提で、UI をブラッシュアップしてください。方向性(エレガント、ゴージャス、モダン等)は問いません。また UIKit だけでなく、SwiftUI の導入も OK です。

検索結果が画面内に収まる場合はスクロールしないようにする

AS IS

検索結果の件数が少なくて(0件も含む)1画面内に収まる場合でもスクロールが可能になっている。
そのため、画面に何も表示されない状態までスクロールすることができる。

TO BE

検索結果の件数が少なくて1画面内に収まる場合はスクロール禁止にする。

キャプチャー

バグを修正

本プロジェクトに Storyboard 含め、至る所にバグが潜んであります。下記のリストを参考にバグを修正してください。

  • レイアウトエラー
  • メモリリーク
  • パースエラー

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.