InterSystems IRIS とソース・コントロール・システムの統合

ドキュメントとファイルを管理するツール

InterSystems IRIS には、ドキュメントと外部ファイルを管理するために、以下のツールが用意されています。

• %Studio.Extension.BaseOpens in a new tab クラスは、基本的なドキュメント管理のためのメソッドを提供します。%Studio.SourceControl.BaseOpens in a new tab は、%Studio.Extension.BaseOpens in a new tab のサブクラスで、ソース・コントロール・メニューも提供します。“ソース・コントロール・クラスの作成と有効化” を参照してください。

• $system.OBJ.Export 関数は、InterSystems IRIS ドキュメントを外部のドキュメント・システムにある XML ファイルにエクスポートします。この XML ファイルには、ドキュメントの再構築に十分な情報が含まれています。

• $system.OBJ.Load 関数は、外部 XML ファイルをロードし、対応する InterSystems IRIS ドキュメントが存在する場合はそれを上書きします。

• %RoutineMgr.TS クラス・メソッドは、InterSystems IRIS ドキュメントのタイムスタンプとコンパイル日時を返します。

内部名と外部名をマップする方法の指定

各ドキュメントには 2 つの名前があります。

• 内部名。例えば、スタジオの [開く] ダイアログ・ボックスで使用する名前です。

• 外部名。ファイル・システム内でのファイルの完全修飾パス。サポートされる InterSystems IRIS プラットフォーム間でファイル・パスの構成方法が異なるため、有効な既定値を提供することができません。

内部名と外部名との間に双方向のマッピングを作成することは、ソース・コントロール・システムを実装するうえで最も難しい部分であると言えます。このマッピングはユーザ固有のものであり、注意深く考慮する必要があります。類似する項目をグループ化できます。例えば、サンプルでは以下のディレクトリ構造が使用されます。

• クラス・ファイルは、クラスのパッケージ階層に対応するサブディレクトリを含む cls サブディレクトリ内にあります。

• .INT ルーチンは int サブディレクトリ内にあります。

• .MAC ルーチンは mac サブディレクトリ内にあります。

例を以下に示します。

• 内部名 — MyApp.Addresses.HomeAddress

• 外部名 — C:\sources\cls\MyApp\Addresses\HomeAddress.xml

多数のルーチンがある場合は、機能別などで、ルーチンをサブディレクトリにグループ化できます。

スタジオの拡張

%Studio.Extension.BaseOpens in a new tab または %Studio.SourceControl.BaseOpens in a new tab を使用して、ソース・コード・コントロール・メニューをスタジオに追加できます。最大で 2 つのメニューと、そのそれぞれに 19 個のメニュー項目を追加できます。

%Studio.Extension.BaseOpens in a new tab クラスでは、以下のメソッドが提供されます。これらのメソッドではすべて InterSystems IRIS ドキュメントの内部名が使用されます。

• 空の Login メソッドと Logout メソッド。必要に応じて実装できます。変数 $username によって、現在のユーザが記録されます (Login メソッドでは、Username 引数が下位互換性のために提供されているので、代わりに、変数 $username の使用をお勧めします)。

• 指定した InterSystems IRIS ドキュメントの状態を示す基本的なメソッド ： GetStatus および IsInSourceControl。必要に応じて、これらのメソッドを実装します。

• コールバック・メソッド。ユーザが InterSystems IRIS ドキュメントでアクションを実行するときに実行されます。これには、OnBeforeLoad、OnAfterLoad、OnBeforeCompile、OnAfterCompile、ItemIconState のメソッドが含まれます。

%Studio.SourceControl.BaseOpens in a new tab は %Studio.Extension.BaseOpens in a new tab のサブクラスで、以下の追加要素を提供します。

• Menu という名前の XDATA ブロック。InterSystems IRIS の追加メニュー [ソースコントロール] を定義します。既定では、このメニューには、メニュー項目 [チェックイン]、[チェックアウト]、[チェックアウト取消]、[最新を取得]、および [ソース・コントロールに追加] が含まれています。また、この XDATA ブロックは、スタジオのコンテキスト・メニューの追加メニュー項目も定義します。

  これらすべてのメニュー項目は、このクラスで定義されているメソッドも呼び出します。

• CheckIn、CheckOut、UndoCheckOut、GetLatest、および AddToSourceControl という名前のメソッドは、既定では何も実行しません。

