作りたいものがありすぎる

40歳を過ぎてプログラミングを始めた人の顛末とこれからなど

Laravel unit test dataProvider で変数やconfig 使う場合

コードとコメントで全部表してますがこんな感じ。

unitテストにしろFeatureテストにしろ、データプロバイダを使って、test用の配列データを作るというのは良くやるかと思いますが、 unitテストで データプロバイダ使う際には、

$this->createApplication();

というのを最初に書いてやらないと駄目らしいです。(laravel6系で確認)

    /**
     * データプロバイダ
     * @return array
     */
    public function hogeParams()
    {
        // unitTestでは DataProviderにこれが必要
        $this->createApplication();
        // 上のを入れないとdataProvider内でこんなのが使えなくなる
        $otherId = config('const.hoge-id');

        // この辺にTestで使う配列を記述
        return [
            // 配列宣言
        ];
    }

$this->createApplication();を書かないとこんな風に怒られる

There was 1 warning:

1) Warning
The data provider specified for Tests\Feature\HogeTest::postValidateRequiredIfTest is invalid.
Target class [config] does not exist.

WARNINGS!
Tests: 1, Assertions: 0, Warnings: 1.

追記:

ノウハウとして、$this->createApplication();とだけ書けば良い。という理解でもいいのだけど、これ、実は Laravelのtestsディレクトリにある以下のメソッドを呼んでいるってことですね。

\tests\CreatesApplication.php

<?php

namespace Tests;

use Illuminate\Contracts\Console\Kernel;

trait CreatesApplication
{
    /**
     * Creates the application.
     *
     * @return \Illuminate\Foundation\Application
     */
    public function createApplication()
    {
        $app = require __DIR__.'/../bootstrap/app.php';

        $app->make(Kernel::class)->bootstrap();

        return $app;
    }
}

これ、確かLaravel自体をアプリケーションとまず動かす奴で index.php とかから追える処理で書いている事と基本は同じですね。つまり unit test単体として完結した ピュアなphpunit 環境でtestさせるんじゃなくて、laravelとして動かして動作検証するというか、そんな感じ。 詳しく追ってないけど DataProvider という機能自体がLaravel固有のものなのかな?そんな気がする。

10万円給付金を無限に使う仕組み

コロナウイルスで大変な事になっている地球の皆さんこんにちは。私も大変です。

日本政府が国民一人あたり10万円を給付するとか、しないとか、足りないやばい。みたいな話になってますが、これは今その問題を解決する方法ではなく、先々の事を考えての提案というか妄想です。

半分ネタみたいな話ですが、実は結構前から色々考えていたことの一つの答えみたいなものが、ここ数ケ月で発酵してきたので、アウプトプットしておこうと思います。まあコロナウイルスに感染して死んじゃう可能性も0じゃないので。

では先に結論。

何処の国でも良いです。その国の政府は国民一人あたり日本円でおよそ10万円を数か月配り続ける予算を使って(後払いでもOK)再分配が可能なスマホアプリの電子通貨システムを発注するなり作るなりして欲しいです。そうすれば結構多くの人がピンチを脱したり、幸せになったりするかもしれないよ。という話。

は?お前何言ってんの?というツッコミを無視して話を続けます。

政府が確約することは

  • そのシステムの利用者はこの国のこの人で間違いない事を証明する
  • そのシステムを維持運営する予算を毎年出す
  • これは確かにウチの国のお金ですよ、と確約すること

です。

誰だお前

そもそもお金とは何か?とか、そういう話を10年以上延々調べたり考えて、新しい経済システムを作りたくてプログラム覚えてプロトタイプを作ったりして現在は職業プログラマーのおっさんです。

でもまあ仕組を考えて、ショボくても自分で作れても、皆がそれに価値を感じて使ってもらわないとそれは「お金という仕組み」にはならない訳です。

でもビットコインだって最初は冗談半分でピザと交換されたのに、今や普通に取引されています。羨ましいぞサトシナカモト。

お金大事、なのに稼げない

さて、そのお金ですが、日本のお札には日本銀行券、って書いてありますが、最近流行りのスマホの「なんちゃらペイ」にあるポイントと、日本銀行券って同じお金ですよね?ゲームに出て来る「ゴールド・ルピー」なんていう「ゲームのマネー」と見た感じ大して違いはないのに、レジてピッってやればちゃんと使える。便利。 そして、足りなくなったら、クレジットカードとか銀行のお金でチャージすればいい。すげー便利。 でも銀行に振り込まれるそもそものお金は、働かないと枯渇する。チャージもできなくなる。何も買えなくなるかも。でも働くに働けない状態が、まだ続きそうですげー不安。

だから政府が国民の生活を守る為に、支援金を配るべきだというのはもっともだと思います。

要は国民全員の銀行口座にピッってチャージして欲しいわけです。で、当面は毎日生きるのに必要な食べ物や電気の支払いや生活必需品を買えて、なんとか生きていける様にして欲しい。

でも、本当に全員なの?とか、早くしろよ、とか、もっと給付されないと全然ヤバイ、とか喧々諤々やってるあいだにも、仕事は出来ず、残高はひっ迫し、気持ちに余裕が無くなる。

そういうの本当に辛いと思います。まかり間違えば病気やお金で絶望して死ぬかもしれないなんて本当にしんどい。

でも、こんな時に私個人ができることって仕事以外であんまりない。なので、ちょっと非現実的だけど、もしできたら良いな。みたいな話として読んでください。

私はお金の歴史に学んで、新しいタイプの電子マネーのようなものを作りたい。と考えています。

f:id:sakamata:20200508004807p:plain

どういう仕組みか?

政府主導のスマホアプリ

生活に必要な最低限の額(以降『ポイント』と呼称)が、毎月でも、週に1度でも、毎日、でも良いです。きちんとチャージされる様になる仕組みです。

ひとまず、一月あたりで一人10万ポイント

で、このアプリ、スマホ同士でポイントをやり取りできます。レジの機械でピッってやるのが難しいなら、私でも作れるQRコードとかで送り合えるものでも良いです。つまり個人のスマホ同士でポイントをやり取りできる。QRコードだから、遠くの人ともやり取りできます。

スマホ持ってない」とか、「うまく使えない」って人は最初の月に給付される10万円の替わりにアプリの入ったスマホを配布してもらうなり、購入するなりして通信会社と契約してもらいます。デジタルデバイドの問題は、それこそこの給付金である程度なんとかできると思ってます。

そして政府が「これ、お金として使えます」って言えば良いだけ

むしろ、この「なんちゃらペイで払います」って言ったのに、お店とか売る側が、「そんな変なマネーじゃ駄目だ、福沢諭吉よこせ!」みたいに受け取り拒否をすると、むしろ罰金にするとか、罰則設けても良い位です。だってお金なんだもん。

でも、そうなれば、私たちはこれで毎月の最低限の生活をまかなうことができる訳です。これでスーパーやコンビニで食料買っても良いし、電気代を払っても良い。家賃を払っても良いわけです。そして当然これは国が「お金として使えます」って言っているので、給料として社長が従業員に配っても良い訳ですよ。

スーパーやコンビニはレジに自分の店のスマホの口座のQRコードを紙に印刷しておけばOK(法人端末がー!とか問題があるなら、この際店長さん個人の端末とかでも良いです)会計の時に、提示された金額が確かに自分のスマホに振り込まれた事だけを確認できれば良いわけです。

