Added the ability to tell Sequelize what language to go by for singularing and pluralizing words.

Daniel Durante
Commit 6410c22e authored Jun 19, 2013 by Daniel Durante
Showing with 76 additions and 23 deletions
changelog.md
lib/associations/belongs-to.js
lib/associations/has-many.js
lib/associations/has-one.js
lib/dao-factory.js
lib/dialects/abstract/query.js
lib/sequelize.js
lib/utils.js
spec/language.spec.js
--- a/changelog.md
+++ b/changelog.md
@@ -29,7 +29,8 @@
 - [FEATURE] BigInts can now be used for autoincrement/serial columns. [#673](https://github.com/sequelize/sequelize/pull/673). thanks to sevastos
 - [REFACTORING] hasMany now uses a single SQL statement when creating and destroying associations, instead of removing each association seperately [690](https://github.com/sequelize/sequelize/pull/690). Inspired by [#104](https://github.com/sequelize/sequelize/issues/104). janmeier
 - [FEATURE] Use moment for better postgres timestamp strings. [#710](https://github.com/sequelize/sequelize/pull/710). Thanks to seth-admittedly
- [FEATURE] Keep milliseconds in timestamps for postgres. [#712](https://github.com/sequelize/sequelize/pull/712). THanks to seth-admittedly
+- [FEATURE] Keep milliseconds in timestamps for postgres. [#712](https://github.com/sequelize/sequelize/pull/712). Thanks to seth-admittedly
+- [FEATURE] You can now set lingo's language through Sequelize. [#713](https://github.com/sequelize/sequelize/pull/713). Thanks to durango
 # v1.6.0 #
 - [DEPENDENCIES] upgrade mysql to alpha7. You *MUST* use this version or newer for DATETIMEs to work

--- a/lib/associations/belongs-to.js
+++ b/lib/associations/belongs-to.js
@@ -11,7 +11,7 @@ module.exports = (function() {
    this.isSelfAssociation = (this.source.tableName == this.target.tableName)
    if (this.isSelfAssociation && !this.options.foreignKey && !!this.options.as) {
-      this.options.foreignKey = Utils._.underscoredIf(Utils.singularize(this.options.as) + "Id", this.source.options.underscored)
+      this.options.foreignKey = Utils._.underscoredIf(Utils.singularize(this.options.as, this.source.options.language) + "Id", this.source.options.underscored)
    }
    this.associationAccessor = this.isSelfAssociation
@@ -23,7 +23,7 @@ module.exports = (function() {
  BelongsTo.prototype.injectAttributes = function() {
    var newAttributes  = {}
-    this.identifier = this.options.foreignKey || Utils._.underscoredIf(Utils.singularize(this.target.tableName) + "Id", this.source.options.underscored)
+    this.identifier = this.options.foreignKey || Utils._.underscoredIf(Utils.singularize(this.target.tableName, this.target.options.language) + "Id", this.source.options.underscored)
    newAttributes[this.identifier] = { type: this.options.keyType || DataTypes.INTEGER }
    Helpers.addForeignKeyConstraints(newAttributes[this.identifier], this.target, this.source, this.options)
    Utils._.defaults(this.source.rawAttributes, newAttributes)
@@ -36,7 +36,7 @@ module.exports = (function() {
  BelongsTo.prototype.injectGetter = function(obj) {
    var self     = this
-      , accessor = Utils._.camelize('get_' + (this.options.as || Utils.singularize(this.target.tableName)))
+      , accessor = Utils._.camelize('get_' + (this.options.as || Utils.singularize(this.target.tableName, this.target.options.language)))
    obj[accessor] = function(params) {
      var id = this[self.identifier]
@@ -59,7 +59,7 @@ module.exports = (function() {
  BelongsTo.prototype.injectSetter = function(obj) {
    var self     = this
-      , accessor = Utils._.camelize('set_' + (this.options.as || Utils.singularize(this.target.tableName)))
+      , accessor = Utils._.camelize('set_' + (this.options.as || Utils.singularize(this.target.tableName, this.target.options.language)))
    obj[accessor] = function(associatedObject) {
      this[self.identifier] = associatedObject ? associatedObject.id : null

--- a/lib/associations/has-many.js
+++ b/lib/associations/has-many.js
@@ -21,14 +21,14 @@ module.exports = (function() {
    this.associationAccessor = this.combinedName = (this.options.joinTableName || combinedTableName)
    this.options.tableName = this.combinedName
-    var as = (this.options.as || Utils.pluralize(this.target.tableName))
+    var as = (this.options.as || Utils.pluralize(this.target.tableName, this.target.options.language))
    this.accessors = {
      get: Utils._.camelize('get_' + as),
      set: Utils._.camelize('set_' + as),
-      add: Utils._.camelize(Utils.singularize('add_' + as)),
+      add: Utils._.camelize(Utils.singularize('add_' + as, this.target.options.language)),
-      remove: Utils._.camelize(Utils.singularize('remove_' + as)),
+      remove: Utils._.camelize(Utils.singularize('remove_' + as, this.target.options.language)),
-      hasSingle: Utils._.camelize(Utils.singularize('has_' + as)),
+      hasSingle: Utils._.camelize(Utils.singularize('has_' + as, this.target.options.language)),
      hasAll: Utils._.camelize('has_' + as)
    }
  }
@@ -37,7 +37,7 @@ module.exports = (function() {
  // or in an extra table which connects two tables
  HasMany.prototype.injectAttributes = function() {
    var multiAssociation = this.target.associations.hasOwnProperty(this.associationAccessor)
-    this.identifier = this.options.foreignKey || Utils._.underscoredIf(Utils.singularize(this.source.tableName) + "Id", this.options.underscored)
+    this.identifier = this.options.foreignKey || Utils._.underscoredIf(Utils.singularize(this.source.tableName, this.source.options.language) + "Id", this.options.underscored)
    // is there already a single sided association between the source and the target?
    // or is the association on the model itself?

--- a/lib/associations/has-one.js
+++ b/lib/associations/has-one.js
@@ -11,7 +11,7 @@ module.exports = (function() {
    this.isSelfAssociation = (this.source.tableName == this.target.tableName)
    if (this.isSelfAssociation && !this.options.foreignKey && !!this.options.as) {
-      this.options.foreignKey = Utils._.underscoredIf(Utils.singularize(this.options.as) + "Id", this.options.underscored)
+      this.options.foreignKey = Utils._.underscoredIf(Utils.singularize(this.options.as, this.target.options.language) + "Id", this.options.underscored)
    }
    this.associationAccessor = this.isSelfAssociation
@@ -19,8 +19,8 @@ module.exports = (function() {
      : this.options.as || this.target.tableName
    this.accessors = {
-      get: Utils._.camelize('get_' + (this.options.as || Utils.singularize(this.target.tableName))),
+      get: Utils._.camelize('get_' + (this.options.as || Utils.singularize(this.target.tableName, this.target.options.language))),
-      set: Utils._.camelize('set_' + (this.options.as || Utils.singularize(this.target.tableName)))
+      set: Utils._.camelize('set_' + (this.options.as || Utils.singularize(this.target.tableName, this.target.options.language)))
    }
  }
@@ -28,7 +28,7 @@ module.exports = (function() {
  HasOne.prototype.injectAttributes = function() {
    var newAttributes = {}
-    this.identifier = this.options.foreignKey || Utils._.underscoredIf(Utils.singularize(this.source.tableName) + "Id", this.options.underscored)
+    this.identifier = this.options.foreignKey || Utils._.underscoredIf(Utils.singularize(this.source.tableName, this.source.options.language) + "Id", this.options.underscored)
    newAttributes[this.identifier] = { type: this.options.keyType || DataTypes.INTEGER }
    Helpers.addForeignKeyConstraints(newAttributes[this.identifier], this.source, this.target, this.options)
    Utils._.defaults(this.target.rawAttributes, newAttributes)

--- a/lib/dao-factory.js
+++ b/lib/dao-factory.js
@@ -18,7 +18,8 @@ module.exports = (function() {
      paranoid: false,
      whereCollection: null,
      schema: null,
-      schemaDelimiter: ''
+      schemaDelimiter: '',
+      language: 'en'
    }, options || {})
    // error check options
@@ -31,7 +32,7 @@ module.exports = (function() {
    this.name = name
    if (!this.options.tableName) {
-      this.tableName = this.options.freezeTableName ? name : Utils.pluralize(name)
+      this.tableName = this.options.freezeTableName ? name : Utils.pluralize(name, this.options.language)
    } else {
      this.tableName = this.options.tableName
    }

--- a/lib/dialects/abstract/query.js
+++ b/lib/dialects/abstract/query.js
@@ -302,11 +302,12 @@ module.exports = (function() {
  var buildAssociatedDaoInstances = function(tableName, associationData, dao) {
    var associatedDaoFactory = this.sequelize.daoFactoryManager.getDAO(tableName, { attribute: 'tableName' })
      , association          = null
+      , self                 = this
    if (!!associatedDaoFactory) {
      association = this.callee.getAssociation(associatedDaoFactory)
    } else {
-      associatedDaoFactory = this.sequelize.daoFactoryManager.getDAO(Utils.pluralize(tableName), { attribute: 'tableName' })
+      associatedDaoFactory = this.sequelize.daoFactoryManager.getDAO(Utils.pluralize(tableName, this.sequelize.language), { attribute: 'tableName' })
      if (!!associatedDaoFactory) {
        association = this.callee.getAssociation(associatedDaoFactory)
@@ -326,7 +327,7 @@ module.exports = (function() {
        , isEmpty     = !Utils.firstValueOfHash(daoInstance.identifiers)
      if (['BelongsTo', 'HasOne'].indexOf(association.associationType) > -1) {
-        accessor = Utils.singularize(accessor)
+        accessor = Utils.singularize(accessor, self.sequelize.language)
        dao[accessor] = isEmpty ? null : daoInstance
      } else {
        dao[accessor] = dao[accessor] || []

--- a/lib/sequelize.js
+++ b/lib/sequelize.js
@@ -79,7 +79,8 @@ module.exports = (function() {
      native: false,
      replication: false,
      pool: {},
-      quoteIdentifiers: true
+      quoteIdentifiers: true,
+      language: 'en'
    }, options || {})
    if (this.options.logging === true) {
@@ -172,7 +173,9 @@ module.exports = (function() {
        }
      })
    }
    options.omitNull = globalOptions.omitNull
+    options.language = globalOptions.language
    // if you call "define" multiple times for the same daoName, do not clutter the factory
    if(this.isDefined(daoName)) {

--- a/lib/utils.js
+++ b/lib/utils.js
@@ -72,12 +72,12 @@ var Utils = module.exports = {
    return (tableName1.toLowerCase() < tableName2.toLowerCase()) ? (tableName1 + tableName2) : (tableName2 + tableName1)
  },
-  singularize: function(s) {
+  singularize: function(s, language) {
-    return Utils.Lingo.en.isSingular(s) ? s : Utils.Lingo.en.singularize(s)
+    return Utils.Lingo[language || 'en'].isSingular(s) ? s : Utils.Lingo[language || 'en'].singularize(s)
  },
-  pluralize: function(s) {
+  pluralize: function(s, language) {
-    return Utils.Lingo.en.isPlural(s) ? s : Utils.Lingo.en.pluralize(s)
+    return Utils.Lingo[language || 'en'].isPlural(s) ? s : Utils.Lingo[language || 'en'].pluralize(s)
  },
  removeCommentsFromFunctionString: function(s) {

--- a/spec/language.spec.js
+++ b/spec/language.spec.js
+if(typeof require === 'function') {
+  const buster    = require("buster")
+      , Sequelize = require("../index")
+      , Helpers   = require('./buster-helpers')
+      , dialect   = Helpers.getTestDialect()
+}
+buster.spec.expose()
+buster.testRunner.timeout = 1000
+describe(Helpers.getTestDialectTeaser("Language Util"), function() {
+  describe("Plural", function(){
+    before(function(done) {
+      Helpers.initTests({
+        dialect: dialect,
+        onComplete: function(sequelize) {
+          this.sequelize = sequelize
+          this.sequelize.options.language = 'es'
+          done()
+        }.bind(this)
+      })
+    })
+    it("should rename tables to their plural form...", function(done){
+      var table = this.sequelize.define('arbol', {name: Sequelize.STRING})
+      var table2 = this.sequelize.define('androide', {name: Sequelize.STRING})
+      expect(table.tableName).toEqual('arboles')
+      expect(table2.tableName).toEqual('androides')
+      done()
+    })
+    it("should be able to pluralize/singularize associations...", function(done){
+      var table = this.sequelize.define('arbol', {name: Sequelize.STRING})
+      var table2 = this.sequelize.define('androide', {name: Sequelize.STRING})
+      var table3 = this.sequelize.define('hombre', {name: Sequelize.STRING})
+      table.hasOne(table2)
+      table2.belongsTo(table)
+      table3.hasMany(table2)
+      expect(table.associations.androides.identifier).toEqual('arbolId')
+      expect(table2.associations.arboles).toBeDefined()
+      expect(table3.associations.androideshombres).toBeDefined()
+      done()
+    })
+  })
+})