myrurema 0.2.0 → 0.3.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    myrurema (0.3.0)
+      launchy (~> 2.0.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    diff-lcs (1.1.3)
+    launchy (2.0.5)
+      addressable (~> 2.2.6)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  myrurema!
+  rspec (> 2.0)

data/README.mkd

@@ -34,7 +34,7 @@ RubyGemsでインストールします。
 新しくデータベースを作成します。
 (データベースの作成には数分かかります。)
 
-別のディレクトリにインストールしたい場合はruremadirオプションを指定します。
+(別のディレクトリにインストールしたい場合はruremadirオプションを指定します。)
 
     $ rurema --init --ruremadir=/some/where
 
@@ -44,8 +44,8 @@ bitclustは、Rubyの各バージョンに合わせたデータベースを
 作成するようになっています。デフォルトでは、お使いのRubyと
 同じバージョンのデータベースを生成します。
 
-別のRubyバージョン用のリファレンスデータベースを作成するには、
-rubyverオプションを指定します。
+(別のRubyバージョン用のリファレンスデータベースを作成するには、
+rubyverオプションを指定します。)
 
     $ rurema --init --rubyver=1.9.2
 
@@ -58,6 +58,17 @@ ruremaコマンドにメソッド名やクラス名を与えると、リファ
 
     $ rurema Array#index
 
+クラス名・メソッド名の一部だけでも検索できます。
+
+    $ rurema Ar ras
+    (Array#rassocのリファレンスが表示される)
+
+あるクラスの全てのインスタンスメソッドを表示するには以下のようにします。
+
+    $ rurema Array#
+    
+    (お使いのシェルによっては rurema Array\# とする必要があります)
+
 引数によっては、複数の候補が表示されることもあります。
 
     $ rurema each_w
@@ -78,8 +89,8 @@ ruremaコマンドにメソッド名やクラス名を与えると、リファ
 
     $ rurema --server --browser
 
-デフォルトではRubyのバージョンに合わせたポート番号(例：Ruby 1.8.7なら
-ポート10187)を使います。ポート番号を変更するには--portオプションを指定します。
+(デフォルトではRubyのバージョンに合わせたポート番号(例：Ruby 1.8.7なら
+ポート10187)を使います。ポート番号を変更するには--portオプションを指定します。)
 
     $ rurema --server --port=9999 --browser
 

data/Rakefile

@@ -1,34 +1,2 @@
-#
-# Rakefile to creating gems
-#
-# configurations:
-PROJECT_NAME = File.basename(File.dirname(__FILE__))
-
-begin
-  require 'jeweler'
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
-
-Jeweler::Tasks.new do |gemspec|
-  gemspec.name = "#{PROJECT_NAME}"
-  gemspec.summary = "A tool for Rurema (the new Japanese Ruby reference manual)"
-  gemspec.email = "yutaka.hara/at/gmail.com"
-  gemspec.homepage = "http://github.com/yhara/#{PROJECT_NAME}"
-  gemspec.description = gemspec.summary
-  gemspec.authors = ["Yutaka HARA"]
-  gemspec.executables = ["rurema"]
-end
-
-desc "install current source as a gem"
-task :dogfood => [:gemspec, :build] do
-  sh "gemi pkg/#{PROJECT_NAME}-#{File.read("VERSION").chomp}.gem"
-end
-
-desc "uninstall the installed gem"
-task :undogfood do
-  sh "gemi -u #{PROJECT_NAME}"
-end
-
-desc "uninstall, then install current source as gem"
-task :redogfood => [:undogfood, :dogfood]
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/bin/rurema

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
-require File.expand_path("../src/myrurema", File.dirname(__FILE__))
+$LOAD_PATH.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'myrurema'
 
 MyRurema.new.run

data/lib/myrurema/options.rb

@@ -0,0 +1,91 @@
+class MyRurema
+  class Options
+    def initialize(argv)
+      @command = nil
+      @open_browser = false
+      @port = nil
+      @dry_run = false
+      @no_ask = false
+      @ruremadir = Pathname("~/.rurema").expand_path
+      @rubyver = RUBY_VERSION
+
+      @optionparser = OptionParser.new{|o|
+        o.banner = [
+          "Usage: rurema [options] <method name or class name>",
+        ].join("\n")
+
+        o.on("--init",
+             "initialize rurema system"){
+          @command = :init
+        }
+        o.on("--update",
+             "update documents and database"){
+          @command = :update
+        }
+        o.on("--server",
+             "start web server"){
+          @command = :server 
+        }
+        o.on("--preview",
+             "render a reference as HTML"){
+          @command = :preview 
+        }
+        o.on("--list",
+             "list all classes"){
+          @command = :list 
+        }
+
+        o.on("---- (OPTIONS)"){}
+
+        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 or --preview)"){
+          @open_browser = true 
+        }
+        o.on("--dry-run",
+             "show commands only"){
+          @dry_run = true 
+        }
+        o.on("--no-ask",
+             "do not ask keyboard input"){
+          @no_ask = true 
+        }
+        o.on("--ruremadir=PATH",
+             "specify rurema directory (default: #{@ruremadir})"){|path|
+          @ruremadir = Pathname(path)
+        }
+        o.on("--rubyver=STR",
+             "specify Ruby version (default: #{@rubyver})"){|str|
+          @rubyver = str
+        }
+
+        o.on("----- (INFO)"){}
+
+        o.on("--version",
+             "show version of myrurema"){
+          puts "myrurema version #{MyRurema::VERSION}"
+          exit
+        }
+        o.on("--help",
+             "show this message"){
+          puts o
+          exit
+        }
+      }
+      @rest_args = @optionparser.parse(argv)
+    end
+    attr_accessor :dry_run, :no_ask, :ruremadir, :rubyver,
+                  :open_browser, :command, :port, :rest_args
+
+    def ruremadir=(dir)
+      @ruremadir = Pathname(dir)
+    end
+
+    def usage
+      puts @optionparser
+    end
+  end
+end

data/lib/myrurema/version.rb

@@ -0,0 +1,4 @@
+class MyRurema
+  VERSION = "0.3.0"
+end
+

data/{src → lib}/myrurema.rb

@@ -3,100 +3,17 @@ require 'pathname'
 require 'shellwords'
 require 'tmpdir'
 
+require 'launchy'
+require 'myrurema/options'
+require 'myrurema/version'
+
+# Extend Pathname so that you can write 
+#   foo / "bar"    #=> Pathname("foo/bar")
+# instead of
+#   foo + "bar"
 class Pathname; alias / +; end
 
-class Options
-  def initialize(argv)
-    @command = nil
-    @open_browser = false
-    @port = nil
-    @dry_run = false
-    @no_ask = false
-    @ruremadir = Pathname("~/.rurema").expand_path
-    @rubyver = RUBY_VERSION
-
-    @optionparser = OptionParser.new{|o|
-      o.banner = [
-        "Usage: rurema [options] <method name or class name>",
-      ].join("\n")
-
-      o.on("--init",
-           "initialize rurema system"){
-        @command = :init
-      }
-      o.on("--update",
-           "update documents and database"){
-        @command = :update
-      }
-      o.on("--server",
-           "start web server"){
-        @command = :server 
-      }
-      o.on("--preview",
-           "render a reference as HTML"){
-        @command = :preview 
-      }
-      o.on("--list",
-           "list all classes"){
-        @command = :list 
-      }
-
-      o.on("---- (OPTIONS)"){}
-
-      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 or --preview)"){
-        @open_browser = true 
-      }
-      o.on("--dry-run",
-           "show commands only"){
-        @dry_run = true 
-      }
-      o.on("--no-ask",
-           "do not ask keyboard input"){
-        @no_ask = true 
-      }
-      o.on("--ruremadir=PATH",
-           "specify rurema directory (default: #{@ruremadir})"){|path|
-        @ruremadir = Pathname(path)
-      }
-      o.on("--rubyver=STR",
-           "specify Ruby version (default: #{@rubyver})"){|str|
-        @rubyver = str
-      }
-
-      o.on("----- (INFO)"){}
-
-      o.on("--version",
-           "show version of myrurema"){
-        puts MyRurema::VERSION
-        exit
-      }
-      o.on("--help",
-           "show this message"){
-        puts o
-        exit
-      }
-    }
-    @rest_args = @optionparser.parse(argv)
-  end
-  attr_accessor :dry_run, :no_ask, :ruremadir, :rubyver,
-                :open_browser, :command, :port, :rest_args
-
-  def ruremadir=(dir)
-    @ruremadir = Pathname(dir)
-  end
-
-  def usage
-    puts @optionparser
-  end
-end
-
 class MyRurema
