イケてないRubyのコードのリファクタリングって奴をSmalltalkでやってみる(sumim版)


件のネタについては Ruby ではすでに言及済みですが、その後 えせはらさんが Smalltalk に書き直すかたちで


というすばらしいエントリーを公開してくださいましたので、触発されて私も二番煎じではありますが、同じ Smalltalk 処理系の Pharo を使ってやってみました。ただバージョンは、先頃リリースされたばかりの 5.0 を使用しました。あとで出てきますが、新機能のサジェスチョンも初めて体験できて面白かったです。


正直このネタに関しては、肝心のリファクタリング自体は冗長な記述をまとめるだけであっさりと終わってしまいそうなので、このエントリーでは本論から少し離れて、その前段階の Rubyリファクタリング対象のコードとそのテストをできるだけ忠実に Pharo Smalltalk で再現して実際にテストを通すまでの作業も少し詳しく書きたいと思います、できればお手元でも Pharo をインストールし、同じ作業を試してみるなどして、Smalltalk 体験のとっかかりとなれば嬉しいです。

▼システムブラウザ(クラスブラウザ)の起動

Pharo を起動すると仮想的なデスクトップが現われるので、このデスクトップに相当する領域でクリック→ポップアップするメニューから System Browser を選択してシステムブラウザ(たんにブラウザ、あるいはクラスブラウザともいう)を起動します。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo01.png

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo02.png


通常、IDE によるサポートがデフォの Smalltalk では、このクラスブラウザを使って既存のクラスやメソッドの閲覧や修正、新規のものの追加を行ないます。

SmalltalkRuby などの通常の言語処理系と大きく違うのは、組み込みクラスはもちろん、コンパイラなど処理系の主要部や IDE それ自体が Smalltalk のオブジェクトで構成され(セルフホスティング)、なおかつ、それらを構成するオブジェクトをオブジェクトストア(簡易OODB。仮想イメージと呼ばれるファイルに適宜保存可能なオブジェクトメモリ)内に生きたまま永続化可能なかたちで存在させ運用しているところです。

したがって Smalltalk において、クラスやメソッドの定義はソースコードの記述というよりは、その場で「クラスやメソッドのオブジェクトを生成してオブジェクトストアに追加する(あるいは差し替える)作業」という感覚であることは、他言語とかなり違います。ここらへんは Smalltalk でこの仕組みを意識しつつ体験しないと実感できないところなので、ぜひ実際に操作してつかんでほしいところです。


▼Order クラスの定義

元の Ruby のコードでは、さくっとこのような定義があります。

class Order < OpenStruct
end

残念ながら Smalltalk には Ruby の OpenStruct のような便利な機構はないので、普通に amount と placed_at をインスタンス変数に持つ Object のサブクラスとして定義します。

いくつか方法はあるのですが、ここでは先ほど起動したクラスブラウザの上段左端の枠内をスクロールして最後にある _UnpackagedPackage を見つけてクリックします。すると、下の枠にクラス定義のテンプレートのようなものが現われるので、その中の #NameOfSubclass を #Order に、instanceVariableNames:キーワードの引数を 'amount placed_at' に、package:キーワードの引数の '_UnpackagedPackage' を 'RubyRefactoring-Example' に変更してから同じ枠内で右クリックメニューから Accept (あるいはキーボードで ctrl + s をタイプ)します。

Object subclass: #Order
	instanceVariableNames: 'amount placed_at'
	classVariableNames: ''
	package: 'RubyRefactoring-Example'

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo03.png


すると、上段左から二番目の枠内に Order が現われ、システムに当該クラスが追加されたことが示されます。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo04.png


引き続き、インスタンス変数 amount と placed_at それぞれのアクセッサーを追加しましょう。

Ruby の attr_accessor 相当のことをすればよいわけですが、ここでも Ruby とは違い Smalltalk では、スクリプト内にアクセッサーの自動生成を処理として記述するのではなく、あらかじめクラスブラウザなどで作業として済ませておく必要があります。

やはりいくつか方法はありますが、ここでは上段左から二番目の枠で Order クラスを(必要なら一度クリックして選択解除した後、改めて)右クリックしてポップアップするメニューから Refactoring → Class Referctoring → Generate Accessor → OK でアクセッサーを自動的に生成、追加します。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo05.png


このタイミングで、次のような「Author Identification」ダイアログが現わて名前の入力を促されることがあります。ここで入力した名前は、システムに改変を加えた編集者名としてメソッド定義等のバージョン管理などをするのに利用されるので適当に入力して OK してやってください。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo06.png


今さらですが、デフォルトでアンダーラインを変数名などに使えるのは、Ruby のコードを移植するときに便利ですね。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo07.png


