RubyGems - rdtool - Versions diffs - 0.6.23 - Mend

rdtool 0.6.23

Files changed (94) hide show

data/COPYING.txt +674 -0
data/Gemfile +9 -0
data/HISTORY +284 -0
data/LICENSE.txt +58 -0
data/MANIFEST +89 -0
data/README.html +44 -0
data/README.ja.html +46 -0
data/README.rd +52 -0
data/README.rd.ja +54 -0
data/Rakefile +29 -0
data/TODO +15 -0
data/VERSION +1 -0
data/bin/rd2 +281 -0
data/bin/rdswap.rb +207 -0
data/doc/rd-draft.rd +479 -0
data/doc/rd-draft.rd.ja +487 -0
data/lib/rd/block-element.rb +114 -0
data/lib/rd/complex-list-item.rb +65 -0
data/lib/rd/desclist.rb +55 -0
data/lib/rd/document-struct.rb +46 -0
data/lib/rd/dot.rd2rc +18 -0
data/lib/rd/element.rb +160 -0
data/lib/rd/filter.rb +255 -0
data/lib/rd/inline-element.rb +233 -0
data/lib/rd/labeled-element.rb +14 -0
data/lib/rd/list.rb +57 -0
data/lib/rd/loose-struct.rb +11 -0
data/lib/rd/methodlist.rb +57 -0
data/lib/rd/output-format-visitor.rb +28 -0
data/lib/rd/package.rb +4 -0
data/lib/rd/parser-util.rb +14 -0
data/lib/rd/post-install +1 -0
data/lib/rd/rbl-file.rb +69 -0
data/lib/rd/rbl-suite.rb +37 -0
data/lib/rd/rd-struct.rb +86 -0
data/lib/rd/rd2html-lib.rb +490 -0
data/lib/rd/rd2html-opt.rb +67 -0
data/lib/rd/rd2man-lib.rb +241 -0
data/lib/rd/rd2rdo-lib.rb +19 -0
data/lib/rd/rd2rmi-lib.rb +32 -0
data/lib/rd/rdblockparser.ry +518 -0
data/lib/rd/rdblockparser.tab.rb +1050 -0
data/lib/rd/rdfmt.rb +15 -0
data/lib/rd/rdinlineparser.ry +503 -0
data/lib/rd/rdinlineparser.tab.rb +1243 -0
data/lib/rd/rdvisitor.rb +214 -0
data/lib/rd/reference-resolver.rb +114 -0
data/lib/rd/search-file.rb +14 -0
data/lib/rd/tree.rb +103 -0
data/lib/rd/version.rb +39 -0
data/lib/rd/visitor.rb +86 -0
data/makerdtool.rb +75 -0
data/setup.rb +1596 -0
data/test.rb +33 -0
data/test/data/includee1.html +1 -0
data/test/data/includee2.html +1 -0
data/test/data/includee3.nothtml +1 -0
data/test/data/includee4.xhtml +0 -0
data/test/data/label.rbl +2 -0
data/test/data/label2.rbl +2 -0
data/test/data/sub/includee2.html +1 -0
data/test/data/sub/includee4.html +0 -0
data/test/dummy-observer.rb +6 -0
data/test/dummy.rb +33 -0
data/test/temp-dir.rb +19 -0
data/test/test-block-parser.rb +46 -0
data/test/test-desclist-item.rb +219 -0
data/test/test-document-element.rb +46 -0
data/test/test-document-struct.rb +66 -0
data/test/test-element.rb +46 -0
data/test/test-headline.rb +80 -0
data/test/test-inline-parser.rb +46 -0
data/test/test-list-item.rb +54 -0
data/test/test-list.rb +53 -0
data/test/test-methodlist-item.rb +73 -0
data/test/test-nonterminal-element.rb +170 -0
data/test/test-nonterminal-inline.rb +33 -0
data/test/test-output-format-visitor.rb +48 -0
data/test/test-parser-util.rb +41 -0
data/test/test-rbl-file.rb +156 -0
data/test/test-rbl-suite.rb +43 -0
data/test/test-rd2html-lib.rb +496 -0
data/test/test-rdtree.rb +17 -0
data/test/test-rdvisitor.rb +29 -0
data/test/test-reference-resolver.rb +202 -0
data/test/test-reference.rb +132 -0
data/test/test-search-file.rb +22 -0
data/test/test-terminal-inline.rb +41 -0
data/test/test-textblock.rb +44 -0
data/test/test-tree.rb +82 -0
data/test/test-version.rb +57 -0
data/test/test-visitor.rb +230 -0
data/utils/rd-mode.el +425 -0
metadata +203 -0

