nishidayuya-rd2odt 0.0.1.20090403.01 → 0.1.1

data/NEWS

@@ -1,3 +1,16 @@
+= version 0.1.1 2009-07-01
+
+== a little feature
+
+* Supported Ruby version 1.8.6.
+
+= version 0.1.0 2009-05-16
+
+== a feature
+
+* Distributed under the RubyGems package.
+  * rd2odt includes RDtool.
+
 = version 0.0.1 2009-04-01
 
 == a little features

data/Rakefile

@@ -15,6 +15,8 @@ end
 Spec::Rake::SpecTask.new do |t|
   t.spec_files = FileList["test/**/*-spec.rb"]
   t.libs << "lib"
+  t.libs << "lib/rd2odt/rdtool"
+  t.spec_opts << "--colour"
 end
 
 Rake::RDocTask.new do |t|
@@ -33,7 +35,7 @@ task :init_gem_spec do
   s = File.read("rd2odt.gemspec").untaint
   spec = nil
   Thread.start {
-    $SAFE = 2
+    $SAFE = 3
     spec = Module.new.module_eval(s)
   }.join
   Rake::GemPackageTask.new(spec) do |pkg|

data/lib/rd2odt/compat/ruby-1.8.6.rb

@@ -0,0 +1,86 @@
+# This part is from Ruby 1.8.7's tmpdir.rb.
+
+class Dir
+  # Dir.mktmpdir creates a temporary directory.
+  #
+  # The directory is created with 0700 permission.
+  #
+  # The prefix and suffix of the name of the directory is specified by
+  # the optional first argument, <i>prefix_suffix</i>.
+  # - If it is not specified or nil, "d" is used as the prefix and no suffix is used.
+  # - If it is a string, it is used as the prefix and no suffix is used.
+  # - If it is an array, first element is used as the prefix and second element is used as a suffix.
+  #
+  #  Dir.mktmpdir {|dir| dir is ".../d..." }
+  #  Dir.mktmpdir("foo") {|dir| dir is ".../foo..." }
+  #  Dir.mktmpdir(["foo", "bar"]) {|dir| dir is ".../foo...bar" }
+  #
+  # The directory is created under Dir.tmpdir or
+  # the optional second argument <i>tmpdir</i> if non-nil value is given.
+  #
+  #  Dir.mktmpdir {|dir| dir is "#{Dir.tmpdir}/d..." }
+  #  Dir.mktmpdir(nil, "/var/tmp") {|dir| dir is "/var/tmp/d..." }
+  #
+  # If a block is given,
+  # it is yielded with the path of the directory.
+  # The directory and its contents are removed
+  # using FileUtils.remove_entry_secure before Dir.mktmpdir returns.
+  # The value of the block is returned.
+  #
+  #  Dir.mktmpdir {|dir|
+  #    # use the directory...
+  #    open("#{dir}/foo", "w") { ... }
+  #  }
+  #
+  # If a block is not given,
+  # The path of the directory is returned.
+  # In this case, Dir.mktmpdir doesn't remove the directory.
+  #
+  #  dir = Dir.mktmpdir
+  #  begin
+  #    # use the directory...
+  #    open("#{dir}/foo", "w") { ... }
+  #  ensure
+  #    # remove the directory.
+  #    FileUtils.remove_entry_secure dir
+  #  end
+  #
+  def Dir.mktmpdir(prefix_suffix=nil, tmpdir=nil)
+    case prefix_suffix
+    when nil
+      prefix = "d"
+      suffix = ""
+    when String
+      prefix = prefix_suffix
+      suffix = ""
+    when Array
+      prefix = prefix_suffix[0]
+      suffix = prefix_suffix[1]
+    else
+      raise ArgumentError, "unexpected prefix_suffix: #{prefix_suffix.inspect}"
+    end
+    tmpdir ||= Dir.tmpdir
+    t = Time.now.strftime("%Y%m%d")
+    n = nil
+    begin
+      path = "#{tmpdir}/#{prefix}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+      path << "-#{n}" if n
+      path << suffix
+      Dir.mkdir(path, 0700)
+    rescue Errno::EEXIST
+      n ||= 0
+      n += 1
+      retry
+    end
+
+    if block_given?
+      begin
+        yield path
+      ensure
+        FileUtils.remove_entry_secure path
+      end
+    else
+      path
+    end
+  end
+end

