Merge pull request #105 from bem-sdk/fix/deprecation

Fix deprecation

Author: blond

lib/deprecate.js

@@ -0,0 +1,20 @@
+const util = require('util');
+
+const deprecate = require('depd')(require('../package.json').name);
+
+/**
+ * Logs deprecation messages.
+ *
+ * @param {object} obj
+ * @param {string} deprecateName
+ * @param {string} newName
+ */
+module.exports = (obj, deprecateName, newName) => {
+    const objStr = util.inspect(obj, { depth: 1 });
+    const message = [
+        `\`${deprecateName}\` is kept just for compatibility and can be dropped in the future.`,
+        `Use \`${newName}\` instead in \`${objStr}\` at`
+    ].join(' ');
+
+    deprecate(message);
+};

lib/entity-name.js

@@ -3,8 +3,8 @@
 const util = require('util');
 
 const stringifyEntity = require('@bem/naming').stringify;
-const deprecate = require('depd')(require('../package.json').name);
 
+const deprecate = require('./deprecate');
 const EntityTypeError = require('./entity-type-error');
 
 /**
@@ -29,6 +29,9 @@ class BemEntityName {
             throw new EntityTypeError(obj, 'the field `block` is undefined');
         }
 
+        obj.modName && deprecate(obj, 'modName', 'mod.name');
+        obj.modVal && deprecate(obj, 'modVal', 'mod.val');
+
         const data = this._data = { block: obj.block };
 
         obj.elem && (data.elem = obj.elem);
@@ -104,7 +107,7 @@ class BemEntityName {
      * @deprecated use {@link BemEntityName#mod.name}
      */
     get modName() {
-        deprecate(`modName is kept just for compatibility and can be dropped in the future. Use mod.name instead in ${this.inspect()} at`);
+        deprecate(this, 'modName', 'mod.name');
 
         return this.mod && this.mod.name;
     }
@@ -118,7 +121,7 @@ class BemEntityName {
      * @deprecated use {@link BemEntityName#mod.val}
      */
     get modVal() {
-        deprecate(`modVal is kept just for compatibility and can be dropped in the future. Use mod.val instead in ${this.inspect()} at`);
+        deprecate(this, 'modVal', 'mod.val');
 
         return this.mod && this.mod.val;
     }

test/deprecate.test.js

@@ -0,0 +1,32 @@
+const test = require('ava');
+const sinon = require('sinon');
+const proxyquire = require('proxyquire');
+
+const BemEntityName = require('../lib/entity-name');
+
+const deprecateSpy = sinon.spy();
+const deprecate = proxyquire('../lib/deprecate', {
+    'depd':() => deprecateSpy
+});
+
+test('should deprecate object', t => {
+    deprecate({ block: 'block' }, 'oldField', 'newField');
+
+    const message = [
+        "`oldField` is kept just for compatibility and can be dropped in the future.",
+        "Use `newField` instead in `{ block: 'block' }` at"
+    ].join(' ');
+
+    t.true(deprecateSpy.calledWith(message));
+});
+
+test('should deprecate BemEntityName instance', t => {
+    deprecate(new BemEntityName({ block: 'block' }), 'oldField', 'newField');
+
+    const message = [
+        "`oldField` is kept just for compatibility and can be dropped in the future.",
+        "Use `newField` instead in `BemEntityName { block: 'block' }` at"
+    ].join(' ');
+
+    t.true(deprecateSpy.calledWith(message));
+});

test/to-string.test.js

@@ -14,29 +14,29 @@ test('should use `naming.stringify()` for block', t => {
 
     entityName.toString();
 
-    t.truthy(spy.calledWith({ block: 'block' }));
+    t.true(spy.calledWith({ block: 'block' }));
 });
 
 test('should use `naming.stringify()` for elem', t => {
     const entityName = new BemEntityName({ block: 'block', elem: 'elem' });
 
     entityName.toString();
 
-    t.truthy(spy.calledWith({ block: 'block', elem: 'elem' }));
+    t.true(spy.calledWith({ block: 'block', elem: 'elem' }));
 });
 
 test('should use `naming.stringify()` for block modifier', t => {
     const entityName = new BemEntityName({ block: 'block', mod: { name: 'mod', val: 'val' } });
 
     entityName.toString();
 
-    t.truthy(spy.calledWith({ block: 'block', mod: { name: 'mod', val: 'val' } }));
+    t.true(spy.calledWith({ block: 'block', mod: { name: 'mod', val: 'val' } }));
 });
 
 test('should use naming.stringify() for element modifier', t => {
     const entityName = new BemEntityName({ block: 'block', elem: 'elem', mod: { name: 'mod', val: 'val' } });
 
     entityName.toString();
 
-    t.truthy(spy.calledWith({ block: 'block', elem: 'elem', mod: { name: 'mod', val: 'val' } }));
+    t.true(spy.calledWith({ block: 'block', elem: 'elem', mod: { name: 'mod', val: 'val' } }));
 });