Application: gvSIG desktop » gvSIG scripting

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

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <artifactId>org.gvsig.scripting</artifactId>

    <packaging>pom</packaging>

    <version>2.3.28</version>

    <name>${project.artifactId}</name>

    <description>Scripting Framework for gvSIG</description>

    <url>http://devel.gvsig.org/sites/org.gvsig.scripting/${project.version}</url>

    <parent>

        <groupId>org.gvsig</groupId>

        <artifactId>org.gvsig.desktop</artifactId>

        <version>2.0.148</version>

    </parent>

    <scm>

        <connection>scm:svn:https://devel.gvsig.org/svn/gvsig-scripting/org.gvsig.scripting/tags/org.gvsig.scripting-2.3.28</connection>

        <developerConnection>scm:svn:https://devel.gvsig.org/svn/gvsig-scripting/org.gvsig.scripting/tags/org.gvsig.scripting-2.3.28</developerConnection>

        <url>https://devel.gvsig.org/redmine/projects/gvsig-scripting/repository/show/org.gvsig.scripting/tags/org.gvsig.scripting-2.3.28</url>

    </scm>

    <developers>

        <developer>

            <id>jjdelcerro</id>

            <name>Joaquín José del Cerro</name>

            <email>jjdelcerro@gvsig.org</email>

            <roles>

                <role>Architect</role>

                <role>Developer</role>

            </roles>

        </developer>

        <developer>

            <id>jbadia</id>

            <name>José Badía</name>

            <email>badia_jos@gva.es</email>

            <roles>

                <role>Developer</role>

            </roles>

        </developer>

    </developers>

    <distributionManagement>

        <site>

            <id>gvsig-repository</id>

            <url>dav:https://devel.gvsig.org/sites/org.gvsig.scripting/${project.version}</url>

        </site>

    </distributionManagement>

    <repositories>

        <repository>

            <id>gvsig-public-http-repository</id>

            <name>gvSIG maven public HTTP repository</name>

            <url>http://devel.gvsig.org/m2repo/j2se</url>

            <releases>

                <enabled>true</enabled>

                <updatePolicy>daily</updatePolicy>

                <checksumPolicy>warn</checksumPolicy>

            </releases>

            <snapshots>

                <enabled>true</enabled>

                <updatePolicy>daily</updatePolicy>

                <checksumPolicy>warn</checksumPolicy>

            </snapshots>

        </repository>

        <repository>

            <id>bedatadriven</id>

            <name>bedatadriven public repo</name>

            <url>http://nexus.bedatadriven.com/content/groups/public/</url>

        </repository>

    </repositories>

    <build>

        <plugins>

            <plugin>

                <groupId>org.apache.maven.plugins</groupId>

                <artifactId>maven-release-plugin</artifactId>

                <configuration>

                    <tagBase>https://devel.gvsig.org/svn/gvsig-scripting/org.gvsig.scripting/tags</tagBase>

                </configuration>

            </plugin>

        </plugins>

    </build>

    <dependencyManagement>

        <dependencies>

            <dependency>

                <groupId>org.gvsig</groupId>

                <artifactId>org.gvsig.scripting.lib.api</artifactId>

                <version>2.3.28</version>

            </dependency>

            <dependency>

                <groupId>org.gvsig</groupId>

                <artifactId>org.gvsig.scripting.swing.api</artifactId>

                <version>2.3.28</version>

            </dependency>

            <dependency>

                <groupId>org.gvsig</groupId>

                <artifactId>org.gvsig.scripting.lib.impl</artifactId>

                <version>2.3.28</version>

            </dependency>

            <dependency>

                <groupId>org.gvsig</groupId>

                <artifactId>org.gvsig.scripting.swing.impl</artifactId>

                <version>2.3.28</version>

            </dependency>

            <dependency>

                <groupId>org.gvsig</groupId>

                <artifactId>org.gvsig.scripting.main</artifactId>

                <version>2.3.28</version>

            </dependency>

            <dependency>

                <groupId>org.gvsig</groupId>

                <artifactId>org.gvsig.scripting.thing</artifactId>

                <version>2.3.28</version>

            </dependency>

            <dependency>

                <groupId>org.gvsig</groupId>

                <artifactId>org.gvsig.scripting.app.mainplugin</artifactId>

                <version>2.3.28</version>

            </dependency>

            <dependency>

                <groupId>org.renjin</groupId>

                <artifactId>renjin-script-engine</artifactId>

                <version>0.8.1592</version>

                <classifier>jar-with-dependencies</classifier>

            </dependency>

            <dependency>

                <groupId>org.scala-lang</groupId>

                <artifactId>scala-dist</artifactId>

                <version>2.12.0-M2</version>

                <scope>runtime</scope>

                <exclusions>

                    <exclusion>

                        <groupId>org.scala-lang</groupId>

                        <artifactId>scala-library-all</artifactId>

                    </exclusion>

                </exclusions>            

            </dependency>

            <dependency>

                <groupId>org.scala-lang</groupId>

                <artifactId>scala-compiler</artifactId>

                <version>2.12.0-M2</version>

            </dependency>

            <dependency>

                <groupId>org.scala-lang</groupId>

                <artifactId>scala-library</artifactId>

                <version>2.12.0-M2</version>

            </dependency>

            <dependency>

                <groupId>org.scala-lang</groupId>

                <artifactId>scala-reflect</artifactId>

                <version>2.12.0-M2</version>

            </dependency>

            <dependency>

                <groupId>org.scala-lang</groupId>

                <artifactId>scalap</artifactId>

                <version>2.12.0-M2</version>

            </dependency>

            <dependency>

                <groupId>jline</groupId>

                <artifactId>jline</artifactId>

                <version>2.12.1</version>

            </dependency>

            <dependency>

                <groupId>com.jeta</groupId>

                <artifactId>abeille</artifactId>

                <version>2.1.0.M3</version>

                <type>tar.gz</type>

            </dependency>

            <dependency>

                <groupId>org.apache.tika</groupId>

                <artifactId>tika-core</artifactId>

                <version>1.12</version>

            </dependency>            

            <!-- Eliminar para org.gvsig.desktop > 2.0.115 -->

            <dependency>

                <groupId>org.jopendocument</groupId>

                <artifactId>jOpenDocument</artifactId>

                <version>1.3</version>

            </dependency>

            <dependency>

                <groupId>net.sf.cssbox</groupId>

                <artifactId>swingbox</artifactId>

                <version>1.1</version>

            </dependency>

            <dependency>

                <groupId>net.sf.cssbox</groupId>

                <artifactId>cssbox</artifactId>

                <version>4.7</version>

            </dependency>

            <dependency>

                <groupId>net.sourceforge.nekohtml</groupId>

                <artifactId>nekohtml</artifactId>

                <version>1.9.21</version>

            </dependency>

            <dependency>

                <groupId>net.sf.cssbox</groupId>

                <artifactId>jstyleparser</artifactId>

                <version>1.18</version>

            </dependency>

        </dependencies>

    </dependencyManagement>

    <modules>

        <module>org.gvsig.scripting.thing</module>

        <module>org.gvsig.scripting.lib</module>

        <module>org.gvsig.scripting.swing</module>

        <module>org.gvsig.scripting.main</module>

        <module>org.gvsig.scripting.app</module>

    </modules>

</project>

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

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<artifactId>org.gvsig.scripting.lib.api</artifactId>

	<packaging>jar</packaging>

	<name>org.gvsig.scripting.lib.api</name>

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.scripting.lib</artifactId>

		<version>2.3.28</version>

	</parent>

	<dependencies>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.tools.lib</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.tools.lib</artifactId>

			<type>test-jar</type>

			<scope>test</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.i18n</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>javax.help</groupId>

			<artifactId>javahelp</artifactId>

			<scope>compile</scope>

		</dependency>

	</dependencies>

	<build>

		<plugins>

			<plugin>

				<groupId>org.apache.maven.plugins</groupId>

				<artifactId>maven-jar-plugin</artifactId>

				<configuration>

				</configuration>

				<executions>

					<!--

						Generates a jar file only with the test classes

					-->

					<execution>

						<goals>

							<goal>test-jar</goal>

						</goals>

					</execution>

				</executions>

			</plugin>

		</plugins>

	</build>

</project>

package org.gvsig.scripting;

import java.io.File;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Set;

import junit.framework.Assert;

import org.gvsig.tools.junit.AbstractLibraryAutoInitTestCase;

public abstract class TestManager extends AbstractLibraryAutoInitTestCase {

	protected ScriptingManager manager;

	@Override

	protected void doSetUp() throws Exception {

		manager = ScriptingLocator.getManager();

	}

	public void setWorkingFolder(){

		File file =new File(this.getClass().getClassLoader().getResource("org/gvsig/scripting/home").getFile());

//		FIXME: hay que sustituirlo por manager.setHomeFolder(home) 

//		manager.setRootUserFolder(file.getAbsolutePath());

	}

	public void deleteFolderContent(ScriptingFolder folder){

		List<ScriptingUnit> units = folder.getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		while(it.hasNext()){

			ScriptingUnit unit = it.next();

			if(unit instanceof ScriptingFolder){

				deleteFolderContent((ScriptingFolder)unit);

				folder.remove(unit);

			}else{

				folder.remove(unit);

			}

		}

	}

	public void deleteWorkingFolderContent(){

		setWorkingFolder();

		ScriptingFolder folder = manager.getUserFolder();

		deleteFolderContent(folder);

	}

	public void testUserFolderPath(){

		setWorkingFolder();

		Assert.assertEquals(manager.getRootUserFolder().getAbsolutePath(), manager.getUserFolder().getFile().getAbsolutePath());

	}

	public void testExistsScriptId(){

		setWorkingFolder();

		manager.createUnit(ScriptingManager.UNIT_SCRIPT,manager.getUserFolder(),"test_script.py");

		Assert.assertEquals(false, manager.validateUnitId(manager.getUserFolder(),"test_script"));

		Assert.assertEquals(true, manager.validateUnitId(manager.getUserFolder(),"test_script2"));

		deleteWorkingFolderContent();

	}

	public void checkUnitValues(ScriptingUnit unit1, ScriptingUnit unit2){

		Assert.assertEquals(unit1.getId(),unit2.getId());

		Assert.assertEquals(unit1.getName(),unit2.getName());

	}

	public void testRegisteringSystemFolders(){

		ScriptingFolder folder_parent = (ScriptingFolder) manager.createUnit(ScriptingManager.UNIT_FOLDER,manager.getUserFolder(), "test");

		ScriptingFolder folder = (ScriptingFolder) manager.createUnit(ScriptingManager.UNIT_FOLDER,folder_parent, "test");

		ScriptingScript script = (ScriptingScript)manager.createUnit(ScriptingManager.UNIT_SCRIPT,folder, "test_script.py");

		manager.registerSystemFolder("test", folder.getFile());

		List<ScriptingUnit> units = manager.getSystemFolder().getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		ScriptingUnit unit = null;

		while(it.hasNext()){

			unit = it.next();

			checkUnitValues(unit, folder);

		}

		Assert.assertNotNull(unit);

		ScriptingScript script2 = (ScriptingScript) manager.getScript(new File(((ScriptingFolder)unit).getFile(),script.getId()+".py"));

		checkUnitValues(script,script2);

		deleteWorkingFolderContent();

	}

}

package org.gvsig.scripting;

import java.io.File;

import java.util.Iterator;

import java.util.List;

import junit.framework.Assert;

import org.gvsig.tools.junit.AbstractLibraryAutoInitTestCase;

public abstract class TestFolder extends AbstractLibraryAutoInitTestCase {

	protected ScriptingManager manager;

	@Override

	protected void doSetUp() throws Exception {

		manager = ScriptingLocator.getManager();

	}

	public void setWorkingFolder(){

		File file =new File(this.getClass().getClassLoader().getResource("org/gvsig/scripting/home").getFile());

		if(file.exists()){

			file.mkdir();

		}

//		FIXME: hay que sustituirlo por manager.setHomeFolder(home) 

//		manager.setRootUserFolder(file.getAbsolutePath());

	}

	public void deleteFolderContent(ScriptingFolder folder){

		List<ScriptingUnit> units = folder.getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		while(it.hasNext()){

			ScriptingUnit unit = it.next();

			if(unit instanceof ScriptingFolder){

				deleteFolderContent((ScriptingFolder)unit);

				folder.remove(unit);

			}else{

				folder.remove(unit);

			}

		}

	}

	public void deleteWorkingFolderContent(){

		setWorkingFolder();

		ScriptingFolder folder = manager.getUserFolder();

		deleteFolderContent(folder);

	}

	public File getFile(ScriptingFolder folder, String name){

		return new File(folder.getFile(),name);

	}

	public void checkFolder(ScriptingFolder folder, String fName){

		File ffolder = getFile(folder, fName);

		Assert.assertTrue(ffolder.exists());

		Assert.assertTrue(ffolder.isDirectory());

	}

	public void checkScriptDefaultValues(ScriptingScript script){

		Assert.assertEquals("test_script", script.getId());

		Assert.assertEquals("test_script", script.getName());

		Assert.assertEquals("python", script.getLangName());

		Assert.assertEquals("main", script.getMainName());

	}

	public void testCreation(){

		deleteWorkingFolderContent();

		ScriptingFolder folder = (ScriptingFolder) manager.createUnit(ScriptingManager.UNIT_FOLDER,manager.getUserFolder(),"test_folder");

		checkFolder(manager.getUserFolder(),folder.getId());

	}

	public void testList(){

		testCreation();

		ScriptingFolder folder = manager.getFolder(getFile(manager.getUserFolder(),"test_folder"));

		ScriptingScript script = (ScriptingScript) manager.createUnit(ScriptingManager.UNIT_SCRIPT,folder, "test_script.py");

        List<ScriptingUnit> units = folder.getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		while(it.hasNext()){

			ScriptingUnit unit = it.next();

			checkScriptDefaultValues((ScriptingScript) unit);

		}

		folder.remove(script);

		Assert.assertTrue(folder.getUnits().isEmpty());

	}

	public void testRename(){

		testCreation();

		ScriptingFolder folder = manager.getFolder(getFile(manager.getUserFolder(),"test_folder"));

		Assert.assertFalse(folder.rename("test_folder"));

		Assert.assertTrue(folder.rename("test_folder2"));

		Assert.assertEquals("test_folder2", folder.getName());

		deleteWorkingFolderContent();

	}

	public void testMove(){

		testCreation();

		ScriptingScript script = (ScriptingScript) manager.createUnit(ScriptingManager.UNIT_SCRIPT,manager.getUserFolder(), "test_script.py");	

		ScriptingFolder folder = manager.getFolder(getFile(manager.getUserFolder(),"test_folder"));

		Assert.assertEquals(script.getParent().getFile().getAbsolutePath(),manager.getUserFolder().getFile().getAbsolutePath());

		folder.add(script);

		Assert.assertEquals(script.getParent(),folder);

		deleteWorkingFolderContent();

	}

}

package org.gvsig.scripting;

import java.io.BufferedWriter;

import java.io.File;

import java.io.FileWriter;

import java.io.IOException;

import java.util.Iterator;

import java.util.List;

import junit.framework.Assert;

import org.gvsig.tools.junit.AbstractLibraryAutoInitTestCase;

public abstract class TestDialog extends AbstractLibraryAutoInitTestCase {

	protected ScriptingManager manager;

	@Override

	protected void doSetUp() throws Exception {

		manager = ScriptingLocator.getManager();

	}

	public void setWorkingFolder(){

		File file =new File(this.getClass().getClassLoader().getResource("org/gvsig/scripting/home").getFile());

//		FIXME: hay que sustituirlo por manager.setHomeFolder(home) 

//		manager.setRootUserFolder(file.getAbsolutePath());

	}

	public File getFile(String name){

		return new File(manager.getRootUserFolder()+File.separator+name);

	}

	public void deleteFolderContent(ScriptingFolder folder){

		List<ScriptingUnit> units = folder.getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		while(it.hasNext()){

			ScriptingUnit unit = it.next();

			if(unit instanceof ScriptingFolder){

				deleteFolderContent((ScriptingFolder)unit);

				folder.remove(unit);

			}else{

				folder.remove(unit);

			}

		}

	}

	public void deleteWorkingFolderContent(){

		setWorkingFolder();

		ScriptingFolder folder = manager.getUserFolder();

		deleteFolderContent(folder);

	}

	public void checkFile(String fName){

		File fscript = getFile(fName);

		Assert.assertTrue(fscript.exists());

	}

	public void checkScriptDefaultValues(ScriptingDialog script){

		Assert.assertEquals("test_dialog", script.getId());

		Assert.assertEquals("test_dialog", script.getName());

		Assert.assertEquals("python", script.getLangName());

		Assert.assertEquals("main", script.getMainName());

	}

	public void checkScriptNewValues(ScriptingDialog script){

		Assert.assertEquals("test_dialog", script.getId());

		Assert.assertEquals("TestDialog", script.getName());

		Assert.assertEquals("Tests sobre dialogs", script.getDescription());

		Assert.assertEquals("python", script.getLangName());

		Assert.assertEquals("main", script.getMainName());

		Assert.assertEquals("creator", script.getCreatedBy());

		Assert.assertEquals("v1.0", script.getVersion());

		Assert.assertEquals("def hola():\n  return 'hola mundo'\n",script.getCode());

	}

	public void testCreation(){

		deleteWorkingFolderContent();

		setWorkingFolder();

		ScriptingDialog script = (ScriptingDialog) manager.createUnit(ScriptingManager.UNIT_DIALOG,manager.getUserFolder(),"test_dialog.py");

		script.save();

		checkFile("test_dialog.py");

		checkFile("test_dialog.dlg");

		checkFile("test_dialog.inf");

		checkScriptDefaultValues(script);

	}

	public void testOpen(){

		testCreation();

		ScriptingDialog script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));

		checkScriptDefaultValues(script);

		deleteWorkingFolderContent();

	}

	public void testSave(){

		testCreation();

		ScriptingDialog script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));

		script.setName("TestDialog");

		script.setDescription("Tests sobre dialogs");

		script.setCode("def hola():\n  return 'hola mundo'\n");

		script.setCreatedBy("creator");

		script.setVersion("v1.0");

		script.save();

		File f = script.getDialogFile();

		try {

			BufferedWriter bw = new BufferedWriter(new FileWriter(f));

			bw.write("<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>\n" + 

					"<panel columns=\"1\">\n" +

					"\t<button action=\"hola\" text=\"press\"/>\n" + 

					"</panel>");

		} catch (IOException e) {

			// TODO Auto-generated catch block

			e.printStackTrace();

		}

		script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));

		checkScriptNewValues(script);

	}

	public void testRename(){

		deleteWorkingFolderContent();

		testCreation();

		ScriptingDialog script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));

		Assert.assertFalse(script.rename("test_dialog"));

		Assert.assertTrue(script.rename("test_dialog2"));

		script = (ScriptingDialog) manager.getScript(getFile("test_dialog2.py"));

		Assert.assertEquals("test_dialog2", script.getId());

		File f = getFile("test_dialog.py");

		Assert.assertFalse(f.exists());

		f = getFile("test_dialog2.py");

		Assert.assertTrue(f.exists());

		deleteWorkingFolderContent();

	}

	public void testMove(){

		testCreation();

		ScriptingFolder folderDestination = (ScriptingFolder) manager.createUnit(ScriptingManager.UNIT_FOLDER,manager.getUserFolder(), "other folder");

		checkFile("other folder");

		ScriptingDialog script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));	

		script.move(folderDestination);

		Assert.assertEquals(script.getParent().getFile().getAbsolutePath(),folderDestination.getFile().getAbsolutePath());

		deleteWorkingFolderContent();

	}

	public void testRun(){

	/*	testSave();

		ScriptingDialog script = (ScriptingDialog) manager.getScript(getFile("test_dialog.py"));		

		Assert.assertEquals("hola mundo", script.run());

		//setMainName

		//invokeMethod

		//invokeFunction

		deleteWorkingFolderContent();*/

	}

}

package org.gvsig.scripting;

import java.io.File;

import java.util.Iterator;

import java.util.List;

import junit.framework.Assert;

import org.gvsig.tools.junit.AbstractLibraryAutoInitTestCase;

public abstract class TestScript extends AbstractLibraryAutoInitTestCase {

	protected ScriptingManager manager;

	@Override

	protected void doSetUp() throws Exception {

		ScriptingLocator locator = new ScriptingLocator();

		Assert.assertNotNull(locator);

		manager = ScriptingLocator.getManager();

		Assert.assertNotNull(manager);

	}

	public void setWorkingFolder(){

		File file =new File(this.getClass().getClassLoader().getResource("org/gvsig/scripting/home").getFile());

		if(file.exists()){

			file.mkdir();

		}

//		FIXME: hay que sustituirlo por manager.setHomeFolder(home) 

//		manager.setRootUserFolder(file.getAbsolutePath());

	}

	public void deleteFolderContent(ScriptingFolder folder){

		List<ScriptingUnit> units = folder.getUnits();

        Iterator<ScriptingUnit> it = units.iterator();

		while(it.hasNext()){

			ScriptingUnit unit = it.next();

			if(unit instanceof ScriptingFolder){

				deleteFolderContent((ScriptingFolder)unit);

				folder.remove(unit);

			}else{

				folder.remove(unit);

			}

		}

	}

	public void deleteWorkingFolderContent(){

		setWorkingFolder();

		ScriptingFolder folder = manager.getUserFolder();

		deleteFolderContent(folder);

	}

	public File getFile(ScriptingFolder folder, String name){

		return new File(folder.getFile(),name);

	}

	public void checkFile(ScriptingFolder folder, String fName){

		File fscript = getFile(folder, fName);

		Assert.assertTrue(fscript.exists());

	}

	public void checkScriptDefaultValues(ScriptingScript script){

		Assert.assertEquals(manager.getUserFolder().getFile().getAbsolutePath(), script.getParent().getFile().getAbsolutePath());

		Assert.assertEquals("test_script", script.getId());

		Assert.assertEquals("test_script", script.getName());

		Assert.assertEquals("python", script.getLangName());

		Assert.assertEquals("main", script.getMainName());

	}

	public void checkScriptNewValues(ScriptingScript script){

		Assert.assertEquals("test_script", script.getId());

		Assert.assertEquals("TestScript", script.getName());

		Assert.assertEquals("Tests sobre scripts", script.getDescription());

		Assert.assertEquals("python", script.getLangName());

		Assert.assertEquals("main", script.getMainName());

		Assert.assertEquals("creator", script.getCreatedBy());

		Assert.assertEquals("v1.0", script.getVersion());

		Assert.assertEquals("def main():\n  return 'hola mundo'\n",script.getCode());

	}

	public void testCreation(){

		setWorkingFolder();

		ScriptingScript previous = (ScriptingScript) manager.getScript(new File(manager.getRootUserFolder()+File.separator+"test_script.py"));

		if (previous!=null){

			manager.getUserFolder().remove(previous);

		}

		ScriptingScript script = (ScriptingScript) manager.createUnit(ScriptingManager.UNIT_SCRIPT,manager.getUserFolder(),"test_script.py");

		script.save();

		checkFile(manager.getUserFolder(),"test_script.py");

		checkFile(manager.getUserFolder(),"test_script.inf");

		checkScriptDefaultValues(script);

	}

	public void testOpen(){

		testCreation();

		ScriptingScript script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));

		checkScriptDefaultValues(script);

		deleteWorkingFolderContent();

	}

	public void testSave(){

		testCreation();

		ScriptingScript script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));

		script.setName("TestScript");

		script.setDescription("Tests sobre scripts");

		script.setCode("def main():\n  return 'hola mundo'\n");

		script.setCreatedBy("creator");

		script.setVersion("v1.0");

		script.save();

		script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));

		checkScriptNewValues(script);

	}

	public void testRename(){

		testSave();

		ScriptingScript script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));

		Assert.assertFalse(script.rename("test_script"));

		Assert.assertTrue(script.rename("test_script2"));

		script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script2.py"));

		Assert.assertEquals("test_script2", script.getId());

		deleteWorkingFolderContent();

	}

	public void testMove(){

		setWorkingFolder();

		ScriptingFolder folderDestination = (ScriptingFolder) manager.createUnit(ScriptingManager.UNIT_FOLDER,manager.getUserFolder(), "other folder");

		checkFile(manager.getUserFolder(),"other folder");

		ScriptingScript previous = (ScriptingScript) manager.getScript(new File(folderDestination.getFile(),"test_script.py"));

		if (previous!=null){

			folderDestination.remove(previous);

		}

		testSave();

		ScriptingScript script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));	

		script.move(folderDestination);

		System.out.println(script.getParent() + " " + folderDestination);

		Assert.assertEquals(script.getParent(),folderDestination);

		deleteWorkingFolderContent();

	}

	public void testRun() throws NoSuchMethodException{

		testSave();

		ScriptingScript script = (ScriptingScript) manager.getScript(getFile(manager.getUserFolder(),"test_script.py"));		

		Assert.assertEquals("hola mundo", script.run());

		script.setCode("def hola():\n  return 'hola mundo'\n");

		//setMainName

		script.setMainName("hola");

		Assert.assertEquals("hola mundo", script.run());

		//invokeMethod

		//invokeFunction

		Assert.assertEquals("hola mundo", script.invokeFunction("hola", null));

		deleteWorkingFolderContent();

	}

}

#set( $symbol_pound = '#' )

#set( $symbol_dollar = '$' )

#set( $symbol_escape = '\' )

For each class you are going to test, create one Test class with the same

name as the class to test, ending with Test.

For example, the unit tests of the "ExampleLibrary" class are performed

by the "ExampleLibraryTest" class.

#set( $symbol_pound = '#' )

#set( $symbol_dollar = '$' )

#set( $symbol_escape = '\' )

Put into this folder the resources needed by your test classes.

This folder is added to the Tests classpath, so you can load any resources 

through the ClassLoader.

By default, in this folder you can find an example of log4j configuration,

prepared to log messages through the console, so logging works when you

run your tests classes.

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

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<!-- 

Log4J configuration file for unit tests execution.

 -->

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<!-- Appender configuration to show logging messages through the console -->

	<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">

		<layout class="org.apache.log4j.PatternLayout">

			<param name="ConversionPattern" value="%d{HH:mm:ss,SSS} %-5p [%c{2}.%M()]\n  %m%n" />

		</layout>

	</appender>

	<!-- 

	Activate logging messages of DEBUG level of higher only for the

	DefaultExampleManager class.

	You can put full classes names or packages instead, to configure

	logging for all the classes and subpackages of the package.

	-->

	<category name="org.gvsig.scripting.impl.DefaultExampleManager">

		<priority value="DEBUG" />

	</category>

	<!-- 

	By default, show only logging messages of INFO level or higher, 

	through the previously configured CONSOLE appender. 

	-->

	<root>

		<priority value="INFO" />

		<appender-ref ref="CONSOLE" />

	</root>

</log4j:configuration>

package org.gvsig.scripting;

import java.beans.PropertyChangeListener;

import java.io.File;

import java.util.List;

/**

 * <p> Interface that represents the elements used in the ScriptingFramework.</p>

 * 

 * @see ScriptingBaseScript

 * @see ScriptingFolder

 */

public interface ScriptingUnit {

	/**

	 * Returns the ScriptingUnit's ID

	 * 

	 * @return a String containing the ScriptingUnit's ID

	 */

	public String getId();

	/**

	 * Returns the ScriptingUnit's name

	 * 

	 * @return a String containing the ScriptingUnit's name

	 */

	public String getName();

	/**

	 * Returns the ScriptingUnit's description

	 * 

	 * @return a String containing the ScriptingUnit's description

	 */

	public String getDescription();

	/**

	 * Returns information about the ScriptingUnit's creator

	 * 

	 * @return a String containing the ScriptingUnit's creator

	 */

	public String getCreatedBy();

	/**

	 * Returns the ScriptingUnit's version

	 * 

	 * @return a String containing the ScriptingUnit's version

	 */

	public String getVersion();

	/**

	 * Returns the ScriptingUnit's parent

	 * 

	 * @return a {@link ScriptingFolder} where is contained the ScriptingUnit

	 */

	public ScriptingFolder getParent();

	/**

	 * Sets a new name to the ScriptingUnit.

	 *

	 * @param name

	 *            String that contains the new name.

	 */

	public void setName(String name);

	/**

	 * Sets a new description to the ScriptingUnit.

	 *

	 * @param description

	 *            String that contains the new description.

	 */

	public void setDescription(String description);

	/**

	 * Sets a new information about the ScriptingUnit's creator.

	 *

	 * @param createdBy

	 *            String that contains the new creator's information.

	 */

	public void setCreatedBy(String createdBy);

	/**

	 * Sets a new version value to the ScriptingUnit.

	 *

	 * @param version

	 *            String that contains the new version.

	 */

	public void setVersion(String version);

	/**

	 * Changes the ID of a ScriptingUnit and the name of the files and/or directories associated

	 *

	 * @param newId

	 *            String that contains the new Id.

	 *            

	 * @return true if it's succesful, false if not.

	 */

	public boolean rename(String newId);

	public boolean remove();

	/**

	 * Moves a ScriptingUnitfrom the current directory to the new location.

	 *

	 * @param target

	 *            {@link ScriptingFolder} that represents the destination..

	 *            

	 * @return true if it's succesful, false if not.

	 */

	public boolean move(ScriptingFolder target);

	/**

	 * Gets the name of the icons associated to the ScriptingUnit type.

	 *            

	 * @return a String array with the identificators of the icons associated.

	 */

	public String[] getIconNames();

	public String getTypeName();

	/**

	 * Gets a File with the ScriptUnit path name.

	 *

	 * @return a string with the path name of the ScriptUnit (inf/folder).

	 */

	public File getFile();

        /**

         * Return a list of the files that use this unit with out the inf file.

         * @return list of files of the unit.

         */

        public List<File> getFiles();

        public void addPropertyChangeListener(PropertyChangeListener listener);

        /**

         * Sets the unit current status with the saved version.

         *

         * @param saved Indicate if the unit is up-to-date or not.

         */

        public void setSaved(boolean saved);

        /**

         * Indicates if the ScriptBaseScript is modified from last saved version.

         *

         * @return true if current version is up-to-date, false if not.

         */

        public boolean isSaved();        

}

package org.gvsig.scripting;

import java.io.File;

public interface ScriptingExternalFile extends ScriptingUnit {

    public File getExternalFile();

    public String getMimeType();

    public void setContents(String text);

    public String getContentsAsText();

}

package org.gvsig.scripting;

import java.io.File;

import java.net.URL;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import javax.help.HelpSet;

import org.gvsig.tools.task.SimpleTaskStatus;

/**

 * This class is responsable of the management of the Help services provided to

 * the application.

 * It shows all the methods applied to the JavaDocs imported on the

 * ScriptingFramework

 * 

 * @see ScriptingManager

 */

public interface ScriptingHelpManager {

    public URL makeURL(File helpsetfolder, URL sourceurl);

//    /**

//     * Interface that represents each JavaDoc imported to the application

//     * 

//     */

//    public interface ScriptingHelpAPI {

//

//        /**

//         * Gets the JavaDoc's identificator

//         * 

//         * @return a String with the name of the JavaDoc imported identificator

//         */

//        public String getName();

//    }

    /**

     * Interface that represents a class contained on the JavaDocs

     * 

     */

    public interface ScriptingHelpClass extends Comparable {

        /**

         * Gets the name of the class

         * 

         * @return a String with the Class' name

         */

        public String getName();

        /**

         * Gets the URL of the resource that contains the JavaDoc of this class

         * 

         * @return a String with the URL.

         */

        public String getUrl();

        public void addMethod(String name);

        public List<String> getMethods();

    }

    /**

     * Interface that represents a method implemented by a class of the JavaDoc

     * 

     */

    public interface ScriptingHelpMethod extends Iterable<ScriptingHelpClass> {

        /**

         * Gets the method's name

         * 

         * @return a String with the method's name

         */

        public String getName();

        /**

         * Gets an Iterator of the {@link ScriptingHelpClass}es which implements

         * that method

         * 

         */

        @Override

        public Iterator<ScriptingHelpClass> iterator();

    }

//    /**

//     * Returns the folder list of the Help's content

//     * 

//     * @return list of folders

//     */

//    public List<File> getHelpRoots();

//

    /**

     * Gets a List of all the {@link ScriptingHelpMethod}s contained on the

     * JavaDocs

     * 

     * @return a List of the {@link ScriptingHelpMethod}s on all the

     *         {@link ScriptingHelpAPI}s imported

     */

    public List<ScriptingHelpMethod> getMethods();

    public void addMethods(URL methodsfile);

    /**

     * Gets the methods of all the classes includes on the JavaDocs which

     * matches with the text provided

     * 

     * 

     * @param text

     * @return a HashMap with the references founded

     * 

     */

    public Map<String, ScriptingHelpMethod> findMethods(String text);

    /**

     * Returns the HelpSet with the Help information of the JavaDocs registered

     * 

     * @return a HelpSet with the Help content

     */

    public HelpSet getHelpSet();

    /**

     * Reloads the Help information of the JavaDocs

     * 

     */

    public void reloadHelp();

    /**

     * Removes a help module from the application's helpset

     * 

     * @param name

     *            String with the identificator of the module help to remove

     * @return 

     * 

     */

    public boolean removeHelp(String name);

    /**

     * Checks if exists a help module from the application's helpset with the

     * same identificator

     * 

     * @param name

     *            String with the identificator of the module help to check

     * 

     * @return true if exists, false if not

     * 

     */

    public boolean existsHelp(String name);

    /**

     * Adds a new help module to the application's helpset with the

     * identificator specified

     * 

     * @param name

     *            String with the identificator of the module help to add

     * @param javadocFolder

     * @param status

     * @return 

     * 

     */

    public boolean importJavadoc(String name, File javadocFolder,  SimpleTaskStatus status);

    public ScriptingHelpClass getHelpClass(String name);

    public List<ScriptingHelpClass> getHelpClasses();

    public List<File> getHelpRoots();

}

package org.gvsig.scripting;

/**

 * Interface to support the notifications in the application 

 *

 */

public interface ScriptingNotification {

	/**

	 * Gets the type of ScriptingNotification

	 * 

	 * @return An integer with the type.

	 */

	public int getType();

	/**

	 * Gets the ScriptingNotification's id

	 * 

	 * @return a String with the id

	 */

	public String getId();

	/**

	 * Get the {@link ScriptingUnit} which send the notification

	 * 

	 * @return {@link ScriptingUnit

	 */

	public ScriptingUnit getUnit();

	/**

	 * Gets the cause of the ScriptingNotification

	 * 

	 * @return Exception

	 */

	public Exception getException();

}

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.scripting package documentation</title>

</head>

<body>

	<p>TODO: Example library description.</p>

	<p>See the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#packagecomment">Javadoc Tool documentation about the package file</a></p>

</body>

</html>

package org.gvsig.scripting;

import java.io.File;

import java.io.Writer;

import java.net.URL;

import javax.help.HelpSet;

public interface HelpConfig {

    String FILENAME_DOCS = "docs";

    String FILENAME_HELPINDEX = "help-index.xml";

    String FILENAME_HELPMAPPING = "help.jhm";

    String FILENAME_HELPSET = "help.hs";

    String FILENAME_HELPTOC = "help-toc.xml";

    String FILENAME_HELP_CONFIG = "help.cfg";

    String FILENAME_INDEXER_CONFIG = "help-indexer.cfg";

    String FILENAME_SEARCHDB = "searchdb";

    boolean create(File folder, String name);

    boolean create(File folder, String name, File docsFolder);

    boolean create(File folder, File docsFolder);

    HelpSet createHelpSet();

    boolean exists(File folder);

    File getDocsFolder();

    URL getDocsUrl();

    File getFolder();

    File getHelpConfig();

    File getHelpIndex();

    Writer getHelpIndexWriter();

    File getHelpMapping();

    Writer getHelpMappingWriter();

    File getHelpSet();

    Writer getHelpSetWriter();

    File getIndexerConfig();

    ClassLoader getLoader();

    String getName();

    File getSearchdb();

    File getTOC();

    Writer getTOCWriter();

    boolean load(File folder);

}

package org.gvsig.scripting;

import java.io.File;

public class CompileErrorException extends ScriptingErrorException {

	/**

	 * 

	 */

	private static final long serialVersionUID = -7829204331513125285L;

	public CompileErrorException(String msg, File name, int line, int column) {

		super(msg, name, line, column);

	}

	public CompileErrorException(String msg, File name, int line, int column, Throwable cause) {

		this(msg, name, line, column);

		this.initCause(cause);

	}

	public CompileErrorException(String msg, File name, Throwable cause) {

		this(msg, name, -1, -1);

		this.initCause(cause);

	}

}

package org.gvsig.scripting;

import java.io.File;

import java.io.Writer;

import org.gvsig.tools.observer.WeakReferencingObservable;

/**

 * <p>

 * Interface that represents Scripting elements.</p>

 *

 * @see ScriptingUnit

 *

 * @see ScriptingScript

 * @see ScriptingDialog

 * @see ScriptingProject

 */

public interface ScriptingBaseScript extends ScriptingUnit, WeakReferencingObservable {

    public static final int ISOLATION_LOW = 0;

    public static final int ISOLATION_HIGH = 10;

    /**

     * Check if the script execution is enabled.

     *

     * @return if the script is enabled.

     */

    public boolean isEnabled();

    /**

     * Enable or disable the sript execution.

     *

     * @param enabled

     */

    public void setEnabled(boolean enabled);

    /**

     * Executes the code of a ScriptBaseScript.

     *

     * @return

     */

    public Object run();

    /**

     * Executes the code of a ScriptBaseScript.

     *

     * @param args Contains the input parameters to run the ScriptBaseScript.

     * @return

     */

    public Object run(Object args[]);

    /**

     * Executes the code of a ScriptBaseScript in a separated thread

     *

     * @param args Contains the input parameters to run the ScriptBaseScript.

     */

    public void runAsTask(Object args[]);