▼OrdersReport クラスの定義

Orderクラスと同様の操作で、引き続き OrdersReport クラスとそのアクセッサーを定義します。Ruby の定義は次のようなものです。

class OrdersReport
  def initialize(orders, start_date, end_date)
    @orders = orders
    @start_date = start_date
    @end_date = end_date
  end

  def total_sales_within_date_range
    orders_within_range = []
    @orders.each do |order|
      if order.placed_at >= @start_date && order.placed_at <= @end_date
        orders_within_range << order
      end
    end

    sum = 0
    orders_within_range.each do |order|
      sum += order.amount
    end
    sum
  end
end

直前の Orderクラスおよびそのアクセッサーの追加(定義)作業の直後であれば、クラスブラウザの上段左端の枠ではすでに RubyRefactoring-Example パッケージが追加されて選択状態にあるので、今回は package:キーワードの引数はそのままで結構です。(必要なら、Orderクラスをクリックして選択解除してクラス定義のテンプレートを下の枠に呼び出してから)subclass: キーワードの引数を #OrdersReport に、instanceVariableNames: の引数を 'orders start_date end_date' に変更して Accept します。

それぞれのインスタンス変数のアクセッサーも Order 同様に Generate Accessor で自動生成・追加します。

Object subclass: #OrdersReport
	instanceVariableNames: 'orders start_date end_date'
	classVariableNames: ''
	package: 'RubyRefactoring-Example'

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo08.png


OrdersReportクラスには、加えてメインの total_sales_within_date_range メソッドも追加してあげる必要があります。クラスブラウザ上段左から三番目の枠内の accessing プロトコルをクリックして選択すると下にメソッド定義のためのテンプレートが現われるので ctrl + a などで選択後、次のコード(OrdersReport >> より後、total_sales_within_date_range 以下を使用します。以降に出てくるコードも同様です)をコピペ、あるいはタイプして入力して置き換えてください。

OrdersReport >> total_sales_within_date_range
	| orders_within_range sum |
	orders_within_range := OrderedCollection new.
	orders
		do: [ :order | 
			(order placed_at >= start_date and: [ order placed_at <= end_date ])
				ifTrue: [ orders_within_range add: order ] ].
	sum := 0.
	orders_within_range do: [ :order | sum := sum + order amount ].
	^ sum


入力が完了したら、同枠内で右クリック → Accept (コンパイルしてクラスにメソッドを追加。なお、Smalltalk ではコンパイルはメソッドごとにインクリメンタルに行なわれる)します。コンパイルが通ると上段右端の枠内に total_sales_within_date_range が現われ、以降、いつでも当該メソッドのソースコードを読んだり編集したりが可能になります。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo09.png


▼OrdersReportTest クラスの定義

最後に Ruby 版のテストを Pharo Smalltalk に移植します。Ruby では次のようなコードでした。

require 'spec_helper'

describe OrdersReport do
  describe '#total_sales_within_date_range' do
    it 'returns total sales in range' do
      order_within_range1 = Order.new(amount: 5,
                                      placed_at: Date.new(2016, 10, 10))
      order_within_range2 = Order.new(amount: 10,
                                      placed_at: Date.new(2016, 10, 15))
      order_out_of_range = Order.new(amount: 6,
                                     placed_at: Date.new(2016, 1, 1))
      orders = [order_within_range1, order_within_range2, order_out_of_range]

      start_date = Date.new(2016, 10, 1)
      end_date = Date.new(2016, 10, 31)

      expect(OrdersReport.
             new(orders, start_date, end_date).
             total_sales_within_date_range).to eq(15)
    end
  end
end


RSpec のコードですが、こちらも単純に Pharo/Squeak Smalltalk に組み込みの xUnit 系 TestCase を継承した OrdersReportTest クラスに test_total_sales_within_date_range メソッドを定義することで再現とすることにします。

(Order または OrdersReportクラスが選択状態にあるならクリックして選択を解除した状態で)Object を TestCase に、subclass: キーワードの引数を #OrdersReportTest に変更して Accept します。上段左から三番目の枠に OrdersReportTest が現われることを確認してください。

TestCase subclass: #OrdersReportTest
	instanceVariableNames: ''
	classVariableNames: ''
	package: 'RubyRefactoring-Example'

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo10.png


このクラスにはインスタンス変数はないのでアクセッサーの自動生成作業は不要です。あとはテストメソッド test_returns_total_sales_in_range を追加します。

まず、上段左から三番目の枠の no message を選択して下の枠にメソッド定義のテンプレートを呼び出します。下の枠内で ctrl + a でテンプレート全選択後、次のコードに置き換えてから Accept してコンパイルを完了します。

