Refactoring Browser Fixes and Enhancements

Every few months we will release a new version of the Refactoring Browser. This file contains what was added or fixed with each version. Changes in version 2.X of the Browser are here.

Version 3.0.3

Renamed RestrictedEnvironment to SelectorEnvironment and FilteredEnvironment to BrowserEnvironmentWrapper. If you have Smalllint filters, you will need to save the filters to a file and select the "Clear Filters" option from the Smalllint tool, before you'll be able to load the new browser.

Additionally, you will need to execute in VisualWorks:

	| fileName stream rewriter parseTree |

	fileName := 'MyFilename.ig' asFilename.

	rewriter := ParseTreeRewriter new.
	rewriter replace: 'RestrictedEnvironment' with: 'SelectorEnvironment'.
	stream := fileName readStream.
	[parseTree := BRParser parseExpression: stream contents] ensure: [stream close].
	rewriter executeTree: parseTree.
	parseTree := rewriter tree.
	
	stream := fileName writeStream.
	[stream nextPutAll: parseTree formattedCode] ensure: [stream close]

and in VisualAge:

	| fileName stream rewriter parseTree |

	fileName := 'MyFilename.ig'.

	rewriter := ParseTreeRewriter new.
	rewriter replace: 'RestrictedEnvironment' with: 'SelectorEnvironment'.
	stream := CfsReadFileStream open: fileName.
	[parseTree := BRParser parseExpression: stream contents] ensure: [stream close].
	rewriter executeTree: parseTree.
	parseTree := rewriter tree.
	
	stream := CfsWriteFileStream open: fileName.
	[stream nextPutAll: parseTree formattedCode] ensure: [stream close]

Be sure to change the filename before you execute the script.

Refactored BrowserEnvironment by moving methods to other classes (in VisualWorks).
Fixed bug in remove category. It didn't use the change objects so it wasn't undoable.
Refactored Smalllint so that it can be run without any interface. Before it always required either the standard interface or the abort interface.
Refactored the scanner to remove the instance variable flag for saving comments. Comments are always saved. Before, comments weren't saved on rewrite expressions.
Refactored EnvironmentEditor class. The environment: method was renamed to selectedEnvironment:.
Refactored the RefactoringBrowser and Navigator classes. The environment instance variable was moved from the RefactoringBrowser to the Navigator. As a result, the navigator no longer needs/has a reference to the browser.
Added #storeOn: methods to each of the refactorings so that they can easily be stored to a text file. In the future, we will have a package that save the refactorings when they are performed.
Added lint rules for "Contains a return in an ensure: block", "to:do: doesn''t use collect:", and "to:do: loop also increments a counter". See the lint rules page for an explanation.
Renamed instance variable "varName" to "variableName" in VariableRefactoring.
Fixed bug in drag-and-drop. It didn't use change objects so it wasn't undoable.
Removed the ValueHolderInstanceVariable refactoring. This refactoring was added several years ago when people were moving to VisualWorks from ObjectsWorks.
Fixed bug in the various method renaming refactorings that would allow you to change the arguments of a primitive method. You could add/remove/permute the arguments of primitive methods which would cause the primitives to fail.
Fixed bug in ENVY where a DNU would occur if you removed a method that was being viewed from a ClassSelectorNavigator (the one with only class and selector lists). This would happen if you performed the messages not sent from Smalllint and then tried to remove the message.
Fixed bug in ENVY that would try to add class instance variables when undoing a remove class change. Since class instance variables are already defined in the class definition it would try to add them a second time.
Changed the method name dialog so that the OK button is the default button (VisualWorks).
Add a help string to the rewrite rule editor that points to the rewrite rule web page.
Fixed bug in VisualWorks without ENVY that didn't update the changes file when you added/removed a variable.
Fixed bug in ENVY where protocol environments didn't list all their applications if a protocol had two or more applications. This bug is not noticeable unless one spawns a protocol.
Fixed bug in VisualWorks ENVY version that would cause a primitived fail when opening some browser in the vertical navigator mode.

Version 3.0.2

This version did not have any major changes from the previous version.

Re-added support for the VW2.5 w/ ENVY since several people are still using it. However, since I did not receive any mail from people using plain VW2.5, I did not add support for it.
Added two missing methods that had missed being parceled in the VW3.0 version. These missing methods would cause DNU's if you ran Smalllint using the filters or if you searched for "Methods with strings matching".
Fixed #yourself search for VA. VA optimizes #yourself sends like ifTrue:/ifFalse: messages, so a method doesn't know if it sends a yourself message. This would cause the #yourself not used lint rule, to not find anything.

Version 3.0.1

Renamed the valueNowOrOnUnwindDo: message sends for VisualWorks. The new VisualWorks uses and ANSI standard ensure: message. This allows us to remove some of the differences between VisualAge and VisualWorks versions of the browser.
Performed various refactorings including renaming RefactoryBuilder to CompositeRefactoryChange, TempToInstVarRefactoring to TemporaryToInstanceVariableRefactoring, and RenameTempRefactoring to RenameTemporaryRefactoring.
Enhanced the parse tree searching/replacing for the ParseTreeLintRules and TransformationRules. This speeds up the Rewrite tool. It will also speedup some of the lint rules (if they are run individually).
Changed the exception handling in VisualWorks to use the newer 3.0 version of exception handling.
Added ability to set the number of undo's that the browser can perform (see "Set Undo Count" under the "Operations" menu).
Fixed rename class under ENVY. The previous version copied all the attributes from the original class including the instance and class protocols. As a result, you could not version the class after renaming it. The new renaming copies all attributes except for instance and class protocols. If you know of any other attributes that shouldn't be copied, please mail us.
In addition to fixing the attribute copy, the rename class refactoring was also fixed, to make sure that every application that defines an extension to the application is an edition. Previously, it only checked that the defining application was an edition.
Finally, whenever a class is renamed, the refactoring will convert all existing instances to the new class before trying to remove the class. Previously, if there were instances, the remove class would fail.
Fixed bug that could accur when opening a browser. The BrowserCodeTool would add a menu item before all of its submenus were initialized. Under certain circumstances, this menu could be accessed before the submenus were initialized.
Fixed bug in the implementors/senders menu. If a method had an #& message, then it would be taken as the menu's shortcut key.
Changed remove method (in the Navigator) so that if you remove multiple methods, it is treated as a single operation instead of multiple remove method operations. Similarly, remove protocol was also changed.
Fixed the BRProgramNodeVisitor so that it doesn't visit the receiver of a cascaded message multiple times. This caused problems with any transformations that modified a receiver of a cascaded message. For example, if you tried to move a variable to its inner most scope, and its inner most scope was a block that appeared in the receiver of a cascaded message, it would move the variable for each cascaded message. This resulted in multiple definitions of the variable.
Fixed bug in the token positions of elements inside of literal arrays. This didn't cause any problems with the browser itself. However, if you tried to use the parse trees to get the exact positions, then you would have problems with literal arrays.
Changed the ParseTreeRewriter>>#replaceLiteral:with:inToken: to compare literal values by both #= and their class. Previously, it searched for literals that were #==, which didn't work for floating point and string literals.
Changed the browser environments to make them somewhat faster.