【実務・中級編】【上級】Gitによるステンシル管理:VBAでコミット・プッシュを自動化する – Visio VBA解析バイブル

スポンサーリンク
スポンサーリンク

【極限の知見】Visio VBAをGitで掌握する:ステンシル管理の自動化と堅牢なアーキテクチャ設計

チーム開発において、Visioのステンシル(`.vssx`)は「設計の共通言語」だ。しかし、多くの現場ではこの「言語」が、場当たり的なファイル共有やネットワークドライブの同期ミスによって、音を立てて崩壊していく。

「誰かがステンシルを更新した。しかし、私の手元にあるのは古いバージョンだ」
「マスターシェイプを修正したつもりが、上書きされて消えていた」

このような悲劇は、単なる不注意ではない。「バイナリに近い複雑な構造を持つステンシルを、バージョン管理の思想(Version Control System)から切り離して運用している」という設計上の欠陥に起因する。

本稿では、Visio VBAを単なる「図形操作の道具」としてではなく、「Gitリポジトリを制御するオーケストレーター」として昇華させる、プロフェッショナルな自動化手法を伝授する。

1. なぜ「単なるファイル保存」では足りないのか

多くの開発担当者は、VBAで「ファイルを保存して、手動でGitにコミットする」というフローを想定する。だが、これは極めて脆弱な設計だ。

致命的な設計ミス:ファイルロックの無視

Visioはステンシルを開いている間、そのファイルに対して強力なファイルロックをかける。VBAからGitコマンドを叩こうとしても、Visioがファイルを掴んでいる限り、Gitは「Permission Denied」を吐いて沈黙する。

解決策:状態管理(State Management)の導入

堅牢なツールを作るなら、以下のライフサイクルをVBA側で厳格に管理しなければならない。
1. Stencil Lock Check: 現在のステンシルが編集モードか、あるいは開かれているかを確認。
2. Graceful Close: 変更を保存し、Visioのドキュメントコレクションから安全にアンロードする。
3. Git Execution: 外部プロセスとしてのGitを、同期的に実行する。
4. Re-open / Refresh: Git操作後、最新の状態をVisioへ再ロードする。

2. アーキテクチャ設計:Orchestrator Pattern

VBAの中に直接 `Shell` 関数を書き込むような真似はしないでほしい。それは保守性を放棄した、いわゆる「スパゲッティ・コード」への第一歩だ。

我々が構築すべきは、以下の3層構造である。

1. Git Executor Layer: `WScript.Shell` を用いてGit CLIを呼び出し、実行結果(Exit Code)を解析する低レイヤー。
2. Stencil Manager Layer: Visioの `Document` オブジェクトのライフサイクル(開く・閉じる・保存)を制御する中間レイヤー。
3. Business Logic Layer: 「コミットしてプッシュする」というユーザーの意図を、上記2層に命令として伝える高レイヤー。

3. プロダクション・コードの実装例

以下に、そのまま実務に投入可能なレベルの、クラスモジュールを意識した設計思想に基づくコードを示す。

A. GitExecutor クラス (概念的な実装)

まずは、Gitコマンドを「確実に」実行するためのエンジンだ。`Shell` 関数ではなく、戻り値を捕捉できる `WScript.Shell` を使用するのが鉄則である。

' --- Class Module: GitExecutor ---
Option Explicit

Private m_shell As Object

Private Sub Class_Initialize()
    Set m_shell = CreateObject("WScript.Shell")
End Sub

