ModelやURIをいい感じに開くイベントを提供して、Modelの種類を呼び出し側が考えずに開くことができるようにする

動機¶

今は似たような機能をGtk::Timelineが担当していて（！？）、URLを開くときに、特定の画像サービスの正規表現にURLがマッチしたらそれで開くという挙動を実現している。

今Gtkプラグインに実装されている方法だと、開く手段が複数ある場合に対応できていない。 #862 カスタムEntity、 #834 マルチサービスといったものが実装されると、パーマリンク、URIがリソースを特定するために広く使われるようになるため、あるURLを開く手段が複数提供されるようなケースが出てくると思う。

さらに、開く方法も Gtk::Timeline.openurl という俺も全然覚えてなかったヤバいメソッドを直接叩くようになっているので、URI投げたらざっくり開いてくれるイベントを提供する。

handle¶

Retriever::Model.handle(Regexp condition)

そのModelが扱えるURIを登録しておく。実際には===を呼び出すようにしておいて、Procとかもいけるみたいにしておくといいっぽい

Intent¶

Plugin#intent(Symbol intent_slug, String label, Class model){|IntentToken token| }

class Intent
  Symbol slug
  String label
  Class supporting_model_class

各Modelを開くためのルーチン(intent)はプラグインが提供する。
開く手段が複数あって決定できないときにユーザにintentを選択させることができるように、表示用のlabelをつけておく。

intent自身が特定のURIの書式をサポートするのではなく、対応するModelのクラスのみを宣言することで、たまにパーマリンクを変えてくるサービスがあっても(そんなサービスあるわけないったーｗ)、Model側だけの変更で済む。

パーマリンクを開くときにIntentが利用されたら、IntentTokenを引数にブロックが呼ばれる。

IntentToken¶

class IntentToken
  URI uri
  Retriever::Model model
  Intent intent
  IntentToken parent

Intentで開くときのブロックに渡すパラメータ用のクラス。Structとかでよさそう

「別のやつで開く」みたいなのを実装するために連結リストになっていて、今までどんなIntentで開かれてきたかをあとから辿れるようにしておく。「別のIntentで開く」みたいな抽象的なこをやりたい。

例) あるURIに対するIntentの候補が3つあって、それぞれが「別のIntentで開く」機能を提供している場合、今まで利用したIntentがわからないと、Intent A→Intent B→Intent A...みたいにたらいまわしにされる。

Event¶

Plugin.call(:open_uri, URI uri)
Plugin.call(:open_uri, String uri)
Plugin.call(:open_model, Retriever::Model model)
Plugin.call(:open_intent, IntentToken intent_token)

handleを全て走査して、利用できるintentを決定し、それで開くイベント。Web Modelみたいなのを作っておいて、WebサイトのURLを投げたらブラウザで表示してくれるような感じにする。そのURLが偶然Twitterのパーマリンクだったりすると、Userのhandlerが反応して、プロフィールを開く。

URIのほかにModelも受け入れ可能にしておく。Modelのクラスが決定していれば、どのIntentで開くべきかを決定するのに役立ちそう。
（TwitterユーザのパーマリンクはWebModelとUserどちらともとれるが、Userが渡されていれば一つに決定できる）

また、IntentTokenの節に書いたような問題にも対応できるように、IntentTokenも受け入れ可能にする。

値の種類ごとにイベントを分けずに、openイベントみたいな高級な名前にしてしまって、なんでも受け入れるようにするかもしれない