Jump to: navigation, search

Difference between revisions of "Ant/Ant buildfile refactorings"

< Ant
m (List of Ideas for this summer (taken from eclipse bug db))
m (List of Ideas for this summer (taken from eclipse bug db))
Line 60: Line 60:
 
   <echo message="Hello World"/>
 
   <echo message="Hello World"/>
 
</source>
 
</source>
 +
 
   converted to
 
   converted to
 +
 
<source lang="xml">
 
<source lang="xml">
 
   <property name="msg" value="Hello World"/>
 
   <property name="msg" value="Hello World"/>

Revision as of 12:12, 23 May 2009

Ant buildfile refactorings
Possible mentors: Darin Swanson
Related Project: Platform Ant
Description: Ant buildfiles can become large and complex and would benefit from refactoring. Currently there is no support beyond renaming within a buildfile to allow the developer to efficiently refactor Ant buildfiles. The goals would be to implement an infrastructure to support refactorings in Ant buildfiles, participate in other components refactorings and provide a starter set of Ant buildfile refactorings.
Further information

Abstract

Of course, eclipse supports ant. But now, in modern project ant build files became too difficult to maintaine and refactor. Goal of this project - to implement an infrastructure to support refactorings for ant files, provide more clear and visual tool for working with ant tasks ant targets.


List of Ideas for this summer (taken from eclipse bug db)

1. Something like "extract method" - You select one task and could generate a <presetdef>. - You select multiple tasks and could generate a <macrodef>. - You select a <script> and could generate a <scriptdef>. (2) could be used inside

2. Introduce attributes (see "introduce parameters" on methods)

<macrodef name="foo">
    <sequential>
        <echo message="Hello World"/>
    </sequential>
</macrodef>
<foo/>

would be

<macrodef name="foo">
    <attribute name="msg"/>
    <sequential>
        <echo message="@{msg}"/>
    </sequential>
</macrodef>
<foo msg="Hello World"/>

3. Convert <presetdef> to <macrodef> Rename <presetdef> to <macrodef> and include the <sequential> container.

4. Rename - rename of properties (dont know if it works already) - definitions by <*def>

 -- change the value in the name-attribute
 -- change the value in "tasks"
 -- example (from 2):
    foo --> myecho
    --- <macrodef name="myecho">...
    --- <myecho msg="...

5. Extract property - Select an attribute value and it will introduce a property with that value.

  <echo message="Hello World"/>
 converted to
  <property name="msg" value="Hello World"/>
  <echo message="${msg}"/>

6. Property bundle (see I18N-stuff) - gives a list with all properties - you select the properties to put into the new build.properties file - build.properties will be created and load into the build file

7. Pull up / push down In Java code this means moving between a class and it`s parent. Here it would move between the actual buildfile and an <import>ed one. Could also be done with Drag&Drop in the Outline View (drag target on <import>) or Package Explorer.


For future period

If all previous ideas would been realized, I`m planning extend them with ant dependency grafic representation.