refactor: Use types to create vocabularies.

CommunitySolidServer · Jan 2, 2021 · 8e138c3 · RubenVerborgh · Jan 2, 2021 · joachimvh
1 parent 882c0fd
commit 8e138c3
Show file tree

Hide file tree

Showing 41 changed files with 145 additions and 111 deletions.
diff --git a/src/authorization/WebAclAuthorizer.ts b/src/authorization/WebAclAuthorizer.ts
@@ -12,7 +12,7 @@ import { InternalServerError } from '../util/errors/InternalServerError';
 import { NotFoundHttpError } from '../util/errors/NotFoundHttpError';
 import { UnauthorizedHttpError } from '../util/errors/UnauthorizedHttpError';
 import type { IdentifierStrategy } from '../util/identifiers/IdentifierStrategy';
-import { ACL, FOAF } from '../util/UriConstants';
+import { ACL, FOAF } from '../util/Vocabularies';
 import type { AclManager } from './AclManager';
 import type { AuthorizerArgs } from './Authorizer';
 import { Authorizer } from './Authorizer';

diff --git a/src/index.ts b/src/index.ts
@@ -199,6 +199,6 @@ export * from './util/QuadUtil';
 export * from './util/RecordObject';
 export * from './util/SequenceHandler';
 export * from './util/StreamUtil';
-export * from './util/WaterfallHandler';
-export * from './util/UriConstants';
 export * from './util/UriUtil';
+export * from './util/Vocabularies';
+export * from './util/WaterfallHandler';
diff --git a/src/init/AclInitializer.ts b/src/init/AclInitializer.ts
@@ -7,7 +7,7 @@ import { TEXT_TURTLE } from '../util/ContentTypes';
 import { NotFoundHttpError } from '../util/errors/NotFoundHttpError';
 import { ensureTrailingSlash } from '../util/PathUtil';
 import { guardedStreamFrom } from '../util/StreamUtil';
