short-jsdoc/test/spec/literalObjectParserSpec.js

short and simple jsdoc Object Oriented syntax format and implementation

var JsDocMaker = typeof _ === 'undefined' ? require('../../src/jsdocmaker/main.js') : JsDocMaker; 
var _ = typeof _ === 'undefined' ? require('underscore') : _; 

describe("type parsers", function() 
{
	describe("Basic", function() 
	{
		it("parseType", function() 
		{
			var parsed = JsDocMaker.parseType('Map<String,Array<Apple>>'); 
			expect(parsed.name).toBe('Map'); 
			expect(parsed.params[0]).toBe('String'); 
			expect(parsed.params[1].name).toBe('Array'); 
			expect(parsed.params[1].params[0]).toBe('Apple'); 
		}); 

		it("parseType with strange chars", function() 
		{
			var parsed = JsDocMaker.parseType('Hello.Wo_rld<Foo.Bar_min>'); 
			expect(parsed.name).toBe('Hello.Wo_rld'); 
			expect(parsed.params[0]).toBe('Foo.Bar_min'); 
		}); 

		it("parseLiteralObjectType", function() 
		{
			var parsed = JsDocMaker.parseLiteralObjectType('{prop1:Map<String,Array<Apple>>,prop2:String}'); 
			expect(parsed.prop1.name).toBe('Map'); 
			expect(parsed.prop1.params[0]).toBe('String'); 
			expect(parsed.prop1.params[1].name).toBe('Array'); 
			expect(parsed.prop1.params[1].params[0]).toBe('Apple'); 
			expect(parsed.prop2).toBe('String'); //no type object, just the string
		}); 
	});

});