feat: add rename action with tests

Signed-off-by: John Molakvoæ <skjnldsv@protonmail.com>

diff --git a/apps/files/src/actions/deleteAction.spec.ts b/apps/files/src/actions/deleteAction.spec.ts
index c99514f9906b8e44201be1b559d34fbb763c007f..af7722008b619b53c2d833323c94bc6b773a9b8e 100644 (file)
--- a/apps/files/src/actions/deleteAction.spec.ts
+++ b/apps/files/src/actions/deleteAction.spec.ts
@@ -25,8 +25,8 @@ import { File, Folder, Permission } from '@nextcloud/files'
 import { FileAction } from '../services/FileAction'
 import * as eventBus from '@nextcloud/event-bus'
 import axios from '@nextcloud/axios'
-import type { Navigation } from '../services/Navigation'
 import logger from '../logger'
+import type { Navigation } from '../services/Navigation'
 
 const view = {
        id: 'files',

diff --git a/apps/files/src/actions/renameAction.spec.ts b/apps/files/src/actions/renameAction.spec.ts
new file mode 100644 (file)
index 0000000..ae2cfce
--- /dev/null
+++ b/apps/files/src/actions/renameAction.spec.ts
@@ -0,0 +1,111 @@
+/**
+ * @copyright Copyright (c) 2023 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+import { action } from './renameAction'
+import { expect } from '@jest/globals'
+import { File, Permission } from '@nextcloud/files'
+import { FileAction } from '../services/FileAction'
+import * as eventBus from '@nextcloud/event-bus'
+import type { Navigation } from '../services/Navigation'
+
+const view = {
+       id: 'files',
+       name: 'Files',
+} as Navigation
+
+describe('Rename action conditions tests', () => {
+       test('Default values', () => {
+               expect(action).toBeInstanceOf(FileAction)
+               expect(action.id).toBe('rename')
+               expect(action.displayName([], view)).toBe('Rename')
+               expect(action.iconSvgInline([], view)).toBe('SvgMock')
+               expect(action.default).toBe(false)
+               expect(action.order).toBe(10)
+       })
+})
+
+describe('Rename action enabled tests', () => {
+       test('Enabled for node with UPDATE permission', () => {
+               const file = new File({
+                       id: 1,
+                       source: 'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
+                       owner: 'admin',
+                       mime: 'text/plain',
+                       permissions: Permission.UPDATE,
+               })
+
+               expect(action.enabled).toBeDefined()
+               expect(action.enabled!([file], view)).toBe(true)
+       })
+
+       test('Disabled for node without UPDATE permission', () => {
+               const file = new File({
+                       id: 1,
+                       source: 'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
+                       owner: 'admin',
+                       mime: 'text/plain',
+                       permissions: Permission.READ,
+               })
+
+               expect(action.enabled).toBeDefined()
+               expect(action.enabled!([file], view)).toBe(false)
+       })
+
+       test('Disabled if more than one node', () => {
+               window.OCA = { Files: { Sidebar: {} } }
+
+               const file1 = new File({
+                       id: 1,
+                       source: 'https://cloud.domain.com/remote.php/dav/files/admin/foo.txt',
+                       owner: 'admin',
+                       mime: 'text/plain',
+               })
+               const file2 = new File({
+                       id: 1,
+                       source: 'https://cloud.domain.com/remote.php/dav/files/admin/bar.txt',
+                       owner: 'admin',
+                       mime: 'text/plain',
+               })
+
+               expect(action.enabled).toBeDefined()
+               expect(action.enabled!([file1, file2], view)).toBe(false)
+       })
+})
+
+describe('Rename action exec tests', () => {
+       test('Rename', async () => {
+               jest.spyOn(eventBus, 'emit')
+
+               const file = new File({
+                       id: 1,
+                       source: 'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
+                       owner: 'admin',
+                       mime: 'text/plain',
+               })
+
+               const exec = await action.exec(file, view, '/')
+
+               // Silent action
+               expect(exec).toBe(null)
+               expect(eventBus.emit).toBeCalledTimes(1)
+               expect(eventBus.emit).toHaveBeenCalledWith('files:node:rename', file)
+       })
+})

diff --git a/apps/files/src/actions/renameAction.ts b/apps/files/src/actions/renameAction.ts
new file mode 100644 (file)
index 0000000..02aaaa6
--- /dev/null
+++ b/apps/files/src/actions/renameAction.ts
@@ -0,0 +1,51 @@
+/**
+ * @copyright Copyright (c) 2023 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+import { Permission, type Node } from '@nextcloud/files'
+import { translate as t } from '@nextcloud/l10n'
+import PencilSvg from '@mdi/svg/svg/pencil.svg?raw'
+
+import { emit } from '@nextcloud/event-bus'
+import { registerFileAction, FileAction } from '../services/FileAction'
+
+export const ACTION_DETAILS = 'details'
+
+export const action = new FileAction({
+       id: 'rename',
+       displayName: () => t('files', 'Rename'),
+       iconSvgInline: () => PencilSvg,
+
+       enabled: (nodes: Node[]) => {
+               return nodes.length > 0 && nodes
+                       .map(node => node.permissions)
+                       .every(permission => (permission & Permission.UPDATE) !== 0)
+       },
+
+       async exec(node: Node) {
+               // Renaming is a built-in feature of the files app
+               emit('files:node:rename', node)
+               return null
+       },
+
+       order: 10,
+})
+
+registerFileAction(action)

diff --git a/apps/files/src/actions/sidebarAction.spec.ts b/apps/files/src/actions/sidebarAction.spec.ts
index cdf878459dbba07bc859645be79dba9627a34e30..f6594090c53e6a5455f6d2e0c7c5143bb190ebbd 100644 (file)
--- a/apps/files/src/actions/sidebarAction.spec.ts
+++ b/apps/files/src/actions/sidebarAction.spec.ts
@@ -42,7 +42,7 @@ describe('Open sidebar action conditions tests', () => {
        })
 })
 
-describe('Open folder action enabled tests', () => {
+describe('Open sidebar action enabled tests', () => {
        test('Enabled for ressources within user root folder', () => {
                window.OCA = { Files: { Sidebar: {} } }