enumを用いたswitchの取得

Question

前提・実現したいこと

アラート専用のファイルを作成し、viewControllerで出力する。
アラートファイルでは可読性をあげるためにenumを使ってSwitch文の分岐をIntではなくStringで表示させ、その場に応じて異なったアラートを表示させる。
今回の場合、アラートのtitleとmessageを２種類用意し、２箇所で使用する予定。

発生している問題・エラーメッセージ

色々試し、様々なエラーが出ていましたが、今はenumがviewControllerで取得できないのが１番の原因かと思われます。

Cannot find 'ErrorType' in scope

該当のソースコード

import Foundation
import UIKit

class Alert: UIAlertController {

    static func show(title: String, message: String, viewController: UIViewController) {
        enum ErrorType {
            case failedLoadUrl
            case failedFetchAPI

            func title() -> String {
                switch self {
                case .failedLoadUrl:
                    return "Webページの取得に失敗しました"
                case .failedFetchAPI:
                    return "タイトルの取得に失敗しました"
                }
            }

            func message() -> String {
                switch self {
                case .failedLoadUrl:
                    return "もう一度やり直してください"
                case .failedFetchAPI:
                    return "アプリを再起動し、もう一度やり直してください"
                }
            }
        }
    }
}

class ViewController: UIViewController {
    
   Alert.show(title: ErrorType.failedLoadUrl.title(), message: .failedLoadUrl.message(), viewController: self)
     
}

試したこと

Alert.showのtitle, messageの欄にenumで設定した２つの文字列を色々挿入してみましたがうまくいきませんでした。

Answer 1

期待されている文脈で使うのであれば、Alert クラスのトップレベルで enum を定義してあげるのがいいかと思います。

import UIKit

class Alert: UIAlertController {
    enum ErrorType {
        case failedLoadUrl
        case failedFetchAPI
        
        func title() -> String {
            switch self {
            case .failedLoadUrl:
                return "Webページの取得に失敗しました"
            case .failedFetchAPI:
                return "タイトルの取得に失敗しました"
            }
        }
        
        func message() -> String {
            switch self {
            case .failedLoadUrl:
                return "もう一度やり直してください"
            case .failedFetchAPI:
                return "アプリを再起動し、もう一度やり直してください"
            }
        }
    }
    
    static func show(title: ErrorType, message: ErrorType, viewController: UIViewController) {
        let titleString = title.title()
        let messageString = message.message()
        
        // あとは適切に扱う
        print("Title:", titleString)
        print("Message:", messageString)
    }
}

show()の第一引数、第二引数の型は、ご自身で作られた ErrorType 型になります。このようにしておけば、

        Alert.show(title: .failedLoadUrl, message: .failedLoadUrl, viewController: self)

のような感じで呼び出せますし、Xcode は引数の型をみて適切な候補を推論できるようになりますので、引数に指定できる enum の値を限定（failedLoadUrl もしくは failedFetchAPI）することが可能となります。

元々のコードで呼び出されていた

   Alert.show(title: ErrorType.failedLoadUrl.title(), message: .failedLoadUrl.message(), viewController: self)

だと、毎回打ち込む本人が ErrorType という型を覚えておく必要があり、またtitle()などのプロパティまで指定しなければいけないため、かえって扱いが面倒になってしまいます。

これらのことを考えると、title と message の両方を引数として与える必要があるのかも考え直すことができるかと思います。title と message の組み合わせが限定できるのであれば、むしろ

    static func show(reason: ErrorType, viewController: UIViewController) {
        let titleString = reason.title()
        let messageString = reason.message()
        
        // あとは適切に扱う
        print("Title:", titleString)
        print("Message:", messageString)
    }

のような感じで、呼び出しに指定する値は「エラーの原因」ひとつにしておいたほうが、今後の拡張性は高くなりそうな気がします。

Comments

[TsukubaDepot]

ちなみに、エラーの根本的な原因は、miyabi_takatsukさんご指摘のように、スコープ外から参照していることが原因です。

Xcodeの場合、スコープから見えない型は自動補完が効かないようになっています。したがって、

ErrorType.

まで打ち込んでも tab 補完ができないのであれば、それは宣言方法が間違っていると疑った方がいいかと思います。

[TsukubaDepot]

