BcBake plugin for baserCMS

baserCMSのスキャッフォルドを作成するためのプラグインです。
CakePHPの bake コマンドを拡張して、baserCMSのプラグインやテーマを作成するためのコマンドを提供します。

プラグインの作成

プラグインを作成するためのコマンドは次の通りです。

bin/cake bake bc_plugin {PluginName}

bake bc_plugin コマンドは、CakePHPが提供する bake plugin コマンドが生成するファイルに加えて次のファイルを生成します。
これによりすぐに baserCMSにインストール可能となります。

config.php
config/setting.php
src/ServiceProvider/PluginNameServiceProvider.php
src/Event/PluginNameControllerEventListener.php
src/Event/PluginNameModelEventListener.php
src/Event/PluginNameViewEventListener.php
src/Event/PluginNameHelperEventListener.php
src/View/Helper/PluginNameBaserHelper.php

不要なファイルは削除しましょう。

MVCに関連するファイルの作成

MVCに関連するファイルを作成するためのコマンドは次の通りです。

bin/cake bake bc_all {table_name} -p {PluginName} --prefix Admin

bake bc_all コマンドは、CakePHPが提供する bake all コマンドが生成するファイルに加えて次のファイルを生成します。

src/Service/TableNameService.php
src/Service/TableNameServiceInterface.php
src/Service/Admin/TableNameAdminService.php
src/Service/Admin/TableNameAdminServiceInterface.php

サービスクラスを利用するには、サービスプロバイダに登録が必要となります。

// src/ServiceProvider/PluginNameServiceProvider.php

// provides プロパティにインターフェイスを定義
protected array $provides = [
    TableNameAdminServiceInterface::class,
];

// services メソッドにインターフェイスと実装クラスの関連付けを登録
public function services($container): void
{
    $container->defaultToShared(true);
    $container->add(TableNameAdminServiceInterface::class, TableNameAdminService::class);
}

Serviceクラスのテストについて

@ryuring
プラグインのServiceクラスのテストを、baserCMSに倣って書きたいのですが、
以下のようなエラーが出て、コンテナに登録されない（？）、エイリアスが無い（？）と怒られます。

1) DubOgp\Test\TestCase\Service\DubOgpConfigsServiceTest::test__construct
League\Container\Exception\NotFoundException: Alias (DubOgp\Service\DubOgpConfigsServiceInterface) is not being managed by the container or delegates

/var/www/html/vendor/league/container/src/Container.php:208
/var/www/html/vendor/league/container/src/Container.php:118
/var/www/html/plugins/baser-core/src/Utility/BcContainerTrait.php:33
/var/www/html/plugins/DubOgp/tests/TestCase/Service/DubOgpConfigsServiceTest.php:20
/var/www/html/vendor/bin/phpunit:122

ちなみにテストはdockerコンテナに入って、プラグインディレクトリから実行しています。

cd plugins/DubOgp/
../../vendor/bin/phpunit tests/TestCase/Service/DubOgpConfigsServiceTest.php

basercms/plugins/bc-theme-config/tests/TestCase/Service/ThemeConfigsServiceTest.php
この辺を参考にしてるのですが、コンテナ登録はBcTestCaseが勝手にやってくれてるように見えるんですが、
なにか設定なり登録が必要でしょうか？
なにか気になる点や、ヒントだけでもいただけると助かります。
できれば、ServiceTestのサンプルがあると嬉しいです！

問題のテストコードは以下、
DubOgpConfigsServiceTest.php

<?php
namespace DubOgp\Test\TestCase\Service;

// use Cake\TestSuite\TestCase;
use BaserCore\TestSuite\BcTestCase;
use BaserCore\Utility\BcContainerTrait;
use DubOgp\Service\DubOgpConfigsService;
use DubOgp\Service\DubOgpConfigsServiceInterface;

class DubOgpConfigsServiceTest extends BcTestCase
{
    
    use BcContainerTrait;

