Merge branch 'release/2.1.0'

jledentu · jledentu · commit 7aad4076142a · 2017-03-29T00:20:10.000+02:00
diff --git a/.babelrc b/.babelrc
@@ -1,3 +1,9 @@
 {
-  "presets": ["es2015"]
-}
+  "presets": [
+    ["env", {
+      "targets": {
+        "node": 4
+      }
+    }]
+  ]
+}
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,14 @@
+{
+    "extends": "eslint:recommended",
+    "env": {
+        "node": true,
+        "es6": true
+    },
+    "parserOptions": {
+        "ecmaVersion": 6,
+        "sourceType": "module"
+    },
+    "rules": {
+        "semi": 2
+    }
+}
diff --git a/.jscsrc b/.jscsrc
diff --git a/.jshintrc b/.jshintrc
diff --git a/.travis.yml b/.travis.yml
@@ -2,6 +2,8 @@ language: node_js
 node_js:
 - '4.2'
 - '5'
+- '6'
+- '7'
 env:
 - CXX=g++-4.8
 addons:
@@ -10,3 +12,13 @@ addons:
     - ubuntu-toolchain-r-test
     packages:
     - g++-4.8
+    - unicode-data
+deploy:
+  provider: npm
+  email: jledentu@gmail.com
+  api_key:
+    secure: HaUooYs1t9OSYUD7sRkFm3uR307r+Ze0qx59E3tlBCp3Cm86yt1k3dRR7FqexDt6Gspn5wR1m59JfYtJ3a3137CryTCDjEGmBfpFBWb7+e7wg/NiSNVbyH+R8vk3kxEhv7Llzv8dKk/ZOiMyEMGyynd6GmUtAanmh2N/I/bEpq+KfVySdxFKBN+6iL0ppjB0Kq7TkYZ3IrGTkHH2BsAXZPinMFapeG1WVUkM3yrNmRZiaBRb5Kvxn74dz2BfoRybY9Am9oIgOZCjqmhio/rdTLSQ03/Hgs4zEkUKHbbDkNi9amqF1LR9TmA7a3Z9cnPtMX7kTo0N8iOml0G5qBdmdMJrqaeHU3n4DHV6PjUq18qJaJngdbAmPnr5YaUzZzzp3ESK/NlWv76O50WkLN2t5SzaS39a4kRzJfPKbJRjfrmak/AGUpYxKilhnbeGKWIEWhyQjUlA2ekUqChCDpsn8SHBZnZTvYf4tioYhN1kVNYY9EroygUAGgw3HigIgGK982hY55TVdTQO+3pl2LPwarqbQMqNHdAVnbiODKtr7wukieyuRo/lBMFj+aANqZdbw9VDdve1iTChvhDEHZyBl7IUJTWOp6ajzrKFmYSpNyFw5rSi9ur3k3knqAr3NqQlNHp6iBR+JwlGQPs/cqtUpyz5ZDFb5Asm1DEzms/uTlU=
+  on:
+    branch: master
+    tags: true
+    repo: jledentu/sails-hook-slugs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,36 @@
+# Change Log
+
+## [2.1.0] - 2017-03-29
+### Added
+Add property `blacklist` in `sails.config.slugs` and model attributes to exclude names from slugs.
+### Changed
+- Replace node-uuid by uuid
+- Remove require-all and Lodash dependencies
+- Replace JSCS + JSHint linters by ESLint
+
+## [2.0.0] - 2017-03-19
+### Changed
+When a slug already exists, a dash is added between the slug and the UUID (thanks @thibaultboursier).
+
+## [1.0.0] - 2015-12-06
+### Added
+Add configuration in `sails.config.slugs`:
+- `lowercase` (`boolean`) to lowercase slugs (defaults to `true`)
+### Changed
+Slugs are lowercased and not capitalized anymore by default.
+
+## [0.2.6] - 2015-12-04
+### Fixed
+- Add `.npmignore`
+- Fix missing dependencies
+- Fix an issue with attribute property `from`
+
+## [0.2.0] - 2015-12-03
+### Added
+Resolve slug conflicts by adding a UUID after a new slug if already exists
+
+## [0.1.0] - 2015-11-30
+Initial version
+### Added
+- Slug generation
+- Base configuration
diff --git a/README.md b/README.md
@@ -1,9 +1,14 @@
 # sails-hook-slugs
 