電気も家賃も同様です。ウェブサイトに法人口座に相当するスマホQRコード張っておけば支払いができる訳です。

だれが払ったのか?スマホアプリなら管理や証明が可能です

要は銀行の口座がアプリになっている様なものなので、誰からポイントが送られて、誰に送ったか?が、最初から通帳とか確定申告の時の資料の様に管理出来てるわけです。

でも、「誰とやり取りしたらわかるとか嫌」とか、「エッチな本の購入履歴とかマジ勘弁」となるので、電話番号とか名前じゃなくても、それに紐づけた暗号化されたIDでも、そのアプリの利用者の一意の情報が利用者全員がお互いにわかっていれば、まあ問題ないかと。

そんなこと言って月10万とか財源どうすんだ!

と思うかもしれません、確かに最初の製作費と月々の維持管理費はそれなりにかかると思いますが、それでもせいぜい、超有名なウェブサービスの運営費位か、それ以下でなんとかなると思います。上手くいけば、銀行のATMをはじめとした口座システム開発費や維持費よりも安価になると踏んでます。そして…

月10万の財源は、皆さんが毎月やり取りをする月10万ポイントから徴収します

なにを言っているのかというと、このシステム、3か月位一切使わないで放置していたらどうなるか?

合計30万が振り込まれていると、思うじゃないですか?

ところがどっこい、残高は10万です。

つまり使って無いと、その分は他の人の財源に回されます。 毎月10万、きっちり使って残高を0にすれば次の月はまた10万入ります。

逆に言うと、月末に30万位溜まっていても、最高で残高10万位まで減らされます。でも、全部は取られませんし、必ず全員が一定量のポイントを国から保障される訳です。

この理不尽な現象に名前を付けるとすれば『所得税』とでもいいましょうか。でも、このシステムを使っていれば毎月10万は必ずもらえる。つまりベーシックインカム型、再分配機能内包の通貨システム』という訳です。

さて、これでは支払いをされる側があまりにも損をしますが、損をしないタイプの説明をする前に、ひとまず現状の数字の流れの全体像を具体的に説明します。

仮に、このなんちゃらポイントの参加者が10名だとしましょう。最初の月に全員に10万ずつが渡り、政府の支払いは100万になります。

10人は生活の為にお互いのモノやサービスとポイントを交換します。現在仕事が出来ずほとんどが生活費で消える人のポイント残高は、ほぼ0に近くなり、逆に今も運よく仕事があったり、モノやサービスを多く提供した側には、20万の儲けが出たとしましょう。

仮に利用開始から一か月が経つ頃に、10人中3人が30万溜まったとすると、10万(最初から)+20万(儲け)3人の合計は90万 そして残り7人のわずかな額を合計をするとちょうど10万となります。そして全体で見ると 90万 + 10万 で合計100万、合計額は当然変わりません。

そして月末になると、30万の口座の人は20万が引かれ、残高10万。 3×20=60万を残りの7人に分けて全員が10万に戻る。という訳です。

もっとも、これはずいぶん極端な例で、「頑張って働いたのに20万も取られるなんてふざけてる!」と思ったかもしれませんが、当然です。なのでルールを少し変えまましょう。

30万バラマキからスタートするともっと嬉しい

今度は3か月目までは、新規で10万ずつが必ず振り込まれるとしたらどうでしょう?つまり3か月放置すると30万迄きちんと溜まります。その時点での10人全員での合計は300万です。ベースラインをあげた上で、毎月10万を必ず全員に配る分だけを全体の余剰から集めます。

今度もさっきと同様に3人の一月の儲けが+20万だったとしましょう。 元々全員が30万溜まった所からスタートしたので、儲けた3人が持っているのは 30+20= 50万です。 これが3人で合計150万。 残りの7人が持っている合計額は、全体の300万から150万を引いて、150万です。(さっきは10万だったのに!)

これなら残高10万未満の人に負担する額は、前よりも少なくて済む事がわかるかと思います。運が良ければ再分配もしなくて済むかも!

…というのも実は極端な話で、実は総額が増えた分、インフレが起こるのと、流動性が上がって云々、となるので、実はそんなに上手くは行きませんが、全体として余裕が生まれるのはわかるかと思います。

さらに考えを極端にしてみます。 もっと財源を豊富にしましょう。そしてある程度残高が溜まってから取られるルールをもっと甘くしましょう。100万から1万だけ引かれる様にする?それとも400万位から50万位にする?1000万なら300万位?より溜まった人からはより多く取った方が良い? …なんとなく従来のお金の仕組と『所得税』に似てきましたね。つまりそういう事です。

じゃあ、このバランスをどのへんで保つのか?というのが大きな問題であるにはちがいないですが、たぶん福祉国家を目指すなら、このゲームの参加者全員が「健康で文化的な最低限度の生活」が出来る位、毎月配分される位がちょうど良いのではないでしょうか?

そしてこのゲームを10人ではなく何億人という単位でやる訳です。

つまり、このシステムで徴収された金額は確実に他の参加者の為に使われ、新規のポイント発行も上の例だと、3か月目以降はなくなり、毎月必ず全員に10万位が手に渡ります。しかもその合計は常に一定で、中で数字が循環するだけ。という仕組みです。 なので、ぶっちゃけると国家が運営する「お金」「税金」「社会福祉」や「再分配」という仕組みを、デジタルマネーの仕組ですべてやってしまおう。ということです。でもその税金は既にこの仕組みの中自体で取って再分配されているので、これ以上税金を取られる必要性も意味も無い訳です。

なんか騙されてる気がしないでもないですが、私に言わせれば、実は従来のお金の仕組自体が絶妙に人を欺いた仕組だと思ってます。

さて、ではこのなんちゃらペイシステムで「所得税」がどんな配分になったとしても、絶対に損をしない方法をあらかじめ言っておきます。現在の経済状況がどんなに豊かな人も、大ピンチの人も、この戦略はほぼ一緒です。

『次の再分配の日までに残ってるポイントを全部使いきること』

たったこれだけです。

宵越しの金を持たなければ、自分の持ち金は絶対減らないのです。さらに必要最低限の額は再度支給されるのです。

f:id:sakamata:20200508004846p:plain

ベーシックインカム反対の意見でよく出るのが「税源をどうするんだ」とか「全員にお金が支給されたら、誰も働かなくなる」という話がありますが、この仕組みの中で財源は、投資した額だけが中で循環するのみですし、再分配されるのは、健康で文化的な生活をする為の最低限の額だけです。それでも足りない分は従来通り、ある程度働くなり従来の社会福祉を利用するなり、周囲の人たちと支え合う必要があります。しかも今は、コロナウイルスの為に働くに働けない状況の人が格段に増えています。そんな中でこのような仕組みがもし実現できれば、誰にとっても生きるのに必要な最低限をシンプルに保障する。という点でそれなりの効果が期待できるのではないでしょうか。

じゃあ、もう一度。

この仕組みで政府が確約することは

  • そのシステムの利用者はこの国のこの人で間違いない事を証明する
  • そのシステムを維持運営する予算を毎年出す
  • これは確かにウチの国のお金ですよ、と確約すること

