feat(scm): defined the publicly browsable url when hosted on github

as defined by https://maven.apache.org/pom.html#SCM

for #9

src/pom/lifter.js

@@ -1,15 +1,18 @@
 import {promises as fs} from 'node:fs';
-import {XMLBuilder, XMLParser} from 'fast-xml-parser';
+import {XMLParser} from 'fast-xml-parser';
 
+import {write} from './xml/index.js';
 import {getPathTo} from './file.js';
+import defineScmDetails from './scm.js';
 
-export default async function ({projectRoot}) {
+export default async function ({projectRoot, vcs}) {
   const pathToPom = getPathTo(projectRoot);
   const parser = new XMLParser();
-  const builder = new XMLBuilder({format: true});
   const existingPomContents = parser.parse(await fs.readFile(pathToPom, 'utf-8'));
-  existingPomContents.project.scm = {tag: 'HEAD'};
-  await fs.writeFile(pathToPom, builder.build(existingPomContents));
+
+  existingPomContents.project.scm = defineScmDetails(vcs);
+
+  await write({path: pathToPom, contents: existingPomContents});
 
   return {};
 }

src/pom/lifter.test.js

@@ -4,11 +4,15 @@ import {describe, it, expect, vi, afterEach} from 'vitest';
 import any from '@travi/any';
 import {when} from 'jest-when';
 
+import {write} from './xml/index.js';
 import {getPathTo} from './file.js';
+import defineScmDetails from './scm.js';
 import liftPom from './lifter.js';
 
 vi.mock('node:fs');
 vi.mock('./file.js');
+vi.mock('./scm.js');
+vi.mock('./xml/index.js');
 
 describe('pom lifter', () => {
   afterEach(() => {
@@ -18,21 +22,23 @@ describe('pom lifter', () => {
   it('should define the vcs details', async () => {
     const projectRoot = any.string();
     const pathToPomFile = any.string();
+    const vcsDetails = any.simpleObject();
+    const scmDetails = any.simpleObject();
     when(fs.readFile)
       .calledWith(pathToPomFile, 'utf-8')
       .mockResolvedValue('<project><modelVersion>4.0.0</modelVersion></project>');
     when(getPathTo).calledWith(projectRoot).mockReturnValue(pathToPomFile);
+    when(defineScmDetails).calledWith(vcsDetails).mockReturnValue(scmDetails);
 
-    expect(await liftPom({projectRoot})).toEqual({});
-    expect(fs.writeFile).toHaveBeenCalledWith(
-      pathToPomFile,
-      `<project>
-  <modelVersion>4.0.0</modelVersion>
-  <scm>
-    <tag>HEAD</tag>
-  </scm>
-</project>
-`
-    );
+    expect(await liftPom({projectRoot, vcs: vcsDetails})).toEqual({});
+    expect(write).toHaveBeenCalledWith({
+      path: pathToPomFile,
+      contents: {
+        project: {
+          modelVersion: '4.0.0',
+          scm: scmDetails
+        }
+      }
+    });
   });
 });

src/pom/scaffolder.js

@@ -1,13 +1,14 @@
-import {promises as fs} from 'node:fs';
-import {XMLBuilder} from 'fast-xml-parser';
-
+import {write} from './xml/index.js';
 import {getPathTo} from './file.js';
 
 export default async function ({projectRoot, projectName}) {
-  const builder = new XMLBuilder({format: true});
-
-  await fs.writeFile(
-    getPathTo(projectRoot),
-    builder.build({project: {modelVersion: '4.0.0', artifactId: projectName}})
-  );
+  await write({
+    path: getPathTo(projectRoot),
+    contents: {
+      project: {
+        modelVersion: '4.0.0',
+        artifactId: projectName
+      }
+    }
+  });
 }

src/pom/scaffolder.test.js

@@ -1,14 +1,13 @@
-import {promises as fs} from 'node:fs';
-
 import {describe, expect, it, vi, afterEach} from 'vitest';
 import any from '@travi/any';
 import {when} from 'jest-when';
 
+import {write} from './xml/index.js';
 import {getPathTo} from './file.js';
 import scaffold from './scaffolder.js';
 
-vi.mock('node:fs');
 vi.mock('./file.js');
+vi.mock('./xml/index.js');
 
 describe('pom scaffolder', () => {
   afterEach(() => {
@@ -23,14 +22,15 @@ describe('pom scaffolder', () => {
 
     await scaffold({projectRoot, projectName});
 
-    expect(fs.writeFile)
-      .toHaveBeenCalledWith(
-        pathToPomFile,
-        `<project>
-  <modelVersion>4.0.0</modelVersion>
-  <artifactId>${projectName}</artifactId>
-</project>
-`
-      );
+    expect(write)
+      .toHaveBeenCalledWith({
+        path: pathToPomFile,
+        contents: {
+          project: {
+            modelVersion: '4.0.0',
+            artifactId: projectName
+          }
+        }
+      });
   });
 });

src/pom/scm.js

@@ -0,0 +1,6 @@
+export default function ({host, owner, name}) {
+  return {
+    tag: 'HEAD',
+    ...'github' === host && {url: `https://github.com/${owner}/${name}`}
+  };
+}

src/pom/scm.test.js

@@ -0,0 +1,21 @@
+import {describe, expect, it} from 'vitest';
+import any from '@travi/any';
+
+import defineScmDetails from './scm.js';
+
+describe('pom scm details', () => {
+  it('should define scm details for a project hosted on github.com', () => {
+    const owner = any.word();
+    const name = any.word();
+
+    expect(defineScmDetails({owner, name, host: 'github'}))
+      .toEqual({tag: 'HEAD', url: `https://github.com/${owner}/${name}`});
+  });
+
+  it('should only define the tag for a project not hosted on github.com', () => {
+    const owner = any.word();
+    const name = any.word();
+
+    expect(defineScmDetails({owner, name, host: any.word()})).toEqual({tag: 'HEAD'});
+  });
+});

src/pom/xml/index.js

@@ -0,0 +1 @@
+export {default as write} from './writer.js';

src/pom/xml/writer.js

@@ -0,0 +1,8 @@
+import {promises as fs} from 'node:fs';
+import {XMLBuilder} from 'fast-xml-parser';
+
+export default async function ({path, contents}) {
+  const builder = new XMLBuilder({format: true});
+
+  await fs.writeFile(path, builder.build(contents));
+}

src/pom/xml/writer.test.js

@@ -0,0 +1,30 @@
+import {promises as fs} from 'node:fs';
+import {XMLBuilder} from 'fast-xml-parser';
+
+import {afterEach, describe, expect, it, vi} from 'vitest';
+import any from '@travi/any';
+import {when} from 'jest-when';
+
+import write from './writer.js';
+
+vi.mock('node:fs');
+vi.mock('fast-xml-parser');
+
+describe('xml writer', () => {
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('should write the provided data to the xml file', async () => {
+    const pathToFile = any.string();
+    const contents = any.simpleObject();
+    const build = vi.fn();
+    const renderedXml = any.string();
+    when(XMLBuilder).calledWith({format: true}).mockReturnValue({build});
+    when(build).calledWith(contents).mockReturnValue(renderedXml);
+
+    await write({path: pathToFile, contents});
+
+    expect(fs.writeFile).toHaveBeenCalledWith(pathToFile, renderedXml);
+  });
+});

test/integration/features/step_definitions/common-steps.js

@@ -29,5 +29,5 @@ When('the project is scaffolded', async function () {
 });
 
 When('the project is lifted', async function () {
-  await lift({projectRoot: this.projectRoot});
+  await lift({projectRoot: this.projectRoot, vcs: this.vcsDetails});
 });

test/integration/features/step_definitions/pom-steps.js

@@ -6,7 +6,16 @@ import {assert} from 'chai';
 
 Then('the pom file is created', async function () {
   const parser = new XMLParser();
-  const parsedContent = parser.parse(await fs.readFile(`${this.projectRoot}/pom.xml`, 'utf-8'));
+  const pomContent = await fs.readFile(`${this.projectRoot}/pom.xml`, 'utf-8');
+  const parsedContent = parser.parse(pomContent);
 
   assert.deepEqual(parsedContent, {project: {modelVersion: '4.0.0', artifactId: this.projectName}});
+  assert.deepEqual(
+    pomContent,
+    `<project>
+  <modelVersion>4.0.0</modelVersion>
+  <artifactId>${this.projectName}</artifactId>
+</project>
+`
+  );
 });

test/integration/features/step_definitions/vcs-steps.js

@@ -1,16 +1,24 @@
 import {promises as fs} from 'node:fs';
+import {XMLParser} from 'fast-xml-parser';
 
 import {Given, Then} from '@cucumber/cucumber';
-import {XMLParser} from 'fast-xml-parser';
 import {assert} from 'chai';
+import any from '@travi/any';
 
 Given('vcs details are not defined in the pom', async function () {
   await fs.writeFile(`${this.projectRoot}/pom.xml`, '<project><modelVersion>4.0.0</modelVersion></project>');
 });
 
+Given('the repository is hosted on github.com', async function () {
+  const owner = any.word();
+  const repositoryName = any.word();
+  this.vcsDetails = {host: 'github', owner, name: repositoryName};
+  this.vcsUrl = `https://github.com/${owner}/${repositoryName}`;
+});
+
 Then('vcs details are defined in the pom', async function () {
   const parser = new XMLParser();
   const {project: {scm}} = parser.parse(await fs.readFile(`${this.projectRoot}/pom.xml`, 'utf-8'));
 
-  assert.deepEqual(scm, {tag: 'HEAD'});
+  assert.deepEqual(scm, {tag: 'HEAD', url: this.vcsUrl});
 });

test/integration/features/vcs.feature

@@ -1,6 +1,7 @@
 Feature: Version Control Details
 
-  Scenario: No Details Defined
+  Scenario: No Details Defined for a repository hosted on github.com
     Given vcs details are not defined in the pom
+    And the repository is hosted on github.com
     When the project is lifted
     Then vcs details are defined in the pom