Carthageコードリーディング::3日目

さて3日目。

前回は「VersionCommand」まわりの実装を見た。 今回は実際にコマンドを実行している周りを見ていく。

エントリポイント（復習）

1日目でも触れたが、エントリポイントであるmain.swiftの以下でhelpコマンドをデフォルトに実行している。

registry.main(defaultVerb: helpCommand.verb) { error in
    fputs(error.description + "\n", stderr)
}

CommandRegistry::main

mainメソッドの中身を見ると、以下のようになっている。

@noreturn public func main(defaultVerb defaultVerb: String, errorHandler: ClientError -> ()) {
        main(arguments: Process.arguments, defaultVerb: defaultVerb, errorHandler: errorHandler)
}

標準のProcess.argumentsを使ってコマンドライン引数を取得した上で、別のメソッドに転送している。

ちなみにProcess.argumentsは[String]を返し、最初の要素はコマンド自身の名前となる。 つまりcarthage helpとした場合は、["carthage", "help"]という結果が得られるはずである。

転送先のメソッドを見てみると・・・ちょっと長い。

@noreturn public func main(arguments arguments: [String], defaultVerb: String, errorHandler: ClientError -> ()) {
  assert(arguments.count >= 1)

  var arguments = arguments

  // Extract the executable name.
  let executableName = arguments.remove(at: 0)

  let verb = arguments.first ?? defaultVerb
  if arguments.count > 0 {
    // Remove the command name.
    arguments.remove(at: 0)
  }

  switch runCommand(verb, arguments: arguments) {
  case .Success?:
    exit(EXIT_SUCCESS)

  case let .Failure(error)?:
    switch error {
    case let .UsageError(description):
      fputs(description + "\n", stderr)

    case let .CommandError(error):
      errorHandler(error)
    }

    exit(EXIT_FAILURE)

  case nil:
    if let subcommandExecuted = executeSubcommandIfExists(executableName, verb: verb, arguments: arguments) {
      exit(subcommandExecuted)
    }

    fputs("Unrecognized command: '\(verb)'. See `\(executableName) help`.\n", stderr)
    exit(EXIT_FAILURE)
  }
}

端折ってもいいけれど一応順番に見ていく。 （今後、繰り返しになりそうであれば割愛していく感じで）

コマンド名と引数の取得

assert(arguments.count >= 1)

var arguments = arguments

// Extract the executable name.
let executableName = arguments.remove(at: 0)

まずassertでargumentsの要素数が1以上であることを確認している。 前述したが、引数無しで$ carthageと打った場合でもcarthageが格納されるはずなのでこれは正当なassert。

そして次に「コマンド名」と「コマンド引数」に分離すべく、argumentsをvarで宣言しなおしている。 （ここで同じ名前で宣言しなおしているのは賛否ありそうだが、あえて新しい名前をつけるシチュエーションでもなかろう）

そして最初の引数であるはずのcarthageを除外して、executableNameに入れている。 （最初、これは使わないから_でいいかと思ったのだが、あとで使っているようだ）

let verb = arguments.first ?? defaultVerb
if arguments.count > 0 {
  // Remove the command name.
  arguments.remove(at: 0)
}

ここでverbにコマンド名、あるいはデフォルトであたえたhelpCommand.verb（すなわちhelp）が入る。

つまり$ carthage versionであればversion、 $ carthageであればhelpがデフォルトコマンドとして格納されるわけだ。

そしてargumentsの最初の要素を削って、コマンドの本来の引数としている。 すなわち$ carthage update --platform macであれば、["--platform", "mac"]となるはずだ。

実行

次に実際にコマンドを実行しているようだ。

switch runCommand(verb, arguments: arguments) {
case .Success?:
  exit(EXIT_SUCCESS)

case let .Failure(error)?:
  switch error {
  case let .UsageError(description):
    fputs(description + "\n", stderr)

  case let .CommandError(error):
    errorHandler(error)
  }

  exit(EXIT_FAILURE)

case nil:
  if let subcommandExecuted = executeSubcommandIfExists(executableName, verb: verb, arguments: arguments) {
    exit(subcommandExecuted)
  }

  fputs("Unrecognized command: '\(verb)'. See `\(executableName) help`.\n", stderr)
  exit(EXIT_FAILURE)
}

