Skip to content

[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable#11064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jesseleite merged 8 commits into from
Dec 2, 2024
Merged

[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable #11064

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c702166
Spec out `addon: true` for starter kits that should live on as compos…
jesseleite Nov 6, 2024
5a8649c
Blink config, no reason to read it twice.
jesseleite Nov 6, 2024
109317a
Pass tests.
jesseleite Nov 6, 2024
bdfce39
Refactor to `updatable: true`.
jesseleite Nov 6, 2024
faeb1dc
Merge branch '5.x' of https://github.com/statamic/cms into starter-ki…
jesseleite Nov 26, 2024
c299481
Add test coverage to ensure package remains in `require` (not `requir…
jesseleite Nov 26, 2024
261f689
Pass test. (We don’t really have reason to `requireDev` here anymore.)
jesseleite Nov 26, 2024
9ab6e51
Adjust these tests too.
jesseleite Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions src/StarterKits/Installer.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -250,7 +250,7 @@ function () {
: $this->package;

try {
Composer::withoutQueue()->throwOnFailure()->requireDev($package);
Composer::withoutQueue()->throwOnFailure()->require($package);
} catch (ProcessException $exception) {
$this->rollbackWithError("Error installing starter kit [{$package}].", $exception->getMessage());
}
Expand DownExpand Up@@ -548,14 +548,14 @@ function () {
*/
public function removeStarterKit(): self
{
if ($this->disableCleanup) {
if ($this->isUpdatable() || $this->disableCleanup) {
return $this;
}

spin(
function () {
if (Composer::isInstalled($this->package)) {
Composer::withoutQueue()->throwOnFailure(false)->removeDev($this->package);
Composer::withoutQueue()->throwOnFailure(false)->remove($this->package);
}
},
'Cleaning up temporary files...'
Expand DownExpand Up@@ -589,7 +589,7 @@ protected function completeInstall(): self
*/
protected function removeRepository(): self
{
if ($this->fromLocalRepo || ! $this->url) {
if ($this->isUpdatable() || $this->fromLocalRepo || ! $this->url) {
return $this;
}

Expand DownExpand Up@@ -672,12 +672,22 @@ protected function starterKitPath(?string $path = null): string
*/
protected function config(?string $key = null): mixed
{
$config = collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
$config = Blink::once('starter-kit-config', function () {
return collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
});

if ($key) {
return $config->get($key);
}

return $config;
}

/**
* Should starter kit be treated as an updatable package, and live on for future composer updates, etc?
*/
protected function isUpdatable(): bool
{
return (bool) $this->config('updatable');
}
}
89 changes: 85 additions & 4 deletions tests/StarterKits/InstallTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use Statamic\Facades\Blink;
use Statamic\Facades\Config;
use Statamic\Facades\YAML;
use Statamic\Support\Arr;
use Statamic\Support\Str;
use Tests\Fakes\Composer\FakeComposer;
use Tests\TestCase;
Expand DownExpand Up@@ -56,6 +57,7 @@ public function it_installs_starter_kit()
$this->assertFalse(Blink::has('starter-kit-repository-added'));
$this->assertFileDoesNotExist($this->kitVendorPath());
$this->assertFileDoesNotExist(base_path('composer.json.bak'));
$this->assertComposerJsonDoesntHavePackage('statamic/cool-runnings');
$this->assertComposerJsonDoesntHave('repositories');
$this->assertFileExists(base_path('copied.md'));
}
Expand DownExpand Up@@ -209,6 +211,70 @@ public function it_restores_existing_repositories_after_successful_install()
$this->assertEquals($expectedRepositories, $composerJson['repositories']);
}

#[Test]
public function it_installs_as_living_package_with_custom_config()
{
$this->setConfig([
'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
'export_paths' => [
'copied.md',
],
]);

$this->assertFileDoesNotExist(base_path('copied.md'));
$this->assertFileDoesNotExist($this->kitVendorPath());

$this->installCoolRunnings();

$this->assertFileExists(base_path('copied.md'));
$this->assertComposerJsonDoesntHave('repositories');

// Keep package around
$this->assertFileExists($this->kitVendorPath());
$this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

// But ensure we still delete backup composer.json, which is only used for error handling purposes
$this->assertFileDoesNotExist(base_path('composer.json.bak'));
}

#[Test]
public function it_leaves_custom_repository_for_living_packages_that_need_it()
{
$this->setConfig([
'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
'export_paths' => [
'copied.md',
],
]);

$this->assertFileDoesNotExist(base_path('copied.md'));
$this->assertFileDoesNotExist($this->kitVendorPath());
$this->assertComposerJsonDoesntHave('repositories');

$this->installCoolRunnings([], [
'outpost.*' => Http::response(['data' => ['price' => null]], 200),
'github.com/*' => Http::response('', 200),
'*' => Http::response('', 404),
]);

$this->assertFileExists(base_path('copied.md'));

// Keep package around
$this->assertFileExists($this->kitVendorPath());
$this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

// As well as custom repository, which will be needed for composer updates, if it was needed for install
$composerJson = json_decode($this->files->get(base_path('composer.json')), true);
$this->assertCount(1, $composerJson['repositories']);
$this->assertEquals([[
'type' => 'vcs',
'url' => 'https://github.com/statamic/cool-runnings',
]], $composerJson['repositories']);

// But delete backup composer.json, which is only used for error handling purposes
$this->assertFileDoesNotExist(base_path('composer.json.bak'));
}

#[Test]
public function it_fails_if_starter_kit_config_does_not_exist()
{
Expand DownExpand Up@@ -688,8 +754,8 @@ public function it_parses_branch_from_package_param_when_installing()
]);

// Ensure `Composer::requireDev()` gets called with `package:branch`
$this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
$this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-custom-branch');
$this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
$this->assertEquals(Blink::get('composer-require-branch'), 'dev-custom-branch');

// But ensure the rest of the installer handles parsed `package` without branch messing things up
$this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand All@@ -711,8 +777,8 @@ public function it_installs_branch_with_slash_without_failing_package_validation
]);

// Ensure `Composer::requireDev()` gets called with `package:branch`
$this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
$this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-feature/custom-branch');
$this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
$this->assertEquals(Blink::get('composer-require-branch'), 'dev-feature/custom-branch');

// But ensure the rest of the installer handles parsed `package` without branch messing things up
$this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand DownExpand Up@@ -1603,6 +1669,21 @@ private function assertFileDoesntHaveContent($expected, $path)
$this->assertStringNotContainsString($expected, $this->files->get($path));
}

private function assertComposerJsonHasPackage($requireKey, $package)
{
$composerJson = json_decode($this->files->get(base_path('composer.json')), true);

$this->assertTrue(Arr::has($composerJson, "{$requireKey}.{$package}"));
}

private function assertComposerJsonDoesntHavePackage($package)
{
$composerJson = json_decode($this->files->get(base_path('composer.json')), true);

$this->assertFalse(Arr::has($composerJson, "require.{$package}"));
$this->assertFalse(Arr::has($composerJson, "require-dev.{$package}"));
}

private function assertComposerJsonHasPackageVersion($requireKey, $package, $version)
{
$composerJson = json_decode($this->files->get(base_path('composer.json')), true);
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable by jesseleite · Pull Request #11064 · statamic/cms · GitHub
Skip to content
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable#11064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jesseleite
merged 8 commits into

from

Dec 2, 2024
 Merged


[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable
#11064
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
c702166

Spec out `addon: true` for starter kits that should live on as compos…


jesseleite Nov 6, 2024
5a8649c

Blink config, no reason to read it twice.


jesseleite Nov 6, 2024
109317a

Pass tests.


jesseleite Nov 6, 2024
bdfce39

Refactor to `updatable: true`.


jesseleite Nov 6, 2024
faeb1dc

Merge branch '5.x' of https://github.com/statamic/cms into starter-ki…


jesseleite Nov 26, 2024
c299481

Add test coverage to ensure package remains in `require` (not `requir…


jesseleite Nov 26, 2024
261f689

Pass test. (We don’t really have reason to `requireDev` here anymore.)


jesseleite Nov 26, 2024
9ab6e51

Adjust these tests too.


jesseleite Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


20 changes: 15 additions & 5 deletions
src/StarterKits/Installer.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -250,7 +250,7 @@ function () {
 : $this->package;

 try {
 Composer::withoutQueue()->throwOnFailure()->requireDev($package);
 Composer::withoutQueue()->throwOnFailure()->require($package);
 } catch (ProcessException $exception) {
 $this->rollbackWithError("Error installing starter kit [{$package}].", $exception->getMessage());
 }
Expand DownExpand Up@@ -548,14 +548,14 @@ function () {
 */
 public function removeStarterKit(): self
 {
 if ($this->disableCleanup) {
 if ($this->isUpdatable() || $this->disableCleanup) {
 return $this;
 }

 spin(
 function () {
 if (Composer::isInstalled($this->package)) {
 Composer::withoutQueue()->throwOnFailure(false)->removeDev($this->package);
 Composer::withoutQueue()->throwOnFailure(false)->remove($this->package);
 }
 },
 'Cleaning up temporary files...'
Expand DownExpand Up@@ -589,7 +589,7 @@ protected function completeInstall(): self
 */
 protected function removeRepository(): self
 {
 if ($this->fromLocalRepo || ! $this->url) {
 if ($this->isUpdatable() || $this->fromLocalRepo || ! $this->url) {
 return $this;
 }

Expand DownExpand Up@@ -672,12 +672,22 @@ protected function starterKitPath(?string $path = null): string
 */
 protected function config(?string $key = null): mixed
 {
 $config = collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 $config = Blink::once('starter-kit-config', function () {
 return collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 });

 if ($key) {
 return $config->get($key);
 }

 return $config;
 }

 /**
 * Should starter kit be treated as an updatable package, and live on for future composer updates, etc?
 */
 protected function isUpdatable(): bool
 {
 return (bool) $this->config('updatable');
 }
}

89 changes: 85 additions & 4 deletions
tests/StarterKits/InstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use Statamic\Facades\Blink;
use Statamic\Facades\Config;
use Statamic\Facades\YAML;
use Statamic\Support\Arr;
use Statamic\Support\Str;
use Tests\Fakes\Composer\FakeComposer;
use Tests\TestCase;
Expand DownExpand Up@@ -56,6 +57,7 @@ public function it_installs_starter_kit()
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 $this->assertComposerJsonDoesntHavePackage('statamic/cool-runnings');
 $this->assertComposerJsonDoesntHave('repositories');
 $this->assertFileExists(base_path('copied.md'));
 }
Expand DownExpand Up@@ -209,6 +211,70 @@ public function it_restores_existing_repositories_after_successful_install()
 $this->assertEquals($expectedRepositories, $composerJson['repositories']);
 }

 #[Test]
 public function it_installs_as_living_package_with_custom_config()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());

 $this->installCoolRunnings();

 $this->assertFileExists(base_path('copied.md'));
 $this->assertComposerJsonDoesntHave('repositories');

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // But ensure we still delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_leaves_custom_repository_for_living_packages_that_need_it()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertComposerJsonDoesntHave('repositories');

 $this->installCoolRunnings([], [
 'outpost.*' => Http::response(['data' => ['price' => null]], 200),
 'github.com/*' => Http::response('', 200),
 '*' => Http::response('', 404),
 ]);

 $this->assertFileExists(base_path('copied.md'));

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // As well as custom repository, which will be needed for composer updates, if it was needed for install
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
 $this->assertCount(1, $composerJson['repositories']);
 $this->assertEquals([[
 'type' => 'vcs',
 'url' => 'https://github.com/statamic/cool-runnings',
 ]], $composerJson['repositories']);

 // But delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_fails_if_starter_kit_config_does_not_exist()
 {
Expand DownExpand Up@@ -688,8 +754,8 @@ public function it_parses_branch_from_package_param_when_installing()
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand All@@ -711,8 +777,8 @@ public function it_installs_branch_with_slash_without_failing_package_validation
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-feature/custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-feature/custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand DownExpand Up@@ -1603,6 +1669,21 @@ private function assertFileDoesntHaveContent($expected, $path)
 $this->assertStringNotContainsString($expected, $this->files->get($path));
 }

 private function assertComposerJsonHasPackage($requireKey, $package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertTrue(Arr::has($composerJson, "{$requireKey}.{$package}"));
 }

 private function assertComposerJsonDoesntHavePackage($package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertFalse(Arr::has($composerJson, "require.{$package}"));
 $this->assertFalse(Arr::has($composerJson, "require-dev.{$package}"));
 }

 private function assertComposerJsonHasPackageVersion($requireKey, $package, $version)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable by jesseleite · Pull Request #11064 · statamic/cms · GitHub
Skip to content
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable#11064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jesseleite
merged 8 commits into

from

Dec 2, 2024
 Merged


[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable
#11064
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
c702166

Spec out `addon: true` for starter kits that should live on as compos…


jesseleite Nov 6, 2024
5a8649c

Blink config, no reason to read it twice.


jesseleite Nov 6, 2024
109317a

Pass tests.


jesseleite Nov 6, 2024
bdfce39

Refactor to `updatable: true`.


jesseleite Nov 6, 2024
faeb1dc

Merge branch '5.x' of https://github.com/statamic/cms into starter-ki…


jesseleite Nov 26, 2024
c299481

Add test coverage to ensure package remains in `require` (not `requir…


jesseleite Nov 26, 2024
261f689

Pass test. (We don’t really have reason to `requireDev` here anymore.)


jesseleite Nov 26, 2024
9ab6e51

Adjust these tests too.


jesseleite Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


20 changes: 15 additions & 5 deletions
src/StarterKits/Installer.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -250,7 +250,7 @@ function () {
 : $this->package;

 try {
 Composer::withoutQueue()->throwOnFailure()->requireDev($package);
 Composer::withoutQueue()->throwOnFailure()->require($package);
 } catch (ProcessException $exception) {
 $this->rollbackWithError("Error installing starter kit [{$package}].", $exception->getMessage());
 }
Expand DownExpand Up@@ -548,14 +548,14 @@ function () {
 */
 public function removeStarterKit(): self
 {
 if ($this->disableCleanup) {
 if ($this->isUpdatable() || $this->disableCleanup) {
 return $this;
 }

 spin(
 function () {
 if (Composer::isInstalled($this->package)) {
 Composer::withoutQueue()->throwOnFailure(false)->removeDev($this->package);
 Composer::withoutQueue()->throwOnFailure(false)->remove($this->package);
 }
 },
 'Cleaning up temporary files...'
Expand DownExpand Up@@ -589,7 +589,7 @@ protected function completeInstall(): self
 */
 protected function removeRepository(): self
 {
 if ($this->fromLocalRepo || ! $this->url) {
 if ($this->isUpdatable() || $this->fromLocalRepo || ! $this->url) {
 return $this;
 }

Expand DownExpand Up@@ -672,12 +672,22 @@ protected function starterKitPath(?string $path = null): string
 */
 protected function config(?string $key = null): mixed
 {
 $config = collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 $config = Blink::once('starter-kit-config', function () {
 return collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 });

 if ($key) {
 return $config->get($key);
 }

 return $config;
 }

 /**
 * Should starter kit be treated as an updatable package, and live on for future composer updates, etc?
 */
 protected function isUpdatable(): bool
 {
 return (bool) $this->config('updatable');
 }
}

89 changes: 85 additions & 4 deletions
tests/StarterKits/InstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use Statamic\Facades\Blink;
use Statamic\Facades\Config;
use Statamic\Facades\YAML;
use Statamic\Support\Arr;
use Statamic\Support\Str;
use Tests\Fakes\Composer\FakeComposer;
use Tests\TestCase;
Expand DownExpand Up@@ -56,6 +57,7 @@ public function it_installs_starter_kit()
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 $this->assertComposerJsonDoesntHavePackage('statamic/cool-runnings');
 $this->assertComposerJsonDoesntHave('repositories');
 $this->assertFileExists(base_path('copied.md'));
 }
Expand DownExpand Up@@ -209,6 +211,70 @@ public function it_restores_existing_repositories_after_successful_install()
 $this->assertEquals($expectedRepositories, $composerJson['repositories']);
 }

 #[Test]
 public function it_installs_as_living_package_with_custom_config()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());

 $this->installCoolRunnings();

 $this->assertFileExists(base_path('copied.md'));
 $this->assertComposerJsonDoesntHave('repositories');

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // But ensure we still delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_leaves_custom_repository_for_living_packages_that_need_it()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertComposerJsonDoesntHave('repositories');

 $this->installCoolRunnings([], [
 'outpost.*' => Http::response(['data' => ['price' => null]], 200),
 'github.com/*' => Http::response('', 200),
 '*' => Http::response('', 404),
 ]);

 $this->assertFileExists(base_path('copied.md'));

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // As well as custom repository, which will be needed for composer updates, if it was needed for install
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
 $this->assertCount(1, $composerJson['repositories']);
 $this->assertEquals([[
 'type' => 'vcs',
 'url' => 'https://github.com/statamic/cool-runnings',
 ]], $composerJson['repositories']);

 // But delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_fails_if_starter_kit_config_does_not_exist()
 {
Expand DownExpand Up@@ -688,8 +754,8 @@ public function it_parses_branch_from_package_param_when_installing()
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand All@@ -711,8 +777,8 @@ public function it_installs_branch_with_slash_without_failing_package_validation
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-feature/custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-feature/custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand DownExpand Up@@ -1603,6 +1669,21 @@ private function assertFileDoesntHaveContent($expected, $path)
 $this->assertStringNotContainsString($expected, $this->files->get($path));
 }

 private function assertComposerJsonHasPackage($requireKey, $package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertTrue(Arr::has($composerJson, "{$requireKey}.{$package}"));
 }

 private function assertComposerJsonDoesntHavePackage($package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertFalse(Arr::has($composerJson, "require.{$package}"));
 $this->assertFalse(Arr::has($composerJson, "require-dev.{$package}"));
 }

 private function assertComposerJsonHasPackageVersion($requireKey, $package, $version)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable by jesseleite · Pull Request #11064 · statamic/cms · GitHub
Skip to content
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable#11064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jesseleite
merged 8 commits into

from

Dec 2, 2024
 Merged


[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable
#11064
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
c702166

Spec out `addon: true` for starter kits that should live on as compos…


jesseleite Nov 6, 2024
5a8649c

Blink config, no reason to read it twice.


jesseleite Nov 6, 2024
109317a

Pass tests.


jesseleite Nov 6, 2024
bdfce39

Refactor to `updatable: true`.


jesseleite Nov 6, 2024
faeb1dc

Merge branch '5.x' of https://github.com/statamic/cms into starter-ki…


jesseleite Nov 26, 2024
c299481

Add test coverage to ensure package remains in `require` (not `requir…


jesseleite Nov 26, 2024
261f689

Pass test. (We don’t really have reason to `requireDev` here anymore.)


jesseleite Nov 26, 2024
9ab6e51

Adjust these tests too.


jesseleite Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


20 changes: 15 additions & 5 deletions
src/StarterKits/Installer.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -250,7 +250,7 @@ function () {
 : $this->package;

 try {
 Composer::withoutQueue()->throwOnFailure()->requireDev($package);
 Composer::withoutQueue()->throwOnFailure()->require($package);
 } catch (ProcessException $exception) {
 $this->rollbackWithError("Error installing starter kit [{$package}].", $exception->getMessage());
 }
Expand DownExpand Up@@ -548,14 +548,14 @@ function () {
 */
 public function removeStarterKit(): self
 {
 if ($this->disableCleanup) {
 if ($this->isUpdatable() || $this->disableCleanup) {
 return $this;
 }

 spin(
 function () {
 if (Composer::isInstalled($this->package)) {
 Composer::withoutQueue()->throwOnFailure(false)->removeDev($this->package);
 Composer::withoutQueue()->throwOnFailure(false)->remove($this->package);
 }
 },
 'Cleaning up temporary files...'
Expand DownExpand Up@@ -589,7 +589,7 @@ protected function completeInstall(): self
 */
 protected function removeRepository(): self
 {
 if ($this->fromLocalRepo || ! $this->url) {
 if ($this->isUpdatable() || $this->fromLocalRepo || ! $this->url) {
 return $this;
 }

Expand DownExpand Up@@ -672,12 +672,22 @@ protected function starterKitPath(?string $path = null): string
 */
 protected function config(?string $key = null): mixed
 {
 $config = collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 $config = Blink::once('starter-kit-config', function () {
 return collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 });

 if ($key) {
 return $config->get($key);
 }

 return $config;
 }

 /**
 * Should starter kit be treated as an updatable package, and live on for future composer updates, etc?
 */
 protected function isUpdatable(): bool
 {
 return (bool) $this->config('updatable');
 }
}

89 changes: 85 additions & 4 deletions
tests/StarterKits/InstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use Statamic\Facades\Blink;
use Statamic\Facades\Config;
use Statamic\Facades\YAML;
use Statamic\Support\Arr;
use Statamic\Support\Str;
use Tests\Fakes\Composer\FakeComposer;
use Tests\TestCase;
Expand DownExpand Up@@ -56,6 +57,7 @@ public function it_installs_starter_kit()
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 $this->assertComposerJsonDoesntHavePackage('statamic/cool-runnings');
 $this->assertComposerJsonDoesntHave('repositories');
 $this->assertFileExists(base_path('copied.md'));
 }
Expand DownExpand Up@@ -209,6 +211,70 @@ public function it_restores_existing_repositories_after_successful_install()
 $this->assertEquals($expectedRepositories, $composerJson['repositories']);
 }

 #[Test]
 public function it_installs_as_living_package_with_custom_config()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());

 $this->installCoolRunnings();

 $this->assertFileExists(base_path('copied.md'));
 $this->assertComposerJsonDoesntHave('repositories');

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // But ensure we still delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_leaves_custom_repository_for_living_packages_that_need_it()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertComposerJsonDoesntHave('repositories');

 $this->installCoolRunnings([], [
 'outpost.*' => Http::response(['data' => ['price' => null]], 200),
 'github.com/*' => Http::response('', 200),
 '*' => Http::response('', 404),
 ]);

 $this->assertFileExists(base_path('copied.md'));

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // As well as custom repository, which will be needed for composer updates, if it was needed for install
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
 $this->assertCount(1, $composerJson['repositories']);
 $this->assertEquals([[
 'type' => 'vcs',
 'url' => 'https://github.com/statamic/cool-runnings',
 ]], $composerJson['repositories']);

 // But delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_fails_if_starter_kit_config_does_not_exist()
 {
Expand DownExpand Up@@ -688,8 +754,8 @@ public function it_parses_branch_from_package_param_when_installing()
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand All@@ -711,8 +777,8 @@ public function it_installs_branch_with_slash_without_failing_package_validation
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-feature/custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-feature/custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand DownExpand Up@@ -1603,6 +1669,21 @@ private function assertFileDoesntHaveContent($expected, $path)
 $this->assertStringNotContainsString($expected, $this->files->get($path));
 }

 private function assertComposerJsonHasPackage($requireKey, $package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertTrue(Arr::has($composerJson, "{$requireKey}.{$package}"));
 }

 private function assertComposerJsonDoesntHavePackage($package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertFalse(Arr::has($composerJson, "require.{$package}"));
 $this->assertFalse(Arr::has($composerJson, "require-dev.{$package}"));
 }

 private function assertComposerJsonHasPackageVersion($requireKey, $package, $version)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable by jesseleite · Pull Request #11064 · statamic/cms · GitHub
Skip to content
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable#11064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jesseleite
merged 8 commits into

from

Dec 2, 2024
 Merged


[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable
#11064
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
c702166

Spec out `addon: true` for starter kits that should live on as compos…


jesseleite Nov 6, 2024
5a8649c

Blink config, no reason to read it twice.


jesseleite Nov 6, 2024
109317a

Pass tests.


jesseleite Nov 6, 2024
bdfce39

Refactor to `updatable: true`.


jesseleite Nov 6, 2024
faeb1dc

Merge branch '5.x' of https://github.com/statamic/cms into starter-ki…


jesseleite Nov 26, 2024
c299481

Add test coverage to ensure package remains in `require` (not `requir…


jesseleite Nov 26, 2024
261f689

Pass test. (We don’t really have reason to `requireDev` here anymore.)


jesseleite Nov 26, 2024
9ab6e51

Adjust these tests too.


jesseleite Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


20 changes: 15 additions & 5 deletions
src/StarterKits/Installer.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -250,7 +250,7 @@ function () {
 : $this->package;

 try {
 Composer::withoutQueue()->throwOnFailure()->requireDev($package);
 Composer::withoutQueue()->throwOnFailure()->require($package);
 } catch (ProcessException $exception) {
 $this->rollbackWithError("Error installing starter kit [{$package}].", $exception->getMessage());
 }
Expand DownExpand Up@@ -548,14 +548,14 @@ function () {
 */
 public function removeStarterKit(): self
 {
 if ($this->disableCleanup) {
 if ($this->isUpdatable() || $this->disableCleanup) {
 return $this;
 }

 spin(
 function () {
 if (Composer::isInstalled($this->package)) {
 Composer::withoutQueue()->throwOnFailure(false)->removeDev($this->package);
 Composer::withoutQueue()->throwOnFailure(false)->remove($this->package);
 }
 },
 'Cleaning up temporary files...'
Expand DownExpand Up@@ -589,7 +589,7 @@ protected function completeInstall(): self
 */
 protected function removeRepository(): self
 {
 if ($this->fromLocalRepo || ! $this->url) {
 if ($this->isUpdatable() || $this->fromLocalRepo || ! $this->url) {
 return $this;
 }

Expand DownExpand Up@@ -672,12 +672,22 @@ protected function starterKitPath(?string $path = null): string
 */
 protected function config(?string $key = null): mixed
 {
 $config = collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 $config = Blink::once('starter-kit-config', function () {
 return collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 });

 if ($key) {
 return $config->get($key);
 }

 return $config;
 }

 /**
 * Should starter kit be treated as an updatable package, and live on for future composer updates, etc?
 */
 protected function isUpdatable(): bool
 {
 return (bool) $this->config('updatable');
 }
}

89 changes: 85 additions & 4 deletions
tests/StarterKits/InstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use Statamic\Facades\Blink;
use Statamic\Facades\Config;
use Statamic\Facades\YAML;
use Statamic\Support\Arr;
use Statamic\Support\Str;
use Tests\Fakes\Composer\FakeComposer;
use Tests\TestCase;
Expand DownExpand Up@@ -56,6 +57,7 @@ public function it_installs_starter_kit()
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 $this->assertComposerJsonDoesntHavePackage('statamic/cool-runnings');
 $this->assertComposerJsonDoesntHave('repositories');
 $this->assertFileExists(base_path('copied.md'));
 }
Expand DownExpand Up@@ -209,6 +211,70 @@ public function it_restores_existing_repositories_after_successful_install()
 $this->assertEquals($expectedRepositories, $composerJson['repositories']);
 }

 #[Test]
 public function it_installs_as_living_package_with_custom_config()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());

 $this->installCoolRunnings();

 $this->assertFileExists(base_path('copied.md'));
 $this->assertComposerJsonDoesntHave('repositories');

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // But ensure we still delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_leaves_custom_repository_for_living_packages_that_need_it()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertComposerJsonDoesntHave('repositories');

 $this->installCoolRunnings([], [
 'outpost.*' => Http::response(['data' => ['price' => null]], 200),
 'github.com/*' => Http::response('', 200),
 '*' => Http::response('', 404),
 ]);

 $this->assertFileExists(base_path('copied.md'));

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // As well as custom repository, which will be needed for composer updates, if it was needed for install
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
 $this->assertCount(1, $composerJson['repositories']);
 $this->assertEquals([[
 'type' => 'vcs',
 'url' => 'https://github.com/statamic/cool-runnings',
 ]], $composerJson['repositories']);

 // But delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_fails_if_starter_kit_config_does_not_exist()
 {
Expand DownExpand Up@@ -688,8 +754,8 @@ public function it_parses_branch_from_package_param_when_installing()
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand All@@ -711,8 +777,8 @@ public function it_installs_branch_with_slash_without_failing_package_validation
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-feature/custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-feature/custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand DownExpand Up@@ -1603,6 +1669,21 @@ private function assertFileDoesntHaveContent($expected, $path)
 $this->assertStringNotContainsString($expected, $this->files->get($path));
 }

 private function assertComposerJsonHasPackage($requireKey, $package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertTrue(Arr::has($composerJson, "{$requireKey}.{$package}"));
 }

 private function assertComposerJsonDoesntHavePackage($package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertFalse(Arr::has($composerJson, "require.{$package}"));
 $this->assertFalse(Arr::has($composerJson, "require-dev.{$package}"));
 }

 private function assertComposerJsonHasPackageVersion($requireKey, $package, $version)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable by jesseleite · Pull Request #11064 · statamic/cms · GitHub
Skip to content
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable#11064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jesseleite
merged 8 commits into

from

Dec 2, 2024
 Merged


[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable
#11064
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
c702166

Spec out `addon: true` for starter kits that should live on as compos…


jesseleite Nov 6, 2024
5a8649c

Blink config, no reason to read it twice.


jesseleite Nov 6, 2024
109317a

Pass tests.


jesseleite Nov 6, 2024
bdfce39

Refactor to `updatable: true`.


jesseleite Nov 6, 2024
faeb1dc

Merge branch '5.x' of https://github.com/statamic/cms into starter-ki…


jesseleite Nov 26, 2024
c299481

Add test coverage to ensure package remains in `require` (not `requir…


jesseleite Nov 26, 2024
261f689

Pass test. (We don’t really have reason to `requireDev` here anymore.)


jesseleite Nov 26, 2024
9ab6e51

Adjust these tests too.


jesseleite Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


20 changes: 15 additions & 5 deletions
src/StarterKits/Installer.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -250,7 +250,7 @@ function () {
 : $this->package;

 try {
 Composer::withoutQueue()->throwOnFailure()->requireDev($package);
 Composer::withoutQueue()->throwOnFailure()->require($package);
 } catch (ProcessException $exception) {
 $this->rollbackWithError("Error installing starter kit [{$package}].", $exception->getMessage());
 }
Expand DownExpand Up@@ -548,14 +548,14 @@ function () {
 */
 public function removeStarterKit(): self
 {
 if ($this->disableCleanup) {
 if ($this->isUpdatable() || $this->disableCleanup) {
 return $this;
 }

 spin(
 function () {
 if (Composer::isInstalled($this->package)) {
 Composer::withoutQueue()->throwOnFailure(false)->removeDev($this->package);
 Composer::withoutQueue()->throwOnFailure(false)->remove($this->package);
 }
 },
 'Cleaning up temporary files...'
Expand DownExpand Up@@ -589,7 +589,7 @@ protected function completeInstall(): self
 */
 protected function removeRepository(): self
 {
 if ($this->fromLocalRepo || ! $this->url) {
 if ($this->isUpdatable() || $this->fromLocalRepo || ! $this->url) {
 return $this;
 }

Expand DownExpand Up@@ -672,12 +672,22 @@ protected function starterKitPath(?string $path = null): string
 */
 protected function config(?string $key = null): mixed
 {
 $config = collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 $config = Blink::once('starter-kit-config', function () {
 return collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 });

 if ($key) {
 return $config->get($key);
 }

 return $config;
 }

 /**
 * Should starter kit be treated as an updatable package, and live on for future composer updates, etc?
 */
 protected function isUpdatable(): bool
 {
 return (bool) $this->config('updatable');
 }
}

89 changes: 85 additions & 4 deletions
tests/StarterKits/InstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use Statamic\Facades\Blink;
use Statamic\Facades\Config;
use Statamic\Facades\YAML;
use Statamic\Support\Arr;
use Statamic\Support\Str;
use Tests\Fakes\Composer\FakeComposer;
use Tests\TestCase;
Expand DownExpand Up@@ -56,6 +57,7 @@ public function it_installs_starter_kit()
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 $this->assertComposerJsonDoesntHavePackage('statamic/cool-runnings');
 $this->assertComposerJsonDoesntHave('repositories');
 $this->assertFileExists(base_path('copied.md'));
 }
Expand DownExpand Up@@ -209,6 +211,70 @@ public function it_restores_existing_repositories_after_successful_install()
 $this->assertEquals($expectedRepositories, $composerJson['repositories']);
 }

 #[Test]
 public function it_installs_as_living_package_with_custom_config()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());

 $this->installCoolRunnings();

 $this->assertFileExists(base_path('copied.md'));
 $this->assertComposerJsonDoesntHave('repositories');

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // But ensure we still delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_leaves_custom_repository_for_living_packages_that_need_it()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertComposerJsonDoesntHave('repositories');

 $this->installCoolRunnings([], [
 'outpost.*' => Http::response(['data' => ['price' => null]], 200),
 'github.com/*' => Http::response('', 200),
 '*' => Http::response('', 404),
 ]);

 $this->assertFileExists(base_path('copied.md'));

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // As well as custom repository, which will be needed for composer updates, if it was needed for install
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
 $this->assertCount(1, $composerJson['repositories']);
 $this->assertEquals([[
 'type' => 'vcs',
 'url' => 'https://github.com/statamic/cool-runnings',
 ]], $composerJson['repositories']);

 // But delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_fails_if_starter_kit_config_does_not_exist()
 {
Expand DownExpand Up@@ -688,8 +754,8 @@ public function it_parses_branch_from_package_param_when_installing()
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand All@@ -711,8 +777,8 @@ public function it_installs_branch_with_slash_without_failing_package_validation
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-feature/custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-feature/custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand DownExpand Up@@ -1603,6 +1669,21 @@ private function assertFileDoesntHaveContent($expected, $path)
 $this->assertStringNotContainsString($expected, $this->files->get($path));
 }

 private function assertComposerJsonHasPackage($requireKey, $package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertTrue(Arr::has($composerJson, "{$requireKey}.{$package}"));
 }

 private function assertComposerJsonDoesntHavePackage($package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertFalse(Arr::has($composerJson, "require.{$package}"));
 $this->assertFalse(Arr::has($composerJson, "require-dev.{$package}"));
 }

 private function assertComposerJsonHasPackageVersion($requireKey, $package, $version)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable by jesseleite · Pull Request #11064 · statamic/cms · GitHub
Skip to content
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable#11064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jesseleite
merged 8 commits into

from

Dec 2, 2024
 Merged


[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable
#11064
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
c702166

Spec out `addon: true` for starter kits that should live on as compos…


jesseleite Nov 6, 2024
5a8649c

Blink config, no reason to read it twice.


jesseleite Nov 6, 2024
109317a

Pass tests.


jesseleite Nov 6, 2024
bdfce39

Refactor to `updatable: true`.


jesseleite Nov 6, 2024
faeb1dc

Merge branch '5.x' of https://github.com/statamic/cms into starter-ki…


jesseleite Nov 26, 2024
c299481

Add test coverage to ensure package remains in `require` (not `requir…


jesseleite Nov 26, 2024
261f689

Pass test. (We don’t really have reason to `requireDev` here anymore.)


jesseleite Nov 26, 2024
9ab6e51

Adjust these tests too.


jesseleite Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


20 changes: 15 additions & 5 deletions
src/StarterKits/Installer.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -250,7 +250,7 @@ function () {
 : $this->package;

 try {
 Composer::withoutQueue()->throwOnFailure()->requireDev($package);
 Composer::withoutQueue()->throwOnFailure()->require($package);
 } catch (ProcessException $exception) {
 $this->rollbackWithError("Error installing starter kit [{$package}].", $exception->getMessage());
 }
Expand DownExpand Up@@ -548,14 +548,14 @@ function () {
 */
 public function removeStarterKit(): self
 {
 if ($this->disableCleanup) {
 if ($this->isUpdatable() || $this->disableCleanup) {
 return $this;
 }

 spin(
 function () {
 if (Composer::isInstalled($this->package)) {
 Composer::withoutQueue()->throwOnFailure(false)->removeDev($this->package);
 Composer::withoutQueue()->throwOnFailure(false)->remove($this->package);
 }
 },
 'Cleaning up temporary files...'
Expand DownExpand Up@@ -589,7 +589,7 @@ protected function completeInstall(): self
 */
 protected function removeRepository(): self
 {
 if ($this->fromLocalRepo || ! $this->url) {
 if ($this->isUpdatable() || $this->fromLocalRepo || ! $this->url) {
 return $this;
 }

Expand DownExpand Up@@ -672,12 +672,22 @@ protected function starterKitPath(?string $path = null): string
 */
 protected function config(?string $key = null): mixed
 {
 $config = collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 $config = Blink::once('starter-kit-config', function () {
 return collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 });

 if ($key) {
 return $config->get($key);
 }

 return $config;
 }

 /**
 * Should starter kit be treated as an updatable package, and live on for future composer updates, etc?
 */
 protected function isUpdatable(): bool
 {
 return (bool) $this->config('updatable');
 }
}

89 changes: 85 additions & 4 deletions
tests/StarterKits/InstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use Statamic\Facades\Blink;
use Statamic\Facades\Config;
use Statamic\Facades\YAML;
use Statamic\Support\Arr;
use Statamic\Support\Str;
use Tests\Fakes\Composer\FakeComposer;
use Tests\TestCase;
Expand DownExpand Up@@ -56,6 +57,7 @@ public function it_installs_starter_kit()
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 $this->assertComposerJsonDoesntHavePackage('statamic/cool-runnings');
 $this->assertComposerJsonDoesntHave('repositories');
 $this->assertFileExists(base_path('copied.md'));
 }
Expand DownExpand Up@@ -209,6 +211,70 @@ public function it_restores_existing_repositories_after_successful_install()
 $this->assertEquals($expectedRepositories, $composerJson['repositories']);
 }

 #[Test]
 public function it_installs_as_living_package_with_custom_config()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());

 $this->installCoolRunnings();

 $this->assertFileExists(base_path('copied.md'));
 $this->assertComposerJsonDoesntHave('repositories');

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // But ensure we still delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_leaves_custom_repository_for_living_packages_that_need_it()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertComposerJsonDoesntHave('repositories');

 $this->installCoolRunnings([], [
 'outpost.*' => Http::response(['data' => ['price' => null]], 200),
 'github.com/*' => Http::response('', 200),
 '*' => Http::response('', 404),
 ]);

 $this->assertFileExists(base_path('copied.md'));

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // As well as custom repository, which will be needed for composer updates, if it was needed for install
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
 $this->assertCount(1, $composerJson['repositories']);
 $this->assertEquals([[
 'type' => 'vcs',
 'url' => 'https://github.com/statamic/cool-runnings',
 ]], $composerJson['repositories']);

 // But delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_fails_if_starter_kit_config_does_not_exist()
 {
Expand DownExpand Up@@ -688,8 +754,8 @@ public function it_parses_branch_from_package_param_when_installing()
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand All@@ -711,8 +777,8 @@ public function it_installs_branch_with_slash_without_failing_package_validation
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-feature/custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-feature/custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand DownExpand Up@@ -1603,6 +1669,21 @@ private function assertFileDoesntHaveContent($expected, $path)
 $this->assertStringNotContainsString($expected, $this->files->get($path));
 }

 private function assertComposerJsonHasPackage($requireKey, $package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertTrue(Arr::has($composerJson, "{$requireKey}.{$package}"));
 }

 private function assertComposerJsonDoesntHavePackage($package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertFalse(Arr::has($composerJson, "require.{$package}"));
 $this->assertFalse(Arr::has($composerJson, "require-dev.{$package}"));
 }

 private function assertComposerJsonHasPackageVersion($requireKey, $package, $version)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable by jesseleite · Pull Request #11064 · statamic/cms · GitHub
Skip to content
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable#11064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jesseleite
merged 8 commits into

from

Dec 2, 2024
 Merged


[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable
#11064
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
c702166

Spec out `addon: true` for starter kits that should live on as compos…


jesseleite Nov 6, 2024
5a8649c

Blink config, no reason to read it twice.


jesseleite Nov 6, 2024
109317a

Pass tests.


jesseleite Nov 6, 2024
bdfce39

Refactor to `updatable: true`.


jesseleite Nov 6, 2024
faeb1dc

Merge branch '5.x' of https://github.com/statamic/cms into starter-ki…


jesseleite Nov 26, 2024
c299481

Add test coverage to ensure package remains in `require` (not `requir…


jesseleite Nov 26, 2024
261f689

Pass test. (We don’t really have reason to `requireDev` here anymore.)


jesseleite Nov 26, 2024
9ab6e51

Adjust these tests too.


jesseleite Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


20 changes: 15 additions & 5 deletions
src/StarterKits/Installer.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -250,7 +250,7 @@ function () {
 : $this->package;

 try {
 Composer::withoutQueue()->throwOnFailure()->requireDev($package);
 Composer::withoutQueue()->throwOnFailure()->require($package);
 } catch (ProcessException $exception) {
 $this->rollbackWithError("Error installing starter kit [{$package}].", $exception->getMessage());
 }
Expand DownExpand Up@@ -548,14 +548,14 @@ function () {
 */
 public function removeStarterKit(): self
 {
 if ($this->disableCleanup) {
 if ($this->isUpdatable() || $this->disableCleanup) {
 return $this;
 }

 spin(
 function () {
 if (Composer::isInstalled($this->package)) {
 Composer::withoutQueue()->throwOnFailure(false)->removeDev($this->package);
 Composer::withoutQueue()->throwOnFailure(false)->remove($this->package);
 }
 },
 'Cleaning up temporary files...'
Expand DownExpand Up@@ -589,7 +589,7 @@ protected function completeInstall(): self
 */
 protected function removeRepository(): self
 {
 if ($this->fromLocalRepo || ! $this->url) {
 if ($this->isUpdatable() || $this->fromLocalRepo || ! $this->url) {
 return $this;
 }

Expand DownExpand Up@@ -672,12 +672,22 @@ protected function starterKitPath(?string $path = null): string
 */
 protected function config(?string $key = null): mixed
 {
 $config = collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 $config = Blink::once('starter-kit-config', function () {
 return collect(YAML::parse($this->files->get($this->starterKitPath('starter-kit.yaml'))));
 });

 if ($key) {
 return $config->get($key);
 }

 return $config;
 }

 /**
 * Should starter kit be treated as an updatable package, and live on for future composer updates, etc?
 */
 protected function isUpdatable(): bool
 {
 return (bool) $this->config('updatable');
 }
}

89 changes: 85 additions & 4 deletions
tests/StarterKits/InstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use Statamic\Facades\Blink;
use Statamic\Facades\Config;
use Statamic\Facades\YAML;
use Statamic\Support\Arr;
use Statamic\Support\Str;
use Tests\Fakes\Composer\FakeComposer;
use Tests\TestCase;
Expand DownExpand Up@@ -56,6 +57,7 @@ public function it_installs_starter_kit()
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 $this->assertComposerJsonDoesntHavePackage('statamic/cool-runnings');
 $this->assertComposerJsonDoesntHave('repositories');
 $this->assertFileExists(base_path('copied.md'));
 }
Expand DownExpand Up@@ -209,6 +211,70 @@ public function it_restores_existing_repositories_after_successful_install()
 $this->assertEquals($expectedRepositories, $composerJson['repositories']);
 }

 #[Test]
 public function it_installs_as_living_package_with_custom_config()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());

 $this->installCoolRunnings();

 $this->assertFileExists(base_path('copied.md'));
 $this->assertComposerJsonDoesntHave('repositories');

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // But ensure we still delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_leaves_custom_repository_for_living_packages_that_need_it()
 {
 $this->setConfig([
 'updatable' => true, // With `updatable: true`, kit should live on as composer updatable package
 'export_paths' => [
 'copied.md',
 ],
 ]);

 $this->assertFileDoesNotExist(base_path('copied.md'));
 $this->assertFileDoesNotExist($this->kitVendorPath());
 $this->assertComposerJsonDoesntHave('repositories');

 $this->installCoolRunnings([], [
 'outpost.*' => Http::response(['data' => ['price' => null]], 200),
 'github.com/*' => Http::response('', 200),
 '*' => Http::response('', 404),
 ]);

 $this->assertFileExists(base_path('copied.md'));

 // Keep package around
 $this->assertFileExists($this->kitVendorPath());
 $this->assertComposerJsonHasPackage('require', 'statamic/cool-runnings');

 // As well as custom repository, which will be needed for composer updates, if it was needed for install
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
 $this->assertCount(1, $composerJson['repositories']);
 $this->assertEquals([[
 'type' => 'vcs',
 'url' => 'https://github.com/statamic/cool-runnings',
 ]], $composerJson['repositories']);

 // But delete backup composer.json, which is only used for error handling purposes
 $this->assertFileDoesNotExist(base_path('composer.json.bak'));
 }

 #[Test]
 public function it_fails_if_starter_kit_config_does_not_exist()
 {
Expand DownExpand Up@@ -688,8 +754,8 @@ public function it_parses_branch_from_package_param_when_installing()
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand All@@ -711,8 +777,8 @@ public function it_installs_branch_with_slash_without_failing_package_validation
 ]);

 // Ensure `Composer::requireDev()` gets called with `package:branch`
 $this->assertEquals(Blink::get('composer-require-dev-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-dev-branch'), 'dev-feature/custom-branch');
 $this->assertEquals(Blink::get('composer-require-package'), 'statamic/cool-runnings');
 $this->assertEquals(Blink::get('composer-require-branch'), 'dev-feature/custom-branch');

 // But ensure the rest of the installer handles parsed `package` without branch messing things up
 $this->assertFalse(Blink::has('starter-kit-repository-added'));
Expand DownExpand Up@@ -1603,6 +1669,21 @@ private function assertFileDoesntHaveContent($expected, $path)
 $this->assertStringNotContainsString($expected, $this->files->get($path));
 }

 private function assertComposerJsonHasPackage($requireKey, $package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertTrue(Arr::has($composerJson, "{$requireKey}.{$package}"));
 }

 private function assertComposerJsonDoesntHavePackage($package)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);

 $this->assertFalse(Arr::has($composerJson, "require.{$package}"));
 $this->assertFalse(Arr::has($composerJson, "require-dev.{$package}"));
 }

 private function assertComposerJsonHasPackageVersion($requireKey, $package, $version)
 {
 $composerJson = json_decode($this->files->get(base_path('composer.json')), true);
Expand Down