[Dotenv] Make load() variadic #23242

chalasr · 2017-06-20T21:07:50Z

Q	A
Branch?	4.0
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	Dotenv.php#L50
License	MIT
Doc PR	n/a

fabpot · 2017-06-20T21:10:47Z

src/Symfony/Component/Dotenv/Dotenv.php

     *
     * @throws FormatException when a file has a syntax error
     * @throws PathException   when a file does not exist or is not readable
     */
-    public function load($path/*, ...$paths*/)
+    public function load(...$paths)


I would keep the $path, ...$paths signature as it conveys the fact that at least one path is required.

got it, fixed

chalasr · 2017-06-20T21:16:32Z

Should we update the signature from ($path, ...$paths) to (string $path, string ...$paths) (Dotenv is final)?

stof · 2017-06-21T07:37:03Z

src/Symfony/Component/Dotenv/Tests/DotenvTest.php

+        file_put_contents($path1, 'FOO=BAR');
+        file_put_contents($path2, 'BAR=BAZ');
+
+        (new DotEnv())->load($path1, $path2);


The test loading multiple paths should actually be added in 3.3

javiereguiluz · 2017-06-21T08:51:26Z

src/Symfony/Component/Dotenv/Dotenv.php

@@ -45,10 +45,11 @@
     * @throws FormatException when a file has a syntax error
     * @throws PathException   when a file does not exist or is not readable
     */
-    public function load($path/*, ...$paths*/)
+    public function load($path, ...$paths)


Why can't we change load($path, ...$paths) to load(...$paths) in Symfony 4?

@javiereguiluz see #23242 (comment).
Imho, we could have kept only ... $paths, maybe throwing if $paths is empty, but having both in the signature looks a bit weird

well, having load($path, ...$paths) means that the signature itself tells people that at least 1 argument is required (and IDEs know it too then). load(...$paths) allows 0 arguments

imo it's not that bad if the ...$paths is empty. No file loaded, no env variable created

@Taluu writing $dotenv->load() in your code which is always a no-op because you misused it is a bad DX (and this is the experience talking: it was the initial API of the component when merging it in Symfony)

Indeed, can sound like calling load() will automagically look for some .env but nothing happens.

This PR was merged into the 3.3 branch. Discussion ---------- [Dotenv] Test load() with multiple paths | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #23242 (comment) | License | MIT | Doc PR | n/a Commits ------- dabecde [Dotenv] Test load() with multiple paths

fabpot

Can be rebase now that the test has been merged in 3.3.