runCommand(verb, arguments: arguments)メソッドで先ほど解決した、コマンド名と引数を渡している。 そしてその結果（成功 or 失敗 or nil？）で処理結果を分離している。

そのまま読んでみると、以下のようになるだろうか。

• 成功：プロセス終了
• 失敗（引数の指定が正しくない）：usage（正しい使い方）を出力して終了
• 失敗（コマンド失敗）：登録されたエラーハンドラを実行
• nil：サブコマンドがあれば実行し、なければエラーとする

nilのケースが良くわからなかった。 これは「Commandantモジュール」の中なので、Carthageでは使用していない部分の可能性もある。

追記： 直後に分かったが登録されていないコマンドを与えた場合にnilのケースになるようだ。

$ carthage foo
$ Unrecognized command: 'foo'. See `carthage help`.

CommandRegistry::runCommand

runCommandの中身に飛ぶと、以下のようになっている。

public func runCommand(verb: String, arguments: [String]) -> Result<(), CommandantError<ClientError>>? {
  return self[verb]?.run(ArgumentParser(arguments))
}

self[verb]でsubscriptを呼び出して、CommandWrapperを取得している。

public subscript(verb: String) -> CommandWrapper<ClientError>? {
        return commandsByVerb[verb]
}

commandsByVerbは以下のように宣言されており、registerメソッドを呼び出した際に更新されている。

private var commandsByVerb: [String: CommandWrapper<ClientError>] = [:]

public func register<C: CommandType where C.ClientError == ClientError, C.Options.ClientError == ClientError>(command: C) {
  commandsByVerb[command.verb] = CommandWrapper(command)
}

つまりcommandsByVerbはコマンド名をキーに、CommandoTypeのラッパーを値として格納するDictionaryだ。 これによってコマンド名に対応するCommandWrapper（とやら）を取得して、.run(ArgumentParser(arguments))を呼び出している。

ArgumentParserは大体想像するとおりのこと（つまり引数文字列のパース）をやっていると思うので、とりあえず放置する。

CommandWrapper

まずコード全体を見てみる。

public struct CommandWrapper<ClientError: ClientErrorType> {
    public let verb: String
    public let function: String

    public let run: ArgumentParser -> Result<(), CommandantError<ClientError>>

    public let usage: () -> CommandantError<ClientError>?

    /// Creates a command that wraps another.
    private init<C: CommandType where C.ClientError == ClientError, C.Options.ClientError == ClientError>(_ command: C) {
        verb = command.verb
        function = command.function
        run = { (arguments: ArgumentParser) -> Result<(), CommandantError<ClientError>> in
            let options = C.Options.evaluate(.Arguments(arguments))

            if let remainingArguments = arguments.remainingArguments {
                return .Failure(unrecognizedArgumentsError(remainingArguments))
            }

            switch options {
            case let .Success(options):
                return command
                    .run(options)
                    .mapError(CommandantError.CommandError)

            case let .Failure(error):
                return .Failure(error)
            }
        }
        usage = { () -> CommandantError<ClientError>? in
            return C.Options.evaluate(.Usage).error
        }
    }
}

これもちょっとややこしそうだ。

verb、function

とりあえずイニシャライザを覗いてみると、、、 verbとfunctionは、単にCommandTypeの値を転記しているだけのようだ。

verb = command.verb
function = command.function

run

runはArgumentParserを受け取ってResultを返すクロージャが格納されている。

run = { (arguments: ArgumentParser) -> Result<(), CommandantError<ClientError>> in
  let options = C.Options.evaluate(.Arguments(arguments))

  if let remainingArguments = arguments.remainingArguments {
    return .Failure(unrecognizedArgumentsError(remainingArguments))
  }

  switch options {
  case let .Success(options):
    return command
      .run(options)
      .mapError(CommandantError.CommandError)

  case let .Failure(error):
    return .Failure(error)
  }
}

個人的にはクロージャではなくて普通にメソッドでも良いと感じたのだが、何かメリットがあるのだろうか？

とりあえずオプション引数のパースを試みて、成功したらcommand.run(options)で実行し、 失敗した場合は.Failureで失敗を返しているようだ。（まぁその辺の詳細はおいおい）

