module Observable

要約

Observer パターンを提供するモジュールです。

Mix-in により Observer パターンを提供します。

Observable モジュールを include したクラスは Observable#changed メソッドにより更新フラグを立て、 Observable#notify_observers が呼び出されると更新フラグが立っている場合はオブザーバに通知します (オブザーバの update メソッドを呼び出す)。 Observable#notify_observers の引数はそのままオブザーバの update メソッドに渡されます。

サンプルコード

require "observer"

class Ticker          ### Periodically fetch a stock price.
  include Observable

  def initialize(symbol)
    @symbol = symbol
  end

  def run
    last_price = nil
    loop do
      price = Price.fetch(@symbol)
      print "Current price: #{price}\n"
      if price != last_price
        changed                 # notify observers
        last_price = price
        notify_observers(Time.now, price)
      end
      sleep 1
    end
  end
end

class Price           ### A mock class to fetch a stock price (60 - 140).
  def self.fetch(symbol)
    60 + rand(80)
  end
end

class Warner          ### An abstract observer of Ticker objects.
  def initialize(ticker, limit)
    @limit = limit
    ticker.add_observer(self)
  end
end

class WarnLow < Warner
  def update(time, price)       # callback for observer
    if price < @limit
      print "--- #{time.to_s}: Price below #@limit: #{price}\n"
    end
  end
end

class WarnHigh < Warner
  def update(time, price)       # callback for observer
    if price > @limit
      print "+++ #{time.to_s}: Price above #@limit: #{price}\n"
    end
  end
end

ticker = Ticker.new("MSFT")
WarnLow.new(ticker, 80)
WarnHigh.new(ticker, 120)
ticker.run

# => Current price: 126
# => +++ 2017-11-02 12:09:36 +0900: Price above 120: 126
# => Current price: 102
# => Current price: 87
# => Current price: 121

インスタンスメソッド

add_observer(observer, func=:update) -> Array[permalink][rdoc]

オブザーバを登録します。

オブザーバを登録し、登録されているオブザーバのリストを返します。

オブザーバは update メソッドを備えている必要があります。

observer が update メソッドを持たないときは例外 NoMethodError が発生します。

func を指定することで update 以外のメソッドを通知に用いることができます。

[PARAM] observer:: 更新の通知を受けるオブザーバ
[PARAM] func:: 更新の通知をするメソッド
[EXCEPTION] NoMethodError:: updateメソッドを持たないオブジェクトをオブザーバに指定した場合に発生します。

changed(state = true) -> bool[permalink][rdoc]

更新フラグを立てます。

更新フラグを指定された内容へ変更し、変更後の更新フラグの状態を返します。明示的に引数を指定して、更新フラグを初期化することも出来ます。

[PARAM] state:: 更新フラグを立てる場合はtrueを、初期化する場合はfalseを指定します。

changed? -> bool[permalink][rdoc]

更新フラグの状態を返します。

count_observers -> Integer[permalink][rdoc]

登録されているオブザーバの数を返します。

delete_observer(observer) -> object | nil[permalink][rdoc]

オブザーバを削除します。

指定されたオブジェクトがオブザーバとして登録されていた場合は、リストからオブジェクトを削除し、取り除かれたオブジェクトを返します。登録されていなかった場合は、nil を返します。

[PARAM] observer:: 削除するオブザーバ

delete_observers -> Array[permalink][rdoc]

オブザーバをすべて削除します。

登録されているオブザーバのリストから全てのオブジェクトを取り除き、空となったオブザーバのリストを返します。

notify_observers(*arg) -> nil[permalink][rdoc]

オブザーバへ更新を通知します。

更新フラグが立っていた場合は、登録されているオブザーバの update メソッドを順次呼び出します。与えられた引数はその update メソッドに渡されます。与えられた引数の数と登録されているオブザーバのupdate メソッドの引数の数に違いがある場合は例外ArgumentErrorを発生します。全てのオブザーバの update メソッドを呼び出し後、更新フラグを初期化します。

[EXCEPTION] ArgumentError:: 与えられた引数の数と登録されているオブザーバのupdate メソッドの引数の数に違いがある場合に発生します。

module Observable

要約

サンプルコード

目次

インスタンスメソッド