RFactor(リンク)は Rubyのgemであり、みなさんのお気に入りのテキストエディタ用に、自動化されたリファクタリングのサポートを提供することを目標としている。リファクタリングをサポートしているIDEがあるではないか、と思われるだろう。そうではあるが、RFactorの開発者であるFabio kung氏は「Ruby開発者のほとんどはIDEを使わない」し、テキストエディタで十分であると考えている。
自動化されたリファクタリングは重要なタスクであり、スコープや使用を決定するためのソースコードの解析のような、いくつかの複雑なアクティビティが含まれている。また、ユーザのフォーマットを台無しにすることなくコードを変更するための、優れた戦略をもつことも必要である。
現時点では、RFactorはまだ出来て間もなく、いくつかの制限のついたメソッド抽出のみをサポートしている。我々はRFactorについてよく知るためにFabio Kung氏と話をした。
RFactorはruby_parser (リンク)を利用しており、これは解析したRuby ASTをS式(s-expressions:sexp)として返す。しかし、どのようにしてS式からRubyコードに戻しているのだろうか?
当初は、ただいくつかのリファクタリングをサポートするためだけにsexpを使うことを考えていました。私は、どのようにコードをリファクタリングするかを決定する助けとしてそれらを利用しています。メソッドを抽出する場合、どの変数がローカルとみなすことができ、どれを引数としなければならないのか?変数を抽出する場合は、新たに作成した変数を使用するように変更しなければならないのはどのコードなのか?
コードを生成するために、私はsexpを直接修正してはいません;私のアプローチはソースコードを直接変更するというものでした。sexpは主に、現在のスコープをもとに、どれを変えなければならないかを決める助けとなるものです(そして現在のスコープがどれかを見つけるためのものです)。
何を変更するかを決定するために一度sexpを使ったら、私は行番号と列番号を抽出します。そうして、私はユーザが書いたコードを直接修正することができるのです。
しかし、もしsexpから新しいコードを再生成できるのであれば、もっと簡単になるのではないだろうか?
ruby2ruby(リンク)は、Ryan Davis氏のもう一つの素晴らしいプロジェクトで、sexpからrubyのソースコードを出力します。これを使用することも以前考慮しましたが、コメントやユーザのフォーマットを維持することができないでしょう。
この方法では、コメントやフォーマットノード(たとえば改行、スペース、タブなど)を構文解析木に含めなければならないでしょう。それは確かにひとつの選択肢ですが、はるかに複雑です。そのような理由から、私は行番号と列番号を見つけるためだけにsexpを使うと決め、ソースコードのテキストを直接操作します。
これまでのところは、このアプローチは(私が目標としている)単純なリファクタリングには十分でした。しかし、たとえば移動/名前の変更のようなもっと複雑なリファクタリングには不十分に違いありません。そうしたリファクタリングには異なるアプローチが求められます。名前の変更/移動のケースでは、たとえば、一致する可能性のあるものを探すのにAck(grepを改良したもの)を利用することを考えています。次に、どれを変更したいかユーザに尋ね、変更する場所を提案する際に(sexpに裏打ちされた)発見的方法を用いるでしょう。とても難しいことですが、質のよいIDEには既にこうした機能の優れた実装がなされています。
そうではありますが、私はわざわざ複雑なリファクタリングはしないつもりです;それは目下の私の目標ではないからです。私はTextMateやその類のものを複雑なIDEにしようとしているわけではありません。優れたテキストエディタ用のリファクタリングのサポートはどこにもないのです。まずは簡単なものを作ることに集中しましょう。
それでは、今後の予定は?
これまでのところ、Rfactorは非常にシンプルで、他のメソッド内のコードからメソッドを抽出することができるだけです;すなわち:メソッド外のコードはまだサポートしていません。同様に、メソッドのパラメータや戻り値の推測もしていません。これは私がサポートしたいことの一つです。sexpからはどれをローカル変数にするべきか、することが出来ないかがわかります。他に検討していることは、類似したコードを新たに生成したメソッド呼び出しに置換することです。
また、PythonのBicycle Repair Man(リンク)やEclipse RDT、Smalltalk Refactoring Browser、そして制限の少ないライセンスのもの(Netbeans?RubyMine?)は何でも、実装例を勉強しています。(Bicycle Repair Manの)Phil Dawes氏は既に、私に素晴らしい洞察をもたらしました。
さらなるリファクタリングも計画しています。残念ながら、私はたった一人しかいませんし、ただ楽しむために、自由時間の一部をあててこうしたことを行っています。ほとんどのオープンソースプロジェクトでそうであるように、どんな貢献でも非常にありがたいです。
- メソッドの抽出
- 変数の抽出
- クラスの抽出
- モジュールの抽出
- Ackを使用した名前の変更/移動
RFactorの詳細はGitHub(リンク)やFabio氏のRFactorに関するブログ記事 (リンク)で知ることができる。さらにTextMateのバンドル(リンク)も存在する。
RFactorは、Rubyで書かれたRubyのソースコードツールを持つことに向けた新たな段階にある。その他の例としては静的解析ツールがあり、それらもRubyのASTを得るためにParseTreeあるいはruby_parserを使用している(参考記事)。
もしみなさんがテキストエディタのユーザであれば、リファクタリングのサポートがなくて不自由しているだろうか?自分が使っているエディタに統合して欲しいと思うようなIDEの機能は他にあるだろうか?