data/lib/rd2odt/rdtool/NOTICE.rd2odt

@@ -0,0 +1,8 @@
+= NOTICE
+
+The files under this directory are the part of RDtool.
+RDtool is licensed under Ruby's License or GPL.
+
+Original program is here.
+* http://rubyforge.org/projects/rdtool/
+* http://raa.ruby-lang.org/project/rdtool/

data/lib/rd2odt/rdtool/README.rd

@@ -0,0 +1,50 @@
+=begin
+= RDtool 0.6.21
+== 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:moonwolf@moonwolf.com>)).
+
+== License
+
+You can use/re-distribute/change RDtool under Ruby's License or GPL.
+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/lib/rd2odt/rdtool/README.rd.ja

@@ -0,0 +1,53 @@
+=begin
+= RDtool 0.6.21
+== 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:moonwolf@moonwolf.com>))
+
+== ライセンス
+
+RDtoolはRuby's LicenseかGPLの下で使用/配布/改造してください。
+RDtoolのパッケージにはTosh以外の人が著作権を持つファイルが含まれています。
+それらのファイルについての配布条件はファイル自体に書かれたライセンスの下で
+行ってください。
+
+=end

data/lib/rd2odt/rdtool/rd/block-element.rb

@@ -0,0 +1,114 @@
+require 'rd/element'
+require 'rd/labeled-element'
+
+module RD
+  # Block-level Element of document tree. abstruct class.
+  class BlockElement < Element
+  end
+
+  class Headline < BlockElement
+    include NonterminalElement
+    include LabeledElement
+
+    MARK2LEVEL = {
+      "=" => 1,
+      "==" => 2,
+      "===" => 3,
+      "====" => 4,
+      "+" => 5,
+      "++" => 6
+    }
+    
+    attr_accessor :level
+    attr_reader :title
+    
+    def initialize(level_num)
+      super()
+      @level = level_num
+      @title = []
+    end
+    
+    def accept(visitor)
+      visitor.visit_Headline(self)
+    end
+
+    def calculate_label
+      ret = ""
+      @title.each do |i|
+	ret << i.to_label
+      end
+      ret
+    end
+    private :calculate_label
+    
+    def Headline.mark_to_level(mark_str)
+      MARK2LEVEL[mark_str] or
+	raise ArgumentError, "#{mark_str} is irregular for Headline mark."
+    end
+
+    def children
+      @title
+    end
+  end
+  
+  class Include < BlockElement
+    include TerminalElement
+    
+    attr_accessor :filename
+    
+    def initialize(filename)
+      super()
+      @filename = filename
+    end
+    
+    def accept(visitor)
+      visitor.visit_Include(self)
+    end
+  end # Include
+  
+  class TextBlock < BlockElement
+    include NonterminalElement
+    
+    attr_accessor :content
+    
+    def initialize()
+      super()
+      @content = []
+    end
+    
+    def accept(visitor)
+      visitor.visit_TextBlock(self)
+    end
+    
+    def children
+      @content
+    end
+  end
+  
+  class Verbatim < BlockElement
+    include TerminalElement
+    
+    attr_reader :content
+    
+    def initialize(content_strings = [])
+      super()
+      @content = content_strings  # Array of String
+    end
+    
+    def accept(visitor)
+      visitor.visit_Verbatim(self)
+    end
+    
+    def each_line
+      if @content.respond_to?(:each_line)
+        @content.each_line {|i|
+	  yield i
+	}
+      else
+        @content.each {|i|
+	  yield i
+	}
+      end
+    end
+  end
+end