-import { CONTENT_TYPE } from '../util/UriConstants';
+import { CONTENT_TYPE } from '../util/Vocabularies';
 import { Initializer } from './Initializer';
 
 /**

diff --git a/src/init/RootContainerInitializer.ts b/src/init/RootContainerInitializer.ts
@@ -8,8 +8,8 @@ import { NotFoundHttpError } from '../util/errors/NotFoundHttpError';
 import { ensureTrailingSlash } from '../util/PathUtil';
 import { generateResourceQuads } from '../util/ResourceUtil';
 import { guardedStreamFrom } from '../util/StreamUtil';
-import { PIM, RDF } from '../util/UriConstants';
 import { toCachedNamedNode } from '../util/UriUtil';
+import { PIM, RDF } from '../util/Vocabularies';
 import { Initializer } from './Initializer';
 import namedNode = DataFactory.namedNode;
 

diff --git a/src/ldp/http/metadata/LinkTypeParser.ts b/src/ldp/http/metadata/LinkTypeParser.ts
@@ -2,7 +2,7 @@ import { DataFactory } from 'n3';
 import { getLoggerFor } from '../../../logging/LogUtil';
 import type { HttpRequest } from '../../../server/HttpRequest';
 import { parseParameters, splitAndClean, transformQuotedStrings } from '../../../util/HeaderUtil';
-import { RDF } from '../../../util/UriConstants';
+import { RDF } from '../../../util/Vocabularies';
 import type { RepresentationMetadata } from '../../representation/RepresentationMetadata';
 import type { MetadataParser } from './MetadataParser';
 

diff --git a/src/ldp/http/metadata/SlugParser.ts b/src/ldp/http/metadata/SlugParser.ts
@@ -1,7 +1,7 @@
 import { getLoggerFor } from '../../../logging/LogUtil';
 import type { HttpRequest } from '../../../server/HttpRequest';
 import { BadRequestHttpError } from '../../../util/errors/BadRequestHttpError';
-import { HTTP } from '../../../util/UriConstants';
+import { HTTP } from '../../../util/Vocabularies';
 import type { RepresentationMetadata } from '../../representation/RepresentationMetadata';
 import type { MetadataParser } from './MetadataParser';
 

diff --git a/src/ldp/http/response/CreatedResponseDescription.ts b/src/ldp/http/response/CreatedResponseDescription.ts
@@ -1,5 +1,5 @@
 import { DataFactory } from 'n3';
-import { HTTP } from '../../../util/UriConstants';
+import { HTTP } from '../../../util/Vocabularies';
 import { RepresentationMetadata } from '../../representation/RepresentationMetadata';
 import type { ResourceIdentifier } from '../../representation/ResourceIdentifier';
 import { ResponseDescription } from './ResponseDescription';

diff --git a/src/storage/DataAccessorBasedStore.ts b/src/storage/DataAccessorBasedStore.ts
@@ -22,7 +22,7 @@ import {
 import { parseQuads } from '../util/QuadUtil';
 import { generateResourceQuads } from '../util/ResourceUtil';
 import { guardedStreamFrom } from '../util/StreamUtil';
-import { CONTENT_TYPE, HTTP, LDP, PIM, RDF } from '../util/UriConstants';
+import { CONTENT_TYPE, HTTP, LDP, PIM, RDF } from '../util/Vocabularies';
 import type { DataAccessor } from './accessors/DataAccessor';
 import type { ResourceStore } from './ResourceStore';
 

diff --git a/src/storage/accessors/FileDataAccessor.ts b/src/storage/accessors/FileDataAccessor.ts
@@ -16,8 +16,8 @@ import type { Guarded } from '../../util/GuardedStream';
 import { isContainerIdentifier } from '../../util/PathUtil';
 import { parseQuads, pushQuad, serializeQuads } from '../../util/QuadUtil';
 import { generateContainmentQuads, generateResourceQuads } from '../../util/ResourceUtil';
-import { CONTENT_TYPE, DCTERMS, LDP, POSIX, RDF, XSD } from '../../util/UriConstants';
 import { toCachedNamedNode, toLiteral } from '../../util/UriUtil';
+import { CONTENT_TYPE, DCTERMS, LDP, POSIX, RDF, XSD } from '../../util/Vocabularies';
 import type { FileIdentifierMapper, ResourceLink } from '../mapping/FileIdentifierMapper';
 import type { DataAccessor } from './DataAccessor';
 

diff --git a/src/storage/accessors/SparqlDataAccessor.ts b/src/storage/accessors/SparqlDataAccessor.ts
@@ -27,8 +27,8 @@ import { guardStream } from '../../util/GuardedStream';
 import type { Guarded } from '../../util/GuardedStream';
 import type { IdentifierStrategy } from '../../util/identifiers/IdentifierStrategy';
 import { isContainerIdentifier } from '../../util/PathUtil';
-import { CONTENT_TYPE, LDP } from '../../util/UriConstants';
 import { toCachedNamedNode } from '../../util/UriUtil';
+import { CONTENT_TYPE, LDP } from '../../util/Vocabularies';
 import type { DataAccessor } from './DataAccessor';
 
 const { defaultGraph, namedNode, quad, variable } = DataFactory;

diff --git a/src/storage/conversion/QuadToRdfConverter.ts b/src/storage/conversion/QuadToRdfConverter.ts
@@ -5,7 +5,7 @@ import { RepresentationMetadata } from '../../ldp/representation/RepresentationM
 import type { RepresentationPreferences } from '../../ldp/representation/RepresentationPreferences';
 import { INTERNAL_QUADS } from '../../util/ContentTypes';
 import { guardStream } from '../../util/GuardedStream';
-import { CONTENT_TYPE } from '../../util/UriConstants';
+import { CONTENT_TYPE } from '../../util/Vocabularies';
 import { matchingMediaTypes } from './ConversionUtil';
 import type { RepresentationConverterArgs } from './RepresentationConverter';
 import { TypedRepresentationConverter } from './TypedRepresentationConverter';

diff --git a/src/storage/conversion/RdfToQuadConverter.ts b/src/storage/conversion/RdfToQuadConverter.ts
@@ -5,7 +5,7 @@ import { RepresentationMetadata } from '../../ldp/representation/RepresentationM
 import { INTERNAL_QUADS } from '../../util/ContentTypes';
 import { BadRequestHttpError } from '../../util/errors/BadRequestHttpError';
 import { pipeSafely } from '../../util/StreamUtil';
-import { CONTENT_TYPE } from '../../util/UriConstants';
+import { CONTENT_TYPE } from '../../util/Vocabularies';
 import type { RepresentationConverterArgs } from './RepresentationConverter';
 import { TypedRepresentationConverter } from './TypedRepresentationConverter';
 

diff --git a/src/storage/patch/SparqlUpdatePatchHandler.ts b/src/storage/patch/SparqlUpdatePatchHandler.ts
@@ -14,7 +14,7 @@ import { NotFoundHttpError } from '../../util/errors/NotFoundHttpError';
 import { NotImplementedHttpError } from '../../util/errors/NotImplementedHttpError';
 import { guardStream } from '../../util/GuardedStream';
 import type { ResourceLocker } from '../../util/locking/ResourceLocker';
-import { CONTENT_TYPE } from '../../util/UriConstants';
+import { CONTENT_TYPE } from '../../util/Vocabularies';
 import type { ResourceStore } from '../ResourceStore';
 import { PatchHandler } from './PatchHandler';
 

diff --git a/src/util/ResourceUtil.ts b/src/util/ResourceUtil.ts
@@ -2,8 +2,8 @@ import { DataFactory } from 'n3';
 import type { NamedNode, Quad } from 'rdf-js';
 import { RepresentationMetadata } from '../ldp/representation/RepresentationMetadata';
 import { pushQuad } from './QuadUtil';
-import { LDP, RDF } from './UriConstants';
 import { toCachedNamedNode } from './UriUtil';
+import { LDP, RDF } from './Vocabularies';
 
 /**
  * Helper function to generate type quads for a Container or Resource.

diff --git a/src/util/UriConstants.ts b/src/util/UriConstants.ts
diff --git a/src/util/UriUtil.ts b/src/util/UriUtil.ts
@@ -1,6 +1,6 @@
 import { DataFactory } from 'n3';
 import type { Literal, NamedNode, Term } from 'rdf-js';
-import { CONTENT_TYPE } from './UriConstants';
+import { CONTENT_TYPE } from './Vocabularies';
 
 const { namedNode, literal } = DataFactory;
 

diff --git a/src/util/Vocabularies.ts b/src/util/Vocabularies.ts
@@ -0,0 +1,89 @@
+/* eslint-disable @typescript-eslint/naming-convention, function-paren-newline */
+
+type PrefixResolver<T> = (localName: string) => T;
+type RecordOf<TKey extends any[], TValue> = Record<TKey[number], TValue>;
+
+export type Namespace<TKey extends any[], TValue> =
+  PrefixResolver<TValue> & RecordOf<TKey, TValue>;
+
+/**
+ * Creates a function that expands local names from the given base URI,
+ * and exports the given local names as properties on the returned object.
+ */
+export const createNamespace = <T extends string>(baseUri: string, ...localNames: T[]):
+Namespace<typeof localNames, string> => {
+  // Create a function that expands local names
+  const expanded = {} as Record<string, string>;
+  const namespace = ((localName: string): string => {
+    if (!(localName in expanded)) {
+      expanded[localName] = `${baseUri}${localName}`;
+    }
+    return expanded[localName];
+  }) as Namespace<typeof localNames, string>;
+
+  // Expose the listed local names as properties
+  for (const localName of localNames) {
+    (namespace as RecordOf<typeof localNames, string>)[localName] = namespace(localName);
+  }
+  return namespace;
+};
+
+export const ACL = createNamespace('http://www.w3.org/ns/auth/acl#',
+  'accessTo',
+  'agent',
+  'agentClass',
+  'default',
+  'mode',
+
+  'Write',
+  'Read',
+  'Append',
+  'Control',
+);
+
+export const DCTERMS = createNamespace('http://purl.org/dc/terms/',
+  'modified',
+);
+
+export const FOAF = createNamespace('http://xmlns.com/foaf/0.1/',
+  'Agent',
+  'AuthenticatedAgent',
+);
+
+export const HTTP = createNamespace('urn:solid:http:',
+  'location',
+  'slug',
+);
+
+export const LDP = createNamespace('http://www.w3.org/ns/ldp#',
+  'contains',
+
+  'BasicContainer',
+  'Container',
+  'Resource',
+);
+
+export const MA = createNamespace('http://www.w3.org/ns/ma-ont#',
+  'format',
+);
+
+export const PIM = createNamespace('http://www.w3.org/ns/pim/space#',
+  'Storage',
+);
+
+export const POSIX = createNamespace('http://www.w3.org/ns/posix/stat#',
+  'mtime',
+  'size',
+);
+
+export const RDF = createNamespace('http://www.w3.org/1999/02/22-rdf-syntax-ns#',
+  'type',
+);
+
+export const XSD = createNamespace('http://www.w3.org/2001/XMLSchema#',
+  'dateTime',
+  'integer',
+);
+
+// Alias for most commonly used URI
+export const CONTENT_TYPE = MA.format;
diff --git a/test/integration/LdpHandlerWithAuth.test.ts b/test/integration/LdpHandlerWithAuth.test.ts
@@ -3,7 +3,7 @@ import { join } from 'path';
 import type { HttpHandler, Initializer, ResourceStore } from '../../src/';
 import { RepresentationMetadata } from '../../src/ldp/representation/RepresentationMetadata';
 import { guardStream } from '../../src/util/GuardedStream';
