1646

pending completion

Build # 1646

Build Type

Pull #1311

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/Redocly/redoc/commit/<a class=hub.com/Redocly/redoc/commit/<a class="double-link" href="https://git"><a class=hub.com/Redocly/redoc/commit/<a class="double-link" href="https://git"><a class=hub.com/Redocly/redoc/commit/<a class="double-link" href="https://git"><a class=hub.com/Redocly/redoc/commit/<a class="double-link" href="https://git"><a class=hub.com/Redocly/redoc/commit/3bacd9172c7ed116461e0e9d82a1c94ed7efd213">3bacd9172">&lt;a href=&quot;https://github.com/Redocly/redoc/commit/</a><a class="double-link" href="https://github.com/Redocly/redoc/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Redocly/redoc/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Redocly/redoc/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Redocly/redoc/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Redocly/redoc/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/Redocly/redoc/commit/3bacd9172c7ed116461e0e9d82a1c94ed7efd213">3bacd9172</a><a href="https://github.com/Redocly/redoc/commit/3bacd9172c7ed116461e0e9d82a1c94ed7efd213">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/Redocly/redoc/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/Redocly/redoc/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/Redocly/redoc/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/Redocly/redoc/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/Redocly/redoc/commit/3bacd9172c7ed116461e0e9d82a1c94ed7efd213&quot;&gt;3bacd9172&lt;/a&gt;&lt;a href=&quot;https://github.com/Redocly/redoc/commit/3bacd9172c7ed116461e0e9d82a1c94ed7efd213&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/Redocly/redoc/commit/3bacd9172c7ed116461e0e9d82a1c94ed7efd213&amp;quot;&amp;gt;&amp;amp;quot;&amp;amp;gt;&amp;amp;amp;lt;a href=&amp;amp;amp;quot;https://github.com/Redocly/redoc/commit/&amp;amp;lt;/a&amp;amp;gt;&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;am... (continued)

Pull Request Pull Request #1311: feat: move description sections to the end with 'sectionsAtTheEnd' op…

Run Details

1540 of 2253 branches covered (68.35%)

Branch coverage included in aggregate %.

26 of 26 new or added lines in 4 files covered. (100.0%)

3143 of 3876 relevant lines covered (81.09%)

121.57 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.9

/src/utils/helpers.ts

import slugify from 'slugify';
import { format, parse } from 'url';

/**
 * Maps over array passing `isLast` bool to iterator as the second argument
 */
export function mapWithLast<T, P>(array: T[], iteratee: (item: T, isLast: boolean) => P) {
  const res: P[] = [];
  for (let i = 0; i < array.length - 1; i++) {
    res.push(iteratee(array[i], false));
  }
  if (array.length !== 0) {
    res.push(iteratee(array[array.length - 1], true));
  }
  return res;
}

/**
 * Creates an object with the same keys as object and values generated by running each
 * own enumerable string keyed property of object thru iteratee.
 * The iteratee is invoked with three arguments: (value, key, object).
 *
 * @param object the object to iterate over
 * @param iteratee the function invoked per iteration.
 */
export function mapValues<T, P>(
  object: Record<string, T>,
  iteratee: (val: T, key: string, obj: Record<string, T>) => P,
): Record<string, P> {
  const res: { [key: string]: P } = {};
  for (const key in object) {
    if (object.hasOwnProperty(key)) {
      res[key] = iteratee(object[key], key, object);
    }
  }
  return res;
}

/**
 * flattens collection using `prop` field as a children
 * @param collectionItems collection items
 * @param prop item property with child elements
 */
export function flattenByProp<T extends object, P extends keyof T>(
  collectionItems: T[],
  prop: P,
): T[] {
  const res: T[] = [];
  const iterate = (items: T[]) => {
    for (const item of items) {
      res.push(item);
      if (item[prop]) {
        iterate((item[prop] as any) as T[]);
      }
    }
  };
  iterate(collectionItems);
  return res;
}

export function stripTrailingSlash(path: string): string {
  if (path.endsWith('/')) {
    return path.substring(0, path.length - 1);
  }
  return path;
}

export function isNumeric(n: any): n is number {
  return !isNaN(parseFloat(n)) && isFinite(n);
}

