feat(slugification): add slugify with count (#21)

* feat(slugification): add slugifyWithCount

* chore(README): add slugifyWithCount documentation

Author: ComfortablyCoding

README.md

@@ -67,7 +67,8 @@ This will listen for any record created or updated in the article content type a
 | contentTypes | The Content Types to add auto slugification and search findOne by slug search utility to | Object | {} | No |
 | contentTypes[modelName] | The model name of the content type (it is the `singularName` in the [model schema](https://docs.strapi.io/developer-docs/latest/development/backend-customization/models.html#model-schema)) | String | N/A | Yes |
 | contentTypes[modelName]field | The name of the field to add the slug  | String | N/A | Yes |
-| contentTypes[modelName]references | The name of the field that is used to build the slug | String | N/A     | Yes |
+| contentTypes[modelName]references | The name of the field that is used to build the slug | String | N/A | Yes |
+| SlugifyWithCount | Duplicate strings will have their occurrence appended to the end of the slug | Boolean | false | No |
 | slugifyOptions | The options to pass the the slugify function. All options can be found in the [slugify docs](https://github.com/sindresorhus/slugify#api) | Object | {} | No |
 
 ## Usage

server/bootstrap.js

@@ -8,20 +8,15 @@ module.exports = ({ strapi }) => {
 	const settingsService = getPluginService(strapi, 'settingsService');
 	const settings = settingsService.get();
 
-	const { contentTypes, slugifyOptions } = settings;
-
 	// build settings structure
-	const models = settingsService.build(contentTypes);
+	const normalizedSettings = settingsService.build(settings);
 
 	// reset plugin settings
-	settingsService.set({
-		models,
-		slugifyOptions,
-	});
+	settingsService.set(normalizedSettings);
 
 	// set up lifecycles
 	const subscribe = {
-		models: _.map(models, (m) => m.uid),
+		models: _.map(normalizedSettings.models, (m) => m.uid),
 	};
 
 	SUPPORTED_LIFECYCLES.forEach((lifecycle) => {

server/config/index.js

@@ -7,6 +7,7 @@ module.exports = {
 		return {
 			contentTypes: {},
 			slugifyOptions: {},
+			slugifyWithCount: false,
 		};
 	},
 	async validator(config) {

server/config/schema.js

@@ -6,16 +6,16 @@ const _ = require('lodash');
 const pluginConfigSchema = yup.object().shape({
 	slugifyOptions: yup.object(),
 	contentTypes: yup.lazy((obj) => {
-		// eslint-disable-next-line no-unused-vars
 		let shape = {};
-		_.each(obj, (_, key) => {
+		_.each(obj, (_value, key) => {
 			shape[key] = yup.object().shape({
 				field: yup.string().required(),
 				references: yup.string().required(),
 			});
 		});
 		return yup.object().shape(shape);
 	}),
+	slugifyWithCount: yup.bool(),
 });
 
 module.exports = {

server/services/settings-service.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const _ = require('lodash');
+const { isValidModelField } = require('../utils/isValidModelField');
 const { pluginId } = require('../utils/pluginId');
 
 module.exports = ({ strapi }) => ({
@@ -10,34 +11,36 @@ module.exports = ({ strapi }) => ({
 	set(settings) {
 		return strapi.config.set(`plugin.${pluginId}`, settings);
 	},
-	build(contentTypes) {
-		let models = {};
-
-		_.filter(strapi.contentTypes, (value, uid) => {
-			const model = contentTypes[value.modelName];
+	build(settings) {
+		// build models
+		settings.models = {};
+		_.filter(strapi.contentTypes, (contentType, uid) => {
+			const model = settings.contentTypes[contentType.modelName];
 			if (!model) {
 				return;
 			}
 
 			// ensure provided fields are present on the model
-			const hasField = _.get(value, ['attributes', model.field], false);
-			const hasReference = _.get(value, ['attributes', model.references], false);
+			const hasField = isValidModelField(model, model.field);
+			const hasReference = isValidModelField(model, model.references);
 			if (!hasField || !hasReference) {
 				strapi.log.warn(
-					`[slugify] skipping ${value.info.singularName} registration, invalid field and/or reference provided.`
+					`[slugify] skipping ${contentType.info.singularName} registration, invalid field and/or reference provided.`
 				);
 				return;
 			}
 
 			const data = {
 				uid,
-				...contentTypes[value.modelName],
-				contentType: value,
+				...model,
+				contentType,
 			};
-			models[uid] = data;
-			models[value.modelName] = data;
+			settings.models[uid] = data;
+			settings.models[contentType.modelName] = data;
 		});
 
-		return models;
+		_.omit(settings, ['contentTypes']);
+
+		return settings;
 	},
 });

server/services/slug-service.js

@@ -2,16 +2,16 @@
 
 const _ = require('lodash');
 const { getPluginService } = require('../utils/getPluginService');
-const { stringToSlug } = require('../utils/stringToSlug');
+const { toSlug, toSlugWithCount } = require('../utils/slugification');
 
 module.exports = ({ strapi }) => ({
 	slugify(ctx) {
-		const { models, slugifyOptions } = getPluginService(strapi, 'settingsService').get();
-
+		const settings = getPluginService(strapi, 'settingsService').get();
 		const { params, model: entityModel } = ctx;
-		const model = models[entityModel.uid];
 		const { data } = params;
 
+		const model = settings.models[entityModel.uid];
+
 		if (!data) {
 			return;
 		}
@@ -24,7 +24,12 @@ module.exports = ({ strapi }) => ({
 			return;
 		}
 
-		data[field] = stringToSlug(referenceFieldValue, slugifyOptions);
+		if (settings.slugifyWithCount) {
+			data[field] = toSlugWithCount(referenceFieldValue, settings.slugifyOptions);
+			return;
+		}
+
+		data[field] = toSlug(referenceFieldValue, settings.slugifyOptions);
 	},
 
 	async findOne(uid, query) {

server/utils/isValidModelField.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const _ = require('lodash');
+
+const isValidModelField = (model, field) => _.get(model, ['attributes', field], false);
+
+module.exports = {
+	isValidModelField,
+};

server/utils/slugification.js

@@ -0,0 +1,12 @@
+'use strict';
+
+const slugify = require('@sindresorhus/slugify');
+const slugifyWithCount = slugify.counter();
+
+const toSlug = (string, options) => slugify(string, options);
+const toSlugWithCount = (string, options) => slugifyWithCount(string, options);
+
+module.exports = {
+	toSlug,
+	toSlugWithCount,
+};