Skip to content

Commit 7c807ce

Browse files
mokimoki
committed
fix(authors): Revert "feat(authors): scrape authors from github"
This reverts commit e5c9ddf.
1 parent 5ba12ea commit 7c807ce

File tree

10 files changed

+20
-122
lines changed

10 files changed

+20
-122
lines changed

‎src/constants.ts

-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,6 @@ export const REGEXP_INCLUDE_FILE_PATH = /(?<=[(]).+(?=[)])/g;
110110
// Include example: author: authorLogin
111111
// Regexp result: authorLogin
112112
export const REGEXP_AUTHOR = /(?<=author:\s).+(?=\r?\n)/g;
113-
export const REGEXP_CONTRIBUTORS = /(?<=contributors:\s).+(?=\r?\n)*?/g;
114113

115114
export const MIN_CHUNK_SIZE = Number(process.env.MIN_CHUNK_SIZE) || 1000;
116115
export const WORKERS_COUNT = Number(process.env.WORKERS_COUNT) || (os.cpus().length - 1);

‎src/models.ts

-2
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,6 @@ export interface Contributor {
171171
login: string;
172172
name: string;
173173
url: string;
174-
date?: string;
175-
hash?: string;
176174
}
177175

178176
export interface Contributors {

‎src/services/authors.ts

+7-45
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,24 @@
1-
import os from 'os';
2-
3-
import {logger, replaceDoubleToSingleQuotes} from '../utils';
4-
import {REGEXP_AUTHOR, REGEXP_CONTRIBUTORS} from '../constants';
1+
import {replaceDoubleToSingleQuotes} from '../utils';
2+
import {REGEXP_AUTHOR} from '../constants';
53
import {VCSConnector} from '../vcs-connector/connector-models';
6-
import {isEarlier, parseDataFromJSONString} from './utils';
7-
import {Contributor} from '../models';
8-
9-
10-
export function getContributorArrayFromMetadata(metadata: string[], filePath = '') {
11-
const contributors: Contributor[] = [];
12-
13-
for (const meta of metadata) {
14-
const matchContributors = meta.match(REGEXP_CONTRIBUTORS);
15-
try {
16-
if (matchContributors) {
17-
contributors.push(...parseDataFromJSONString(matchContributors[0]));
18-
}
19-
} catch (err) {
20-
logger.warn(filePath, JSON.stringify(err));
21-
}
22-
}
23-
24-
return contributors;
25-
}
264

27-
28-
async function updateAuthorMetadataString(
29-
fileMetadata = '',
30-
vcsConnector?: VCSConnector,
31-
newMetadatas: string[] = [],
32-
): Promise<string> {
5+
async function updateAuthorMetadataString(defaultMetadata = '', vcsConnector?: VCSConnector): Promise<string> {
336
if (!vcsConnector) {
34-
return fileMetadata;
7+
return defaultMetadata;
358
}
369

37-
const matchAuthor = fileMetadata.match(REGEXP_AUTHOR);
10+
const matchAuthor = defaultMetadata.match(REGEXP_AUTHOR);
3811

3912
if (matchAuthor && matchAuthor?.length > 0) {
4013
const authorLogin = matchAuthor[0];
4114
const user = await getAuthorDetails(vcsConnector, authorLogin);
4215

4316
if (user) {
44-
return fileMetadata.replace(authorLogin, user);
45-
}
46-
}
47-
48-
const contributors = getContributorArrayFromMetadata(newMetadatas);
49-
50-
if (contributors.length && !matchAuthor) {
51-
contributors.sort((a, b) => isEarlier(a.date, b.date) ? -1 : 1);
52-
const user = await getAuthorDetails(vcsConnector, contributors[0]);
53-
54-
if (user) {
55-
return `${fileMetadata}${os.EOL}author: ${user}`;
17+
return defaultMetadata.replace(authorLogin, user);
5618
}
5719
}
5820

59-
return fileMetadata;
21+
return defaultMetadata;
6022
}
6123

6224
async function getAuthorDetails(vcsConnector: VCSConnector, author: string | object): Promise<string | null> {

‎src/services/metadata.ts

+1-5
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,7 @@ async function getContentWithUpdatedDynamicMetadata(
9595
const [, fileMetadata, , fileMainContent] = matches;
9696
let updatedDefaultMetadata = '';
9797

98-
updatedDefaultMetadata = await updateAuthorMetadataString(
99-
fileMetadata,
100-
options.vcsConnector,
101-
newMetadatas,
102-
);
98+
updatedDefaultMetadata = await updateAuthorMetadataString(fileMetadata, options.vcsConnector);
10399

104100
return `${getUpdatedMetadataString(newMetadatas, updatedDefaultMetadata)}${fileMainContent}`;
105101
}

‎src/services/utils.ts

-17
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ import evalExp from '@doc-tools/transform/lib/liquid/evaluation';
22
import {Filter, TextItems} from '../models';
33
import liquid from '@doc-tools/transform/lib/liquid';
44
import {ArgvService} from './index';
5-
import {replaceSingleToDoubleQuotes} from '../utils';
65

76
export interface FilterFilesOptions {
87
resolveConditions?: boolean;
@@ -150,19 +149,3 @@ export function liquidField(input: string, vars: Record<string, unknown>, path:
150149
export function isObject(o: unknown): o is object {
151150
return typeof o === 'object' && o !== null;
152151
}
153-
154-
export function isEarlier(oldDate?: string, newDate?: string) {
155-
if (!newDate) {
156-
return false;
157-
}
158-
159-
if (!oldDate) {
160-
return true;
161-
}
162-
163-
return new Date(oldDate) > new Date(newDate);
164-
}
165-
166-
export function parseDataFromJSONString(dataString: string) {
167-
return JSON.parse(replaceSingleToDoubleQuotes(dataString));
168-
}

‎src/utils/markup.ts

-4
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,3 @@ export function joinSinglePageResults(singlePageResults: SinglePageResult[], roo
117117
export function replaceDoubleToSingleQuotes(str: string): string {
118118
return str.replace(/"/g, '\'');
119119
}
120-
121-
export function replaceSingleToDoubleQuotes(str: string): string {
122-
return str.replace(/'/g, '"');
123-
}

‎src/vcs-connector/connector-models.ts

-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ export interface GithubCommitDTO {
5151
author: {
5252
name: string;
5353
email: string;
54-
date: string;
5554
};
5655
};
5756
author: {

‎src/vcs-connector/github.ts

+5-25
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ import {
1717
} from '../constants';
1818
import {addSlashPrefix, execAsync, logger} from '../utils';
1919
import {validateConnectorFields} from './connector-validator';
20-
import {isEarlier} from '../services/utils';
2120

2221
const contributorsByPath: Map<string, FileContributors> = new Map();
2322
const contributorsData: Map<string, Contributor | null> = new Map();
@@ -147,7 +146,6 @@ async function getContributorDataByHashCommit(httpClientByToken: Octokit, hashCo
147146
login,
148147
name: commit.author.name,
149148
url,
150-
date: commit.author.date,
151149
};
152150
}
153151

@@ -190,36 +188,18 @@ function addContributorForPath(paths: string[], newContributor: Contributors, ha
190188
contributors: newContributor,
191189
hasIncludes,
192190
});
193-
194191
return;
195192
}
196193

197194
const oldContributors = contributorsByPath.get(normalizePath);
198-
const newContributorKey = Object.keys(newContributor)?.[0];
199195

200-
if (newContributorKey) {
201-
const contributors = {
196+
contributorsByPath.set(normalizePath, {
197+
contributors: {
202198
...oldContributors?.contributors,
203199
...newContributor,
204-
};
205-
206-
if (!oldContributors?.contributors?.[newContributorKey]) {
207-
contributorsByPath.set(normalizePath, {
208-
contributors,
209-
hasIncludes,
210-
});
211-
} else if (
212-
isEarlier(
213-
newContributor[newContributorKey]?.date,
214-
oldContributors?.contributors[newContributorKey]?.date,
215-
)
216-
) {
217-
contributorsByPath.set(normalizePath, {
218-
contributors,
219-
hasIncludes,
220-
});
221-
}
222-
}
200+
},
201+
hasIncludes,
202+
});
223203
});
224204
}
225205

‎tests/integrations/services/metadataContributors.test.ts

+4-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import os from 'os';
21
import {readFileSync} from 'fs';
32
import {normalize} from 'path';
43
import {metadataBorder} from '../../../src/constants';
@@ -86,8 +85,6 @@ describe('getContentWithUpdatedMetadata (Contributors)', () => {
8685
[contributorFirst.email]: contributorFirst,
8786
[contributorSecond.email]: contributorSecond,
8887
};
89-
const expectedAuthorString: string = replaceDoubleToSingleQuotes(
90-
JSON.stringify(contributorFirst));
9188
const expectedContributorsArray: Contributor[] = Object.values(expectedContributors);
9289
const expectedContributorsString: string =
9390
replaceDoubleToSingleQuotes(JSON.stringify(expectedContributorsArray));
@@ -102,7 +99,7 @@ describe('getContentWithUpdatedMetadata (Contributors)', () => {
10299

103100
const splitedFiledContent = fileContent.split(metadataBorder);
104101
splitedFiledContent[1] =
105-
`${splitedFiledContent[1]}${os.EOL}author: ${expectedAuthorString}${os.EOL}contributors: ${expectedContributorsString}${сarriage}`;
102+
`${splitedFiledContent[1]}contributors: ${expectedContributorsString}${сarriage}`;
106103
const expectedFileContent = splitedFiledContent.join(metadataBorder);
107104
expect(updatedFileContent).toEqual(expectedFileContent);
108105
});
@@ -119,8 +116,6 @@ describe('getContentWithUpdatedMetadata (Contributors)', () => {
119116
const expectedContributors: Contributors = {
120117
[contributorFirst.email]: contributorFirst,
121118
};
122-
const expectedAuthorString: string = replaceDoubleToSingleQuotes(
123-
JSON.stringify(contributorFirst));
124119
const expectedContributorsArray: Contributor[] = Object.values(expectedContributors);
125120
const expectedContributorsString: string =
126121
replaceDoubleToSingleQuotes(JSON.stringify(expectedContributorsArray));
@@ -135,7 +130,7 @@ describe('getContentWithUpdatedMetadata (Contributors)', () => {
135130

136131
const splitedFiledContent = fileContent.split(metadataBorder);
137132
splitedFiledContent[1] =
138-
`${splitedFiledContent[1]}${os.EOL}author: ${expectedAuthorString}${os.EOL}contributors: ${expectedContributorsString}${сarriage}`;
133+
`${splitedFiledContent[1]}contributors: ${expectedContributorsString}${сarriage}`;
139134
const expectedFileContent = splitedFiledContent.join(metadataBorder);
140135
expect(updatedFileContent).toEqual(expectedFileContent);
141136
});
@@ -200,8 +195,7 @@ describe('getContentWithUpdatedMetadata (Contributors)', () => {
200195
`and includes files and ${item.title}`, async () => {
201196
const expectedContributorsString: string = replaceDoubleToSingleQuotes(
202197
JSON.stringify(item.expectedContributorsArray));
203-
const expectedAuthorString: string = replaceDoubleToSingleQuotes(
204-
JSON.stringify(contributorFirst));
198+
205199
metaDataOptions.vcsConnector.getContributorsByPath = (path: string) => Promise.resolve({
206200
contributors: getFileContributors(path),
207201
hasIncludes: item.getHasIncludes(path),
@@ -213,7 +207,7 @@ describe('getContentWithUpdatedMetadata (Contributors)', () => {
213207

214208
const splitedFiledContent = fileContent.split(metadataBorder);
215209
splitedFiledContent[1] =
216-
`${splitedFiledContent[1]}${os.EOL}author: ${expectedAuthorString}${os.EOL}contributors: ${expectedContributorsString}${сarriage}`;
210+
`${splitedFiledContent[1]}contributors: ${expectedContributorsString}${сarriage}`;
217211
const expectedFileContent = splitedFiledContent.join(metadataBorder);
218212
expect(updatedFileContent).toEqual(expectedFileContent);
219213
});

‎tests/units/services/authors.test.ts

+3-12
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,7 @@ describe('updateAuthorMetadataString', () => {
9999
test('when "defaultMetadata" is empty', async () => {
100100
const expectedMetadata = '';
101101

102-
const authorDetails = await updateAuthorMetadataString(
103-
expectedMetadata,
104-
defaultVCSConnector,
105-
);
102+
const authorDetails = await updateAuthorMetadataString(expectedMetadata, defaultVCSConnector);
106103

107104
expect(authorDetails).toEqual(expectedMetadata);
108105
});
@@ -114,10 +111,7 @@ describe('updateAuthorMetadataString', () => {
114111

115112
defaultVCSConnector.getUserByLogin = () => Promise.resolve(null);
116113

117-
const updatedMetadata = await updateAuthorMetadataString(
118-
expectedMetadata,
119-
defaultVCSConnector,
120-
);
114+
const updatedMetadata = await updateAuthorMetadataString(expectedMetadata, defaultVCSConnector);
121115

122116
expect(updatedMetadata).toEqual(expectedMetadata);
123117
});
@@ -131,10 +125,7 @@ describe('updateAuthorMetadataString', () => {
131125
const authorDetails = units.replaceDoubleToSingleQuotes(JSON.stringify(author));
132126
defaultVCSConnector.getUserByLogin = () => Promise.resolve(author);
133127

134-
const updatedMetadata = await updateAuthorMetadataString(
135-
defaultMetadata,
136-
defaultVCSConnector,
137-
);
128+
const updatedMetadata = await updateAuthorMetadataString(defaultMetadata, defaultVCSConnector);
138129

139130
const matchAuthor = defaultMetadata.match(REGEXP_AUTHOR);
140131
const expectedMetadata = defaultMetadata.replace(matchAuthor[0], authorDetails);

0 commit comments

Comments
 (0)