myrurema 0.0.4 → 0.1.0

data/HISTORY

@@ -0,0 +1,7 @@
+2010-09-01 version 0.1.0
+
+  * new: --preview
+
+2010-09-01 version 0.0.4
+
+  * can be installed by ruby-station (>= 0.1.6)

data/README.mkd

@@ -49,23 +49,33 @@ rubyverオプションを指定します。
 
     $ rurema --init --rubyver=1.9.2
 
+ruremadirオプションとrubyverオプションは、以下の全てのコマンドに対して
+指定可能です。
+
 ### リファレンスを引く
 
 ruremaコマンドにメソッド名やクラス名を与えると、リファレンスを表示します。
 
     $ rurema Array#index
 
-### ローカルWebサーバの起動
+引数によっては、複数の候補が表示されることもあります。
+
+    $ rurema index
+
+最後に数字を付けることで、指定した番号の候補を表示できます。
+
+    $ rurema index 1
 
-bitclustには、Webサーバを起動してブラウザからリファレンスを
-閲覧できるようにする機能があります。
+### ローカルWebサーバの起動
 
---serverオプションを指定すると、ローカルにWebサーバが起動します。
+--serverオプションを指定すると、ローカルにWebサーバが起動し、
+ブラウザからリファレンスを閲覧することができます。
 --browserオプションを指定すると、同時にブラウザでリファレンスのURLを開きます。
 
     $ rurema --server --browser
 
-デフォルトではRuby 1.8.7ならポート10187を使います。ポートを変更するには--portオプションを指定します。
+デフォルトではRubyのバージョンに合わせたポート番号(例：Ruby 1.8.7なら
+ポート10187)を使います。ポート番号を変更するには--portオプションを指定します。
 
     $ rurema --server --port=9999 --browser
 
@@ -77,10 +87,43 @@ Rubyリファレンス刷新計画では、最新のRubyに完全対応したリ
 
     $ rurema --update
 
-この場合もruremadirオプション、rubyverオプションが指定可能です。
+リファレンスの書き方
+====================
+
+myruremaは、リファレンスを書くための機能も少し備えています。
+
+リファレンスの原稿は、~/.rurema/doctree/refm/api/src/ 以下に置かれています。
+
+### プレビュー
+
+--previewオプションを指定すると、特定のメソッドをHTMLファイルにコンパイル
+します。
+
+    rurema --preview _builtin/Array Array#pop
+
+コンパイル結果は/tmp/rurema_preview.htmlに保存されます。
+--browserオプションを指定すると、コンパイル結果をブラウザで開きます。
+
+    rurema --preview _builtin/Array Array#pop --browser
+
+うまく書けたら、svn diffコマンドで差分を表示し、
+るりまの[Issue Tracker](http://redmine.ruby-lang.org/projects/rurema/issues)
+にチケットを作って、パッチを貼り付けてください。
+内容が問題なければ、るりまコミッターがコミットしてくれます。
+
+パッチがたくさん採用されれば、そのうちに、あなたもるりまコミッターの
+一員に勧誘されるでしょう。 :-)
+
+### ディレクトリの移動
+
+「cd ~/.rurema/doctree/refm/api/src/」と毎回タイプするのは面倒なので、
+
+    $ `rurema --preview`
+
+で同じことができるようになっています(zshの場合)。
 
 その他
-------
+======
 
 ライセンスはbitclustのものに準じます。
 

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/spec/commands.rb

@@ -6,6 +6,8 @@ class MyRurema
     @cmds << cmd
   end
   attr_reader :cmds
