Chore maintenance tasks

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at . All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

COPYRIGHT

@@ -0,0 +1 @@
+(c) 2019 - 2020 CROSS Solution (https://cross-solution.de)

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 CROSS Solution
+Copyright (c) 2019 - 2020 CROSS Solution
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

src/Constraint/ExtendsOrImplements.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
  * CROSS PHPUnit Utils
  *
- * @filesource
- * @license    MIT
- * @copyright  2019 Cross Solution <http://cross-solution.de>
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);
@@ -17,7 +18,6 @@
  * Constraint to assert the extending or implementing of specific classes and interfaces.
  *
  * @author Mathias Gelhausen <gelhausen@cross-solution.de>
- * @todo write tets.
  */
 class ExtendsOrImplements extends BaseConstraint
 {

src/Constraint/UsesTraits.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
  * CROSS PHPUnit Utils
  *
- * @filesource
- * @license    MIT
- * @copyright  2019 Cross Solution <http://cross-solution.de>
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);

src/Exception/ExceptionInterface.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
- * CROSS PHPunit Utils
+ * CROSS PHPUnit Utils
  *
- * @filesource
- * @copyright 2019 Cross Solution <https://www.cross-solution.de>
- * @license MIT
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);

src/Exception/InvalidUsageException.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
- * CROSS PHPunit Utils
+ * CROSS PHPUnit Utils
  *
- * @filesource
- * @copyright 2019 Cross Solution <https://www.cross-solution.de>
- * @license MIT
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);
@@ -15,7 +16,6 @@
  * Exception thrown if a helper trait is used the wrong way
  *
  * @author Mathias Gelhausen <gelhausen@cross-solution.de>
- * @todo write tests
  */
 class InvalidUsageException extends \PHPUnit\Framework\Exception implements ExceptionInterface
 {

src/Exception/TemplatedMessageExceptionTrait.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
- * CROSS PHPunit Utils
+ * CROSS PHPUnit Utils
  *
- * @filesource
- * @copyright 2019 Cross Solution <https://www.cross-solution.de>
- * @license MIT
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);
@@ -32,7 +33,7 @@ trait TemplatedMessageExceptionTrait
      *
      * @return \Exception
      */
-    public static function create(...$args): \Exception
+    public static function create(...$args): self
     {
         $ex      = end($args) instanceof \Throwable ? array_pop($args) : null;
         $message = sprintf(...$args);

src/TestCase/AssertInheritanceTrait.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
  * CROSS PHPUnit Utils
  *
- * @filesource
- * @license    MIT
- * @copyright  2019 Cross Solution <http://cross-solution.de>
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);

src/TestCase/AssertUsesTraitsTrait.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
  * CROSS PHPUnit Utils
  *
- * @filesource
- * @license    MIT
- * @copyright  2019 Cross Solution <http://cross-solution.de>
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);

src/TestCase/ContainerDoubleTrait.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
  * CROSS PHPUnit Utils
  *
- * @filesource
- * @license    MIT
- * @copyright  2019 Cross Solution <http://cross-solution.de>
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);

src/TestCase/CreateProphecyTrait.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
- * CROSS PHPunit Utils
+ * CROSS PHPUnit Utils
  *
- * @filesource
- * @copyright 2019 Cross Solution <https://www.cross-solution.de>
- * @license MIT
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);
@@ -18,7 +19,6 @@
  * Creates object prophecies or doubles.
  *
  * @author Mathias Gelhausen <gelhausen@cross-solution.de>
- * @todo write tests
  */
 trait CreateProphecyTrait
 {

src/TestCase/SetupTargetTrait.php

@@ -1,9 +1,11 @@
 <?php
+
 /**
  * CROSS PHPUnit Utils
  *
- * @filesource
- * @copyright 2019 Cross Solution <http://cross-solution.de>
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);

src/TestCase/TestInheritanceTrait.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
  * CROSS PHPUnit Utils
  *
- * @filesource
- * @license    MIT
- * @copyright  2019 Cross Solution <http://cross-solution.de>
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);

src/TestCase/TestSetterAndGetterTrait.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
  * CROSS PHPUnit Utils
  *
- * @filesource
- * @license    MIT
- * @copyright  2019 Cross Solution <http://cross-solution.de>
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);
@@ -99,7 +100,7 @@
  *
  * @author Mathias Gelhausen <gelhausen@cross-solution.de>
  *
- * @since @#next#@ Allow SUT per individual test.
+ * @since 2.x Allow SUT per individual test.
  */
 trait TestSetterAndGetterTrait
 {

src/TestCase/TestUsesTraitsTrait.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
  * CROSS PHPUnit Utils
  *
- * @filesource
- * @license    MIT
- * @copyright  2013 - 2016 Cross Solution <http://cross-solution.de>
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);

src/Utils/Instance.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
- * CROSS PHPunit Utils
+ * CROSS PHPUnit Utils
  *
- * @filesource
- * @copyright 2019 Cross Solution <https://www.cross-solution.de>
- * @license MIT
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);

src/Utils/Target.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
- * CROSS PHPunit Utils
+ * CROSS PHPUnit Utils
  *
- * @filesource
- * @copyright 2019 Cross Solution <https://www.cross-solution.de>
- * @license MIT
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);

test/TestUtilsTest/Constraint/ExtendsOrImplementsTest.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
  * CROSS PHPUnit Utils
  *
- * @filesource
- * @license MIT
- * @copyright 2019 Cross Solution <http://cross-solution.de>
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 declare(strict_types=1);

test/TestUtilsTest/Constraint/UsesTraitsTest.php

@@ -1,10 +1,11 @@
 <?php
+
 /**
  * CROSS PHPUnit Utils
  *
- * @filesource
- * @license MIT
- * @copyright 2019 Cross Solution <http://cross-solution.de>
+ * @see       https://github.com/cross-solution/phpunit-utils for the canonical source repository
+ * @copyright https://github.com/cross-solution/phpunit-utils/blob/master/COPYRIGHT
+ * @license   https://github.com/cross-solution/phpunit-utils/blob/master/LICENSE MIT
  */
 
 /** */