Add migration notice and optional jquery support

FagnerMartinsBrack · FagnerMartinsBrack · commit 3e816b8ab8a1 · 2015-04-10T09:43:11.000-03:00
Closes js-cookiegh-3.
diff --git a/.jshintrc b/.jshintrc
@@ -2,14 +2,14 @@
 	"curly": true,
 	"eqeqeq": true,
 	"expr": true,
-	// "maxlen": 130,
 	"newcap": true,
 	"noarg": true,
 	"nonbsp": true,
 	"trailing": true,
 	"undef": true,
 	"unused": true,
 	"globals": {
-		"Cookies": true
+		"Cookies": true,
+		"require": true
 	}
 }
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -6,7 +6,15 @@ module.exports = function (grunt) {
 	grunt.initConfig({
 		pkg: grunt.file.readJSON('package.json'),
 		qunit: {
-			all: 'test/index.html'
+			all: {
+				options: {
+					httpBase: 'http://127.0.0.1:9998'
+				},
+				src: ['test/index.html', 'test/amd.html']
+			}
+		},
+		nodeunit: {
+			all: 'test/node.js'
 		},
 		jshint: {
 			options: {
@@ -53,6 +61,12 @@ module.exports = function (grunt) {
 					base: ['.', 'test']
 				}
 			},
+			build: {
+				options: {
+					port: 9998,
+					base: ['.', 'test']
+				}
+			},
 			tests: {
 				options: {
 					port: 9998,
@@ -69,6 +83,7 @@ module.exports = function (grunt) {
 					urls: ['http://127.0.0.1:9999'],
 					testname: 'Sauce Test for js-cookie',
 					build: process.env.TRAVIS_JOB_ID,
+					pollInterval: 5000,
 					browsers: [
 						// iOS
 						{
@@ -164,7 +179,7 @@ module.exports = function (grunt) {
 	}
 
 	grunt.registerTask('saucelabs', ['connect:saucelabs', 'saucelabs-qunit']);
-	grunt.registerTask('test', ['jshint', 'qunit']);
+	grunt.registerTask('test', ['jshint', 'connect:build', 'qunit', 'nodeunit']);
 
 	grunt.registerTask('dev', ['test', 'uglify', 'compare_size']);
 	grunt.registerTask('ci', ['test', 'saucelabs']);
diff --git a/README.md b/README.md
@@ -1,3 +1,13 @@
+# Migrating from jquery-cookie
+
+JavaScript Cookie 1.x internal behavior is totally backward compatible with jquery-cookie.  
+To start migrating from jquery-cookie to JavaScript Cookie, just rename the API accordingly:
+
+`$.cookie('name', 'value')` === `Cookies.set('name', 'value')`  
+`$.cookie('name')` === `Cookies.get('name')`  
+`$.removeCookie('name')` === `Cookies.remove('name')`  
+`$.cookie()` === `Cookies.get()`
+
 # JavaScript Cookie [![Build Status](https://travis-ci.org/js-cookie/js-cookie.svg?branch=master)](https://travis-ci.org/js-cookie/js-cookie) [![Code Climate](https://codeclimate.com/github/js-cookie/js-cookie.svg)](https://codeclimate.com/github/js-cookie/js-cookie)
 
 A simple, lightweight JavaScript API for handling cookies
diff --git a/package.json b/package.json
@@ -17,21 +17,27 @@
   "license": "MIT",
   "devDependencies": {
     "grunt": "0.4.5",
+    "grunt-compare-size": "0.4.0",
+    "grunt-contrib-connect": "0.10.1",
     "grunt-contrib-jshint": "0.11.1",
-    "grunt-contrib-uglify": "0.8.0",
-    "grunt-contrib-qunit": "0.5.2",
+    "grunt-contrib-nodeunit": "0.4.1",
+    "grunt-contrib-qunit": "0.7.0",
+    "grunt-contrib-uglify": "0.9.1",
     "grunt-contrib-watch": "0.6.1",
-    "grunt-compare-size": "0.4.x",
     "grunt-saucelabs": "8.6.0",
-    "grunt-contrib-connect": "0.9.0",
-    "gzip-js": "0.3.2"
+    "gzip-js": "0.3.2",
+    "jquery": "2.1.3",
+    "qunitjs": "1.18.0",
+    "requirejs": "2.1.17"
   },
   "volo": {
     "url": "https://raw.github.com/carhartl/jquery-cookie/v{version}/src/jquery.cookie.js"
   },
   "jspm": {
     "main": "js.cookie",
-    "files": ["src/js.cookie.js"],
+    "files": [
+      "src/js.cookie.js"
+    ],
     "buildConfig": {
       "uglify": true
     }
diff --git a/src/js.cookie.js b/src/js.cookie.js
@@ -6,17 +6,21 @@
  * Released under the MIT license
  */
 (function (factory) {
+	var jQuery;
 	if (typeof define === 'function' && define.amd) {
 		// AMD (Register as an anonymous module)
-		define(factory);
+		define(['jquery'], factory);
 	} else if (typeof exports === 'object') {
 		// Node/CommonJS
-		module.exports = factory();
+		try {
+			jQuery = require('jquery');
+		} catch(e) {}
+		module.exports = factory(jQuery);
 	} else {
 		// Browser globals
-		window.Cookies = factory();
+		window.Cookies = factory(window.jQuery);
 	}
-}(function () {
+}(function ($) {
 
 	var pluses = /\+/g;
 
@@ -129,5 +133,10 @@
 		return !api(key);
 	};
 
+	if ( $ ) {
+		$.cookie = api;
+		$.removeCookie = api.remove;
+	}
+
 	return api;
 }));
diff --git a/test/amd-config.js b/test/amd-config.js
@@ -0,0 +1,12 @@
+/*jshint unused:false */
+
+var require = {
+	paths: {
+		'jquery': [
+			'../node_modules/jquery/dist/jquery'
+		],
+		'qunit': [
+			'../node_modules/qunitjs/qunit/qunit'
+		]
+	}
+};
diff --git a/test/amd.html b/test/amd.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<meta charset="utf-8">
+		<title>JavaScript Cookie Test Suite - AMD</title>
+		<link href="../node_modules/qunitjs/qunit/qunit.css" rel="stylesheet">
+		<script src="amd-config.js"></script>
+		<script src="../node_modules/requirejs/require.js"></script>
+		<script src="amd.js"></script>
+	</head>
+	<body>
+		<div id="qunit"></div>
+		<div id="qunit-fixture"></div>
+	</body>
+</html>
diff --git a/test/amd.js b/test/amd.js
@@ -0,0 +1,16 @@
+require(['qunit'], function (QUnit) {
+	QUnit.module('amd');
+
+	QUnit.start();
+	QUnit.test('with jquery dependency', function (assert) {
+		QUnit.expect(3);
+		var done = assert.async();
+		require(['jquery', '/src/js.cookie.js'], function ($, Cookies) {
+			assert.ok(!!$.cookie, 'Loaded $.cookie');
+			assert.ok(!!$.removeCookie, 'Loaded $.removeCookie');
+			assert.ok(!!Cookies.get, 'Loaded Cookies api');
+			done();
+		});
+	});
+
+});
diff --git a/test/index.html b/test/index.html
@@ -2,7 +2,7 @@
 <html>
 	<head>
 		<meta charset="utf-8">
-		<title>Javascript Cookie Test Suite</title>
+		<title>JavaScript Cookie Test Suite</title>
 		<link href="http://code.jquery.com/qunit/qunit-1.14.0.css" rel="stylesheet">
 		<script src="http://code.jquery.com/qunit/qunit-1.14.0.js"></script>
 		<script src="../src/js.cookie.js"></script>
diff --git a/test/node.js b/test/node.js
@@ -0,0 +1,13 @@
+/*jshint node:true */
+exports.node = {
+	should_load_js_cookie: function(test) {
+		test.expect(3);
+		var Cookies = require('../src/js.cookie');
+		
+		test.ok( !!Cookies.get, 'should expose get api' );
+		test.ok( !!Cookies.set, 'should expose set api' );
+		test.ok( !!Cookies.remove, 'should expose remove api' );
+		
+		test.done();
+	}
+};