-import { CONTENT_TYPE, LDP } from '../../src/util/UriConstants';
+import { CONTENT_TYPE, LDP } from '../../src/util/Vocabularies';
 import { AclHelper, ResourceHelper } from '../util/TestHelpers';
 import { BASE, getTestFolder, createFolder, removeFolder, instantiateFromConfig } from './Config';
 

diff --git a/test/integration/LdpHandlerWithoutAuth.test.ts b/test/integration/LdpHandlerWithoutAuth.test.ts
@@ -1,5 +1,5 @@
 import type { HttpHandler, Initializer, ResourceStore } from '../../src/';
-import { LDP } from '../../src/util/UriConstants';
+import { LDP } from '../../src/util/Vocabularies';
 import { ResourceHelper } from '../util/TestHelpers';
 import { BASE, getTestFolder, createFolder, removeFolder, instantiateFromConfig } from './Config';
 

diff --git a/test/integration/LockingResourceStore.test.ts b/test/integration/LockingResourceStore.test.ts
@@ -13,7 +13,7 @@ import type { ResourceLocker } from '../../src/util/locking/ResourceLocker';
 import { SingleThreadedResourceLocker } from '../../src/util/locking/SingleThreadedResourceLocker';
 import { WrappedExpiringResourceLocker } from '../../src/util/locking/WrappedExpiringResourceLocker';
 import { guardedStreamFrom } from '../../src/util/StreamUtil';
