L5.5 on ララジャパン

既存のDBからfactoryファイルを自動作成

Sat, 25 Jan 2020 07:51:08 +0900

既存のＤＢからmigrationファイルを自動作成によって、テストのために空のDBテーブルの作成が可能となりました。今度は、そこへテストデータを作成するためにfactoryが必要となります。これも自動作成しましょう。

どうして、factoryのファイルが必要？

factoryのファイルが必要なのは、あらゆるテストの目的のためです。いちいち画面の入力でDBレコードを作成する代わりに、tinkerやユニットテストでfactory()のヘルパーを使用して簡単にレコードが作成できようになります。factoryのタグの記事では、たくさんの使用例を見ることできます。

しかし、現状の以下のLaravelのコマンドの実行では、

$ php artisan make:factory UserFactory --model=User

作成されるfactoryは、以下のように項目もない単なるテンプレートです。

databases/factorys/UserFactory.php

/** @var \Illuminate\Database\Eloquent\Factory $factory */

use App\Model;
use Faker\Generator as Faker;

$factory->define(User::class, function (Faker $faker) {
    return [
        //
    ];
});

DBテーブルがたくさんあるプロジェクトでは、いちいちこれを編集していくのはとても大変です。それゆえに、既存のDB構造をもとに、自動でfactoryファイルを生成する必要があります。

factoryファイル自動生成ツール

まずは、パッケージのインストール。以下をコマンドラインで実行します。

$ composer require --dev mpociot/laravel-test-factory-helper

factoryのファイルを作成するには、artisanの実行が必要となります。Laravel 6.x の新規プロジェクトを作成して実行しますが、すでにUserのモデルのためのfactoryファイルが、databases/factories/UserFactory.phpとして存在するので、上書きされないように改名しておきます。そして以下をコマンドラインで実行します。

$ php artisan generate:model-factory
Model factory created: database/factories/UserFactory.php

作成されたfactoryの内容は以下です。

databases/factories/UserFactory.php

/* @var $factory \Illuminate\Database\Eloquent\Factory */

use Faker\Generator as Faker;

$factory->define(App\User::class, function (Faker $faker) {
    return [
        'name' => $faker->name,
        'email' => $faker->safeEmail,
        'email_verified_at' => $faker->dateTime(),
        'password' => bcrypt($faker->password),
        'remember_token' => Str::random(10),
    ];
});

元にあったファイルと比べてみましょう。以下が元のファイルです。

/** @var \Illuminate\Database\Eloquent\Factory $factory */

use App\User;
use Faker\Generator as Faker;
use Illuminate\Support\Str;

$factory->define(User::class, function (Faker $faker) {
    return [
        'name' => $faker->name,
        'email' => $faker->unique()->safeEmail,
        'email_verified_at' => now(),
        'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
        'remember_token' => Str::random(10),
    ];
});

いくつか違いがありますね。しかし、これも自動生成されたmigrationファイルと同様に使用するテストに合わせて編集すればよいです。 Fakerのドキュメントは、こちらです。

factoryファイル自動作成のコマンドのartisanの実行には、いくつかのオプションを指定することができます。

すべてのモデルのfactoryを作成する代わりに、指定のモデルだけのfactoryの作成には、

$ php artisan generate:model-factory User Team

モデルのファイルがが、app/Modelsのディレクトリにあるなら、

$ php artisan generate:model-factory --dir app/Models -- User Team

と実行できます。

最後に、migrationとfactoryの自動作成ツールは、Laravelのバージョンによりインストールが違うのでここでまとめてリストします。

Laravel 6.x

$ composer require --dev oscarafdev/migrations-generator 2.0.13
$ composer require --dev mpociot/laravel-test-factory-helper

Laravel 5.5~

$ composer require --dev xethron/migrations-generator
$ composer require --dev mpociot/laravel-test-factory-helper v1.3

バリデーションの実例：項目の存在、項目の値の存在

Sun, 02 Sep 2018 05:17:50 +0900

今回は、指定の項目の存在、その項目の値の存在を判定するルールを紹介します。これらのルールは主に他のルールと混合して使用します。

nullable present filled required

required以外は、ややわかりづらいルールなので表にしてみました。結果がtrueとなる条件です。値が「なし」というのは、空の文字列（半角の空白文字があるならトリムします）あるいはnullのことです。

ルール	項目	値
nullable	あってもなくても	あってもなくても
present	あり	あってもなくても
filled	あってもなくても	あり
required	あり	あり

以下の実例では、nullable|stringのように他のルールとの混合の例としています。また比較のために、stringだけのテストも掲載しました。

レスポンスマクロを一箇所にまとめて定義

Sat, 25 Aug 2018 05:51:31 +0900

前回、前々回のレスポンスのマクロの定義は、app/Providers/AppServiceProvider.phpのアプリのサービスプロバイダーに入れましたが、マクロの定義が増えてくると整理した方が良いのと、コントローラ以外では必要もないので、単独のサービスに移します。

まず、app/Providers/ResponseMacroServiceProvider.phpを作成して、２つのマクロを定義します。

app/Providers/ResponseMacroServiceProvider.php

namespace App\Providers;

use Illuminate\Routing\ResponseFactory;
use Illuminate\Support\Facades\View;
use Illuminate\Support\ServiceProvider;

class ResponseMacroServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap the application services.
     *
     * @param ResponseFactory $response
     * @return void
     */
    public function boot(ResponseFactory $response) //レスポンスのオブジェクトを渡すこと可能
    {
        $response->macro('viewWithS3', function ($view, $data) {
            $host = '//example.s3.amazonaws.com';
            $html = View::make($view)->with($data)->render();
            $output = preg_replace('#/user/images/#', $host . '/user/images/, $html);
            return $this->make($output); 
        });

        $response->macro('downloadNoCache', function ($path) {
            return $this->download($path, basename($path), [
                'Cache-Control' => 'no-store',
            ])->setPrivate();   // Cache-Controlにpublicが追加されるのを回避
        });
    }
}

上のboot()の関数の定義では、引数にレスポンスのオブジェクトを渡すことが可能です。以下に説明あります。

https://laravel.com/docs/5.5/providers#the-boot-method

この新しいサービスプロバイダーを使うには、以下のようにconfig/app.phpで登録が必要です。

config/app.php

return [
...
    'providers' => [
...

        /*
         * Application Service Providers...
         */
        App\Providers\AppServiceProvider::class,
        App\Providers\AuthServiceProvider::class,
        // App\Providers\BroadcastServiceProvider::class,
        App\Providers\EventServiceProvider::class,
        App\Providers\ResponseMacroServiceProvider::class,
        App\Providers\RouteServiceProvider::class,
    ],
...
];

これで以下のように、コントローラでこれらのマクロの使用が可能となります。

return response()->viewWithS3('user/product', compact('page', 'product'));

return response()->downloadNoCache($pathToFile);

レスポンスマクロでダウンロードファイルを保護

Sun, 19 Aug 2018 07:32:37 +0900

一度気に入ると、より使って見たくなるのが人の常。ということでさらにマクロの活用です。今回は、前回と同様なレスポンスマクロを使用して、サイトからダウンロードするファイルを保護します。

ファイルのダウンロード

ファイルのダウンロードの機能は、すでにLaravelでは提供されています。例えば、storage/data.txtのファイルのダウンロードは以下のようにコントローラのレスポンスにdownload()をチェーンして、ファイルダウンロードのレスポンスとします。