data/README.ja.html ADDED Viewed

@@ -0,0 +1,46 @@
+<?xml version="1.0" ?>
+<!DOCTYPE html
+  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>README.ja</title>
+</head>
+<body>
+<h1><a name="label-0" id="label-0">RDtool 0.6.23</a></h1><!-- RDLabel: "RDtool 0.6.23" -->
+<h2><a name="label-1" id="label-1">RDってなに？</a></h2><!-- RDLabel: "RDってなに？" -->
+<p>RDはRubyにおけるPOD(Plain Old Documentation)のようなものです。
+RDtoolはRDのフォーマッタであり、RDをHTMLなどに変換できます。</p>
+<h2><a name="label-2" id="label-2">何が変わった？</a></h2><!-- RDLabel: "何が変わった？" -->
+<p>HISTORYを見てください。</p>
+<h2><a name="label-3" id="label-3">インストールの方法</a></h2><!-- RDLabel: "インストールの方法" -->
+<ol>
+<li>必要なら、<kbd>su</kbd></li>
+<li><kbd>ruby setup.rb</kbd></li>
+<li>utils/rd-mode.elを使いたいならば
+    それらを<em>手で</em>インストールします。</li>
+</ol>
+<h2><a name="label-4" id="label-4">どうやって使うか。</a></h2><!-- RDLabel: "どうやって使うか。" -->
+<p>基本的には、こんな感じ。</p>
+<pre>% rd2 rdfile.rd &gt; outputfile</pre>
+<p>フォーマットライブラリを指定したい時は、こう。</p>
+<pre>% rd2 -r library rdfile.rd &gt; outputfile</pre>
+<p><kbd> rd2 --help </kbd>でオプションの詳細がでます。</p>
+<p>フォーマットライブラリ依存のオプションは先にフォーマットライブラリの
+指定をしてから<kbd>--help</kbd>。例えば、</p>
+<pre>% rd2 -r rd/rd2html-lib.rb --help</pre>
+<p>rd2はホームディレクトリにある".rd2rc"というファイルを読み込みます。
+これはRubyスクリプトです。</p>
+<h2><a name="label-5" id="label-5">RDの書き方</a></h2><!-- RDLabel: "RDの書き方" -->
+<p>doc/rd-draft.rdを読んでください。</p>
+<h2><a name="label-6" id="label-6">バグ報告</a></h2><!-- RDLabel: "バグ報告" -->
+<p>バグを見付けた時は、次のアドレスまでメールしてください。
+<a href="mailto:uwabami@gfd-dennou.org">&lt;URL:mailto:uwabami@gfd-dennou.org&gt;</a></p>
+<h2><a name="label-7" id="label-7">ライセンス</a></h2><!-- RDLabel: "ライセンス" -->
+<p>RDtoolはRuby's LicenseかGPLの下で使用/配布/改造してください。
+RDtoolのパッケージにはTosh以外の人が著作権を持つファイルが含まれています。
+それらのファイルについての配布条件はファイル自体に書かれたライセンスの下で
+行ってください。</p>
+</body>
+</html>

data/README.rd ADDED Viewed

@@ -0,0 +1,52 @@
+# -*- mode: rd; coding: utf-8-unix; indent-tabs-mode: nil -*-
+=begin
+= RDtool 0.6.23
+== What is RDtool
+RD is Ruby's POD. RDtool is formatter for RD.
+== What is Changed
+See HISTORY.
+== How to Install
+ (1)((%su%)) if you install into public directories.
+ (2)((%ruby setup.rb%))
+ (3)If you want to use , utils/rd-mode.el, install it ((*by hand*)).
+== How to use
+Simply,
+  % rd2 rdfile.rd > outputfile
+If you want to indicate format-library, do
+  % rd2 -r library rdfile.rd > outputfile
+Use ((% rd2 --help %)) for more options.
+For options depend on format-library, enter ((%--help%)) after
+the indication of format-library. For example,
+  % rd2 -r rd/rd2html-lib.rb --help
+rd2 load "${HOME}/.rd2rc" when it runs.
+== How to write RD?
+Please read doc/rd-draft.rd.
+== About bug report
+If you find a bug in RDtool, please E-mail me
+((<URL:mailto:uwabami@gfd-dennou.org>)).
+== License
+You can use/re-distribute/change RDtool under Ruby's License or GPL, see
+LICNESE.txt and COPYING.txt.  This distribution of RDtool include files
+that are copyrighted by somebody else, and these files can be
+re-distributed under those own license.  These files include the
+condition of those licenses in themselves.
+=end

