rrse 0.6.1 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 516e47e7b1a08bfb93f19b65f8abe4618f17e6d8
-  data.tar.gz: 971c3ddf7bcdd21a729b81a1b0922e6e5d5adbd4
+  metadata.gz: 24f46b3b51a2531892be03a50af2a20c30d3e04d
+  data.tar.gz: 73cf2b81f457be12b66986b78410239319dd3dc3
 SHA512:
-  metadata.gz: 9109b45e067697aa2386a076d3fe3fee07ca875c2d7191d9876ac085655c400e2c6f10904bce5f32096d5279a4fc8f59d1f8412dd62d9c23ad95f6c0f7176a13
-  data.tar.gz: a84a572686afc5e7ca0158540e58bd38e45e7ab661bfa8188657a18edc1f536baeb53f91afef456b595c64014abf6255d971e30ed8bddec9a12969fb36f5da15
+  metadata.gz: 2edbfb2d4daeab699098df3691c26e15b5ddc154af9e2a9e79aa32ea5d65e06e3eb3cf1491e001a6a28285fe3ca664c9d7e3c94761780ede1dfc99deb7965f56
+  data.tar.gz: 83aba0a35700c570310e96bdd324dce9cc2134fa2775bfbe7d7839140415a46c8243e3957fc806bb75d86aed4a628be429c241d4c8c64abfad1aeaf70cb636f0

data/NEWS.ja

@@ -1,22 +1,30 @@
+0.7 (2017/9):
+        * ������¤�������˹���
+        * �Ȥ�ʤ��ʤä���ǽ����(rd���ɤ��Ȥ�)
+        * ri�Υǡ����Ϥ��Ǥ˻Ȥ��ʤ��ä��ΤǤ������
+        * ���֤󤳤Υץ������ȤäƤ���ΤϺ�Ԥ������ʤ��Ȼפ��ޤ�����
+          ��������ȤäƤ�������1���饤�󥹥ȡ��뤷���ۤ����褤�Ȼפ��ޤ�
+        * help��ƤӽФ���ǽ����(��ä�¾�Υġ���Τۤ��������Ǥ��礦)
+
 0.5:
-        bitclust �Υǡ��������ѤǤ���褦�ˤ���
+        * bitclust �Υǡ��������ѤǤ���褦�ˤ���
 
 0.4:
-        RD�Υǡ��������ѤǤ���褦�ˤ���
+        * RD�Υǡ��������ѤǤ���褦�ˤ���
 
 0.3:
-        ri �Υǡ��������ѤǤ���褦�ˤ���
-        rrse-make-tables �Ǥ��餫����ǡ�������ʤ���Фʤ�ʤ��褦�ˤ���
+        * ri �Υǡ��������ѤǤ���褦�ˤ���
+        * rrse-make-tables �Ǥ��餫����ǡ�������ʤ���Фʤ�ʤ��褦�ˤ���
         
 0.2:
-        �Ķ��ѿ� REFE_DATA_DIR ���������Ƥ�����Ϥ��Υǥ��쥯�ȥ�ˤ���
-        �ǡ�����Ȥ��褦�ˤ���
+        * �Ķ��ѿ� REFE_DATA_DIR ���������Ƥ�����Ϥ��Υǥ��쥯�ȥ�ˤ���
+        * �ǡ�����Ȥ��褦�ˤ���
 
-        rrse-refe-listdescs �����Ƥ򤢤餫����ե�����˽��Ϥ��Ƥ������Ȥ�
-        ��ư�ι�®����ޤä�
+        * rrse-refe-listdescs �����Ƥ򤢤餫����ե�����˽��Ϥ��Ƥ������Ȥ�
+          ��ư�ι�®����ޤä�
 
 0.1.1:
-        rrb-show-minibuffer-help:rrse.el �ΥХ�����
+        * rrb-show-minibuffer-help:rrse.el �ΥХ�����
 
 0.1:
-        �ǽ�Υ�꡼��
+        * �ǽ�Υ�꡼��

data/README.ja.md