というのを是非やってくれると、結構うまくいくと思うんですが、どうなんでしょう。夢物語みたいなものだからなかなか難しいかもしれません。 財源は上の例なら国民1人あたり30万ぽっきりで、そっから先は内部のポイントを循環させますので、それ以上にお金がかかる心配もない。維持費の支払いさえ内部のポイントでやっても良いんじゃないかって位です。

しかし、こんな酔狂を本気にしてくれる政府が現れない場合のプランも当然考えていて、どっちかというとこっちが理想で本命です。

要は上のルールをこんな感じで少し変えれば良いと思ってます。

  • そのシステムの利用者はこの人で間違いない事を他の利用者や第三者に証明してもらう
  • そのシステムを維持運営する予算は利用者同志が出す
  • このスマホアプリのポイントは確かにお金ですよ、と利用者同志が合意し確約する

です。

そのシステムの利用者はこの人で間違いない事を他の利用者や第三者に証明してもらう

一番目が必要な理由は、複数のスマホを持っていたら追加でさらに10万貰える、という二重取得を避けるためです。一人1アカウントが前提の仕組なのでこの辺が必須になります。

そのシステムを維持運営する予算は利用者同志が出す

二番目は運営、お札や貨幣といったモノとしてのお金ではない為、二重会計や不正等の怪しい計算がされることなく、健全な運営維持が続くことが信頼の根拠になります。そして誰がそれを保証し続けるのか?が問題になります。ビットコインなどは独立したアプリケーションと、ブロックチェーンという、個々の端末に共通の暗号化された全員の通帳を持つ的な人の介在しない仕組自体が、それを維持してます。

このスマホアプリのポイントは確かにお金ですよ、と利用者同志が合意し確約する

三番目が特に難しい気がしますが、この仕組みがとても安心して信頼できるようになり、お互いがこの仕組みに騙されても良い。と考える人が増えれば上手くいくはずです。すでにビットコインがある意味でそうなっていますし、既存の「お金」という仕組そのものが既にそうなってますので。

ということで、このシステムを作って、これでピザを売ったり買ったりしてくれる人を募りたい、というのが私の当面の目的です。誰かよかったら一緒にやりましょう。

ちなみに、この仕組みの元ネタを知りたい人は「ゲゼル」とか「自由貨幣」とかとかでググってみてください。

上記の説明は簡略化したもので、実は考えなきゃいけないルールや仕組、起こりえる問題点は多々あります。例えば再分配の時間が決まっていた場合、必ず損をする人が出て来る問題や、既存の通貨との両替や交換、この仕組みを使っての投資や借金はどうなるの?といった問題がありますが、それはいずれかの機会に説明したいと思ってます。

また過去に私が作ったプロトタイプとか(今ちゃんと動きません)いままで考えた事の軌跡はここにあるので、興味があれば見てやってください。

Happy Project 新しい通貨概念をデザインしよう

さすがにプログラマー業界も景気が悪くなってきたので、私も暇ができてしまうかもしれません。なので時間が余ったら新しい技術を学びながら、ショボくて良いのでもまずはこれを作ります。まあ、現状での利用してもらえる信頼度は0ですし、課題も山積みですが、いつか0より大きくしたいと思ってます。

Laravel本番環境が local 設定で動いていて焦った話

本番環境での composer コマンドに注意

10分程本番環境を止めてしまった。とはいえ普段はSlackの通知ばかりでサイト本体は人がほとんど見てないのでたぶんセーフだ。(本当か?)

まず結論

本番環境の composer install では 以下のオプションを付けないと、 dev環境の dusk 等も本番にインストールされてしまうケースがあるかもしれない。最悪動作しなくなるので注意。(envの設定によっては不要かもしれないが未検証)

Exception: It is unsafe to run Dusk in production. · Issue #289 · laravel/dusk · GitHub

composer install --no-dev

そもそも論

これまで本番環境の .env の APP_ENV の設定値が localのままだった、これのせいで composer installでlocal環境での phpunitや諸々が本番環境にも入ってしまっていたようだ。

従ってまず .envの 値を以下の様に書き換えた

本番before

APP_ENV=local

本番after

APP_ENV=production

ここが最初から productionに設定してあれば、そもそも今回の問題は起こっていないかもしれない。

.env を書き換えた後にconfig:clearの際に出たerror

$ php artisan config:clear

In DuskServiceProvider.php line 43:
                                           
  It is unsafe to run Dusk in production.  
                                           

これ、たしかローカル環境でも散々悩んだ DuskがLaravel5.6 ではにっちもさっちも行かなくなった際のerrorで、vendor の dusk内のメソッドで返り値の型宣言しないとerrorになる関係の奴だったと思う。

で、この後composer updateをやったら以下の様な error が出た

#色々あって最後の方
  - Installing composer/semver (1.5.1): Downloading (100%)         
  - Installing composer/ca-bundle (1.2.6): Downloading (100%)         
  - Installing composer/composer (1.10.1): Downloading (100%)         
  - Installing barryvdh/reflection-docblock (v2.0.6): Downloading (100%)         
  - Installing barryvdh/laravel-ide-helper (v2.6.7): Downloading (100%)         
symfony/event-dispatcher-contracts suggests installing psr/event-dispatcher
symfony/service-contracts suggests installing symfony/service-implementation
barryvdh/reflection-docblock suggests installing dflydev/markdown (~1.0)
Package facebook/webdriver is abandoned, you should avoid using it. Use php-webdriver/webdriver instead.
Writing lock file
Generating optimized autoload files
Carbon 1 is deprecated, see how to migrate to Carbon 2.
https://carbon.nesbot.com/docs/#api-carbon-2
    You can run './vendor/bin/upgrade-carbon' to get help in updating carbon and other frameworks and libraries that depend on it.
> Illuminate\Foundation\ComposerScripts::postAutoloadDump
> @php artisan package:discover

In DuskServiceProvider.php line 43:
                                           
  It is unsafe to run Dusk in production.  
                                           

Script @php artisan package:discover handling the post-autoload-dump event returned with error code 1

dump-autoload でも同じこと言われる これでも本番は動かない(5分位経って焦っている)

$ composer dump-autoload
Generating optimized autoload files
Carbon 1 is deprecated, see how to migrate to Carbon 2.
https://carbon.nesbot.com/docs/#api-carbon-2
    You can run './vendor/bin/upgrade-carbon' to get help in updating carbon and other frameworks and libraries that depend on it.
> Illuminate\Foundation\ComposerScripts::postAutoloadDump
> @php artisan package:discover

In DuskServiceProvider.php line 43:
                                           
  It is unsafe to run Dusk in production.  
                                           

Script @php artisan package:discover handling the post-autoload-dump event returned with error code 1

そこでerror文言でググり冒頭にも張った以下のページに辿り着く

Exception: It is unsafe to run Dusk in production. · Issue #289 · laravel/dusk · GitHub

記載されたコマンド打って本番環境に不要な Dusk含む余計なものをアンインストールできた。

$ composer install --no-dev
Loading composer repositories with package information
Installing dependencies from lock file
Package operations: 0 installs, 0 updates, 34 removals

# 色々削除される(割愛)
  - Removing webmozart/assert (1.7.0)
  - Removing phpunit/phpunit (7.5.20)
  - Removing laravel/dusk (v4.0.5)

