Merge pull request balderdashy#81 from dqydj/master

particlebanana · particlebanana · commit cb9c87cee7ff · 2014-02-13T10:20:39.000-06:00
Adding 'url' option in adapter
diff --git a/README.md b/README.md
@@ -7,14 +7,42 @@ Adds MySQL support for Sails.
 # Sails.js Repo
 http://SailsJs.org
 
+## Installation
+
+Install from NPM.
+
+```bash
+$ npm install sails-mysql
+```
+
+## Sails Configuration
+
+Add the mysql config to the config/adapters.js file.  Basic options:
+
+```javascript
+module.exports.adapters = {
+  'default': 'mysql',
+
+  mysql: {
+    module   : 'sails-mysql',
+    host     : 'localhost',
+    port     : 3306,
+    user     : 'username',
+    password : 'password',
+    database : 'MySQL Database Name'
+    
+    // OR (exlicit sets take precedence)
+    module   : 'sails-mysql',
+    url      : 'mysql2://USER:PASSWORD@HOST:PORT/DATABASENAME'
+    }
+  }
+};
+```
 
 ## About Waterline
 Waterline is a new kind of storage and retrieval engine.  It provides a uniform API for accessing stuff from different kinds of databases, protocols, and 3rd party APIs.  That means you write the same code to get users, whether they live in mySQL, LDAP, MongoDB, or Facebook.
 Waterline also comes with built-in transaction support, as well as a configurable environment setting. 
 
-
-## Writing your own adapters
-It's easy to add your own adapters for integrating with proprietary systems or existing open APIs.  For most things, it's as easy as `require('some-module')` and mapping the appropriate methods to match waterline semantics.
-
+ 
 
 [![githalytics.com alpha](https://cruel-carlota.pagodabox.com/a22d3919de208c90c898986619efaa85 "githalytics.com")](http://githalytics.com/mikermcneil/sails-mysql)
diff --git a/lib/adapter.js b/lib/adapter.js
@@ -55,6 +55,11 @@ module.exports = (function() {
     },
 
     registerCollection: function(collection, cb) {
+
+      // If 'url' is set, extract config
+      collection.config = utils.parseUrl(collection.config);
+
+
       var def = _.clone(collection);
       var key = def.identity;
       var definition = def.definition || {};
diff --git a/lib/utils.js b/lib/utils.js
@@ -4,10 +4,36 @@
 
 // Dependencies
 var _ = require('underscore');
-
+url = require('url');
 // Module Exports
 
-var utils = module.exports = {};
+var utils = module.exports = {
+
+/**
+   * Parse URL string from config
+   *
+   * Parse URL string into connection config parameters
+   */
+  parseUrl: function (config) {
+    if(!_.isString(config.url)) return config;
+      
+      var obj = url.parse(config.url);
+
+      config.host = obj.hostname || config.host;
+      config.port = obj.port || config.port;
+
+      if(_.isString(obj.path)) {
+        config.database = obj.path.split("/")[1] || config.database;
+      }
+
+      if(_.isString(obj.auth)) {
+        config.user = obj.auth.split(":")[0] || config.user;
+        config.password = obj.auth.split(":")[1] || config.password;
+      }
+      return config;
+  }
+
+};
 
 /**
  * Prepare values
