From eeb1d5b0c40a55675921af3f67f366b2ff658acf Mon Sep 17 00:00:00 2001 From: undergroundwires Date: Sat, 26 Feb 2022 17:15:30 +0100 Subject: [PATCH] Refactor to use version object #59 Enable writing safer version aware logic. --- .../Parser/ProjectInformationParser.ts | 4 +- .../ScriptingDefinition/CodeSubstituter.ts | 2 +- src/domain/IProjectInformation.ts | 5 +- src/domain/ProjectInformation.ts | 10 +- src/domain/Version.ts | 24 ++++ .../components/TheFooter/TheFooter.vue | 2 +- .../electron/Update/ManualUpdater.ts | 20 ++- .../Parser/ProjectInformationParser.spec.ts | 5 +- .../CodeSubstituter.spec.ts | 4 +- tests/unit/domain/ProjectInformation.spec.ts | 27 ++-- tests/unit/domain/Version.spec.ts | 115 ++++++++++++++++++ .../shared/Stubs/ProcessEnvironmentStub.ts | 2 +- .../shared/Stubs/ProjectInformationStub.ts | 6 +- tests/unit/shared/Stubs/VersionStub.ts | 7 ++ 14 files changed, 198 insertions(+), 35 deletions(-) create mode 100644 src/domain/Version.ts create mode 100644 tests/unit/domain/Version.spec.ts create mode 100644 tests/unit/shared/Stubs/VersionStub.ts diff --git a/src/application/Parser/ProjectInformationParser.ts b/src/application/Parser/ProjectInformationParser.ts index cfa7655e..1ae13c79 100644 --- a/src/application/Parser/ProjectInformationParser.ts +++ b/src/application/Parser/ProjectInformationParser.ts @@ -1,12 +1,14 @@ import { IProjectInformation } from '@/domain/IProjectInformation'; import { ProjectInformation } from '@/domain/ProjectInformation'; +import { Version } from '@/domain/Version'; export function parseProjectInformation( environment: NodeJS.ProcessEnv, ): IProjectInformation { + const version = new Version(environment.VUE_APP_VERSION); return new ProjectInformation( environment.VUE_APP_NAME, - environment.VUE_APP_VERSION, + version, environment.VUE_APP_REPOSITORY_URL, environment.VUE_APP_HOMEPAGE_URL, ); diff --git a/src/application/Parser/ScriptingDefinition/CodeSubstituter.ts b/src/application/Parser/ScriptingDefinition/CodeSubstituter.ts index 46ec5721..00af3ee6 100644 --- a/src/application/Parser/ScriptingDefinition/CodeSubstituter.ts +++ b/src/application/Parser/ScriptingDefinition/CodeSubstituter.ts @@ -22,7 +22,7 @@ export class CodeSubstituter implements ICodeSubstituter { const substitute = (name: string, value: string) => args .addArgument(new FunctionCallArgument(name, value)); substitute('homepage', info.homepage); - substitute('version', info.version); + substitute('version', info.version.toString()); substitute('date', this.date.toUTCString()); const compiledCode = this.compiler.compileExpressions(code, args); return compiledCode; diff --git a/src/domain/IProjectInformation.ts b/src/domain/IProjectInformation.ts index 4ba5890f..0eb5bbdf 100644 --- a/src/domain/IProjectInformation.ts +++ b/src/domain/IProjectInformation.ts @@ -1,8 +1,9 @@ -import { OperatingSystem } from './OperatingSystem'; +import { OperatingSystem } from '@/domain/OperatingSystem'; +import { Version } from '@/domain/Version'; export interface IProjectInformation { readonly name: string; - readonly version: string; + readonly version: Version; readonly repositoryUrl: string; readonly homepage: string; readonly feedbackUrl: string; diff --git a/src/domain/ProjectInformation.ts b/src/domain/ProjectInformation.ts index ca3e207a..dbfb3b9a 100644 --- a/src/domain/ProjectInformation.ts +++ b/src/domain/ProjectInformation.ts @@ -1,21 +1,22 @@ import { assertInRange } from '@/application/Common/Enum'; import { IProjectInformation } from './IProjectInformation'; import { OperatingSystem } from './OperatingSystem'; +import { Version } from './Version'; export class ProjectInformation implements IProjectInformation { public readonly repositoryWebUrl: string; constructor( public readonly name: string, - public readonly version: string, + public readonly version: Version, public readonly repositoryUrl: string, public readonly homepage: string, ) { if (!name) { throw new Error('name is undefined'); } - if (!version || +version <= 0) { - throw new Error('version should be higher than zero'); + if (!version) { + throw new Error('undefined version'); } if (!repositoryUrl) { throw new Error('repositoryUrl is undefined'); @@ -27,7 +28,8 @@ export class ProjectInformation implements IProjectInformation { } public getDownloadUrl(os: OperatingSystem): string { - return `${this.repositoryWebUrl}/releases/download/${this.version}/${getFileName(os, this.version)}`; + const fileName = getFileName(os, this.version.toString()); + return `${this.repositoryWebUrl}/releases/download/${this.version}/${fileName}`; } public get feedbackUrl(): string { diff --git a/src/domain/Version.ts b/src/domain/Version.ts new file mode 100644 index 00000000..8abd531c --- /dev/null +++ b/src/domain/Version.ts @@ -0,0 +1,24 @@ +export class Version { + public readonly major: number; + + public readonly minor: number; + + public readonly patch: number; + + public constructor(semanticVersion: string) { + if (!semanticVersion) { + throw new Error('empty version'); + } + if (!semanticVersion.match(/^\d+\.\d+\.\d+$/g)) { + throw new Error(`invalid version: ${semanticVersion}`); + } + const [major, minor, patch] = semanticVersion.split('.'); + this.major = parseInt(major, 10); + this.minor = parseInt(minor, 10); + this.patch = parseInt(patch, 10); + } + + public toString(): string { + return `${this.major}.${this.minor}.${this.patch}`; + } +} diff --git a/src/presentation/components/TheFooter/TheFooter.vue b/src/presentation/components/TheFooter/TheFooter.vue index c57f4286..f97b14e3 100644 --- a/src/presentation/components/TheFooter/TheFooter.vue +++ b/src/presentation/components/TheFooter/TheFooter.vue @@ -77,7 +77,7 @@ export default class TheFooter extends Vue { private initialize(app: IApplication) { const { info } = app; - this.version = info.version; + this.version = info.version.toString(); this.homepageUrl = info.homepage; this.repositoryUrl = info.repositoryWebUrl; this.releaseUrl = info.releaseUrl; diff --git a/src/presentation/electron/Update/ManualUpdater.ts b/src/presentation/electron/Update/ManualUpdater.ts index 0afc5284..d3706558 100644 --- a/src/presentation/electron/Update/ManualUpdater.ts +++ b/src/presentation/electron/Update/ManualUpdater.ts @@ -6,6 +6,8 @@ import log from 'electron-log'; import fetch from 'cross-fetch'; import { ProjectInformation } from '@/domain/ProjectInformation'; import { OperatingSystem } from '@/domain/OperatingSystem'; +import { Version } from '@/domain/Version'; +import { parseProjectInformation } from '@/application/Parser/ProjectInformationParser'; import { UpdateProgressBar } from './UpdateProgressBar'; export function requiresManualUpdate(): boolean { @@ -17,12 +19,7 @@ export async function handleManualUpdate(info: UpdateInfo) { if (result === ManualDownloadDialogResult.NoAction) { return; } - const project = new ProjectInformation( - process.env.VUE_APP_NAME, - info.version, - process.env.VUE_APP_REPOSITORY_URL, - process.env.VUE_APP_HOMEPAGE_URL, - ); + const project = getTargetProject(info.version); if (result === ManualDownloadDialogResult.VisitReleasesPage) { await shell.openExternal(project.releaseUrl); } else if (result === ManualDownloadDialogResult.UpdateNow) { @@ -30,6 +27,17 @@ export async function handleManualUpdate(info: UpdateInfo) { } } +function getTargetProject(targetVersion: string) { + const existingProject = parseProjectInformation(process.env); + const targetProject = new ProjectInformation( + existingProject.name, + new Version(targetVersion), + existingProject.repositoryUrl, + existingProject.homepage, + ); + return targetProject; +} + enum ManualDownloadDialogResult { NoAction = 0, UpdateNow = 1, diff --git a/tests/unit/application/Parser/ProjectInformationParser.spec.ts b/tests/unit/application/Parser/ProjectInformationParser.spec.ts index 7e9121d6..5cd7d604 100644 --- a/tests/unit/application/Parser/ProjectInformationParser.spec.ts +++ b/tests/unit/application/Parser/ProjectInformationParser.spec.ts @@ -7,13 +7,14 @@ describe('ProjectInformationParser', () => { describe('parseProjectInformation', () => { it('parses expected repository version', () => { // arrange - const expected = 'expected-version'; + const expected = '0.11.3'; const env = getProcessEnvironmentStub(); env.VUE_APP_VERSION = expected; // act const info = parseProjectInformation(env); // assert - expect(info.version).to.be.equal(expected); + const actual = info.version.toString(); + expect(actual).to.be.equal(expected); }); it('parses expected repository url', () => { // arrange diff --git a/tests/unit/application/Parser/ScriptingDefinition/CodeSubstituter.spec.ts b/tests/unit/application/Parser/ScriptingDefinition/CodeSubstituter.spec.ts index 322b905d..ddcf5b21 100644 --- a/tests/unit/application/Parser/ScriptingDefinition/CodeSubstituter.spec.ts +++ b/tests/unit/application/Parser/ScriptingDefinition/CodeSubstituter.spec.ts @@ -43,14 +43,14 @@ describe('CodeSubstituter', () => { // arrange const info = new ProjectInformationStub(); const date = new Date(); - const testCases = [ + const testCases: Array<{ parameter: string, argument: string }> = [ { parameter: 'homepage', argument: info.homepage, }, { parameter: 'version', - argument: info.version, + argument: info.version.toString(), }, { parameter: 'date', diff --git a/tests/unit/domain/ProjectInformation.spec.ts b/tests/unit/domain/ProjectInformation.spec.ts index 8ee4a32a..d1e20dff 100644 --- a/tests/unit/domain/ProjectInformation.spec.ts +++ b/tests/unit/domain/ProjectInformation.spec.ts @@ -3,12 +3,13 @@ import { expect } from 'chai'; import { ProjectInformation } from '@/domain/ProjectInformation'; import { OperatingSystem } from '@/domain/OperatingSystem'; import { EnumRangeTestRunner } from '@tests/unit/application/Common/EnumRangeTestRunner'; +import { VersionStub } from '@tests/unit/shared/Stubs/VersionStub'; describe('ProjectInformation', () => { it('sets name as expected', () => { // arrange const expected = 'expected-name'; - const sut = new ProjectInformation(expected, 'version', 'repositoryUrl', 'homepage'); + const sut = new ProjectInformation(expected, new VersionStub('0.7.2'), 'repositoryUrl', 'homepage'); // act const actual = sut.name; // assert @@ -16,17 +17,17 @@ describe('ProjectInformation', () => { }); it('sets version as expected', () => { // arrange - const expected = 'expected-version'; + const expected = new VersionStub('0.11.3'); const sut = new ProjectInformation('name', expected, 'repositoryUrl', 'homepage'); // act const actual = sut.version; // assert - expect(actual).to.equal(expected); + expect(actual).to.deep.equal(expected); }); it('sets repositoryUrl as expected', () => { // arrange const expected = 'expected-repository-url'; - const sut = new ProjectInformation('name', 'version', expected, 'homepage'); + const sut = new ProjectInformation('name', new VersionStub('0.7.2'), expected, 'homepage'); // act const actual = sut.repositoryUrl; // assert @@ -36,7 +37,7 @@ describe('ProjectInformation', () => { it('sets repositoryUrl when it does not end with .git', () => { // arrange const expected = 'expected-repository-url'; - const sut = new ProjectInformation('name', 'version', expected, 'homepage'); + const sut = new ProjectInformation('name', new VersionStub('0.7.2'), expected, 'homepage'); // act const actual = sut.repositoryWebUrl; // assert @@ -45,7 +46,7 @@ describe('ProjectInformation', () => { it('removes ".git" from the end when it ends with ".git"', () => { // arrange const expected = 'expected-repository-url'; - const sut = new ProjectInformation('name', 'version', `${expected}.git`, 'homepage'); + const sut = new ProjectInformation('name', new VersionStub('0.7.2'), `${expected}.git`, 'homepage'); // act const actual = sut.repositoryWebUrl; // assert @@ -55,7 +56,7 @@ describe('ProjectInformation', () => { it('sets homepage as expected', () => { // arrange const expected = 'expected-homepage'; - const sut = new ProjectInformation('name', 'version', 'repositoryUrl', expected); + const sut = new ProjectInformation('name', new VersionStub('0.7.2'), 'repositoryUrl', expected); // act const actual = sut.homepage; // assert @@ -65,7 +66,7 @@ describe('ProjectInformation', () => { // arrange const repositoryUrl = 'https://github.com/undergroundwires/privacy.sexy.git'; const expected = 'https://github.com/undergroundwires/privacy.sexy/issues'; - const sut = new ProjectInformation('name', 'version', repositoryUrl, 'homepage'); + const sut = new ProjectInformation('name', new VersionStub('0.7.2'), repositoryUrl, 'homepage'); // act const actual = sut.feedbackUrl; // assert @@ -74,7 +75,7 @@ describe('ProjectInformation', () => { it('sets releaseUrl to github releases page', () => { // arrange const repositoryUrl = 'https://github.com/undergroundwires/privacy.sexy.git'; - const version = '0.7.2'; + const version = new VersionStub('0.7.2'); const expected = 'https://github.com/undergroundwires/privacy.sexy/releases/tag/0.7.2'; const sut = new ProjectInformation('name', version, repositoryUrl, 'homepage'); // act @@ -87,7 +88,7 @@ describe('ProjectInformation', () => { // arrange const expected = 'https://github.com/undergroundwires/privacy.sexy/releases/download/0.7.2/privacy.sexy-0.7.2.dmg'; const repositoryUrl = 'https://github.com/undergroundwires/privacy.sexy.git'; - const version = '0.7.2'; + const version = new VersionStub('0.7.2'); const sut = new ProjectInformation('name', version, repositoryUrl, 'homepage'); // act const actual = sut.getDownloadUrl(OperatingSystem.macOS); @@ -98,7 +99,7 @@ describe('ProjectInformation', () => { // arrange const expected = 'https://github.com/undergroundwires/privacy.sexy/releases/download/0.7.2/privacy.sexy-0.7.2.AppImage'; const repositoryUrl = 'https://github.com/undergroundwires/privacy.sexy.git'; - const version = '0.7.2'; + const version = new VersionStub('0.7.2'); const sut = new ProjectInformation('name', version, repositoryUrl, 'homepage'); // act const actual = sut.getDownloadUrl(OperatingSystem.Linux); @@ -109,7 +110,7 @@ describe('ProjectInformation', () => { // arrange const expected = 'https://github.com/undergroundwires/privacy.sexy/releases/download/0.7.2/privacy.sexy-Setup-0.7.2.exe'; const repositoryUrl = 'https://github.com/undergroundwires/privacy.sexy.git'; - const version = '0.7.2'; + const version = new VersionStub('0.7.2'); const sut = new ProjectInformation('name', version, repositoryUrl, 'homepage'); // act const actual = sut.getDownloadUrl(OperatingSystem.Windows); @@ -118,7 +119,7 @@ describe('ProjectInformation', () => { }); describe('throws when os is invalid', () => { // arrange - const sut = new ProjectInformation('name', 'version', 'repositoryUrl', 'homepage'); + const sut = new ProjectInformation('name', new VersionStub(), 'repositoryUrl', 'homepage'); // act const act = (os: OperatingSystem) => sut.getDownloadUrl(os); // assert diff --git a/tests/unit/domain/Version.spec.ts b/tests/unit/domain/Version.spec.ts new file mode 100644 index 00000000..d24b3ace --- /dev/null +++ b/tests/unit/domain/Version.spec.ts @@ -0,0 +1,115 @@ +import 'mocha'; +import { expect } from 'chai'; +import { Version } from '@/domain/Version'; + +describe('Version', () => { + describe('invalid versions', () => { + describe('throws with invalid semantic version', () => { + // arrange + const invalidVersions = [ + '0.1.0.0', '0.1', '0.1..0', '0..1.0', '0..1', '...', '0.10', '0.-5.4', + ]; + for (const version of invalidVersions) { + const expectedError = `invalid version: ${version}`; + it(`given ${version}`, () => { + // act + const act = () => new Version(version); + // + expect(act).to.throw(expectedError); + }); + } + }); + describe('throws with empty string', () => { + // arrange + const expectedError = 'empty version'; + const testCases = [ + { name: 'empty', value: '' }, + { name: 'undefined', value: undefined }, + ]; + for (const testCase of testCases) { + it(`given ${testCase.name}`, () => { + // act + const act = () => new Version(testCase.value); + // + expect(act).to.throw(expectedError); + }); + } + }); + }); + describe('valid versions', () => { + const validVersions: Array = [ + { + text: '0.1.0', + parts: { major: 0, minor: 1, patch: 0 }, + }, + { + text: '3.0.0', + parts: { major: 3, minor: 0, patch: 0 }, + }, + { + text: '100.1000.10000', + parts: { major: 100, minor: 1000, patch: 10000 }, + }, + ]; + function testValidVersions(tester: (data: ValidVersionTestData) => void) { + for (const version of validVersions) { + it(`given ${version.text}`, () => { + tester(version); + }); + } + } + describe('major', () => { + testValidVersions((version) => { + // arrange + const expected = version.parts.major; + // act + const sut = new Version(version.text); + const actual = sut.major; + // assert + expect(expected).to.equal(actual); + }); + }); + describe('minor', () => { + testValidVersions((version) => { + // arrange + const expected = version.parts.minor; + // act + const sut = new Version(version.text); + const actual = sut.minor; + // assert + expect(expected).to.equal(actual); + }); + }); + describe('patch', () => { + testValidVersions((version) => { + // arrange + const expected = version.parts.patch; + // act + const sut = new Version(version.text); + const actual = sut.patch; + // assert + expect(expected).to.equal(actual); + }); + }); + describe('toString', () => { + testValidVersions((version) => { + // arrange + const expected = version.text; + // act + const sut = new Version(expected); + const actual = sut.toString(); + // assert + expect(expected).to.equal(actual); + }); + }); + }); +}); + +interface ValidVersionTestData { + text: string; + parts: { + major: number, + minor: number, + patch: number, + }, +} diff --git a/tests/unit/shared/Stubs/ProcessEnvironmentStub.ts b/tests/unit/shared/Stubs/ProcessEnvironmentStub.ts index 03a0c26d..f28ba0c4 100644 --- a/tests/unit/shared/Stubs/ProcessEnvironmentStub.ts +++ b/tests/unit/shared/Stubs/ProcessEnvironmentStub.ts @@ -1,6 +1,6 @@ export function getProcessEnvironmentStub(): NodeJS.ProcessEnv { return { - VUE_APP_VERSION: 'stub-version', + VUE_APP_VERSION: '0.11.3', VUE_APP_NAME: 'stub-name', VUE_APP_REPOSITORY_URL: 'stub-repository-url', VUE_APP_HOMEPAGE_URL: 'stub-homepage-url', diff --git a/tests/unit/shared/Stubs/ProjectInformationStub.ts b/tests/unit/shared/Stubs/ProjectInformationStub.ts index 0c553cb5..4b5cf52d 100644 --- a/tests/unit/shared/Stubs/ProjectInformationStub.ts +++ b/tests/unit/shared/Stubs/ProjectInformationStub.ts @@ -1,9 +1,11 @@ import { IProjectInformation } from '@/domain/IProjectInformation'; +import { Version } from '@/domain/Version'; +import { VersionStub } from './VersionStub'; export class ProjectInformationStub implements IProjectInformation { public name = 'name'; - public version = 'version'; + public version = new VersionStub(); public repositoryUrl = 'repositoryUrl'; @@ -22,7 +24,7 @@ export class ProjectInformationStub implements IProjectInformation { return this; } - public withVersion(version: string): ProjectInformationStub { + public withVersion(version: Version): ProjectInformationStub { this.version = version; return this; } diff --git a/tests/unit/shared/Stubs/VersionStub.ts b/tests/unit/shared/Stubs/VersionStub.ts new file mode 100644 index 00000000..86002531 --- /dev/null +++ b/tests/unit/shared/Stubs/VersionStub.ts @@ -0,0 +1,7 @@ +import { Version } from '@/domain/Version'; + +export class VersionStub extends Version { + constructor(version?: string) { + super(version ?? '0.10.0'); + } +}