data/README.rd.ja ADDED Viewed

@@ -0,0 +1,54 @@
+# -*- mode: rd; coding: utf-8-unix; indent-tabs-mode: nil -*-
+=begin
+= RDtool 0.6.23
+== RDってなに？
+RDはRubyにおけるPOD(Plain Old Documentation)のようなものです。
+RDtoolはRDのフォーマッタであり、RDをHTMLなどに変換できます。
+== 何が変わった？
+HISTORYを見てください。
+== インストールの方法
+ (1)必要なら、((%su%))
+ (2)((%ruby setup.rb%))
+ (3)utils/rd-mode.elを使いたいならば
+    それらを((*手で*))インストールします。
+== どうやって使うか。
+基本的には、こんな感じ。
+  % rd2 rdfile.rd > outputfile
+フォーマットライブラリを指定したい時は、こう。
+  % rd2 -r library rdfile.rd > outputfile
+((% rd2 --help %))でオプションの詳細がでます。
+フォーマットライブラリ依存のオプションは先にフォーマットライブラリの
+指定をしてから((%--help%))。例えば、
+  % rd2 -r rd/rd2html-lib.rb --help
+rd2はホームディレクトリにある".rd2rc"というファイルを読み込みます。
+これはRubyスクリプトです。
+== RDの書き方
+doc/rd-draft.rdを読んでください。
+== バグ報告
+バグを見付けた時は、次のアドレスまでメールしてください。
+((<URL:mailto:uwabami@gfd-dennou.org>))
+== ライセンス
+RDtoolはRuby's LicenseかGPLの下で使用/配布/改造してください。
+RDtoolのパッケージにはTosh以外の人が著作権を持つファイルが含まれています。
+それらのファイルについての配布条件はファイル自体に書かれたライセンスの下で
+行ってください。
+=end

data/Rakefile ADDED Viewed

