Skip to content

Commit 114b770

Browse files
nicolas-grekasnicolas-grekas
committed
[Contracts] split in one package per sub-contracts
1 parent 30e42ac commit 114b770

File tree

17 files changed

+316
-16
lines changed

17 files changed

+316
-16
lines changed

‎Cache/LICENSE‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2018-2019 Fabien Potencier
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is furnished
8+
to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

‎Cache/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Symfony Cache Contracts
2+
=======================
3+
4+
A set of abstractions extracted out of the Symfony components.
5+
6+
Can be used to build on semantics that the Symfony components proved useful - and
7+
that already have battle tested implementations.
8+
9+
See https://github.com/symfony/contracts/blob/master/README.md for more information.

‎Cache/composer.json‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"name": "symfony/cache-contracts",
3+
"type": "library",
4+
"description": "Generic abstractions related to caching",
5+
"keywords": ["abstractions", "contracts", "decoupling", "interfaces", "interoperability", "standards"],
6+
"homepage": "https://symfony.com",
7+
"license": "MIT",
8+
"authors": [
9+
{
10+
"name": "Nicolas Grekas",
11+
"email": "p@tchwork.com"
12+
},
13+
{
14+
"name": "Symfony Community",
15+
"homepage": "https://symfony.com/contributors"
16+
}
17+
],
18+
"require": {
19+
"php": "^7.1.3"
20+
},
21+
"suggest": {
22+
"psr/cache": "",
23+
"symfony/cache-implementation": ""
24+
},
25+
"autoload": {
26+
"psr-4": { "Symfony\\Contracts\\Cache\\": "" }
27+
},
28+
"minimum-stability": "dev",
29+
"extra": {
30+
"branch-alias": {
31+
"dev-master": "1.1-dev"
32+
}
33+
}
34+
}

‎EventDispatcher/LICENSE‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2018-2019 Fabien Potencier
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is furnished
8+
to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

‎EventDispatcher/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Symfony EventDispatcher Contracts
2+
=================================
3+
4+
A set of abstractions extracted out of the Symfony components.
5+
6+
Can be used to build on semantics that the Symfony components proved useful - and
7+
that already have battle tested implementations.
8+
9+
See https://github.com/symfony/contracts/blob/master/README.md for more information.

‎EventDispatcher/composer.json‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"name": "symfony/event-dispatcher-contracts",
3+
"type": "library",
4+
"description": "Generic abstractions related to dispatching event",
5+
"keywords": ["abstractions", "contracts", "decoupling", "interfaces", "interoperability", "standards"],
6+
"homepage": "https://symfony.com",
7+
"license": "MIT",
8+
"authors": [
9+
{
10+
"name": "Nicolas Grekas",
11+
"email": "p@tchwork.com"
12+
},
13+
{
14+
"name": "Symfony Community",
15+
"homepage": "https://symfony.com/contributors"
16+
}
17+
],
18+
"require": {
19+
"php": "^7.1.3"
20+
},
21+
"suggest": {
22+
"psr/event-dispatcher": "",
23+
"symfony/event-dispatcher-implementation": ""
24+
},
25+
"autoload": {
26+
"psr-4": { "Symfony\\Contracts\\EventDispatcher\\": "" }
27+
},
28+
"minimum-stability": "dev",
29+
"extra": {
30+
"branch-alias": {
31+
"dev-master": "1.1-dev"
32+
}
33+
}
34+
}

‎HttpClient/LICENSE‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2018-2019 Fabien Potencier
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is furnished
8+
to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

‎HttpClient/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Symfony HttpClient Contracts
2+
============================
3+
4+
A set of abstractions extracted out of the Symfony components.
5+
6+
Can be used to build on semantics that the Symfony components proved useful - and
7+
that already have battle tested implementations.
8+
9+
See https://github.com/symfony/contracts/blob/master/README.md for more information.

‎HttpClient/composer.json‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"name": "symfony/http-client-contracts",
3+
"type": "library",
4+
"description": "Generic abstractions related to HTTP clients",
5+
"keywords": ["abstractions", "contracts", "decoupling", "interfaces", "interoperability", "standards"],
6+
"homepage": "https://symfony.com",
7+
"license": "MIT",
8+
"authors": [
9+
{
10+
"name": "Nicolas Grekas",
11+
"email": "p@tchwork.com"
12+
},
13+
{
14+
"name": "Symfony Community",
15+
"homepage": "https://symfony.com/contributors"
16+
}
17+
],
18+
"require": {
19+
"php": "^7.1.3"
20+
},
21+
"suggest": {
22+
"symfony/http-client-implementation": ""
23+
},
24+
"autoload": {
25+
"psr-4": { "Symfony\\Contracts\\HttpClient\\": "" }
26+
},
27+
"minimum-stability": "dev",
28+
"extra": {
29+
"branch-alias": {
30+
"dev-master": "1.1-dev"
31+
}
32+
}
33+
}

‎README.md‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,22 +44,6 @@ providing abstractions that are useful on their own while still compatible with
4444
implementations provided by Symfony. Although not the main target, we hope that
4545
the declared contracts will directly or indirectly contribute to the PHP-FIG.
4646

47-
### Why isn't this package split into several packages?
48-
49-
Putting all interfaces in one package eases discoverability and dependency
50-
management. Instead of dealing with a myriad of small packages and the
51-
corresponding matrix of versions, you just need to deal with one package and one
52-
version. Also when using IDE autocompletion or just reading the source code, it
53-
makes it easier to figure out which contracts are provided.
54-
55-
There are two downsides to this approach: you may have unused files in your
56-
`vendor/` directory, and in the future, it will be impossible to use two
57-
different sub-namespaces in different major versions of the package. For the
58-
"unused files" downside, it has no practical consequences: their file sizes are
59-
very small, and there is no performance overhead at all since they are never
60-
loaded. For major versions, this package follows the Symfony BC + deprecation
61-
policies, with an additional restriction to never remove deprecated interfaces.
62-
6347
Resources
6448
---------
6549

0 commit comments

Comments
 (0)