joplin-plugin-backup 1.0.3 → 1.0.5

package/.ENV

@@ -0,0 +1 @@
+GITHUB_TOKEN=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

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Gruber Alexander
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Gruber Alexander
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -53,7 +53,7 @@ Under `Options > Keyboard Shortcuts` you can assign a keyboard shortcut for the
 
 ## What is backed up
 
-- Notebooks as JEX export (Empty notbooks are not backed up)
+- Notebooks as JEX export (Empty notebooks are not backed up)
 - The `settings.json` (Joplin settings)
 - The `keymap-desktop.json` (Keyboard shortcuts)
 - The `userchrome.css` (Your Joplin customization)

package/__test__/backup.test.ts

@@ -1,9 +1,9 @@
 import { Backup } from "../src/Backup";
 import * as fs from "fs-extra";
 import * as path from "path";
-import { joplinWrapper } from "../src/joplinWrapper";
 import { when } from "jest-when";
 import { sevenZip } from "../src/sevenZip";
+import joplin from "api";
 
 function getTestPaths(): any {
   const testPath: any = {};
@@ -26,10 +26,10 @@ let spyOnLogWarn = null;
 let spyOnLogError = null;
 let spyOnSaveBackupInfo = null;
 
-const spyOnsSettingsValue = jest.spyOn(joplinWrapper, "settingsValue");
-const spyOnGlobalValue = jest.spyOn(joplinWrapper, "settingsGlobalValue");
+const spyOnsSettingsValue = jest.spyOn(joplin.settings, "value");
+const spyOnGlobalValue = jest.spyOn(joplin.settings, "globalValue");
 const spyOnSettingsSetValue = jest
-  .spyOn(joplinWrapper, "settingsSetValue")
+  .spyOn(joplin.settings, "setValue")
   .mockImplementation();
 
 async function createTestStructure() {

package/__test__/help.test.ts

@@ -0,0 +1,74 @@
+import { helper } from "../src/helper";
+
+describe("Test helper", function () {
+  it(`validFileName`, async () => {
+    const testCases = [
+      {
+        fileName: "some test file.txt",
+        expected: true,
+      },
+      {
+        fileName: "some ^test file.txt",
+        expected: true,
+      },
+      {
+        fileName: "some :test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some \\test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some |test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some /test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some *test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some ?test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some <test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "some >test file.txt",
+        expected: false,
+      },
+      {
+        fileName: "com9.txt",
+        expected: false,
+      },
+      {
+        fileName: "nul.txt",
+        expected: false,
+      },
+      {
+        fileName: "prn.txt",
+        expected: false,
+      },
+      {
+        fileName: "con.txt",
+        expected: false,
+      },
+      {
+        fileName: "lpt5.txt",
+        expected: false,
+      },
+    ];
+
+    for (const testCase of testCases) {
+      expect(await helper.validFileName(testCase.fileName)).toBe(
+        testCase.expected
+      );
+    }
+  });
+});

package/__test__/pw.test.ts

@@ -0,0 +1,82 @@
+import { Backup } from "../src/Backup";
+import joplin from "api";
+import { when } from "jest-when";
+
+let backup = null;
+
+describe("Password", function () {
+  beforeEach(async () => {
+    backup = new Backup() as any;
+  });
+
+  it(`Check`, async () => {
+    const spyOnsSettingsValue = jest.spyOn(joplin.settings, "value");
+    const spyOnsSettingsSetValue = jest.spyOn(joplin.settings, "setValue");
+
+    const testCases = [
+      {
+        usePassword: false,
+        password: "",
+        passwordRepeat: "",
+        expected: 0,
+        called: 2,
+      },
+      {
+        usePassword: false,
+        password: "test",
+        passwordRepeat: "test",
+        expected: 0,
+        called: 2,
+      },
+      {
+        usePassword: false,
+        password: "testA",
+        passwordRepeat: "testB",
+        expected: 0,
+        called: 2,
+      },
+      {
+        usePassword: true,
+        password: "test",
+        passwordRepeat: "test",
+        expected: 1,
+        called: 0,
+      },
+      {
+        usePassword: true,
+        password: "testA",
+        passwordRepeat: "testB",
+        expected: -1,
+        called: 2,
+      },
+      {
+        usePassword: true,
+        password: " ",
+        passwordRepeat: " ",
+        expected: -1,
+        called: 2,
+      },
+      {
+        usePassword: true,
+        password: "",
+        passwordRepeat: " ",
+        expected: -1,
+        called: 2,
+      },
+    ];
+
+    for (const testCase of testCases) {
+      /* prettier-ignore */
+      when(spyOnsSettingsValue)
+        .mockImplementation(() => Promise.resolve("no mockImplementation"))
+        .calledWith("usePassword").mockImplementation(() => Promise.resolve(testCase.usePassword))
+        .calledWith("password").mockImplementation(() => Promise.resolve(testCase.password))
+        .calledWith("passwordRepeat").mockImplementation(() => Promise.resolve(testCase.passwordRepeat));
+      expect(await backup.checkPassword()).toBe(testCase.expected);
+
+      await backup.enablePassword();
+      expect(spyOnsSettingsSetValue).toBeCalledTimes(testCase.called);
+      spyOnsSettingsSetValue.mockReset();
+    }
+  });
+});

package/__test__/sevenZipUpdateBinPath.test.ts

@@ -0,0 +1,16 @@
+import { sevenZip, pathTo7zip } from "../src/sevenZip";
+import * as path from "path";
+import joplin from "api";
+
+it(`Set bin from joplin`, async () => {
+  const pathBevor = pathTo7zip;
+  const pathAdd = "addJoplinPath";
+  const pathAfter = path.join(pathAdd, "7zip-bin", pathTo7zip);
+
+  jest.spyOn(joplin.plugins, "installationDir").mockImplementation(async () => {
+    return pathAdd;
+  });
+
+  await sevenZip.updateBinPath();
+  expect(pathTo7zip).toBe(pathAfter);
+});

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "joplin-plugin-backup",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "scripts": {
     "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
     "prepare": "npm run dist && husky install",
     "update": "npm install -g generator-joplin && yo joplin --update",
+    "release": "npm test && node ./node_modules/joplinplugindevtools/dist/createRelease.js",
+    "preRelease": "npm test && node ./node_modules/joplinplugindevtools/dist/createRelease.js --prerelease",
+    "gitRelease": "node ./node_modules/joplinplugindevtools/dist/createRelease.js --upload",
+    "gitPreRelease": "node ./node_modules/joplinplugindevtools/dist/createRelease.js --upload --prerelease",
     "test": "jest"
   },
   "license": "MIT",
@@ -14,14 +18,18 @@
   "devDependencies": {
     "@types/jest": "^26.0.23",
     "@types/node": "^14.0.14",
+    "axios": "^0.21.1",
     "chalk": "^4.1.0",
     "copy-webpack-plugin": "^6.1.0",
+    "dotenv": "^10.0.0",
     "fs-extra": "^9.0.1",
     "glob": "^7.1.6",
     "husky": "^6.0.0",
     "jest": "^27.0.4",
     "jest-when": "^3.3.1",
+    "joplinplugindevtools": "^1.0.14",
     "lint-staged": "^11.0.0",
+    "mime": "^2.5.2",
     "on-build-webpack": "^0.1.0",
     "prettier": "2.3.0",
     "tar": "^6.0.5",
@@ -56,11 +64,8 @@
       "js"
     ],
     "moduleNameMapper": {
-      "^api$": "<rootDir>/api",
+      "^api$": "<rootDir>/node_modules/joplinplugindevtools/dist/apiMock.js",
       "^api/types$": "<rootDir>/api/types"
-    },
-    "globals": {
-      "joplin": true
     }
   }
 }