This PR was merged into the 4.0-dev branch. Discussion ---------- [DI] Uncomment code | Q | A | ------------- | --- | Branch? | master  | Bug fix? | no | New feature? | no  | BC breaks? | no | Deprecations? | no  | Tests pass? | yes | Fixed tickets | N/A  | License | MIT | Doc PR | N/A I was about fixing all [other occurrences of commented code and `func_get/num_arg(s)`](https://github.com/symfony/symfony/search?utf8=%E2%9C%93&q=func_num_args&type=) as BC layer usages at once, but the following PRs will already cover it: - HttpFoundation: #22863 - Serializer: #23241 - Process: #22836 - DotEnv: #23242 So it only remains DI ones. Commits ------- 03f33b5 [DI] Uncomment code

chalasr · 2017-06-21T14:17:53Z

rebased, not added string typehints, let me know if I should.

fabpot · 2017-06-21T14:19:44Z

For typehints, we should have a discussion about how we want to introduce them.

fabpot · 2017-06-21T14:20:25Z

Thank you @chalasr.

This PR was merged into the 4.0-dev branch. Discussion ---------- [Dotenv] Make load() variadic | Q | A | ------------- | --- | Branch? | 4.0 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | [Dotenv.php#L50](https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Dotenv/Dotenv.php#L50) | License | MIT | Doc PR | n/a Commits ------- 408a33e [Dotenv] Make load() variadic

chalasr · 2017-06-21T17:19:17Z

@fabpot Actually, passing a value that can't be casted as string to this method would break. Given the class is final, I think adding them would be safe.

stof · 2017-06-22T09:26:49Z

@chalasr passign a non-castable value already breaks (inside the function). So I'm totally +1 for adding the typehint here (we cannot add them on non-final non-private methods due to BC, but we can here)

chalasr · 2017-06-22T09:31:42Z

@stof see #23262

This PR was merged into the 4.0-dev branch. Discussion ---------- Add scalar typehints/return types | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no (final, already breaks if doc not respected) | Deprecations? | no | Tests pass? | yes | Fixed tickets | #23242 (comment) | License | MIT | Doc PR | n/a Commits ------- 7b1715b [Yaml] use scalar type hints where possible 6ce70e4 Add scalar typehints/return types on final/internal/private code

This PR was merged into the 4.0-dev branch. Discussion ---------- Add scalar typehints/return types | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no (final, already breaks if doc not respected) | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony/symfony#23242 (comment) | License | MIT | Doc PR | n/a Commits ------- 7b1715b078 [Yaml] use scalar type hints where possible 6ce70e4bf9 Add scalar typehints/return types on final/internal/private code

This PR was merged into the 4.0-dev branch. Discussion ---------- Add scalar typehints/return types | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no (final, already breaks if doc not respected) | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony/symfony#23242 (comment) | License | MIT | Doc PR | n/a Commits ------- 7b1715b [Yaml] use scalar type hints where possible 6ce70e4 Add scalar typehints/return types on final/internal/private code

This PR was merged into the 4.0-dev branch. Discussion ---------- Add scalar typehints/return types | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no (final, already breaks if doc not respected) | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony/symfony#23242 (comment) | License | MIT | Doc PR | n/a Commits ------- 7b1715b078 [Yaml] use scalar type hints where possible 6ce70e4bf9 Add scalar typehints/return types on final/internal/private code

carsonbot added the Status: Needs Review label Jun 20, 2017

fabpot requested changes Jun 20, 2017

View reviewed changes

chalasr force-pushed the dotenv4-variadic branch 2 times, most recently from f962fec to 96081cd Compare June 20, 2017 21:13

ogizanagi mentioned this pull request Jun 21, 2017

[DI] Uncomment code #23244

Merged

stof reviewed Jun 21, 2017

View reviewed changes

chalasr mentioned this pull request Jun 21, 2017

[Dotenv] Test load() with multiple paths #23245

Merged

javiereguiluz reviewed Jun 21, 2017

View reviewed changes

fabpot approved these changes Jun 21, 2017

View reviewed changes

[Dotenv] Make load() variadic

408a33e

chalasr force-pushed the dotenv4-variadic branch from 96081cd to 408a33e Compare June 21, 2017 14:17

fabpot merged commit 408a33e into symfony:master Jun 21, 2017

chalasr deleted the dotenv4-variadic branch June 21, 2017 14:21

chalasr mentioned this pull request Jun 22, 2017

Add scalar typehints/return types #23262

Merged

Uh oh!

[Dotenv] Make load() variadic #23242

[Dotenv] Make load() variadic #23242

Uh oh!

Conversation

chalasr commented Jun 20, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chalasr commented Jun 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chalasr Jun 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chalasr Jun 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabpot left a comment

Choose a reason for hiding this comment

Uh oh!

chalasr commented Jun 21, 2017

Uh oh!

fabpot commented Jun 21, 2017

Uh oh!

fabpot commented Jun 21, 2017

Uh oh!

chalasr commented Jun 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stof commented Jun 22, 2017

Uh oh!

chalasr commented Jun 22, 2017

Uh oh!

Uh oh!

chalasr commented Jun 20, 2017 •

edited

Loading

chalasr Jun 21, 2017 •

edited

Loading

chalasr Jun 21, 2017 •

edited

Loading

chalasr commented Jun 21, 2017 •

edited

Loading