こんにちは。てくぽこです。

以前の記事にて,
UMLダイアグラムをテキストから自動で作成してくれる「PlantUML」と、手軽に実行できる環境としてWebサービスのPlantTextをご紹介しました。

これはデモンストレーション用としては大変手軽なのですが、
一方では【Reflesh】を実行しない限りテキスト変更が反映されないので、初心者のうちは
「文法誤りに気づく→訂正する」
というPDCAを回しにくい部分もあると思います。

~~正直こんなところで文法覚える手間なんかあまりかけたくない~~

というわけで、ここから２回の記事に分けて、
「PlantUMLテキストを編集しながらリアルタイムでプレビューしてくれる」
ローカル環境の導入についてご紹介できればと思います。

完成形

こんな風に、打ったそばから作図されていきます。気持ちいい。
次の例では更に管理者を追加しています。
テキストベースなのでコピペも利くし、変更に対して既存シンボルの配置を自動で修正してくれるのが大きい。
UML図を描くためにいちいちシンボルの配置を気にする必要がなく、純粋にオブジェクト構成と論理構造に集中できます。

文法誤りがあればすぐエラー出してくれるし、文法さえ合っていればすぐ図を出力してくれるので、
PlantUMLに習熟しやすい環境と言えるでしょう。

導入の流れ

Homebrewをインストール：本記事
Graphvizをインストール：本記事
PyCharmをインストール：次回の記事
PyCharm内でパッケージをインストール：次回の記事

ローカル実行環境にはPyCharmを用います。
他にもAtom実行環境なども試してみましたが、2019.09.19時点ではうまく動作しませんでした¹。

実行環境

macOS Mojave ver.10.14.6（18G95）
Homebrew 2.1.11
Graphviz 2.40.1 (20161225.0304)
PyCharm 2019.2.2 (Community Edition)

Homebrewをインストール

公式サイトはこちらです。
macOS 用パッケージマネージャー — Homebrew
まず、上記サイトにアクセスし、下記画像内の赤線で示したスクリプトをコピーします。

ターミナルを開き、コピーしたコマンドを実行することで、Homebrewのインストールを開始します。

詳細手順はこちらの記事を参考にさせていただきました。
macOSにHomebrewをインストール - Qiita

確認

インストール完了後は、ターミナルにbrew -vと入力し、インストールしたHomebrewのバージョンを確認します。

$ brew -v
Homebrew 2.1.11

Graphvizをインストール

公式サイトはこちらです。
Graphviz - Graph Visualization Software

Homebrewをインストールした後、ターミナルで以下のコマンドを入力します。

$ brew install graphviz

詳細手順は下記のサイトを参考にさせていただきました。
テキストデータをグラフ画像に変換するツール「Graphviz」ことはじめ｜ DevelopersIO

確認

$ dot -V
dot - graphviz version 2.40.1 (20161225.0304)

graphvizはDOT言語というものを使用してグラフを描画するソフトです。
ターミナルにそのままdot -Vと入力するとgraphvizのバージョンが表示されます。
今回はあくまでPlantUMLでのUML図作成を目的としていますので、
DOT言語についてはここでは触れません。

次回に続く

今回はPyCharmでPlantUMLのリアルタイムプレビュー環境を導入するため、
まずHomebrewとgraphvizのインストールについて紹介しました。
インストール手順の説明は初心者にはなかなかハードル高いです。。。
参考サイト様ありがとうございます…。

次回はPyCharm本体のインストールと、PlantUMLに関連するPyCharmパッケージ類の導入です。

参考サイト

PyCharmでPlantUMLを使用する方法 - 知的好奇心
macOSにHomebrewをインストール - Qiita
テキストデータをグラフ画像に変換するツール「Graphviz」ことはじめ｜ DevelopersIO

Atom用PlantUMLプラグインの開発が停止している模様。Atom側のアップデートに追いついていなかった。 ↩