export function appendToMdHeading(md: string, heading: string, content: string) {
  // if  heading is already in md and append to the end of it
  const testRegex = new RegExp(`(^|\\n)#\\s?${heading}\\s*\\n`, 'i');
  const replaceRegex = new RegExp(`((\\n|^)#\\s*${heading}\\s*(\\n|$)(?:.|\\n)*?)(\\n#|$)`, 'i');
  if (testRegex.test(md)) {
    return md.replace(replaceRegex, `$1\n\n${content}\n$4`);
  } else {
    // else append heading itself
    const br = md === '' || md.endsWith('\n\n') ? '' : md.endsWith('\n') ? '\n' : '\n\n';
    return `${md}${br}# ${heading}\n\n${content}`;
  }
}

export function extractContent(md: string, heading: string): string {
  // return the content of section with given heading
  const testRegex = new RegExp(`(^|\\n)#\\s?${heading}\\s*\\n`, 'i');
  const replaceRegex = new RegExp(`((\\n|^)#\\s*${heading}\\s*(\\n|$)(?:.|\\n)*?)(?=\\n#|$)`, 'i');
  if (testRegex.test(md)) {
    const extractedContent = replaceRegex.exec(md);
    return extractedContent != null ? extractedContent[0] : '';
  }

  return '';
}

// credits https://stackoverflow.com/a/46973278/1749888
export const mergeObjects = (target: any, ...sources: any[]): any => {
  if (!sources.length) {
    return target;
  }
  const source = sources.shift();
  if (source === undefined) {
    return target;
  }

  if (isMergebleObject(target) && isMergebleObject(source)) {
    Object.keys(source).forEach((key: string) => {
      if (isMergebleObject(source[key])) {
        if (!target[key]) {
          target[key] = {};
        }
        mergeObjects(target[key], source[key]);
      } else {
        target[key] = source[key];
      }
    });
  }

  return mergeObjects(target, ...sources);
};

const isObject = (item: any): boolean => {
  return item !== null && typeof item === 'object';
};

const isMergebleObject = (item): boolean => {
  return isObject(item) && !Array.isArray(item);
};

/**
 * slugify() returns empty string when failed to slugify.
 * so try to return minimum slugified-string with failed one which keeps original value
 * the regex codes are referenced with https://gist.github.com/mathewbyrne/1280286
 */
export function safeSlugify(value: string): string {
  return (
    slugify(value) ||
    value
      .toString()
      .toLowerCase()
      .replace(/\s+/g, '-') // Replace spaces with -
      .replace(/&/g, '-and-') // Replace & with 'and'
      .replace(/\--+/g, '-') // Replace multiple - with single -
      .replace(/^-+/, '') // Trim - from start of text
      .replace(/-+$/, '')
  ); // Trim - from end of text
}

export function isAbsoluteUrl(url: string) {
  return /(?:^[a-z][a-z0-9+.-]*:|\/\/)/i.test(url);
}

/**
 * simple resolve URL which doesn't break on strings with url fragments
 * e.g. resolveUrl('http://test.com:{port}', 'path') results in http://test.com:{port}/path
 */
export function resolveUrl(url: string, to: string) {
  let res;
  if (to.startsWith('//')) {
    const { protocol: specProtocol } = parse(url);
    res = `${specProtocol || 'https:'}${to}`;
  } else if (isAbsoluteUrl(to)) {
    res = to;
  } else if (!to.startsWith('/')) {
    res = stripTrailingSlash(url) + '/' + to;
  } else {
    const urlObj = parse(url);
    res = format({
      ...urlObj,
      pathname: to,
    });
  }
  return stripTrailingSlash(res);
}

export function getBasePath(serverUrl: string): string {
  try {
    return parseURL(serverUrl).pathname;
  } catch (e) {
    // when using with redoc-cli serverUrl can be empty resulting in crash
    return serverUrl;
  }
}

export function titleize(text: string) {
  return text.charAt(0).toUpperCase() + text.slice(1);
}

export function removeQueryString(serverUrl: string): string {
  try {
    const url = parseURL(serverUrl);
    url.search = '';
    return url.toString();
  } catch (e) {
    // when using with redoc-cli serverUrl can be empty resulting in crash
    return serverUrl;
  }
}

function parseURL(url: string) {
  if (typeof URL === 'undefined') {
    // node
    return new (require('url').URL)(url);
  } else {
    return new URL(url);
  }
}