package/publish/io.github.jackgruber.backup.json

@@ -2,7 +2,7 @@
 	"manifest_version": 1,
 	"id": "io.github.jackgruber.backup",
 	"app_min_version": "2.1.3",
-	"version": "1.0.3",
+	"version": "1.0.5",
 	"name": "Simple Backup",
 	"description": "Plugin to create manual and automatic backups.",
 	"author": "JackGruber",
@@ -16,6 +16,6 @@
 		"7zip",
 		"encrypted"
 	],
-	"_publish_hash": "sha256:99f57ce2e8c6fb3b86c825f99493239f643590730356b2a981667586a3ca2b2e",
-	"_publish_commit": "master:ebf47d68156e58af11997df87c7073345785ea83"
+	"_publish_hash": "sha256:afa40d7e0ed66a962aab6cbb7a01401cced7e165c4eddec4f1bbbe13ea96187e",
+	"_publish_commit": "master:2c035a3d426785deeaacc1948a2469d0824e0c25"
 }

package/CHANGELOG.md

@@ -1,84 +0,0 @@
-# Changelog
-
-## not released
-
-## v1.0.3 (2021-08-11)
-
-- Fix: #19 Backups failed from Joplin version v2.2.5 and higher, due to the removed template function
-
-## v1.0.2 (2021-07-19)
-
-- Improved: Use of moments token
-- Fix: #16 Prevent multiple simultaneous backup runs
-- Add: #11 Make zip compression level selectable
-- Fix: Delete old backup set information, if the backup set no longer exists
-
-## v1.0.1 (2021-07-03)
-
-Release for Joplin plugin manager
-
-## v1.0.0 [pre-release] (2021-06-20)
-
-- Add: Option for encrypted backups
-
-> ❗️ Requires at least Joplin `2.1.3` ❗️
-
-## v0.9.0 [pre-release] (2021-06-19)
-
-- Add: Relative path could be used for `Backup Path`
-- Fix: An error with `Only on change`, which was not working properly
-- Add: Option to create zip archive
-- Add: Option to specify the `Backup set name` if multiple backups are to be keep.
-
-## v0.5.3 (2021-04-03)
-
-- Add: Backup settings.json
-- Optimize: #7 Better error message when a backup is created twice in a row in the same minute
-
-## v0.5.2 (2021-02-13)
-
-- Only internal changes
-
-## v0.5.1 (2021-02-07)
-
-- Fix: Incomplete backup.log with only one backup set
-
-## v0.5.0 (2021-02-07)
-
-- Add: Option for Backuplogfile
-- Add: Option to create a backup only if something has changed #3
-
-## v0.4.1 (2021-01-23)
-
-- Optimize: Store profile data in `profile` folder
-
-## v0.4.0 (2021-01-21)
-
-- Add `templates` to backup
-- Optimize: Delete old backups at the end of the backup job
-
-## v0.3.1 (2021-01-21)
-
-- Fix #1: Unsupported characters in filename
-
-## v0.3.0 (2021-01-17)
-
-- Fix: Backup not only the last 50 notebooks
-- Add: Backup userchrome.css and userstyle.css
-- Add: Option to create single file JEX for all notebooks
-
-## v0.2.2 (2021-01-17)
-
-- Fix: Check if keymap-desktop.json exists
-
-## v0.2.1 (2021-01-16)
-
-- remove seconds from folder
-
-## v0.2.0 (2021-01-14)
-
-- Add: Automatic backups every X hours
-
-## v0.1.0 (2021-01-14)
-
-- First version