OrdersReportTest >> test_returns_total_sales_in_range
	| order_within_range1 order_within_range2 order_out_of_range orders start_date end_date |
	order_within_range1 := Order new amount: 5; placed_at: (Date year: 2016 month: 10 day: 10).
	order_within_range2 := Order new amount: 10; placed_at: (Date year: 2016 month: 10 day: 15).
	order_out_of_range := Order new amount: 6; placed_at: (Date year: 2016 month: 1 day: 1).
	orders := {order_within_range1. order_within_range2. order_out_of_range}.
	start_date := Date year: 2016 month: 10 day: 1.
	end_date := Date year: 2016 month: 10 day: 31.
	self
		assert:
			(OrdersReport new orders: orders; start_date: start_date; end_date: end_date)
				total_sales_within_date_range
		equals: 15

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo11.png


▼テストの実行

上段左から二番目の枠でテストクラス OrdersReportTest を、あるいは上段右端の枠で実行したいテストメソッド test_returns_total_sales_in_range を(必要ならクリックして選択解除後、改めて)右クリックしてポップアップメニューから Run tests を選ぶとテストが走ります。上記の作業がうまく終わっていればグリーンが左下に現われるはずです。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo12.png


リファクタリング1: a >= b and: [a <= c] の代わりに a between: b and: c を使いましょう

ようやく本題です。と、意気込みたいところですが、ここまででほぼ力尽きたので以下はあっさり目に。^^;


リファクタリングの例題ということで、あえてそうしているのでしょうが、とにかく total_sales_within_date_range というメソッドの記述内容は冗長で手続き的です。SmalltalkRubyRails に元から備わっている API をあえて無視して書かれているだけ、という言い方もできます。裏を返せば、SmalltalkRubyRails をちゃんと使えば読み下しやすくすっきり書けるということです。

まず、Pharo 5.0 から導入された下段の枠に表示されるコードのサジェスチョンに従った変更をしてみます。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo13.png


最初の "a >= b and: [a <= c]" -> "a between: b and: c" というのは特には説明は不要かと思います。Ruby にも between? がありますね。

このサジェスチョンの脇の?と×の間には「Automatically resolve the issue」ボタンが用意されているので、これを押して自動で処理してもらいましょう。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo14.png

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo15.png

OrdersReport >> total_sales_within_date_range
	| orders_within_range sum |
	orders_within_range := OrderedCollection new.
	orders
		do: [ :order | 
			(order placed_at between: start_date and: end_date)
				ifTrue: [ orders_within_range add: order ] ].
	sum := 0.
	orders_within_range do: [ :order | sum := sum + order amount ].
	^ sum


テストももちろん通ります。以後、OrdersReportTest と OrdersReport を行き来するのは面倒なので、OrdersReport を右クリックして Browse full してクラスブラウザを2つ開いておくと total_sales_within_date_range を書き換えた後のテストが楽になるのでお薦めです。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo16.png


あるいは、ブラウザ右上の Go back、Go foward ボタンを使って行き来するのでもよいでしょう。


リファクタリング2: do: の代わりに select: や collect: を使いましょう

こちらも Pharo からのサジェスチョンのひとつなのですが、慣れていないとちょっとイメージしにくいですね。条件に合致したものをあらかじめ用意した追加可能なコレクション(この場合 an OrderedCollection)に加えていくという処理は select:(条件に合致したものを排除するなら reject:)を使った処理に置き換えられます。

OrdersReport >> total_sales_within_date_range
	| orders_within_range sum |
	orders_within_range := orders
		select: [ :order | order placed_at between: start_date and: end_date ].
	sum := 0.
	orders_within_range do: [ :order | sum := sum + order amount ].
	^ sum

リファクタリング3: sum := 0. colln do: [:x | sum := sum + x ]. ^sum は inject:into: に置き換えましょう

上の select: と考え方は似ていますが、こちらはいわゆる畳み込み処理です。Smalltalk の inject:into: は Ruby の inject に相当し、第一引数として初期値を与え、それと最初の要素との何かしらの演算をし(二引数のブロックで与えられる)を次の要素との同じ演算処理に受け渡す処理を表現するのに用います。

件のコードでも sum に初期値 0 を与え、ループを回して sum に足し込んでいく様子は、inject:into: のターゲットとなる処理の代表格です。

OrdersReport >> total_sales_within_date_range
	| orders_within_range sum |
	orders_within_range := orders
		select: [ :order | order placed_at between: start_date and: end_date ].
	^ orders_within_range inject: 0 into: [ :sum :order | sum + order amount ]

リファクタリング4a: orders_within_range の amount の sum であることが分かる記述にする(その1)

