XOOPXモジュール作成覚書

2005-06-15T13:25:53+09:00

* XOOPSモジュール作成覚書参考文献： XOOPSコミュニティサイト構築ガイド高井守＋インフォリグ　著　小野和巳　監修技術評論社 6 XOOPSの周辺技術 6.1 smarty 6.3 外部モジュール 7 外部モジュールの作成参考サイト：

cosUMLTool4

2005-05-27T18:31:19+09:00

* 閃いた事　エンドユーザ向けドキュメントの自動生成私はクラス図を二つ作らなければいけない立場なのです。それは、開発者向けとエンドユーザ向けです。同じ物でもと思いますが、プロパティ等日本語ではないことで、エンドユーザ向けのドキュメントとなりません。そこで、cacheが生成するxmlファイルのDescription（///で始まるコメント）をプロパティ名にすることによって、日本語のドキュメントが生成することにしました。 /// プロパティを持ったクラス。だが、まだメッソドは持っていない。 Class Simple.withProperty Extends %RegisteredObject [ ProcedureBlock ] { /// 名前 Property name As %String; } 上のソースから下のjavaソースを生成するということです。 class withProperty{ public String 名前; } 残念ながらクラス名の自動化は諦めました。JUDEに取り込んだときに機能する関連が途切れてしまうためです。しかたがないので、JUDEで取り込んでから、本来の使い方ではありませんが、ステレオタイプに入力することにしました。これで、手でクラス図を作成するという作業は大分軽減されると思います。シェルスクリプト conv2java4u.sh #!/bin/sh if [ $# -ne 1 ] then echo "ファイル名がありません。" echo "使用法：conv2java4u.sh ファイル名(.xmlは省略してください。)" exit fi nkf -s $1".xml" | sed -f preconv | awk -f cache2java4u > $1"4u.java" sedファイル preconvは変更ありません。 awkファイル cache2java4u /^

cosUMLTool3

2005-05-27T17:31:59+09:00

* 参考のスクリプトシェルスクリプト conv2java.sh #!/bin/sh if [ $# -ne 1 ] then echo "ファイル名がありません。" echo "使用法：conv2java.sh ファイル名(.xmlは省略してください。)" exit fi nkf -s $1".xml" | sed -f preconv | awk -f cache2java > $1".java" sedファイル preconv /^/ / s/<\/Type/ / s/<\/Description/ \/Description/ s/%String/String/ s/%Date/Date/ awkファイル cache2java /^cosUMLTool4]]があります。

cosUMLTool2

2005-05-27T15:50:08+09:00

* Cacheが生成したXMLファイル /// プロパティを持ったクラス。だが、まだメッソドは持っていない。 Class Simple.withProperty Extends %RegisteredObject [ ProcedureBlock ] { /// 名前を設定できるプロパティ。 Property name As %String; } 上のソースファイルをエクスポートした結果です。プロパティを持ったクラス。だが、まだメッソドは持っていない。 1 %RegisteredObject 60047,56009.8839 0 名前を設定できるプロパティ。 %String Javaのクラスに変換するには、 %String を元に以下の様なJavaソースを生成することにします。 class withPro

cosUMLTool

2005-05-27T15:38:28+09:00

* UML Toolを使いたい私は出来る限りドキュメントを自分で作成したくない！と常々思っています。それは、楽したいということが第一の理由ですが、手で書くことになると、プログラムが出来上がるまで、ドキュメントを書かなくなるからということも大きな理由の一つです。変更することが判っているのにその時点でのドキュメントを作成しようとは思わないのは私だけではないでしょう。出来ることであれば、Cacheでクラスを作成したのだから、それが、ドキュメントになってくれるならば願ったり叶ったりです。Cacheスタジオが生成してくれるクラスドキュメントもその一つですが、UMLのクラス図があればと思います。では、どの様にすればそれを自動的に生成できるでしょうか？ Cacheでは、Rose Linkという機能で、Roseとリンクできるようですが、バージョンが限定されているという問題と、Roseの価格が高いという問題があります。そこで、フリーで使用できるUML Tool 「JUDE Community」を検討してみることにします。でも、このツールには（そして多くのツールでの）、Java用であるという問題があります。しかし、この問題を解決すれば、多くのJava用のツールが使用できるということにもなります。 Java用のツールに対応させるには？私は、CacheのxmlエクスポートファイルをJavaソースファイルに変換できないか検討することにしました。とはいえ、Cacheの全てのシンタックスを網羅することは不可能でしょう。しかし、自分の作成している範囲ぐらいは可能かもしれません。では、簡単なクラスを作成しながら、可能性を探っていきます。ということで、私はCygwinでawkを使う方向で検討を始めました。余談ですが、私のCygwin環境は、デフォルトにvim,nkf,gcc,makeが追加されています。それでは、cacheが生成した[[xmlファイルを見ていきましょう>cosUMLTool2]]。

cosUnitTest7

2005-05-12T16:50:05+09:00

