Merge pull request sailshq#9 from treelinehq/expose-library

particlebanana · web-flow · commit 7dc16acd4e3e · 2017-02-20T12:09:20.000-06:00
Expose 'mysql' property on driver.  Also update lodash + normalize boilerplate files.
diff --git a/.editorconfig b/.editorconfig
@@ -1,12 +1,18 @@
-# http://editorconfig.org
+#   ╔═╗╔╦╗╦╔╦╗╔═╗╦═╗┌─┐┌─┐┌┐┌┌─┐┬┌─┐
+#   ║╣  ║║║ ║ ║ ║╠╦╝│  │ ││││├┤ ││ ┬
+#  o╚═╝═╩╝╩ ╩ ╚═╝╩╚═└─┘└─┘┘└┘└  ┴└─┘
+#
+# This file (`.editorconfig`) exists to help maintain consistent formatting
+# throughout this package, the Sails framework, and the Node-Machine project.
+#
+# To review what each of these options mean, see:
+# http://editorconfig.org/
 root = true
 
 [*]
 indent_style = space
 indent_size = 2
+end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
diff --git a/.eslintrc b/.eslintrc
@@ -1,10 +1,15 @@
 {
+  //   ╔═╗╔═╗╦  ╦╔╗╔╔╦╗┬─┐┌─┐
+  //   ║╣ ╚═╗║  ║║║║ ║ ├┬┘│
+  //  o╚═╝╚═╝╩═╝╩╝╚╝ ╩ ┴└─└─┘
+  // A set of basic conventions designed to complement the .jshintrc file.
+  // For the master copy of this file, see the `.eslintrc` template file in
+  // the `sails-generate` package (https://www.npmjs.com/package/sails-generate.)
   "env": {
     "node": true,
     "mocha": true
   },
   "rules": {
-    "array-bracket-spacing":        [2, "never"],
     "callback-return":              [2, ["callback", "cb", "next", "done", "proceed"]],
     "camelcase":                    [2, {"properties": "always"}],
     "comma-style":                  [2, "last"],
diff --git a/.gitignore b/.gitignore
@@ -1,33 +1,46 @@
+#   ┌─┐┬┌┬┐╦╔═╗╔╗╔╔═╗╦═╗╔═╗
+#   │ ┬│ │ ║║ ╦║║║║ ║╠╦╝║╣
+#  o└─┘┴ ┴ ╩╚═╝╝╚╝╚═╝╩╚═╚═╝
+#
+# This file (`.gitignore`) exists to signify to `git` that certain files
+# and/or directories should be ignored for the purposes of version control.
+#
+# This is primarily useful for excluding temporary files of all sorts; stuff
+# generated by IDEs, build scripts, automated tests, package managers, or even
+# end-users (e.g. file uploads). `.gitignore` files like this also do a nice job
+# at keeping sensitive credentials and personal data out of version control systems.
+#
+
 ############################
-# npm
+# sails / node.js / npm
 ############################
 node_modules
 npm-debug.log
-
+.node_history
 
 ############################
-# tmp, editor & OS files
+# editor & OS files
 ############################
-.tmp
 *.swo
 *.swp
 *.swn
 *.swm
+*.seed
+*.log
+*.out
+*.pid
+lib-cov
 .DS_STORE
 *#
+*\#
+.\#*
 *~
 .idea
+.netbeans
 nbproject
 
-
 ############################
-# Tests
+# misc
 ############################
-coverage
-
-
-############################
-# Other
-############################
-.node_history
-simple-test-script.js
+.tmp
+dump.rdb
diff --git a/.jshintrc b/.jshintrc
@@ -84,6 +84,14 @@
   //  read, albeit a bit less exciting)
   "laxcomma": false,
 
+  // Do NOT allow avant garde use of commas in conditional statements.
+  // (this prevents accidentally writing code like:
+  //  ```
+  //  if (!_.contains(['+ci', '-ci', '∆ci', '+ce', '-ce', '∆ce']), change.verb) {...}
+  //  ```
+  //  See the problem in that code?  Neither did we-- that's the problem!)
+  "nocomma": true,
+
   // Strictly enforce the consistent use of single quotes.
   // (this is a convention that was established primarily to make it easier
   //  to grep [or FIND+REPLACE in Sublime] particular string literals in
diff --git a/.npmignore b/.npmignore
@@ -1,20 +1,34 @@
-*#
+.git
+./.gitignore
+./.jshintrc
+./.editorconfig
+./.travis.yml
+./appveyor.yml
+./example
+./examples
+./test
+./tests
+./.github
+
 node_modules
-ssl
-.DS_STORE
+npm-debug.log
+.node_history
 *.swo
 *.swp
 *.swn
 *.swm
+*.seed
+*.log
+*.out
+*.pid
+lib-cov
+.DS_STORE
+*#
+*\#
+.\#*
 *~
 .idea
+.netbeans
 nbproject
-.git
-.gitignore
 .tmp
-.jshintrc
-.editorconfig
-CONTRIBUTING.md
-*.md
-**/*.md
-test
+dump.rdb
diff --git a/README.md b/README.md
@@ -3,9 +3,9 @@
   machinepack-mysql
 </h1>
 
-### [Docs](http://node-machine.org/machinepack-mysql) &nbsp; [Browse other machines](http://node-machine.org/machinepacks) &nbsp;  [FAQ](http://node-machine.org/implementing/FAQ)  &nbsp;  [Newsgroup](https://groups.google.com/forum/?hl=en#!forum/node-machine)
+Structured Node.js bindings for MySQL.
 
-Structured Node.js bindings for MySql.
+> See https://github.com/node-machine/driver-interface for more background information about this package.
 
 
 ## Installation &nbsp; [![NPM version](https://badge.fury.io/js/machinepack-mysql.svg)](http://badge.fury.io/js/machinepack-mysql) [![Build Status](https://travis-ci.org/treelinehq/machinepack-mysql.png?branch=master)](https://travis-ci.org/treelinehq/machinepack-mysql)
@@ -14,16 +14,35 @@ Structured Node.js bindings for MySql.
 $ npm install machinepack-mysql
 ```
 
+
 ## Usage
 
-For the latest usage documentation, version information, and test status of this module, see <a href="http://node-machine.org/machinepack-mysql" title="Structured Node.js bindings for MySql. (for node.js)">http://node-machine.org/machinepack-mysql</a>.  The generated manpages for each machine contain a complete reference of all expected inputs, possible exit states, and example return values.  If you need more help, or find a bug, jump into [Gitter](https://gitter.im/node-machine/general) or leave a message in the project [newsgroup](https://groups.google.com/forum/?hl=en#!forum/node-machine).
+For the latest usage documentation, version information, and test status of this module, see <a href="http://node-machine.org/machinepack-mysql" title="Structured Node.js bindings for MySql. (for node.js)">http://node-machine.org/machinepack-mysql</a>.  The generated manpages for each machine contain a complete reference of all expected inputs, possible exit states, and example return values.
+
+
+## Help
+
+For more examples, or if you get stuck or have questions, click [here](http://sailsjs.com/support).
+
+
+## Bugs &nbsp; [![NPM version](https://badge.fury.io/js/machinepack-mysql.svg)](http://npmjs.com/package/machinepack-mysql)
+
+To report a bug, [click here](http://sailsjs.com/bugs).
 
-## About  &nbsp; [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/node-machine/general?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-This is a [machinepack](http://node-machine.org/machinepacks), an NPM module which exposes a set of related Node.js [machines](http://node-machine.org/spec/machine) according to the [machinepack specification](http://node-machine.org/spec/machinepack).
-Documentation pages for the machines contained in this module (as well as all other NPM-hosted machines for Node.js) are automatically generated and kept up-to-date on the <a href="http://node-machine.org" title="Public machine registry for Node.js">public registry</a>.
-Learn more at <a href="http://node-machine.org/implementing/FAQ" title="Machine Project FAQ (for implementors)">http://node-machine.org/implementing/FAQ</a>.
+## Contributing &nbsp; [![Build Status](https://travis-ci.org/balderdashy/machinepack-mysql.svg?branch=master)](https://travis-ci.org/balderdashy/machinepack-mysql)
+
+Please observe the guidelines and conventions laid out in the [Sails project contribution guide](http://sailsjs.com/contribute) when opening issues or submitting pull requests.
+
+[![NPM](https://nodei.co/npm/machinepack-mysql.png?downloads=true)](http://npmjs.com/package/machinepack-mysql)
+
+## Acknowledgements
+
+Thanks to [felixge](https://github.com/felixge) and [dougwilson](https://github.com/dougwilson) for all of their great work on [mysql](http://npmjs.com/package/mysql).
 
 ## License
 
-MIT &copy; 2015 - 2016 Cody Stoltman, Mike McNeil, Scott Gress
+MIT &copy; 2015-2017 The Sails Company
+
+This package, like the [Sails framework](http://sailsjs.com), is free and open-source under the [MIT License](http://sailsjs.com/license).
+
diff --git a/appveyor.yml b/appveyor.yml
@@ -0,0 +1,44 @@
+# # # # # # # # # # # # # # # # # # # # # # # # # #
+#  ╔═╗╔═╗╔═╗╦  ╦╔═╗╦ ╦╔═╗╦═╗ ┬ ┬┌┬┐┬              #
+#  ╠═╣╠═╝╠═╝╚╗╔╝║╣ ╚╦╝║ ║╠╦╝ └┬┘││││              #
+#  ╩ ╩╩  ╩   ╚╝ ╚═╝ ╩ ╚═╝╩╚═o ┴ ┴ ┴┴─┘            #
+#                                                 #
+# This file configures Appveyor CI.               #
+# (i.e. how we run the tests on Windows)          #
+#                                                 #
+# https://www.appveyor.com/docs/lang/nodejs-iojs/ #
+# # # # # # # # # # # # # # # # # # # # # # # # # #
+
+
+# Test against these versions of Node.js.
+environment:
+  matrix:
+    - nodejs_version: "4"
+    - nodejs_version: "6"
+    - nodejs_version: "7"
+
+# Install scripts. (runs after repo cloning)
+install:
+  # Get the latest stable version of Node.js
+  # (Not sure what this is for, it's just in Appveyor's example.)
+  - ps: Install-Product node $env:nodejs_version
+  # Install declared dependencies
+  - npm install
+
+
+# Post-install test scripts.
+test_script:
+  # Output Node and NPM version info.
+  # (Presumably just in case Appveyor decides to try any funny business?
+  #  But seriously, always good to audit this kind of stuff for debugging.)
+  - node --version
+  - npm --version
+  # Run the actual tests.
+  - npm test
+
+
+# Don't actually build.
+# (Not sure what this is for, it's just in Appveyor's example.
+#  I'm not sure what we're not building... but I'm OK with not
+#  building it.  I guess.)
+build: off
diff --git a/helpers/validate-connection.js b/helpers/validate-connection.js
@@ -29,16 +29,16 @@ module.exports = require('machine').build({
   exits: {
 
     success: {
-      outputVariableName: 'isProbablyMySQLConnection',
+      outputFriendlyName: 'Is probably MySQL connection',
       outputDescription: 'If the provided appears to be a valid MySQL connection instance.',
-      example: true
+      outputExample: true
     },
 
   },
 
 
   fn: function validateConnection(inputs, exits) {
-    var _ = require('lodash');
+    var _ = require('@sailshq/lodash');
 
     // Validate some basic assertions about the provided connection.
     // (this doesn't guarantee it's still active or anything, but it does let
diff --git a/index.js b/index.js
@@ -3,3 +3,10 @@ module.exports = require('machine').pack({
   pkg: require('./package.json'),
   dir: __dirname
 });
+
+
+
+//... well except for this.
+// Also give the driver a `mysql` property, so that it provides access
+// to the `mysql` library for Node.js. (See http://npmjs.com/package/mysql)
+module.exports.mysql = require('mysql');
diff --git a/machines/create-manager.js b/machines/create-manager.js
@@ -1,7 +1,7 @@
 // Dependencies
 var util = require('util');
 var Url = require('url');
-var _ = require('lodash');
+var _ = require('@sailshq/lodash');
 var felix = require('mysql');
 
 module.exports = {
diff --git a/machines/parse-native-query-error.js b/machines/parse-native-query-error.js
@@ -1,5 +1,5 @@
 // Dependencies
-var _ = require('lodash');
+var _ = require('@sailshq/lodash');
 
 module.exports = {
 
diff --git a/machines/parse-native-query-result.js b/machines/parse-native-query-result.js
@@ -1,5 +1,5 @@
 // Dependencies
-var _ = require('lodash');
+var _ = require('@sailshq/lodash');
 
 module.exports = {
 
diff --git a/machines/send-native-query.js b/machines/send-native-query.js
@@ -1,6 +1,6 @@
 // Dependencies
 var util = require('util');
-var _ = require('lodash');
+var _ = require('@sailshq/lodash');
 var debug = require('debug')('query');
 
 module.exports = {
diff --git a/package.json b/package.json
@@ -1,12 +1,12 @@
 {
   "name": "machinepack-mysql",
-  "version": "2.0.0-4",
+  "version": "2.0.0-5",
   "description": "Structured Node.js bindings for MySQL.",
   "scripts": {
     "test": "node ./node_modules/mocha/bin/mocha --recursive",
     "fasttest": "node ./node_modules/mocha/bin/mocha --recursive",
     "pretest": "npm run lint",
-    "lint": "eslint machines test",
+    "lint": "node ./node_modules/eslint/bin/eslint *.js **/*.js",
     "docker": "docker-compose run adapter bash"
   },
   "keywords": [
@@ -17,11 +17,11 @@
     "machines",
     "machinepack"
   ],
-  "author": "The Treeline Company",
+  "author": "The Sails Company",
   "license": "MIT",
   "dependencies": {
     "debug": "2.2.0",
-    "lodash": "3.10.1",
+    "@sailshq/lodash": "^3.10.2",
     "machine": "^13.0.0-17",
     "mysql": "2.10.2",
     "waterline-sql-builder": "^1.0.0-2"
diff --git a/test/queryable/parse-native-query-error.js b/test/queryable/parse-native-query-error.js
@@ -1,5 +1,5 @@
 var assert = require('assert');
-var _ = require('lodash');
+var _ = require('@sailshq/lodash');
 var Pack = require('../../');
 
 describe('Queryable ::', function() {
diff --git a/test/queryable/parse-native-query-result.js b/test/queryable/parse-native-query-result.js
@@ -1,5 +1,5 @@
 var assert = require('assert');
-var _ = require('lodash');
+var _ = require('@sailshq/lodash');
 var Pack = require('../../');
 
 describe('Queryable ::', function() {
diff --git a/test/queryable/send-native-query.js b/test/queryable/send-native-query.js
@@ -1,5 +1,5 @@
 var assert = require('assert');
-var _ = require('lodash');
+var _ = require('@sailshq/lodash');
 var Pack = require('../../');
 
 describe('Queryable ::', function() {