-import { CONTENT_TYPE } from '../../src/util/UriConstants';
+import { CONTENT_TYPE } from '../../src/util/Vocabularies';
 import { BASE } from './Config';
 
 describe('A LockingResourceStore', (): void => {

diff --git a/test/integration/LpdHandlerOperations.test.ts b/test/integration/LpdHandlerOperations.test.ts
@@ -4,7 +4,7 @@ import { namedNode, quad } from '@rdfjs/data-model';
 import { Parser } from 'n3';
 import type { MockResponse } from 'node-mocks-http';
 import type { HttpHandler } from '../../src/server/HttpHandler';
-import { LDP } from '../../src/util/UriConstants';
+import { LDP } from '../../src/util/Vocabularies';
 import { performRequest } from '../util/Util';
 import { BASE, instantiateFromConfig } from './Config';
 

diff --git a/test/integration/RepresentationConverter.test.ts b/test/integration/RepresentationConverter.test.ts
@@ -4,7 +4,7 @@ import { ChainedConverter } from '../../src/storage/conversion/ChainedConverter'
 import { QuadToRdfConverter } from '../../src/storage/conversion/QuadToRdfConverter';
 import { RdfToQuadConverter } from '../../src/storage/conversion/RdfToQuadConverter';
 import { guardedStreamFrom, readableToString } from '../../src/util/StreamUtil';
-import { CONTENT_TYPE } from '../../src/util/UriConstants';
+import { CONTENT_TYPE } from '../../src/util/Vocabularies';
 
 describe('A ChainedConverter', (): void => {
   const converters = [

diff --git a/test/unit/ldp/http/BasicResponseWriter.test.ts b/test/unit/ldp/http/BasicResponseWriter.test.ts
@@ -9,7 +9,7 @@ import { RepresentationMetadata } from '../../../../src/ldp/representation/Repre
 import { INTERNAL_QUADS } from '../../../../src/util/ContentTypes';
 import { NotImplementedHttpError } from '../../../../src/util/errors/NotImplementedHttpError';
 import { guardedStreamFrom } from '../../../../src/util/StreamUtil';
-import { CONTENT_TYPE } from '../../../../src/util/UriConstants';
+import { CONTENT_TYPE } from '../../../../src/util/Vocabularies';
 import { StaticAsyncHandler } from '../../../util/StaticAsyncHandler';
 
 describe('A BasicResponseWriter', (): void => {

diff --git a/test/unit/ldp/http/metadata/BasicMetadataExtractor.test.ts b/test/unit/ldp/http/metadata/BasicMetadataExtractor.test.ts
@@ -2,7 +2,7 @@ import { BasicMetadataExtractor } from '../../../../../src/ldp/http/metadata/Bas
 import type { MetadataParser } from '../../../../../src/ldp/http/metadata/MetadataParser';
 import type { RepresentationMetadata } from '../../../../../src/ldp/representation/RepresentationMetadata';
 import type { HttpRequest } from '../../../../../src/server/HttpRequest';
-import { RDF } from '../../../../../src/util/UriConstants';
+import { RDF } from '../../../../../src/util/Vocabularies';
 
 class BasicParser implements MetadataParser {
   private readonly header: string;

diff --git a/test/unit/ldp/http/metadata/LinkRelMetadataWriter.test.ts b/test/unit/ldp/http/metadata/LinkRelMetadataWriter.test.ts
@@ -1,8 +1,8 @@
 import { createResponse } from 'node-mocks-http';
 import { LinkRelMetadataWriter } from '../../../../../src/ldp/http/metadata/LinkRelMetadataWriter';
 import { RepresentationMetadata } from '../../../../../src/ldp/representation/RepresentationMetadata';
-import { LDP, RDF } from '../../../../../src/util/UriConstants';
 import { toCachedNamedNode } from '../../../../../src/util/UriUtil';
+import { LDP, RDF } from '../../../../../src/util/Vocabularies';
 
 describe('A LinkRelMetadataWriter', (): void => {
   const writer = new LinkRelMetadataWriter({ [RDF.type]: 'type', dummy: 'dummy' });

diff --git a/test/unit/ldp/http/metadata/LinkTypeParser.test.ts b/test/unit/ldp/http/metadata/LinkTypeParser.test.ts
@@ -1,7 +1,7 @@
 import { LinkTypeParser } from '../../../../../src/ldp/http/metadata/LinkTypeParser';
 import { RepresentationMetadata } from '../../../../../src/ldp/representation/RepresentationMetadata';
 import type { HttpRequest } from '../../../../../src/server/HttpRequest';
-import { RDF } from '../../../../../src/util/UriConstants';
+import { RDF } from '../../../../../src/util/Vocabularies';
 
 describe('A LinkTypeParser', (): void => {
   const parser = new LinkTypeParser();

diff --git a/test/unit/ldp/http/metadata/MappedMetadataWriter.test.ts b/test/unit/ldp/http/metadata/MappedMetadataWriter.test.ts
@@ -1,7 +1,7 @@
 import { createResponse } from 'node-mocks-http';
 import { MappedMetadataWriter } from '../../../../../src/ldp/http/metadata/MappedMetadataWriter';
 import { RepresentationMetadata } from '../../../../../src/ldp/representation/RepresentationMetadata';
-import { CONTENT_TYPE } from '../../../../../src/util/UriConstants';
+import { CONTENT_TYPE } from '../../../../../src/util/Vocabularies';
 
 describe('A MappedMetadataWriter', (): void => {
   const writer = new MappedMetadataWriter({ [CONTENT_TYPE]: 'content-type', dummy: 'dummy' });

diff --git a/test/unit/ldp/http/metadata/SlugParser.test.ts b/test/unit/ldp/http/metadata/SlugParser.test.ts
@@ -2,7 +2,7 @@ import { SlugParser } from '../../../../../src/ldp/http/metadata/SlugParser';
 import { RepresentationMetadata } from '../../../../../src/ldp/representation/RepresentationMetadata';
 import type { HttpRequest } from '../../../../../src/server/HttpRequest';
 import { BadRequestHttpError } from '../../../../../src/util/errors/BadRequestHttpError';
-import { HTTP } from '../../../../../src/util/UriConstants';
+import { HTTP } from '../../../../../src/util/Vocabularies';
 
 describe('A SlugParser', (): void => {
   const parser = new SlugParser();