<?xml version="1.0" encoding="UTF-8"?>

<project basedir="." default="netbeans" name="api.knockout">

    <description>Builds, tests, and runs the project org.netbeans.api.knockout</description>

    <import file="../nbbuild/templates/projectized.xml"/>

</project>

Manifest-Version: 1.0

OpenIDE-Module: org.netbeans.api.knockout

OpenIDE-Module-Localizing-Bundle: org/netbeans/api/knockout/Bundle.properties

OpenIDE-Module-Specification-Version: 1.0

javac.source=1.7

javac.compilerargs=-Xlint -Xlint:-serial

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://www.netbeans.org/ns/project/1">

    <type>org.netbeans.modules.apisupport.project</type>

    <configuration>

        <data xmlns="http://www.netbeans.org/ns/nb-module-project/3">

            <code-name-base>org.netbeans.api.knockout</code-name-base>

            <module-dependencies>

                <dependency>

                    <code-name-base>org.netbeans.modules.editor.mimelookup</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <release-version>1</release-version>

                        <specification-version>1.32</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.netbeans.modules.html.editor</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <release-version>2</release-version>

                        <specification-version>2.52</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.netbeans.modules.html.lexer</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <release-version>1</release-version>

                        <specification-version>1.29</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.netbeans.modules.lexer</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <release-version>2</release-version>

                        <specification-version>1.52</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.netbeans.modules.parsing.api</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <release-version>1</release-version>

                        <specification-version>9.0</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.filesystems</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>9.0</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.util.lookup</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>8.21</specification-version>

                    </run-dependency>

                </dependency>

            </module-dependencies>

            <test-dependencies>

                <test-type>

                    <name>unit</name>

                    <test-dependency>

                        <code-name-base>org.netbeans.libs.testng</code-name-base>

                        <compile-dependency/>

                    </test-dependency>

                </test-type>

            </test-dependencies>

            <public-packages>

                <package>org.netbeans.modules.knockout.impl</package>

                <package>org.netbeans.spi.knockout</package>

            </public-packages>

        </data>

    </configuration>

</project>

OpenIDE-Module-Name=Knockout Model Provider API

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2013 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 2013 Sun Microsystems, Inc.

 */

package org.netbeans.spi.knockout;

import java.util.ArrayList;

import java.util.HashSet;

import java.util.LinkedHashSet;

import java.util.List;

import java.util.Set;

import org.netbeans.spi.knockout.BindingsProvider.Response;

import org.openide.filesystems.FileObject;

import org.openide.util.Lookup;

/**

 * Allows structural description of a <code>ko.applyBindings</code> parameter.

 * Register as {@link BindingsProvider}. When called build description of JSON

 * types using methods like {@link #stringProperty(java.lang.String, boolean)}

 * and then pass the result into

 * {@link Response#applyBindings(org.netbeans.spi.knockout.Bindings)} method.

 *

 * @author Jaroslav Tulach <jtulach@netbeans.org>

 */

public final class Bindings {

    private final String name;

    private final List<Bindings> subBindings = new ArrayList<>();

    private final List<String> props = new ArrayList<>();

    private Bindings(String name) {

        this.name = name;

    }

    /**

     * Defines new variable with provided name and assigns a JSON object into

     * it. The created instance is a builder - continue calling its various

     * builder methods like {@link #intProperty(java.lang.String, boolean)}.

     *

     * @param name name of variable (must be valid JavaScript identifier)

     * @return empty JSON object ready to be filled using

     * {@link #doubleProperty(java.lang.String, boolean)}, and other methods

     */

    public static Bindings create(String name) {

        return new Bindings(name);

    }

    /**

     * Generates a boolean property (with value <code>true</code>) into the JSON

     * class.

     *

     * @param name name of variable (must be valid JavaScript identifier)

     * @param array should this property be an array of just a single value

     * @return this object

     */

    public final Bindings booleanProperty(String name, boolean array) {

        addProp(name, array, "true");

        return this;

    }

    /**

     * Generates a string property (with value <code>''</code>) into the JSON

     * class.

     *

     * @param name name of variable (must be valid JavaScript identifier)

     * @param array should this property be an array of just a single value

     * @return this object

     */

    public final Bindings stringProperty(String name, boolean array) {

        addProp(name, array, "''");

        return this;

    }

    /**

     * Generates a integer property (with value <code>0</code>) into the JSON

     * class.

     *

     * @param name name of variable (must be valid JavaScript identifier)

     * @param array should this property be an array of just a single value

     * @return this object

     */