Generating optimized autoload files
Carbon 1 is deprecated, see how to migrate to Carbon 2.
https://carbon.nesbot.com/docs/#api-carbon-2
    You can run './vendor/bin/upgrade-carbon' to get help in updating carbon and other frameworks and libraries that depend on it.
> Illuminate\Foundation\ComposerScripts::postAutoloadDump
> @php artisan package:discover
Discovered Package: barryvdh/laravel-cors
Discovered Package: barryvdh/laravel-debugbar
Discovered Package: barryvdh/laravel-ide-helper
Discovered Package: fideloper/proxy
Discovered Package: laravel/tinker
Package manifest generated successfully.

むしろ今までlocal環境の設定のままで良く動いていたな、と思う。 万一間違ってtestコマンド打っていたらDBが死んでいた。 ちなみに上に出てる Carbon の新しい奴がどうした、とかいう奴は、前に古いバージョンじゃないと駄目な依存パッケージがあったかもで、そのままにしている。

Laravel Eloquentで取得したデータの状態を意識してなかった件

今までDBファサードでデータの取得をしてましたが、最近はすっかりEloquentでデータを取ったり入れたりするようになりました。が、チェーンメソッドをごりごり書く際に上手くデータが取れない時があって、なんで?ってなる事がしばしばでしたが、データの状態をちゃんと意識しないで感覚と経験則と実装時のTry&Error でなんとかしちゃってました。 でも、この辺をちゃんと意識すべきだなと。

経験のある人から見ると「今それ?」みたいな話かもしれませんが、つまりこれです。

まずお馴染みのModelがあったとします。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    protected $table = 'users';

    // リレーションとか scope とかのメソッドが続く

}

それを use App\User; して使って他のクラス内で使える様にする訳ですが、 ごく単純に使うならまずこうですよね。

$user = User::find(1);

DBなら、user tableの主キーとなる id=1 のレコード1件を抽出します。 あとこんな風にも使います。

$user = User::find(1)->get();

とにかく欲しい。これでデータ取得、みたいな時ですね。

また、ちょっと違った条件で呼び出したい際はこんな風に呼んだりもします。

User::where('community_id', 1);

DBで考えると users table の community_id カラムの値が 1の奴だけ、 つまりコミュニティ1に属するユーザーだけを複数あれば取得、みたいな感じですね。

当然こいつもgetして使う訳です。

User::where('community_id', 1)->get();

で、個人的によく使うのがこのパターンで、複雑な階層下のtableなんかを呼ぶ際は、外部キーをベースに値を呼び出して使う。なんていうのがある訳です。

User::where('community_id', 1)
  ->LeftJoin('comments', 'comments.user_id', '=', 'users.id')
  ->where('comments.active', 1)
  ->get();

こんな風にアクティブな該当ユーザーのコメントのみを出す、みたいなニュアンスでクエリビルダゴリゴリ書いて使う感じですね。(リレーションメソッド使えって話もありますが)

で、こんな感じでいろんな形式でデータを取得するわけですが、なんか上手くいかないなー。って場合があって、その原因がわかりました。

$user = User::find(1);
dd(get_class($user));

ってクラス名を出力したら、最初に紹介した奴、それぞれ違うんですね。

$user = User::find(1);
dd(get_class($user));

これは App\User class と出力されます。

つまり、これはまだ只のModelクラスのインスタンスにすぎません。

次にこれ、一件やっている事は上と同じですが、インスタンスされるクラスが異なるんですね。

$user = User::where('id', 1);
dd(get_class($user));

Illuminate\Database\Eloquent\Builder class が出力されます

dd($user)って出力すると量が多くてヤバイ奴です。

Laravelやってる人は経験あると思います。dd() の際うっかりすげえ量のオブジェクトが出力されてマシンがうなってなかなか画面表示されない。って奴ですね。

しかし、これらに ->get() を付与するとさらにクラスが変わります。

$usr = User::find(1)->get();
dd(get_class($user));

Illuminate\Database\Eloquent\Collection class と出力

つまりコレクションクラス(配列っぽく便利に使えるアレ)のインスタンスとして出力されます。

$usr = User::where('id', 1)->get();
dd(get_class($user));

これも同様、 Illuminate\Database\Eloquent\Collection class と出力

コレクションクラスのインスタンスとして出力されます。

つまり ->get() を付けたら実体化してコレクションとして加工や出力に便利に使える状態に変換される訳ですね。

ところがややこしいのはこれ、 ->first() です

ひとまずこの条件で絞り込んで、最初の1件だけを取得する。なんていうときに使います。私は曖昧なデータの取れ方をするのが嫌であまり使わないですが。

$user = User::where('created_at', '>', Carbon::toDay())->first();
dd(get_class($user));

これ App\User class と出力されます。

コレクションでもなくまだピュアなモデルなのかよ!って感じです。

でもよく考えたら、 find(1) と同じ扱いですね。

でもこれらはとても、混乱しがちで間違いがちなんですよね。

first() もごりごりクエリビルダ書いた最後に付けることが良く多くて、取れるデータとして確定するニュアンスなので。 ->get() と同じ認識でいましたが、インスタンスが異なる為、本質も異なるんですね。

なので、余談ですが first() の後には ->get() が付けられて、コレクションインスタンスに変換が出来ます。使い道が今一つわかりませんが。

$user = User::where('created_at', '>', Carbon::toDay())->first()->get();
dd(get_class($user));

Illuminate\Database\Eloquent\Collection と出力

あとこれ、当たり前ですが最後に ->toArray() を付けるといずれも完全な配列となります。

User::find(1)->toArray();
User::find(1)->get()->toArray();

普通の配列データになる

私はこれで必要なIDの配列を取得して、別のModelを呼ぶ際のwhereInの条件にして使うことが多いです。TOP階層から5階層配下(鬼のようなDB構造...)のtableのリレーションでの値を出す必要があったりして、そんな場合に使います。

また、実際のアプリケーションで複雑な検索条件に対応する際の方法として、一度、単純なクエリ find() や where() でデータを呼び出して、get() を繋げないて$queryみたいな変数に入れ、それをさらに様々な処理を経由して条件追加をチェーンメソッドで繋げて、最後に ->get() みたいな使い方をします。

以下のような感じ。

// よく使う例

public function getUser(Request $request)

    $query = User::find($request->id);

    if (!is_null($request->date)) {
      $query->where('date', $request->date);
    }

    if (!is_null($request->name)) {
      $query->where('name', 'like', "%{$request->name}%");
    }

    return $query;
}

で、この関数の呼び出し元で

public function index(Request $request)

    // 上の関数を呼ぶ
    $query = this->getUser($request);

    // この辺に $query->を使ってさらに色々処理を繋げたり加工したり

    // で、最後にこれをしたりしなかったりして
    $user = query->get();

    // 出力
    return view('index', [
        'user' => $user
    ]);
}

みたいな感じ。

ですが、その際にこの辺のデータも持ち方の違いをきちんと意識してないと、なにがなんだかわかんなくなる。という事がありますので、現在のデータの状態を意識しつつ、クエリビルダを繋げる必要があるな。と感じた次第。

でも、この辺、有志のリファレンスサイトEloquent:利用の開始 5.8 Laravel見るとちゃんと書いてあるんですよね。

