Skip to content

Commit 2c2eead

Browse files
weaverryanweaverryan
committed
bug #580 Turbo mercure package abandoned (weaverryan)
This PR was squashed before being merged into the 2.x branch. Discussion ---------- Turbo mercure package abandoned | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | Tickets | Fix #578 | License | MIT Hi! The `symfony/ux-turbo-mercure` package is now abandoned - see #578 - and instead now lives in `symfony/ux-turbo`. That's actually already the case in 2.6.0, but in 2.6.1, we will move the actual Stimulus controller as well. This moves the controller, fixes the autoloading & updates the README and CHANGELOG. I tested locally on ux.symfony.com (you can see those changes here too, though I'll need to update the package properly in that project after this is merged). Cheers! Commits ------- 0747273 Turbo mercure package abandoned
2 parents 25b7635 + 0747273 commit 2c2eead

21 files changed

+47
-208
lines changed

‎src/Turbo/CHANGELOG.md

+15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# CHANGELOG
22

3+
## 2.6.1
4+
5+
- The `symfony/ux-turbo-mercure` package was abandoned and moved into this package.
6+
If you were previously using `symfony/ux-turbo-mercure`, you can remove it
7+
and only install mecure-bundle:
8+
9+
```
10+
composer require symfony/mercure-bundle
11+
composer remove symfony/ux-turbo-mercure
12+
```
13+
14+
After upgrading this package to 2.6.1, you should have a new entry in
15+
`assets/controllers.json` called `mercure-turbo-stream`. Change
16+
`enabled: false` to `enabled: true`.
17+
318
## 2.6.0
419
520
- [BC BREAK] The `assets/` directory was moved from `Resources/assets/` to `assets/`. Make

‎src/Turbo/src/Bridge/Mercure/assets/dist/turbo_stream_controller.js renamed to ‎src/Turbo/assets/dist/turbo_stream_controller.js

File renamed without changes.

‎src/Turbo/assets/package.json

+7-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
"webpackMode": "eager",
1212
"fetch": "eager",
1313
"enabled": true
14+
},
15+
"mercure-turbo-stream": {
16+
"main": "dist/turbo_stream_controller.js",
17+
"fetch": "eager",
18+
"enabled": false
1419
}
1520
}
1621
},
@@ -20,6 +25,7 @@
2025
},
2126
"devDependencies": {
2227
"@hotwired/turbo": "^7.1.0",
23-
"@hotwired/stimulus": "^3.0.0"
28+
"@hotwired/stimulus": "^3.0.0",
29+
"jest-canvas-mock": "^2.3.0"
2430
}
2531
}

‎src/Turbo/src/Bridge/Mercure/assets/src/turbo_stream_controller.ts renamed to ‎src/Turbo/assets/src/turbo_stream_controller.ts

File renamed without changes.

‎src/Turbo/src/Bridge/Mercure/assets/test/turbo_stream_controller.test.ts renamed to ‎src/Turbo/assets/test/turbo_stream_controller.test.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import TurboStreamController from '../src/turbo_stream_controller';
1616

1717
const startStimulus = () => {
1818
const application = Application.start();
19-
application.register('symfony--ux-turbo-mercure--turbo-stream', TurboStreamController);
19+
application.register('symfony--ux-turbo--mercure-turbo-stream', TurboStreamController);
2020
};
2121

2222
/* eslint-disable no-undef */
@@ -31,7 +31,7 @@ describe('TurboStreamController', () => {
3131
}));
3232

3333
container = mountDOM(
34-
'<div data-testid="turbo-stream-mercure" data-controller="symfony--ux-turbo-mercure--turbo-stream" data-symfony--ux-turbo-mercure--turbo-stream-hub-value="https://example.com/.well-known/mercure" data-symfony--ux-turbo-mercure--turbo-stream-topic-value="foo"></div>'
34+
'<div data-testid="turbo-stream-mercure" data-controller="symfony--ux-turbo--mercure-turbo-stream" data-symfony--ux-turbo--mercure-turbo-stream-hub-value="https://example.com/.well-known/mercure" data-symfony--ux-turbo--mercure-turbo-stream-topic-value="foo"></div>'
3535
);
3636
});
3737

@@ -44,7 +44,7 @@ describe('TurboStreamController', () => {
4444

4545
// smoke test
4646
expect(getByTestId(container, 'turbo-stream-mercure')).toHaveAttribute(
47-
'data-symfony--ux-turbo-mercure--turbo-stream-topic-value',
47+
'data-symfony--ux-turbo--mercure-turbo-stream-topic-value',
4848
'foo'
4949
);
5050
});

