Download the PHP package tototoshi/staticmock without Composer
On this page you can find all versions of the php package tototoshi/staticmock. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tototoshi/staticmock
More information about tototoshi/staticmock
Files in tototoshi/staticmock
Package staticmock
Short Description A mockery-like DSL to replace static method in test.
License BSD-3-Clause
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package staticmock
StaticMock
A mockery-like DSL to replace static methods in tests.
Motivation
Mockery (https://github.com/padraic/mockery) provides nice interfaces to create mock objects. But as for static methods, Mockery needs an alias class and we can't create a mock object in one shot with his easy DSL.
StaticMock provides Mockery-like DSL for static methods. StaticMock depends on runkit7 extension or uopz extension and rewrites static methods temporarily at run-time.
Requirements
- PHP 7.3 and runkit7/runkit7 1.0.11
- PHP >= 7.3 and runkit7/runkit7 >= 4.0.0a3
- PHP >= 7.3 and krakjoe/uopz
About runkit7 settings
Please note that the extension name differs depending on the version of runkit7. In the past it was extension=runkit.so, but nowadays it is extension=runkit7.so
Install
composer.json
Example
Imagine that you are writing tests for User class such as this.
Stubbing and Mocking
User class has a getFeed method. This method aggregates user's feeds from Google+ and Facebook. It depends on GooglePlusClient and FacebookClient to fetch feeds from their API. We sometimes want stubs for GooglePlusClient and FacebookClient to write tests for the User class. Our goal is only to ensure that User class can correctly aggregate feeds from APIs. The behavior of GooglePlusClient and FacebookClient is out of our heads now.
The problem is GooglePlusClient::getFeed and FacebookClient::getFeed are static methods. If they were instance methods, we could manage their dependencies and inject stubs of them to User class. But since they are static methods, we can't do that.
StaticMock solved the problem by replacing the methods temporarily at run-time. It provides an easy DSL for replacing methods. All you need to learn is only a few methods.
- Declare the methods we want to replace with
StaticMock::mockandshouldReceive. - The return value of the method is defined with
andReturn.
See below. In this example, GooglePlusClient::getFeed and FacebookClient::getFeed are changed to return array("From Google+") and array("From Facebook").
StaticMock also has some methods to act as mock objects.
never(),once(),twice()andtimes($times)are used to check how many times they are called.withandwithNthArgare used to check what arguments are passed when they are called.
Common pitfalls
Assigning a mock variable ($mock = StaticMock::mock('MyClass')) is required since StaticMock is implemented with constructor and destructor magic.
The methods are replaced when the instance of Mock class is created by StaticMock::mock and reverted when the instance goes out of scope.
So, the following code doesn't work as you expect.
Replacing method implementation
andImplement is useful to change the behavior of the method.
See below again. We are writing a test for User::register this time but we don't want to send an email every time running the test.
Pass an anonymous function like below. The Email will not be sent and only a short line will be printed on your console.
With PHPUnit
You can easily define custom PHPUnit assertion. See below.
LICENSE
BSD 3-Clause
