RubyCodeCompleterTest.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2010 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]"
 *
 * Contributor(s):
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2009 Sun
 * Microsystems, Inc. All Rights Reserved.
 *
 * 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.
 */
package org.netbeans.modules.ruby;

import org.netbeans.modules.csl.api.CodeCompletionHandler.QueryType;
import org.netbeans.modules.ruby.options.TypeInferenceSettings;
import org.openide.filesystems.FileObject;

/**
 * @author Tor Norbye
 */
public class RubyCodeCompleterTest extends RubyCodeCompleterTestBase {

    public RubyCodeCompleterTest(String testName) {
        super(testName);
    }

    public void testEmpty1() throws Exception {
        checkCompletion("testfiles/empty.rb", "^", false);
    }

    FileObject getTestEmpty1ClassPath() {
        return null;
    }

    public void testPrefix1() throws Exception {
        checkPrefix("testfiles/cc-prefix1.rb");
    }

    public void testPrefix2() throws Exception {
        checkPrefix("testfiles/cc-prefix2.rb");
    }

    public void testPrefix3() throws Exception {
        checkPrefix("testfiles/cc-prefix3.rb");
    }

    public void testPrefix4() throws Exception {
        checkPrefix("testfiles/cc-prefix4.rb");
    }

    public void testPrefix5() throws Exception {
        checkPrefix("testfiles/cc-prefix5.rb");
    }

    public void testPrefix6() throws Exception {
        checkPrefix("testfiles/cc-prefix6.rb");
    }

    public void testPrefix7() throws Exception {
        checkPrefix("testfiles/cc-prefix7.rb");
    }

    public void testPrefix8() throws Exception {
        checkPrefix("testfiles/cc-prefix8.rb");
    }

    public void testAutoQuery1() throws Exception {
        assertAutoQuery(QueryType.NONE, "foo^", "o");
        assertAutoQuery(QueryType.NONE, "foo^", " ");
        assertAutoQuery(QueryType.NONE, "foo^", "c");
        assertAutoQuery(QueryType.NONE, "foo^", "d");
        assertAutoQuery(QueryType.NONE, "foo^", ";");
        assertAutoQuery(QueryType.NONE, "foo^", "f");
        assertAutoQuery(QueryType.NONE, "Foo:^", ":");
        assertAutoQuery(QueryType.NONE, "Foo^ ", ":");
        assertAutoQuery(QueryType.NONE, "Foo^bar", ":");
        assertAutoQuery(QueryType.NONE, "Foo:^bar", ":");
    }

    public void testAutoQuery2() throws Exception {
        assertAutoQuery(QueryType.STOP, "foo^", "[");
        assertAutoQuery(QueryType.STOP, "foo^", "(");
        assertAutoQuery(QueryType.STOP, "foo^", "{");
        assertAutoQuery(QueryType.STOP, "foo^", "\n");
    }

    public void testAutoQuery3() throws Exception {
        assertAutoQuery(QueryType.COMPLETION, "foo.^", ".");
        assertAutoQuery(QueryType.COMPLETION, "Foo::^", ":");
        assertAutoQuery(QueryType.COMPLETION, "foo^ ", ".");
        assertAutoQuery(QueryType.COMPLETION, "foo^bar", ".");
        assertAutoQuery(QueryType.COMPLETION, "Foo::^bar", ":");
    }

    public void testAutoQueryComments() throws Exception {
        assertAutoQuery(QueryType.COMPLETION, "foo^ # bar", ".");
        assertAutoQuery(QueryType.NONE, "#^foo", ".");
        assertAutoQuery(QueryType.NONE, "# foo^", ".");
        assertAutoQuery(QueryType.NONE, "# foo^", ":");
    }

    public void testAutoQueryStrings() throws Exception {
        assertAutoQuery(QueryType.COMPLETION, "foo^ 'foo'", ".");
        assertAutoQuery(QueryType.NONE, "'^foo'", ".");
        assertAutoQuery(QueryType.NONE, "/f^oo/", ".");
        assertAutoQuery(QueryType.NONE, "\"^\"", ".");
        assertAutoQuery(QueryType.NONE, "\" foo^ \"", ":");
    }

