rcodetools 0.7.0.0 → 0.8.0.0

data/CHANGES

@@ -1,5 +1,17 @@
 rcodetools history
 ==================
+User-visible changes since 0.7.0
+--------------------------------
+* Support Ruby 1.9!
+* xmpfilter: multi-line annotation
+* xmpfilter --expectations generates expectations by Jay Fields
+* anything-rcodetools.el: new elisp
+* --tmpfile, --tempfile: use temporary file instead of open3 on un*x
+* rcodetools.el: smarter xmpfilter-command
+* rcodetools.el: rct-fork interface
+* rct-fork: require 'rubygems' initially
+* rct-fork: more stable
+
 User-visible changes since 0.5.0
 --------------------------------
 * "test-driven completion" (TDC) support for Emacs and vim (see README.TDC)

data/README

@@ -1,7 +1,7 @@
 
  rcodetools  http://eigenclass.org/hiki.rb?rcodetools
  Copyright (c) 2005-2007 Mauricio Fernandez <mfp@acm.org> http://eigenclass.org
- Copyright (c) 2006-2007 rubikitch <rubikitch@ruby-lang.org> http://www.rubyist.net/~rubikitch/
+ Copyright (c) 2006-2008 rubikitch <rubikitch@ruby-lang.org> http://www.rubyist.net/~rubikitch/
 Use and distribution subject to the terms of the Ruby license.
 
 = Overview

data/README.emacs

