atoum/stubs

atoum的存根,用于PHP 5.3+的简单、现代和直观的单元测试框架

2.6.0 2018-01-29 22:41 UTC

This package is auto-updated.

Last update: 2024-08-30 18:05:16 UTC


README

atoum

安装它

使用composer安装扩展 composer

{
    "require-dev": {
        "atoum/stubs": "*"
    }
}

使用它

一旦你的IDE配置正确,你只需要使用atoum的一个别名即可

<?php

// tests/units/random.php

namespace tests\units;

use atoum; // or mageekguy\atoum

class random extends atoum {
    // ...
}

atoum为主测试类提供了3个别名,选择你喜欢的

  • atoum
  • atoum\test
  • mageekguy\atoum

完成后,你将获得完整的代码补全功能

atoum-stubs

为什么?

为什么PHPdoc注解是外部存储库的一部分?

因为我们不希望它们出现在atoum源代码的中间。那里它们并不真正有用,并且会增加额外的噪音。

此外,如果我们为用户API使用PHPDoc,我们还应该为内部API的每个方法添加注解。这对于增加的价值来说工作量太大。

为什么这些注解只适用于atoum别名?

因为我们在外部存储库中存储了注解代码,我们不得不复制一些类来注解它们。这样做会创建重复的类,并且某些IDE会发出警告。

我们不想在提供良好的代码补全的同时增加额外的噪音。

为什么不注解每个公共方法?

因为它们在测试上下文中并不都有意义。当你使用atoum编写单元测试时,你很可能永远不会调用内部断言器的公共方法。它们为atoum提供支持,以便它能很好地完成任务。但它们不会帮助你完成日常的工作。

升级存根

bin/updateMissingStubClasses
bin/updateDoc

这将只更新现有方法。要添加新方法,您将需要手动进行!也要考虑查看 断言器 的树,以正确扩展类。

你可能还需要更新 classes/mageekguy/atoum/stubs/asserters.php 以包含新的断言集。

许可证

atoum存根在BSD-3-Clause许可证下发布。有关详细信息,请参阅附带LICENSE文件。