-  VERSION = File.read((Pathname(__FILE__).dirname/"../VERSION").expand_path)
   SVN_URL = "http://jp.rubyist.net/svn/rurema" 
 
   def initialize(opt=Options.new(ARGV))
@@ -107,14 +24,24 @@ class MyRurema
     if @opt.command
       send(@opt.command)
     else
-      query, num = *@opt.rest_args
-      case
+      query = @opt.rest_args
+      num = if !query.empty? and query.last =~ /\A\d+\z/
+              query.pop.to_i
+            else
+              nil
+            end
+      
+      case 
+      when query.empty?
+        if num
+          search(num, @opt.rubyver)
+        else
+          @opt.usage
+        end
       when query && num
-        search_num(query, num.to_i, @opt.rubyver)
-      when query
-        search(query, @opt.rubyver)
+        search_num(query, num, @opt.rubyver)
       else
-        @opt.usage
+        search(query, @opt.rubyver)
       end
     end
   end
@@ -130,19 +57,24 @@ class MyRurema
     refresh_db(@opt.rubyver)
   end
 
+  # - query: Array or String
+  # - ver: String
   def search(query, ver)
     should_have_db(ver)
 
-    cmd = "#{bitclust_path/'bin/refe.rb'}" +
-            " #{Shellwords.escape query} -d #{db_path(ver)}"
+    args = Array(query).map{|s| Shellwords.escape s}.join(" ")
+    cmd = "#{bitclust_path/'bin/refe'}" +
+            " #{args} -d #{db_path(ver)}"
     sh cmd, :silent => true do |txt|