    public final Bindings intProperty(String name, boolean array) {

        addProp(name, array, "0");

        return this;

    }

    /**

     * Generates a floating point property (with value <code>0.1</code>) into

     * the JSON class.

     *

     * @param name name of variable (must be valid JavaScript identifier)

     * @param array should this property be an array of just a single value

     * @return this object

     */

    public final Bindings doubleProperty(String name, boolean array) {

        addProp(name, array, "0.1");

        return this;

    }

    /**

     * Generates complex subtype based on another {@link Bindings} class.

     *

     * @param name name of variable (must be valid JavaScript identifier)

     * @param binding another description of a JSON like object

     * @param array should this property be an array of just a single value

     * @return this object

     */

    public final Bindings modelProperty(String name, Bindings binding, boolean array) {

        subBindings.add(binding);

        addProp(name, array, binding.name);

        return this;

    }

    final String generate() {

        StringBuilder sb = new StringBuilder();

        //sb.append("(function() {\n");

        HashSet<Bindings> visited = new HashSet<>();

        LinkedHashSet<Bindings> lhs = new LinkedHashSet<>();

        walkBindings(visited, lhs);

        for (Bindings b : lhs) {

            b.generate(sb);

        }

        sb.append("  ko.applyBindings(").append(name).append(");\n");

        //sb.append("}());");

        return sb.toString();

    }

    private void generate(StringBuilder sb) {

        sb.append("var ").append(name).append(" = {");

        String sep = "\n";

        for (String s : props) {

            sb.append(sep).append("  ").append(s);

            sep = ",\n";

        }

        sb.append("\n};\n");

    }

    private void addProp(String name, boolean array, String value) {

        if (array) {

            value = "[ " + value + " ]";

        }

        if (name.contains("\"")) {

            throw new IllegalStateException("Wrong name " + name);

        }

        props.add('\"' + name + "\" : " + value);

    }

    private void walkBindings(Set<Bindings> visited, Set<Bindings> collect) {

        if (!visited.add(this)) {

            return;

        }

        for (Bindings b : subBindings) {

            b.walkBindings(visited, collect);

        }

        collect.add(this);

    }

    static {

        new SPIAccessor() {

            @Override

            protected String findBindings(FileObject fo) {

                Response r = new Response();

                for (BindingsProvider p : Lookup.getDefault().lookupAll(BindingsProvider.class)) {

                    p.findBindings(fo, r);

                    if (r.bindings != null) {

                        return r.bindings.generate();

                    }

                }

                return null;

            }

        };

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2013 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 2013 Sun Microsystems, Inc.

 */

package org.netbeans.spi.knockout;

import org.openide.filesystems.FileObject;

/**

 *

 * @author Jaroslav Tulach <jtulach@netbeans.org>

 */

public interface BindingsProvider {

    public void findBindings(FileObject htmlFile, Response r);

    public static final class Response {

        Bindings bindings;

        Response() {

        }

        public void applyBindings(Bindings bindings) {

            this.bindings = bindings;

        }

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2013 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 2013 Sun Microsystems, Inc.

 */

package org.netbeans.spi.knockout;

import org.openide.filesystems.FileObject;

/**

 *

 * @author Jaroslav Tulach <jtulach@netbeans.org>

 */

public abstract class SPIAccessor {

    private static SPIAccessor DEFAULT;

    static {

        Bindings.create("");

    }

    public static String findModelFor(FileObject fo) {

        return DEFAULT.findBindings(fo);

    }

    protected SPIAccessor() {

        DEFAULT = this;

    }

    protected abstract String findBindings(FileObject fo);

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2013 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 2013 Sun Microsystems, Inc.

 */

package org.netbeans.spi.knockout;

import javax.script.ScriptEngine;

import javax.script.ScriptEngineManager;

import javax.script.ScriptException;

import org.testng.annotations.BeforeMethod;

import org.testng.annotations.Test;

import static org.testng.Assert.*;

/**

 *

 * @author Jaroslav Tulach <jtulach@netbeans.org>

 */

public class BindingsNGTest {

    private ScriptEngine eng;

    public BindingsNGTest() {

    }

    @BeforeMethod public void initEngine() {

        ScriptEngineManager sem = new ScriptEngineManager();

        eng = sem.getEngineByMimeType("text/javascript");

    }

    @Test public void generateTwitterModel() throws Exception {

        Bindings tweet = Bindings.create("Tweet").

            stringProperty("from_user", false).

            intProperty("from_user_id", false);

        Bindings tweeters = Bindings.create("Tweeters").

            stringProperty("name", false).

            stringProperty("userNames", true);

        Bindings twitterClient = Bindings.create("TwitterClient");

        twitterClient.

            stringProperty("activeTweetersName", false).

            stringProperty("activeTweeters", true).

            stringProperty("userNameToAdd", false).

            booleanProperty("loading", false).

            modelProperty("currentTweets", tweet, true).

            modelProperty("savedLists", tweeters, true);

        String txt = twitterClient.generate();

        assertValidJS(txt);

        assertNotNull(eng.eval("ko"));

        assertNotNull(eng.eval("ko.value"));

        assertEquals(eng.eval("ko.value.loading"), true, "Boolean values are set to true");

        assertEquals(eng.eval("ko.value.currentTweets[0].from_user_id"), 0d, "Boolean values are set to true");

    }

    private void assertValidJS(String txt) {

        assertNotNull(txt, "We have some script");

        try {

            eng.eval("ko = {}; ko.applyBindings = function(val) { ko.value = val; }");

            eng.eval(txt);

        } catch (ScriptException ex) {

            throw new AssertionError(txt, ex);

        }

    }

}

                <friend>org.netbeans.api.knockout</friend>

                <friend>org.netbeans.modules.javascript2.requirejs</friend>

                    <code-name-base>org.netbeans.api.knockout</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>1.0</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

import org.netbeans.spi.knockout.SPIAccessor;

import org.openide.filesystems.FileObject;

    private String generatedSource;

        FileObject fo = snapshot.getSource().getFileObject();

        if (fo != null) {

            generatedSource = SPIAccessor.findModelFor(fo);

        }

        if (generatedSource != null) {

            sb.append(generatedSource).append("\n");

        }

        api.knockout,\

<?xml version="1.0" encoding="UTF-8"?>

<project basedir="." default="netbeans" name="sample.bindingsprovider">

    <description>Builds, tests, and runs the project org.netbeans.modules.sample.bindingsprovider</description>

    <import file="../nbbuild/templates/projectized.xml"/>

</project>

Manifest-Version: 1.0

AutoUpdate-Show-In-Client: true

OpenIDE-Module: org.netbeans.modules.sample.bindingsprovider

OpenIDE-Module-Localizing-Bundle: org/netbeans/modules/sample/bindingsprovider/Bundle.properties

OpenIDE-Module-Specification-Version: 1.0

javac.source=1.7

javac.compilerargs=-Xlint -Xlint:-serial

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://www.netbeans.org/ns/project/1">

    <type>org.netbeans.modules.apisupport.project</type>

    <configuration>

        <data xmlns="http://www.netbeans.org/ns/nb-module-project/3">

            <code-name-base>org.netbeans.modules.sample.bindingsprovider</code-name-base>

            <module-dependencies>

                <dependency>

                    <code-name-base>org.netbeans.api.knockout</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>1.0</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.filesystems</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>9.3</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.util.lookup</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>8.30</specification-version>

                    </run-dependency>

                </dependency>

            </module-dependencies>

            <public-packages/>

        </data>

    </configuration>

</project>

OpenIDE-Module-Name=Knockout Sample Bindings Provider

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2014 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 2014 Sun Microsystems, Inc.

 */

package org.netbeans.modules.sample.bindingsprovider;

import org.netbeans.spi.knockout.Bindings;

import org.netbeans.spi.knockout.BindingsProvider;

import org.openide.filesystems.FileObject;

import org.openide.util.lookup.ServiceProvider;

/**

 *

 * @author rsvitanic

 */

@ServiceProvider(service = BindingsProvider.class)

public class SampleBindingsProvider implements BindingsProvider {

    @Override

    public void findBindings(FileObject htmlFile, Response r) {

        Bindings tweet = Bindings.create("Tweet").

                stringProperty("from_user", false).

                intProperty("from_user_id", false);

        Bindings tweeters = Bindings.create("Tweeters").

                stringProperty("name", false).

                stringProperty("userNames", true);

        Bindings twitterClient = Bindings.create("TwitterClient");

        twitterClient.

                stringProperty("activeTweetersName", false).

                stringProperty("activeTweeters", true).

                stringProperty("userNameToAdd", false).

                booleanProperty("loading", false).

                modelProperty("currentTweets", tweet, true).

                modelProperty("savedLists", tweeters, true);

        r.applyBindings(twitterClient);

    }

}