...
class DownloadFileController extends Controller
{
...
    public function download()
    {
        $pathToFile = storage_path() . '/data.csv';
        return response()->download($pathToFile);
    }
}

さて、ブラウザーで、このファイルのダウンロードのレスポンスのヘッダーを見ると、

HTTP/1.1 200 OK
Date: Fri, 17 Aug 2018 22:05:43 GMT
Server: Apache/2.4.27 (Fedora) OpenSSL/1.0.2k-fips PHP/7.1.14
X-Powered-By: PHP/7.1.14
Cache-Control: public
...

Cache-Control: publicの部分、パブリックと設定されているので、ファイルの中身がサーバーとクライアント（ユーザー）の間のプロキシでキャッシュされるかもしれません。このファイルが例えば公共に見られてよい画像とかなら問題はないのですが、ファイルがサイトの会員とか注文データだとセキュリティの問題となります。私としては以下と設定したいのです。

...
Cache-Control: private
...

ここを修正すべく、まず思ったのは、download()のパラメータを使用してのCache-Controlの設定です。

return response()->download($pathToFile, 'data.csv', ['Cache-control' => 'private']);

しかし、これが効きません! 相変わらず、レスポンスのヘッダーはCache-Control: publicです。試しに、以下のように違うCache-Controlの属性を設定してみると、

return response()->download($pathToFile, 'data.csv', ['Cache-control' => 'no-store']);

今度は、Cache-Control: no-store, publicという変な結果になりましたが、設定はできるようです。となると、どこかでprivateを弾いているみたいです。

どこでpublicが設定されている？

ymikomeさんが探偵のようにコードを追跡してくれました。

問題は、

vendor/laravel/framework/src/Illuminate/Routing/ResponseFactory.php

namespace Illuminate\Routing;
...
class ResponseFactory implements FactoryContract
{
...
    public function download($file, $name = null, array $headers = [], $disposition = 'attachment')
    {
        $response = new BinaryFileResponse($file, 200, $headers, true, $disposition); //ここの4番目のtrueの設定が問題！

        if (! is_null($name)) {
            return $response->setContentDisposition($disposition, $name, str_replace('%', '', Str::ascii($name)));
        }

        return $response;
    }
...

download()の定義の中の、BinaryFileResponse()のコールで、その4番目のtrueの値が、以下ようにsetPublic()のコールとなります。注意してください。もうここからは、Laravelのコードでなく、Symfonyのコードです。

vendor/symfony/http-foundation/BinaryFileResponse.php

namespace Symfony\Component\HttpFoundation;
...
class BinaryFileResponse extends Response
{
...
    public function __construct($file, $status = 200, $headers = array(), $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
    {
        parent::__construct(null, $status, $headers);

        $this->setFile($file, $contentDisposition, $autoEtag, $autoLastModified);

        if ($public) {
            $this->setPublic(); // $public = trueだからここを実行！
        }
    }
...

そして、このsetPublic()の定義は、

vendor/symfony/http-foundation/Response.php

namespace Symfony\Component\HttpFoundation;

/**
 * Response represents an HTTP response.
 *
 * @author Fabien Potencier <fabien@symfony.com>
 */
class Response
{
...
    public function setPublic()
    {
        $this->headers->addCacheControlDirective('public');
        $this->headers->removeCacheControlDirective('private');　//ここでprivateが弾かれる！
    
        return $this;
    }
...

headersでprivateを設定してもここで抜かれる訳です。

どうprivateを設定する？

さて、Cache-Controlがいつもpublicとなる原因はわかりましたが、どうこれをprivateと設定するのが今度は問題となりました。ResponseFactory::download()を上書きするのが良いように思えますが、ResponseFactoryのクラスそのものを継承とかなるようで、trueをfalseとする目的のためには大袈裟すぎます。

困ったと思ったときに、見たのは先のSymfonyのコード、setPublic()の定義を含むファイルには、setPrivate()もあるではないですか！

ということで、以下のようなマクロの定義となりました。内部では一旦publicにしたものをprivateにすることになりますが、ここでは意図が明確でスッキリとしています。

       Response::macro('downloadNoCache', function ($path) {
            return $this->download($path, basename($path), [
                'Cache-Control' => 'no-store',
            ])->setPrivate();   // Cache-Controlにpublicが追加されるのを回避
        });

no-storeですが、これはブラウザがファイルをキャッシュするのを防ぎます。毎回ダウンロードでデータが変わるときには必要です。

このマクロの使用は、以下のようになります。

return response()->downloadNoCache($pathToFile);

この実行は以下のように思い通りのヘッダーとなりました。

HTTP/1.1 200 OK
Date: Fri, 17 Aug 2018 23:40:33 GMT
Server: Apache/2.4.27 (Fedora) OpenSSL/1.0.2k-fips PHP/7.1.14
X-Powered-By: PHP/7.1.14
Cache-Control: no-store, private
...

レスポンスマクロを使ってLaravel風に問題解決

Sun, 12 Aug 2018 01:02:23 +0900

前回、validate()のソースコードで登場したマクロ、今回は有用なマクロの活用の例を紹介します。

マクロに関してのLaravelのマニュアルでは以下で、response()のマクロの例が紹介されています。

https://laravel.com/docs/5.5/responses#response-macros

これを見て「あ、これはここで使える！」と思ったのは、コントローラから出力するHTMLの中身の画像のURLの変換です。

まずは、ちょっと背景説明を。

私のお客さんのサイトでは画像がかなり多いので、サーバー（EC2）の負担を減らすために画像はすべてAWSのS3にアップしています。どれだけアクセスがあっても画像はS3から配信されるのでサーバーが落ちる心配もないし、サーバーをアップグレードする必要もなくコストセーブとなります。

しかし、ブレードを管理するデザイナーに、

<img src="/user/images/example.jpg">

のような参照を、

<img src="//example.s3.amazonaws.com/user/images/example.jpg">

と毎回書き換えてもらうのは、やっかい。もちろん、エディターやsassとかでのプリ処理は可能だけれども、１つステップ増えるしプログラマでないデザイナーにはちょっと。また、S3のURLも本サイトと開発サイトでは変えたいケースもあり、そうしてもらうとこちらも困ります。

ということで、出力時にダイナミックに変えるのは必須となりました。ダイナミックに変えるには、ウェブサーバーでの設定でも可能ですが、やはり、HTMLの中にS3のURLが入るのがサーバーにも負担にならず、ユーザーにとっても表示速度の点で最適です。

このために、以下のようなユーザー定義のヘルパーを作成して、

Lob.php

// Lobは、私の会社 Lots of Bytesの略です。

class Lob {
    ...
    public static function view($view, $data)
    {       
        $host = '//example.s3.amazonaws.com';
        $html = View::make($view)->with($data)->render());
        $output = preg_replace('#/user/images/#', $host.'/user/images/, $html);    

        return response($output);
    }
　　...
}

コントローラで以下のように、コールしていました。

    return Lob::view('user/product', compact('page', 'product'));

これで用は足りるのですが、なんかLaravelらしくない。

そこで、マクロの登場です。

app/Providers/AppServiceProvider.phpを編集して、viewWithS3のマクロを定義します。

app/Providers/AppServiceProvider.php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Facades\Schema;

use Illuminate\Support\Facades\Response;
use Illuminate\Support\Facades\View;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        Schema::defaultStringLength(191);

        Response::macro('viewWithS3', function ($view, $data) {
            $host = '//example.s3.amazonaws.com';
            $html = View::make($view)->with($data)->render());
            $output = preg_replace('#/user/images/#', $host.'/user/images/, $html);

            // 以下の$thisは、AppServiceProviderのインスタンスでなく、Illuminate\Http\Response
            return $this->make($output); 
        });
    }
...
}

コントローラでは、以下のようにコールします。Laravelらしくわかりやすくなりましたね。

