Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 170457

Summary: Proposed Article: Unleashing the Power of Refactorings
Product: Community Reporter: Tobias Widmer <tobias_widmer>
Component: ArticlesAssignee: community.articles-inbox <community.articles-inbox>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 Keywords: plan
Version: unspecified   
Target Milestone: ---   
Hardware: PC   
OS: All   
Whiteboard:
Attachments:
Description Flags
Attachment contains the article, images, and source code
none
mylar/context/zip
none
Revised version of the article none

Description Tobias Widmer CLA 2007-01-15 07:02:46 EST 
For the inaugural issue of the Eclipse Magazine (www.eclipsemag.net), I wrote an article about creating your own refactoring.

Based on a mutual agreement between the editors and me, we decided to publish this article on eclipse.org as well, three months after the initial publication in the Eclipse Magazine.

This is a draft based on the published article.

Title: Unleashing the Power of Refactorings

Subheading: Writing a powerful Eclipse Java refactoring using the Refactoring Language Toolkit

Standfirst: Refactorings as a tool to automate behavior-preserving transformations to source code are not only very popular in agile development environments, but have been widely established as a cornerstone of the daily software development process, regardless of the methodology being used. Most major development environments such as Eclipse offer a set of powerful refactorings to substantially increase development productivity. While built-in refactorings perform most of the tedious and error-prone tasks such as renaming or moving software elements, sometimes the need arises to develop a custom solution to streamline repetitive tasks. It is time to write your own refactoring!
In this article, Tobias Widmer sheds light on the services offered by the Eclipse Java Development Tools (JDT) and the Refactoring Language Toolkit (LTK) to support automated Java refactorings, explains how these services are used by refactorings to perform searches on the Java workspace, rewrite existing code and provide a rich user-interface to present the results of the refactoring. To demonstrate this combination of Java-specific and language-neutral frameworks, this article presents a simple but working refactoring implementation for an ‘Introduce Indirection’ refactoring designed to introduce an indirection method for existing method invocations.
Comment 1 Tobias Widmer CLA 2007-01-15 07:03:35 EST 
Created attachment 56895 [details]
Attachment contains the article, images, and source code
Comment 2 Wayne Beaton CLA 2007-01-18 23:09:36 EST 
I'd like to try and publish this article to Eclipse corner in January.

Are you finished with the content (I assume that, since it has been previously published you are)? If so, I'll start a conversion to HTML next week.

I'll contact the Eclipse Magazine publishers to confirm that they're okay with the article being republished here (just to be nice) and see if they want to stick their logo on it.
Comment 3 Tobias Widmer CLA 2007-01-19 05:07:24 EST 
The content is finished, and needs only be adapted to Eclipse Corner-specific settings.

The editor which I worked together is Dilip Thomas, in case you would like to contact him directly.

We agreed that this article may be published on eclipse.org without any restrictions, so I would like to prefer to publish it under the affilication with IBM. This should be clarified first.
Comment 4 Wayne Beaton CLA 2007-01-19 09:00:07 EST 
I just was thinking of adding a line that states something to the effect of "previously published in Eclipse Magazine". However, I understand that you (or rather IBM) owns the copyright to this article, so ultimately it's up to you.

Are we in agreement that I'll do the first pass of the HTML conversion?
Comment 5 Tobias Widmer CLA 2007-01-19 09:06:00 EST 
Yes, please do so.
Comment 6 Wayne Beaton CLA 2007-01-24 23:28:12 EST 
The HTML conversion is done. Comments welcome.

I'd like to publish this on January 31st.

http://local.eclipse.org/articles/article.php?file=Article-Unleashing-the-Power-of-Refactoring/index.html
Comment 7 Wayne Beaton CLA 2007-01-24 23:28:53 EST 
Created attachment 57492 [details]
mylar/context/zip
Comment 8 Tobias Widmer CLA 2007-01-25 03:27:39 EST 
The link in comment 6 does not work for me
Comment 10 Tobias Widmer CLA 2007-01-25 09:42:28 EST 
There are still a few references to the Eclipse Magazine around. Those should be removed.

Since the target audience has probably shifted a little bit, we should also make a pass over the text to slightly adapt it.
Comment 11 Wayne Beaton CLA 2007-01-25 09:55:42 EST 
I get the impression that some of those references are in the code (I haven't checked). I'll wait on your comment for changes (or a patch) and then do my own pass for Eclipse Magazine references.
Comment 12 Tobias Widmer CLA 2007-01-25 10:00:43 EST 
ok, I'll have a look at it tomorrow. Could you attach the HTML article as well, so that I can provide patches?
Comment 13 Wayne Beaton CLA 2007-01-25 16:02:39 EST 
It's in CVS:

:pserver:anonymous@dev.eclipse.org:/cvsroot/org.eclipse

directory:

www/articles/Article-Unleashing-the-Power-of-Refactoring

I suppose I can post it here as well if you'd like. Let me know.
Comment 14 Tobias Widmer CLA 2007-01-26 12:14:22 EST 
Created attachment 57607 [details]
Revised version of the article

Here is my revised version, which includes minor changes to the text and some changes to namespaces in the code.

The image "figure11.png" has to be retaken on your workspace again, since the colors would not match otherwise.
Comment 15 Wayne Beaton CLA 2007-02-19 16:09:47 EST 
This article has been published. Closing as FIXED.