Skip to content

Commit 6044926

Browse files
committed
Realese notes, verbose documentation
1 parent cb5c81c commit 6044926

File tree

2 files changed

+28
-2
lines changed

2 files changed

+28
-2
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
11
# PHPSpec Magento 2.0 DI Adapter [![Build Status](https://travis-ci.org/EcomDev/phpspec-magento-di-adapter.svg?branch=develop)](https://travis-ci.org/EcomDev/phpspec-magento-di-adapter?branch=develop) [![Coverage Status](https://coveralls.io/repos/github/EcomDev/phpspec-magento-di-adapter/badge.svg?branch=develop)](https://coveralls.io/github/EcomDev/phpspec-magento-di-adapter?branch=develop)
22

3-
This small PHPSpec extension allows you to test Magento 2.0 modules much more easier by utilizing Factory generators of Magento\Framework\ObjectManager.
3+
This small PHPSpec extension allows you to test Magento 2.0 modules much more easier by utilizing generators of `Magento\Framework\ObjectManager`.
4+
5+
## Why?
6+
Reasons why not to use `ObjectManager` in PHPSpec examples:
7+
8+
1. It is heavy and requires stubbing full file system in order to run a simple spec example.
9+
2. Depending on ObjectManager is a bad idea, as you don't want to test some-else DI overrides.
10+
3. Simple modules that do not require database do not need fully functional object manager
11+
4. Adapting your business logic to another framework will require from you only to materialize generated classes, instead of depending on the whole ObjectManager library.
12+
13+
## Supported Generators
14+
15+
* Factory
16+
* Repository
17+
* Converter
18+
* Persistor
19+
* Mapper
20+
* SearchResults
421

522
## Installation
623

RELEASE_NOTES.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
11
# Release 0.1.0
22

3-
Factory generator adapter for PHPSpec auto-wiring in `let()` or `it_*()` methods.
3+
Magento DI adapter for PHPSpec auto-wiring in `let()` or `it_*()` methods.
4+
5+
Supports such generators:
6+
7+
* Factory
8+
* Repository
9+
* Converter
10+
* Persistor
11+
* Mapper
12+
* SearchResults

0 commit comments

Comments
 (0)