        return response()->viewWithS3('user/product', compact('page', 'product'));

バリデーションのあれこれ

Sun, 05 Aug 2018 05:15:42 +0900

バリデーションの実例をちょっと休んで、実際にバリデーションを実行する部分を見てみます。お客さんのプロジェクトで最近この辺を詳しく見る機会があったので、皆さんと共有です。

一般的にはコントローラで使わるのですが、以下のようにいくつかあります。

リクエストのvalidate()メソッド

まず、代表的（5.5の時点で）なのがLaravelのドキュメンテーションの例としても使われている、Requestオブジェクトのメソッド、validate()。

...
public function store(Request $request)
{
    $request->validate([
        'title' => 'required|unique:posts|max:255',
        'body' => 'required',
    ]);

    // The blog post is valid...
}

このvalidateでは、それだけで与えられたルールの配列をもとに入力値、この場合、$request->all()を判定して、問題があるなら、エラーメッセージと入力値とともに前のページに戻ります。

しかし、驚くことに、これはRequestのクラスのメソッドではありません！メソッドの形をしたマクロで、以下のファイルで定義されています（このマクロに関しては将来投稿を作成する予定です）。

vendor/laravel/framework/src/illuminate/Foundation/Providers/FoundationServiceProvider.php

<?php

namespace Illuminate\Foundation\Providers;

use Illuminate\Http\Request;
use Illuminate\Support\AggregateServiceProvider;

class FoundationServiceProvider extends AggregateServiceProvider
{
    /**
     * The provider class names.
     *
     * @var array
     */
    protected $providers = [
        FormRequestServiceProvider::class,
    ];

    /**
     * Register the service provider.
     *
     * @return void
     */
    public function register()
    {
        parent::register();

        $this->registerRequestValidate();
    }

