保存処理を分離する｜Repository導入 - シンプルなTodo CLIアプリ第4回

@nqounetです。

シリーズ「シンプルなTodo CLIアプリ」の第4回です。

前回の振り返り

JSONファイルで永続化｜データを保存しよう - シンプルなTodo CLIアプリ第3回

プログラム終了後もタスクを保持するため、JSONファイルでの永続化を実装します。PerlのJSONモジュールを使った読み書き方法を解説。タブ区切りからJSONへの移行で、より堅牢なデータ管理を実現しましょう。

nqou.net

前回は、JSONフォーマットでタスクを永続化しました。

JSON モジュールで読み書き
タブ区切りの問題を解決
属性追加が容易になった

しかし、永続化ロジック（load_tasks と save_tasks）がメインスクリプトに直接書かれていました。今回は、この永続化処理を Repositoryパターンで分離します。

なぜ永続化処理を分離するのか

現状の問題点

現在のコードを見てみましょう。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
if ($command eq 'add') {
    my @tasks = load_tasks($file);  # ← 永続化
    my $task = Task->new(...);
    push @tasks, $task;
    save_tasks($file, @tasks);      # ← 永続化
}
elsif ($command eq 'list') {
    my @tasks = load_tasks($file);  # ← 永続化
    # ...
}
elsif ($command eq 'complete') {
    my @tasks = load_tasks($file);  # ← 永続化
    # ...
    save_tasks($file, @tasks);      # ← 永続化
}

各コマンドの処理に永続化ロジックが混在しています。

問題1: 保存形式を変更しにくい

JSON→SQLiteに変更したい場合、load_tasks と save_tasks を大幅に書き換える必要があります。しかも、メイン処理への影響がないか確認が必要です。

問題2: テストが書きにくい

テストを実行するたびに実際のファイルが作成・変更されます。

テスト後のファイル削除が必要になる
並列テストで競合する可能性がある
CI環境でのファイルパス問題が発生する可能性がある

問題3: ファイルパスがハードコード

my $file = 'tasks.json'; がグローバルに定義されており、柔軟性がありません。

Repositoryパターンとは

Repositoryパターンの構造を図で確認しましょう。

	classDiagram
    class TaskRepository_Role {
        <<Role>>
        +save(task)*
        +find(id)*
        +all()*
        +remove(id)*
    }
    
    class TaskRepository_File {
        -filepath
        -_load()
        -_save_all()
        +save(task)
        +find(id)
        +all()
        +remove(id)
    }
    
    class Task {
        +id
        +title
        +is_done
    }
    
    TaskRepository_Role <|.. TaskRepository_File : with
    TaskRepository_File --> Task : manages

この図は、Repositoryパターンの基本構造を示しています。TaskRepository::Roleがインターフェース（必須メソッド）を定義し、TaskRepository::Fileがそのインターフェースを実装します。メイン処理はRoleで定義されたメソッドを通じてタスクを操作するため、具体的な永続化方法を知る必要がありません。

データアクセスを抽象化する

Repositoryパターンは、データの保存・取得のロジックを一箇所にカプセル化するデザインパターンです。

	flowchart LR
    subgraph Before
        direction LR
        A[メイン処理] <--> B[ファイル操作コード] <--> C[ファイル]
    end

	flowchart LR
    subgraph After
        direction LR
        D[メイン処理] <--> E[Repository] <--> F[ファイル]
    end

メイン処理はRepositoryのメソッドを呼ぶだけ。ファイル操作の詳細を知る必要がありません。

コレクションのように扱える

Repositoryは「タスクのコレクション」のように振る舞います。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# タスクを追加
$repository->save($task);

# IDでタスクを取得
my $task = $repository->find(1);

# 全タスクを取得
my @tasks = $repository->all;

# タスクを削除
$repository->remove(1);

内部でファイルを使っているか、データベースを使っているか、メモリに保存しているかは、呼び出し側は気にしません。

Roleでインターフェースを定義する

TaskRepository::Role

まず、Repositoryが持つべきメソッドを Moo::Role で定義します。

