Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 13 additions & 4 deletions resources/js/components/structures/PageTree.vue
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ export default {
collapsedState: [],
discardingChanges: false,
ready: false,
saveKeyBinding: null,
};
},

Expand Down Expand Up @@ -174,16 +175,24 @@ export default {
this.initialPages = clone(this.pages);
});

this.$keys.bindGlobal(['mod+s'], (e) => {
e.preventDefault();
this.save();
});
// A read-only tree can't be saved, so binding the shortcut would only take it away
// from whatever is behind it. e.g. an entry being edited under a selector stack.
if (this.editable) {
this.saveKeyBinding = this.$keys.bindGlobal(['mod+s'], (e) => {
e.preventDefault();
this.save();
});
}
},

mounted() {
setTimeout(() => this.ready = true, 500); // arbitrary delay after initial transitions
},

beforeUnmount() {
this.saveKeyBinding?.destroy();
},

methods: {
isRoot(stat) {
if (!this.expectsRoot) {
Expand Down
88 changes: 88 additions & 0 deletions resources/js/tests/components/structures/PageTree.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
import { mount, flushPromises } from '@vue/test-utils';
import { afterEach, beforeEach, expect, test, vi } from 'vitest';
import PageTree from '@/components/structures/PageTree.vue';
import Keys from '@/components/keys/Keys.js';

globalThis.__ = (key) => key;

let keys;
let outerSaves;
let outerBinding;

// jsdom reports an empty navigator.platform, so mousetrap resolves `mod` to `ctrl`.
function pressSave() {
const event = new KeyboardEvent('keydown', {
key: 's',
code: 'KeyS',
ctrlKey: true,
bubbles: true,
cancelable: true,
});

Object.defineProperty(event, 'keyCode', { get: () => 83 });
Object.defineProperty(event, 'which', { get: () => 83 });

document.dispatchEvent(event);
}

function mountTree(editable) {
return mount(PageTree, {
props: {
pagesUrl: '/test/pages',
editable,
},
global: {
stubs: { Draggable: true, TreeBranch: true, PanelHeader: true, Panel: true, Icon: true },
mocks: {
$keys: keys,
$config: { get: (key, fallback) => fallback },
$axios: { get: () => Promise.resolve({ data: { pages: [] } }) },
},
},
});
}

beforeEach(() => {
keys = new Keys();
outerSaves = 0;

// Stand in for the publish form sitting behind the tree.
outerBinding = keys.bindGlobal(['mod+s'], (e) => {
e.preventDefault();
outerSaves++;
});
});

afterEach(() => outerBinding.destroy());

test('a read-only tree leaves the save shortcut alone', async () => {
const wrapper = mountTree(false);
await flushPromises();

pressSave();
expect(outerSaves).toBe(1);

wrapper.unmount();
await flushPromises();

pressSave();
expect(outerSaves).toBe(2);
});

test('an editable tree takes the save shortcut and gives it back', async () => {
const wrapper = mountTree(true);
await flushPromises();

const save = vi.spyOn(wrapper.vm, 'save').mockImplementation(() => {});

pressSave();
expect(save).toHaveBeenCalledTimes(1);
expect(outerSaves).toBe(0);

wrapper.unmount();
await flushPromises();

pressSave();
expect(save).toHaveBeenCalledTimes(1);
expect(outerSaves).toBe(1);
});
Loading