データの取得の方法論ばかり意識していて、これまではどのクラスのインスタンスの状態であるか?というのを意識してなかった。そういえばdd()で出す際になんか違うな―。位の認識しかしてないという…。

余談ですが、ここに意識が向かったきっかけですが、最近チームで実装をするようになり、後から私のコードを読む人の為に、わかりやすいコードを意識するようになり、メソッドにきちんとアノテーションを書くことも始めました。(最近かよ!)

とはいえ、けっこう俺流で書いてしまっていたのですが、これを書くことで起こった良い変化として、引数にはどんな型のデータが必要で、返り値のデータの型は何なのか?というのを意識的に統一して書くようになりました。

その際の返り値に、じゃあクラスのインスタンスとしては何を書くべきなの?って時に、あれ?ってなってこの記事に至ります。

しかし、返り値については、これまでは単純な配列や数値等、あと、Modelで書いたら、全部内容同じでしょ、位にしか認識してなかったので、今後は返り値が何のClassのインスタンスなのかをきちんと意識して実装できるようにします。

40歳を過ぎてプログラミングを始めたが50歳を前にして業務委託プログラマーとして半年が経過した

近況です。

タイトルの通りで、なんとかWeb系のプログラマーとして仕事を続けることが出来てます。

一昨年末に

sakamata.hateblo.jp

半年前に

sakamata.hateblo.jp

を書いて、その後どうなったみたいな概要を書きます。

俺この案件で死亡フラグたったかも。という位、幸運が舞い込んだ

5月から7月にかけて週3日の業務委託のプログラマーとしてなんとかお仕事をさせていただいたのですが、色々あって2か月程の契約で満了となった後に、次のお仕事を探していただいて、見つかったのがなんとびっくり、電車不要、徒歩20分での勤務先という嘘みたいに近所の案件のお話を頂き飛びつきました。

しかも、業務の内容も自分がいま伸ばしたい方向性にマッチした新規開発案件、季節の移ろいを感じながら毎朝公園内を徒歩通勤していると「俺、この案件が終わったら結婚するんだ」みたいな気分になってきます。

という事でとにかく7月からはそれなりに頑張りました。

今のテーマは設計、とにかく設計ですね。クラス階層毎のメソッドの役割の分割を言葉に落とし込むレベルできちんと分ける事、後時間が無くて書けないテストをきちんと書く事、エラーハンドルをしっかり行う事。

いつももっとうまくやりたいけど、時間が無くて次に行かないと、という焦りを持ちながら開発しているので、実装の速度を上げていきたいです。とはいえ、要件や仕様が複雑な部分ではどうしても最初に書く内容が、俗人化してファットなメソッドを書いてしまうのがなんとももどかしいです。リファクタリングをせず、最初から奇麗に引数を渡して複雑な処理を細分化できるレベルに到達するにははまだまだですね。

自分には少々荷が重い部分もありましたが今の所何とかなってます。でももっと経験を積んだ人のコードや言葉が欲しい毎日です。

自作アプリも地味に機能追加と改善を続ける

その一方で、滞在者確認アプリの方も時間を見つけてはコツコツ開発を続けて、いろんなものが追加されました。

例えばこんな奴、音声を聞いてやってください。

他にも訪問者の来訪記録を過去に遡って閲覧できるlog機能を追加しました。

f:id:sakamata:20200105155109p:plain
LOG機能の画面

これにより、コミュニティのオーナーさんが来訪者の傾向を調べたり、初訪問者の記録を取る事で、端末とユーザーの紐づけのヒントにして、楽な登録を行える事を狙っています。

また、既に作成していた訪問予告機能が近々アップデートされます。従来の24時間以内の訪問宣言だけでなく、来月までの未来の一定期間「きょう、あした、明後日、今週、土日、来週、今月、来月」をユルく宣言出来るようになります。

f:id:sakamata:20200105155952p:plain
予定機能のアップデート画面

今月行くかも。とか誰かが宣言したとします。それを見た誰かが「来週行くかも」と宣言することで、予告の日程を徐々に狭めて、じゃあ来週の金曜日夕方あたり、で、なんとなく人があつまるかなー、みたいなものを狙ってます。

他にも今のアプリで追加したい要件や直したい箇所はいくらでもあるので、地味に改善は続けて行くつもりです。ゆくゆくはスマホのネイティブアプリにしたいですね。

滞在者確認アプリを使ってもらう場所が増えました

秋葉原に出来たプログラマーの為の学習スペースプログラマー自習室|ギークライブラリー秋葉原に滞在者確認アプリ、Livelynkを導入していただきました。

f:id:sakamata:20191109164058j:plain

家ではなかなか集中して勉強できないけど、どこか静かな場所でまずはしっかり勉強したい!そして交流もしたい。という人の為かな?とにかく新しい試みに次々チャレンジしているオーナーさんで、プログラマーにとって、とても面白くて魅力的な空間を提供しています。

f:id:sakamata:20191109164200j:plain f:id:sakamata:20191109164031j:plain

興味のある方は是非一度訪問してみることをおすすめします。 駅から近いが、迷路の様な場所にあり、絶対迷う事請け合いですが、それを込みで楽しんでいただけると良いかと思います。

ひとまず今はそんなところです。

WordPress『更新に失敗しました。 エラーメッセージ: 返答が正しい JSON レスポンスではありません。』でハマりClassic Editorで解消した

WordPress 5.3.2 にアップデートした後、記事の編集を使用とするとタイトルの様なエラーが画面上部に表示され、更新が出来ない状態となる、結論からいうとプラグインで Classic Editor を入れて、この古い方のエディタを有効にしたら無事動いた。 Classic Editor – WordPress プラグイン | WordPress.org 日本語

原因究明までの道のり

エラー文『エラーメッセージ: 返答が正しい JSON レスポンスではありません。』でググった所 php.ini や Apache nginx の設定の関連で画像の最大サイズ超過でも同じエラーが出るらしいが、画像の無い記事を更新したり、新規作成でタイトルのみを作成しても同様の現象が出る為、どうも原因が異なる事が推察される。

またブラウザ依存の問題を疑い、chromeの該当URLのキャッシュを削除したが駄目だった。また、ブラウザをedgeでやっても同じ現象が確認されたので、ブラウザ問題でない事が推察される。

ところが、固定ページ一覧から「クイック編集」でタイトルなどの変更は受け付ける。ということで、DBやブラウザ等のシステム側に依存した現象でない事が確認できた。

検索を続け以下の記事に行き当たる 「更新に失敗しました」と表示され、更新できません。 | WordPress.org 日本語

こちらも同様の症状に悩んでおりましたが、アプデ内容にエディタの変更が含まれていたこと、いつもエディタから保存すると再現し、逆にタイトル変更やトップページのヘッダなどは保存できることからもしかしたらと思い、プラグインでクラシックエディタに戻したら無事更新できるようになりました。 どうやら新しいエディタに原因があるみたいですね。 こちらで上記の方法で何とか解決出来たので報告とご参考までに。

まさにこれだった。 という事で上記のプラグインWordPressの管理画面の「プラグイン」>「新規追加」でインストールして有効化、懐かしい画面で記事の編集を行った所、無事記事が更新できた。

トラブル満載だな、WordPress

