cartodb/jasmine-ajax
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

WIP: refactoring #response

Browse Source
This commit is contained in:
Davis W. Frank, dwfrank & Hunter Gillane 2010-09-16 14:24:35 -07:00
parent b207cefb1d
commit e7ca84008c
8 changed files with 5479 additions and 169 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.rvmrc Normal file
View File

@ -0,0 +1 @@
rvm use default@jasmine-ajax

308
examples/prototype/spec/javascripts/helpers/mock-ajax.js vendored
View File

@ -1,170 +1,168 @@
function mockXhr(options) {
var mockXhr = {
readyState: 1,
responseText: "",
responseXML: "",
status: null,
statusText: null,
requestHeaders: {},
abort: function(){
console.log("called abort");
},
getAllResponseHeaders: function(){
console.log("called getAllResponseHeaders");
},
getResponseHeader: function(header) {
console.log("called getResponseHeader for " + header + ", was " + request);
},
open: function(){
console.log("Called open");
mockXhr.method = arguments[0];
mockXhr.url = arguments[1];
},
send: function(){
console.log("Called send");
},
setRequestHeader: function(header, value){
mockXhr.requestHeaders[header] = value;
console.log("set " + header + " to " + value);
},
response: function(response){
console.log("called response");
mockXhr.status = response.status,
mockXhr.responseText = response.responseText,
mockXhr.readyState = 4;
mockXhr.onreadystatechange();
}
};
return mockXhr;
}
// need
// 1. store list of requests
// 2. provide way to set response for each request
// 3. ability to call back into the right places
// global list of xhr requests made
xhrs = [];
function mostRecentXhr() {
if (xhrs.length == 0) {
return null;
}
return xhrs[xhrs.length - 1];
}
if (typeof jQuery != "undefined") {
console.log("jQuery");
beforeEach(function(){
spyOn(jQuery, 'ajax').andCallThrough();
xhrSpy = spyOn(jQuery.ajaxSettings, 'xhr');
xhrSpy.andCallFake(function(e){
var newXhr = mockXhr();
xhrs.push(newXhr);
return newXhr;
});
});
} else {
console.log("Prototype");
Ajax.Response.defaultContentType = "application/json";
beforeEach(function() {
// AjaxRequests.requests.clear();
spyOn(Ajax, "getTransport").andCallFake(function() {
//return new FakeAjaxTransport();
var newXhr = mockXhr();
xhrs.push(newXhr);
return newXhr;
});
});
}
// Ajax.Request.prototype.response = function(responseOptions) {
// this.transport.readyState = 4;
// if (typeof(responseOptions) == "string") {
// responseOptions = {responseText: responseOptions};
// }
//function mockXhr(options) {
// var mockXhr = {
// readyState: 1,
// responseText: "",
// responseXML: "",
// status: null,
// statusText: null,
//
// this.transport.responseHeaders = responseOptions.responseHeaders ||
// {"Content-type": responseOptions.contentType || Ajax.Response.defaultContentType};
// this.transport.status = typeof(responseOptions.status) == "undefined" ? 200 : responseOptions.status;
// this.transport.responseText = responseOptions.responseText;
// this.transport.onreadystatechange();
// requestHeaders: {},
//
// abort: function(){
// console.log("called abort");
// },
//
// getAllResponseHeaders: function(){
// console.log("called getAllResponseHeaders");
// },
//
// getResponseHeader: function(header) {
// console.log("called getResponseHeader for " + header + ", was " + request);
// },
//
// open: function(){
// console.log("Called open");
// mockXhr.method = arguments[0];
// mockXhr.url = arguments[1];
// },
//
// send: function(){
// console.log("Called send");
// },
//
// setRequestHeader: function(header, value){
// mockXhr.requestHeaders[header] = value;
// console.log("set " + header + " to " + value);
// },
//
// response: function(response){
// console.log("called response");
// mockXhr.status = response.status,
// mockXhr.responseText = response.responseText,
// mockXhr.readyState = 4;
// mockXhr.onreadystatechange();
// }
// };
//
// Ajax.Response.defaultContentType = "application/json";
// Ajax.Request.prototype.oldRequest = Ajax.Request.prototype.request;
// return mockXhr;
//}
//
// Ajax.Request.prototype.request = function(url) {
// this.oldRequest(url);
// AjaxRequests.requests.push(this);
// };
//
// Ajax.RealRequest = Class.create(Ajax.Request, {
// request: function(url) {
// this.transport = Try.these(
// function() {
// return new XMLHttpRequest()
// },
// function() {
// return new ActiveXObject('Msxml2.XMLHTTP')
// },
// function() {
// return new ActiveXObject('Microsoft.XMLHTTP')
// }
// ) || false;
// this.oldRequest(url);
// }
// });
//// need
//// 1. store list of requests
//// 2. provide way to set response for each request
//// 3. ability to call back into the right places
//
// AjaxRequests = {
// requests: [],
// clear: function() {
// this.requests.clear();
// },
// activeRequest: function() {
// if (this.requests.length > 0) {
// return this.requests[this.requests.length - 1];
// } else {
//// global list of xhr requests made
//xhrs = [];
//
//function mostRecentXhr() {
// if (xhrs.length == 0) {
// return null;
// }
// }
// };
// return xhrs[xhrs.length - 1];
//}
//
// FakeAjaxTransport = Class.create({
// initialize: function() {
// this.overrideMimeType = false;
// this.readyState = 0;
// this.setRequestHeader = jasmine.createSpy("setRequestHeader");
// this.open = jasmine.createSpy("open");
// this.send = jasmine.createSpy("send");
// this.abort = jasmine.createSpy("abort");
// },
// getResponseHeader: function(name) {
// return this.responseHeaders[name];
// }
//if (typeof jQuery != "undefined") {
// console.log("jQuery");
//
// beforeEach(function(){
// spyOn(jQuery, 'ajax').andCallThrough();
//
// xhrSpy = spyOn(jQuery.ajaxSettings, 'xhr');
//
// xhrSpy.andCallFake(function(e){
// var newXhr = mockXhr();
// xhrs.push(newXhr);
// return newXhr;
// });
//
// });
//} else {
// console.log("Prototype");
//
// Ajax.Response.defaultContentType = "application/json";
//
// beforeEach(function() {
// AjaxRequests.requests.clear();
// // AjaxRequests.requests.clear();
// spyOn(Ajax, "getTransport").andCallFake(function() {
// return new FakeAjaxTransport();
// //return new FakeAjaxTransport();
// var newXhr = mockXhr();
// xhrs.push(newXhr);
// return newXhr;
// });
// });
//}
Ajax.Request.prototype.response = function(responseOptions) {
this.transport.readyState = 4;
if (typeof(responseOptions) == "string") {
responseOptions = {responseText: responseOptions};
}
this.transport.responseHeaders = responseOptions.responseHeaders ||
{"Content-type": responseOptions.contentType || Ajax.Response.defaultContentType};
this.transport.status = typeof(responseOptions.status) == "undefined" ? 200 : responseOptions.status;
this.transport.responseText = responseOptions.responseText;
this.transport.onreadystatechange();
};
Ajax.Response.defaultContentType = "application/json";
Ajax.Request.prototype.oldRequest = Ajax.Request.prototype.request;
Ajax.Request.prototype.request = function(url) {
this.oldRequest(url);
AjaxRequests.requests.push(this);
};
Ajax.RealRequest = Class.create(Ajax.Request, {
request: function(url) {
this.transport = Try.these(
function() {
return new XMLHttpRequest()
},
function() {
return new ActiveXObject('Msxml2.XMLHTTP')
},
function() {
return new ActiveXObject('Microsoft.XMLHTTP')
}
) || false;
this.oldRequest(url);
}
});
AjaxRequests = {
requests: [],
clear: function() {
this.requests.clear();
},
activeRequest: function() {
if (this.requests.length > 0) {
return this.requests[this.requests.length - 1];
} else {
return null;
}
}
};
FakeAjaxTransport = Class.create({
initialize: function() {
this.overrideMimeType = false;
this.readyState = 0;
this.setRequestHeader = jasmine.createSpy("setRequestHeader");
this.open = jasmine.createSpy("open");
this.send = jasmine.createSpy("send");
this.abort = jasmine.createSpy("abort");
},
getResponseHeader: function(name) {
return this.responseHeaders[name];
}
});
beforeEach(function() {
AjaxRequests.requests.clear();
spyOn(Ajax, "getTransport").andCallFake(function() {
return new FakeAjaxTransport();
});
});