-      if txt.lines.count < 10 and
-         txt.lines.first(2).join =~ /#{query}.*#{query}/m and
+      lines = txt.lines.to_a
+      if lines.count < 10 and
+         lines.first(2).join =~ /#{query}.*#{query}/m and
+         lines[1] !~ /^--- / and   # ad hoc :-(  see Issue #2
          !@opt.no_ask
 
         words = {}
         k = 0
-        puts txt.lines.map{|line|
+        puts lines.map{|line|
           line.gsub(/(\S+)/){|str|
             k+=1
             words[k] = str
@@ -165,7 +97,7 @@ class MyRurema
   def search_num(query, num, ver)
     should_have_db(ver)
 
-    result = `#{bitclust_path/'bin/refe.rb'} #{query} -d #{db_path(ver)}`
+    result = `#{bitclust_path/'bin/refe'} #{query} -d #{db_path(ver)}`
     word = result.split[num-1]
     if word
       word.gsub!(/\.#/, ".")    # avoid multi-hit for a module function
@@ -179,7 +111,7 @@ class MyRurema
   def list
     should_have_db(@opt.rubyver)
 
-    sh "#{bitclust_path/'bin/refe.rb'}" +
+    sh "#{bitclust_path/'bin/refe'}" +
          " -l -d #{db_path(@opt.rubyver)}", :silent => true
   end
 
@@ -187,16 +119,23 @@ class MyRurema
     port = @opt.port || default_port(@opt.rubyver)
     th = Thread.new{
       sh "#{bitclust_path/'standalone.rb'}" +
+           " --srcdir=#{bitclust_path}" +
            " --baseurl=http://localhost:#{port}" +
            " --port=#{port}" +
            " --database=#{db_path(@opt.rubyver)}" +
-           " --debug"
+           " --debug" # needed to avoid the server running as daemon :-(
     }
+
+    url = "http://localhost:#{port}/view/"
+    puts "Starting BitClust server .."
+    puts "Open #{url} in your browser."
+    puts
+
     if @opt.open_browser
       sleep 1  # wait for the server to start
-      cmd = (/mswin/ =~ RUBY_PLATFORM) ? "start" : "open"
-      sh "#{cmd} http://localhost:#{port}/view/"
+      Launchy.open(url)
     end
+
     th.join
   end
 
@@ -229,7 +168,7 @@ class MyRurema
   end
 
   def init_db(ver)
-    sh "#{bitclust_path/'bin/bitclust.rb'}" +
+    sh "#{bitclust_path/'bin/bitclust'}" +
           " -d #{db_path(ver)} init version=#{ver} encoding=euc-jp"
 
     refresh_db(ver)
@@ -238,7 +177,7 @@ class MyRurema
   def refresh_db(ver)
     puts "Updating Rurema database:"
     puts "This will take a few minutes. Please be patient."
-    sh "#{bitclust_path/'bin/bitclust.rb'}" +
+    sh "#{bitclust_path/'bin/bitclust'}" +
           " -d #{db_path(ver)}" +
           " update --stdlibtree=#{doctree_path/'refm/api/src'}"
   end
@@ -283,7 +222,12 @@ class MyRurema
   end
 
   def error(msg)
-    $stderr.puts msg
+    $stderr.puts msg unless $MYRUREMA_TEST
     exit
   end
+
+  def puts(str="")
+    Kernel.puts(str) unless $MYRUREMA_TEST
+  end
+
 end

data/myrurema.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path('../lib/myrurema/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yutaka HARA"]
+  gem.email         = ["yutaka.hara.gmail.com"]
+  gem.description   = %q{myrurema provides a command 'rurema', which helps searching/browsing/writing the Japanese Ruby documents (a.k.a Rurema http://bugs.ruby-lang.org/projects/rurema/wiki .)}
+  gem.summary       = %q{A tool for Rurema (the new Japanese Ruby reference manual)}
+  gem.homepage      = 'http://github.com/yhara/myrurema'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "myrurema"
+  gem.require_paths = ['lib']
+  gem.version       = MyRurema::VERSION
+
+  gem.add_dependency("launchy", "~> 2.0.5")
+  gem.add_development_dependency("rspec", ">= 2.0")
+end

data/spec/commands.rb

@@ -1,5 +1,8 @@
-require File.expand_path("../src/myrurema", File.dirname(__FILE__))
+require File.expand_path("../lib/myrurema", File.dirname(__FILE__))
 
+$MYRUREMA_TEST = true
+
+# Override methods for testing
 class MyRurema
   def sh(cmd, opt={})
     @cmds ||= []
@@ -10,12 +13,14 @@ class MyRurema
   def exit; end
 end
 
+module Launchy; def self.open(*args); end; end
+
 CASES = {
   "rurema --init" => [
-    %r{svn co .*doctree},
-    %r{svn co .*bitclust},
-    %r{bitclust.*init},
-    %r{bitclust.*update},
+    %r{svn co -rHEAD .*/doctree/trunk .*},
+    %r{svn co -rHEAD .*/bitclust/trunk .*},
+    %r{.*/bin/bitclust -d .* init version=.* encoding=euc-jp},
+    %r{.*/bin/bitclust -d .* update --stdlibtree=.*/refm/api/src},
   ],
 
   "rurema --init --rubyver=1.8.7" => [
@@ -32,20 +37,24 @@ CASES = {
   ],
 
   "rurema Array" => [
-    %r{refe.*Array},
+    %r{.*/refe Array -d .*}
+  ],
+
+  "rurema Ar i" => [
+    %r{.*/refe Ar i -d .*},
   ],
 
   "rurema --server" => [
-    %r{standalone},
+    %r{.*/standalone.rb --srcdir=.* --baseurl=http://localhost:.* --port=.* --database=.* --debug}
   ],
 
   "rurema --server --port=9898" => [
-    %r{standalone.*--port=9898},
+    %r{.*/standalone.rb --srcdir=.* --baseurl=http://localhost:.* --port=9898 --database=.* --debug}
   ],
 
   "rurema --server --browser" => [
-    %r{standalone},
-    %r{(start|open) http://localhost:}
+    %r{.*/standalone.rb --srcdir=.* --baseurl=http://localhost:.* --port=.* --database=.* --debug}
+    # Todo: Launchy.should_receive(:open)
   ],
 
   "rurema --preview" => [
@@ -70,20 +79,20 @@ CASES = {
 }
 
 describe MyRurema do
-  it "should execute expected commands" do
-    CASES.each do |command, expects|
-      opt = Options.new(command.split[1..-1])
+  CASES.each do |command, expects|
+    it "should respond to #{command}" do
+      opt = MyRurema::Options.new(command.split.drop(1))
       my = MyRurema.new(opt)
       my.run
 
       cmds = my.cmds
       i = 0
       expects.each do |pattern|
-        pattern.should satisfy{
-          i = cmds[i..-1].index{|cmd| pattern =~ cmd}
-          not i.nil?
+        cmds[i..-1].should satisfy{|ary|
+          ary.any?{|s| pattern =~ s}
         }
-        i += 1
+
+        i = cmds[i..-1].index{|cmd| pattern =~ cmd} + 1
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: myrurema
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,25 +9,53 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-05 00:00:00.000000000 Z
-dependencies: []
-description: A tool for Rurema (the new Japanese Ruby reference manual)
-email: yutaka.hara/at/gmail.com
+date: 2012-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: &2154448780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154448780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2154448100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154448100
+description: myrurema provides a command 'rurema', which helps searching/browsing/writing
+  the Japanese Ruby documents (a.k.a Rurema http://bugs.ruby-lang.org/projects/rurema/wiki
+  .)
+email:
+- yutaka.hara.gmail.com
 executables:
 - rurema
 extensions: []
-extra_rdoc_files:
-- README.mkd
+extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
 - HISTORY
 - README.mkd
 - Rakefile
-- VERSION
 - bin/rurema
 - features/basic_commands.feature
+- lib/myrurema.rb
+- lib/myrurema/options.rb
+- lib/myrurema/version.rb
 - main.rb
+- myrurema.gemspec
 - spec/commands.rb
-- src/myrurema.rb
 homepage: http://github.com/yhara/myrurema
 licenses: []
 post_install_message: 
@@ -48,8 +76,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A tool for Rurema (the new Japanese Ruby reference manual)
-test_files: []
+test_files:
+- features/basic_commands.feature
+- spec/commands.rb
+has_rdoc: 

data/VERSION

@@ -1 +0,0 @@
-0.2.0