command.run(options)で実行される具体例は、前回見た以下となる。

public func run(options: NoOptions<CarthageError>) -> Result<(), CarthageError> {
    let versionString = NSBundle(identifier: CarthageKitBundleIdentifier)?.objectForInfoDictionaryKey("CFBundleShortVersionString") as! String
    carthage.println(versionString)
    return .Success(())
}

これでコマンド引数のパースから、前回のVersionCommandのrun()までつながった。

usage

usageも同じようにクロージャが格納されている。

usage = { () -> CommandantError<ClientError>? in
  return C.Options.evaluate(.Usage).error
}

CommandTypeに紐づくOptionsで.Usageを評価させて、.errorを返しているらしい。 難しく見えるけれど、要はオプション引数のusage（使い方）を返す処理のようだ。

また新しいテーマに入ってしまうので深追いはやめておくが、参考までにHelpCommandのevaluateは以下のようになっている。

public static func evaluate(m: CommandMode) -> Result<HelpOptions, CommandantError<ClientError>> {
  return create
    <*> m <| Argument(defaultValue: "", usage: "the command to display help for")
}

まとめ

とりあえず今日はここまで！ なんかCarthageというよりも依存ライブラリに対するコードリーディングになっている気もするが・・・。

続く・・・のかもしれない。

Carthageコードリーディング::2日目

今回は一番簡単であろう「version」コマンドを見ていく。

VersionCommand

登録

前回も触れたが、main.swiftでCommandRegistryに各コマンドを登録している。

// main.swift
let registry = CommandRegistry<CarthageError>()
registry.register(VersionCommand())

「version」コマンドは「VersionCommand」という構造体を生成して登録している。

VersionCommandの定義

実際の定義を見てみると、以下のようになっている。

public struct VersionCommand: CommandType {
    public let verb = "version"
    public let function = "Display the current version of Carthage"

    public func run(options: NoOptions<CarthageError>) -> Result<(), CarthageError> {
        let versionString = NSBundle(identifier: CarthageKitBundleIdentifier)?.objectForInfoDictionaryKey("CFBundleShortVersionString") as! String
        carthage.println(versionString)
        return .Success(())
    }
}

「CommandType」というプロトコルを実装しているシンプルな構造体になっている。

見たままだが、定義されている定数とメソッドは以下のようになっている。

• verb・・・コマンド名
• function・・・コマンドのusage
• run()・・・実際に実行する処理

「verb」と「function」で定義された文字列は「carthage help」で確認できる。

$ carthage help
Available commands:
...
   version           Display the current version of Carthage

「run()」の処理結果はもちろん「carthage version」で確認できる。

$ carthage version
0.15.2

これでとりあえず「VersionCommand」の処理内容は全て確認できたはずである。

run()の中身

run()の中身をもう一度見てみる。

public func run(options: NoOptions<CarthageError>) -> Result<(), CarthageError> {
  let versionString = NSBundle(identifier: CarthageKitBundleIdentifier)?.objectForInfoDictionaryKey("CFBundleShortVersionString") as! String
  carthage.println(versionString)
  return .Success(())
}

最初はバージョン番号の取得だが、よく使われる（と私が思っている）NSBundle.mainBundle()は使われていない。

CarthageKitBundleIdentifierの定義を見てみる。

/// Carthage’s bundle identifier.
public let CarthageKitBundleIdentifier = NSBundle(forClass: Project.self).bundleIdentifier!

Projectクラスが所属するBundleのbundleIdentifierを取得するようになっているようだ。 正確な意図がわからなかったが、Frameworkなどでプロジェクトを分割した時でも正しいplistが参照できるようにするためだろうか？

ちなみに強制アンラップ(!)や強制キャスト(as!)が使用されているのには興味深い。

プロジェクトの開発ルールによっては一部を除外してほぼ禁止されることも多いが、必ず成功するという確信が得られるケースでは利用しているようだ。 （これは個人的にも賛成だ）

次はバージョン番号を出力しているコードであるが、carthage.printlnなるメソッドが利用されている。

carthage.println(versionString)

そしてどうやら定義はExtensions.swiftに記述された以下関数らしい。