-[![Build Status](https://travis-ci.org/jledentu/sails-hook-slugs.svg?branch=master)](https://travis-ci.org/jledentu/sails-hook-slugs)
+[![Build Status](https://travis-ci.org/jledentu/sails-hook-slugs.svg?branch=master)](https://travis-ci.org/jledentu/sails-hook-slugs) [![dependencies Status](https://david-dm.org/jledentu/sails-hook-slugs/status.svg)](https://david-dm.org/jledentu/sails-hook-slugs) [![npm](https://img.shields.io/npm/v/sails-hook-slugs.svg)](https://www.npmjs.com/package/sails-hook-slugs)
 
 This [Sails.js](https://github.com/balderdashy/sails) hook generates URL-friendly slugs in your models.
 
+```
+http://www.myblog.com/post/233987
+-> http://www.myblog.com/post/title-of-my-blog-post
+```
+
 ## Installation
 
 Add this hook to your Sails app:
@@ -32,7 +37,8 @@ module.exports = {
     },
     slug: {
       type: 'slug',
-      from: 'title'
+      from: 'title',
+      blacklist: ['search']
     }
   }
 };
@@ -41,6 +47,7 @@ module.exports = {
 Configure your slug attribute:
 
 * `from`: name of the attribute from which the slug will be defined (required)
+* `blacklist`: A list of reserved words to not use as this slug (optional)
 
 
 A `slug` attribute is automatically set when you create a record:
@@ -86,7 +93,8 @@ These parameters can be changed in `sails.config.slugs`:
 Parameter      | Type                | Details
 -------------- | ------------------- |:---------------------------------
 lowercase | `boolean` | Whether or not the generated slugs are lowercased. Defaults to `true`.
+blacklist | `Array<string>` | A list of reserved words to not use as slugs in your application. Defaults to `[]`.
 
 ## License
 
-MIT © 2015 Jérémie Ledentu
+MIT © 2017 Jérémie Ledentu
diff --git a/api/models/Post.js b/api/models/Post.js
@@ -25,7 +25,8 @@ module.exports = {
     },
     slugAuthor: {
       type: 'slug',
-      from: 'author'
+      from: 'author',
+      blacklist: ['profile']
     }
   }
 };
diff --git a/lib/index.js b/lib/index.js
@@ -1,59 +1,61 @@
-import requireAll from 'require-all';
 import slug from 'slug';
-import _ from 'lodash';
-import * as uuid from 'node-uuid';
+import uuid from 'uuid/v4';
 
 function SlugsHook(sails) {
 
-  function transformModels(models) {
-    return _.chain(models)
-      .mapValues((model, key) => {
-        return _.defaults(model, {
-          globalId: key,
-          identity: key.toLowerCase()
-        });
-      })
-      .mapKeys((model, key) => key.toLowerCase())
-      .value();
-  }
+  /**
+   * Indicate whether a given slug can be used as it is or not.
+   *
+   * @param {string}    slugName      Slug to check
+   * @param {string}    modelName     Name of the model
+   * @param {string}    attributeName Attribute on which the slug is defined
+   * @param {Array}     blacklist     List of names to not use
+   * @returns {Promise}
+   */
+  function slugCanBeUsed(slugName, modelName, attributeName, blacklist) {
+
+    return new Promise((resolve, reject) => {
+
+      if (sails.config.slugs.blacklist.indexOf(slugName) !== -1 ||
+          (Array.isArray(blacklist) && blacklist.indexOf(slugName) !== -1)) {
+        return resolve(false);
+      }
 
-  function loadModels() {
-    console.log('Loading Models...');
-    try {
-      let models = requireAll({
-        dirname: __dirname + '/models',
-        filter: /(.+)\.js$/
+      let criteria = {};
+      criteria[attributeName] = slugName;
+  
+      sails.models[modelName].count(criteria)
+      .then((found) => {
+        resolve(!found);
+      })
+      .catch((err) => {
+        reject(err);
       });
-
-      _.merge(sails.models || {}, transformModels(models));
-    }
-    catch (e) {
-      console.log('No Models found');
-    }
+    });
   }
 
   function patchModels() {
-    _.forOwn(sails.models, function(model, modelName) {
 
-      _.forOwn(model.attributes, function(attr, name) {
+    for (let modelName of Object.keys(sails.models)) {
+      let model = sails.models[modelName];
+
+      for (let name of Object.keys(model.attributes)) {
+        let attr = model.attributes[name];
         if (attr.type === 'slug' && attr.from) {
           attr.type = 'string';
 
-          model.beforeCreate = ((previousBeforeCreate, from) => function(values, cb) {
+          model.beforeCreate = ((previousBeforeCreate, from, blacklist) => function(values, cb) {
 
             let slugName = slug(values[from], {lower: sails.config.slugs.lowercase});
 
-            let criteria = {};
-            criteria[name] = slugName;
-
             // Check that slug is not already used
-            sails.models[modelName].count(criteria)
-            .then(function (found) {
-              if (found) {
-                values[name] = slugName + '-' + uuid.v4();
+            slugCanBeUsed(slugName, modelName, name, blacklist)
+            .then((ok) => {
+              if (ok) {
+                values[name] = slugName;
               }
               else {
-                values[name] = slugName;
+                values[name] = slugName + '-' + uuid();
               }
 
               if (typeof previousBeforeCreate === 'function') {
@@ -65,26 +67,25 @@ function SlugsHook(sails) {
             })
             .catch(cb);
 
-          })(model.beforeCreate, attr.from);
+          })(model.beforeCreate, attr.from, attr.blacklist);
 
           delete attr.from;
         }
-      });
-    });
+      }
+    }
   }
 
   return {
 
     defaults: {
       __configKey__: {
-        lowercase: true
+        lowercase: true,
+        blacklist: []
       }
     },
 
     initialize: function(next) {
 
-      //loadModels();
-
       sails.after(['hook:moduleloader:loaded'], function() {
 
         patchModels();
diff --git a/package.json b/package.json
@@ -1,13 +1,14 @@
 {
   "name": "sails-hook-slugs",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A hook for Sails to handle slugs in your models.",
   "main": "dist/lib/index.js",
   "scripts": {
     "babel": "babel lib --out-dir dist/lib",
     "pretest": "npm run babel",
     "test": "mocha test/bootstrap.test.js test/unit/*.test.js test/unit/**/*.test.js --compilers js:babel-core/register",
-    "prepublish": "npm run babel"
+    "prepublish": "npm run babel",
+    "lint": "eslint lib"
   },
   "keywords": [
     "sails",
@@ -22,16 +23,15 @@
   "devDependencies": {
     "babel-cli": "^6.2.0",
     "babel-core": "^6.2.1",
-    "babel-preset-es2015": "^6.1.18",
+    "babel-preset-env": "^1.2.2",
+    "eslint": "^3.18.0",
     "mocha": "^2.3.4",
     "sails": "^0.11.3",
     "sails-disk": "^0.10.8",
     "should": "^7.1.1"
   },
   "dependencies": {
-    "lodash": "^3.10.1",
-    "require-all": "^2.0.0",
     "slug": "^0.9.1",
-    "node-uuid": "^1.4.7"
+    "uuid": "^3.0.1"
   }
 }
diff --git a/test/.eslintrc b/test/.eslintrc
@@ -0,0 +1,5 @@
+{
+    "env": {
+        "mocha": true
+    }
+}
diff --git a/test/unit/models/Post.test.js b/test/unit/models/Post.test.js
@@ -47,16 +47,47 @@ describe('PostModel', function() {
 
         post.should.have.property('slug');
         post.slug.should.be.a.String();
-        post.slug.should.not.be.eql('this-is-a-new-post');
         post.slug.should.match(/^this-is-a-new-post-/);
 
         post.should.have.property('slugAuthor');
         post.slugAuthor.should.be.a.String();
-        post.slugAuthor.should.not.be.eql('jeremie-ledentu');
+        post.slugAuthor.should.match(/^jeremie-ledentu-/);
         done();
       })
       .catch(done);
     });
+
+    it('should not use a slug from global blacklist', (done) => {
+      sails.config.slugs.blacklist = ['new'];
+      Post.create({
+        title: 'New',
+        author: 'Jérémie Ledentu'
+      })
+      .then((post) => {
+        post.should.have.property('slug');
+        post.slug.should.be.a.String();
+        post.slug.should.match(/^new-/);
+
+        post.should.have.property('author');
+        post.author.should.be.a.String();
+        post.slugAuthor.should.match(/^jeremie-ledentu-/);
+
+        done();
+      });
+    });
+
+    it('should not use a slug from local blacklist', (done) => {
+      Post.create({
+        title: 'My new post',
+        author: 'Profile'
+      })
+      .then((post) => {
+        post.should.have.property('author');
+        post.slugAuthor.should.match(/^profile-/);
+
+        done();
+      });
+    });
   });
 
   describe('#findOneBySlug()', function() {
diff --git a/test/unit/slugsHook.test.js b/test/unit/slugsHook.test.js

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,8 @@ module.exports = {`
`25`	`25`	`},`
`26`	`26`	`slugAuthor: {`
`27`	`27`	`type: 'slug',`
`28`		`- from: 'author'`
	`28`	`+ from: 'author',`
	`29`	`+ blacklist: ['profile']`
`29`	`30`	`}`
`30`	`31`	`}`
`31`	`32`	`};`