*UnitTest FirstUnitTestの問題点このテストは、直ぐに見つかる大きな問題点があります。それは、nameプロパティに、半角スペースが無かった場合のチェックが行われていないことです。 Humanクラスは正解かどうかは別としてそれらしきコードがあります。きちんとテストが記述れていれば、このコードはきちんとコーディングされていたものと考えられます。まだ、問題点はあります。スペースが複数あった場合。先頭がスペースだった場合。それらの記述が欠けている事が予想できます。こんな簡単な例ですが、テストすべき項目は意外と多い事に気がつきます。

cosUnitTest6

2005-04-28T17:48:30+09:00

*UnitTest メソッドのテストの追加 Humanクラスに名前を取得するgetFirstNameメソッドと苗字を取得するgetFamilyNameメソッドを追加します。前提としては、名前と苗字は、半角のスペースで区切られているとします。 Class Sample.Human Extends %RegisteredObject [ ProcedureBlock ] { Property height As %Integer; Property name As %String; Method getFamilyName() As %String { if (..name = "") { quit "" } else { set pos = $FIND(..name," ") if (pos = 0) { quit ..name } else { quit $EXTRACT(..name,pos,$LENGTH(..name)) } } } Method getFirstName() As %String { if (..name = "") { quit "" } else { set pos = $FIND(..name," ") if (pos = 0) { quit ..name } else { quit $EXTRACT(..name,1,pos-2) } } } } そのテスト仕様も変更して以下のようにしました。 Include %outUnitTest /// Unit Test for Human Class Class Sample.FirstUnitTest Extends %UnitTest.TestCase [ ProcedureBlock ] { Method TestGetFamilyName() { set p = ##class(Sample.Human).%New()

cosUnitTest5

2005-04-28T16:48:53+09:00

*UnitTest WEB上でのテスト結果の表示 http://127.0.0.1:1972/csp/samples/%UnitTest.Report.cls?NS=USER&INDEX=30 で、今の結果が表示されます。また、 http://127.0.0.1:1972/csp/samples/%UnitTest.Report.cls?NS=USER でUSERネームスペースで行われたテストの一覧が表示されます。この機能は非常に有効であると思われます。PMは、このページを確認することによってテストの状況を確認することが可能です。では、Cache Object ScriptでのUnitTestの概要が理解できたところで、もう一度、テスト内容を完全なものにしてみましょう。以下の様にテストを変更します。 Include %outUnitTest /// Unit Test for Human Class Class Sample.FirstUnitTest Extends %UnitTest.TestCase [ ProcedureBlock ] { Method TestConstructor() { set p = ##class(Sample.Human).%New() set p.name = "Taro Yamada" set p.height = 180 DO $$$AssertEquals(p.name,"Taro Yamada","My name is "_p.name) DO $$$AssertEquals(p.height,180,"My height is "_p.height) } } これで、Humanクラスのインスタンスを作成して、nameプロパティ、heightプロパティをセットしその値が正しくセットされているか確認しています。テストの結果は、 USER>do ##class(%UnitTest.Manager).RunTest ("Human:Sample.FirstUnitTest","/load=0/recursive=0/nodebug") =======================

cosUnitTest4

2005-04-28T15:20:26+09:00

*UnitTest エラーの無いクラスそれでは、エラーの無いクラスに変更してみましょう。簡単ですね。nameプロパティを追加すればエラーは無くなりますが、ここでは、Humanクラスの仕様書通りに、 name as %String height as %Integer を追加します。Humanクラスをコンパイルして、テストを実行します。 do ##class(%UnitTest.Manager).RunTest ("Human:Sample.FirstUnitTest","/load=0/recursive=0/nodebug") =============================================================================== Directory: c:\cache\unittests\human\ =============================================================================== Human begins ... Skipping loading testsuite Human Sample.FirstUnitTest begins ... TestConstructor() begins ... AssertEquals:Constructor Name (passed) LogMessage:Duration of execution: .001808 sec. TestConstructor passed Sample.FirstUnitTest passed Human passed Use the following URL to view the result: http://127.0.0.1:1972/csp/samples/%UnitTest.Report.cls?NS=USER&INDEX=30 USER> 今度は、テストがパスしました。ここで、WEB上で今までの[[テストの結果を確認する方法を説明します。>cosUnitTest5]]

cosUnitTest3

2005-04-28T15:05:51+09:00

*UnitTestの実行ターミナルを起動して、 DO ##class(%UnitTest.Manager).RunTest("Human:Sample.FirstUnitTest","/load=0/recursive=0/nodebug") と入力します。 USER>do ##class(%UnitTest.Manager).RunTest ("Human:Sample.FirstUnitTest","/load=0/recursive=0/nodebug") =============================================================================== Directory: c:\cache\unittests\human\ =============================================================================== Human begins ... Skipping loading testsuite Human Sample.FirstUnitTest begins ... TestConstructor() begins ... LogStateStatus:0:TestConstructor():エラー #5002: Cache エラー:zTestConstructor^Sample.FirstUnitTest.2 TestConstructor failed Sample.FirstUnitTest failed Human failed Use the following URL to view the result: http://127.0.0.1:1972/csp/samples/%UnitTest.Report.cls?NS=USER&INDEX=27 USER> 期待通り、クラスが無いというで失敗しています。では、次に、メンバーの無いHumanクラスを作成し同じテストを繰り返します。 USER>do ##

lazybones @Wiki