Observable

NTYPopulatorというiOS/OS X用のライブラリを書いた。これはCore Data向けに初期データを用意する。

インストール

CocoaPodsに公開したので、pod "NTYPopulator"からインストールできる。

使い方

最も簡単な使い方はAppDelegate.mに一行追加するだけで良い。

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [[NTYPopulator new] run];
    return YES;
}

この一行はリソースバンドル内にあるseeds/*.csvを探し出し、ファイル名と同名のEntityに初期データを追加する。例えば、seeds/user.csvというファイルにあるデータはUserというEntityに追加される。

デフォルトで参照されるモデルファイルはModel.momd、データを保存するSQLiteファイルは$(CFBundleName).sqliteとなっている。これらを設定することもできる。

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    NSURL *modelURL = [[NSBundle mainBundle] URLForResource:@"MyModel" withExtension:@"momd"];
    NSURL *documentDirectoryURL = [[[NSFileManager defaultManager] URLsForDirectory:NSDocumentDirectory inDomains:NSUserDomainMask] lastObject];
    NSURL *sqliteURL = [documentDirectoryURL URLByAppendingPathComponent:@"MySQLite.sqlite"];

    NTYPopulator *populator = [[NTYPopulator alloc] initWithModelURL:modelURL sqliteURL:sqliteURL];
    [populator run];

    return YES;
}

動機

まず、マスターデータを事前に用意する必要が出てきたため、初期データを簡単に用意する方法について調べた。Railsではdb/seed.rbにRubyプログラムを書いてrake db:seedを実行すれば簡単に追加できるから、Core Dataにもそういう仕組みがあると思った。でもなかった。次に任意のフォーマットからSQLiteファイルを作成するライブラリを書こうと思ったけど、それもうまくいかないことがわかった。というのも、Core Dataによって定義されるスキーマは特殊でその仕様は未公開（中身を見れば分かるけど）なので、未公開の仕様を前提としたライブラリは突然の仕様変更で壊れるリスクがある。そこで、ちゃんとCore DataのAPIを使って初期データを追加するライブラリを書くことにした。

課題

現在の実装では、毎回Entityのデータを全部消去してから追加し直すようになっている。件数が少なければ問題にはならないかもしれないけど、件数が増加すると起動が遅くなる可能性がある。様子を見て、例えばシードファイルの最終更新日時が更新されているときのみ追加し直す処理を行うなどの実装を加えていきたい。