data/lib/rd2odt/rdtool/rd/complex-list-item.rb

@@ -0,0 +1,65 @@
+
+
+module RD
+  # abstruct class for ListItem which have term part additionaly. 
+  # (i.e. DescListItem and MethodListItem)
+  module ComplexListItem
+    def set_term(term)
+      set_term_under_document_struct(term, tree.document_struct)
+    end
+    alias term= set_term
+
+    def set_term_under_document_struct(term, document_struct)
+      raise ArgumentError unless document_struct.is_valid?(self, term)
+      assign_term(term)
+    end
+
+    def set_term_without_document_struct(term)
+      assign_term(term)
+    end
+
+    def assign_term(term)
+      @term = term
+      term.parent = self
+    end
+    
+    def make_term(*args_of_new, &block)
+      child = self.class::Term.new(*args_of_new)
+      set_term(child)
+      child.build(&block) if block_given?
+      child
+    end
+
+    def each_element(&block)
+      yield(self)
+      @term.each_element(&block)
+      @description.each do |i|
+	i.each_element(&block)
+      end
+    end
+    alias each each_element
+    
+    def each_block_in_description
+      @description.each do |i|
+	yield(i)
+      end
+    end
+    alias each_block each_block_in_description
+
+    def children
+      @description
+    end
+
+    def to_label
+      @term.to_label
+    end
+    alias label to_label
+
+    def inspect
+      t = indent2(term.inspect) if term
+      c  = children.collect{|i| indent2(i.inspect)}.join("\n")
+      "<#{self.class.name}>" + (term ? "\n" : "") + t.to_s +
+	(c.empty? ? "" : "\n") + c
+    end
+  end # ComplexListItem
+end # RD

data/lib/rd2odt/rdtool/rd/desclist.rb

@@ -0,0 +1,55 @@
+require 'rd/element'
+require 'rd/list'
+require 'rd/complex-list-item'
+require 'rd/labeled-element'
+
+module RD
+  class DescList < List
+    def accept(visitor)
+      visitor.visit_DescList(self)
+    end
+  end
+  
+  class DescListItem < ListItem
+    include ComplexListItem
+    
+    attr_reader :term
+    attr_reader :description
+    
+    def initialize
+      @term = nil
+      @description = []
+      @label = nil
+    end
+
+    def accept(visitor)
+      visitor.visit_DescListItem(self)
+    end
+
+    class Term < Element
+      include NonterminalElement
+      include LabeledElement
+      
+      def initialize
+	@content = []
+      end
+
+      def calculate_label
+	ret = ""
+	children.each do |i|
+	  ret.concat(i.to_label)
+	end
+	ret
+      end
+      private :calculate_label
+
+      def accept(visitor)
+	visitor.visit_DescListItemTerm(self)
+      end
+      
+      def children
+	@content
+      end
+    end
+  end # DescListItem
+end # RD

data/lib/rd2odt/rdtool/rd/document-struct.rb

@@ -0,0 +1,46 @@
+
+module RD
+  # DocumentStructure defines and restricts structure of document tree.
+  # it consists of ElementRelationship
+  class DocumentStructure
+    def initialize
+      @relationships = []
+    end
+    
+    def add_relationships(*relations)
+      @relationships += relations
+    end
+
+    def define_relationship(parent, child)
+      add_relationships(ElementRelationship.new(parent, child))
+    end
+
+    def each_relationship
+      @relationships.each do |i|
+	yield(i)
+      end
+    end
+
+    def is_valid?(parent, child)
+      each_relationship do |i|
+	return true if i.match?(parent, child)
+      end
+      false
+    end
+  end
+
+  # ElementRelationship is knowledge about parent-children relationship
+  # between Elements.
+  class ElementRelationship
+    attr_reader(:parent, :child)
+
+    def initialize(parent, child)
+      @parent = parent
+      @child = child
+    end
+
+    def match?(parent, child)
+      parent.is_a? @parent and child.is_a? @child
+    end
+  end
+end