export function unescapeHTMLChars(str: string): string {
  return str
    .replace(/&#(\d+);/g, (_m, code) => String.fromCharCode(parseInt(code, 10)))
    .replace(/&amp;/g, '&');
}

1	import slugify from 'slugify';	16✔
2	import { format, parse } from 'url';	16✔
3
4	/**
5	* Maps over array passing `isLast` bool to iterator as the second argument
6	*/
7	export function mapWithLast<T, P>(array: T[], iteratee: (item: T, isLast: boolean) => P) {	16✔
8	const res: P[] = [];	59✔
9	for (let i = 0; i < array.length - 1; i++) {	59✔
10	res.push(iteratee(array[i], false));	127✔
11	}
12	if (array.length !== 0) {	59✔
13	res.push(iteratee(array[array.length - 1], true));	58✔
14	}
15	return res;	59✔
16	}
17
18	/**
19	* Creates an object with the same keys as object and values generated by running each
20	* own enumerable string keyed property of object thru iteratee.
21	* The iteratee is invoked with three arguments: (value, key, object).
22	*
23	* @param object the object to iterate over
24	* @param iteratee the function invoked per iteration.
25	*/
26	export function mapValues<T, P>(	16✔
27	object: Record<string, T>,
28	iteratee: (val: T, key: string, obj: Record<string, T>) => P,
29	): Record<string, P> {
30	const res: { [key: string]: P } = {};	8✔
31	for (const key in object) {	8✔
32	if (object.hasOwnProperty(key)) {	8!
33	res[key] = iteratee(object[key], key, object);	8✔
34	}
35	}
36	return res;	8✔
37	}
38
39	/**
40	* flattens collection using `prop` field as a children
41	* @param collectionItems collection items
42	* @param prop item property with child elements
43	*/
44	export function flattenByProp<T extends object, P extends keyof T>(	16✔
45	collectionItems: T[],
46	prop: P,
47	): T[] {
48	const res: T[] = [];	2✔
49	const iterate = (items: T[]) => {	2✔
50	for (const item of items) {	136✔
51	res.push(item);	66✔
52	if (item[prop]) {	66!
53	iterate((item[prop] as any) as T[]);	66✔
54	}
55	}
56	};
57	iterate(collectionItems);	2✔
58	return res;	2✔
59	}
60
61	export function stripTrailingSlash(path: string): string {	16✔
62	if (path.endsWith('/')) {	108✔
63	return path.substring(0, path.length - 1);	7✔
64	}
65	return path;	101✔
66	}
67
68	export function isNumeric(n: any): n is number {	16✔
69	return !isNaN(parseFloat(n)) && isFinite(n);	97✔
70	}
71
72	export function appendToMdHeading(md: string, heading: string, content: string) {	16✔
73	// if heading is already in md and append to the end of it
74	const testRegex = new RegExp(`(^\|\\n)#\\s?${heading}\\s*\\n`, 'i');	3✔
75	const replaceRegex = new RegExp(`((\\n\|^)#\\s${heading}\\s(\\n\|$)(?:.\|\\n)*?)(\\n#\|$)`, 'i');	3✔
76	if (testRegex.test(md)) {	3✔
77	return md.replace(replaceRegex, `$1\n\n${content}\n$4`);	2✔
78	} else {
79	// else append heading itself
80	const br = md === '' \|\| md.endsWith('\n\n') ? '' : md.endsWith('\n') ? '\n' : '\n\n';	1!
81	return `${md}${br}# ${heading}\n\n${content}`;	1✔
82	}
83	}
84
85	export function extractContent(md: string, heading: string): string {	16✔
86	// return the content of section with given heading
87	const testRegex = new RegExp(`(^\|\\n)#\\s?${heading}\\s*\\n`, 'i');	8✔
88	const replaceRegex = new RegExp(`((\\n\|^)#\\s${heading}\\s(\\n\|$)(?:.\|\\n)*?)(?=\\n#\|$)`, 'i');	8✔
89	if (testRegex.test(md)) {	8!
90	const extractedContent = replaceRegex.exec(md);	8✔
91	return extractedContent != null ? extractedContent[0] : '';	8!
92	}
93
94	return '';	×
95	}
96
97	// credits https://stackoverflow.com/a/46973278/1749888
98	export const mergeObjects = (target: any, ...sources: any[]): any => {	5,139✔
99	if (!sources.length) {	2,034✔
100	return target;	999✔
101	}
102	const source = sources.shift();	1,035✔
103	if (source === undefined) {	1,035!
104	return target;	×
105	}
106
107	if (isMergebleObject(target) && isMergebleObject(source)) {	1,035!
108	Object.keys(source).forEach((key: string) => {	1,035✔
109	if (isMergebleObject(source[key])) {	4,044✔
110	if (!target[key]) {	963✔
111	target[key] = {};	962✔
112	}
113	mergeObjects(target[key], source[key]);	963✔
114	} else {
115	target[key] = source[key];	3,081✔
116	}
117	});
118	}
119
120	return mergeObjects(target, ...sources);	1,035✔
121	};
122
123	const isObject = (item: any): boolean => {	16✔
124	return item !== null && typeof item === 'object';	6,114✔
125	};
126
127	const isMergebleObject = (item): boolean => {	16✔
128	return isObject(item) && !Array.isArray(item);	6,114✔
129	};
130
131	/**
132	* slugify() returns empty string when failed to slugify.
133	* so try to return minimum slugified-string with failed one which keeps original value
134	* the regex codes are referenced with https://gist.github.com/mathewbyrne/1280286
135	*/
136	export function safeSlugify(value: string): string {	16✔
137	return (	37✔
138	slugify(value) \|\|	38✔
139	value
140	.toString()
141	.toLowerCase()
142	.replace(/\s+/g, '-') // Replace spaces with -
143	.replace(/&/g, '-and-') // Replace & with 'and'
144	.replace(/\--+/g, '-') // Replace multiple - with single -
145	.replace(/^-+/, '') // Trim - from start of text
146	.replace(/-+$/, '')
147	); // Trim - from end of text
148	}
149
150	export function isAbsoluteUrl(url: string) {	16✔
151	return /(?:^[a-z][a-z0-9+.-]*:\|\/\/)/i.test(url);	14✔
152	}
153
154	/**
155	* simple resolve URL which doesn't break on strings with url fragments
156	* e.g. resolveUrl('http://test.com:{port}', 'path') results in http://test.com:{port}/path
157	*/
158	export function resolveUrl(url: string, to: string) {	16✔
159	let res;
160	if (to.startsWith('//')) {	107✔
161	const { protocol: specProtocol } = parse(url);	93✔
162	res = `${specProtocol \|\| 'https:'}${to}`;	93✔
163	} else if (isAbsoluteUrl(to)) {	14✔
164	res = to;	5✔
165	} else if (!to.startsWith('/')) {	9✔
166	res = stripTrailingSlash(url) + '/' + to;	1✔
167	} else {
168	const urlObj = parse(url);	8✔
169	res = format({	8✔
170	...urlObj,
171	pathname: to,
172	});
173	}
174	return stripTrailingSlash(res);	107✔
175	}
176
177	export function getBasePath(serverUrl: string): string {	16✔
178	try {	×
179	return parseURL(serverUrl).pathname;	×
180	} catch (e) {
181	// when using with redoc-cli serverUrl can be empty resulting in crash
182	return serverUrl;	×
183	}
184	}
185
186	export function titleize(text: string) {	16✔
187	return text.charAt(0).toUpperCase() + text.slice(1);	3✔
188	}
189
190	export function removeQueryString(serverUrl: string): string {	16✔
191	try {	21✔
192	const url = parseURL(serverUrl);	21✔
193	url.search = '';	21✔
194	return url.toString();	21✔
195	} catch (e) {
196	// when using with redoc-cli serverUrl can be empty resulting in crash
197	return serverUrl;	×
198	}
199	}
200
201	function parseURL(url: string) {
202	if (typeof URL === 'undefined') {	21!
203	// node
204	return new (require('url').URL)(url);	×
205	} else {
206	return new URL(url);	21✔
207	}
208	}
209
210	export function unescapeHTMLChars(str: string): string {	16✔
211	return str	19✔
212	.replace(/&#(\d+);/g, (_m, code) => String.fromCharCode(parseInt(code, 10)))	×
213	.replace(/&/g, '&');
214	}

Redocly / redoc / 1646

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous