mirror of
https://github.com/pawelmalak/snippet-box.git
synced 2025-12-21 21:33:10 +01:00
Include tags with snippets. Filter by tags. Display tags on single snippet view.
This commit is contained in:
@@ -3,7 +3,7 @@ import { useHistory } from 'react-router-dom';
|
||||
import { SnippetsContext } from '../../store';
|
||||
import { Snippet } from '../../typescript/interfaces';
|
||||
import { dateParser } from '../../utils';
|
||||
import { Button, Card } from '../UI';
|
||||
import { Badge, Button, Card } from '../UI';
|
||||
import copy from 'clipboard-copy';
|
||||
import { SnippetPin } from './SnippetPin';
|
||||
|
||||
@@ -15,6 +15,7 @@ export const SnippetDetails = (props: Props): JSX.Element => {
|
||||
const {
|
||||
title,
|
||||
language,
|
||||
tags,
|
||||
createdAt,
|
||||
updatedAt,
|
||||
description,
|
||||
@@ -61,6 +62,16 @@ export const SnippetDetails = (props: Props): JSX.Element => {
|
||||
</div>
|
||||
<hr />
|
||||
|
||||
{/* TAGS */}
|
||||
<div>
|
||||
{tags.map(tag => (
|
||||
<span className='me-2'>
|
||||
<Badge text={tag} color='dark' />
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
<hr />
|
||||
|
||||
{/* ACTIONS */}
|
||||
<div className='d-grid g-2' style={{ rowGap: '10px' }}>
|
||||
<Button
|
||||
|
||||
@@ -5,7 +5,7 @@ import { Button, Card, EmptyState, Layout } from '../components/UI';
|
||||
import { Snippet } from '../typescript/interfaces';
|
||||
|
||||
export const Snippets = (): JSX.Element => {
|
||||
const { snippets, languageCount, getSnippets, countSnippets } =
|
||||
const { snippets, tagCount, getSnippets, countTags } =
|
||||
useContext(SnippetsContext);
|
||||
|
||||
const [filter, setFilter] = useState<string | null>(null);
|
||||
@@ -13,16 +13,16 @@ export const Snippets = (): JSX.Element => {
|
||||
|
||||
useEffect(() => {
|
||||
getSnippets();
|
||||
countSnippets();
|
||||
countTags();
|
||||
}, []);
|
||||
|
||||
useEffect(() => {
|
||||
setLocalSnippets([...snippets]);
|
||||
}, [snippets]);
|
||||
|
||||
const filterHandler = (language: string) => {
|
||||
setFilter(language);
|
||||
const filteredSnippets = snippets.filter(s => s.language === language);
|
||||
const filterHandler = (tag: string) => {
|
||||
setFilter(tag);
|
||||
const filteredSnippets = snippets.filter(s => s.tags.includes(tag));
|
||||
setLocalSnippets(filteredSnippets);
|
||||
};
|
||||
|
||||
@@ -44,21 +44,21 @@ export const Snippets = (): JSX.Element => {
|
||||
<span>Total</span>
|
||||
<span>{snippets.length}</span>
|
||||
</div>
|
||||
<h5 className='card-title'>Filter by language</h5>
|
||||
<h5 className='card-title'>Filter by tags</h5>
|
||||
<Fragment>
|
||||
{languageCount.map((el, idx) => {
|
||||
const isActiveFilter = filter === el.language;
|
||||
{tagCount.map((tag, idx) => {
|
||||
const isActiveFilter = filter === tag.name;
|
||||
|
||||
return (
|
||||
<div
|
||||
key={idx}
|
||||
className={`d-flex justify-content-between cursor-pointer ${
|
||||
isActiveFilter && 'text-dark fw-bold'
|
||||
}`}
|
||||
key={idx}
|
||||
onClick={() => filterHandler(el.language)}
|
||||
onClick={() => filterHandler(tag.name)}
|
||||
>
|
||||
<span>{el.language}</span>
|
||||
<span>{el.count}</span>
|
||||
<span>{tag.name}</span>
|
||||
<span>{tag.count}</span>
|
||||
</div>
|
||||
);
|
||||
})}
|
||||
|
||||
@@ -5,14 +5,14 @@ import {
|
||||
Context,
|
||||
Snippet,
|
||||
Response,
|
||||
LanguageCount,
|
||||
TagCount,
|
||||
NewSnippet
|
||||
} from '../typescript/interfaces';
|
||||
|
||||
export const SnippetsContext = createContext<Context>({
|
||||
snippets: [],
|
||||
currentSnippet: null,
|
||||
languageCount: [],
|
||||
tagCount: [],
|
||||
getSnippets: () => {},
|
||||
getSnippetById: (id: number) => {},
|
||||
setSnippet: (id: number) => {},
|
||||
@@ -20,7 +20,7 @@ export const SnippetsContext = createContext<Context>({
|
||||
updateSnippet: (snippet: NewSnippet, id: number, isLocal?: boolean) => {},
|
||||
deleteSnippet: (id: number) => {},
|
||||
toggleSnippetPin: (id: number) => {},
|
||||
countSnippets: () => {}
|
||||
countTags: () => {}
|
||||
});
|
||||
|
||||
interface Props {
|
||||
@@ -30,7 +30,7 @@ interface Props {
|
||||
export const SnippetsContextProvider = (props: Props): JSX.Element => {
|
||||
const [snippets, setSnippets] = useState<Snippet[]>([]);
|
||||
const [currentSnippet, setCurrentSnippet] = useState<Snippet | null>(null);
|
||||
const [languageCount, setLanguageCount] = useState<LanguageCount[]>([]);
|
||||
const [tagCount, setTagCount] = useState<TagCount[]>([]);
|
||||
|
||||
const history = useHistory();
|
||||
|
||||
@@ -132,17 +132,17 @@ export const SnippetsContextProvider = (props: Props): JSX.Element => {
|
||||
}
|
||||
};
|
||||
|
||||
const countSnippets = (): void => {
|
||||
const countTags = (): void => {
|
||||
axios
|
||||
.get<Response<LanguageCount[]>>('/api/snippets/statistics/count')
|
||||
.then(res => setLanguageCount(res.data.data))
|
||||
.get<Response<TagCount[]>>('/api/snippets/statistics/count')
|
||||
.then(res => setTagCount(res.data.data))
|
||||
.catch(err => redirectOnError());
|
||||
};
|
||||
|
||||
const context = {
|
||||
snippets,
|
||||
currentSnippet,
|
||||
languageCount,
|
||||
tagCount,
|
||||
getSnippets,
|
||||
getSnippetById,
|
||||
setSnippet,
|
||||
@@ -150,7 +150,7 @@ export const SnippetsContextProvider = (props: Props): JSX.Element => {
|
||||
updateSnippet,
|
||||
deleteSnippet,
|
||||
toggleSnippetPin,
|
||||
countSnippets
|
||||
countTags
|
||||
};
|
||||
|
||||
return (
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
import { LanguageCount, NewSnippet, Snippet } from '.';
|
||||
import { TagCount, NewSnippet, Snippet } from '.';
|
||||
|
||||
export interface Context {
|
||||
snippets: Snippet[];
|
||||
currentSnippet: Snippet | null;
|
||||
languageCount: LanguageCount[];
|
||||
tagCount: TagCount[];
|
||||
getSnippets: () => void;
|
||||
getSnippetById: (id: number) => void;
|
||||
setSnippet: (id: number) => void;
|
||||
@@ -11,5 +11,5 @@ export interface Context {
|
||||
updateSnippet: (snippet: NewSnippet, id: number, isLocal?: boolean) => void;
|
||||
deleteSnippet: (id: number) => void;
|
||||
toggleSnippetPin: (id: number) => void;
|
||||
countSnippets: () => void;
|
||||
countTags: () => void;
|
||||
}
|
||||
|
||||
@@ -7,7 +7,7 @@ export interface NewSnippet {
|
||||
code: string;
|
||||
docs?: string;
|
||||
isPinned: boolean;
|
||||
tags: string;
|
||||
tags: string[];
|
||||
}
|
||||
|
||||
export interface Snippet extends Model, NewSnippet {}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
export interface LanguageCount {
|
||||
export interface TagCount {
|
||||
count: number;
|
||||
language: string;
|
||||
name: string;
|
||||
}
|
||||
|
||||
@@ -2,8 +2,10 @@ import { Request, Response, NextFunction } from 'express';
|
||||
import { QueryTypes } from 'sequelize';
|
||||
import { sequelize } from '../db';
|
||||
import { asyncWrapper } from '../middleware';
|
||||
import { SnippetModel } from '../models';
|
||||
import { ErrorResponse, tagsParser } from '../utils';
|
||||
import { SnippetInstance, SnippetModel } from '../models';
|
||||
import { ErrorResponse, getTags, tagsParser, Logger } from '../utils';
|
||||
|
||||
const logger = new Logger('snippets-controller');
|
||||
|
||||
/**
|
||||
* @description Create new snippet
|
||||
@@ -37,7 +39,22 @@ export const createSnippet = asyncWrapper(
|
||||
*/
|
||||
export const getAllSnippets = asyncWrapper(
|
||||
async (req: Request, res: Response, next: NextFunction): Promise<void> => {
|
||||
const snippets = await SnippetModel.findAll();
|
||||
const snippets = await SnippetModel.findAll({
|
||||
raw: true
|
||||
});
|
||||
|
||||
await new Promise<void>(async resolve => {
|
||||
try {
|
||||
for await (let snippet of snippets) {
|
||||
const tags = await getTags(+snippet.id);
|
||||
snippet.tags = tags;
|
||||
}
|
||||
} catch (err) {
|
||||
logger.log('Error while fetching tags');
|
||||
} finally {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
|
||||
res.status(200).json({
|
||||
data: snippets
|
||||
@@ -46,14 +63,15 @@ export const getAllSnippets = asyncWrapper(
|
||||
);
|
||||
|
||||
/**
|
||||
* @description Get single sinppet by id
|
||||
* @description Get single snippet by id
|
||||
* @route /api/snippets/:id
|
||||
* @request GET
|
||||
*/
|
||||
export const getSnippet = asyncWrapper(
|
||||
async (req: Request, res: Response, next: NextFunction): Promise<void> => {
|
||||
const snippet = await SnippetModel.findOne({
|
||||
where: { id: req.params.id }
|
||||
where: { id: req.params.id },
|
||||
raw: true
|
||||
});
|
||||
|
||||
if (!snippet) {
|
||||
@@ -65,6 +83,9 @@ export const getSnippet = asyncWrapper(
|
||||
);
|
||||
}
|
||||
|
||||
const tags = await getTags(+req.params.id);
|
||||
snippet.tags = tags;
|
||||
|
||||
res.status(200).json({
|
||||
data: snippet
|
||||
});
|
||||
@@ -144,19 +165,20 @@ export const deleteSnippet = asyncWrapper(
|
||||
);
|
||||
|
||||
/**
|
||||
* @description Count snippets by language
|
||||
* @description Count tags
|
||||
* @route /api/snippets/statistics/count
|
||||
* @request GET
|
||||
*/
|
||||
export const countSnippets = asyncWrapper(
|
||||
export const countTags = asyncWrapper(
|
||||
async (req: Request, res: Response, next: NextFunction): Promise<void> => {
|
||||
const result = await sequelize.query(
|
||||
`SELECT
|
||||
COUNT(language) AS count,
|
||||
language
|
||||
FROM snippets
|
||||
GROUP BY language
|
||||
ORDER BY language ASC`,
|
||||
COUNT(tags.name) as count,
|
||||
tags.name
|
||||
FROM snippets_tags
|
||||
INNER JOIN tags ON snippets_tags.tag_id = tags.id
|
||||
GROUP BY tags.name
|
||||
ORDER BY name ASC`,
|
||||
{
|
||||
type: QueryTypes.SELECT
|
||||
}
|
||||
|
||||
@@ -76,7 +76,6 @@ export const up = async (queryInterface: QueryInterface): Promise<void> => {
|
||||
}
|
||||
} catch (err) {
|
||||
logger.log('Error while assigning tags to snippets');
|
||||
console.log(err);
|
||||
} finally {
|
||||
resolve();
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { Router } from 'express';
|
||||
import {
|
||||
countSnippets,
|
||||
countTags,
|
||||
createSnippet,
|
||||
deleteSnippet,
|
||||
getAllSnippets,
|
||||
@@ -22,4 +22,4 @@ snippetRouter
|
||||
.put(updateSnippet)
|
||||
.delete(deleteSnippet);
|
||||
|
||||
snippetRouter.route('/statistics/count').get(countSnippets);
|
||||
snippetRouter.route('/statistics/count').get(countTags);
|
||||
|
||||
@@ -8,6 +8,7 @@ export interface Snippet extends Model {
|
||||
code: string;
|
||||
docs: string;
|
||||
isPinned: number;
|
||||
tags?: string[];
|
||||
}
|
||||
|
||||
export interface SnippetCreationAttributes
|
||||
|
||||
18
src/utils/getTags.ts
Normal file
18
src/utils/getTags.ts
Normal file
@@ -0,0 +1,18 @@
|
||||
import { sequelize } from '../db';
|
||||
import { QueryTypes } from 'sequelize';
|
||||
|
||||
export const getTags = async (snippetId: number): Promise<string[]> => {
|
||||
const tags = await sequelize.query<{ name: string }>(
|
||||
`SELECT tags.name
|
||||
FROM tags
|
||||
INNER JOIN
|
||||
snippets_tags ON tags.id = snippets_tags.tag_id
|
||||
INNER JOIN
|
||||
snippets ON snippets.id = snippets_tags.snippet_id
|
||||
WHERE
|
||||
snippets_tags.snippet_id = ${snippetId};`,
|
||||
{ type: QueryTypes.SELECT }
|
||||
);
|
||||
|
||||
return tags.map(tag => tag.name);
|
||||
};
|
||||
@@ -1,3 +1,4 @@
|
||||
export * from './Logger';
|
||||
export * from './ErrorResponse';
|
||||
export * from './tagsParser';
|
||||
export * from './getTags';
|
||||
|
||||
Reference in New Issue
Block a user