65
lib/mock-ajax.js
View File

@ -0,0 +1,65 @@
Ajax.Request.prototype.response = function(responseOptions) {
this.transport.readyState = 4;
if (typeof(responseOptions) == "string") {
responseOptions = {responseText: responseOptions};
}
this.transport.responseHeaders = responseOptions.responseHeaders ||
{"Content-type": responseOptions.contentType || Ajax.Response.defaultContentType};
this.transport.status = typeof(responseOptions.status) == "undefined" ? 200 : responseOptions.status;
this.transport.responseText = responseOptions.responseText;
this.transport.onreadystatechange();
};
Ajax.Response.defaultContentType = "application/json";
Ajax.Request.prototype.oldRequest = Ajax.Request.prototype.request;
Ajax.Request.prototype.request = function(url) {
this.oldRequest(url);
ajaxRequests.push(this);
};
Ajax.RealRequest = Class.create(Ajax.Request, {
request: function(url) {
this.transport = Try.these(
function() {
return new XMLHttpRequest()
},
function() {
return new ActiveXObject('Msxml2.XMLHTTP')
},
function() {
return new ActiveXObject('Microsoft.XMLHTTP')
}
) || false;
this.oldRequest(url);
}
});
var ajaxRequests = [];
FakeAjaxTransport = Class.create({
initialize: function() {
this.overrideMimeType = false;
this.readyState = 0;
this.setRequestHeader = jasmine.createSpy("setRequestHeader");
this.open = jasmine.createSpy("open");
this.send = jasmine.createSpy("send");
this.abort = jasmine.createSpy("abort");
},
getResponseHeader: function(name) {
return this.responseHeaders[name];
}
});
function mostRecentAjaxRequest() {
if (ajaxRequests.length > 0) {
return ajaxRequests[ajaxRequests.length - 1];
} else {
return null;
}
}
function clearAjaxRequests() {
ajaxRequests = [];
}