@@ -21,8 +21,15 @@ If you use icicles copy <tt>icicles-rcodetools.el</tt> too.
 Then require it.
   (require 'icicles-rcodetools)
 It provides wonderful `help on candidate' feature, RI document on each candidate during completion.
-I'm addicted to icicles!
-  http://www.emacswiki.org/cgi-bin/wiki/Icicles
+
+If you use anything.el copy <tt>anything-rcodetools.el</tt> too.
+Then require it.
+  (require 'anything-rcodetools)
+RI document on each candidate during completion.
+I think anything-rcodetools is more convenient than icicles-rcodetools.
+
+I'm addicted to anything!
+  http://www.emacswiki.org/cgi-bin/wiki/Anything
 
 xmpfilter on buffer
 ===================
@@ -38,8 +45,9 @@ method/class/constant completion
 
 # [EVAL IT] (describe-function 'rct-complete-symbol)
 
-If you use icicles-rcodetools, you can browse RI document for selected candidate
-by typing C-M-RET. It is wonderful icicles feature!!
+If you use icicles-rcodetools or anything-rcodetools, you can browse RI document
+for selected candidate by typing C-M-RET (icicles) or C-z (anything.
+It is wonderful icicles and anything feature!!
 
 show RI document / jump to the definition
 =========================================
@@ -52,3 +60,12 @@ If use do not use this feature, evaluate:
   (setq rct-find-tag-if-available nil)
 
 # [EVAL IT] (describe-variable 'rct-find-tag-if-available)
+
+speed-up xmpfilter and completion
+=================================
+
+# [EVAL IT] (describe-function 'rct-fork)
+# [EVAL IT] (describe-function 'rct-fork-kill)
+
+M-x rct-fork pre-loads heavy libraries (like rails).
+You need not every time wait for loading them anymore!

data/README.ja

@@ -1,7 +1,7 @@
 
  rcodetools  http://eigenclass.org/hiki.rb?rcodetools
  Copyright (c) 2005-2007 Mauricio Fernandez <mfp@acm.org> http://eigenclass.org
- Copyright (c) 2006-2007 rubikitch <rubikitch@ruby-lang.org> http://www.rubyist.net/~rubikitch/
+ Copyright (c) 2006-2008 rubikitch <rubikitch@ruby-lang.org> http://www.rubyist.net/~rubikitch/
 Use and distribution subject to the terms of the Ruby license.
 
 = ����

data/README.xmpfilter

@@ -1,12 +1,14 @@
 
 xmpfilter  http://eigenclass.org/hiki.rb?xmpfilter
-Copyright (c) 2005-2006 Mauricio Fernandez <mfp@acm.org> http://eigenclass.org
+Copyright (c) 2005-2008 Mauricio Fernandez <mfp@acm.org> http://eigenclass.org
+                        rubikitch <rubikitch@ruby-lang.org>
 Use and distribution subject to the terms of the Ruby license.
 
 Overview
 ========
 xmpfilter is a small tool that can be used to
-* generate Test::Unit assertions and RSpec expectations semi-automatically
+* generate Test::Unit assertions, RSpec expectations and
+  expectations blocks semi-automatically
 * annotate source code with intermediate results (a bit like irb
   --simple-prompt but only for the lines explicitly marked with # =>)
   Very useful for example code (such as postings to ruby-talk).
@@ -15,7 +17,7 @@ Usage
 =====
 xmpfilter takes its input from stdin and writes to stdout. It can run in
 several modes (annotation, Test::Unit assertion expansion, RSpec expectation
-generation, marker insertion); see 
+generation, expectations expectations generation, marker insertion); see 
  xmpfilter -h 
 README.emacs and README.vim describe how to use xmpfilter from your editor.
 
@@ -34,8 +36,33 @@ README.vim)
  a + b                                             # => "foobaz"
  a.size                                            # => 3
 
-This saves much cut&pasting when you're posting to ruby-talk/ruby-core (I use
-it all the time).
+This saves much cut&pasting when you're posting to ruby-list/ruby-talk/ruby-core
+(We use it all the time).
+
+
+Example: multi-line code annotation
+===================================
+Just add "# =>" markers to the next lines whose values you want to be shown with pp:
+
+a = ["1111111111111111111111111111111111111111111111111111", 123334324234242342,
+  1332333333,6,8 ]
+1                               # => 
+a
+# => 
+
+will be expanded to (in one keypress in a decent editor, see README.emacs and
+README.vim)
+
+a = ["1111111111111111111111111111111111111111111111111111", 123334324234242342,
+  1332333333,6,8 ]
+1                               # => 1
+a
+# => ["1111111111111111111111111111111111111111111111111111",
+#     123334324234242342,
+#     1332333333,
+#     6,
+#     8]
+
 
 Example: assertion generation
 =============================
@@ -114,88 +141,146 @@ Example: RSpec expectations
 ===========================
 Here's some code before and after filtering it with xmpfilter:
 
-    class X
-      Y = Struct.new(:a)
-      def foo(b); b ? Y.new(2) : 2 end
-      def bar; raise "No good" end
-      def baz; nil end
-      def fubar(x); x ** 2.0 + 1 end
-      def babar; [1,2] end
-      A = 1
-      A = 1
+  class X
+    Y = Struct.new(:a)
+    def foo(b); b ? Y.new(2) : 2 end
+    def bar; raise "No good" end
+    def baz; nil end
+    def fubar(x); x ** 2.0 + 1 end
+    def babar; [1,2] end
+    A = 1
+    A = 1
+  end
+
+  context "Testing xmpfilter's expectation expansion" do
+    setup do
+      @o = X.new
     end
 
-    context "Testing xmpfilter's expectation expansion" do
-      setup do
-	@o = X.new
-      end
+    specify "Should expand should_equal expectations" do
+      @o.foo(true)   # =>
+      @o.foo(true).a # =>
+      @o.foo(false)  # =>
+    end
 
-      specify "Should expand should_equal expectations" do
-	@o.foo(true)   # =>
-	@o.foo(true).a # =>
-	@o.foo(false)  # =>
-      end
-      
-      specify "Should expand should_raise expectations" do
-	@o.bar         # =>
-      end
+    specify "Should expand should_raise expectations" do
+      @o.bar         # =>
+    end
 
-      specify "Should expand should_be_nil expectations" do
-	@o.baz         # =>
-      end
+    specify "Should expand should_be_nil expectations" do
+      @o.baz         # =>
+    end
 
-      specify "Should expand correct expectations for complex values" do
-	@o.babar       # =>
-      end
+    specify "Should expand correct expectations for complex values" do
+      @o.babar       # =>
+    end
 
-      specify "Should expand should_be_close expectations" do
-	@o.fubar(10)   # =>
-      end
+    specify "Should expand should_be_close expectations" do
+      @o.fubar(10)   # =>
     end
+  end
 
 
 after piping it to xmpfilter -s:
 
-    class X
-      Y = Struct.new(:a)
-      def foo(b); b ? Y.new(2) : 2 end
-      def bar; raise "No good" end
-      def baz; nil end
-      def fubar(x); x ** 2.0 + 1 end
-      def babar; [1,2] end
-      A = 1
-      A = 1 # !> already initialized constant A
-    end
-
-    context "Testing xmpfilter's expectation expansion" do
-      setup do
-	@o = X.new
-      end
-
-      specify "Should expand should_equal expectations" do
-	(@o.foo(true)).should_be_a_kind_of X::Y
-	(@o.foo(true).inspect).should_equal "#<struct X::Y a=2>"
-	(@o.foo(true).a).should_equal 2
-	(@o.foo(false)).should_equal 2
-      end
-      
-      specify "Should expand should_raise expectations" do
-	lambda{(@o.bar)}.should_raise RuntimeError
-      end
-
-      specify "Should expand should_be_nil expectations" do
-	(@o.baz).should_be_nil
-      end
-
-      specify "Should expand correct expectations for complex values" do
-	(@o.babar).should_equal [1, 2]
-      end
-
-      specify "Should expand should_be_close expectations" do
-	(@o.fubar(10)).should_be_close(101.0, 0.0001)
-      end
+  class X
+    Y = Struct.new(:a)
+    def foo(b); b ? Y.new(2) : 2 end
+    def bar; raise "No good" end
+    def baz; nil end
+    def fubar(x); x ** 2.0 + 1 end
+    def babar; [1,2] end
+    A = 1
+    A = 1 # !> already initialized constant A
+  end
+
+  context "Testing xmpfilter's expectation expansion" do
+    setup do
+      @o = X.new
+    end
+
+    specify "Should expand should_equal expectations" do
+      (@o.foo(true)).should_be_a_kind_of X::Y
+      (@o.foo(true).inspect).should_equal "#<struct X::Y a=2>"
+      (@o.foo(true).a).should_equal 2
+      (@o.foo(false)).should_equal 2
+    end
+
+    specify "Should expand should_raise expectations" do
+      lambda{(@o.bar)}.should_raise RuntimeError
+    end
+
+    specify "Should expand should_be_nil expectations" do
+      (@o.baz).should_be_nil
+    end
+
+    specify "Should expand correct expectations for complex values" do
+      (@o.babar).should_equal [1, 2]
+    end
+
+    specify "Should expand should_be_close expectations" do
+      (@o.fubar(10)).should_be_close(101.0, 0.0001)
+    end
+  end
+
+
+Example: expectations expectations
+==================================
+Expectations is a light-weight unit testing framework by Jay Fields.
+(http://expectations.rubyforge.org)
+
+Here's some code before and after filtering it with xmpfilter:
+
+  require 'rubygems'
+  require 'expectations'
+
+  S = Struct.new :a
+  Expectations do
+    1 + 1  # =>
+    "a".length # =>
+    [][1] # =>
+    1.hoge # =>
+    1.1 + 1.0 # =>
+    S.new(1) # =>
+  end
+
+after piping it to xmpfilter --expectations:
+
+  require 'rubygems'
+  require 'expectations'
+
+  S = Struct.new :a
+  Expectations do
+    expect 2 do
+      1 + 1
+    end
+
+    expect 1 do
+      "a".length
+    end
+
+    expect nil do
+      [][1]
+    end
+
+    expect NoMethodError do
+      1.hoge
+    end
+
+    expect 2.0999..2.1001 do
+      1.1 + 1.0
     end
 
+    expect S do
+      S.new(1)
+    end
+
+    expect "#<struct S a=1>" do
+      S.new(1).inspect
+    end
+
+  end
+
 
 License
 =======

data/Rakefile

@@ -31,47 +31,13 @@ end
 
 task :default => :test
 
-## test data file dependency
-basetestfiles = []
-copy = lambda do |t|
-  cp t.prerequisites.first, t.name
-end
-
-#  DO NOT EDIT!!                         EDITABLE
-[ ["test/data/rspec_poetry-input.rb", "test/data/rspec-input.rb"],
-  ["test/data/unit_test_poetry-input.rb", "test/data/unit_test-input.rb"],
-  ["test/data/completion_emacs-input.rb", "test/data/completion-input.rb"],
-  ["test/data/unit_test_detect_rbtest-input.rb", "test/data/unit_test-input.rb"],
-  ["test/data/unit_test_detect_rbtest-output.rb", "test/data/unit_test-output.rb"],
-  ["test/data/unit_test_detect_rbtest2-input.rb", "test/data/unit_test_rbtest-input.rb"],
-  ["test/data/unit_test_detect_rbtest2-output.rb", "test/data/unit_test_rbtest-output.rb"],
-  ["test/data/completion_detect_rbtest-input.rb", "test/data/completion_rbtest-input.rb"],
-  ["test/data/completion_detect_rbtest-output.rb", "test/data/completion_rbtest-output.rb"],
-  ["test/data/completion_detect_rbtest2-input.rb", "test/data/completion-input.rb"],
-  ["test/data/completion_detect_rbtest2-output.rb", "test/data/completion-output.rb"],
-  ["test/data/doc_detect_rbtest-input.rb", "test/data/doc-input.rb"],
-  ["test/data/doc_detect_rbtest-output.rb", "test/data/doc-output.rb"],
-  ["test/data/doc_detect_rbtest2-input.rb", "test/data/doc_rbtest-input.rb"],
-  ["test/data/doc_detect_rbtest2-output.rb", "test/data/doc_rbtest-output.rb"],
-
-].each do |outfile, infile|
-  basetestfiles << outfile
-  file(outfile => infile, &copy)
-end
-for test in %w[refe ri ri_emacs ri_vim]
-  outfile = "test/data/#{test}-input.rb"
-  basetestfiles << outfile
-  file(outfile => "test/data/doc-input.rb", &copy)
-end
-task :base_update => basetestfiles
-task :test => :base_update
-task :rcov => :base_update
 
 #{{{ Package tasks
 PKG_FILES = FileList[
 "bin/rct-complete", "bin/rct-doc", "bin/xmpfilter", "bin/rct-meth-args",
 "lib/**/*.rb",
-"CHANGES", "rcodetools.*", "icicles-rcodetools.el", "README", "README.*", "THANKS", 
+"CHANGES", "rcodetools.*", "icicles-rcodetools.el", "anything-rcodetools.el",
+"README", "README.*", "THANKS", 
 "Rakefile", "Rakefile.method_analysis",
 "setup.rb",
 "test/**/*.rb",
@@ -126,7 +92,7 @@ EOF
 
   end
 
-  task :gem => [:test]
+  task :gem #=> [:test]
   Rake::GemPackageTask.new(Spec) do |p|
     #p.need_tar = true
   end

data/anything-rcodetools.el

@@ -0,0 +1,142 @@
+;;; anything-rcodetools.el --- accurate Ruby method completion with anything
+;; $Id: anything-rcodetools.el,v 1.6 2008/01/14 17:59:34 rubikitch Exp $
+
+;;; Copyright (c) 2007 rubikitch
+
+;; Author: rubikitch <rubikitch@ruby-lang.org>
+;; URL: http://www.emacswiki.org/cgi-bin/wiki/download/anything-rcodetools.el
+
+;;; Use and distribution subject to the terms of the Ruby license.
+
+;;; Commentary:
+
+;; (0) You need rcodetools, anything.el and FastRI. Note that you do not have to
+;;     configure anything.el if you use anything.el for this package.
+;; (1) You need to add to .emacs:
+;;       (require 'anything)
+;;       (require 'anything-rcodetools)
+;;       ;; Command to get all RI entries.
+;;       (setq rct-get-all-methods-command "PAGER=cat fri -l")
+;;       ;; See docs
+;;       (define-key anything-map "\C-z" 'anything-execute-persistent-action)
+
+;;; History:
+
+;; $Log: anything-rcodetools.el,v $
+;; Revision 1.6  2008/01/14 17:59:34  rubikitch
+;; * uniform format (anything-c-source-complete-ruby, anything-c-source-complete-ruby-all)
+;; * rename command: anything-c-ri -> anything-rct-ri
+;;
+;; Revision 1.5  2008/01/13 17:54:04  rubikitch
+;; anything-current-buffer advice.
+;;
+;; Revision 1.4  2008/01/08 14:47:34  rubikitch
+;; Added (require 'rcodetools).
+;; Revised commentary.
+;;
+;; Revision 1.3  2008/01/04 09:32:29  rubikitch
+;; *** empty log message ***
+;;
+;; Revision 1.2  2008/01/04 09:21:23  rubikitch
+;; fixed typo
+;;
+;; Revision 1.1  2008/01/04 09:21:05  rubikitch
+;; Initial revision
+;;
+
+;;; Code:
+
+(require 'rcodetools)
+
+;;;; Compatibility code
+(unless (fboundp 'anything-execute-persistent-action)
+  (defun anything-execute-persistent-action ()
+    "If a candidate was selected then perform the associated action without quitting anything."
+    (interactive)
+    (save-selected-window
+      (select-window (get-buffer-window anything-buffer))
+      (select-window (setq minibuffer-scroll-window
+                           (if (one-window-p t) (split-window) (next-window (selected-window) 1))))
+      (let* ((anything-window (get-buffer-window anything-buffer))
+             (selection (if anything-saved-sources
+                            ;; the action list is shown
+                            anything-saved-selection
+                          (anything-get-selection)))
+             (default-action (anything-get-action))
+             (action (assoc-default 'persistent-action (anything-get-current-source))))
+        (setq action (or action default-action))
+        (if (and (listp action)
+                 (not (functionp action))) ; lambda
+            ;; select the default action
+            (setq action (cdar action)))
+        (set-window-dedicated-p anything-window t)
+        (unwind-protect
+            (and action selection (funcall action selection))
+          (set-window-dedicated-p anything-window nil))))))
+
+(unless (boundp 'anything-current-buffer)
+  (defvar anything-current-buffer nil)
+  (defadvice anything (before get-current-buffer activate)
+    (setq anything-current-buffer (current-buffer))))
+
+;;;; Main code
+(defun anything-rct-ri (pair)
+  (ri (substring (cadr (split-string pair "\t")) 1 -1)))
+
+(defun anything-rct-complete  (pair)
+  (save-excursion
+    (set-buffer anything-current-buffer)
+    (search-backward pattern)
+    (delete-char (length pattern)))
+  (insert (car (split-string pair "\t"))))
+
+(setq rct-complete-symbol-function 'rct-complete-symbol--anything)
+(defvar anything-c-source-complete-ruby
+  '((name . "Ruby Method Completion")
+    (candidates . rct-method-completion-table)
+    (init
+     . (lambda ()
+         (condition-case x
+             (rct-exec-and-eval rct-complete-command-name "--completion-emacs-icicles")
+           ((error) (setq rct-method-completion-table nil)))))
+    (action
+     ("Completion" . anything-rct-complete)
+     ("RI" . anything-rct-ri))
+    (volatile)
+    (persistent-action . anything-rct-ri)))
+
+(defvar rct-get-all-methods-command "PAGER=cat fri -l")
+(defun rct-get-all-methods ()
+  (interactive)
+  (setq rct-all-methods
+        (mapcar (lambda (fullname)
+                  (replace-regexp-in-string "^.+[:#.]\\([^:#.]+\\)$"
+                                            "\\1\t[\\&]" fullname))
+                (split-string (shell-command-to-string rct-get-all-methods-command) "\n"))))
+
+(defvar rct-all-methods (rct-get-all-methods))
+(defvar anything-c-source-complete-ruby-all
+  '((name . "Ruby Method Completion (ALL)")
+    (candidates
+     . (lambda ()
+        (let ((case-fold-search nil)
+              (re (format "[:#.]%s" (with-current-buffer anything-current-buffer
+                                   (symbol-at-point)))))
+          (remove-if-not
+           (lambda (meth) (string-match re meth))
+           rct-all-methods))))
+    (action
+     ("Completion" . anything-rct-complete)
+     ("RI" . anything-rct-ri))
+    (persistent-action . anything-rct-ri)))
+
+(defun rct-complete-symbol--anything ()
+  (interactive)
+  (let ((anything-sources (list anything-c-source-complete-ruby anything-c-source-complete-ruby-all)))
+    (anything)))
+
+(provide 'anything-rcodetools)
+
+;; How to save (DO NOT REMOVE!!)
+;; (emacswiki-post "anything-rcodetools.el")
+;;; install-elisp.el ends here