+
+  def exit; end
 end
 
 CASES = {
@@ -45,6 +47,23 @@ CASES = {
     %r{standalone},
     %r{(start|open) http://localhost:}
   ],
+
+  "rurema --preview" => [
+    %r{cd .*doctree/refm/api/src},
+  ],
+
+  "rurema --preview _builtin/Array" => [
+    %r{bc-tohtml.*_builtin/Array .*rurema_preview.html},
+  ],
+
+  "rurema --preview _builtin/Array Array#pop" => [
+    %r{bc-tohtml.*_builtin/Array --target=Array#pop.*rurema_preview.html},
+  ],
+
+  "rurema --preview Array --browser" => [
+    %r{bc-tohtml},
+    %r{(start|open) .*rurema_preview.html}
+  ],
 }
 
 describe MyRurema do

data/src/myrurema.rb

@@ -1,6 +1,7 @@
 require 'optparse'
 require 'pathname'
 require 'shellwords'
+require 'tmpdir'
 
 class Pathname; alias / +; end
 
@@ -12,7 +13,6 @@ class Options
     @dry_run = false
     @ruremadir = Pathname("~/.rurema").expand_path
     @rubyver = RUBY_VERSION
-    @query = ""
 
     @optionparser = OptionParser.new{|o|
       o.on("--init",
@@ -27,13 +27,19 @@ class Options
            "start web server"){
         @command = :server 
       }
+      o.on("--preview",
+           "render a reference as HTML"){
+        @command = :preview 
+      }
+
+      o.on("----"){}
 
       o.on("--port=N",
            "port number of the web browser (only meaningful with --server)"){|n|
         @port = n.to_i
       }
       o.on("--browser",
-           "open web browser (only meaningful with --server)"){
+           "open web browser (only meaningful with --server or --preview)"){
         @open_browser = true 
       }
       o.on("--dry-run",
@@ -48,6 +54,9 @@ class Options
            "specify Ruby version (default: #{@rubyver})"){|str|
         @rubyver = str
       }
+
+      o.on("-----"){}
+
       o.on("--version",
            "show version of myrurema"){
         puts MyRurema::VERSION
@@ -59,12 +68,10 @@ class Options
         exit
       }
     }
-    @query, @num = @optionparser.parse(argv)
-    @query = "" if @query.nil?
-    @num = @num.to_i if @num
+    @rest_args = @optionparser.parse(argv)
   end
   attr_accessor :dry_run, :ruremadir, :rubyver, :open_browser
-  attr_accessor :command, :query, :num, :port
+  attr_accessor :command, :port, :rest_args
 
   def ruremadir=(dir)
     @ruremadir = Pathname(dir)
@@ -84,15 +91,18 @@ class MyRurema
   end
 
   def run
-    case 
-    when @opt.command
+    if @opt.command
       send(@opt.command)
-    when @opt.query.empty?
-      @opt.usage
-    when @opt.num
-      search_num(@opt.query, @opt.num, @opt.rubyver)
     else
-      search(@opt.query, @opt.rubyver)
+      query, num = *@opt.rest_args
+      case
+      when query && num
+        search_num(query, num.to_i, @opt.rubyver)
+      when query
+        search(query, @opt.rubyver)
+      else
+        @opt.usage
+      end
     end
   end
 
@@ -144,6 +154,28 @@ class MyRurema
     end
     th.join
   end
+
+  TMP_FILE = Pathname(Dir.tmpdir)/'rurema_preview.html'
+  def preview
+    file, target = *@opt.rest_args
+
+    if file
+      error "file not found: #{file}" unless File.exist?(file)
+
+      result = sh "#{bitclust_path/'tools/bc-tohtml.rb'}" +
+                    " #{file}" +
+                    (target ? " --target=#{target}" : "") +
+                    " --ruby=#{@opt.rubyver}" +
+                    " > #{TMP_FILE}"
+
+      if result && @opt.open_browser
+        cmd = (/mswin/ =~ RUBY_PLATFORM) ? "start" : "open"
+        sh "#{cmd} #{TMP_FILE}"
+      end
+    else
+      sh "cd #{doctree_path/'refm/api/src'}"
+    end
+  end
   
   private
 
@@ -201,5 +233,6 @@ class MyRurema
 
   def error(msg)
     $stderr.puts msg
+    exit
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: myrurema
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 4
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Yutaka HARA
@@ -28,6 +28,7 @@ extensions: []
 extra_rdoc_files: 
 - README.mkd
 files: 
+- HISTORY
 - README.mkd
 - Rakefile
 - VERSION