OpenSourceArk/Ghost
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revert "Added @tryghost/in-memory-repository"

Browse Source 
This reverts commit 905578d590.
This commit is contained in:
Fabien "egg" O'Carroll 2023-05-09 19:38:06 -04:00
parent 6ad14bfba9
commit 9ac8301f5b
11 changed files with 0 additions and 534 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.github/dev.js vendored
View File

@ -50,16 +50,6 @@ if (DASH_DASH_ARGS.includes('revisions') || DASH_DASH_ARGS.includes('all')) {
});
}
if (DASH_DASH_ARGS.includes('in-memory-repository') || DASH_DASH_ARGS.includes('all')) {
commands.push({
name: 'in-memory-repository',
command: 'yarn dev',
cwd: path.resolve(__dirname, '../ghost/in-memory-repository'),
prefixColor: 'pink',
env: {}
});
}
if (DASH_DASH_ARGS.includes('portal') || DASH_DASH_ARGS.includes('all')) {
commands.push({
name: 'portal',

3
.gitignore vendored
View File

@ -138,6 +138,3 @@ Caddyfile
/ghost/post-revisions/build
/ghost/post-revisions/tsconfig.tsbuildinfo
/ghost/in-memory-repository/build
/ghost/in-memory-repository/tsconfig.tsbuildinfo

11
ghost/in-memory-repository/.eslintrc.js
View File

@ -1,11 +0,0 @@
module.exports = {
parser: '@typescript-eslint/parser',
plugins: ['ghost', '@typescript-eslint'],
extends: [
'plugin:ghost/node'
],
rules: {
'no-unused-vars': 'off',
'@typescript-eslint/no-unused-vars': ['error']
}
};

21
ghost/in-memory-repository/README.md
View File

@ -1,21 +0,0 @@
# In Memory Repository
## Usage
## Develop
This is a monorepo package.
Follow the instructions for the top-level repo.
1. `git clone` this repo & `cd` into it as usual
2. Run `yarn` to install top-level dependencies.
## Test
- `yarn lint` run just eslint
- `yarn test` run lint and tests

33
ghost/in-memory-repository/package.json
View File

@ -1,33 +0,0 @@
{
"name": "@tryghost/in-memory-repository",
"version": "0.0.0",
"repository": "https://github.com/TryGhost/Ghost/tree/main/packages/in-memory-repository",
"author": "Ghost Foundation",
"private": true,
"main": "build/index.js",
"types": "build/index.d.ts",
"scripts": {
"dev": "tsc --watch --preserveWatchOutput --sourceMap",
"build": "tsc",
"prepare": "tsc",
"test:unit": "NODE_ENV=testing c8 --src src --all --check-coverage --100 --reporter text --reporter cobertura mocha -r ts-node/register './test/**/*.test.ts'",
"test": "yarn test:types && yarn test:unit",
"test:types": "tsc --noEmit",
"lint:code": "eslint src/ --ext .ts --cache",
"lint": "yarn lint:code && yarn lint:test",
"lint:test": "eslint -c test/.eslintrc.js test/ --ext .ts --cache"
},
"files": [
"build"
],
"devDependencies": {
"c8": "7.13.0",
"mocha": "10.2.0",
"sinon": "15.0.4",
"ts-node": "10.9.1",
"typescript": "5.0.4"
},
"dependencies": {
"@tryghost/nql": "^0.11.0"
}
}

80
ghost/in-memory-repository/src/InMemoryRepository.ts
View File

@ -1,80 +0,0 @@
import nql from '@tryghost/nql';
type Entity<T> = {
id: T;
deleted: boolean;
}
type Order<T> = {
field: keyof T;
direction: 'asc' | 'desc';
}
type OrderOption<T extends Entity<any>> = Order<T>[];
export abstract class InMemoryRepository<IDType, T extends Entity<IDType>> {
private store: T[] = [];
private ids: Map<IDType, true> = new Map();
constructor() {}
protected abstract toPrimitive(entity: T): object;
public async save(entity: T): Promise<void> {
if (entity.deleted) {
this.store = this.store.filter(item => item.id !== entity.id);
this.ids.delete(entity.id);
return;
}
if (this.ids.has(entity.id)) {
this.store = this.store.map((item) => {
if (item.id === entity.id) {
return entity;
}
return item;
});
} else {
this.store.push(entity);
this.ids.set(entity.id, true);
}
}
public async getById(id: string): Promise<T | null> {
return this.store.find(item => item.id === id) || null;
}
public async getAll(options: { filter?: string; order?: OrderOption<T> } = {}): Promise<T[]> {
const filter = nql(options.filter);
const results = this.store.slice().filter(item => filter.queryJSON(this.toPrimitive(item)));
if (options.order) {
for (const order of options.order) {
results.sort((a, b) => {
if (order.direction === 'asc') {
return a[order.field] as any > (b[order.field] as any) ? 1 : -1;
} else {
return a[order.field] < b[order.field] ? 1 : -1;
}
});
}
}
return results;
}
public async getPage(options: { filter?: string; page: number; limit: number; order?: Order<T>[] } = {page: 1, limit: 15}): Promise<T[]> {
const results = await this.getAll(options);
const start = (options.page - 1) * options.limit;
const end = start + options.limit;
return results.slice(start, end);
}
public async getCount(options: { filter?: string }): Promise<number> {
const results = await this.getAll(options);
return results.length;
}
}

80
ghost/in-memory-repository/src/InMemoryRepository.ts~
View File

@ -1,80 +0,0 @@
import nql from '@tryghost/nql';
type Entity<T> = {
id: T;
deleted: boolean;
}
type Order<T> = {
field: keyof T;
direction: 'asc' | 'desc';
}
type OrderOption<T extends Entity<any>> = Order<T>[];
export abstract class InMemoryRepository<IDType, T extends Entity<IDType>> {
private store: T[] = [];
private ids: Map<IDType, true> = new Map();
constructor() {}
protected abstract toPrimitive(entity: T): object;
public async save(entity: T): Promise<void> {
if (entity.deleted) {
this.store = this.store.filter(item => item.id !== entity.id);
this.ids.delete(entity.id);
return;
}
if (this.ids.has(entity.id)) {
this.store = this.store.map((item) => {
if (item.id === entity.id) {
return entity;
}
return item;
});
} else {
this.store.push(entity);
this.ids.set(entity.id, true);
}
}
public async getById(id: string): Promise<T | null> {
return this.store.find(item => item.id === id) || null;
}
public async getAll(options: { filter?: string; order?: OrderOption<T> } = {}): Promise<T[]> {
const filter = nql(options.filter);
const results = this.store.slice().filter(item => filter.queryJSON(this.toPrimitive(item)));
if (options.order) {
for (const order of options.order) {
results.sort((a, b) => {
if (order.direction === 'asc') {
return a[order.field] as any > (b[order.field] as any) ? 1 : -1;
} else {
return a[order.field] < b[order.field] ? 1 : -1;
}
});
}
}
return results;
}
public async getPage(options: { filter?: string; page: number; limit: number; order?: Order<T>[] } = {page: 1, limit: 15}): Promise<T[]> {
const results = await this.getAll(options);
const start = (options.page - 1) * options.limit;
const end = start + options.limit;
return results.slice(start, end);
}
public async getCount(options: { filter?: string }): Promise<number> {
const results = await this.getAll(options);
return results.length;
}
}

1
ghost/in-memory-repository/src/index.ts
View File

@ -1 +0,0 @@
export {InMemoryRepository} from './InMemoryRepository';

7
ghost/in-memory-repository/test/.eslintrc.js
View File

@ -1,7 +0,0 @@
module.exports = {
parser: '@typescript-eslint/parser',
plugins: ['ghost'],
extends: [
'plugin:ghost/test'
]
};

175
ghost/in-memory-repository/test/InMemoryRepository.test.ts
View File

@ -1,175 +0,0 @@
import assert from 'assert';
import {InMemoryRepository} from '../src/index';
type SimpleEntity = {
id: string;
deleted: boolean;
name: string;
age: number;
}
class SimpleInMemoryRepository extends InMemoryRepository<string, SimpleEntity> {
constructor() {
super();
}
protected toPrimitive(entity: SimpleEntity): object {
return {
name: entity.name,
age: entity.age
};
}
}
describe('InMemoryRepository', function () {
it('Can save, retrieve, update and delete entities', async function () {
const repository = new SimpleInMemoryRepository();
checkRetrieving: {
const entity = {
id: '1',
deleted: false,
name: 'John',
age: 30
};
await repository.save(entity);
const result = await repository.getById('1');
assert(result);
assert(result.name === 'John');
assert(result.age === 30);
assert(result.id === '1');
break checkRetrieving;
}
checkUpdating: {
const entity = {
id: '2',
deleted: false,
name: 'John',
age: 24
};
await repository.save(entity);
entity.name = 'Kym';
await repository.save(entity);
const result = await repository.getById('2');
assert(result);
assert(result.name === 'Kym');
assert(result.age === 24);
assert(result.id === '2');
break checkUpdating;
}
checkDeleting: {
const entity = {
id: '3',
deleted: false,
name: 'Egg',
age: 180
};
await repository.save(entity);
assert(await repository.getById('3'));
entity.deleted = true;
await repository.save(entity);
assert(!await repository.getById('3'));
break checkDeleting;
}
});
it('Can save and retrieve all entities', async function () {
const repository = new SimpleInMemoryRepository();
const entities = [{
id: '1',
deleted: false,
name: 'Kym',
age: 24
}, {
id: '2',
deleted: false,
name: 'John',
age: 30
}, {
id: '3',
deleted: false,
name: 'Kevin',
age: 5
}];
for (const entity of entities) {
await repository.save(entity);
}
const result = await repository.getAll({
order: [{
field: 'age',
direction: 'desc'
}]
});
assert(result);
assert(result.length === 3);
assert(result[0].age === 30);
assert(result[1].age === 24);
assert(result[2].age === 5);
});
it('Can save and retrieve a page of entities', async function () {
const repository = new SimpleInMemoryRepository();
const entities = [{
id: '1',
deleted: false,
name: 'John',
age: 30
}, {
id: '2',
deleted: false,
name: 'Kym',
age: 24
}, {
id: '3',
deleted: false,
name: 'Egg',
age: 180
}, {
id: '4',
deleted: false,
name: 'Kevin',
age: 36
}];
for (const entity of entities) {
await repository.save(entity);
}
const result = await repository.getPage({
filter: 'age:>25',
page: 1,
limit: 3,
order: [{
field: 'age',
direction: 'asc'
}]
});
const count = await repository.getCount({
filter: 'name:John'
});
assert(result);
assert(result.length === 3);
assert(count === 1);
});
});

113
ghost/in-memory-repository/tsconfig.json
View File

@ -1,113 +0,0 @@
{
"ts-node": {
"files": true
},
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
"incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": ["es2019"], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
"rootDir": "src", /* Specify the root folder within your source files. */
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
"resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
"declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "build", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
"noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"include": ["src/**/*"]
}