Últimas Arquivo Comunicados

mail2weblog (1.3.9)2013-08-09 13:18

トピックス (Topics)

最近の更新 (Recent Changes)

2015-05-21
2015-05-13
2015-03-05
2014-10-03
2013-08-22

開発情報

スタートアップ

本ページでは開発を開始するにあたっての手順を簡単に紹介します。

1. Ruby 動作環境の準備

まず最初に Ruby の動作環境を用意してください。

Windows 環境ならば以下のリンクを辿ってインストーラーを入手すると簡単に環境が手に入ります。

UNIX/Linux 環境の場合は、それぞれのパッケージマネージャを使うのが楽でしょう。

もちろん、ソースコードからビルド/インストールする方法も選べます。

インストール後、コマンドラインで以下のコマンドを実行してインストールが成功していることを確認してください。

ruby --version

うまくいかない場合、パスの設定を忘れていることがあるので、パスの設定を確認してみてください。


2. ソースコードをリポジトリから取得する

以下のページを参考にソースコードをリポジトリから取得してください。

本プロジェクトは、ソースコード管理に Subversion を採用しています。

  • 本プロジェクトの trunk(メインブランチ)からソースコードをダウンロードしてください。
    • trunk の中には以下の3つのフォルダが入っています。
      • main - mail2weblog 本体一式
      • test - mail2weblog のテストコード一式
      • tools - 開発時に作成したツール群(現状はメールの受信/送信やブログへのアクセスを試行錯誤するためのサンドボックスと思ってもらった方が良い)

Subversion を知っている人は以上の説明でわかると思うので次に進んでください。以下は Subversion を初めて利用する方向けの説明です。

Windows 環境ならば以下の2つのクライアントを必要に応じて使い分けると便利です。

  • TortoiseSVN
    • Subversion リポジトリアクセス用の GUI クライアントです。
    • Windows のエクスプローラから右クリックでリポジトリへのアクセスが可能になります。
  • Subversion
    • Subversion リポジトリアクセス用の CUI クライアントです。
    • バッチファイルやシェルスクリプトなどから呼び出して定常処理を実現することが可能になります。

とりあえずは GUI クライアントをインストールして、ソースコードをダウンロードすることを推奨します。

CUI の存在は心の中に留めて置いてください。

UNIX/Linux でも相応の Subversion クライアントを利用してソースコードをダウンロードしてください。 UNIX/Linux ユーザへの説明は不要と判断します。


3. テストコードを実行する

ソースのダウンロードが成功したら勇気を持って、おもむろに以下のコマンドを実行してください。

rake test

初期状態ではローカルで実行可能なテスト(いわゆる単体テスト?)が動き、以下のような表示が出るはずです。

Succeeded... C:/Home/Extraction/m2w/test/basic/test_deep_extension.rb
Succeeded... C:/Home/Extraction/m2w/test/blogger/test_blogger.rb
以下続く…

不運にもテストに失敗した場合、Failed という表示が出ます。

テスト結果の詳細は同フォルダにできた stdout.log と stderr.log を見るとわかります。

また、main/logs フォルダにできた m2w.log を見ると動作状況がわかります。


4. さらに…

以下のフォルダ群にある設定ファイルを書き換えることでより高度なテスト(いわゆる結合テスト?総合テスト?)も動きます。

  • main/conf/02_user フォルダ
  • test フォルダ配下の任意の conf フォルダ

高度なテストでは以下のようなテストが行われます。

  • メールモジュールによるメール送受信テスト
  • 実際のブログへの投稿テスト

これを実行するには、テストに利用するメールサーバやブログが必要になります。


5. ソースコードを触ろう!

4 は置いておいたとしても、とりあえずソースコードを触ったらテストを実行してください。

新しいコードを追加したら、テストコードも追加してみてください。 (※ テストコードはできる限り作りますが、少人数開発なのでバランスが重要です。 カバレージ100%を目指すわけではありません。難しいですがその感覚を醸成するのもまた楽しみましょう。)

テストコードはファイル名に test_ と付ければ勝手に実行されるようになります。

テストコード単体でのテスト実行も可能です。例えば以下のように

cd test/basic
ruby test_deep_extension.rb

ここまで理解できたら mail2weblog の開発作業をエンジョイしましょう!!!