komagataのブログ

あるべき初期データの姿が不明。今動いてるDBが全て。という場合にmigrationをはじめるのが難しい。また、複合主キーを使ってる場合はそもそもmigration出来ない。なので無理矢理afterでdumpファイルを読み込んで対応。

<?php
class xxxxxxxxxxxxxxxxx extends CakeMigration
{
    public $description = '';

    public $migration = array(
        'up'   => array(),
        'down' => array(),
    );

    public function before($direction)
    {
        return true;
    }

    public function after($direction)
    {
        if ($direction == 'up') {
            $config = $this->db->config;
            `mysql -u{$config['login']} -p{$config['password']} {$config['database']} < db/20121010154033_create_initialize.sql`;
        }
   
        return true;
    }
}

こんなこと書いてたけど普通にできた。（simpletestは必要）

% cake testsuite app all

知らんかった・・・。

ついでに、phpunitを使ったseleniumのテストも一緒にできるshell作った。

app/vendors/shells/tasks/integrations.php:

<?php
class IntegrationsTask extends Shell
{
    public function startup() {}

    public function execute()
    {
        $this->out(`phpunit app/tests/integrations`);
    }
}

app/vendors/shells/test.php:

class TestShell extends Shell
{
    public $tasks = array('Cases', 'Integrations');

    public function startup() {}

    public function main()
    {
        $arg = isset($this->args[0]) ? $this->args[0] : '';
        switch ($arg) {
        case 'cases':
            $this->Cases->execute();
            break;
        case 'integrations':
            $this->Integrations->execute();
            break;
        default:
            $this->Cases->execute();
            $this->Integrations->execute();
        }
    }
}

% cake test

とりあえず本番でエラーが起きてたら開発MLへメールしたい。レガシーPHP案件にとりかかる時はいつもやるphp.iniでメール飛ばす設定をしようとしたら、CakePHPがエラーを捕まえているので飛ばない。

大抵のフレームワークではググるとMailを飛ばすLoggerが見つかるもんだが、CakePHP1.3用のが見つからなかったので書いときました。

<?php
/**
 * メールを送るロガー
 *
 * 使い方：
 * // app/config/bootstrup.php:
 * CakeLog::config('mailLog', array(
 *     'engine' => 'MailLog',
 *     'to'     => 'to@example.com',
 *     'from'   => 'from@example.com'
 * ));
 */
class MailLog
{
    private $to;
    private $from;

    /**
     * オプションを設定する
     *
     * @param  array $options メールのto、fromの設定
     * @return void
     */
    public function __construct($options = array())
    {
        if (isset($options['to'])) {
            $this->to = $options['to'];
        }

        if (isset($options['from'])) {
            $this->from = $options['from'];
        }
    }

    /**
     * ログをメールで送る（ログを書く）
     *
     * @param  string $type    エラーの種類
     * @param  string $message エラーの内容
     * @return void
     */
    public function write($type, $message)
    {
        $subject = "[{$type}] ".mb_substr($message, 0, 32);
        mb_send_mail($this->to, $subject, $message, "From: {$this->from}");
    }
}

Sending log by mail for CakePHP1.3 — Gist

appディレクトリ以下から対象を抽出し、potファイルを生成する。

% cake i18n extract

potファイルをpoファイルにマージする。

% msgmerge -U app/locale/jpn/LC_MESSAGES/default.po app/locale/default.pot

poファイルやmsgmerge等のツールについてはgettextをググる。

（レガシー改善に関しては文章が長くなるのでいつもと違って、〜だ、〜である口調で書きます。）

bake

CakePHPははじめてなのでところどころハマったが基本的なCRUDは出来た。というかbakeで殆ど生成されるのだが。CakePHP1.3のbakeはデフォルトでページングとカラム毎のソート機能が入っている。

しかし、「データがたくさんある時ページ分けして欲しい」というタスクが幾つかRedmineにあったし、ソースをみても既存の部分はbakeを使った形跡は無い。俺が初bakeか。

