/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2012 Sun Microsystems, Inc.
 */
package org.netbeans.modules.javascript2.sdoc;

import java.util.Iterator;
import java.util.List;
import java.util.Map.Entry;
import org.netbeans.modules.javascript2.editor.JsTestBase;
import org.netbeans.modules.javascript2.sdoc.elements.SDocDescriptionElement;
import org.netbeans.modules.javascript2.sdoc.elements.SDocElement;
import org.netbeans.modules.javascript2.sdoc.elements.SDocElementType;
import org.netbeans.modules.parsing.api.Snapshot;
import org.netbeans.modules.parsing.api.Source;

/**
 *
 * @author Martin Fousek <marfous@netbeans.org>
 */
public class SDocParserTest extends JsTestBase {

    public SDocParserTest(String name) {
        super(name);
    }

    private static final SDocElementType[] expectedTypes = new SDocElementType[] {
        // context sensitive type
        SDocElementType.DESCRIPTION, SDocElementType.UNKNOWN,

        // classic types
        SDocElementType.ALIAS, SDocElementType.AUTHOR, SDocElementType.CLASS_DESCRIPTION, SDocElementType.CONSTRUCTOR,
        SDocElementType.DEPRECATED,SDocElementType.EXAMPLE,SDocElementType.EXCEPTION,SDocElementType.ID,
        SDocElementType.INHERITS,SDocElementType.INTERNAL,SDocElementType.MEMBER_OF,SDocElementType.METHOD,
        SDocElementType.NAMESPACE,SDocElementType.PARAM,SDocElementType.PRIVATE,SDocElementType.PROJECT_DESCRIPTION,
        SDocElementType.PROPERTY,SDocElementType.RETURN,SDocElementType.SEE,SDocElementType.SINCE,SDocElementType.TYPE,
        SDocElementType.VERSION
    };

    public void testParsedTypesForAsterisksComment() throws Exception {
        checkElementTypes("testfiles/sdoc/allTypesAsterisks.js");
    }

    public void testParsedTypesForNoAsteriskComment() throws Exception {
        checkElementTypes("testfiles/sdoc/allTypesNoAsterisks.js");
    }

    public void testParsedContextSensitiveContentNoAsterisk() throws Exception {
        Source source = getTestSource(getTestFile("testfiles/sdoc/allTypesNoAsterisks.js"));
        List<? extends SDocElement> tags = getFirstDocumentationBlock(source.createSnapshot()).getTags();
        assertEquals(SDocElementType.DESCRIPTION, tags.get(0).getType());
        assertEquals("This should be description.", ((SDocDescriptionElement) tags.get(0)).getDescription());
    }

    public void testParsedContextSensitiveContentAsterisks() throws Exception {
        Source source = getTestSource(getTestFile("testfiles/sdoc/allTypesAsterisks.js"));
        List<? extends SDocElement> tags = getFirstDocumentationBlock(source.createSnapshot()).getTags();
        assertEquals(SDocElementType.DESCRIPTION, tags.get(0).getType());
        assertEquals("This should be description.", ((SDocDescriptionElement) tags.get(0)).getDescription());
    }

    public void testNoTagsInBlockComment() throws Exception {
        Source source = getTestSource(getTestFile("testfiles/sdoc/blockComment.js"));
        Iterator<Entry<Integer, SDocComment>> iterator = SDocParser.parse(source.createSnapshot()).entrySet().iterator();
        assertTrue(!iterator.hasNext());
    }

    private void checkElementTypes(String filePath) throws Exception {
        Source source = getTestSource(getTestFile(filePath));
        List<? extends SDocElement> tags = getFirstDocumentationBlock(source.createSnapshot()).getTags();
        for (int i = 0; i < expectedTypes.length; i++) {
            assertEquals(expectedTypes[i], tags.get(i).getType());
        }
    }

    private SDocComment getFirstDocumentationBlock(Snapshot snapshot) {
        Iterator<Entry<Integer, SDocComment>> iterator = SDocParser.parse(snapshot).entrySet().iterator();
        return iterator.next().getValue();
    }

}