1
2
3
4
5
6
7
8
package TaskRepository::Role {
    use Moo::Role;

    requires 'save';    # タスクを保存（新規/更新）
    requires 'find';    # IDでタスクを取得
    requires 'all';     # 全タスクを取得
    requires 'remove';  # タスクを削除
}

requires で宣言されたメソッドは、このRoleを使うクラスが必ず実装しなければなりません。

第10回-継承しないで振る舞いを共有 - Mooで覚えるオブジェクト指向プログラミング

MessageもUserも作成日時を記録したい。でも継承関係はない…。そんなとき、Moo::Roleを使えば継承なしで同じ機能を複数のクラスに追加できます。ロールによる振る舞いの共有を学びましょう。

nqou.net

メソッドの役割

メソッド	役割	引数	戻り値
`save($task)`	タスクを保存（新規追加または更新）	Taskオブジェクト	保存したTaskオブジェクト
`find($id)`	IDでタスクを取得	タスクID	Taskオブジェクトまたはundef
`all()`	全タスクを取得	なし	Taskオブジェクトのリスト
`remove($id)`	タスクを削除	タスクID	削除成功時は真

save メソッドは「upsert」のセマンティクスを持ちます。IDが未設定または存在しないIDの場合は新規追加、既存IDの場合は更新を行います。

TaskRepository::Fileの実装

クラスの定義

JSONファイルで永続化するRepositoryクラスを実装します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
package TaskRepository::File {
    use Moo;
    use JSON;

    with 'TaskRepository::Role';

    has filepath => (
        is      => 'ro',
        default => sub { 'tasks.json' },
    );

    # ... メソッドの実装
}

with 'TaskRepository::Role' でRoleを適用
filepath でファイルパスを設定可能に

内部メソッド: _load と _save_all

ファイル操作を内部メソッドとして実装します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
sub _load {
    my $self = shift;
    my @tasks;

    return @tasks unless -e $self->filepath;

    open my $fh, '<:encoding(UTF-8)', $self->filepath or die $!;
    my $json = do { local $/; <$fh> };
    close $fh;

    my $data = decode_json($json);

    for my $item (@$data) {
        push @tasks, Task->new(
            id      => $item->{id},
            title   => $item->{title},
            is_done => $item->{is_done} ? 1 : 0,
        );
    }

    return @tasks;
}

sub _save_all {
    my ($self, @tasks) = @_;

    my @data = map {
        {
            id      => $_->id,
            title   => $_->title,
            is_done => $_->is_done ? \1 : \0,
        }
    } @tasks;

    open my $fh, '>:encoding(UTF-8)', $self->filepath or die $!;
    print $fh encode_json(\@data);
    close $fh;
}

アンダースコア _ で始まるメソッド名は「内部用」を意味する慣習です。外部から直接呼ばれることを想定していません。

saveメソッド

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
sub save {
    my ($self, $task) = @_;
    my @tasks = $self->_load;

    if ($task->id && $task->id > 0) {
        # 既存タスクの更新
        my $found = 0;
        for my $t (@tasks) {
            if ($t->id == $task->id) {
                $t->is_done($task->is_done);
                $found = 1;
                last;
            }
        }
        push @tasks, $task unless $found;
    }
    else {
        # 新規タスクの追加
        my $max_id = 0;
        for my $t (@tasks) {
            $max_id = $t->id if $t->id > $max_id;
        }
        $task->id($max_id + 1);
        push @tasks, $task;
    }

    $self->_save_all(@tasks);
    return $task;
}

IDが設定されていれば更新、されていなければ新規追加として扱います。

find / all / removeメソッド

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
sub find {
    my ($self, $id) = @_;
    my @tasks = $self->_load;

    for my $task (@tasks) {
        return $task if $task->id == $id;
    }
    return;
}

sub all {
    my $self = shift;
    return $self->_load;
}

sub remove {
    my ($self, $id) = @_;
    my @tasks = $self->_load;
    my $original_count = @tasks;

    @tasks = grep { $_->id != $id } @tasks;

    if (@tasks < $original_count) {
        $self->_save_all(@tasks);
        return 1;
    }
    return 0;
}