4874
lib/prototype.js vendored Normal file
View File

File diff suppressed because it is too large Load Diff

6
spec/javascripts/helpers/spec-helper.js Normal file
View File

@ -0,0 +1,6 @@
beforeEach(function() {
clearAjaxRequests();
spyOn(Ajax, "getTransport").andCallFake(function() {
return new FakeAjaxTransport();
});
});

359
spec/javascripts/mock-ajax-prototypejs-spec.js Normal file
View File

@ -0,0 +1,359 @@
describe("Jasmine Mock Ajax (for Prototype.js)", function() {
var request, anotherRequest, onSuccess, onFailure, onComplete;
var sharedContext = {};
beforeEach(function() {
onSuccess = jasmine.createSpy("onSuccess");
onFailure = jasmine.createSpy("onFailure");
onComplete = jasmine.createSpy("onComplete");
});
describe("when making a request", function () {
beforeEach(function() {
request = new Ajax.Request("example.com/someApi", {
onSuccess: onSuccess,
onFailure: onFailure,
onComplete: onComplete
});
});
it("should store URL and transport", function() {
expect(request.url).toEqual("example.com/someApi");
expect(request.transport).toBeTruthy();
});
it("should queue the request", function() {
expect(ajaxRequests.length).toEqual(1);
});
it("should allow access to the queued request", function() {
expect(ajaxRequests[0]).toEqual(request);
});
describe("and then another request", function () {
beforeEach(function() {
anotherRequest = new Ajax.Request("example.com/someApi", {
onSuccess: onSuccess,
onFailure: onFailure,
onComplete: onComplete
});
});
it("should queue the next request", function() {
expect(ajaxRequests.length).toEqual(2);
});
it("should allow access to the other queued request", function() {
expect(ajaxRequests[1]).toEqual(anotherRequest);
});
});
describe("mostRecentAjaxRequest", function () {
describe("when there is one request queued", function () {
it("should return the request", function() {
expect(mostRecentAjaxRequest()).toEqual(request);
});
});
describe("when there is more than one request", function () {
beforeEach(function() {
anotherRequest = new Ajax.Request("balthazarurl", {
onSuccess: onSuccess,
onFailure: onFailure,
onComplete: onComplete
});
});
it("should return the most recent request", function() {
expect(mostRecentAjaxRequest()).toEqual(anotherRequest);
});
});
describe("when there are no requests", function () {
beforeEach(function() {
clearAjaxRequests();
});
it("should return null", function() {
expect(mostRecentAjaxRequest()).toEqual(null);
});
});
});
describe("clearAjaxRequests()", function () {
beforeEach(function() {
clearAjaxRequests();
});
it("should remove all requests", function() {
expect(ajaxRequests.length).toEqual(0);
expect(mostRecentAjaxRequest()).toEqual(null);
});
});
});
describe("when simulating a response with request.response", function () {
beforeEach(function() {
request = new Ajax.Request("idontcare", {
method: 'get',
onSuccess: onSuccess,
onFailure: onFailure,
onComplete: onComplete
});
});
describe("and the response is Success", function () {
beforeEach(function() {
var response = {status: 200, contentType: "text/html", responseText: "OK!"};
request.response(response);
sharedContext.responseCallback = onSuccess;
sharedContext.status = response.status;
sharedContext.contentType = response.contentType;
sharedContext.responseText = response.responseText;
});
it("should call the success handler", function() {
expect(onSuccess).toHaveBeenCalled();
});
it("should not call the failure handler", function() {
expect(onFailure).not.toHaveBeenCalled();
});
it("should call the complete handler", function() {
expect(onComplete).toHaveBeenCalled();
});
sharedAjaxResponseBehavior(sharedContext);
});
describe("and the response is Failure", function () {
beforeEach(function() {
var response = {status: 500, contentType: "text/html", responseText: "(._){"};
request.response(response);
sharedContext.responseCallback = onFailure;
sharedContext.status = response.status;
sharedContext.contentType = response.contentType;
sharedContext.responseText = response.responseText;
});
it("should not call the success handler", function() {
expect(onSuccess).not.toHaveBeenCalled();
});
it("should call the failure handler", function() {
expect(onFailure).toHaveBeenCalled();
});
it("should call the complete handler", function() {
expect(onComplete).toHaveBeenCalled();
});
sharedAjaxResponseBehavior(sharedContext);
});
describe("and the response is Success, but with JSON", function () {
var response;
beforeEach(function() {
var responseObject = {status: 200, contentType: "application/json", responseText: "{'foo':'bar'}"};
request.response(responseObject);
sharedContext.responseCallback = onSuccess;
sharedContext.status = responseObject.status;
sharedContext.contentType = responseObject.contentType;
sharedContext.responseText = responseObject.responseText;
response = onSuccess.mostRecentCall.args[0];
console.error(response)
});
it("should call the success handler", function() {
expect(onSuccess).toHaveBeenCalled();
});
it("should not call the failure handler", function() {
expect(onFailure).not.toHaveBeenCalled();
});
it("should call the complete handler", function() {
expect(onComplete).toHaveBeenCalled();
});
it("should return a JavaScript object", function() {
window.response = response;
expect(response.responseJSON).toEqual({foo: "bar"});
});
sharedAjaxResponseBehavior(sharedContext);
});
});
});
// describe(".response", function() {
// it("should present responseJSON if contentType is application/json", function() {
// request = new Ajax.Request("http://example.com/someApi", {
// onSuccess: onSuccess,
// onFailure: onFailure,
// onComplete: onComplete
// });
//
// request.response({status: 201, contentType: "application/json", responseText: "{'foo':'bar'}"});
// expect(onSuccess).toHaveBeenCalled();
// var response = onSuccess.mostRecentCall.args[0];
// expect(response.getHeader('Content-type')).toEqual("application/json");
// expect(response.responseJSON).toEqual({foo: "bar"});
// });
//
// it("should default to status 200", function() {
// request.response({contentType: "text/html", responseText: "Yay!"});
// expect(onSuccess).toHaveBeenCalled();
// expect(onComplete).toHaveBeenCalled();
// var response = onSuccess.mostRecentCall.args[0];
// expect(response.status).toEqual(200);
// });
//
// it("should default to contentType application/json", function() {
// request.response({status: 200, responseText: "{'foo':'bar'}"});
// expect(onComplete).toHaveBeenCalled();
// var response = onComplete.mostRecentCall.args[0];
// expect(response.getHeader('Content-type')).toEqual("application/json");
// expect(response.responseJSON).toEqual({foo: "bar"});
// });
//
// it("should convert null response status to status 0", function() {
// request.response({status: null, responseText: ""});
// expect(onSuccess).toHaveBeenCalled();
// expect(onComplete).toHaveBeenCalled();
// var response = onSuccess.mostRecentCall.args[0];
// expect(response.status).toEqual(0);
// });
//
// it("should accept a string", function() {
// request.response("{'foo': 'bar'}");
// expect(onSuccess).toHaveBeenCalled();
// var response = onSuccess.mostRecentCall.args[0];
// expect(response.responseText).toEqual("{'foo': 'bar'}");
// });
// });
//});
function sharedAjaxResponseBehavior(context) {
describe("the response", function () {
var response;
beforeEach(function() {
response = context.responseCallback.mostRecentCall.args[0];
});
it("should have the expected status code", function() {
expect(response.status).toEqual(context.status);
});
it("should have the expected content type", function() {
expect(response.getHeader('Content-type')).toEqual(context.contentType);
});
it("should have the expected response text", function() {
expect(response.responseText).toEqual(context.responseText);
});
});
}
xdescribe("pockets.mock_ajax", function() {
var request, success, failure, complete;
beforeEach(function() {
success = jasmine.createSpy("success");
failure = jasmine.createSpy("failure");
complete = jasmine.createSpy("complete");
request = new Ajax.Request("balthazarurl", {onSuccess: success, onFailure: failure,
onComplete: complete});
});
it("should store URL and transport", function() {
expect(request.url).toEqual("balthazarurl");
expect(request.transport).toBeTruthy();
});
describe("AjaxRequests", function() {
it("should attach new AJAX requests to AjaxRequests.requests", function() {
expect(AjaxRequests.requests.length).toEqual(1);
expect(AjaxRequests.activeRequest()).toEqual(request);
var request2 = new Ajax.Request("balthazarurl2", {onSuccess: success, onFailure: failure,
onComplete: complete});
expect(AjaxRequests.requests.length).toEqual(2);
expect(AjaxRequests.activeRequest()).toEqual(request2);
});
it("should let you clear AJAX requests", function() {
clearAjaxRequests();
expect(AjaxRequests.requests.length).toEqual(0);
});
});
describe(".response", function() {
it("should pretend that the AJAX request returned a response with status, contentType, and responseText", function() {
request.response({status: 201, contentType: "text/html", responseText: "You have been redirected."});
expect(success).wasCalled();
expect(complete).wasCalled();
expect(failure).wasNotCalled();
var response = success.mostRecentCall.args[0];
expect(response.status).toEqual(201);
expect(response.getHeader('Content-type')).toEqual("text/html");
expect(response.responseText).toEqual("You have been redirected.");
expect(response.responseJSON).toEqual(null);
});
it("should call failure for error statuses", function() {
request.response({status: 500, contentType: "text/html", responseText: "Ar mateys."});
expect(success).wasNotCalled();
expect(complete).wasCalled();
expect(failure).wasCalled();
var response = failure.mostRecentCall.args[0];
expect(response.status).toEqual(500);
expect(response.getHeader('Content-type')).toEqual("text/html");
expect(response.responseText).toEqual("Ar mateys.");
});
it("should present responseJSON if contentType is application/json", function() {
request.response({status: 201, contentType: "application/json", responseText: "{'foo':'bar'}"});
expect(success).wasCalled();
var response = success.mostRecentCall.args[0];
expect(response.getHeader('Content-type')).toEqual("application/json");
expect(response.responseJSON).toEqual({foo: "bar"});
});
it("should default to status 200", function() {
request.response({contentType: "text/html", responseText: "Yay!"});
expect(success).wasCalled();
expect(complete).wasCalled();
var response = success.mostRecentCall.args[0];
expect(response.status).toEqual(200);
});
it("should default to contentType application/json", function() {
request.response({status: 200, responseText: "{'foo':'bar'}"});
expect(complete).wasCalled();
var response = complete.mostRecentCall.args[0];
expect(response.getHeader('Content-type')).toEqual("application/json");
expect(response.responseJSON).toEqual({foo: "bar"});
});
it("should convert null response status to status 0", function() {
request.response({status: null, responseText: ""});
expect(success).wasCalled();
expect(complete).wasCalled();
var response = success.mostRecentCall.args[0];
expect(response.status).toEqual(0);
});
it("should accept a string", function() {
request.response("{'foo': 'bar'}");
expect(success).wasCalled();
var response = success.mostRecentCall.args[0];
expect(response.responseText).toEqual("{'foo': 'bar'}");
});
});
});

21
spec/javascripts/support/jasmine.yml
View File

@ -1,3 +1,17 @@
src_dir: .
src_files:
- lib/prototype.js
- lib/**/*.js
spec_dir:
spec_files:
helpers:
stylesheets:
# src_files
#
# Return an array of filepaths relative to src_dir to include before jasmine specs.
@ -10,8 +24,6 @@
# - lib/source2.js
# - dist/**/*.js
#
src_files:
- public/javascripts/**/*.js
# stylesheets
#
@ -24,7 +36,6 @@ src_files:
# - css/style.css
# - stylesheets/*.css
#
stylesheets:
# helpers
#
@ -36,7 +47,6 @@ stylesheets:
# helpers:
# - helpers/**/*.js
#
helpers:
# spec_files
#
@ -48,7 +58,6 @@ helpers:
# spec_files:
# - **/*[sS]pec.js
#
spec_files:
# src_dir
#
@ -59,7 +68,6 @@ spec_files:
#
# src_dir: public
#
src_dir:
# spec_dir
#
@ -70,4 +78,3 @@ src_dir:
#
# spec_dir: spec/javascripts
#
spec_dir:

0
spec/mock-ajax-spec.js
View File