    public $DubOgpConfigsService;

    public function setUp(): void
    {
        parent::setUp();
        $this->DubOgpConfigsService = $this->getService(DubOgpConfigsServiceInterface::class);
    }

    public function tearDown(): void
    {
        unset($this->DubOgpConfigsService);
        parent::tearDown();
    }

    public function test__construct()
    {
        $this->assertEquals('dub_ogp_configs', $this->DubOgpConfigsService->DubOgpConfigs->getTable());
    }

}

テスト対象のServiceは以下、
DubOgpConfigsService.php

<?php
declare(strict_types=1);

namespace DubOgp\Service;

use DubOgp\Model\Entity\DubOgpConfig;
use DubOgp\Model\Table\DubOgpConfigsTable;
use Cake\Datasource\EntityInterface;
use Cake\ORM\Table;
use Cake\ORM\TableRegistry;

/**
 * DubOgpConfigs Service
 */
class DubOgpConfigsService implements DubOgpConfigsServiceInterface
{
    
    public DubOgpConfigsTable|Table $DubOgpConfigs;

    /**
     * キャッシュ用 Entity
     * @var MailConfig
     */
    protected $entity;

    /**
     * constructor
     */
    public function __construct()
    {
        $this->DubOgpConfigs = TableRegistry::getTableLocator()->get('DubOgp.DubOgpConfigs');
    }

    /**
     * get new
     * @return \Cake\Datasource\EntityInterface
     以下bakeされたコードが続く
     */

}

プロバイダーは登録してあって、以下のテストコードは通りました。
DubOgpServiceProviderTest.php

<?php

namespace DubOgp\Test\TestCase\ServiceProvider;

use BaserCore\TestSuite\BcTestCase;
use DubOgp\Service\DubOgpConfigsServiceInterface;
use DubOgp\ServiceProvider\DubOgpServiceProvider;
use Cake\Core\Container;

class DubOgpServiceProviderTest extends BcTestCase
{
    public function setUp(): void
    {
        parent::setUp();
        $this->DubOgpServiceProvider = new DubOgpServiceProvider();
    }

    public function tearDown(): void
    {
        unset($this->DubOgpServiceProvider);
        parent::tearDown();
    }

    public function testServices()
    {
        $container = new Container();
        $this->DubOgpServiceProvider->services($container);
        $this->assertTrue($container->has(DubOgpConfigsServiceInterface::class));
    }

}

対象コードは以下、
DubOgpServiceProvider.php

<?php
declare(strict_types=1);

namespace DubOgp\ServiceProvider;

use DubOgp\Service\DubOgpConfigsService;
use DubOgp\Service\DubOgpConfigsServiceInterface;
use DubOgp\Service\Admin\DubOgpConfigsAdminService;
use DubOgp\Service\Admin\DubOgpConfigsAdminServiceInterface;
use Cake\Core\ServiceProvider;

/**
 * DubOgp Service Provider
 */
class DubOgpServiceProvider extends ServiceProvider
{

    protected $provides = [
        // TableNameAdminServiceInterface::class,
        DubOgpConfigsServiceInterface::class,
        DubOgpConfigsAdminServiceInterface::class,
    ];

    public function services($container): void
    {
        $container->defaultToShared(true);
        //$container->add(TableNameAdminServiceInterface::class, TableNameAdminService::class);
        $container->add(DubOgpConfigsServiceInterface::class, DubOgpConfigsService::class);
        $container->add(DubOgpConfigsAdminServiceInterface::class, DubOgpConfigsAdminService::class);
    }

}

baserproject / bcbake Goto Github PK

bcbake's Introduction

BcBake plugin for baserCMS

プラグインの作成

MVCに関連するファイルの作成

bcbake's People

Contributors

Stargazers

Watchers

Forkers

bcbake's Issues

src/Plugin.phpについて

テスト時のdefineについて

Serviceクラスのテストについて

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent