ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ste...@apache.org
Subject cvs commit: ant build.xml
Date Sun, 16 Jan 2005 23:37:52 GMT
stevel      2005/01/16 15:37:52

  Modified:    src/main/org/apache/tools/ant/types/optional
                        ScriptFilter.java
               src/main/org/apache/tools/ant/util ScriptRunner.java
               src/main/org/apache/tools/ant/types defaults.properties
               src/main/org/apache/tools/ant/taskdefs/optional Script.java
               docs/manual/CoreTypes selectors.html
               .        build.xml
  Added:       src/testcases/org/apache/tools/ant/types/optional
                        ScriptSelectorTest.java
               src/main/org/apache/tools/ant/types/optional
                        ScriptSelector.java
               src/etc/testcases/types/selectors scriptselector.xml
  Log:
  Adding scripting support to selectors. No personal need for this right now, just rounding
off what you can now do with mappers via filterchains
  
  Revision  Changes    Path
  1.1                  ant/src/testcases/org/apache/tools/ant/types/optional/ScriptSelectorTest.java
  
  Index: ScriptSelectorTest.java
  ===================================================================
  /*
   * Copyright  2005 The Apache Software Foundation
   *
   *  Licensed under the Apache License, Version 2.0 (the "License");
   *  you may not use this file except in compliance with the License.
   *  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing, software
   *  distributed under the License is distributed on an "AS IS" BASIS,
   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   *  See the License for the specific language governing permissions and
   *  limitations under the License.
   *
   */
  package org.apache.tools.ant.types.optional;
  
  import org.apache.tools.ant.BuildFileTest;
  
  /**
   * Test that scripting selection works. Needs scripting support to work
   */
  public class ScriptSelectorTest extends BuildFileTest {
  
  
      public ScriptSelectorTest(String name) {
          super(name);
      }
  
      public void setUp() {
          configureProject("src/etc/testcases/types/selectors/scriptselector.xml");
      }
  
      public void testNolanguage() {
          expectBuildExceptionContaining("testNolanguage",
                  "Absence of language attribute not detected",
                  "script language must be specified");
      }
  
      public void testSelectionSetByDefault() {
          executeTarget("testSelectionSetByDefault");
      }
      public void testSelectionSetWorks() {
          executeTarget("testSelectionSetWorks");
      }
      public void testSelectionClearWorks() {
          executeTarget("testSelectionClearWorks");
      }
      public void testFilenameAttribute() {
          executeTarget("testFilenameAttribute");
      }
      public void testFileAttribute() {
          executeTarget("testFileAttribute");
      }
      public void testBasedirAttribute() {
          executeTarget("testBasedirAttribute");
      }
  
  }
  
  
  
  1.11      +2 -9      ant/src/main/org/apache/tools/ant/types/optional/ScriptFilter.java
  
  Index: ScriptFilter.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/types/optional/ScriptFilter.java,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- ScriptFilter.java	9 Mar 2004 16:48:43 -0000	1.10
  +++ ScriptFilter.java	16 Jan 2005 23:37:51 -0000	1.11
  @@ -1,5 +1,5 @@
   /*
  - * Copyright  2003-2004 The Apache Software Foundation
  + * Copyright  2003-2005 The Apache Software Foundation
    *
    *  Licensed under the Apache License, Version 2.0 (the "License");
    *  you may not use this file except in compliance with the License.
  @@ -60,14 +60,7 @@
               return;
           }
           initialized = true;
  -
  -        runner.addBeans(getProject().getProperties());
  -        runner.addBeans(getProject().getUserProperties());
  -        runner.addBeans(getProject().getTargets());
  -        runner.addBeans(getProject().getReferences());
  -
  -        runner.addBean("project", getProject());
  -        runner.addBean("self", this);
  +        runner.bindToComponent(this);
       }
   
       /**
  
  
  
  1.1                  ant/src/main/org/apache/tools/ant/types/optional/ScriptSelector.java
  
  Index: ScriptSelector.java
  ===================================================================
  /*
   * Copyright  2005 The Apache Software Foundation
   *
   *  Licensed under the Apache License, Version 2.0 (the "License");
   *  you may not use this file except in compliance with the License.
   *  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing, software
   *  distributed under the License is distributed on an "AS IS" BASIS,
   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   *  See the License for the specific language governing permissions and
   *  limitations under the License.
   *
   */
  package org.apache.tools.ant.types.optional;
  
  import org.apache.tools.ant.types.selectors.BaseSelector;
  import org.apache.tools.ant.util.ScriptRunner;
  import org.apache.tools.ant.BuildException;
  
  import java.io.File;
  
  /**
   * Selector that lets you run a script with selection logic inline
   * @since Ant1.7
   */
  public class ScriptSelector extends BaseSelector {
  
      /**
       * Has this object been initialized ?
       */
      private boolean initialized = false;
  
      /**
       * script runner
       */
      private ScriptRunner runner = new ScriptRunner();
  
      /**
       * fields updated for every selection
       */
      private File basedir;
      private String filename;
      private File file;
  
      /**
       * selected flag
       */
      private boolean selected;
  
      /**
       * Defines the language (required).
       *
       * @param language the scripting language name for the script.
       */
      public void setLanguage(String language) {
          runner.setLanguage(language);
      }
  
      /**
       * Initialize on demand.
       *
       * @throws org.apache.tools.ant.BuildException
       *          if someting goes wrong
       */
      private void init() throws BuildException {
          if (initialized) {
              return;
          }
          initialized = true;
          runner.bindToComponent(this);
      }
  
  
      /**
       * Load the script from an external file ; optional.
       *
       * @param file the file containing the script source.
       */
      public void setSrc(File file) {
          runner.setSrc(file);
      }
  
      /**
       * The script text.
       *
       * @param text a component of the script text to be added.
       */
      public void addText(String text) {
          runner.addText(text);
      }
  
      /**
       * Method that each selector will implement to create their selection
       * behaviour. If there is a problem with the setup of a selector, it can
       * throw a BuildException to indicate the problem.
       *
       * @param basedir  A java.io.File object for the base directory
       * @param filename The name of the file to check
       * @param file     A File object for this filename
       *
       * @return whether the file should be selected or not
       */
      public boolean isSelected(File basedir, String filename, File file) {
          init();
          setSelected(true);
          this.file=file;
          this.basedir=basedir;
          this.filename=filename;
          runner.addBean("basedir", basedir);
          runner.addBean("filename", filename);
          runner.addBean("file", file);
          runner.executeScript("<ANT-Selector>");
          return isSelected();
      }
  
  
      /**
       * get the base directory
       * @return
       */
      public File getBasedir() {
          return basedir;
      }
  
      /**
       * get the filename of the file
       * @return
       */
      public String getFilename() {
          return filename;
      }
  
      /**
       * get the file that is currently to be tested
       * @return
       */
      public File getFile() {
          return file;
      }
  
      /**
       * get state of selected flag
       * @return
       */
      public boolean isSelected() {
          return selected;
      }
  
      /**
       * set the selected state
       * Intended for script use, not as an Ant attribute
       * @param selected
       */
      public void setSelected(boolean selected) {
          this.selected = selected;
      }
  
  }
  
  
  
  1.1                  ant/src/etc/testcases/types/selectors/scriptselector.xml
  
  Index: scriptselector.xml
  ===================================================================
  <project name="scriptselector" default="def" basedir=".">
  
    <property name="src.file" location="${ant.file}" />
    
    <macrodef name="testselected">
      <element name="selector" implicit="yes" optional="true"/>
      <attribute name="message"/>
      <sequential>
        <fail message="@{message} failed: file was not selected">
          <condition>
            <not>
              <isfileselected file="{src.file}">
                <selector/>
              </isfileselected>
            </not>
          </condition>
        </fail>
      </sequential>
    </macrodef>  
    
    <macrodef name="testnoselected">
      <element name="selector" implicit="yes" optional="true"/>
      <attribute name="message"/>
      <sequential>
        <fail message="@{message} failed: file was selected">
          <condition>
            <isfileselected file="{src.file}">
              <selector/>
            </isfileselected>
          </condition>
        </fail>
      </sequential>
    </macrodef>    
  
    <!-- this is here to test the macro is well coded -->
    <target name="testNoSelector">
      <testselected message="testNoSelector" >
      </testselected>
    </target>
  
    <target name="testNolanguage">
      <testselected message="testNolanguage" >
        <selector>
          <scriptselector >
            self.setSelected(true);
          </scriptselector>
        </selector>
      </testselected>
      <scriptdef name="nolang">
      </scriptdef>
    </target>
  
    <target name="testSelectionSetByDefault">
      <testselected message="testSelectionSetByDefault" >
        <selector>
          <scriptselector language="javascript">
          </scriptselector>
        </selector>
      </testselected>
    </target>
  
  
    <target name="testSelectionSetWorks">
      <testselected message="testSelectionSetWorks" >
        <selector>
          <scriptselector language="javascript">
            self.setSelected(false);
            self.setSelected(true);
          </scriptselector>
        </selector>
      </testselected>
    </target>
  
    <target name="testSelectionClearWorks">
      <testnoselected message="testSelectionClearWorks">
        <selector>
          <scriptselector language="javascript">
            self.setSelected(false);
          </scriptselector>
        </selector>
      </testnoselected>
    </target>
    
    <target name="testFileAttribute">
      <testselected message="testFileAttribute" >
        <selector>
          <scriptselector language="javascript">
            self.setSelected(file.equals(self.getFile()));
          </scriptselector>
        </selector>
      </testselected>
    </target>  
  
    <target name="testFilenameAttribute">
      <testselected message="testFilenameAttribute" >
        <selector>
          <scriptselector language="javascript">
            self.setSelected(filename.equals(self.getFilename()));
          </scriptselector>
        </selector>
      </testselected>
    </target>    
    
    <target name="testBasedirAttribute">
      <testselected message="testBasedirAttribute" >
        <selector>
          <scriptselector language="javascript">
            self.setSelected(basedir.equals(self.getBasedir()));
          </scriptselector>
        </selector>
      </testselected>
    </target>
    
    <target name="notestFilenameLength">
      <testselected message="notestFilenameLength" >
        <selector>
          <scriptselector language="javascript">
            self.setSelected((filename.length%2)==0);
          </scriptselector>
        </selector>
      </testselected>
    </target>    
  </project>
  
  
  
  1.9       +20 -1     ant/src/main/org/apache/tools/ant/util/ScriptRunner.java
  
  Index: ScriptRunner.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/util/ScriptRunner.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- ScriptRunner.java	9 Mar 2004 16:48:52 -0000	1.8
  +++ ScriptRunner.java	16 Jan 2005 23:37:51 -0000	1.9
  @@ -1,5 +1,5 @@
   /*
  - * Copyright  2003-2004 The Apache Software Foundation
  + * Copyright  2003-2005 The Apache Software Foundation
    *
    *  Licensed under the Apache License, Version 2.0 (the "License");
    *  you may not use this file except in compliance with the License.
  @@ -22,6 +22,9 @@
   import org.apache.bsf.BSFException;
   import org.apache.bsf.BSFManager;
   import org.apache.tools.ant.BuildException;
  +import org.apache.tools.ant.ProjectComponent;
  +import org.apache.tools.ant.Project;
  +
   import java.util.Map;
   import java.util.HashMap;
   import java.util.Iterator;
  @@ -189,5 +192,21 @@
        */
       public void addText(String text) {
           this.script += text;
  +    }
  +
  +    /**
  +     * Bind the runner to a project component.
  +     * Properties, targets and references are all added as beans;
  +     * project is bound to project, and self to the component.
  +     * @param component to become <code>self</code>
  +     */
  +    public void bindToComponent(ProjectComponent component) {
  +        Project project=component.getProject();
  +        addBeans(project.getProperties());
  +        addBeans(project.getUserProperties());
  +        addBeans(project.getTargets());
  +        addBeans(project.getReferences());
  +        addBean("project", project);
  +        addBean("self", component);
       }
   }
  
  
  
  1.34      +1 -0      ant/src/main/org/apache/tools/ant/types/defaults.properties
  
  Index: defaults.properties
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/types/defaults.properties,v
  retrieving revision 1.33
  retrieving revision 1.34
  diff -u -r1.33 -r1.34
  --- defaults.properties	17 Dec 2004 13:39:45 -0000	1.33
  +++ defaults.properties	16 Jan 2005 23:37:51 -0000	1.34
  @@ -39,3 +39,4 @@
   isfileselected=org.apache.tools.ant.taskdefs.condition.IsFileSelected
   ispingable=org.apache.tools.ant.taskdefs.optional.condition.IsPingable
   mavenrepository=org.apache.tools.ant.taskdefs.repository.MavenRepository
  +scriptselector=org.apache.tools.ant.types.optional.ScriptSelector
  
  
  
  1.31      +1 -7      ant/src/main/org/apache/tools/ant/taskdefs/optional/Script.java
  
  Index: Script.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/Script.java,v
  retrieving revision 1.30
  retrieving revision 1.31
  diff -u -r1.30 -r1.31
  --- Script.java	9 Mar 2004 16:48:15 -0000	1.30
  +++ Script.java	16 Jan 2005 23:37:51 -0000	1.31
  @@ -49,13 +49,7 @@
               runner.addText(text);
           }
   
  -        runner.addBeans(getProject().getProperties());
  -        runner.addBeans(getProject().getUserProperties());
  -        runner.addBeans(getProject().getTargets());
  -        runner.addBeans(getProject().getReferences());
  -
  -        runner.addBean("project", getProject());
  -        runner.addBean("self", this);
  +        runner.bindToComponent(this);
   
           runner.executeScript("ANT");
       }
  
  
  
  1.31      +125 -0    ant/docs/manual/CoreTypes/selectors.html
  
  Index: selectors.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/CoreTypes/selectors.html,v
  retrieving revision 1.30
  retrieving revision 1.31
  diff -u -r1.30 -r1.31
  --- selectors.html	13 Jan 2005 23:09:32 -0000	1.30
  +++ selectors.html	16 Jan 2005 23:37:51 -0000	1.31
  @@ -927,7 +927,132 @@
           </tr>
         </table>
   
  +      <a name="scriptselector"></a>
  +      <h4>Script Selector</h4>
   
  +      <p>
  +        The <code>&lt;scriptselector&gt;</code> element enables you

  +        to write a complex selection algorithm in any
  +        <a href="http://jakarta.apache.org/bsf" target="_top">Apache BSF</a>
  +        supported language.</p>
  +        See the <a href="../OptionalTasks/script.html">Script</a> task for
  +        an explanation of scripts and dependencies.
  +      </p>
  +      <p>
  +        This selector was added in Apache Ant 1.7.
  +      </p>
  +      <table border="1" cellpadding="2" cellspacing="0">
  +        <tr>
  +          <td valign="top"><b>Attribute</b></td>
  +          <td valign="top"><b>Description</b></td>
  +          <td align="center" valign="top"><b>Required</b></td>
  +        </tr>
  +        <tr>
  +          <td valign="top">language</td>
  +          <td valign="top">language of the script.</td>
  +          <td valign="top" align="center">yes</td>
  +        </tr>
  +        <tr>
  +          <td valign="top">src</td>
  +          <td valign="top">filename of the script</td>
  +          <td valign="top" align="center">no</td>
  +        </tr>
  +      </table>      
  +      <p>
  +      If no <code>src</code> attribute is supplied, the script must be nested
  +      inside the selector declaration. 
  +      </p>
  +      <p>The embedded script is invoked for every test, with
  +         the bean <code>self</code> 
  +        is bound to the selector. It has an attribute <code>selected</code>
  +        must can be set using <code>setSelected(boolean)</code> to select that
  +        file.
  +         
  +      <p>
  +      
  +      The following beans are configured for every script, alongside
  +      the classic set of project, properties, and targets.
  +      
  +      <table border="1" cellpadding="2" cellspacing="0">
  +        <tr>
  +          <td valign="top"><b>Bean</b></td>
  +          <td valign="top"><b>Description</b></td>
  +          <td valign="top"><b>Type</b></td>
  +        </tr>
  +        <tr>
  +          <td valign="top">self</td>
  +          <td valign="top">selector instance</td>
  +          <td valign="top">org.apache.tools.ant.types.optional</td>
  +        </tr>
  +        <tr>
  +          <td valign="top">filename</td>
  +          <td valign="top">filename of the selection</td>
  +          <td valign="top" >String</td>
  +        </tr>
  +        <tr>
  +          <td valign="top">file</td>
  +          <td valign="top">file of the selection</td>
  +          <td valign="top" >java.io.File</td>
  +        </tr>
  +        <tr>
  +          <td valign="top">basedir</td>
  +          <td valign="top">Fileset base directory</td>
  +          <td valign="top" >java.io.File</td>
  +        </tr>
  +        
  +      </table>       
  +      <p>
  +      The <code>self</code> bean maps to the selector, which has the following
  +      attributes. Only the <code>selected</code> flag is writeable, the rest

  +      are read only via their getter methods.
  +      
  +            <table border="1" cellpadding="2" cellspacing="0">
  +        <tr>
  +          <td valign="top"><b>Attribute</b></td>
  +          <td valign="top"><b>Description</b></td>
  +          <td align="center" valign="top"><b>Type</b></td>
  +        </tr>
  +        <tr>
  +          <td valign="top">selected</td>
  +          <td valign="top">writeable flag to select this file</td>
  +          <td valign="top" align="center">boolean</td>
  +        </tr>
  +        <tr>
  +          <td valign="top">filename</td>
  +          <td valign="top">filename of the selection</td>
  +          <td valign="top" >String</td>
  +        </tr>
  +        <tr>
  +          <td valign="top">file</td>
  +          <td valign="top">file of the selection</td>
  +          <td valign="top" >java.io.File</td>
  +        </tr>
  +        <tr>
  +          <td valign="top">basedir</td>
  +          <td valign="top">Fileset base directory</td>
  +          <td valign="top" >java.io.File</td>
  +        </tr>
  +      </table>
  +      
  +      <p>
  +      Example
  +      </p>
  +<pre>
  +    &lt;scriptselector language=&quot;javascript&quot;&gt;
  +      self.setSelected(true);
  +    &lt;/scriptselector&gt;
  +</pre>
  +    <p>
  +    Selects every file.
  +    </p>
  +
  +<pre>
  +    &lt;scriptselector language=&quot;javascript&quot;&gt;
  +      self.setSelected((filename.length%2)==0);
  +    &lt;/scriptselector&gt;
  +</pre>
  +Select files whose filename length is even.
  +      
       <a name="selectcontainers"></a>
       <h3>Selector Containers</h3>
   
  
  
  
  1.448     +4 -0      ant/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/ant/build.xml,v
  retrieving revision 1.447
  retrieving revision 1.448
  diff -u -r1.447 -r1.448
  --- build.xml	13 Jan 2005 09:01:58 -0000	1.447
  +++ build.xml	16 Jan 2005 23:37:51 -0000	1.448
  @@ -1537,6 +1537,10 @@
                      unless="bsf.present"/>
             <exclude name="${optional.package}/BeanShellScriptTest.java"
                      unless="beanshell.present"/>
  +          <exclude name="${optional.type.package}/Script/*.java"
  +                   unless="bsf.present"/>
  +          <exclude name="${optional.type.package}/Script/*.java"
  +                   unless="rhino.present"/>
   
             <!-- fail if testcases can be loaded from the system classloader -->
             <exclude name="${ant.package}/AntClassLoaderDelegationTest.java"
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


Mime
View raw message