i18n

bakeにともなってi18nも使った（bakeで生成されるソースにはi18n前提だし）。現状、poファイルが無い。俺が初i18nか。

% cake bake i18n extract

こんな感じでソースからpotファイルを生成する。app/vendorsにPHPExcelというプラグインがあって、それの処理に死ぬほどメモリと時間がかかる。app/vendorsを除外する方法は無いものか。

ソースを見ると上記にpotを既存poにマージする機能があるっぽいが、やり方がわからなかったのでとりあえず初回はmsginitした。

macではデフォルトでgettextが入っているが、% brew link gettextしないとパスが通らないところが若干罠だった。

既存ソースに何故か

__('')

msgid ""
msgstr ""

みたいな空文字を翻訳している箇所が5箇所ぐらいあってmsginitが出来ない。どういう理由でこういうコードがあるのか不明だが、とりあえず消した。

validateエラーメッセージのi18n

modelでvalidateエラーメッセージをi18nしようとしたがsyntax errorが出る。何故？と思ったがphpではrubyと違ってインスタンス変数の定義は定義であって評価じゃない。初期値は書けるが関数の実行はできない。

要は下記はOKだが、

class User {
    public $name = 'komagata';
}

下記は駄目ということだ。

class User {
    public $length = strlen('komagata');
}

rubyを始めた頃はattr_accessorを見て「クラス定義内も普通に式が評価されるのか、凄いなー！」なんて思ったはずだが、それが当たり前になりすぎてそうじゃない言語が沢山あることを忘れていた…。（array()はOKなのでarrayは関数じゃなくてリテラルなのかな？）

class RegularOrder extends AppModel {
    public $validate = array(
        'interval' => array(
            array(
                'rule'    => 'numeric',
                'message' => __('must be number', true)
            )
        )
    );
}

何故これがsyntax errorなんだー！・・・みたいな。

FormHelperへの疑問

CakePHP1.3のbakeが生成するコードはFormHelperを使っている。railsのscaffoldと比較して疑問点がいくつかあった。

bakeが生成するviewのコードは下記のようになっている。（分かりやすく色々端折ってます）

<?= $form->input('interval') ?>

でも実際は下記のようにモデル名も書かないと動かない。

<?= $form->input('RegularOrder.interval') ?>

formはmodelを知ってるんだから自動で付けてくれてもいい気がするが、PHP4もサポートするせいでモデル名がわからないのかもしれない。それだったらPHP4サポートを切ったCakePHP2系だったら改善されてるのかも。

レガシー改善パターン "Partial Proxy Pattern"

既存のレガシーの中にリーダブルコードを書いていく為のショーモナイテクニックに勝手に名前を付けていきたいと思います。

既存のテンプレートの中の共通化したい部分はこんな感じで書かれてる。

<body>                      
  <?php include('../views/head-menu.ctp');?>
    <h2 class="title_1">注文入力</h2>

ファイル名と置き場所が分かり辛い。include（！）ではなく、CakePHPのElementを使って欲しい。かといって既存部分をいじったら他で何が起こるか分かったもんじゃない。怖い。

app/views/elements/admin/menu.ctp:

<?= $this->element('../head-menu') ?>

そこでこんな感じで本来置きたい場所に一旦既存のテンプレを読み込むだけのProxy的なElementを作る。そうすると、新しく実装するviewはリーダブルでいられる。

app/views/layouts/admin.ctp:

<?= $html->doctype('xhtml-trans') ?> 
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja">
  <head>
    <?= $html->charset() ?>
    <title><?= $title_for_layout ?></title>
    <?= $html->css('admin') ?>
    <?= $scripts_for_layout ?>
  </head>
  <body>
    <?= $this->element('admin/menu') ?>
    <div id="content">
      <?= $content_for_layout ?>
    </div>
  </body>
</html>

レガシー改善パターン "CSS Proxy Pattern"

