Merge pull request #2452 from janmeier/fieldSameName

Support for attributes with the same field name as attribute name

lib/instance.js

@@ -565,7 +565,8 @@ module.exports = (function() {
         if (identifier) {
           for (attrName in identifier) {
             // Field name mapping
-            if (self.Model.rawAttributes[attrName].field) {
+            var rawAttribute = self.Model.rawAttributes[attrName];
+            if (rawAttribute.field && rawAttribute.field !== rawAttribute.fieldName) {
               identifier[self.Model.rawAttributes[attrName].field] = identifier[attrName];
               delete identifier[attrName];
             }
@@ -658,7 +659,7 @@ module.exports = (function() {
   Instance.prototype.reload = function(options) {
     var self = this
       , where = [
-        this.QueryInterface.quoteTable(this.Model.name) + '.' + this.QueryInterface.quoteIdentifier(this.Model.primaryKeyAttribute) + '=?',
+        this.QueryInterface.quoteTable(this.Model.name) + '.' + this.QueryInterface.quoteIdentifier(this.Model.primaryKeyField) + '=?',
         this.get(this.Model.primaryKeyAttribute, {raw: true})
       ];
 

lib/model.js

@@ -210,6 +210,8 @@ module.exports = (function() {
     // Primary key convenience variables
     this.primaryKeyAttributes = Object.keys(this.primaryKeys);
     this.primaryKeyAttribute = this.primaryKeyAttributes[0];
+    this.primaryKeyField = this.rawAttributes[this.primaryKeyAttribute].field || this.primaryKeyAttribute;
+
     this.primaryKeyCount = this.primaryKeyAttributes.length;
     this._hasPrimaryKeys = this.options.hasPrimaryKeys = this.hasPrimaryKeys = this.primaryKeyCount > 0;
 
@@ -716,7 +718,7 @@ module.exports = (function() {
       if (options.hooks) {
         return this.runHooks('beforeFindAfterExpandIncludeAll', options);
       }
-	}).then(function() {
+    }).then(function() {
       if (typeof options === 'object') {
         if (options.include) {
           hasJoin = true;
@@ -745,7 +747,7 @@ module.exports = (function() {
       if (options.hooks) {
         return this.runHooks('beforeFindAfterOptions', options);
       }
-	}).then(function() {
+    }).then(function() {
       return this.QueryInterface.select(this, this.getTableName(), options, Utils._.defaults({
         type: QueryTypes.SELECT,
         hasJoin: hasJoin,
@@ -1279,11 +1281,14 @@ module.exports = (function() {
           return Utils._.omit(dao.dataValues, self._virtualAttributes);
         });
 
+        var rawAttribute;
+
         // Map field names
         records.forEach(function(values) {
           for (var attr in values) {
             if (values.hasOwnProperty(attr)) {
-              if (self.rawAttributes[attr].field) {
+              rawAttribute = self.rawAttributes[attr];
+              if (rawAttribute.field && rawAttribute.field !== rawAttribute.fieldName) {
                 values[self.rawAttributes[attr].field] = values[attr];
                 delete values[attr];
               }
@@ -1599,7 +1604,8 @@ module.exports = (function() {
 
     if (options.where) {
       var attributes = options.where
-        , attribute;
+        , attribute
+        , rawAttribute;
 
       if (options.where instanceof Utils.and || options.where instanceof Utils.or) {
         attributes = undefined;
@@ -1612,7 +1618,8 @@ module.exports = (function() {
 
       if (attributes) {
         for (attribute in attributes) {
-          if (Model.rawAttributes[attribute] && Model.rawAttributes[attribute].field) {
+          rawAttribute = Model.rawAttributes[attribute];
+          if (rawAttribute && rawAttribute.field && rawAttribute.field !== rawAttribute.fieldName) {
             attributes[Model.rawAttributes[attribute].field] = attributes[attribute];
             delete attributes[attribute];
           }

lib/sequelize.js

@@ -879,7 +879,9 @@ module.exports = (function() {
    * A way of specifying attr = condition.
    *
    * The attr can either be an object taken from `Model.rawAttributes` (for example `Model.rawAttributes.id` or `Model.rawAttributes.name`). The
-   * attribute should be defined in your model definition. The attribute can also be an object from one of the sequelize utility functions (`sequelize.fn`, `sequelize.col` et.c).
+   * attribute should be defined in your model definition. The attribute can also be an object from one of the sequelize utility functions (`sequelize.fn`, `sequelize.col` etc.)
+   *
+   * For string attributes, use the regular `{ where: { attr: something }}` syntax. If you don't want your string to be escaped, use `sequelize.literal`.
    *
    * @see {Model#find}
    *

test/model/attributes.test.js

@@ -134,6 +134,46 @@ describe(Support.getTestDialectTeaser("Model"), function () {
         ]);
       });
 
+      describe('field and attribute name is the same', function () {
+        beforeEach(function () {
+          return this.Comment.bulkCreate([
+            { notes: 'Number one'},
+            { notes: 'Number two'},
+          ]);
+        });
+
+        it('bulkCreate should work', function () {
+          return this.Comment.findAll().then(function (comments) {
+           expect(comments[0].notes).to.equal('Number one');
+           expect(comments[1].notes).to.equal('Number two');
+          });
+        });
+
+        it('find with where should work', function () {
+          return this.Comment.findAll({ where: { notes: 'Number one' }}).then(function (comments) {
+            expect(comments).to.have.length(1);
+            expect(comments[0].notes).to.equal('Number one');
+          });
+        });
+
+        it('reload should work', function () {
+          return this.Comment.find(1).then(function (comment) {
+            return comment.reload();
+          });
+        });
+
+        it('save should work', function () {
+          return this.Comment.create({ notes: 'my note' }).then(function (comment) {
+            comment.notes = 'new note';
+            return comment.save();
+          }).then(function (comment) {
+            return comment.reload();
+          }).then(function (comment) {
+            expect(comment.notes).to.equal('new note');
+          });
+        });
+      });
+
       it('should create, fetch and update with alternative field names from a simple model', function () {
         var self = this;
 
@@ -544,4 +584,4 @@ describe(Support.getTestDialectTeaser("Model"), function () {
       });
     });
   });
-});
\ No newline at end of file
+});