@@ -0,0 +1,103 @@
+# Ruby Reference Seeker for Emacsen 0.7
+
+## ����ϲ�����
+���Υġ���ϡ�bitclust�ξ���ˤ�ȤŤ���Emacs�Υߥ˥Хåե���
+Ruby�Υ᥽�åɤδ�ñ�ʥإ�פ�ɽ������ġ���Ǥ���
+
+## bitclust�Ȥϲ�����
+bitclust �� Ruby��ե���󥹥ޥ˥奢������ײ� (�̾Τ���) ��
+�ޥ˥奢����갷������Υץ������Ǥ���
+�ܤ����� https://github.com/rurema/doctree/wiki �ʤɤ򻲾Ȥ��Ƥ���������
+
+## ư��Ķ�
+* Emacs (24.5.1�dz�ǧ)
+* Ruby (2.4.2�dz�ǧ)
+
+## ���󥹥ȡ���
+
+�ޤ�
+
+    gem install rrse
+
+�� gem �򥤥󥹥ȡ��뤷�ޤ���gem �Υѥå������� elisp/rrse.el �Ȥ���
+�ե����뤬�ޤޤ�Ƥ��ޤ��Τǡ����� rrse.el ��
+Emacs �� load-path ���̤ä���˥��ԡ����Ƥ���������
+
+    gem contents rrse | grep rrse.el
+
+�Ǥɤ��˥ե����뤬�֤���Ƥ��뤫�狼��ޤ���
+
+���˥ǡ����١�����������ޤ���rrse��ź�դ��Ƥ���ǡ����١�����
+
+    rrse setup-config
+    rrse install-default-db
+    
+�ǥ��󥹥ȡ���Ǥ��ޤ���
+
+�ǿ���rurema�ξ����Ȥ���������bitclust��Ȥ��ޤ����ޤ� bitclust ��
+
+    bitclust setup
+        
+�ǥ��åȥ��åפ��Ƥ���
+
+    rrse-table setup-config
+    rrse-table update-db
+
+�ǥǡ����١��������ۤ���ޤ���
+
+�ɤ���ξ��Ǥ� $HOME/.rrse/ �ʲ�������ե������ rrse �ѥǡ����١�����
+����ޤ���
+
+### Emacs ¦�Υ��󥹥ȡ���
+���� emacs �ν�����ե�����(.emacs.d/init.el�ʤ�)��
+
+    (load-library "rrse")
+    (rrse-setup)
+
+�Ƚ񤤤Ƥ����������ޤ���ruby�ѤΥ⡼�ɤȤ���ruby-mode�ʳ�(enhanced-ruby-mode�ʤ�)
+��ȤäƤ������ϡ�
+
+* rrse-ruby-mode
+* rrse-ruby-mode-hook
+
+��Ŭ�ڤ����ꤹ��ɬ�פ�����ޤ����㤨�� enh-ruby-mode��Ȥ����ϡ�
+`(rrse-setup)` �ιԤ�����
+
+    (setq rrse-ruby-mode 'enh-ruby-mode)
+    (setq rrse-ruby-mode-hook 'enh-ruby-mode-hook)
+
+�Ȥ���2�Ԥ�ä��Ƥ���������
+
+
+## �Ȥ���
+
+ruby-mode ��ư����
+�᥽�å�̾�ξ�˥����������äƤ����Ȥ��Υ᥽�åɤ�
+���� "���饹#�᥽�å�̾(����)" �Ȥ������ǥߥ˥Хåե���ɽ������ޤ���
+
+Ʊ��̾���Υ᥽�åɤ�ʣ��������Ϥ��줬����ɽ������ޤ���
+
+�ޤ������ξ��֤� M-x rrse-help �Ȥ���ȡ�ɽ������Ƥ���᥽�å�
+�Υ�ե���󥹤� ReFe �ǰ������Ȥ��Ǥ��ޤ���
+
+M-x rrse-toggle-show �ǥߥ˥Хåե���ɽ����ͭ����������̵����������Ǥ��ޤ���
+
+## �饤����
+GNU GPL 2 or later
+
+������ misc/ �ʲ��Ϥ��ޤΥǡ����Ǥ��뤿�ᡢ������������
+�饤���� (CC BY 3.0) ��Ŭ�Ѥ���ޤ���
+
+## �ռ��ʤ�
+��������β��ξ����ɽ������Ȥ��������ǥ��� haskell-mode ����
+�Ҽڤ��ޤ�����
+�ޤ����͡��ʥҥ�Ȥ���ӥѥå��򲼤��ä�rubikitch���󤪤��
+�Х���ݡ��Ȥ򲼤��ä� dfft����˴��դ��ޤ���
+
+## �Х��ʤ�
+�Х�����˾�ʤɤϺ�Ԥ˥᡼��򤷤Ƥ���������
+
+## ��ԤˤĤ���
+
+���Ӱ�ʿ <ohai@kmc.gr.jp>  
+http://www.kmc.gr.jp/~ohai/

data/bin/rrse

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "rrse/main"
+
+RRSE::Main.new.run(ARGV)

data/elisp/rrse.el

@@ -1,9 +1,12 @@
-;;; rrse --- Ruby Reference|Refe Searcher for Emacsen
 
-;; Copyright (C) 2006-2010 Ohbayashi Ippei
+;;; rrse.el --- Ruby Reference Searcher for Emacsen
 
-;; Version: 0.5
+;; Copyright (C) 2017 by Ippei Obayashi
+
+;; Author: Ippei Obayashi <ohai@kmc.gr.jp>
 ;; URL: http://www.kmc.gr.jp/~ohai/rrse.html
+;; Version: 0.7
+;; Package-Requires: ()
 
 ;; This software is distributed under GNU general Public Licence version 2 or later.
 ;; 
@@ -12,254 +15,123 @@
 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ;; GNU General Public License for more details.
 
-
-
 ;;; Code:
 
-;;;; User customizable varaible
-(defvar rrse-desc-separator " "
-  "*Separator for each description")
-
-(defvar rrse-refe-program-name
-  (if (featurep 'meadow)
-      "ruby"
-    "refe"))
-
-(defvar rrse-refe-program-args
-  (if (featurep 'meadow)
-      '("-S" "refe")
-    nil))
+(provide 'rrse)
 
-(defvar rrse-idle-delay 0.5)
-
-(defvar rrse-refe-coding-system locale-coding-system)
+;;;; User customizable varaible
 
+(defcustom rrse-idle-delay 0.5 "RRSE delay seconds")
+(defcustom rrse-ruby-mode 'ruby-mode "Major mode for RRSE")
+(defcustom rrse-ruby-mode-hook 'ruby-mode-hook "Major mode hook for RRSE")
+(defcustom rrse-directory "~/.rrse" "RRSE directory")
 
 ;;;; Internal variables
-
-(defvar rrse-refe-buffer-name "*rrse-help*")
-
-(defvar rrse-forward-table nil)
-(defvar rrse-rev-table nil)
-
 (defvar rrse-enable t)
+(defvar rrse-program-name "rrse")
+(defvar rrse-process-buffer nil)
+(defvar rrse-process nil)
+(defvar rrse-query-timeout 5)
 
-(defvar rrse-table-file "~/.rrse/table")
-(defvar rrse-rev-table-file "~/.rrse/rev-table")
-
-;;;; Utitility functions
-(defun rrse-id-char-p (c)
-  "Return whether character C is in [a-zA-Z0-9_]"
-  (or (and (<= ?a c) (<= c ?z))
-      (and (<= ?A c) (<= c ?Z))
-      (and (<= ?0 c) (<= c ?9))
-      (= ?_ c)))
-
-(defun rrse-chomp (str)
-  (if (string-match "\\(\r\\|\n\\)$" str)
-      (substring str 0 (match-beginning 0))
-    str))
-
-(defun rrse-each-line (fun)
-  "Apply FUN to each line in current buffer"
-  (goto-char (point-min))
-  (while (not (eobp))
-    (funcall fun (rrse-chomp (thing-at-point 'line)))
-    (forward-line)))
-
-
-(defun rrse-chomp-string (str)
-  "remove \\n from STR's tail"
-  (if (eq (aref str (- (length str) 1)) ?\n)
-      (substring str 0 (- (length str) 1))
-    str))
-
-(defun rrse-refe-call-process (buf &rest args)
-  "Call refe"
-  (let ((coding-system-for-read rrse-refe-coding-system))
-    (apply 'call-process rrse-refe-program-name nil buf nil
-           (append rrse-refe-program-args args))))
-
-(defun rrse-bsearch (table word begin end)
-  "binary search implementation"
-  (if (or (= (+ begin 1) end) (= begin end))
-      (cond
-       ((string= word (car (aref table begin))) (cdr (aref table begin)))
-       ((string= word (car (aref table end))) (cdr (aref table end)))
-       (t nil))
-    (let ((center (/ (+ begin end) 2)))
-      (if (string< (car (aref table center)) word)
-          (rrse-bsearch table word (+ center 1) end)
-        (rrse-bsearch table word begin center)))))
-
-
-(defun rrse-search (key table)
-  "binary search"
-  (rrse-bsearch table key 0 (- (length table) 1)))
-
-(defun rrse-filter (fun list)
-  "a list of all elements that satisfy (FUN elem) in LIST"
-  (let ((head list)
-        (result nil))
-    (while head
-      (if (funcall fun (car head))
-          (setq result (cons (car head) result)))
-      (setq head (cdr head)))
-    (reverse result)))
-
-;;;; Table Creation
-(defun rrse-make-table ()
-  (with-temp-buffer
-    (if (file-exists-p rrse-table-file)
-        (insert-file-contents rrse-table-file)
-      (error "can't load %s" rrse-table-file))
-    (let ((table (make-vector (count-lines (point-min) (point-max)) nil)))
-      (rrse-each-line (lambda (line)
-                        (aset table (count-lines (point-min) (point))
-                              (split-string line "[\t\n]"))))
-      table)))
-    
-(defun rrse-make-rev-table ()
-  (with-temp-buffer
-    (if (file-exists-p rrse-rev-table-file)
-        (insert-file-contents rrse-rev-table-file)
-      (error "can't load %s" rrse-rev-table-file))
-    (let ((table (make-vector (count-lines (point-min) (point-max)) nil)))
-      (rrse-each-line (lambda (line)
-                        (aset table (count-lines (point-min) (point))
-                              (split-string line "[\t\n]"))))
-      table)))
-
-(defun rrse-prepare-table ()
-  (if (null rrse-forward-table)
-      (setq rrse-forward-table (rrse-make-table)
-            rrse-rev-table (rrse-make-rev-table))))
-
-;;;; Find suitable methods
-
+;;;; Functions
 (defun rrse-get-current-word ()
+  "Return the word at the point"
   (save-excursion
     (buffer-substring-no-properties
      (progn (skip-syntax-backward "w_") (point))
      (progn (skip-syntax-forward "w_") (point)))))
 
-(defun rrse-go-before-current-word ()
-  (skip-syntax-backward "w_")
-  (while (and (memq (char-before) '(?\t ?\  ?\n)) (> (point) (point-min)))
-    (backward-char)))
-
-(defun rrse-find-dot ()
+(defun rrse-method-call-p ()
+  "Return true if the current word is a method call by using dot"
   (save-excursion
-    (rrse-go-before-current-word)
-    (char-before)))
-      
-(defun rrse-find-reciever ()
-  (if (not (eq (rrse-find-dot) ?.))
-      ""
+    (skip-syntax-backward "w_")
+    (skip-syntax-backward " ")
+    (eq (char-before) ?.)))
+
+(defun rrse-get-receiver ()
+  "Return the receiver of the method call at the cursor"
+  (when (rrse-method-call-p)
     (save-excursion
-      (rrse-go-before-current-word)
+      (skip-syntax-backward "w_")
+      (skip-syntax-backward " ")
       (backward-char)
-      (let ((end (point)))
+      (let ((receiver-end-point (point)))
         (skip-syntax-backward "w_")
-        (buffer-substring-no-properties (point) end)))))
-
-(defun rrse-valid-class-method-p (word spec dot reciever)
-  (and (eq dot ?.)
-       (or (string= (concat reciever "." word) spec)
-           (string-match (concat "::" (regexp-quote reciever) "\\." word)
-                         spec))))
-
-(defun rrse-valid-instance-method-p (word spec dot reciever)
-  (and (eq dot ?.)
-       (not (string= word "new"))
-       (not (string-match "^Kernel#\\|^Kernel." spec))
-       (string-match (concat "#" word) spec)))
-
-(defun rrse-valid-kernel-or-module-method-p (word spec dot reciever)
-  (and (not (eq dot ?.))
-       (string-match "^\\(Object#\\|Kernel.\\|Kernel#\\|Module#\\)" spec)
-       (not (string-match "class\\|initialize" word))))
-
-(defun rrse-find-specs ()
-  (let* ((word (rrse-get-current-word))
-         (dot (rrse-find-dot))
-         (reciever (rrse-find-reciever))
-         (specs (rrse-search word rrse-rev-table))
-         (class-method-p
-          (lambda (spec) (rrse-valid-class-method-p word spec dot reciever)))
-         (instance-method-p
-          (lambda (spec) (rrse-valid-instance-method-p word spec dot reciever)))
-         (kernel-method-p
-          (lambda (spec) (rrse-valid-kernel-or-module-method-p
-                          word spec dot reciever))))
-    (or (rrse-filter class-method-p specs)
-        (rrse-filter instance-method-p specs)
-        (rrse-filter kernel-method-p specs))))
-              
-;;;; Convert Methods to Descriptions
-(defun rrse-format-descs (descs)
-  (mapconcat 'identity descs rrse-desc-separator))
-
-(defun rrse-specs-to-descs (specs)
-  (let ((make-desc (lambda (desc) (concat spec desc)))
-        (pick-desc (lambda (spec)
-                     (mapcar make-desc
-                             (rrse-search spec rrse-forward-table)))))
-    (apply 'append (mapcar pick-desc specs))))
-
-
-;;;; show description in minibuffer
-(defun rrse-show-minibuffer-help ()
-  (let ((descs (rrse-specs-to-descs (rrse-find-specs))))
-    (if descs
-        (message "%s" (rrse-format-descs descs)))))
-                 
+        (buffer-substring-no-properties (point) receiver-end-point)))))
+
+(defun rrse-start-process (buffer)
+  "Invoke \"rrse pipe-query\""
+  (start-process "rrse" buffer
+                 rrse-program-name "-d" (expand-file-name rrse-directory)
+                 "pipe-query" "-s" " "))
+
+(defun rrse-init-process ()
+  "Invoke \"rrse pipe-query\" if rrse-process is nil and set rrse-process"
+  (when (not rrse-process)
+    (setq rrse-process-buffer (get-buffer-create " *rrse*"))
+    (setq rrse-process (rrse-start-process rrse-process-buffer))
+    (set-process-coding-system rrse-process 'utf-8-unix 'utf-8-unix)
+    (set-process-query-on-exit-flag rrse-process nil)))
+
+(defun rrse-kill-process ()
+  "Kill rrse pipe-query process if the process is alive"
+  (when (and rrse-process (eq (process-status rrse-process) 'run))
+    (kill-process rrse-process)
+    (setq rrse-process nil)
+    (when (get-buffer rrse-process-buffer)
+      (kill-buffer rrse-process-buffer))))
+
+(defun rrse-query (type query)
+  "Query to rrse"
+  (rrse-init-process)
+  (with-current-buffer (process-buffer rrse-process)
+    (delete-region (point-min) (point-max))
+    (process-send-string rrse-process (concat type " " query "\n"))
+    (while (not (eq (char-before (point-max)) ?\n))
+      (accept-process-output rrse-process 0 rrse-query-timeout))
+    (let ((msg (buffer-substring-no-properties (point-min) (1- (point-max)))))
+      (if (string= msg "") nil msg))))
+
+(defun rrse-debug-message ()
+  (concat (rrse-get-current-word)
+          " "
+          (if (rrse-method-call-p) "1" "0")
+          " "
+          (rrse-get-receiver)))
+
+(defun rrse-build-minibuffer-help ()
+  "Return help string for minibuffer from the method at the cursor"
+  (let ((word (rrse-get-current-word))
+        (receiver (rrse-get-receiver)))
+    (if (rrse-method-call-p)
+        (or (rrse-query "full-name" (concat receiver "." word))
+            (rrse-query "instance-method" word))
+      (rrse-query "toplevel-method" word))))
 
 (defun rrse-print-current-symbol-info ()
+  "Show the information of the method call at the cursor in the minibuffer"
   (interactive)
   (condition-case err
       (and rrse-enable
-           (eq major-mode 'ruby-mode)
+           (eq major-mode rrse-ruby-mode)
            (not executing-kbd-macro)
            (not (eq (selected-window) (minibuffer-window)))
            (sit-for rrse-idle-delay)
-           (rrse-show-minibuffer-help))
+           (let ((minibuffer-help (rrse-build-minibuffer-help)))
+             (when minibuffer-help (message minibuffer-help))))
     (error (princ err) (error "stop hook"))))
 
-;;;; show refe's help
-(defun rrse-show-help (method)
-  (let ((buf (or (get-buffer rrse-refe-buffer-name)
-                 (generate-new-buffer rrse-refe-buffer-name))))
-    (set-buffer buf)
-    (setq buffer-read-only nil)
-    (erase-buffer)
-    (rrse-refe-call-process buf method)
-    (goto-char (point-min))
-    (set-buffer-modified-p nil)
-    (setq buffer-read-only t)
-    (display-buffer buf)))
-    
-(defun rrse-help-completing-read (methods)
-  (completing-read "Method: " (mapcar 'list methods)))
-
-(defun rrse-help ()
-  (interactive)
-  (let ((methods (rrse-find-specs)))
-    (cond
-     ((null methods) nil) 
-     ((null (cdr methods)) (rrse-show-help (car methods)))
-     (t (rrse-show-help (rrse-help-completing-read methods))))))
-
-;;;; toggle rrse
 (defun rrse-toggle-show ()
   "Toggle whether documents are shown in minibuffer"
   (interactive)
   (setq rrse-enable (not rrse-enable)))
 
-;;;; setup function
 (defun rrse-setup ()
+  "Setup rrse in emacs"
   (interactive)
-  (add-hook 'ruby-mode-hook
+  (add-hook rrse-ruby-mode-hook
             '(lambda ()
-               (rrse-prepare-table)
                (add-hook 'post-command-hook 'rrse-print-current-symbol-info))))
+
+;;; rrse.el ends here
+