【輪読会資料】PHPフレームワーク Laravel Webアプリケーション開発 8章 コンソールアプリケーション 前半資料

以下の記事は2019年9月12日、コワーキングスペース秋葉原Weeybleにて行われる [秋葉原] Laravel Webアプリケーション開発 輪読&勉強会 コンソールアプリケーションの輪読会資料の一部となります。
今回は 4章前半 8-1 『Commandの基礎』, 8-2『Commandの実装』部分の記事をアップします。

また、元になっている書籍は以下となります。

PHPフレームワーク Laravel Webアプリケーション開発 バージョン5.5 LTS対応

PHPフレームワーク Laravel Webアプリケーション開発 バージョン5.5 LTS対応

また書籍のコードが記載されているGitHubレポジトリは以下となります。とても助かります!
GitHub - laravel-socym/chapter08

  • 8-1 Commandの基礎

    • 8-1-1 クロージャによるCommandの基礎
    • 8-1-2 クラスによるCommandの作成
    • 8-1-3 Commandへの入力
    • 8-1-4 Commandからの入力
    • 8-1-5 Commandの実行
  • 8-2 Commandの実装

    • 8-2-1 サンプル実装の仕様
    • 8-1-2 Commandの生成
    • 8-1-3 ユースケースクラスとサービスクラスの分離
    • 8-2-4 ユースケースクラスのひな形を作成する
    • 8-2-5 サービスクラスの実装
    • 8-2-6 ユースケースクラスの実装
    • 8-2-7 Commandクラスの仕上げ


8-1 Commandの基礎

LaravelにはCommandというコンポーネントがあり、これを使えばコンソールアプリケーションに必要な機能を簡単に実装できる
Commandの作り方には2種類ある

  • クロージャ
    • 簡単な処理を書くのに向いている
  • クラス
    • 複雑な処理にも対応可能


8-1-1 クロージャによるCommandの基礎

こんな風にオリジナルのコマンドを作る事ができる ここでは単純な文字列を表示するCommandをクロージャで作る

実行してみる

php artisan hello:closure
Hello Closure command!

routes/console.phpクロージャで書いて定義する

<?php

Artisan::command('hello:closure', function () {
    $this->comment('Hallo Closure Command!');  // Command本体 文字列出力
})->describe('サンプルコマンド(クロージャ実装)'); //コマンドの説明

routes/console.php にコマンドを書くとlistに自動登録される、以下のコマンドで登録が確認できる

実行してみる

vagrant@homestead:~/study_command$ php artisan list
Laravel Framework 6.0.1

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  clear-compiled       Remove the compiled class file
  down                 Put the application into maintenance mode
  env                  Display the current framework environment

  ### 省略 ###

 flare
  flare:test           Send a test notification to Flare
 hello
  hello:closure        サンプルコマンド(クロージャ実装)
 key
  key:generate         Set the application key

  ### 省略 ###


8-1-2 クラスによるCommandの作成

以下の様なコマンドでClassのひな形を作れる

php artisan make:command HelloCommand
Console command created successfully.

ちなみに、どうも同時にどこかに自動で登録をしているようで ファイル名を間違えて自分で手直しすると、 list に出てこなかったり、実行できなかったり登録する?みたいなコマンドが出たりしたが、正体不明であった)

作成されたファイル app/Console/Commands/HelloCommand.php の中身

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class HelloCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'command:name';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Command description';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        //
    }
}

上記を以下の様に書き換えると、クロージャ同様のコマンドが作れる

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class HelloCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    // コマンドを指定する
    protected $signature = 'hello:class';

    /**
     * The console command description.
     *
     * @var string
     */
    // コマンドの説明を指定
    protected $description = 'サンプルコマンド(クラスで実装)';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    // 実行されるコマンドの定義
    public function handle()
    {
        $this->comment('Hello class command!');
    }
}

実行コマンドと結果

実行してみる

php artisan hello:class 
Hello class command!

リストにも登録されているのが確認できる

vagrant@homestead:~/study_command$ php artisan list

### 省略 ###

flare
  flare:test           Send a test notification to Flare
 hello
  hello:class          サンプルコマンド(クラスで実装)
  hello:closure        サンプルコマンド(クロージャ実装)
 key
  key:generate         Set the application key

### 省略 ###


8-1-3 Commandへの入力

vagrant@homestead:~/study_command$ php artisan hello:option --param
Hello Option param  => 有
vagrant@homestead:~/study_command$ php artisan hello:option
Hello Option param  => 無

コマンドには引数を入れて処理をさせることが出来る
実際にこんなコマンドを叩いた経験があるかもしれないが、

php artisan make:migration [マイグレーションファイル名] --table=[テーブル名]

後ろのファイル名(必須)と テーブル名(オプション) が引数となっている


コマンド引数 (必須)

$signature に引数を { } で指定できる

<?php

protected $signature = 'hello:class {name}';

handleメソッド内で argument() を使って呼べる

<?php

    public function handle()
    {
        $param = $this->argument('name');
        $this->comment('Hello class command! Param => ' . ($param));
    }

コマンド実行結果

やってみる際にコードのコメントを変更

vagrant@homestead:~/study_command$ php artisan hello:class taro
Hello class command! Param => taro

その他引数の指定方法

コマンド引数 内容
{name} 引数を文字列として取得 省略するとエラー
{name?} 引数を文字列として取得 省略可能
{name=default} 引数を文字列として取得 デフォルト値指定
{name*} 引数を配列として取得 省略するとエラー
{name : description} : コロン以降に説明を記述可能 : 前後にスペース必須

オプション引数 (任意)

あっても無くても良いオプションの引数を指定できる
以下は引数を論理値として使える例で、引数の文字列は指定したものを決め打ちしないと駄目

<?php
protected $signature = 'hello:option {--param}';

option()メソッドで利用できる

<?php

    public function handle()
    {
        $param = $this->option('param');
        $this->comment('Hello Option param  => ' . ($param ? '有' : '無'));
    }

やってみる際にコードのコメントを変更

引数ありで実行 指定すると true となる

vagrant@homestead:~/study_command$ php artisan hello:option --param
Hello Option param  => 有

引数無しで実行 指定なしは false となる

vagrant@homestead:~/study_command$ php artisan hello:option
Hello Option param  => 無

オプション引数の指定方法には以下のようなものがある

コマンド引数 内容
{--switch} 引数を論地値として取得 省略するとエラー
{--switch=} 引数を文字列として取得 省略可能
{--switch=default} 引数を文字列として取得 デフォルト値指定
{--switch=*} 引数を配列として取得 省略するとエラー
{--switch : description} :コロン以降に説明を記述可能 : 前後にスペース必須


8-1-4 Commandからの入力

出力の際の文字色や表示レベルをカスタマイズできる

<?php

    public function handle()
    {
        // 文字色,背景色の設定
        $this->line('line');
        $this->info('info');
        $this->comment('comment');
        $this->question('question');
        $this->error('error');
        $this->warn('warn');
        $this->table(['h1', 'h2'], [[1, 2]]);

        // 出力レベルの設定
        $this->info('quiet', OutputInterface::VERBOSITY_QUIET);
        $this->info('normal', OutputInterface::VERBOSITY_NORMAL);
        $this->info('verbose', OutputInterface::VERBOSITY_VERBOSE);
        $this->info('very_verbose', OutputInterface::VERBOSITY_VERY_VERBOSE);
        $this->info('debug', OutputInterface::VERBOSITY_DEBUG);

    }