    public void testAutoQueryRanges() throws Exception {
        assertAutoQuery(QueryType.NONE, "x..^", ".");
        assertAutoQuery(QueryType.NONE, "x..^5", ".");
    }

    // This test is unstable for some reason
//    public void testCompletion1() throws Exception {
//        checkCompletion("testfiles/completion/lib/test1.rb", "f.e^");
//    }
    public void testCompletion2() throws Exception {
        checkCompletion("testfiles/completion/lib/test2.rb", "Result is #{@^myfield} and #@another.");
    }

    public void testCompletion3() throws Exception {
        checkCompletion("testfiles/completion/lib/test2.rb", "Result is #{@myfield} and #@a^nother.");
    }

    public void testCompletion4() throws Exception {
        checkCompletion("testfiles/completion/lib/test2.rb", "Hell^o World");
    }

    public void testCompletion5() throws Exception {
        checkCompletion("testfiles/completion/lib/test2.rb", "/re^g/");
    }

    public void testCompletion6() throws Exception {
        checkCompletion("testfiles/completion/lib/test2.rb", "class My^Test");
    }

    public void testCompletion7() throws Exception {
        checkCompletion("testfiles/completion/lib/test2.rb", "puts Module.class_variable^s");
    }

    public void testCompletion8() throws Exception {
        checkCompletion("testfiles/completion/lib/test2.rb", "puts 'Hello'.class^");
    }

    // TODO: test open classes, class inheritance, relative symbols, finding classes, superclasses, def completion, ...
    public void checkComputeMethodCall(String file, String caretLine, String fqn, String param, boolean expectSuccess) throws Exception {
        checkComputeMethodCall(file, caretLine, param, expectSuccess);
    }

    public void testCall1() throws Exception {
        checkComputeMethodCall("testfiles/calls/call1.rb", "create_table(^firstarg,  :id => true)",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "table_name", true);
    }

    public void testCall2() throws Exception {
        checkComputeMethodCall("testfiles/calls/call1.rb", "create_table(firstarg^,  :id => true)",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "table_name", true);
    }

    public void testCall3() throws Exception {
        checkComputeMethodCall("testfiles/calls/call1.rb", "create_table(firstarg,^  :id => true)",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "options", true);
    }

    public void testCall4() throws Exception {
        checkComputeMethodCall("testfiles/calls/call1.rb", "create_table(firstarg,  ^:id => true)",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "options", true);
    }

    public void testCallSpace1() throws Exception {
        checkComputeMethodCall("testfiles/calls/call1.rb", "create_table firstarg,  ^:id => true",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "options", true);
    }

    public void testCallSpace2() throws Exception {
        checkComputeMethodCall("testfiles/calls/call1.rb", "create_table ^firstarg,  :id => true",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "table_name", true);
    }

    public void testCall5() throws Exception {
        checkComputeMethodCall("testfiles/calls/call2.rb", "create_table(^)",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "table_name", true);
    }

    public void testCall6() throws Exception {
        checkComputeMethodCall("testfiles/calls/call3.rb", "create_table^",
                null, null, false);
    }

    public void testCall7() throws Exception {
        checkComputeMethodCall("testfiles/calls/call3.rb", "create_table ^",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "table_name", true);
    }

    public void testCall8() throws Exception {
        checkComputeMethodCall("testfiles/calls/call4.rb", "create_table foo,^",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "options", true);
    }

    public void testCall9() throws Exception {
        checkComputeMethodCall("testfiles/calls/call4.rb", "create_table foo, ^",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "options", true);
    }

    public void testCall10() throws Exception {
        checkComputeMethodCall("testfiles/calls/call5.rb", " create_table(foo, ^)",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "options", true);
    }

    public void testCall11() throws Exception {
        checkComputeMethodCall("testfiles/calls/call6.rb", " create_table(foo, :key => ^)",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "options", true);
    }