data/lib/rd2odt/rdtool/rd/element.rb

@@ -0,0 +1,160 @@
+
+module RD
+
+  # abstruct class of node of document tree
+  class Element
+    include Enumerable
+    
+    attr_accessor :parent
+
+    def initialize
+      @parent = nil
+    end
+    
+    def tree
+      raise RuntimeError, "#{self} doesn't have a parent." unless @parent
+      @parent.tree
+    end
+
+    def inspect
+      c  = children.collect{|i| indent2(i.inspect)}.join("\n")
+      "<#{self.class.name}>" + (c.empty? ? "" : "\n") + c
+    end
+  end # Element
+
+  # element which don't have children.
+  module TerminalElement
+    def children
+      []
+    end
+
+    def each_element
+      yield(self)
+    end
+    alias each each_element
+  end
+
+  # element which have children.
+  module NonterminalElement
+    def initialize(*arg)
+      @temporary_document_structure = nil
+      super
+    end
+
+    def children
+      raise NotImplimentedError, "need #{self}#children."
+    end
+
+    def each_child
+      children.each do |i|
+	yield(i)
+      end
+    end
+
+    def each_element(&block)
+      yield(self)
+      children.each do |i|
+	i.each_element(&block)
+      end
+    end
+    alias each each_element
+    
+    def add_child(child)
+      add_child_under_document_struct(child, tree.document_struct)
+    end
+
+    def add_child_under_document_struct(child, document_struct)
+      if document_struct.is_valid?(self, child)
+	push_to_children(child)
+      else
+	raise ArgumentError,
+	  "mismatched document structure, #{self} <-/- #{child}."
+      end
+      return self
+    end
+
+    def add_children(children)
+      add_children_under_document_struct(children, tree.document_struct)
+    end
+
+    def add_children_under_document_struct(children, document_struct)
+      children.each do |i|
+	add_child_under_document_struct(i, document_struct)
+      end
+      return self
+    end
+
+    def add_children_without_document_struct(new_children)
+      new_children.each do |i|
+	push_to_children(i)
+      end
+      return self
+    end
+
+    def push_to_children(child)
+      children.push(child)
+      child.parent = self
+    end
+
+    attr_accessor :temporary_document_structure
+
+    def build(document_struct = tree.document_struct, &block)
+      under_temporary_document_structure(document_struct) do
+	self.instance_eval(&block)
+      end
+      self
+    end
+
+    def make_child(child_class, *args_of_new, &block)
+      child = child_class.new(*args_of_new)
+      if self.temporary_document_structure
+	self.add_child_under_document_struct(child,
+					     self.temporary_document_structure)
+	child.build(self.temporary_document_structure, &block) if block_given?
+      else
+	self.add_child(child)
+	child.build(&block) if block_given?
+      end
+      child
+    end
+    alias new make_child
+    private :new
+    # NonterminalElement#new, not NonterminalElement.new
+
+    def under_temporary_document_structure(document_struct)
+      begin
+	self.temporary_document_structure = document_struct
+	yield
+      ensure
+	self.temporary_document_structure = nil
+      end
+    end
+
+    def indent2(str)
+      buf = ''
+      str.each_line{|i| buf << "  " << i }
+      buf
+    end
+    private :indent2
+  end
+
+  # root node of document tree
+  class DocumentElement < Element
+    include NonterminalElement
+    attr_reader :blocks
+    
+    def initialize()
+      @blocks = []
+    end
+
+    def accept(visitor)
+      visitor.visit_DocumentElement(self)
+    end
+
+    alias each_block each_child
+    
+    def children
+      @blocks
+    end
+  end
+end