InterSystems IRIS を拡張するには、これらのクラスのいずれかを拡張する新しいクラスを定義します。“ソース・コントロール・クラスの有効化” で説明するように、管理ポータルには、指定したネームスペースで現在アクティブな拡張クラスを示す方法が用意されています。指定したネームスペースで拡張クラスがアクティブな場合、およびそのクラスが XDATA メニュー・ブロックを定義する場合は、これらのメニュー項目が InterSystems IRIS に追加されます。

ソース・コントロール・クラスの作成

ソース・コントロール・クラスを作成するには、以下を実行します。

1. %Studio.Extension.BaseOpens in a new tab または %Studio.SourceControl.BaseOpens in a new tab のサブクラスを作成します。

2. %Studio.Extension.BaseOpens in a new tab から開始する場合、サブクラスで Menu という名前の XDATA ブロックを作成します(これを開始するには、%Studio.SourceControl.BaseOpens in a new tab からコピーして貼り付けます)。

3. 必要に応じて、このクラスにメソッド AddToSourceControl、CheckIn、CheckOut などを実装します。これらのメソッドは、通常、少なくとも以下を実行します。

   • 必要に応じて、InterSystems IRIS ドキュメントを XML からインポート、または XML にエクスポートします。

   • XML ファイルで機能するように、ソース・コントロール・ソフトウェアの適切な関数またはメソッドを呼び出します。

   • 指定したファイルの状態について InterSystems IRIS の内部情報を更新します。

   • InterSystems IRIS ドキュメントが編集可能であるかどうかを制御します。

   詳細は、ソース・コントロール・システムにより異なります。

4. ソース・コントロール・クラスの GetStatus メソッドを実装します。これは必須です。既定の実装が適切でない場合は、IsInSourceControl メソッドの実装も必要な場合があります。

ソース・コントロール・クラスの有効化

指定したネームスペースに対してソース・コントロール・クラスを有効にするには、以下を実行します。

1. 拡張クラスが存在する場合、管理ポータルを使用して、指定したネームスペースで InterSystems IRIS が使用する拡張クラスを指定します。使用するクラスを指定するには、以下の操作を実行します。

   1. [システム管理]→[構成]→[追加設定]→[ソースコントロール] を選択します。

   2. ページの左側で、この設定に適用するネームスペースを選択します。

   3. 使用する拡張クラスの名前を選択して、[OK] を選択します。

      このリストには、選択されたネームスペースにある、%Studio.Extension.BaseOpens in a new tab のコンパイル済みサブクラスがすべて含まれます。

2. スタジオが現在開いている場合は、いったん閉じてから再び開きます。または、別のネームスペースに切り替えてから元に切り替え直します。

管理ポータルの [プロダクション構成] ページでも、ソース・コントロールがサポートされます。"プロダクションの構成" の “ソース・コントロール設定の構成” を参照してください。

例 1

以下のフラグメントでは、VSS の API 用のラッパ・メソッドを生成しました。次に、ソース・コントロール・メソッド内に以下のようなコードを含めることができます。

 do ..VSSFile.CheckIn(..VSSFile.LocalSpec,Description)

詳細は、ソース・コントロール・ソフトウェア、その API、および要件によって異なります。

例 2

以下のフラグメントでは、Windows コマンド行インタフェースを使用してファイルをチェック・アウトしています。この例では、ソース・コントロール・システムは Perforce です。

/// Check this routine/class out of source control.
Method CheckOut(IntName As %String, Description As %String) As %Status
{
  Set file=..ExternalName(IntName)
  If file="" Quit $$$OK
  //...
 Set cmd="p4 edit """_file_""""


  #; execute the actual command
  Set sc=..RunCmd(cmd)
  If $$$ISERR(sc) Quit sc

  #; If the file still does not exist or
  #; if it is not writable then checkout failed
  If '##class(%File).Exists(file)||(##class(%File).ReadOnly(file)) {
    Quit $$$ERROR($$$GeneralError,
                  "Failure: '"_IntName_"' not writeable in file sys")
  }

  #; make sure we have latest version
  Set sc=..OnBeforeLoad(IntName)
  If $$$ISERR(sc) Quit sc

  //...
  Quit sc
}

この例では、RunCmd は、指定したコマンドを実行して一部の汎用エラーのチェックを行う別のメソッドです (RunCmd は、$ZF(-1) インタフェースから OS コマンドを発行します)。

また、この CheckOut メソッドは、InterSystems IRIS ドキュメントと外部 XML ドキュメントを同期させる OnBeforeLoad メソッドを呼び出します。