find : 一致するIDのタスクを返す（なければundef）
all : 全タスクのリストを返す
remove : 指定IDのタスクを削除し、成功したら真を返す

メイン処理をRepositoryで書き換える

Repositoryを使った実装

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
my $repository = TaskRepository::File->new(filepath => 'tasks.json');
my $command = shift @ARGV // 'help';

if ($command eq 'add') {
    my $title = shift @ARGV;
    die "Usage: $0 add <task>\n" unless defined $title && $title ne '';

    my $task = Task->new(title => $title);
    $repository->save($task);

    print "Added: $title (ID: " . $task->id . ")\n";
}
elsif ($command eq 'list') {
    my @tasks = $repository->all;

    if (@tasks == 0) {
        print "No tasks.\n";
        exit;
    }

    for my $task (@tasks) {
        my $status = $task->is_done ? '[x]' : '[ ]';
        printf "%d. %s %s\n", $task->id, $status, $task->title;
    }
}
elsif ($command eq 'complete') {
    my $id = shift @ARGV;
    die "Usage: $0 complete <id>\n" unless defined $id && $id =~ /^\d+$/;

    my $task = $repository->find($id);
    die "Task $id not found.\n" unless $task;

    $task->mark_done();
    $repository->save($task);

    print "Completed: " . $task->title . "\n";
}

load_tasks と save_tasks の呼び出しが、$repository->all や $repository->save に置き換わりました。

完成コード

todo.pl の全容

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
#!/usr/bin/env perl
use strict;
use warnings;
use utf8;
use JSON;

# === Taskクラスの定義 ===
package Task {
    use Moo;

    has id => (
        is       => 'rw',
        default  => sub { 0 },
    );

    has title => (
        is       => 'ro',
        required => 1,
    );

    has is_done => (
        is      => 'rw',
        default => sub { 0 },
    );

    sub mark_done {
        my $self = shift;
        $self->is_done(1);
    }
}

# === TaskRepository::Role ===
package TaskRepository::Role {
    use Moo::Role;

    requires 'save';
    requires 'find';
    requires 'all';
    requires 'remove';
}

# === TaskRepository::File ===
package TaskRepository::File {
    use Moo;
    use JSON;

    with 'TaskRepository::Role';

    has filepath => (
        is      => 'ro',
        default => sub { 'tasks.json' },
    );

    sub _load {
        my $self = shift;
        my @tasks;

        return @tasks unless -e $self->filepath;

        open my $fh, '<:encoding(UTF-8)', $self->filepath or die $!;
        my $json = do { local $/; <$fh> };
        close $fh;

        my $data = decode_json($json);

        for my $item (@$data) {
            push @tasks, Task->new(
                id      => $item->{id},
                title   => $item->{title},
                is_done => $item->{is_done} ? 1 : 0,
            );
        }

        return @tasks;
    }

    sub _save_all {
        my ($self, @tasks) = @_;

        my @data = map {
            {
                id      => $_->id,
                title   => $_->title,
                is_done => $_->is_done ? \1 : \0,
            }
        } @tasks;

        open my $fh, '>:encoding(UTF-8)', $self->filepath or die $!;
        print $fh encode_json(\@data);
        close $fh;
    }

    sub save {
        my ($self, $task) = @_;
        my @tasks = $self->_load;

        if ($task->id && $task->id > 0) {
            my $found = 0;
            for my $t (@tasks) {
                if ($t->id == $task->id) {
                    $t->is_done($task->is_done);
                    $found = 1;
                    last;
                }
            }
            push @tasks, $task unless $found;
        }
        else {
            my $max_id = 0;
            for my $t (@tasks) {
                $max_id = $t->id if $t->id > $max_id;
            }
            $task->id($max_id + 1);
            push @tasks, $task;
        }

        $self->_save_all(@tasks);
        return $task;
    }

    sub find {
        my ($self, $id) = @_;
        my @tasks = $self->_load;

        for my $task (@tasks) {
            return $task if $task->id == $id;
        }
        return;
    }

    sub all {
        my $self = shift;
        return $self->_load;
    }

    sub remove {
        my ($self, $id) = @_;
        my @tasks = $self->_load;
        my $original_count = @tasks;

        @tasks = grep { $_->id != $id } @tasks;

        if (@tasks < $original_count) {
            $self->_save_all(@tasks);
            return 1;
        }
        return 0;
    }
}

