/*
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.flex.compiler.internal.codegen.js.flexjs;
import org.apache.flex.compiler.clients.MXMLJSC;
import org.apache.flex.compiler.driver.IBackend;
import org.apache.flex.compiler.exceptions.ConfigurationException;
import org.apache.flex.compiler.internal.codegen.js.goog.TestGoogEmitter;
import org.apache.flex.compiler.internal.driver.js.flexjs.FlexJSBackend;
import org.apache.flex.compiler.internal.driver.js.goog.JSGoogConfiguration;
import org.apache.flex.compiler.internal.parsing.as.FlexJSASDocDelegate;
import org.apache.flex.compiler.internal.projects.FlexJSProject;
import org.apache.flex.compiler.tree.as.IFileNode;
import org.apache.flex.compiler.tree.as.IFunctionNode;
import org.junit.Test;
/**
* @author Erik de Bruin
*/
public class TestFlexJSEmitter extends TestGoogEmitter
{
@Override
public void setUp()
{
backend = createBackend();
project = new FlexJSProject(workspace, backend);
super.setUp();
}
@Override
@Test
public void testSimple()
{
String code = "package com.example.components {"
+ "import flash.events.EventDispatcher;"
+ "public class MyEventTarget extends EventDispatcher {"
+ "public function MyEventTarget() {if (foo() != 42) { bar(); } }"
+ "private var _privateVar:String = \"do \";"
+ "public var publicProperty:Number = 100;"
+ "public function myFunction(value: String): String{"
+ "return \"Don't \" + _privateVar + value; }}}";
IFileNode node = compileAS(code);
asBlockWalker.visitFile(node);
assertOutWithMetadata("/**\n" +
" * com.example.components.MyEventTarget\n" +
" *\n" +
" * @fileoverview\n" +
" *\n" +
" * @suppress {checkTypes|accessControls}\n" +
" */\n" +
"\n" +
"goog.provide('com.example.components.MyEventTarget');\n" +
"\n" +
"goog.require('flash.events.EventDispatcher');\n" +
"\n" +
"\n" +
"\n" +
"/**\n" +
" * @constructor\n" +
" * @extends {flash.events.EventDispatcher}\n" +
" */\n" +
"com.example.components.MyEventTarget = function() {\n" +
" com.example.components.MyEventTarget.base(this, 'constructor');\n" +
" if (foo() != 42) {\n" +
" bar();\n" +
" }\n" +
"};\n" +
"goog.inherits(com.example.components.MyEventTarget, flash.events.EventDispatcher);\n" +
"\n" +
"\n" +
"/**\n" +
" * @private\n" +
" * @type {string}\n" +
" */\n" +
"com.example.components.MyEventTarget.prototype._privateVar = \"do \";\n" +
"\n" +
"\n" +
"/**\n" +
" * @export\n" +
" * @type {number}\n" +
" */\n" +
"com.example.components.MyEventTarget.prototype.publicProperty = 100;\n" +
"\n" +
"\n" +
"/**\n" +
" * @export\n" +
" * @param {string} value\n" +
" * @return {string}\n" +
" */\n" +
"com.example.components.MyEventTarget.prototype.myFunction = function(value) {\n" +
" return \"Don't \" + this._privateVar + value;\n" +
"};\n" +
"\n" +
"\n" +
"/**\n" +
" * Metadata\n" +
" *\n" +
" * @type {Object.<string, Array.<Object>>}\n" +
" */\n" +
"com.example.components.MyEventTarget.prototype.FLEXJS_CLASS_INFO = { names: [{ name: 'MyEventTarget', qName: 'com.example.components.MyEventTarget', kind: 'class' }] };\n" +
"\n" +
"\n" +
"/**\n" +
" * Prevent renaming of class. Needed for reflection.\n" +
" */\n" +
"goog.exportSymbol('com.example.components.MyEventTarget', com.example.components.MyEventTarget);\n" +
"\n" +
"\n" +
"\n" +
"/**\n" +
" * Reflection\n" +
" *\n" +
" * @return {Object.<string, Function>}\n" +
" */\n" +
"com.example.components.MyEventTarget.prototype.FLEXJS_REFLECTION_INFO = function () {\n" +
" return {\n" +
" variables: function () {\n" +
" return {\n" +
" 'publicProperty': { type: 'Number'}\n" +
" };\n" +
" },\n" +
" accessors: function () {return {};},\n" +
" methods: function () {\n" +
" return {\n" +
" 'MyEventTarget': { type: '', declaredBy: 'com.example.components.MyEventTarget'},\n" +
" 'myFunction': { type: 'String', declaredBy: 'com.example.components.MyEventTarget', parameters: function () { return [ { index: 1, type: 'String', optional: false } ]; }}\n" +
" };\n" +
" }\n" +
" };\n" +
"};\n");
}
@Override
@Test
public void testSimpleInterface()
{
String code = "package com.example.components {"
+ "public interface TestInterface { } }";
IFileNode node = compileAS(code);
asBlockWalker.visitFile(node);
assertOutWithMetadata("/**\n" +
" * com.example.components.TestInterface\n" +
" *\n" +
" * @fileoverview\n" +
" *\n" +
" * @suppress {checkTypes|accessControls}\n" +
" */\n" +
"\n" +
"goog.provide('com.example.components.TestInterface');\n" +
"\n" +
"\n" +
"\n" +
"/**\n" +
" * @interface\n" +
" */\ncom.example.components.TestInterface = function() {\n" +
"};\n" +
"\n" +
"\n" +
"/**\n" +
" * Metadata\n" +
" *\n" +
" * @type {Object.<string, Array.<Object>>}\n" +
" */\n" +
"com.example.components.TestInterface.prototype.FLEXJS_CLASS_INFO = { names: [{ name: 'TestInterface', qName: 'com.example.components.TestInterface', kind: 'interface' }] };\n" +
"\n" +
"\n" +
"/**\n" +
" * Prevent renaming of class. Needed for reflection.\n" +
" */\n" +
"goog.exportSymbol('com.example.components.TestInterface', com.example.components.TestInterface);\n" +
"\n" +
"\n" +
"\n" +
"/**\n" +
" * Reflection\n" +
" *\n" +
" * @return {Object.<string, Function>}\n" +
" */\n" +
"com.example.components.TestInterface.prototype.FLEXJS_REFLECTION_INFO = function () {\n" +
" return {\n" +
" accessors: function () {return {};},\n" +
" methods: function () {return {};}\n" +
" };\n" +
"};\n");
}
@Override
@Test
public void testSimpleClass()
{
String code = "package com.example.components {"
+ "public class TestClass { } }";
IFileNode node = compileAS(code);
asBlockWalker.visitFile(node);
assertOutWithMetadata("/**\n" +
" * com.example.components.TestClass\n" +
" *\n" +
" * @fileoverview\n" +
" *\n" +
" * @suppress {checkTypes|accessControls}\n" +
" */\n" +
"\n" +
"goog.provide('com.example.components.TestClass');\n" +
"\n" +
"\n" +
"\n" +
"/**\n" +
" * @constructor\n" +
" */\n" +
"com.example.components.TestClass = function() {\n" +
"};\n" +
"\n" +
"\n" +
"/**\n" +
" * Metadata\n" +
" *\n" +
" * @type {Object.<string, Array.<Object>>}\n" +
" */\n" +
"com.example.components.TestClass.prototype.FLEXJS_CLASS_INFO = { names: [{ name: 'TestClass', qName: 'com.example.components.TestClass', kind: 'class' }] };\n" +
"\n" +
"\n" +
"/**\n" +
" * Prevent renaming of class. Needed for reflection.\n" +
" */\n" +
"goog.exportSymbol('com.example.components.TestClass', com.example.components.TestClass);\n" +
"\n" +
"\n" +
"\n" +
"/**\n" +
" * Reflection\n" +
" *\n" +
" * @return {Object.<string, Function>}\n" +
" */\n" +
"com.example.components.TestClass.prototype.FLEXJS_REFLECTION_INFO = function () {\n" +
" return {\n" +
" variables: function () {return {};},\n" +
" accessors: function () {return {};},\n" +
" methods: function () {return {};}\n" +
" };\n" +
"};\n");
}
@Test
public void testInjectHTML()
{
String code = "package com.example.components {\n"
+ "public class TestClass {"
+ "/**\n"
+ " * <inject_html>\n"
+ " * This will be injected.\n"
+ " * </inject_html>\n"
+ " */\n"
+ "public function TestClass() { } } }";
IFileNode node = compileAS(code);
asBlockWalker.visitFile(node);
assertOutWithMetadata("/**\n" +
" * com.example.components.TestClass\n" +
" *\n" +
" * @fileoverview\n" +
" *\n" +
" * @suppress {checkTypes|accessControls}\n" +
" */\n" +
"\n" +
"goog.provide('com.example.components.TestClass');\n" +
"\n" +
"\n" +
"\n" +
"/**\n" +
" * <inject_html>\n" +
" * This will be injected.\n" +
" * </inject_html>\n" +
" * @constructor\n" +
" */\n" +
"com.example.components.TestClass = function() {\n" +
"};\n" +
"\n" +
"\n" +
"/**\n" +
" * Metadata\n" +
" *\n" +
" * @type {Object.<string, Array.<Object>>}\n" +
" */\n" +
"com.example.components.TestClass.prototype.FLEXJS_CLASS_INFO = { names: [{ name: 'TestClass', qName: 'com.example.components.TestClass', kind: 'class' }] };\n" +
"\n" +
"\n" +
"/**\n" +
" * Prevent renaming of class. Needed for reflection.\n" +
" */\n" +
"goog.exportSymbol('com.example.components.TestClass', com.example.components.TestClass);\n" +
"\n" +
"\n" +
"\n" +
"/**\n" +
" * Reflection\n" +
" *\n" +
" * @return {Object.<string, Function>}\n" +
" */\n" +
"com.example.components.TestClass.prototype.FLEXJS_REFLECTION_INFO = function () {\n" +
" return {\n" +
" variables: function () {return {};},\n" +
" accessors: function () {return {};},\n" +
" methods: function () {\n" +
" return {\n" +
" 'TestClass': { type: '', declaredBy: 'com.example.components.TestClass'}\n" +
" };\n" +
" }\n" +
" };\n" +
"};\n");
}
@Override
@Test
public void testDefaultParameter()
{
IFunctionNode node = getMethodWithPackage("function method1(p1:int, p2:int, p3:int = 3, p4:int = 4):int{return p1 + p2 + p3 + p4;}");
asBlockWalker.visitFunction(node);
assertOut("/**\n * @param {number} p1\n * @param {number} p2\n * @param {number=} p3\n * @param {number=} p4\n * @return {number}\n */\n"
+ "foo.bar.FalconTest_A.prototype.method1 = function(p1, p2, p3, p4) {\n"
+ " p3 = typeof p3 !== 'undefined' ? p3 : 3;\n"
+ " p4 = typeof p4 !== 'undefined' ? p4 : 4;\n"
+ " return p1 + p2 + p3 + p4;\n}");
}
@Override
@Test
public void testDefaultParameter_Body()
{
IFunctionNode node = getMethodWithPackage("function method1(bar:int = 42, bax:int = 4):void{if (a) foo();}");
asBlockWalker.visitFunction(node);
assertOut("/**\n * @param {number=} bar\n * @param {number=} bax\n */\n"
+ "foo.bar.FalconTest_A.prototype.method1 = function(bar, bax) {\n"
+ " bar = typeof bar !== 'undefined' ? bar : 42;\n"
+ " bax = typeof bax !== 'undefined' ? bax : 4;\n"
+ " if (a)\n foo();\n}");
}
@Override
@Test
public void testDefaultParameter_NoBody()
{
IFunctionNode node = getMethodWithPackage("function method1(p1:int, p2:int, p3:int = 3, p4:int = 4):int{}");
asBlockWalker.visitFunction(node);
assertOut("/**\n * @param {number} p1\n * @param {number} p2\n * @param {number=} p3\n * @param {number=} p4\n * @return {number}\n */\n"
+ "foo.bar.FalconTest_A.prototype.method1 = function(p1, p2, p3, p4) {\n"
+ " p3 = typeof p3 !== 'undefined' ? p3 : 3;\n"
+ " p4 = typeof p4 !== 'undefined' ? p4 : 4;\n}");
}
@Override
@Test
public void testSimpleParameterReturnType()
{
IFunctionNode node = getMethodWithPackage("function method1(bar:int):int{\n}");
asBlockWalker.visitFunction(node);
assertOut("/**\n * @param {number} bar\n * @return {number}\n */\n"
+ "foo.bar.FalconTest_A.prototype.method1 = function(bar) {\n}");
}
@Override
@Test
public void testSimpleMultipleParameter()
{
IFunctionNode node = getMethodWithPackage("function method1(bar:int, baz:String, goo:Array):void{\n}");
asBlockWalker.visitFunction(node);
assertOut("/**\n * @param {number} bar\n * @param {string} baz\n * @param {Array} goo\n */\n"
+ "foo.bar.FalconTest_A.prototype.method1 = function(bar, baz, goo) {\n}");
}
@Override
@Test
public void testSimpleMultipleParameter_JSDoc()
{
IFunctionNode node = getMethodWithPackage("/**\n * This is copied from ASDoc.\n */\nfunction method1(bar:int, baz:String, goo:Array):void{\n}");
asBlockWalker.visitFunction(node);
assertOut("/**\n * This is copied from ASDoc.\n * @param {number} bar\n * @param {string} baz\n * @param {Array} goo\n */\n"
+ "foo.bar.FalconTest_A.prototype.method1 = function(bar, baz, goo) {\n}");
}
@Test
public void testSimpleMultipleParameter_JSDocSingleLine()
{
IFunctionNode node = getMethodWithPackage("/** This is copied from ASDoc. */\nfunction method1(bar:int, baz:String, goo:Array):void{\n}");
asBlockWalker.visitFunction(node);
assertOut("/** This is copied from ASDoc. \n * @param {number} bar\n * @param {string} baz\n * @param {Array} goo\n */\n"
+ "foo.bar.FalconTest_A.prototype.method1 = function(bar, baz, goo) {\n}");
}
@Override
protected IBackend createBackend()
{
return new FlexJSBackend();
}
@Override
protected void addDependencies()
{
super.addDependencies();
workspace.setASDocDelegate(new FlexJSASDocDelegate());
if (project.config == null)
project.config = new JSGoogConfiguration();
try {
project.config.setKeepASDoc(null, true);
} catch (ConfigurationException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}