出力レベルはLaravelのLog機能同様に通常で出力、詳細まで出す、デバッグで出す、みたいなレベル付けで出力ができる

実行例

それぞれ出力されるものが異なってくる

php artisan output:test --quiet
php artisan output:test
php artisan output:test -v
php artisan output:test -vv
php artisan output:test -vvv


8-1-5 Commandの実行

コンソールのコマンドで実行させるだけでなく、プログラムを直接書いてCommandの実行も可能
ここでは例としてroutes/web.php に書いて Log::debug(); で出力してみる

<?php

Route::get('/no_args', function () {
    Artisan::call('output:test');
});

// php artisan hello:option --param=1 --param=2

Route::get('/with_args', function () {
    Artisan::call('hello:option', [
        'arg' => 'value',
        '--switch' => 'false',
    ]);
});
Artisan::call('コマンド', ['引数指定']);

Artisanというファサードで call メソッドを呼ぶ、
第一引数は呼びたいコマンドを指定
第二引数にコールバック関数を入れる 引数を指定可能、上の例では第二引数を配列にして2つの引数を送っている

ブラウザで設定したurlにアクセスすると

http://study_command.test/no_args

<?php

    public function handle()
    {
        $param = $this->option('param');
        $this->comment('Hello Option param  => ' . ($param ? '有' : '無'));

        log::debug(print_r('command HelloOptionParamCommand run!!',1));
    }

handle() に書いたlogが出力されているのが確認できる

laravel.log

[2019-09-08 11:43:58] local.DEBUG: command output:test run!!  

ちなみに handle() の中にcallメソッドで別のコマンドを呼ぶ処理を書けばCommandから別のCommandを実行することができる

<?php
    public function handle()
    {
        $this->call('hello:param');
    }


8-2 Commandの実装

ここでは実際のコマンドラインアプリケーションの実装方法の解説をExportOrdersCommandで説明する

8-2-1 サンプル実装の仕様

ここではコマンド実行でDBの値をTSV形式で出力できる機能を実装する

TSVとは何? Weblio辞書

フルスペル:Tab Separated Values 読み方:ティーエスブイ 別名:タブ区切り TSVとは、文字や文字列の間にタブ記号を挿入して区切りを設けること、あるいは、そのようにして各データを区切って管理するファイル形式のことである。

書籍にはDB定義のカラム仕様や出力されるデータの形式が詳細に記載されているがここでは割愛する。

<?php
        // ひとまずseederファイルの一部でDB構造はなんとなく把握してください。
        Schema::create('orders', function (Blueprint $table) {
            $table->increments('id');
            $table->string('order_code', 32);
            $table->dateTime('order_date');
            $table->string('customer_name', 100);
            $table->string('customer_email', 255);
            $table->string('destination_name', 100);
            $table->string('destination_zip', 10);
            $table->string('destination_prefecture', 10);
            $table->string('destination_address', 100);
            $table->string('destination_tel', 20);
            $table->integer('total_quantity');
            $table->integer('total_price');
            $table->timestamps();

            $table->unique('order_code');
            $table->index('order_date');
        });

        Schema::create('order_details', function (Blueprint $table) {
            $table->string('order_code', 32);
            $table->integer('detail_no');
            $table->string('item_name', 100);
            $table->integer('item_price');
            $table->integer('quantity');
            $table->integer('subtotal_price');

            $table->primary(['order_code', 'detail_no']);

            $table->index('order_code');
            /** @noinspection PhpUndefinedMethodInspection */
            $table->foreign('order_code')->references('order_code')->on('orders');
        });

登録されるコマンドは以下の様なものとなる

vagrant@homestead:~/study_command$ php artisan list
Laravel Framework 6.0.1
  ### 省略 ###

app
  app:export-orders    購入情報を出力する

  ### 省略 ###

出力される内容は以下の様なタブ区切りでカラム名とレコードを出力する

 php artisan app:export-orders
購入コード      購入日時        明細番号        商品名  商品価格        購入点数小計金額        合計点数        合計金額        購入者氏名      購入者メールアドレス    送付先氏名      送付先郵便番号  送付先都道府県  送付先住所      送付先電話番号
1111-1111-1111-1111     2019-09-08 00:00:00     1       商品1   1000    1      1000     大阪 太郎       osaka@example.com       送付先 太郎     1234567 大阪府 送付先住所1     06-0000-0000


8-2-2 Commandの生成

8-1章でのコマンドに習いファイルを作成し、ひな形として動くコマンドファイルを作成する

php arrisan make:command ExportOrdersCommand

app\Console\Commands\ExportOrdersCommand.php

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class ExportOrdersCommand extends Command
{
    // コメントは省略
    protected $signature = 'app:export-orders';

    protected $description = '購入情報を出力する';

    public function __construct()
    {
        parent::__construct();
    }

    public function handle()
    {
        $this->info('hello');
    }
}

実行してみてhelloを確認

vagrant@homestead:~/study_command$ php artisan app:export-orders
hello


8-2-3 ユースケースクラスとサービスクラスの分離

ここでは設計と実装について説明しているがこのUML図とコメントでおおよそを把握してください。

f:id:sakamata:20190911082822p:plain

処理毎にクラスを分離して役割を明確にして、定められた役割のみを担うように実装をする。
これにより処理の再利用性が高まる。 8-3 では実際に ExportOrdersServiceクラスを再利用する。

また、テストを容易にでくるメリットもあり、図の真ん中の ExportOrderUseCaseも単体でテスト可能となる。


8-2-4 ユースケースクラスのひな形を作成する

まずごく簡単な処理の流れがつかめる実装を行う Commandクラス(1階層目)に ExportOrdersUseCase を注入して run メソッドに引数を入れて走らせる処理を書く

<?php

namespace App\Console\Commands;

use App\UseCases\ExportOrdersUseCase;
use Carbon\Carbon;
use Illuminate\Console\Command;

class ExportOrdersCommand extends Command
{
    protected $signature = 'app:export-orders';

    /** @var TemplateExportOrdersUseCase */
    private $useCase;

    protected $description = '購入情報を出力する';

    public function __construct(ExportOrdersUseCase $useCase)
    {
        parent::__construct();
        $this->useCase = $useCase;
    }

    public function handle()
    {
        $tsv = $this->useCase->run(Carbon::today());
        echo $tsv;
    }
}

ExportOrdersUseCase クラス(2階層目)には runメソッドを書いて渡されたCarbonオブジェクトで Y-m-d形式の表示を行う仮実装を行う。

<?php

declare(strict_types=1);

namespace App\UseCases;

use App\Services\ExportOrdersService;
use Carbon\Carbon;

final class TemplateExportOrdersUseCase
{
    /**
     * @param Carbon $targetDate
     * @return string
     */
    public function run(Carbon $targetDate): string
    {
        return $targetDate->format('Y-m-d') . 'の購入情報';
    }
}

コマンド実行で 本日 + 文字列 が出力されるようになる。

php artisan app:export-orders
2019-09-09の購入情報


8-2-5 サービスクラスの実装