    public void testCall12() throws Exception {
        checkComputeMethodCall("testfiles/calls/call7.rb", " create_table(foo, :key => :^)",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "options", true);
    }

    public void testCall13() throws Exception {
        checkComputeMethodCall("testfiles/calls/call8.rb", " create_table(foo, :key => :a^)",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "options", true);
    }

    public void testCall14() throws Exception {
        checkComputeMethodCall("testfiles/calls/call9.rb", " create_table(foo, :^)",
                "ActiveRecord::SchemaStatements::ClassMethods#create_table", "options", true);
    }

//    public void testCall15() throws Exception {
//        checkComputeMethodCall("testfiles/calls/call10.rb", "File.exists?(^)",
//                "File#exists", "file", true);
//    }
    public void testCall16() throws Exception {
        checkComputeMethodCall("testfiles/calls/call11.rb", " ^#",
                null, null, false);
    }

    public void testCall17() throws Exception {
        checkComputeMethodCall("testfiles/calls/call12.rb", " ^#",
                null, null, false);
    }

    public void testGlobals() throws Exception {
        checkCompletion("testfiles/completion/lib/globals.rb", "$^m # input");
    }

    FileObject getTestGlobalsClassPath() {
        return getTestFile("testfiles/completion/lib");
    }

    void doGlobalsSetup() {
        RubyIndexer.userSourcesTest = true;
    }

    public void testAttributes() throws Exception {
        checkCompletion("testfiles/completion/lib/song.rb", "ss.^");
    }

    FileObject getTestAttributesClassPath() {
        return getTestFile("testfiles/completion/lib");
    }

    
    public void testIfWithFailingInferenceInBranchType() throws Exception {
        checkCompletion("testfiles/if_with_failing_inference_in_branch_type.rb", "var.to_i^");
    }

    public void testPredefConstantsComletionARGV() throws Exception {
        checkCompletion("testfiles/predef_constants.rb", "ARGV.del^");
    }

    public void testPredefConstantsComletion__FILE__() throws Exception {
        checkCompletion("testfiles/predef_constants.rb", "__FILE__.cho^");
    }

    // #threw NPE from RubyDeclarationFinder
    public void testUnkownInTheBlock() throws Exception {
        // TODO: it actually tries to infer wrongly upon the 'arr', but should
        // upon the 'Huh'. Cf. unknown_in_the_block.rb
        checkCompletion("testfiles/unknown_in_the_block.rb", "Huh.err^");
    }

    public void testConstantMethods() throws Exception {
        checkCompletion("testfiles/constants.rb", "Colors::RED.byte^s");
    }

    public void testConstantAssignedToVariableMethods() throws Exception {
        checkCompletion("testfiles/constants.rb", "puts b.down^case");
    }

    public void testConstants() throws Exception {
        checkCompletion("testfiles/constants1.rb", "Fcntl::O_A^");
    }

    public void testConstantsNonPrefixed() throws Exception {
        checkCompletion("testfiles/constants1.rb", "Fcntl::^O_A");
    }

    FileObject getTestConstantsNonPrefixedClassPath() {
        return null;
    }

    public void testConstantsFromParentsAreNotOffered() throws Exception {
        // must not offer FALSE from Object
        checkCompletion("testfiles/constants1.rb", "Fcntl::F^");
    }

    public void testConstantsForDotAreNotOffered() throws Exception {
        checkCompletion("testfiles/constants1.rb", "File.S^");
    }

    public void testCoreMethodWithMultiTypes() throws Exception {
        checkCompletion("testfiles/core_methods.rb", "puts has_one.t^");
    }

    public void testMethodsChainingAssignment() throws Exception {
        checkCompletion("testfiles/methods_chaining.rb", "puts greeting.cap^italize");
    }

    public void doMethodsChainingAssignmentSetup() {
        enableTypeInference();
    }

    public void testMethodsChainingDirect() throws Exception {
        checkCompletion("testfiles/methods_chaining.rb", "puts greeting.empty?.to_^s");
    }

