Download the PHP package tkaratug/eloquent-scope-assertion without Composer
On this page you can find all versions of the php package tkaratug/eloquent-scope-assertion. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 eloquent-scope-assertion
Eloquent Scope Assertion
This package allows you to assert that the scope of a model is called in your tests.
Installation
You can install the package via composer:
Use Case
Let's say you have a complicated conditional query for Orders that is imported to be tested.
- Get the orders that have not been paid.
- Sorted by creation date descending.
- The list could go on.
The above query constraints should be tested at the feature level, so that you have tests like so;
user_can_get_ordersuser_can_get_only_unpaid_ordersuser_can_get_orders_by_created_at_desc- The list could go on.
Since the query is happening in the model scope it would be nice to test the query in the model's unit test and therefore only write the test coverage once.
However, in your feature tests, it's hard to be sure that the model scope with test coverage is actually used in your controller, so you'll likely duplicate that test coverage in your Feature tests in some way. Thus, you make the unit test you write quite meaningless.
As a solution of that, this package triggers an event that contains the name of the scope and model when a model scope is called. In this way, it is quite easy to assert that the event is dispatched with the correct scope and model names in feature tests.
Usage
Add the HasScopeAssertion trait to the TestCase class in order to be able to call assertScopeCalled() method in your feature tests.
Since the ModelScopeCalled event is triggered when a named scope is called, you should fake it in setUp() method.
Then add the HasScopeWatcher trait in your models to be able to assert its scopes.
Let's say you want to see only unpaid orders sorted by creation date descending.
The OrderController should be like this;
Now you can simplify your test coverage in OrderControllerTest like so;
If you want to assert how many times a query scope is called, just add a number as third parameter to assertScopeCalled() method.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Turan Karatug
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
