myrurema 0.0.0

data/README.mkd

@@ -0,0 +1,80 @@
+myrurema
+========
+
+myrurema は、Rubyの次世代日本語版リファレンスである
+「Rubyリファレンスマニュアル刷新計画」(通称るりま) のリファレンスを
+手軽に参照するためのツールです。
+
+インストール
+------------
+
+Ruby >= 1.8.xと、Subversionが必要です。
+
+RubyGemsでインストールします。
+
+    $ sudo gem install myrurema
+
+するとruremaコマンドが使えるようになります。
+
+    $ rurema
+    (ヘルプが表示される)
+
+使い方
+------
+
+順を追って説明します。
+
+### 初期化
+
+まず、リファレンスのデータをダウンロードする必要があります。
+
+    $ rurema --init
+
+のようにすると、~/.rurema/以下にbitclustとdoctreeをダウンロードし、
+新しくデータベースを作成します。
+(データベースの作成には数分かかります。)
+
+別のディレクトリにインストールしたい場合はruremadirオプションを指定します。
+
+    $ rurema --init --ruremadir=/some/where
+
+### データベースについて
+
+bitclustは、Rubyの各バージョンに合わせたデータベースを
+作成するようになっています。デフォルトでは、お使いのRubyと
+同じバージョンのデータベースを生成します。
+
+別のRubyバージョン用のリファレンスデータベースを作成するには、
+rubyverオプションを指定します。
+
+    $ rurema --init --rubyver=1.9.2
+
+### リファレンスを引く
+
+ruremaコマンドにメソッド名やクラス名を与えると、リファレンスを表示します。
+
+    $ rurema Array#index
+
+### データベースの更新
+
+Rubyリファレンス刷新計画では、最新のRubyに完全対応したリファレンスを目指し、
+日夜更新が続いています。最新のリファレンスデータに更新するには、
+--updateコマンドを使います。
+
+    $ rurema --update
+
+この場合もruremadirオプション、rubyverオプションが指定可能です。
+
+その他
+------
+
+ライセンスはbitclustのものに準じます。
+
+  * [Rubyリファレンスマニュアル刷新計画](http://redmine.ruby-lang.org/projects/show/rurema)
+  * [ソースコード(github)](http://github.com/yhara/myrurema)
+
+myruremaはいまのところyharaが個人的に作成しています。
+
+yhara (Yutaka HARA)
+http://route477.net/
+yutaka.hara.gmail.com

data/Rakefile

@@ -0,0 +1,45 @@
+#
+# 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 "sudo gem install pkg/#{PROJECT_NAME}-#{File.read("VERSION").chomp}.gem"
+end
+
+desc "uninstall the installed gem"
+task :undogfood do
+  sh "sudo gem uninstall #{PROJECT_NAME}"
+end
+
+desc "uninstall, then install current source as gem"
+task :redogfood => [:undogfood, :dogfood]
+
+desc "uninstall temporary gem and install from github"
+task :nodogfood do
+  sh "sudo gem uninstall #{PROJECT_NAME}"
+  sh "sudo gem install yhara-#{PROJECT_NAME}"
+end
+
+desc "check for gem to be built"
+task :stalk do
+  sh "gemstalk yhara #{PROJECT_NAME}"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/rurema

@@ -0,0 +1,140 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'pathname'
+
+class Pathname; alias / +; end
+
+class Options
+  def initialize(argv)
+    @dry_run = false
+    @ruremadir = Pathname("~/.rurema").expand_path
+    @rubyver = RUBY_VERSION
+    @command = nil
+    @query = ""
+
+    @optionparser = OptionParser.new{|o|
+      o.on("--init",
+           "initialize rurema"){
+        @command = :init
+      }
+      o.on("--update",
+           "update documents and database"){
+        @command = :update
+      }
+
+      o.on("--dry-run",
+           "show commands only"){
+        @dry_run = 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("--help",
+           "show this message"){
+        puts o
+        exit
+      }
+    }
+    @query = @optionparser.parse(argv).join(" ")
+  end
+  attr_reader :dry_run, :ruremadir, :rubyver
+  attr_reader :command, :query
+
+  def usage
+    puts @optionparser
+  end
+end
+
+class Rurema
+  SVN_URL = "http://jp.rubyist.net/svn/rurema" 
+
+  def initialize(opt=Options.new(ARGV))
+    @opt = opt
+  end
+
+  def run
+    if @opt.command
+      send(@opt.command)
+    elsif @opt.query.empty?
+      @opt.usage
+    else
+      search(@opt.query, @opt.rubyver)
+    end
+  end
+
+  def init
+    sh "svn co -rHEAD #{SVN_URL}/doctree/trunk #{doctree_path}"
+    sh "svn co -rHEAD #{SVN_URL}/bitclust/trunk #{bitclust_path}"
+    init_db(@opt.rubyver)
+  end
+
+  def update
+    sh "svn up #{doctree_path}"
+    refresh_db(@opt.rubyver)
+  end
+
+  def search(query, ver)
+    unless has_db?(ver)
+      puts "You don't have a database for ruby #{ver}."
+      puts "Make it now? [y/n]"
+      if $stdin.gets.chomp.downcase == "y"
+        init_db(ver)
+      else
+        exit
+      end
+    end
+
+    sh "#{bitclust_path/'bin/refe.rb'}" +
+          " #{query} -d #{db_path(ver)}", :silent => true
+  end
+
+  def server
+    # TODO
+  end
+  
+  private
+
+  def init_db(ver)
+    sh "#{bitclust_path/'bin/bitclust.rb'}" +
+          " -d #{db_path(ver)} init version=#{ver} encoding=euc-jp"
+
+    refresh_db(ver)
+  end
+
+  def refresh_db(ver)
+    puts "Updating Rurema database:"
+    puts "This will take a few minutes. Please be patient."
+    sh "#{bitclust_path/'bin/bitclust.rb'}" +
+          " -d #{db_path(ver)}" +
+          " update --stdlibtree=#{doctree_path/'refm/api/src'}"
+  end
+
+  def bitclust_path
+    @opt.ruremadir / "bitclust"
+  end
+
+  def doctree_path
+    @opt.ruremadir / "doctree"
+  end
+
+  def has_db?(ver)
+    db_path(ver).directory?
+  end
+
+  def db_path(ver)
+    raise ArgumentError, "malformed ver: #{ver}" unless ver =~ /\A\d.\d.\d\z/
+    @opt.ruremadir / "db" / ver
+  end
+
+  def sh(cmd, opt={})
+    puts cmd unless opt[:silent]
+    system cmd unless @opt.dry_run
+  end
+end
+
+Rurema.new.run

data/features/basic_commands.feature

@@ -0,0 +1,27 @@
+Feature: Basic commands
+  Background:
+    Given I have the config file with:
+      """
+      rubys:
+        - name: MRI 1.8
+          command: 'gem'
+      """
+
+  $B%7%J%j%*(B: $B=i4|2=(B
+    $BA0Ds!'$k$j$^%G%#%l%/%H%j$,$J$$(B
+    $B$b$7!V(Brurema --init$B!W$r<B9T$7$?(B
+    $B$J$i$P!"$k$j$^%G%#%l%/%H%j$K!V(Bbitclust doctree$B!W$,$G$-$k(B
+    $B$+$D!"%G!<%?%Y!<%9$,:F9=C[$5$l$k(B
+
+  $B%7%J%j%*(B: DB$B99?7(B
+    $BA0Ds!'$k$j$^%G%#%l%/%H%j$K!V(Bdoctree$B!W$,$"$k(B
+    $B$b$7!V(Brurema --update$B!W$r<B9T$7$?(B
+    $B$J$i$P!"(Bdoctree$B$,%"%C%W%G!<%H$5$l$k(B
+    $B$+$D!"%G!<%?%Y!<%9$,:F9=C[$5$l$k(B
+
+  $B%7%J%j%*(B: $B8!:w(B
+    $BA0Ds!'$k$j$^%G%#%l%/%H%j$K%G!<%?%Y!<%9$,$"$k(B
+    $BA0Ds!'$k$j$^%G%#%l%/%H%j$K!V(Bbitclust doctree db-x.x.x$B!W$,$"$k(B
+    $B$b$7!V(Brurema Array$B!W$r<B9T$7$?(B
+    $B$J$i$P!"(BArray$B$N%I%-%e%a%s%H$,I=<($5$l$k(B
+

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: myrurema
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Yutaka HARA
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-05 00:00:00 +09:00
+default_executable: rurema
+dependencies: []
+
+description: A tool for Rurema (the new Japanese Ruby reference manual)
+email: yutaka.hara/at/gmail.com
+executables: 
+- rurema
+extensions: []
+
+extra_rdoc_files: 
+- README.mkd
+files: 
+- README.mkd
+- Rakefile
+- VERSION
+- bin/rurema
+- features/basic_commands.feature
+has_rdoc: true
+homepage: http://github.com/yhara/myrurema
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A tool for Rurema (the new Japanese Ruby reference manual)
+test_files: []
+