‎src/Turbo/composer.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@
2424
],
2525
"autoload": {
2626
"psr-4": {
27-
"Symfony\\UX\\Turbo\\": "src/",
28-
"Symfony\\UX\\Turbo\\Bridge\\Mercure\\": "src/Bridge/Mercure/src"
27+
"Symfony\\UX\\Turbo\\": "src/"
2928
}
3029
},
3130
"autoload-dev": {

‎src/Turbo/doc/index.rst

+13-3
Original file line numberDiff line numberDiff line change
@@ -383,9 +383,19 @@ Start by installing `the Mercure support`_ on your project:
383383

384384
.. code-block:: terminal
385385
386-
$ composer require symfony/ux-turbo-mercure
387-
$ yarn install --force
388-
$ yarn encore dev
386+
$ composer require symfony/mercure-bundle
387+
388+
Then, enable the "mercure stream" controller in ``assets/controllers.json``:
389+
390+
.. code-block:: diff
391+
392+
"@symfony/ux-turbo": {
393+
"mercure-turbo-stream": {
394+
+ "enabled": true,
395+
- "enabled": false,
396+
"fetch": "lazy"
397+
}
398+
},
389399
390400
The easiest way to have a working development (and production-ready)
391401
environment is to use `Symfony Docker`_, which comes with

‎src/Turbo/src/Bridge/Mercure/src/Broadcaster.php renamed to ‎src/Turbo/src/Bridge/Mercure/Broadcaster.php

File renamed without changes.

‎src/Turbo/src/Bridge/Mercure/LICENSE

-19
This file was deleted.

‎src/Turbo/src/Bridge/Mercure/README.md

-15
This file was deleted.

‎src/Turbo/src/Bridge/Mercure/src/TurboStreamListenRenderer.php renamed to ‎src/Turbo/src/Bridge/Mercure/TurboStreamListenRenderer.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
use Twig\Environment;
1919

2020
/**
21-
* Renders the attributes to load the "turbo-stream-mercure" controller.
21+
* Renders the attributes to load the "mercure-turbo-stream" controller.
2222
*
2323
* @author Kévin Dunglas <[email protected]>
2424
*/
@@ -52,7 +52,7 @@ public function renderTurboStreamListen(Environment $env, $topic): string
5252

5353
return $this->stimulusTwigExtension->renderStimulusController(
5454
$env,
55-
'symfony/ux-turbo-mercure/turbo-stream',
55+
'symfony/ux-turbo/mercure-turbo-stream',
5656
['topic' => $topic, 'hub' => $this->hub->getPublicUrl()]
5757
);
5858
}

‎src/Turbo/src/Bridge/Mercure/assets/jest.config.js

-1
This file was deleted.

‎src/Turbo/src/Bridge/Mercure/assets/package.json

-26
This file was deleted.

‎src/Turbo/src/Bridge/Mercure/composer.json

-44
This file was deleted.

‎src/Turbo/tests/app/assets/app.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
*/
99

1010
import { Application } from "@hotwired/stimulus";
11-
import TurboStreamMercureController from "@symfony/ux-turbo-mercure/dist/turbo_stream_controller";
11+
import TurboStreamMercureController from "@symfony/ux-turbo/dist/turbo_stream_controller";
1212

1313
const application = Application.start();
14-
application.register("symfony--ux-turbo-mercure--turbo-stream", TurboStreamMercureController);
14+
application.register("symfony--ux-turbo--mercure-turbo-stream", TurboStreamMercureController);
1515

1616
console.log('test app initialized');

‎src/Turbo/tests/app/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"devDependencies": {
33
"@hotwired/turbo": "^7.0.1",
44
"@symfony/ux-turbo": "file:../../assets",
5-
"@symfony/ux-turbo-mercure": "file:../../src/Bridge/Mercure/assets",
65
"@symfony/webpack-encore": "^0.32.0",
76
"core-js": "^3.0.0",
87
"regenerator-runtime": "^0.13.2",

‎ux.symfony.com/assets/controllers.json

+2-4
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,8 @@
7171
"turbo-core": {
7272
"enabled": true,
7373
"fetch": "eager"
74-
}
75-
},
76-
"@symfony/ux-turbo-mercure": {
77-
"turbo-stream": {
74+
},
75+
"mercure-turbo-stream": {
7876
"enabled": true,
7977
"fetch": "lazy"
8078
}

‎ux.symfony.com/composer.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"symfony/flex": "^2",
2323
"symfony/form": "6.0.*",
2424
"symfony/framework-bundle": "6.0.*",
25-
"symfony/mercure-bundle": "^0.3.4",
25+
"symfony/mercure-bundle": "^0.3.5",
2626
"symfony/monolog-bundle": "^3.0",
2727
"symfony/notifier": "6.0.*",
2828
"symfony/proxy-manager-bridge": "6.0.*",
@@ -38,7 +38,6 @@
3838
"symfony/ux-react": "2.x-dev",
3939
"symfony/ux-swup": "2.x-dev",
4040
"symfony/ux-turbo": "2.x-dev",
41-
"symfony/ux-turbo-mercure": "2.x-dev",
4241
"symfony/ux-twig-component": "2.x-dev",
4342
"symfony/ux-typed": "2.x-dev",
4443
"symfony/ux-vue": "2.x-dev",

‎ux.symfony.com/composer.lock

+1-79
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎ux.symfony.com/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
"@symfony/ux-react": "file:vendor/symfony/ux-react/Resources/assets",
2525
"@symfony/ux-swup": "file:vendor/symfony/ux-swup/Resources/assets",
2626
"@symfony/ux-turbo": "file:vendor/symfony/ux-turbo/Resources/assets",
27-
"@symfony/ux-turbo-mercure": "file:vendor/symfony/ux-turbo-mercure/Resources/assets",
2827
"@symfony/ux-typed": "file:vendor/symfony/ux-typed/Resources/assets",
2928
"@symfony/ux-vue": "file:vendor/symfony/ux-vue/Resources/assets",
3029
"@symfony/webpack-encore": "^2.0.0",

‎ux.symfony.com/symfony.lock

-3
Original file line numberDiff line numberDiff line change
@@ -562,9 +562,6 @@
562562
"symfony/ux-turbo": {
563563
"version": "v2.1.0"
564564
},
565-
"symfony/ux-turbo-mercure": {
566-
"version": "v2.1.0"
567-
},
568565
"symfony/ux-twig-component": {
569566
"version": "v2.1.0"
570567
},

0 commit comments

Comments
 (0)