    public void doMethodsChainingDirectSetup() {
        enableTypeInference();
    }

    public void testMethodsChainingDirectLiterals() throws Exception {
        checkCompletion("testfiles/methods_chaining.rb", "puts 1.even?.to^_s");
    }

    public void doMethodsChainingDirectLiteralsSetup() throws Exception {
        enableTypeInference();
    }

    public void testMethodsChainingParenthesised() throws Exception {
        checkCompletion("testfiles/methods_chaining.rb", "10.between?(0, 100).to^");
    }

    public void doMethodsChainingNoParenthesisedSetup() {
        enableTypeInference();
    }

    public void testMethodsChainingParenthesised2() throws Exception {
        checkCompletion("testfiles/methods_chaining.rb", "puts greeting.capitalize().swapc^ase()");
    }

    public void doMethodsChainingParenthesised2Setup() {
        enableTypeInference();
    }

    public void testMethodsChainingNoParenthesis() throws Exception {
        checkCompletion("testfiles/methods_chaining.rb", "puts greeting.capitalize.swapc^ase");
    }

    public void doMethodsChainingNoParenthesisSetup() {
        enableTypeInference();
    }

    public void testMethodTypeInference() throws Exception {
        checkCompletion("testfiles/method_type_inference.rb", "puts num.abs^");
    }

    public void doMethodTypeInferenceSetup() {
        enableTypeInference();
    }

    private void enableTypeInference() {
        RubyIndexer.userSourcesTest = true;
        TypeInferenceSettings.getDefault().setMethodTypeInference(true);
        TypeInferenceSettings.getDefault().setRdocTypeInference(true);
    }

    public void testClassVariables() throws Exception {
        checkCompletion("testfiles/cc-classvars.rb", "puts @@my_cl^ass_var");
    }

    public void testAttrReader() throws Exception {
        checkCompletion("testfiles/cc-attr_accessors.rb", "attr_reader ^:bar");
    }

    public void testAttrReader2() throws Exception {
        checkCompletion("testfiles/cc-attr_accessors.rb", "attr_reader :^bar");
    }

    public void testAttrWriter() throws Exception {
        checkCompletion("testfiles/cc-attr_accessors.rb", "attr_writer :baz, :fo^o");
    }

    public void testAliasMethod() throws Exception {
        checkCompletion("testfiles/alias_method.rb", "Far.new.far_^far_away");
    }

    public void testAliasMethod2() throws Exception {
        checkCompletion("testfiles/alias_method.rb", "Close.new.so_^so_close");
    }

    public void testAliasMethodKeyword() throws Exception {
        checkCompletion("testfiles/alias_method.rb", "Here.new.right_^there");
    }

    public void testDefineMethod() throws Exception {
        checkCompletion("testfiles/define_method.rb", "Calcutec.new.lau^nder");
    }

    public void testDefineMethod2() throws Exception {
        checkCompletion("testfiles/define_method.rb", "Calcutec.new.shuffle_dat^a");
    }

    public void testExtendWith() throws Exception {
        checkCompletion("testfiles/extend_with.rb", "added_class_m^ethod :something");
    }

    public void testExtendWith2() throws Exception {
        checkCompletion("testfiles/extend_with.rb", "Includes.added_class_^method");
    }

    public void testExtendWith3() throws Exception {
        checkCompletion("testfiles/extend_with.rb", "i.added_class_m^ethod");
    }

    public void testSpecCc() throws Exception {
        checkCompletion("testfiles/some_spec.rb", "@so^me.stuff");
    }

    public void testSpecCc2() throws Exception {
        checkCompletion("testfiles/some_spec.rb", "@thi^ng.do_it");
    }

    // TODO uncomment when reindexed
//    public void testIndexedConstantMethods() throws Exception {
//        checkCompletion("testfiles/constants.rb", "REXML::COPYRIGHT.ls^");
//    }
    // TODO - test more non-fc calls (e.g. x.foo)
    // TODO test with splat args (more args than are in def list)
    // TODO test with long arg lists
}