同じく、既存のCSS(style.css)はゴチャゴチャなので新しく作るview用のCSSはリーダブルにしたい。そこでこう！

app/webroot/css/admin.css:

@import url('style.css');

/* ここに新しいviewで必要なcssを書いてく */

レガシーCSSとリーダブルCSSを切り分けることが出来る。

絶賛募集中

僕と一緒にレガシー改善をしてくださるプログラマーを募集しています。常駐・受託、開発会社・フリーランス、派遣・バイト問いませんので是非お願いします。というか助けて欲しい・・・。詳しくはこちら。

関連：レガシーPHP改善日記シリーズ

cakephp1.3はwebアプリとしてのtestrunnerしか無い。terminalからやりたいとかjenkinsでshell exexuteしたいときとかに困る。

神の子、@itemanさん達が作られてるStagehand_TestRunnerがCakePHP x simpletestの実行に対応してるのでそれを使えばOK。

CLI のための継続的テストランナー v3 - Stagehand_TestRunner - Piece Framework

Stagehand_TestRunnerをComposerでインストール

% vi composer.json 
{
  "require": {
    "piece/stagehand-testrunner": ">=3.3.1"
  }
}
% php composer.phar install
% ./vendor/bin/testrunner --preload-script=vendor/autoload.php --cakephp-app-path=app --cakephp-core-path=cake cakephp app/tests/cases/models/post.test.php

（ハマっていた時、Twitterで@itemanさん、@rskyさんに助けていただきました。ありがとうございます。）

CakePHP1.3でtestを書くにはsimpletestが必要。（デフォルトで付いてない）CakePHP1.3はちょっと古いのでsimpletestの最新では動かないので1.0系を使う。

まずFixtureを書く。Fixtureはクラスで書く。（これyamlとかでできないかなあ）

<?php
class PostFixture extends CakeTestFixture {
    var $name = 'Post';
    var $table = 'posts';

    var $fields = array(
        'id' => array(
            'type'    => 'integer',
            'null'    => false,
            'key'     => 'primary'
        ),
        'name' => array(
            'type'    => 'integer',
            'null'    => false
        )
    );

    var $records = array(
        array('id' => 1, 'name' => 'komagata'),
        array('id' => 2, 'name' => 'machida'),
        array('id' => 3, 'name' => 'yoshida')
    );
}
?>

modelのテストケースを書く。

<?php
class TestPost extends Post {
    var $cacheSources = false;
    var $useDbConfig = 'test';
}

class PostTestCase extends CakeTestCase {
    var $Post = null;
    var $fixtures = array('app.post');

    function startTest() {
        $this->Post =& ClassRegistry::init('Post');
    }

    function endTest() {
        unset($this->Post);
        ClassRegistry::flush();
    }

    function testPostInstance() {
        $this->assertTrue(is_a($this->Post, 'Post'));
    }

    function testFetchKomagata() {
        $this->Post->recursive = -1;
        $result = $this->Post->fetchKomagata();
        $expected =  array(
            'Post' => array('id' => 1, 'name' => 'komagata')
        );
        $this->assertEqual($result[0], $expected);
    }
}
?>

こんな感じ。/test.phpから結果が見れる。

cakephp1.3系（+svn)のプロジェクトのテコ入れ的な仕事をやることになったのですが、php浦島状態です。下記、もしわかれば教えていただけるとありがたいです！

• エンドツーエンドテストがしたい。（selenium rc+simpletestなのかな？）
• CIしたい。（jenkins + selenium rc+simpletest or phpunitとかでできるのかな？）
• migrationしたい。（若干あきらめ気味）
• deployはどうやるんだろう？
• stagingとproductionを簡単に切り替えるdeployがしたい（贅沢？）

識者の方、なにとぞ、なにとぞ・・・　m(_ _)m

追記：

@yandoさんに教えてもらった情報。

migration = migration plugin

deploy =cap-cake (capistrano)

あとはエンドツーエンドテストが気になります。（個人的にbehatはやり過ぎ感）