    /**
     * Register the "validate" macro on the request.
     *
     * @return void
     */
    public function registerRequestValidate()
    {
        Request::macro('validate', function (array $rules, ...$params) {
            validator()->validate($this->all(), $rules, ...$params);

            return $this->only(collect($rules)->keys()->map(function ($rule) {
                return str_contains($rule, '.') ? explode('.', $rule)[0] : $rule;
            })->unique()->toArray());
        });
    }
}

コントローラのValidatesRequestsトレイトのvalidate()メソッド

先の例を使えば、以下のようになります。

...
public function store(Request $request)
{
    $this->validate($request,
        [
            'title' => 'required|unique:posts|max:255',
            'body' => 'required',
       ]);
...
}

validate()の第１引数にリクエストのオブジェクトを渡します。こちらも、$request->all()を判定して、問題があるなら、エラーメッセージと入力値とともに前のページに戻ります。

このvalidateは、ValidateRequestsのトレイトのメソッドで、以下のようにコントローラの親クラスで宣言されています。

app/Http/Controllers/Controller.php

namespace App\Http\Controllers;

use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Routing\Controller as BaseController;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Foundation\Auth\Access\AuthorizesRequests;

class Controller extends BaseController
{
    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
}

Validatorクラス

上の２つが存在しなかった時代からLaravelをやってきている人たちにはこのやり方は馴染みあります。上の２つに比べてコードが長くなるものの、何をやっているか明確になります。

...
    public function store(Request $request)
    {
        $validator = Validator::make($request->all(), [
            'title' => 'required|unique:posts|max:255',
            'body' => 'required',
        ]);

        if ($validator->fails()) {
            return redirect('post/create')
                        ->withErrors($validator)
                        ->withInput();
        }

        // Store the blog post...
    }

バリデーターのオブジェクトを作成してから、判定作業(fails())を実行して、エラーならリダイレクトです。

validator()ヘルパー

最後に、Validator::make()を簡略化したヘルパー、validator()があります。

...
    public function store(Request $request)
    {
        $validator = validator($request->all(), [
            'title' => 'required|unique:posts|max:255',
            'body' => 'required',
        ]);

        $validator->validate();
...

$validator->validate();これ、どこかで見たような。そう、最初のvalidateのマクロの定義の中で使用されています。

このようにバリデーションの実行にいろいろやり方があるのは、Laravelが進化を続けている証拠ですね。

バリデーションの実例：DBの情報を引数とする条件

Sun, 29 Jul 2018 05:10:01 +0900

今回は、引数にDBの情報を指定するバリデーションルールです。今回はデータベースを伴うテストなので、use RefreshDatabase;のトレイトや、factory()->create()が使用されています。

exists unique

後者の方は、会員登録では必須のバリデーションです。会員編集の方でも自分のレコードを外す引数を指定すれば使用可能です。しかし、Laravel 5.5からのRuleの登場で、よりわかりやすい形でも指定できます。これらは皆、今回のテストに含まれています。

バリデーションの実例：他の項目の値を引数とする条件

Sun, 22 Jul 2018 04:08:56 +0900

今回は、引数にフォームの他の項目名を指定するバリデーションルールです。

confirmed different in_array same

個人的には、最初のconfirmed以外は使用したことないですね。in_arrayでは引数として指定する項目が配列であることを示すために、field2.*のように指定する必要あることに注意してください。

さて、他の項目の値を引数としては使わないのですが、入力値が配列のときに、それらの値に重複がないというチェックもここに掲載します。他に入れるところがないというのですが、本当は。配列という投稿を作成してもよいかもしれませんね。

distinct

バリデーションの実例：定数値を引数とする条件

Sun, 15 Jul 2018 07:22:29 +0900

入力値のデータタイプの判定のバリデーションから、今度は条件で判定するバリデーションに移っていきます。条件で判定するバリデーションには、その条件で使用される引数の指定が必要となります。引数には、

文字列や数字の定数値（例：min, maxなど）
同じフォームの他の項目名（例：same、differentなど）
DBの情報（例：exists、unique）

が指定されます。

今回は、最初の引数タイプ、定数値を引数とする条件の以下のバリデーションのテストを掲載します。

digits digits_between size between min max in not_in regex

また、前回紹介した日付のバリデーションの以下も定数値を引数とする条件に含まれますね。

date_format, date_equals, after, after_or_equal, before, before_or_equal

今回の注意点は、size, between, min, maxにおいて、入力値を文字列でなく数値として扱うには、numericあるいはintegerのルールの指定が必要なことです。例えば、integer|between:3,10なルールになります。

バリデーションの実例：日付

Sat, 07 Jul 2018 07:11:01 +0900

今回は日付関連のバリデーションを掲載します。

date date_format date_equals after after_or_equal before before_or_equal

date以外、今回は皆ルールの指定にはパラメータが必要となります。

バリデーションの実例：特殊データタイプ

Sun, 01 Jul 2018 05:57:20 +0900

特殊データタイプとしてのチェックとして以下のテストを掲載します。以下からのリンクだけでなく、この投稿にも掲載してあります。

alpha alpha_dash alpha_num accepted active_url email ip timezone url

今回、まず注意する必要があるのは、alpha, alpha_dash, alpha_numです。これらの「アルファ」は通常の半角英字と仮定してしまいますが、実際はそれぞれの言語でのアルファベット、という意味で、英語ではなく一般的に言語の文字列という意味です。つまり、日本語なら何でもＯＫということになります。ログインなどに使用する半角英数字のアルファベットのバリデーションには、これでなくユーザー定義が必要となりますね。

それから、emailのバリデーション、日本のユーザーに対応するならRFC非準拠のメールアドレス（「.」を「..」などのように連続で使用することや@マークの直前で使用）は対応していません。これも、ユーザー定義のバリデーションが必要となります。

バリデーションの実例：基本データタイプ

Sun, 24 Jun 2018 01:22:59 +0900

基本データタイプのチェックとして以下のテストを掲載します。以下からのリンクだけでなく、この投稿にも掲載してあります。

boolean integer numeric string array json

dateも入れようかと思いましたが、その他の日付関連のバリデーションとともに掲載します。

以下の掲載で説明が必要な部分は、ブーリアンです。入力値がfalseなのにどうしてtrueを返すのか？データをチェックしているのでなく、データがブーリアンタイプであるかをチェックしている、と考えてください。

それから、配列のテストで、どうして空の[]がrequiredによりエラーとなりますが、jsonの{}はエラーとならないのかは謎です。

バリデーションの実例

Sun, 17 Jun 2018 05:54:57 +0900

新しい連載を始めます。

Laravelは、出来合いのヘルパーやバリデーションがあり便利です。もの凄くたくさんあり覚えらないというほどの数ではないですが、すべてを頭の中で保持しておくのも大変です。また、こういう使い方では結果はどうなるのとか、実際に実行してみないとわからないことあります。

例えば、バリデーションのalphaは、文字列がすべて英字からなる（本当？）かをチェックします。このバリデーションを、ログイン名のチェックとかに使うとします。しかし、大文字でもＯＫなのとか、空白文字が入ってもＯＫなのとか、日本語の入力はどうなのとか、調べないとわからないことあります。Laravelのドキュメントではそこまで細かくは説明していません。

前回で説明したようにtinkerで簡単にチェックすることも可能ですが、面倒だなと思うときに、実例を素早く見ることができれば便利だと思いません？

そこで今回から、そんな便利な実例特集を連載する予定です。まず、その１つを見てください。以下は、Laravelのバリデーションのacceptedのユニットテストです。

実例の使い方

先に掲載したコードは、github.comのgistを使用しています。gistは、一般的にスニペットと言われる、コピペ専用が目的のgitのレポジトリです。gitでコード管理するのと同様、cloneやforkの利用も可能です。

上のコードを実際にテストしてみたいなら、ララベル5.5のプロジェクトを作成して、そのプロジェクトのルートのディレクトリで、以下を実行してください。

$ git clone git@gist.github.com:cf781699c05c73d07fdbff8489052ef8.git tests/Unit/Validations/Accepted

コマンドラインで指定したURLは、

gistの画面において、embedのドロップダウンのリストから、Clone via SSHを指定して、表示されたURLを使います。以下の画面では、赤いボックスのところをクリックしてコピーできます。

コマンドの実行は、以下のように、tests/Unit/Validations/Acceptedのディレクトリを作成して、テストのファイルを作成してくれます。

tests/Unit
├── ExampleTest.php
└── Validations
    └── Accepted
        ├── 0.md
        └── AcceptedTest.php

ダウンロードしたところで、テストを実行してみましょう。

$ vendor/bin/phpunit --filter AcceptedTest
PHPUnit 6.5.8 by Sebastian Bergmann and contributors.

.........                                                           9 / 9 (100%)

Time: 201 ms, Memory: 12.00MB

OK (9 tests, 9 assertions)

と９つテストがすべて成功の結果を表示してくれます。

phpunitのデータプロバイダー

先のテストの実行では、９つのテストが成功、とありましたが、９つのテストなるゆえは、上のコードのprovider_acceptedの関数内に９つのデータ配列があるからです。

このユニットテストでは、phpunitのデータプロバイダー機能を使用しています。その機能では、コメントに入れる情報で、どこからデータを受け取るかを指定します。

    /**
     * @test ←　関数がテストの関数であることを指定
     * @dataProvider provider_accepted　←　この関数からデータを取ってくることを指定
     */
    public function accepted($input, $expected)
    {
     ..

provider_accepted()では、

例えば、最初のデータ

[[‘field’ => null], false]

は、

[‘field’ => null]　が　accepted()の最初のパラメの$input

となり、

falseが、$expected

となります。

テストの実行では、９つのデータ配列があるので、データを変えて9回のテストの実行となります。そして、さらにいろいろテストしたいなら、そのデータと期待する結果をそこに追加すればよいだけです。

バリデーションの実例の連載開始

ということで、次回からバリデーションの実例を投稿していきます。まずは、Laravelにある規定のバリデーションですが、それだけでなくユーザー定義のバリデーションもアップしていく予定です。

ティンカーでリクエスト（Request）

Sat, 09 Jun 2018 09:00:44 +0900

前回に引き続いてリクエストの話です。ブラウザがないとリクエスト（Request）のオブジェクトが作成できない、とは限りません。Laravelならコマンドラインで作成できます。どうやって？

リクエストオブジェクトの作成

コマンドラインと言えばもちろん、tinkerのことです。以下のように、クラスのcreate()メソッドを使って、リクエストのオブジェクトを作成できます。

Psy Shell v0.9.3 (PHP 7.1.14 — cli) by Justin Hileman

>>> $request = \Illuminate\Http\Request::create('http://localhost', 'GET', ['name' => 'test']);

=> Illuminate\Http\Request {#2324
     ⚠: Symfony\Component\VarDumper\Exception\ThrowingCasterException {#2309
       #message: "Unexpected ErrorException thrown from a caster: Undefined index: ",
     },
     +attributes: Symfony\Component\HttpFoundation\ParameterBag {#2320},
     +request: Symfony\Component\HttpFoundation\ParameterBag {#2322},
     +query: Symfony\Component\HttpFoundation\ParameterBag {#2321},
     +server: Symfony\Component\HttpFoundation\ServerBag {#2317},
     +files: Symfony\Component\HttpFoundation\FileBag {#2318},
     +cookies: Symfony\Component\HttpFoundation\ParameterBag {#2319},
     +headers: Symfony\Component\HttpFoundation\HeaderBag {#2316},
   }

Laravelのリクエストは、Symfonyのクラスがベースになっているようです。createは、Laravelのクラスのメソッドではなく、Symfonyのクラスのメソッドです。参考のために、以下にその定義の一部を掲載します。

SymfonyComponentHttpFoundationRequest.php

    /**
     * Creates a Request based on a given URI and configuration.
     *
     * The information contained in the URI always take precedence
     * over the other information (server and parameters).
     *
     * @param string               $uri        The URI
     * @param string               $method     The HTTP method
     * @param array                $parameters The query (GET) or request (POST) parameters
     * @param array                $cookies    The request cookies ($_COOKIE)
     * @param array                $files      The request files ($_FILES)
     * @param array                $server     The server parameters ($_SERVER)
     * @param string|resource|null $content    The raw body data
     *
     * @return static
     */
    public static function create($uri, $method = 'GET', $parameters = array(), $cookies = array(), $files = array(), $server = array(), $content = null)
    {
    ..

先のtinkerの実行では、create()の3番目のパラメータに、連想配列で値（[’name’ => ’test’]）を渡しました。ということは、以下のtinkerの実行で変数の取り出し可能です。

>>> $request->all();

=> [
     "name" => "test",
   ]

>>> $request->input();

=> [
     "name" => "test",
   ]

>>> $request->name;

=> "test"

>>> $request->input('name');

=> "test"

>>> $request->get('name');

=> "test"
>>>

前回に説明したことが、ここで簡単にシミュレートできるのです。

そして、さらに、こんなこともテストできます。簡単なValidationのテストです。

>>> $request->validate(['name' => 'required']);

=> [
     "name" => "test",
   ]

>>> $request->validate(['name' => 'required|alpha']);

=> [
     "name" => "test",
   ]

>>> $request->validate(['name' => 'alpha']);
=> [
     "name" => "test",
   ]

>>> $request->validate(['name' => 'numeric']);
Illuminate/Validation/ValidationException with message 'The given data was invalid.'
>>>

Validationに成功したら、入力の連想配列を返し、失敗したらValidationExceptionを返します。

tinkerの便利さは、いちいちプログラムを書かずに、ブラウザを立ち上げることなしに、テストできることです。こんな便利なツールを習得せずに、Laravelを語ることはできません。

リクエスト（Request）のあれこれ

Sat, 02 Jun 2018 05:02:11 +0900

Laravelで、リクエスト(Request)というのは、ブラウザを通してユーザーから送られる情報をすべて含んでいるオブジェクトのことです。例えば、会員登録のフォームなら、画面でユーザーが入力したＥメール、パスワード、名前、住所だけでなく、何のブラウザを使用したか（User Agent）、どのIPから送られたか、どのURLからアクセスしたかなど、また、会員ログイン後の画面なら、会員認証において保存されたクッキーもブラウザを介して、リクエストに含まれます。

リクエストの使用

リクエストの代表的な使用は、以下のようにコントローラのメソッドのパラメータです。以下は、Laravelのドキュメントからのコードから引用からですが、会員登録画面でのPOSTされたときにコールされるstoreメソッドです。

UserController.php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * 新規ユーザーの作成
     *
     * @param  Request  $request
     * @return Response
     */
    public function store(Request $request)
    {
        $name = $request->input('name');

        //
    }
}

また、Httpのミドルウェアでも、handle()のパラメータとして利用されています。

RedirectIfAuthenticated.php

use Closure;
use Illuminate\Support\Facades\Auth;

class RedirectIfAuthenticated
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @param  string|null  $guard
     * @return mixed
     */
    public function handle($request, Closure $next, $guard = null)
    {
        if (Auth::guard($guard)->check()) {
            return redirect('/home');
        }

        return $next($request);
    }
}

ミドルウェアと言えば、コントローラのコンストラクタでも$requestにアクセスが可能です。

namespace App\Http\Controllers;

class UserBaseController extends Controller
{
   protected $ip, $userAgent;

   public function __construct()
   {
       $this->middleware(function ($request, $next) {
            $this->ip = $request->ip();
            $this->userAgent = $request->userAgent();

            return $next($request);
        });
 
        //
    }
}

ユーザーの入力値の抽出

先のリクエストのオブジェクトから、ユーザーが入力した値を取り出すには、以下のようにいろいろなメソッドがあります。

まず、入力値を全部とりだす。$inputは、連想配列の変数です。

// 入力値を全部とりだす。
$input = $request->all();

// これも、入力値を全部とりだすが、all()と違ってファイル関連のデータはなし
$input = $request->input();

// これはヘルパー。input()と同じ
$input = request();

フォームからではなく、クエリのデータ、例えば、http://localhost/user?x=10&y=20　のxとyの値　を取り出すには、

$input = $request->query();

ちなみに、all()や、input()には、すでにクエリのデータも含まれています。

今度は、指定した入力値だけを取り出すには、

// 'name'の値を取り出す
$name = $request->get('name');

// これも、'name'の値を取り出す
$name = $request->input('name');

// これも、'name'の値を取り出す
$name = $request->name;

// これはヘルパー
$name = request('name');

いろいろありますね。違いとしては、

入力値が連想配列なら、

つまり、

<form>
    <input type="text" name="items[]['price']" value="100">
    <input type="text" name="items[]['price']" value="200">
</form>

のようなフォームのときは、

$price = $request->input('items.0.price');　// 100を返す
$price = $request->get('items.0.price'); // nullを返す

と、inputは使えますが、get()は使えません。

最後に、例えば、http://localhost/user?name=yamadaのような、クエリからの指定の値を取ってくるには、以下のどれでもＯＫです。

$name = $request->query('name');
$name = $request->input('name');
$name = $request->get('name');

となります。

Laravelの開発に必須な私のツール

Sat, 26 May 2018 02:27:27 +0900

Laravelをウェブアプリの開発の使い始めてから、もうかれこれ5年になろうとしています。Laravelのバージョンも4から5になりさらに進化し続けています。こう経験が長くなると、使用する開発ツールも年々増えてきます。その中で、もうこれがないと開発できない！というものもいくつかあります。

バージョン管理：Git

コードのバージョン管理まったくなしで開発していた時代があったのが信じられないくらい、gitは毎日毎日使用しています。ブランチの作成、差分のチェック(git diff)、コードのマージ(git merge)、プログラムのリバート(git checkout)、ときにハードのリセット(git reset –hard)などなど、もうこれなしでプログラマとして生きていくのは不可能。Laravelだから必要というわけでないですが、ほとんどLaravelの採用とともに、バージョン管理をsubversionからgitに乗り換えてから、後ろを振り向くことはありません。

また、コマンドラインで実行するgitのプログラムだけでなく、それに伴うインフラのサービスも必須です。このブログで紹介しているLaravelの日本語レポジトリは、有名なgithub.comを使用し、プライベートのプロジェクトには、bitbucket.comを使用しています。それぞれ長所、短所ありますが、後者はプライベートのレポをいくら作成しても無料なゆえに開発チームで使用しています。

開発ヘルパー：debugbar

以前にも紹介したツールです。

Debugbarで楽々デバッグ

https://github.com/barryvdh/laravel-debugbar

Laravelのコミュニティーには、Laravelの作者も含めて、賢い人がたくさんいます。debugbarを作成した人もそのひとり。このようなツール、Laravelの以前から欲しかったものです。ブラウザに、現在の画面でLaravelで使用された、リクエスト(Request)、セッション(Session)、DBクエリ(Queries)、認証(Auth)の情報がすべて出てくるので、すぐにコード内の状況がわかります。また、debug()をコードに入れることで、dd()を使用せずに、情報をデバッグ画面に表示できます。最近気づいたことでは、実行したDBクエリーに対応するファイルの行数まで表示されます。嬉しいこと、このうえない！

開発ヘルパー：tinker

これも以前紹介したコマンドツール。

もっとティンカー(tinker)を使おう！

コマンドツールというと、覚えることが多くて大変と思われるかもしれないですが、慣れてくるともう離れられない。プログラムのファイルを作成することなしにちょいちょいとテストできるからです。

そして、Laravel5.5のバージョンでは、嬉しい改善があります。

例えば、Laravel 5.5以前のバージョンでは、

Psy Shell v0.9.3 (PHP 7.1.15 — cli) by Justin Hileman
>>> use App\User;
>>> User::find(5);
=> App\User {#2307
     id: 5,
     name: "hogeuser01",
     email: "hoge01@example.com",
     created_at: "2018-04-04 14:20:37",
     updated_at: "2018-04-04 14:20:37",
   }

今までいちいちとタイプしていたクラスの宣言（上のuse App\User;）を、

Psy Shell v0.9.3 (PHP 7.1.15 — cli) by Justin Hileman
>>> User::find(5);
[!] Aliasing 'User' to 'App\User' for this Tinker session.
=> App\User {#2316
     id: 5,
     name: "hogeuser01",
     email: "hoge01@example.com",
     created_at: "2018-04-04 14:20:37",
     updated_at: "2018-04-04 14:20:37",
   }

このように指定しなくても自動的に探してエイリアスとして覚えてくれるので、1行分のタイプが必要なくなり、ますます使いやすくなりました。

コードチェック：phan

これも以前紹介したコマンドツール。

phanは楽しい！

タイプレスのphp言語にＣ言語のようなタイプチェックをもたらしてくれるツールです。これが開発に貢献する度合いは、すでに紹介したツールと比べて小さいのだけれど、これで発見したエラーは貴重です。改善して欲しいのは、Traitを使用すると誤診の警告が多いこと。将来に期待しています。

テスト：phpunit

アプリの機能が増えるにつれ、コードの複雑さが増してくると、バグの修正であれ機能の変更であれ、他の部分への影響が大きくなります。もちろん、仕様を整理したり、Laravelのようなフレームワークを導入して管理性を高めるのだけれど、人間がなす業、見過ごしや間違いがもちろん起きます。自分自身でないテスターにテストさせても間違いがスルーしてしまいます。

こうした中で、頼りとなってくるのはユニットテスト。単に、今までの機能が変更により壊れていないかを確認してくれだけでなく、今まで作成・蓄積してきた関数の使用方法もテストのプログラムを読むことで理解できます。特にLaravelのバージョンの更新後に、phpunitの実行でエラーがないことを確認するだけでも自分が作成したプログラムに自信が持てます。

最近は、開発自体もまずはユニットテストから始めるテストドリブン（Test Driven Development）の開発に移行しつつあります。もちろん、通常の開発だけに比べてより時間がかかるのですが、その時間が将来に起こるかもしれない、冷っとする経験を少なくしてくれると思うとかけがえのないものです。

その他

他にも開発に関わるツールは、たくさんあります。テキストエディタのsublimeや、仕様管理に使っているGoogle Sheet、スマホもＰＣも一度に閲覧できるブラウザ、blixなどあります。感慨深いのは、5年前にはどれもこれも使用したこともないツールばかり、中にはこの世に存在しないものも。次の5年間はどうなるのでしょう？

Laravelの日本語レポジトリの作成（Laravel 5.5）

Sat, 19 May 2018 05:00:25 +0900

前回に作成したLaravelの日本語のリポジトリ（Laravel 5.5）。今回はその作成の仕方を説明します。ほとんどは、Laravel 5.4のときと同じですが、いくつか違いがあります。

コマンドの実行

まずは、以下のcomposerのコマンドを実行します。

composer create-project --prefer-dist laravel/laravel larajapan "5.5.*"

上で使用されているコマンドの引数は、

–prefer-dist laravel/laravel

https://packagist.org/packages/laravel/laravelからパッケージをダウンロードすることを指示します。

larajapan

パッケージのダウンロード先。その名前でディレクトリを作成します。このディレクトリ名は、先のコマンドラインで違う名前を指定可能であるし、実行完了してから改名も可能です。

5.5.*

パッケージのバージョンを指定。ここでは、laravelの5.5を使用します。マイナーバージョンを指定したいなら、5.5.40のように指定します。

実行すると、パッケージに含まれるファイル、さらにパッケージが依存するパッケージのファイルが多数ダウンロードされ少々時間がかかります。

最終的には、実行したディレクトリのもとにlarajapanのディレクトリが作成され、ダウンロードされたファイルが収納されます。

larajapan
├── app/
├── bootstrap/
├── config/
├── database/
├── public/
├── resources/
├── routes/
├── storage/
├── tests/
├── vendor/
├── artisan
├── composer.json
├── composer.lock
├── package.json
├── phpunit.xml
├── readme.md
├── server.php
└── webpack.mix.js

次に、ユーザー認証のためのファイル作成を以下の実行で行います。

php artisan make:auth

この実行により、resources/viewsのディレクトリにおいて、すでにインストールされている以下のコントローラで使用されるbladeファイルが作成されます。

app/Http/Controllers
├── Auth/
│   ├── ForgotPasswordController.php（パスワードのリセットのリンク送信画面）
│   ├── LoginController.php（ログイン画面）
│   ├── RegisterController.php（会員登録画面）
│   └── ResetPasswordController.php（パスワードリセット画面）
├── Controller.php
└── HomeController.php（ログイン後のホーム画面）

最後に以下のコマンドを実行して、先のパスワードのリセットのリンク送信画面から発行されるＥメールで使用されるHTMLのテンプレートを作成作成します。

php artisan vendor:publish

5.4と違って、上の実行は以下のような選択が出てきますが、0を選択してすべてをインストールします。

 Which provider or tag's files would you like to publish?:
  [0] Publish files from all providers and tags listed below
  [1] Provider: Fideloper\Proxy\TrustedProxyServiceProvider
  [2] Provider: Illuminate\Mail\MailServiceProvider
  [3] Provider: Illuminate\Notifications\NotificationServiceProvider
  [4] Provider: Illuminate\Pagination\PaginationServiceProvider
  [5] Provider: Laravel\Tinker\TinkerServiceProvider
  [6] Tag: laravel-mail
  [7] Tag: laravel-notifications
  [8] Tag: laravel-pagination
 > 0

Copied Directory [/vendor/laravel/framework/src/Illuminate/Notifications/resources/views] To [/resources/views/vendor/notifications]
Copied Directory [/vendor/laravel/framework/src/Illuminate/Pagination/resources/views] To [/resources/views/vendor/pagination]
Copied File [/vendor/fideloper/proxy/config/trustedproxy.php] To [/config/trustedproxy.php]
Copied Directory [/vendor/laravel/framework/src/Illuminate/Mail/resources/views] To [/resources/views/vendor/mail]
Copied File [/vendor/laravel/tinker/config/tinker.php] To [/config/tinker.php]
Publishing complete.

日本語化

さて、ここからが日本語化の作業です。

まず、config/app.phpの編集から。

config/app.php

                                                                                                                                                                                                                                                                                                                                                   
...
    'timezone' => 'UTC',                                                                                                                                                                                                                                                                                                               
                                                                                                                                                                                              
    'locale' => 'en',
...

を

config/app.php

                                                                                                                                                                                                                                                                                                                                                   
...
    'timezone' => 'Asia/Tokyo',                                                                                                                                                                                                                                                                                                               
                                                                                                                                                                                              
    'locale' => 'ja',
...

と変えて保存します。

timezone

これは、通常、プログラム内の日時設定のタイムゾーンとして使用されるもので、PHPの以下の関数で使用されます。

date_default_timezone_set()

ここで設定すれば、後はLaravelが面倒みてくれます。

日本時間の場合は、Aisa/Tokyoの設定だけで十分。

locale

resources/langで言語のファイルが以下のように存在します。これらは、Laravelのプロジェクトでバリデーションのエラーメッセージなどを定義しています。

resources/lang
└── en/
    ├── auth.php
    ├── pagination.php
    ├── passwords.php
    └── validation.php

デフォルトの設定では、英語のenのディレクトリしかありません。日本語の翻訳を作成するには、上で設定したjaと同じ名前のディレクトリをそこに作成します。以下の実行でディレクトリごとコピーしてください。

$ cp -pr en ja

バリデーションに関しては、見米氏のバリデーション（１）Validatorファサードのextend　を参照してください。

今回は、新しく追加されたバリデーションの以下のエントリーもあります。

after_or_equal before_or_equal

次は、ユーザー認証画面などで使用されるブレードファイルの翻訳です。

私のLaravelの日本語レポジトリでは、以下は、すべて翻訳してあります。

resources/views
├── auth
│   ├── login.blade.php
│   ├── passwords
│   │   ├── email.blade.php
│   │   └── reset.blade.php
│   └── register.blade.php
├── errors
│   └── 404.blade.php
├── home.blade.php
├── layouts
│   └── app.blade.php
├── vendor
│   ├── mail
│   │   ├── html
│   │   │   ├── button.blade.php
│   │   │   ├── footer.blade.php
│   │   │   ├── header.blade.php
│   │   │   ├── layout.blade.php
│   │   │   ├── message.blade.php
│   │   │   ├── panel.blade.php
│   │   │   ├── promotion
│   │   │   │   └── button.blade.php
│   │   │   ├── promotion.blade.php
│   │   │   ├── subcopy.blade.php
│   │   │   ├── table.blade.php
│   │   │   └── themes
│   │   │       └── default.css
│   │   └── markdown
│   │       ├── button.blade.php
│   │       ├── footer.blade.php
│   │       ├── header.blade.php
│   │       ├── layout.blade.php
│   │       ├── message.blade.php
│   │       ├── panel.blade.php
│   │       ├── promotion
│   │       │   └── button.blade.php
│   │       ├── promotion.blade.php
│   │       ├── subcopy.blade.php
│   │       └── table.blade.php
│   ├── notifications
│   │   └── email.blade.php
│   └── pagination
│       ├── bootstrap-4.blade.php
│       ├── default.blade.php
│       ├── semantic-ui.blade.php
│       ├── simple-bootstrap-4.blade.php
│       └── simple-default.blade.php
└── welcome.blade.php

5.4と比べて異なるのは、paginationにsemantic-ui.blade.phpが追加されています。errorsのフォルダーは例として追加しました。

パスワードリセットで送信されるＥメールの翻訳

ここまで来ても、残念ながら、パスワードを忘れたときに送信される、パスワードリセットを含むＥメールの内容がまだ翻訳されていません。なぜなら、本文がハードコードされているからです。

これはちょっと頭をひねりましたが、多分以下が最小の変更で対応できると思います。

まず、

vendor/laravel/framework/src/Illuminate/AuthのディレクトリからResetPassword.phpとCanResetPassword.phpのファイルを以下の場所にコピーします。

app/Auth
├── Notifications/
│   └── ResetPassword.php
└── Passwords/
    └── CanResetPassword.php

次に、以下のようにファイルを編集します。app/User.phpのファイルも変更必要です。

app/Auth/Notifications/ResetPassword.php

namespace App\Auth\Notifications;                                                                                                                                                             
                                                                                                                                                                                              
use Illuminate\Notifications\Notification;                                                                                                                                                    
use Illuminate\Notifications\Messages\MailMessage;                                                                                                                                            
                                                                                                                                                                                              
class ResetPassword extends Notification                                                                                                                                                      
{                  
...
    /**                                                                                                                                                                                       
     * Build the mail representation of the notification.                                                                                                                                     
     *                                                                                                                                                                                        
     * @param  mixed  $notifiable                                                                                                                                                             
     * @return \Illuminate\Notifications\Messages\MailMessage                                                                                                                                 
     */                                                                                                                                                                                       
    public function toMail($notifiable)                                                                                                                                                       
    {    
        return (new MailMessage)
            ->subject('パスワードリセット')
        　　->greeting('パスワードリセット')
            ->line('パスワードリセットリンクの送信のリクエストがありました。')
            ->action('リセットパスワード', url(config('app.url').route('password.reset', $this->token, false)))
            ->line('リクエストされていなかったら、無視してください。');                                                                                                          
    }     
}

app/Auth/Passwords/CanResetPassword.php

namespace App\Auth\Passwords;                                                                                                                                                                 
                                                                                                                                                                                              
use App\Auth\Notifications\ResetPassword as ResetPasswordNotification;                                                                                                                        
                                                                                                                                                                                              
trait CanResetPassword                                                                                                                                                                        
{                                                                                                                                                                                             
    /**                                                                                                                                                                                       
     * Get the e-mail address where password reset links are sent.                                                                                                                            
     *                                                                                                                                                                                        
     * @return string                                                                                                                                                                         
     */                                                                                                                                                                                       
    public function getEmailForPasswordReset()                                                                                                                                                
    {                                                                                                                                                                                         
        return $this->email;                                                                                                                                                                  
    }                                                                                                                                                                                         
                                                                                                                                                                                              
    /**                                                                                                                                                                                       
     * Send the password reset notification.                                                                                                                                                  
     *                                                                                                                                                                                        
     * @param  string  $token                                                                                                                                                                 
     * @return void                                                                                                                                                                           
     */                                                                                                                                                                                       
    public function sendPasswordResetNotification($token)                                                                                                                                     
    {                                                                                                                                                                                         
        $this->notify(new ResetPasswordNotification($token));                                                                                                                                 
    }                                                                                                                                                                                         
}

app/User.hpp

                                                                                                                                                                                              
namespace App;                                                                                                                                                                                
                                                                                                                                                                                              
use Illuminate\Notifications\Notifiable;                                                                                                                                                      
use Illuminate\Foundation\Auth\User as Authenticatable;                                                                                                                                       
use App\Auth\Passwords\CanResetPassword;                                                                                                                                                      
                                                                                                                                                                                              
class User extends Authenticatable                                                                                                                                                            
{                                                                                                                                                                                             
    use Notifiable;                                                                                                                                                                           
    use CanResetPassword;                                                                                                                                                                     
...

認証のroutesの設定

日本語化とは関係ないですが、私がこうした方がわかりやすいと思ったことです。

オリジナルのroutes.phpは、

routes/web.php

Route::get('/', function () {
    return view('welcome');
});

Auth::routes();

Route::get('/home', 'HomeController@index');

とシンプルですが、Auth::routes()で認証のrouteが隠されてしまって不透明。

ということで、私のLaravelの日本語レポジトリでは、以下のように編集しました。

routes/web.php

// 以下は、Auth::routes()の中身を移したもの。将来において変更が可能なように                                                                                                                   
                                                                                                                                                                                              
// Authentication Routes...
Route::get('login', 'Auth\LoginController@showLoginForm')->name('login');
Route::post('login', 'Auth\LoginController@login');
Route::post('logout', 'Auth\LoginController@logout')->name('logout');

// Registration Routes...
Route::get('register', 'Auth\RegisterController@showRegistrationForm')->name('register');
Route::post('register', 'Auth\RegisterController@register');

// Password Reset Routes...
Route::get('password/reset', 'Auth\ForgotPasswordController@showLinkRequestForm')->name('password.request');
Route::post('password/email', 'Auth\ForgotPasswordController@sendResetLinkEmail')->name('password.email');
Route::get('password/reset/{token}', 'Auth\ResetPasswordController@showResetForm')->name('password.reset');
Route::post('password/reset', 'Auth\ResetPasswordController@reset');                                                                                                                
                                                                                                                                                                                              
Route::get('/home', 'HomeController@index');

Debugbar

このバージョンから、開発に非常に有用なDebugbarがdevの環境だけにインストールできるようになりました。プロダクションの環境にインストールする必要はありません。

以下の実行により、composer.jsonが編集されvendorのディレクトリにライブラリがインストールされます。

$ composer require barryvdh/laravel-debugbar --dev

また、Laravel 5.5のauto-discoveryの機能により、以前のようにconfig/app.phpで設定の必要もありません。

しかし、今までコード内で、debug()を使用していてそれを残しておくと、プロダクションにおいて関数未定義のエラーが出ます。防ぐには、以下のように、bootstrap/app.phpで空の関数を定義しておきます。

bootstrap/app.php

/*
|--------------------------------------------------------------------------
| Create The Application
|--------------------------------------------------------------------------
|
| The first thing we will do is create a new Laravel application instance
| which serves as the "glue" for all the components of Laravel, and is
| the IoC container for the system binding all of the various parts.
|
*/

$app = new Illuminate\Foundation\Application(
    realpath(__DIR__.'/../')
);

// no-dev でエラーにならないように定義

if (!function_exists('debug')) {
    function debug($value)
    {
    }
}
..

その他

インストールにおいて経験した問題として、

php artisan migrate

を実行したときに、以下のエラーとなりました。

 [Illuminate\Database\QueryException]
SQLSTATE[42000]: Syntax error or access violation: 1071 Specified key was too long; max key length is 767 bytes (SQL: alter table users add unique users_email_unique(email))

[PDOException]
SQLSTATE[42000]: Syntax error or access violation: 1071 Specified key was too long; max key length is 767 bytes

これは、使用しているデータベースがMariaDBで10.2.2のバージョンより古いか、あるいはMySQLで5.7.7より古いときに起こるエラーです。Laravelは5.4より、絵文字対応のutf8mb4のエンコーディングがデフォルトとなりました。

古いバージョンを使用する場合（大半がそうでは？）は、以下の変更が必要となります。日本語のレポにはこの変更が含まれています。

app/Providers/AppServiceProvider.php

namespace App\Providers;                                                                                                                                                                                           
                                                                                                                                                                                                                   
use Illuminate\Support\ServiceProvider;                                                                                                                                                                            
use Illuminate\Support\Facades\Schema;                                                                                                                                                                             
                                                                                                                                                                                                                   
class AppServiceProvider extends ServiceProvider                                                                                                                                                                   
{                                                                                                                                                                                                                  
    /**                                                                                                                                                                                                            
     * Bootstrap any application services.                                                                                                                                                                         
     *                                                                                                                                                                                                             
     * @return void                                                                                                                                                                                                
     */                                                                                                                                                                                                            
    public function boot()                                                                                                                                                                                         
    {                                                                                                                                                                                                              
        Schema::defaultStringLength(191);                                                                                                                                                                          
    }                                                                                                                                                                                                              
                                                                                                                                                                                                                   
    /**                                                                                                                                                                                                            
     * Register any application services.                                                                                                                                                                          
     *                                                                                                                                                                                                             
     * @return void                                                                                                                                                                                                
     */                                                                                                                                                                                                            
    public function register()                                                                                                                                                                                     
    {                                                                                                                                                                                                              
        //                                                                                                                                                                                                         
    }                                                                                                                                                                                                              
}

Laravelの日本語のレポジトリ（Laravel 5.5）

Sun, 13 May 2018 05:52:32 +0900

Laravelの日本語のリポジトリをLaravel5.5に更新しました。もうLaravel5.6がリリースされていますが、Laravel5.5は長期サポート（2年間）のバージョンなゆえに重要です。前回同様に、以下インストールの手順です。

このバージョンでは、PHP >= 7.0.0が必須となりますので現在のPHPのバージョンをチェックしてください。過去のバージョンは以下を参照してください。 Laravel 5.4
Laravel 5.3

Laravelにおいて新規のプロジェクト作成はとても簡単。コマンドラインでいくつかのコマンドを実行をちょちょいとすれば完了。しかし、インストールされるのは英語のプロジェクト。テンプレートやメッセージの翻訳をいちいちしなければ日本語のプロジェクトにはならない。

ここのプロセスを簡単にと、Laravelバージョン5.5をもとに、開発者のために日本語化したレポジトリを作成してみました。

このレポジトリには、

デフォルトのユーザー認証の機能：会員登録、パスワードリセット、会員ログイン
日本語に翻訳されたデフォルトのテンプレートとＥメールメッセージ
日本語に翻訳されたデフォルトの入力エラーメッセージ
デバッグのためのDebugbarツール
ウェブ解析ツールGoogle Analyticsのトラッキングスクリプト

以上を含みます。

さらに、今回は、実際動作するデモとして以下に用意しました。 https://larajapan.lotsofbytes.com/larajapan

さて、このレポジトリのインストールは以下の手順で簡単にできます。

レポジトリのインストール

SSHを利用しているなら、以下をコマンドラインで実行してレポジトリをインストールします。

$ git clone -b 5.5 git@github.com:lotsofbytes/larajapan.git

あるいは、Httpsを使用するなら、以下を実行します。

$ git clone -b 5.5 https://github.com/lotsofbytes/larajapan.git

実行後は、larajapanのディレクトリが作成されますが、お好きな名前に改名してもらってＯＫです。

その後、

cd larajapan

それから、ファイルのパーミッションを与えるべく以下を実行。

$ chmod -R a+w bootstrap/cache
$ chmod -R a+w storage

インストール後は、以下を実行してください。

$ composer install

.envの編集

.env.example をコピーして、.env　を作成し編集して以下のように設定します。*****の部分を適切な値に変更してください。

APP_NAME=私のララベル APP_ENV=local APP_KEY= APP_DEBUG=true APP_LOG_LEVEL=debug DB_CONNECTION=mysql DB_DATABASE=***** DB_USERNAME=***** DB_PASSWORD=***** MAIL_DRIVER=sendmail

その後、以下を実行して.env内のAPP_KEYを更新します。

$ php artisan key:generate

APP_DEBUG=trueこれによりDebugbarが画面下方に表示されます。Debugbarに関しては、Debugbarで楽々デバッグも読んでください。

また、 ANALYTICS=UA-XXXXXXのようにサイトのためにGoogleから取得したコードを設定すれば、Google Analyticsでウェブでのユーザーの動向が追跡できます。

DBを作成

.envで指定したDBを作成。

$ echo 'CREATE DATABASE mydatabase CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci' | mysql -u root -p

php artisan migrate

ウェブサーバーの立ち上げ

最後に以下を実行して、ウェブサーバーを立ち上げると、

$ php artisan serve

以下のアドレスでブラウザーからアクセスできます。

http://localhost:8000

以上です。

上の設定は私の開発環境Fedora LinuxとAmazon Linux OSで、7.0のバージョンのPHPで、DBにはMysqlあるいはMaria DBを使用して動作確認しています。しかし、皆さんの環境ではいろいろ異なることがあると思います。問題や指摘があれば、ご連絡ください。