Emacsのauto-completeでRubyのドキュメントを引っ張れるrobeに手を入れてみる

どうもこんばんは。随分長いことblogを更新してない麦汁です。 ようやく気が向いたので更新。

で、最近またRoRに返り咲きしてまして、 そのついでにEmacsのRuby環境を整えたりしている。

その際に導入したのが robe という Rubyのコードアシスタンス機能を持つやつ。 Emacs LispだけではなくRubyも動かすちょっと贅沢なやつ。 auto-complete と組み合わせると幸せになれそうなやつ。

と思うじゃん? これ見てよ

わあい! to_s がいっぱい! 何だよこれこんなにいらねえぞどれがどれだよ泣くぞ。

っていうか全部同じドキュメント出しているじゃないかギャン泣きするぞ。

というわけで俺好みに修正する。

auto-complete の候補を引っ張ってくる関数が robe-complete-thing というやつになるんだけど まずこいつが “Kernel.to_s” なども “to_s” だけ拾って帰ってくるようになっているので もにゃもにゃと修正。

(defun robe-complete-thing (thing)
  (robe-start)
  (if (robe-const-p thing)
      (progn
        (robe-complete-exit)
        (robe-request "complete_const" thing (car (robe-context))))
    (destructuring-bind (target module instance _) (robe-call-context)
      (setq robe-specs-cache (make-hash-table :test 'equal))
      (mapcar (lambda (spec)
                (let* ((method (robe-spec-method spec))
                       (value (gethash method robe-specs-cache))
                       (prop-value (caar value))
                       result-string
                       result-value
                       klass
                       case-fold-search)
                  (puthash method (cons spec value) robe-specs-cache)
                  (if robe-highlight-capf-candidates
                      (propertize method 'face
                                  (if (string-match "\\`[A-Z]" method)
                                      'font-lock-type-facen
                                    'font-lock-function-name-face))
                    (setq klass (if (and value (stringp (caar value)))
                                    (caar value)
                                  ""))
                    (setq result-string method)
                    (setq result-value (if value
                                           (concat (caar value) "#" method )
                                         method))
                    (popup-make-item (propertize result-string 'value result-value)
                                     :summary (if (stringp klass)
                                                  klass
                                                "")))))
              (reverse
               (robe-request "complete_method" thing target module instance))))))

元々は method だけ返していた物を その text-property の value に “Class#method” という形の文字列を埋め込んだり popup の item の summary にクラス名を埋め込んだりしている。

次に、auto-completeのメニューを選んだ時に 右側に出て来るドキュメントを出す関数を修正

(defun ac-robe-doc (symbol)
  "Return popup documentation for `auto-complete'."
  (when robe-running
    (let* ((candidate (ac-selected-candidate))
           (dummy-spec (list (get-text-property 0 'summary candidate)
                             t
                             (substring-no-properties candidate)
                             nil))
           (document (robe-doc-for dummy-spec)))
        (concat symbol
                "\n\n"
                (cdr (assoc 'docstring document))))))

元々はsymbolを使ってrobe-specs-cacheから適当に最初の1個を引っ張り出して来ていたのを 修正したrobe-complete-thingの情報を無理矢理引っ張り出して robe-doc-for に送り込んでる。

ちなみに robe-doc-for は なんか robe の http なプロセスにGETでドキュメントを取りに行く関数

というわけで〜、これでauto-completeを実行すると〜

やったね! ちゃんと何のto_sかわかるし ちゃんとしたドキュメントも表示されるぞ! いえい!

というわけで幸せになれました。

本当はコンテキストに合わせて補完候補絞って欲しいけど今回はこれで勘弁してやる。

癒されたいEmacsユーザのための「cat-mode」作りましたにゃん

長らくこちらの更新を行ってない間に 消費税も上がってしまいましたね。

こんな世の中だからEmacsユーザの方も非常にしんどい状況かと思います。 主に左手小指が。

そのようなわけで、他に作ってる人もいないようなので、 Emacs上にいながら猫に癒される cat-mode を作りました。

使い方は簡単。 (add-to-list ‘load-path (expand-file-name “~/path/to/cat-mode”)) とかでload-pathを通して (require ‘cat-mode) でrequireして M-x cat-mode と入力して起動するだけで The Cat API を使って猫画像を拾って来て Emacs上に表示します。

cat-mode中は RET で別の画像を表示し、qでcat-modeを終了します。

というわけで、 癒されたくなればすぐにでも猫画像を見ることができます。そう、Emacsならね。

世界の麦汁Advent Calendar 2013 麦汁さんとEmacs

どうも。 こちらの記事は世界の麦汁Advent Calendar 2013の 10日目の記事となります。

今日は麦汁さんが愛用しているエディタ、或いは環境であるEmacsについて軽くお話を書かせていただきます。

世界の麦汁ファンの皆様ならご存知かと思いますが 上述の通り麦汁さんは普段Emacsを使って開発等を行っております。

仕事では主にみんな大好きPHPを操り、そして現在では補助的にRubyや稀にPerlを使うといった感じで プログラムを書いているのですが、 プログラムを書く以外でもEmacsを活用しています。

麦汁さんがEmacs教に洗礼を受けたのは みんなよくあるパターンで、大学の頃となります。 当時は情報系の学科に通っておりまして つまりそこでEmacsについて学びまして もうそれ以来それを愛用しているといった感じですね。

といいつつ、実際に色々なプラグインを導入していくようになったのは 大学を卒業してからとなっています。

卒業後、最初に入った会社ではRoRの開発をしておりまして そこではVimによる開発を行っていたのですが まあEmacsでもOKだったのでRoR開発用に各種プラグインを入れたりして Emacs力を高めることができました。 おかげで僕のEmacsも立派に「他の人には触れない」という オレオレ仕様環境を育てることができています。

また、そのあたりをこじらせて lupin-title.elやらgalge-modeやらの 何の役にも立たないようなプラグインの開発に勤しんでおります。 嘘。あんまりやってない。

今後はそういうどうでもいいのをもっと作っていきたいところですけど 結構だるいっすよねEmacs Lisp……。

というわけで麦汁さんのEmacsにかける熱い思いでした。 あんまり熱くなかった。

というわけで 明日11日のアドベントカレンダーは誰が書いてくれるかな?