当初の冗長さから比べればだいぶ簡潔になったのですが、inject:into: というのは select: などに比べると、読み下しのしやすさという意味からはちょっと弱いです。ここはやはり、orders_within_range の amount の sum を欲していることがわかる記述にしたいところです。

ひとつの解決策としては、組み込みの select:thenCollect: を使う方法です。

OrdersReport >> total_sales_within_date_range
	^ (orders
		select: [ :order | order placed_at between: start_date and: end_date ]
		thenCollect: #amount) sum


select:thenCollect: は読んで字の通り、select:キーワードの引数(つまり第一引数)のブロックの処理に合致する要素を選び、さらにそれらについて thenCollect:キーワードの引数(同じく第二引数)のブロックの処理をした値を集めたコレクションを返します。

なお、Squeak/Pharo では、ブロックで記述する処理が要素に対する単項メッセージ(引数を取らないメッセージ)の場合、そのメッセージのセレクタ(メソッド名。実体はシンボル)で代替可能です。この例では [:order | order amount] は #amount に置き換え可能であることをさします。


ただこの select:thenCollect: には問題があって、それは、select:thenCollect: の実装が素朴に select: した結果を collect: しているだけで工夫がないため、ひとつ前のリファクタリング前のコードより、無駄なコレクションを作成するコストがかかってしまうことです。


リファクタリング4b: orders_within_range の amount の sum であることが分かる記述にする(その2)

コストの問題を解決するには、inject:into: の sum に特化したエイリアスを定義する方法があります。具体的には Ruby2.4 以降の sum のように、ブロックを引数として取ることができるようにすればよいでしょう。inject:into: と同じ Collection に次の sumOf: メソッドを生やしてやります。


まず念のため inject:into: がどこに定義されているのかを調べます。文字を入力できる場所ならどこでもいいのでその中の(たとえば total_sales_within_date_range のコード入力枠の)空行におもむろに inject:into: とタイプして入力し、ctrl + m(あるいは右クリックメニューから Code search... → Implemnetors of it を選択)します。すると開いたウインドウの上のリスト枠から inject:into: が Collection と LayoutCell というふたつのクラスに定義され、Collection での定義が下のペインに呼び出されます。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo17.png


ここで、下のペインの inject:into: の定義を ctrl + a などの操作で全選択し、次のコードに置き換えたあと Accept (コンパイル)します。なお、クラスブラウザでのコード編集はメソッド名が変われば別のメソッドの追加と解釈されるので、こうした操作で inject:into: が sumOf: に置き換えられてしまう心配はありません。

Collection >> sumOf: block
	^ self inject: 0 into: [ :sum :each | sum + (block value: each) ]

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo18.png


あと、このままですと RubyRefactoring-Example パッケージをソースコード単位で扱うとき(たとえば File Out して別の仮想イメージに Load 等した場合)に sumOf: が追加されず困るので、RubyRefactoring-Example パッケージに含めておくのがよいと思います。操作は、sumOf: を選択して右クリック→ Code search... → implementors of it → Browse → 上段右端の枠で sumOf: を右クリック→ Move to package... → RubyRefactoring-Example を選択 → OK です。


以降はこの sumOf: が使えるので、total_sales_within_date_range も次のように書き換えます。

OrdersReport >> total_sales_within_date_range
	^ (orders select: [ :order | order placed_at between: start_date and: end_date ])
		sumOf: #amount


いかがでしょう。指定した期間内の order の amount の sum であることが分かりやすくなったのではないでしょうか。当初のコードと比べると一目瞭然です。

OrdersReport >> total_sales_within_date_range
	| orders_within_range sum |
	orders_within_range := OrderedCollection new.
	orders
		do: [ :order | 
			(order placed_at >= start_date and: [ order placed_at <= end_date ])
				ifTrue: [ orders_within_range add: order ] ].
	sum := 0.
	orders_within_range do: [ :order | sum := sum + order amount ].
	^ sum


なお、クラスブラウザの上段右端の枠内の total_sales_within_date_range を右クリック→ Versions で、リファクタリングしたコードの変遷をたどることができます。

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo19.png

http://squab.no-ip.com/collab/uploads/RubyRefactoringPharo20.png


Smalltalk は環境それ自体がオブジェクトストアのような性格を有していることを利用して、このようなメソッド単位でバージョン管理が可能な SCM 機構が 1980年代から組み込まれて利用されてきています。他にもいろいろと興味深いしくみがあるので、他言語ユーザーの皆さんも、処理系や IDE 等の環境が Smalltalk でどのように実現されているか、ぜひオブジェクトのスープの中に飛び込んで異世界を愉しんでみてください。