@@ -0,0 +1,29 @@
+# -*- mode: ruby; coding: utf-8 -*-
+require 'rubygems'
+require 'rake'
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rdtool"
+  gem.homepage = "http://github.com/uwabami/rdtool"
+  gem.license = ['GPL', 'Ruby']
+  gem.summary = %Q{RDtool is formatter for RD.}
+  gem.description = %Q{RD is multipurpose documentation format created for documentating Ruby and output of Ruby world. You can embed RD into Ruby script. And RD have neat syntax which help you to read document in Ruby script. On the other hand, RD have a feature for class reference.}
+  gem.email = "uwabami@gfd-dennou.org"
+  gem.authors = ["Youhei SASAKI"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib'
+  test.libs << 'test'
+  test.pattern = 'test.rb'
+  test.verbose = true
+end
+task :default => :test

data/TODO ADDED Viewed

@@ -0,0 +1,15 @@
+# -*- mode: rd; coding: utf-8-unix; indent-tabs-mode: nil -*-
+= TODO
+== Moonwolf さんから指摘された事
+* Ruby1,9での動作確認(全機能)+encoding周り
+* gem化した際に、通常のsetup.rbによるインストール方法も残すか
+* 原作者のToshさんの認識していたバグが直っているかの確認(できるの?)
+  ((<URL:http://pub.cozmixng.org/~the-rwiki/rw-cgi.rb?cmd=view;name=RDtool+Bug+List>))
+== 佐々木が気になっている事/やりたいこと
+* COPYRIGHT の表記. きちんとまとめておきたい|おくべき.
+* makerdtool.rb などを Rake のタスクに落としこむ
+* Windows での, テストしておくべき Ruby 環境ってドレなの?

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.6.23

data/bin/rd2 ADDED Viewed

@@ -0,0 +1,281 @@
+#! /usr/bin/ruby1.8 -Kn
+# -*- coding: ASCII-8BIT -*-
+=begin
+= NAME
+rd2 - converter from RD to other mark-up language.
+= SYNOPSIS
+  rd2 [-r <visitor>] [options] <file>
+= DESCRIPTION
+rd2 inputs from ((|<file>|)) and outputs into (({STDOUT})). you can
+choose ((|<visitor>|)) to select output format. For example, use
+"rd/rd2html-lib.rb" to translate it into HTML, and "rd/rd2man-lib.rb"
+to tranlate it into roff with man macros.
+= OPTIONS
+please read output of
+  % rd2 --help
+and
+  % rd2 -r rd/rd2html-lib.rb --help
+= FILES
+  * ~/.rd2rc - User configration file.
+= SEE ALSO
+ruby(1)
+=end
+require "kconv"
+require "optparse"
+require "rd/rdfmt"
+require "rd/visitor"
+require "rd/version"
+module Kconv
+  NAME2CONST = {
+    "iso-2022-jp" => Kconv::JIS,
+    "euc-jp" => Kconv::EUC,
+    "shift_jis" => Kconv::SJIS,
+  }
+  NAME_ALIAS = {
+    'jis' => 'iso-2022-jp',
+    'euc' => 'euc-jp',
+    'sjis' => 'shift_jis',
+    'shift-jis' => 'shift_jis',
+  }
+  if defined?(Kconv::UTF8)
+    NAME2CONST['utf-8'] = Kconv::UTF8
+    NAME_ALIAS['utf8'] = 'utf-8'
+  end
+end
+include RD
+SYSTEM_NAME = "RDtool -- rd2"
+SYSTEM_VERSION = "$Version: 0.6.23$" #"
+RD2_VERSION = Version.new_from_version_string(SYSTEM_NAME, SYSTEM_VERSION)
+# global vars
+$Visitor_Class = nil
+$Visitor = nil
+$RD2_Sub_OptionParser = nil
+# local vars
+include_path = []
+with_part = []
+output_file = nil
+output_index = nil
+out_code = nil
+from_rdo = nil
+# user option
+$DEFAULT_FORMAT_LIB = "rd/rd2html-lib"
+$RC = {}
+$RC["filter"] = Hash.new(RD::INCLUDE_FILTER)
+begin
+  if test(?r, File.expand_path("~/.rd2rc"))
+    load "~/.rd2rc"
+    #  STDERR << "#{$0}: loading ~/.rd2rc\n"
+  else
+    load "rd/dot.rd2rc"
+    #  STDERR << "#{$0}: loading rd/dot.rd2rc\n"
+  end
+rescue
+  load "rd/dot.rd2rc"
+end
+# initialize OptionParser
+ARGV.options do |q|
+  q.banner = "Usage: #{$0} [options] rd-file > output\n"
+  q.on_head("global options:")
+  q.on("-rLIB", "--require=LIB",
+       String,
+       "choose format library.") do |i|
+    # require LIB
+    require i
+    if $Visitor_Class && !$Visitor
+      $Visitor = $Visitor_Class.new()
+      if $RD2_Sub_OptionParser
+	require $RD2_Sub_OptionParser
+	$RD2_Sub_OptionParser = nil
+      end
+    end
+  end
+  q.on("-oNAME",
+       String,
+       "indicate base name of output file") do |i|
+    output_file = i
+  end
+  q.on("--out-code=KCODE",
+       Kconv::NAME2CONST.keys, Kconv::NAME_ALIAS,
+       "character encoding of output.(jis|euc|sjis|utf8)") do |i|
+    out_code = i
+  end
+  q.on("--output-index",
+       "output method index file (*.rmi)") do |i|
+    output_index = true
+  end
+  q.on("-IPATH", "--include-path=PATH",
+       String,
+       "add PATH to list of include path") do |i|
+    # add to include path
+    include_path.unshift(i)
+  end
+  # accept "PART:FILTER" and "PART"
+  class PART ; end
+  q.accept(PART, /(\w+)(?:\s*:\s*(\w+))?/) {|s, p, f| [s, p, f] }
+  q.on("--with-part=PART",
+       PART,
+       "include PART with Filter") do |src, part, filter|
+    with_part.push([part, filter || part])
+    unless include_path.index(RD::RDTree.tmp_dir)
+      include_path.push(RD::RDTree.tmp_dir)
+    end
+  end
+  q.on("--from-rdo",
+       "load from *.rdo instead of *.rd") do
+    from_rdo = true
+  end
+  q.on("--version",
+       "print versions.") do
+    STDERR.puts RD2_VERSION
+    STDERR.puts Tree::version
+    STDERR.puts Visitor::version
+    STDERR.puts $Visitor_Class.version if $Visitor_Class
+    exit(0)
+  end
+  q.on_tail("--help",
+	    "print this message") do
+    STDERR.print(q.to_s)
+    exit(0)
+  end
+end # OptionParser.new
+# require format lib implicitly
+if /rd2.+/ =~ File.basename($0, ".*").downcase
+  visitor_lib = "rd/" + $& + "-lib.rb"
+  require visitor_lib
+  require $RD2_Sub_OptionParser  if $RD2_Sub_OptionParser
+  # make visitor
+  $Visitor = $Visitor_Class.new()
+end
+begin
+  ARGV.parse!
+rescue
+  STDERR.print("Error: " + $!.inspect + "\n")
+  STDERR.print(ARGV.options.to_s)
+  exit(1)
+end
+unless $Visitor_Class
+  require $DEFAULT_FORMAT_LIB
+  $Visitor = $Visitor_Class.new
+end
+# make tree (but not parsed yet)
+if from_rdo
+  rdos = []
+  ARGV.each do |path|
+    rdos.push(File.open(path))
+    dirname = File.dirname(path)
+    include_path.push(dirname, dirname + "/include")
+  end
+  tree = RDTree.new_from_rdo(*rdos)
+  tree.include_path = include_path
+else
+  # input from ARGF
+  src = readlines
+  if src.find{|i| /\S/ === i } and !src.find{|i| /^=begin\b/ === i }
+    src.unshift("=begin\n").push("=end\n")
+  end
+  # set Include_Path
+  if ARGF.filename
+    dir = File.dirname(ARGF.filename)
+  else
+    dir = "."
+  end
+  include_path.push(dir)
+  include_path.push(dir + "/include")
+  tree = RDTree.new(src, include_path, nil)
+  # filter set tree.filter
+  with_part.each do |i|
+    tree.filter[i[0]] = $RC["filter"][i[1]]
+  end
+  # parse
+  begin
+    tree.parse
+  rescue Racc::ParseError
+    STDERR.puts($!.message)
+    exit(10)
+  end
+end
+# filter: set visitor.include_suffix
+with_part.each do |i|
+  $Visitor.include_suffix.push(i[0])
+end
+# file base name setup
+$Visitor.filename = output_file if output_file
+# character encoding
+if out_code
+  begin
+    $Visitor.charcode = out_code
+    $Visitor.lang = "ja"
+  rescue NameError
+  end
+end
+# output
+out = $Visitor.visit(tree)
+# character encoding convert
+out = Kconv.kconv(out, Kconv::NAME2CONST[out_code], Kconv::AUTO) if out_code
+if output_file
+  filename = output_file + "." + $Visitor.class::OUTPUT_SUFFIX
+  file = open(filename, "w")
+  file.print(out)
+  file.close
+  STDERR.print("#{$0}: output to #{filename}...\n")
+else
+  print(out)
+end
+# RMI
+if output_index
+  if output_file
+    require "rd/rd2rmi-lib"
+    rmivisitor = RD2RMIVisitor.new
+    rmivisitor.filename = output_file
+    rmi = rmivisitor.visit(tree)
+    filename = output_file + ".rmi"
+    file = open(filename, "w")
+    file.print(rmi)
+    file.close
+    STDERR.print("#{$0}: output to #{filename}...\n")
+  else
+    raise %Q[Error: option "--output-index" must be used with option "-oNAME"]
+  end
+end
+# filter: remove tmp file
+Dir.glob("#{RD::RDTree.tmp_dir}/rdtmp.#{$$}.*.*").each do |i|
+  File.delete(i)
+end