ちなみに、show というメソッドはベースクラスの UIAlertController がすでにメソッド名として使っていますので、違う名前にした方が紛らわしくなくて良いかと思います。

[miyabi_pudding]

しまった、スーパークラスにあったメソッドでしたか・・・。

[TsukubaDepot]

正確には UIAlertController ではなくて UIViewController でした...

[Narikura]

ご回答ありがとうございます。メソッド名につきましてもベースクラスのメソッド名として使われていないものを使用するよう心がけます（今回のshowはUIViewControllerのようですが）。これまでも質問に答えていただきありがとうございます。とても助かっております。

[Narikura]

（誤入力）

Answer 2

エラーの通りです。
そのスコープでは、ErrorTypeを使用することはできません。
なぜなら、
Alertクラスのメソッド内で宣言している列挙型なのに、
他のクラスである、
ViewControllerから呼び出すことはできるわけがないからです。
ErrorType列挙型を他のクラスなどで使うならば、
グローバルで定義・宣言しましょう。

コメントに対して

使用の例示を出します。

import Foundation
import UIKit

// ここで定義
enum ErrorType {
  case failedLoadUrl
  case failedFetchAPI

  func title() -> String {
    switch self {
      case .failedLoadUrl:
        return "Webページの取得に失敗しました"
      case .failedFetchAPI:
        return "タイトルの取得に失敗しました"
    }
  }

  func message() -> String {
    switch self {
      case .failedLoadUrl:
        return "もう一度やり直してください"
      case .failedFetchAPI:
        return "アプリを再起動し、もう一度やり直してください"
    }
  }
}

class Alert: UIAlertController {
  // 引数では、ErrorTypeを入れさせる
  static func show(errorType: ErrorType, viewController: UIViewController) {
    // 処理では、errorType.title()、errorType.message()で、各文字列を取得できる
  }
}

class ViewController: UIViewController {
  // メソッドの引数で、ErroType自体を入れるので、ここではString文字列を入れる必要はない
  Alert.show(errorType: .failedLoadUrl, viewController: self)
}

Comments

[Narikura]

ご回答ありがとうございます。enumのグローバル定義の仕方がわかりません。enumにstaticを付けてみましたがエラーが出てしまいました。extensionを利用するのでしょうか。

[miyabi_pudding]

class Alert: UIAlertController {

の前行に配置・展開し宣言します。
つまり、全てのコードで参照できる位置で宣言します。

というか通常は、
列挙型は、どこからも参照できるようにした方が、処理を活かせるので、グローバルスコープないし、staticなメンバとして配置することが圧倒的に多いですので、
むしろ、クラスメソッド内で列挙型を宣言しているのは初めて見ました。

[Narikura]

ありがとうございます。私の実力が及ばないもので、そうするとSwitchのcaseの部分でenumの要素二つがno member になってしまうのですが、、
また勉強始めなので初めて知りました。助言ありがとうございます。

[Narikura]

class内部のenumは残したままclassの前にも同じコードを記述することでいいのでしょうか。また、そうした際のアラートの呼び出し文はどのように記述するべきなのでしょうか。

[miyabi_pudding]

その、アラートの呼び出し文の記載がないので、なんとも言えません。

[Narikura]

コード例を追加していただきありがとうございます。全てのクラスでクラスで参照できるようグローバルでの記述をこれから必要に応じて利用していきます。ありがとうございます。

[miyabi_pudding]

解決したなら、BAを選出して、質問を閉じましょう。

[Narikura]

let alert = UIAlertController(title: ErrorType, message: ErrorType, preferredStyle: .alert)
viewController.present(alert, animated: true, completion: nil)
let actionCancel = UIAlertAction(title: "OK", style: .cancel) {
action in print("Pushed CANCEL!")
}
alert.addAction(actionCancel)
ちなみにですが上記のように定義しました。しかしlet alertで定義したアラートのtitleとmessageにenumのErrorTypeを使うとエラー出るのですが使えないのですか？
質問を閉じた後ですので回答する必要はございませんがもしよろしければお願いいたします。

[miyabi_pudding]

使えません。
UIAlertContllerのinitの引数のtitleは、
String型しか受け付けません。
ErrorType型は入れることはできません。

型についてと、
初期化メソッド（インスタンスを生成する時に実行されるinitメソッドのこと）についてしっかり学習して下さい。