次に3階層目(Service)の処理を書く

<?php

declare(strict_types=1);

namespace App\Services;

use Carbon\Carbon;
use Generator;
use Illuminate\Database\Connection;

final class ExportOrdersService
{
    /** @var Connection */
    private $connection;

    public function __construct(Connection $connection)
    {
        $this->connection = $connection;
    }

    /**
     * 対象日の購入情報を取得
     *
     * @param Carbon $date
     * @return Generator
     */
    public function findOrders(Carbon $date): Generator
    {
        return $this->connection
            ->table('orders')
            ->join('order_details', 'orders.order_code', '=', 'order_details.order_code')
            ->select([
                'orders.order_code',
                'orders.order_date',
                'orders.total_price',
                'orders.total_quantity',
                'orders.customer_name',
                'orders.customer_email',
                'orders.destination_name',
                'orders.destination_zip',
                'orders.destination_prefecture',
                'orders.destination_address',
                'orders.destination_tel',
                'order_details.*',
            ])
            ->where('order_date', '>=', $date->toDateString())
            ->where('order_date', '<', $date->copy()->addDay()->toDateString())
            ->orderBy('order_date')
            ->orderBy('orders.id')
            ->orderBy('order_details.detail_no')
            ->cursor();  // ここがポイント! cursor は呼び出し時点でレコードの読み込みはしない

            // https://localdisk.hatenablog.com/entry/2016/07/20/173208
            // cursor メソッドを使っています。これは 5.2.33 から追加されました*1。
            // 内部でジェネレータを使っているのでメモリ不足で死ななくて最高です。
    }
}

クエリビルダで単純に必要なデータを取得しているのみ。 引数にCoerbonの日付を入れてクエリ条件にしている。

ポイントは最後の cursor() メソッドでこれは呼び出し時点でクエリを実行しないので、メモリ的に厳しい処理にも対応できるらしい。

コードの詳細な説明は書籍を参照のこと。


8-2-6 ユースケースクラスの実装

次に2階層目(UseCase)クラスを実装する。

<?php

declare(strict_types=1);

namespace App\UseCases;

use App\Services\ExportOrdersService;
use Carbon\Carbon;

final class ExportOrdersUseCase
{
    /** @var ExportOrdersService */
    private $service;

    public function __construct(ExportOrdersService $service)
    {
        $this->service = $service;
    }

    /**
     * @param Carbon $targetDate
     * @return string
     */
    public function run(Carbon $targetDate): string
    {
        // (1) データベースから購入情報を取得
        $orders = $this->service->findOrders($targetDate);

        // (2) TSV ファイル用コレクションを生成
        $tsv = collect();
        // (3) タイトル行を追加
        $tsv->push($this->title());

        // (4) 購入情報を追加
        foreach ($orders as $order) {
            $tsv->push([
                $order->order_code,
                $order->order_date,
                $order->detail_no,
                $order->item_name,
                $order->item_price,
                $order->quantity,
                $order->subtotal_price,
                $order->customer_name,
                $order->customer_email,
                $order->destination_name,
                $order->destination_zip,
                $order->destination_prefecture,
                $order->destination_address,
                $order->destination_tel,
            ]);
        }

        // (5) 各要素を TSV 形式に変換
        return $tsv->map(function (array $values) {
                return implode("\t", $values);
            })->implode("\n") . "\n";
    }

    private function title(): array
    {
        return [
            '購入コード',
            '購入日時',
            '明細番号',
            '商品名',
            '商品価格',
            '購入点数',
            '小計金額',
            '合計点数',
            '合計金額',
            '購入者氏名',
            '購入者メールアドレス',
            '送付先氏名',
            '送付先郵便番号',
            '送付先都道府県',
            '送付先住所',
            '送付先電話番号',
        ];
    }
}

書籍にはないが、そろそろSeederを追加してダミーデータを入れておく ファイルを書くより書籍用のGithubリポジトリのコードを流用するのが良い。

php artisan migrate
php artisan db:seed

seeder に購入日を本日に指定したレコードを挿入しておく( Carbon::now()でよろしくやる )

作ったコマンド実行をすると、見出しとレコードがタブスペース繋がりで出力される

php artisan app:export-orders

購入コード      購入日時        明細番号        商品名  商品価格        購入点数小計金額        合計点数        合計金額        購入者氏名      購入者メールアドレス    送付先氏名      送付先郵便番号  送付先都道府県  送付先住所      送付先電話番号
1111-1111-1111-1111     2019-09-08 00:00:00     1       商品1   1000    1      1000     大阪 太郎       osaka@example.com       送付先 太郎     1234567 大阪府 送付先住所1     06-0000-0000

データが無い場合は見出しのみ出力される


8-2-7 Commandクラスの仕上げ

日付を引数で指定して渡してやるとその日に購入されたレコードが表示されるようになる

<?php

### 省略 ###

    protected $signature = 'app:export-orders {date}';

  ### 省略 ###

    public function handle()
    {
        // 日付のパラメーターを取得してUseCaseに処理を渡す
        $date = $this->argument('date');
        $tagetDate = Carbon::createFromFormat('Ymd', $date);
        $tsv = $this->useCase->run($tagetDate);

        echo $tsv;
    }

### 省略 ###

出力結果

vagrant@homestead:~/study_command$ php artisan app:export-orders 20180629
購入コード      購入日時        明細番号        商品名  商品価格        購入点数        小計金額        合計点数        合計金額        購入者氏名      購入者メールアドレス    送付先氏名      送付先郵便番号  送付先都道府県  送付先住所  送付先電話番号
1111-1111-1111-1112     2018-06-29 23:59:59     1       商品1   1000    2       2000    神戸 花子       kobe@example.com        送付先 太郎     1234567 兵庫県  送付先住所2     078-0000-0000
1111-1111-1111-1112     2018-06-29 23:59:59     2       商品2   500     1       500     神戸 花子       kobe@example.com        送付先 太郎     1234567 兵庫県  送付先住所2     078-0000-0000
vagrant@homestead:~/study_command$ php artisan app:export-orders 20190908
購入コード      購入日時        明細番号        商品名  商品価格        購入点数        小計金額        合計点数        合計金額        購入者氏名      購入者メールアドレス    送付先氏名      送付先郵便番号  送付先都道府県  送付先住所  送付先電話番号
1111-1111-1111-1111     2019-09-08 00:00:00     1       商品1   1000    1       1000    大阪 太郎       osaka@example.com       送付先 太郎     1234567 大阪府  送付先住所1     06-0000-0000

さらに必須引数に日時 オプションに出力先を指定すれば、その場所にファイルが出力される

<?php
    // オプションの引数を追加
    protected $signature = 'app:export-orders {date} {--output=}';

    public function handle()
    {
        $date = $this->argument('date');
        $tagetDate = Carbon::createFromFormat('Ymd', $date);
        $tsv = $this->useCase->run($tagetDate);

        // オプションの引数を取得できれば指定されたpathに出力
        $outputFilePath = $this->option('output');
        if (is_null($outputFilePath)) {
            echo $tsv;
            return;
        }

        file_put_contents($outputFilePath, $tsv);
    }

出力pathとファイル名をオプションで指定すればファイルとして出力できる。

php artisan app:export-orders 20190908 --output tmp/orders.tsv