/// A thread-safe version of Swift's standard println().
internal func println<T>(object: T) {
    dispatch_async(outputQueue) {
        Swift.print(object)
    }
}

標準のprint()がスレッドセーフでないので、スレッドセーフなバージョンを用意しているようだ。 （コメントに書いてあるまんまですね）

そして私は初めて知ったのだが、carthage.printlnのcarthageはモジュール名を指しているらしい。 つまり「モジュール名.関数」という形でアクセスできるというわけだ。（常識だったりする？）

最初はどこかにインスタンスが定義されているものと思ったが、そもそも実体は関数であるわけで。

元のrun()メソッドに戻り、最後は結果を返している。

return .Success(())

これは「Result」モジュールの「Result」が利用されているらしい。

/// An enum representing either a failure with an explanatory error, or a success with a result value.
public enum Result<T, Error: ResultErrorType>: ResultType, CustomStringConvertible, CustomDebugStringConvertible {
    case Success(T)
    case Failure(Error)

Haskell使いには「Either」といったほうが早いだろうか？ つまり今回のケースでは処理としては「成功」で、その中身は「空タプル」というわけだ。

CommandTypeプロトコル

これで一応はrun()の中身が読み終わったので、CommandTypeプロトコルを見てみる。

/// Represents a subcommand that can be executed with its own set of arguments.
public protocol CommandType {

    /// The command's options type.
    associatedtype Options: OptionsType

    associatedtype ClientError: ClientErrorType = Options.ClientError

    /// The action that users should specify to use this subcommand (e.g.,
    /// `help`).
    var verb: String { get }

    /// A human-readable, high-level description of what this command is used
    /// for.
    var function: String { get }

    /// Runs this subcommand with the given options.
    func run(options: Options) -> Result<(), ClientError>
}

ここまでくれば目新しいものは無い。 VersionCommandで実装されていた定数verbとfunction、run()がプロトコルとして定義されている。

つまりすべてのCarthageコマンドは、このCommandTypeプロトコルを実装することになる。

もし自分で新しいコマンドを作りたい場合（がもしあったとしてだが）、 このプロトコルを実装したクラスあるいは構造体を作ってCommandRegistryに登録しておけばいいわけだ。 （なんかオブジェクト指向の授業みたいになっちゃったけど、まぁそれはさておき）

ちなみにCommandTypeは「Commandant」モジュールに含まれている。 これは（おそらく）Carthageのコマンド引数のパースや実行の仕組みが「Commandant」モジュールで実現されていることを示唆する。

まとめ

今回は一番簡単であろう「version」コマンドがどのように処理されているのかを見てみた。 単純な実装ではあったが、コマンド実行の仕組み、ちょっとした工夫が見られたような気がする。

はてさて、こんなペースで続けていてコードリーディングが終わるのか不安である。 次回に続く・・・のか？

文章中の表現が統一できていない箇所が多いですけれど、そのうち揃えていきますのでご容赦を。

Carthageコードリーディング::1日目

Swift力を上げるために、Swiftで書かれたパッケージマネージャ「Carthage」のコードリーディングを始めてみる。 github.com

準備

まずはGitHubリポジトリをclone。

$ git clone https://github.com/Carthage/Carthage.git

次に依存ライブラリをインストール。

$ carthage update --platform mac

関係ないけど、自身の依存関係管理に自身（つまりCarthage）を使ってるのって夢があるよね。 GitやSVNといったVCSほどの感動はないけれど。

エントリポイント

どうやらエントリポイントは「main.swift」らしい。 https://github.com/Carthage/Carthage/blob/master/Source/carthage/main.swift

まずはCarthageを動作させるために必須なバージョンのgitがインストールされているかチェックしている模様。

guard ensureGitVersion().first()?.value == true else {
    fputs("Carthage requires git \(CarthageRequiredGitVersion) or later.\n", stderr)
    exit(EXIT_FAILURE)
}

どうやらCarthageは、2.3.0以上のgitでなければ動作しないようだ。（READMEに書いてあるだろうけれど）

/// The git version Carthage requires at least.
public let CarthageRequiredGitVersion = "2.3.0"

次にcarthageの実行パスを環境変数に追加している。

if let carthagePath = NSBundle.mainBundle().executablePath {
    setenv("CARTHAGE_PATH", carthagePath, 0)
}

別プロセスで参照することがあるからだろうか？ 今のところ必要性が分かっていない。

そしてここからが本質的なところとなるが、 carthageのコマンドに対応したものが、CommandRegistryに追加していっている。

let registry = CommandRegistry<CarthageError>()
registry.register(ArchiveCommand())
registry.register(BootstrapCommand())
...
registry.register(VersionCommand())

そして、helpコマンドをデフォルトとして実際に実行している。

let helpCommand = HelpCommand(registry: registry)
registry.register(helpCommand)

registry.main(defaultVerb: helpCommand.verb) { error in
    fputs(error.description + "\n", stderr)
}

ここでいうデフォルトとはつまり単にcarthageと引数を与えずに実行した場合という意味だ。 実際に、carthageとだけ打つとhelpコマンドが実行されるのが分かる。

$ carthage
Available commands:

   archive           Archives built frameworks into a zip that Carthage can use
   bootstrap         Check out and build the project's dependencies
   build             Build the project's dependencies
   checkout          Check out the project's dependencies
   copy-frameworks   In a Run Script build phase, copies each framework specified by a SCRIPT_INPUT_FILE environment variable into the built app bundle
   fetch             Clones or fetches a Git repository ahead of time
   help              Display general or command-specific help
   update            Update and rebuild the project's dependencies
   version           Display the current version of Carthage

エントリポイントとしてはこんなところ。 CommandRegistryがいい味を出している。

依存ライブラリ

Carthageはシンプルなパッケージマネージャだと聞いていたので、依存ライブラリは少ないと思っていたのがところがどっこい。間接的な依存ライブラリも多いが、それらも含めると結構な量である。

Commandant

コマンドライン引数のパース用ライブラリらしい。 後述のJSONパーサ「Argo」をインスパイヤしているとのこと。

Curry

カリー化用の関数を提供している。 たぶん今回の中で一番シンプルなライブラリ。（だって実質1ファイルだもの）

ReactiveCocoa

いわずとしれたリアクティブプログラミング用のライブラリ。

Quick

こちらもいわずとしれたBDDなテスティングフレームワーク。

Nimble

Quickと一緒に使えるマッチャー。

ReactiveTask

シェル実行用のライブラリらしい。 名前からしてReactiveCocoa（あるいはRx系のライブラリの考え方）をインスパイヤしているのは間違いないだろう。

Argo

関数型のJSONパーサ。 どうやらApplicativeFunctorの考え方がベースになってそう。

PrettyColors

ターミナルの色付け用。

Result

HaskellでいうところのEitherの++的な？

Tentacle

GitHub API用のライブラリ。 ちなみに翻訳して知ったのだが「触手」という意味の単語らしい。 （触手って・・・もう少しネーミングどうにかならなかったのか。。）

まとめ

やり始めたけど思ったより大変そう・・・。 はてさて、2日目以降の記事は書けるのか？

CookieClicker v2.0 - クッキーを自動クリック

風邪を引いて体調悪いので、自動クリックに対応してみた。

これでよりたくさんのクッキーを焼けるぞ！やったね！！

追記（2016/06/26）：
久しぶりに実行したらAddEventでエラーになっていたので修正。

Haskell :: mapとfilterをfoldrで実装してみた。

Functional Programming in Swift で 同様のコード例があったのでHaskellでも書いてみた。

関数プログラミング実践入門で、「筆者がfoldrの方が好きなので」的な記述があったけれど、consリストで畳み込むコードを考えると、確かにfoldrの方が自然に感じる気もしてきた。

関数プログラミング実践入門 - ランレングス復号化を書いてみた

ランレングス圧縮が例題として載っていたので、練習がてら復号化を書いてみることに。

とりあえず書けたのだが。

安全でないreadを使っているのはさておき、なんだろうこの微妙感は。

追記（2016/05/05）：
`let`を活用することで少し読みやすくなった。冗長だった処理もリファクタリング出来た。

Swiftソースのメソッド名とかの数を数えるスクリプト

Rubyの勉強がてら。自分用なので適当。