# === メイン処理 ===
package main;

my $repository = TaskRepository::File->new(filepath => 'tasks.json');
my $command = shift @ARGV // 'help';

if ($command eq 'add') {
    my $title = shift @ARGV;
    die "Usage: $0 add <task>\n" unless defined $title && $title ne '';

    my $task = Task->new(title => $title);
    $repository->save($task);

    print "Added: $title (ID: " . $task->id . ")\n";
}
elsif ($command eq 'list') {
    my @tasks = $repository->all;

    if (@tasks == 0) {
        print "No tasks.\n";
        exit;
    }

    for my $task (@tasks) {
        my $status = $task->is_done ? '[x]' : '[ ]';
        printf "%d. %s %s\n", $task->id, $status, $task->title;
    }
}
elsif ($command eq 'complete') {
    my $id = shift @ARGV;
    die "Usage: $0 complete <id>\n" unless defined $id && $id =~ /^\d+$/;

    my $task = $repository->find($id);
    die "Task $id not found.\n" unless $task;

    $task->mark_done();
    $repository->save($task);

    print "Completed: " . $task->title . "\n";
}
else {
    print "Usage: $0 <command> [args]\n";
    print "Commands:\n";
    print "  add <task>      - Add a new task\n";
    print "  list            - List all tasks\n";
    print "  complete <id>   - Complete a task by ID\n";
}

動作確認

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
$ perl todo.pl add "牛乳を買う"
Added: 牛乳を買う (ID: 1)

$ perl todo.pl add "メールを返信する"
Added: メールを返信する (ID: 2)

$ perl todo.pl list
1. [ ] 牛乳を買う
2. [ ] メールを返信する

$ perl todo.pl complete 1
Completed: 牛乳を買う

$ perl todo.pl list
1. [x] 牛乳を買う
2. [ ] メールを返信する

動作は変わりませんが、コードの構造が大きく改善されました。

Repositoryパターンで何が良くなったか

永続化処理が1箇所にまとまった

ファイル操作のコードは TaskRepository::File の中だけにあります。

ファイル形式を変更したい場合、このクラスだけを修正すればよい
バグがあった場合、調査範囲が限定される

メイン処理がシンプルになった

メイン処理は「何をするか」に集中できるようになりました。

1
2
3
4
5
6
7
8
9
# Before
my @tasks = load_tasks($file);
# ... 処理 ...
save_tasks($file, @tasks);

# After
my @tasks = $repository->all;
# ... 処理 ...
$repository->save($task);

保存先の変更が容易になった

別の保存先（SQLite、APIなど）に切り替えたい場合、同じインターフェースを持つ新しいRepositoryクラスを作るだけです。

1
2
3
4
5
# ファイル保存
my $repository = TaskRepository::File->new(filepath => 'tasks.json');

# 将来: SQLite保存
my $repository = TaskRepository::SQLite->new(dbfile => 'tasks.db');

メイン処理は変更不要！これがインターフェース（Role）の力です。

次回予告 - InMemoryRepositoryでテスト容易に

今回作成した TaskRepository::File は実際にファイルを読み書きします。これはテストの際に問題になります。

テストごとにファイルが作成される
テスト後のクリーンアップが必要
CI環境でのパス問題

次回は、ファイルI/Oなしでテストできる InMemoryRepository を実装します。同じインターフェースで異なる実装を持つ、Repositoryパターンの真価を体感しましょう。

まとめ

今回は、Repositoryパターンで永続化処理を分離しました。

TaskRepository::Role でインターフェースを定義
TaskRepository::File でJSON永続化を実装
メイン処理がシンプルになった
保存先の変更が容易になった

「Mooで覚えるオブジェクト指向プログラミング」で学んだRoleの知識が、実践的なデザインパターンに活きてきましたね。

次回は、InMemoryRepositoryを実装してテスト容易性を高めます。お楽しみに！