''' <summary>
''' Gitコマンドを実行し、実行結果を返す。
''' </summary>
''' <param name="command">実行するGitコマンド (例: "git commit -m ""update""")</param>
''' <returns>0なら成功、それ以外はエラーコード</returns>
Public Function Execute(ByVal command As String) As Long
    Dim exitCode As Long
    Dim fullCommand As String
    
    ' 実行ディレクトリをカレントに設定するか、フルパスで指定するのがプロの作法
    ' ここではコマンドの実行結果を待機する「同期実行」を行う
    On Error GoTo ErrHandler
    
    ' 0: Windowなし, True: 終了まで待機
    exitCode = m_shell.Run(command, 0, True)
    
    Execute = exitCode
    Exit Function

ErrHandler:
    Execute = -1 ' システムエラー
End Function

B. StencilGitController (メインロジック)

ここが心臓部だ。ファイルロックを回避しながら、安全にGit操作を完遂させる。

' --- Standard Module: StencilGitController ---
Option Explicit

''' <summary>
''' ステンシルをGitにコミットし、リモートへプッシュする。
''' </summary>
''' <param name="stencilPath">対象となるステンシルのフルパス</param>
''' <param name="commitMessage">コミットメッセージ</param>
Public Sub SyncStencilWithGit(ByVal stencilPath As String, ByVal commitMessage As String)
    Dim gitExec As New GitExecutor
    Dim doc As Visio.Document
    Dim folderPath As String
    Dim result As Long
    Dim targetFile As String
    
    targetFile = Dir(stencilPath)
    If targetFile = "" Then
        MsgBox "指定されたファイルが見つかりません。", vbCritical
        Exit Sub
    End If
    
    folderPath = Left(stencilPath, InStrRev(stencilPath, "\"))
    
    ' 1. ステップ:ファイルロックの解除
    ' 現在開いているドキュメントの中から、対象のステンシルを探す
    On Error Resume Next
    Set doc = Visio.Documents(targetFile)
    On Error GoTo 0
    
    If Not doc Is Nothing Then
        Debug.Print "File is open. Saving and closing..."
        doc.Save
        doc.Close
        ' 完全に解放されるまで僅かな待機を入れるのが、OSレベルの不安定さを回避するコツ
        DoEvents
    End If
    
    ' 2. ステップ:Git Add & Commit
    ' コマンドの組み立て(ダブルクォーテーションのエスケープに注意)
    Debug.Print "Committing changes..."
    result = gitExec.Execute("cd /d """ & folderPath & """ && git add """ & targetFile & """")
    If result <> 0 Then GoTo ErrorExit
    
    result = gitExec.Execute("cd /d """ & folderPath & """ && git commit -m """ & commitMessage & """")
    If result <> 0 Then GoTo ErrorExit
    
    ' 3. ステップ:Git Push
    Debug.Print "Pushing to remote..."
    result = gitExec.Execute("cd /d """ & folderPath & """ && git push")
    If result <> 0 Then GoTo ErrorExit
    
    MsgBox "同期が完了しました。", vbInformation
    
    ' 4. ステップ:ステンシルの再ロード
    ' ユーザーの作業を中断させないよう、再度開く
    Visio.Documents.Open stencilPath
    Exit Sub

ErrorExit:
    MsgBox "Git操作中にエラーが発生しました。Exit Code: " & result & vbCrLf & _
           "Gitのログを確認してください。", vbCritical
    ' 失敗した場合は、ファイルを再度開いて作業を継続させる
    If Not doc Is Nothing Then Visio.Documents.Open stencilPath
End Sub

4. 現場で差がつく「堅牢性」への極意

コードを書いただけで満足してはいけない。伝説のアーキテクトは、以下の3点にまで神経を尖らせる。

① コマンドラインのエスケープ

`commitMessage` にダブルクォーテーションが含まれていたら、Gitコマンドは即座に崩壊する。実務レベルでは、メッセージ内の `”` を `””` に置換するバリデーションロジックを必ず組み込め。

② 冪等性(Idempotency)の確保

「既にコミットされている場合に、再度コミットしようとしてエラーにならないか?」を考慮せよ。Gitの仕様上、変更がないコミットはエラーを返す。これを「失敗」とみなすか、「正常な状態」とみなすか、設計思想を明確にする必要がある。

③ ログの外部出力

VBAの `Debug.Print` は開発者には見えるが、エンドユーザーには見えない。Gitの実行結果(`stderr`)をテキストファイルにダンプする仕組みを `GitExecutor` に持たせることができれば、トラブルシューティングの速度は劇的に向上する。

結びに代えて

Visio VBAによる自動化の真価は、単なる「作業の短縮」ではない。「人間がミスを犯す余地を、システム設計によって物理的に排除すること」にある。

Gitという強力な武器を、VBAというインターフェースを通じて制御下に置く。この設計思想を手にした時、君の作るツールは単なる「便利ツール」から、チームのインフラへと進化するだろう。

タイトルとURLをコピーしました