org-parse 0.1.1 → 0.1.2

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:patch: 1
+:minor: 1
+:patch: 2
 :build: 
 :major: 0
-:minor: 1

data/bin/org-parse

@@ -34,8 +34,9 @@ begin
     puts options_parser
   else
     data = IO.read(ARGV[0])
-    
-    parser = OrgParse::StructParser.new(data, File.basename(ARGV[0], '.*'))
+    opts = {}
+    opts[:default_title] = File.basename(ARGV[0], '.*')
+    parser = OrgParse::StructParser.new(data, opts)
     root = parser.parse
     if options[:format] == :html
       visitor = OrgParse::HtmlVisitor.new(root, options[:template])

data/doc/org-parse.html

@@ -7,7 +7,7 @@ lang="en" xml:lang="en">
 <title>OrgParse</title>
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
 <meta name="generator" content="Org-mode"/>
-<meta name="generated" content="2010-03-10 11:09:20 JST"/>
+<meta name="generated" content="2010-03-24 10:38:50 JST"/>
 <meta name="author" content="Kensei Nakamura"/>
 <meta name="description" content=""/>
 <meta name="keywords" content=""/>
@@ -35,6 +35,7 @@ lang="en" xml:lang="en">
   dt { font-weight: bold; }
   div.figure { padding: 0.5em; }
   div.figure p { text-align: center; }
+  textarea { overflow-x: auto; }
   .linenr { font-size:smaller }
   .code-highlighted {background-color:#ffff00;}
   .org-info-js_info-navigation { border-style:none; }
@@ -77,17 +78,31 @@ lang="en" xml:lang="en">
 <h2>Table of Contents</h2>
 <div id="text-table-of-contents">
 <ul>
-<li><a href="#sec-1">1 これは何か？ </a></li>
-<li><a href="#sec-2">2 何故作ったか。 </a></li>
-<li><a href="#sec-3">3 構成 </a>
+<li><a href="#sec-1">1 これは何か？ </a>
 <ul>
-<li><a href="#sec-3.1">3.1 概要 </a></li>
+<li><a href="#sec-1.1">1.1 何故作ったか。 </a></li>
 </ul>
 </li>
-<li><a href="#sec-4">4 使い方 </a>
+<li><a href="#sec-2">2 構成 </a>
 <ul>
-<li><a href="#sec-4.1">4.1 org-parse コマンド </a></li>
-<li><a href="#sec-4.2">4.2 org-parse ライブラリ </a></li>
+<li><a href="#sec-2.1">2.1 概要 </a></li>
+</ul>
+</li>
+<li><a href="#sec-3">3 使い方 </a>
+<ul>
+<li><a href="#sec-3.1">3.1 org-parse コマンド </a></li>
+<li><a href="#sec-3.2">3.2 org-parse ライブラリ </a></li>
+</ul>
+</li>
+<li><a href="#sec-4">4 MEMO </a>
+<ul>
+<li><a href="#sec-4.1">4.1 オプション類の扱い </a>
+<ul>
+<li><a href="#sec-4.1.1">4.1.1 プログラム内でのオプションの記憶場所 </a></li>
+<li><a href="#sec-4.1.2">4.1.2 オプションの指定方法 </a></li>
+<li><a href="#sec-4.1.3">4.1.3 オプションの優先順位 </a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
@@ -99,13 +114,12 @@ lang="en" xml:lang="en">
 <div class="outline-text-2" id="text-1">
 
 <p><a href="http://orgmode.org">Org-Mode</a> で書かれた文書を他のフォーマットに変換するためのライブラリである。
-</p></div>
-
+</p>
 </div>
 
-<div id="outline-container-2" class="outline-2">
-<h2 id="sec-2"><span class="section-number-2">2</span> 何故作ったか。 </h2>
-<div class="outline-text-2" id="text-2">
+<div id="outline-container-1.1" class="outline-3">
+<h3 id="sec-1.1"><span class="section-number-3">1.1</span> 何故作ったか。 </h3>
+<div class="outline-text-3" id="text-1.1">
 
 <p>直接の動機は、Redmine の文書やWikiに、Org-Modeで書いた文書を入れたかったから。
 長文になると、textileで書くのは骨が折れる。Org-Mode のアウトライン操作は快適である。
@@ -113,45 +127,50 @@ lang="en" xml:lang="en">
 <p>
 この用途には<a href="http://orgmode.org/worg/org-tutorials/org-ruby.php">Org-ruby</a> が使えそうだけど、日本語の textile 文書との相性が悪かった。
 Org-rubyに手を入れるか自分用を作るか迷ったのだが、Racc の勉強を兼ねて一から作ることにした。
+</p>
+<p>
+が、構文エラーを出さない方針にしてみると、Racc 等の構文解析ライブラリは使いにくかった。
+プログラミング言語じゃないから、あまりガチガチにすると使いにくいし、悩ましい所である。
 </p></div>
+</div>
 
 </div>
 
-<div id="outline-container-3" class="outline-2">
-<h2 id="sec-3"><span class="section-number-2">3</span> 構成 </h2>
-<div class="outline-text-2" id="text-3">
+<div id="outline-container-2" class="outline-2">
+<h2 id="sec-2"><span class="section-number-2">2</span> 構成 </h2>
+<div class="outline-text-2" id="text-2">
 
 
 </div>
 
-<div id="outline-container-3.1" class="outline-3">
-<h3 id="sec-3.1"><span class="section-number-3">3.1</span> 概要 </h3>
-<div class="outline-text-3" id="text-3.1">
+<div id="outline-container-2.1" class="outline-3">
+<h3 id="sec-2.1"><span class="section-number-3">2.1</span> 概要 </h3>
+<div class="outline-text-3" id="text-2.1">
 
 <p>org-file を、スキャナー、パーサーを通して、構文木を作成する。
 出来上がった構文木から、HTMLや、textile 等のフォーマットの文書を構築する。
 </p>
 <p>
-<img src="images/org-parse-struct_1ffae50f0c5eb867f9418df6800f40a5cc3d1751.png"  alt="images/org-parse-struct_1ffae50f0c5eb867f9418df6800f40a5cc3d1751.png" />
+<img src="images/org-parse-struct_ca4f70a7189eddf1f60e8486f7d289b294cf8df3.png"  alt="images/org-parse-struct_ca4f70a7189eddf1f60e8486f7d289b294cf8df3.png" />
 </p>
 <p>
 RDtool の構成と同じ様な形式である。
-visitor の部分を置き換えることで、様々なフォーマットへの対応を行う予定である。
+visitor の部分を置き換えることで、様々なフォーマットへ変換出来るようになる（予定）。
 </p></div>
 </div>
 
 </div>
 
-<div id="outline-container-4" class="outline-2">
-<h2 id="sec-4"><span class="section-number-2">4</span> 使い方 </h2>
-<div class="outline-text-2" id="text-4">
+<div id="outline-container-3" class="outline-2">
+<h2 id="sec-3"><span class="section-number-2">3</span> 使い方 </h2>
+<div class="outline-text-2" id="text-3">
 
 
 </div>
 
-<div id="outline-container-4.1" class="outline-3">
-<h3 id="sec-4.1"><span class="section-number-3">4.1</span> org-parse コマンド </h3>
-<div class="outline-text-3" id="text-4.1">
+<div id="outline-container-3.1" class="outline-3">
+<h3 id="sec-3.1"><span class="section-number-3">3.1</span> org-parse コマンド </h3>
+<div class="outline-text-3" id="text-3.1">
 
 
 
@@ -167,9 +186,9 @@ visitor の部分を置き換えることで、様々なフォーマットへの
 
 </div>
 
-<div id="outline-container-4.2" class="outline-3">
-<h3 id="sec-4.2"><span class="section-number-3">4.2</span> org-parse ライブラリ </h3>
-<div class="outline-text-3" id="text-4.2">
+<div id="outline-container-3.2" class="outline-3">
+<h3 id="sec-3.2"><span class="section-number-3">3.2</span> org-parse ライブラリ </h3>
+<div class="outline-text-3" id="text-3.2">
 
 <p>以下の様な感じ。
 </p>
@@ -188,6 +207,76 @@ puts visitor.build
 </pre>
 
 
+</div>
+</div>
+
+</div>
+
+<div id="outline-container-4" class="outline-2">
+<h2 id="sec-4"><span class="section-number-2">4</span> MEMO </h2>
+<div class="outline-text-2" id="text-4">
+
+<p>以下は、これからの修正のための覚書
+</p>
+</div>
+
+<div id="outline-container-4.1" class="outline-3">
+<h3 id="sec-4.1"><span class="section-number-3">4.1</span> オプション類の扱い </h3>
+<div class="outline-text-3" id="text-4.1">
+
+
+</div>
+
+<div id="outline-container-4.1.1" class="outline-4">
+<h4 id="sec-4.1.1"><span class="section-number-4">4.1.1</span> プログラム内でのオプションの記憶場所 </h4>
+<div class="outline-text-4" id="text-4.1.1">
+
+<p>オプションや、セクション番号等の情報は、各Nodeに持たせる。
+つまり、ビジターで、コンテキストやオプション類の判定を行わないで済む様にする。
+</p><ul>
+<li>
+セクション番号を、Section Node に持たせる
+</li>
+<li>
+Verse、Example 等は、各 BlockNode 配下のnode 自体が知っている
+</li>
+</ul>
+</div>
+
+</div>
+
+<div id="outline-container-4.1.2" class="outline-4">
+<h4 id="sec-4.1.2"><span class="section-number-4">4.1.2</span> オプションの指定方法 </h4>
+<div class="outline-text-4" id="text-4.1.2">
+
+<p>コマンドラインで指定。
+コンフィグファイルを作る？(~/.org-parse-rc)
+文書内での指定を最優先する方が正しいか？
+<a href="../examples/dot.org-parse-rc">../examples/dot.org-parse-rc</a>
+</p></div>
+
+</div>
+
+<div id="outline-container-4.1.3" class="outline-4">
+<h4 id="sec-4.1.3"><span class="section-number-4">4.1.3</span> オプションの優先順位 </h4>
+<div class="outline-text-4" id="text-4.1.3">
+
+<ul>
+<li>
+デフォルト設定
+</li>
+<li>
+.opt-parse
+</li>
+<li>
+コマンドラインオプション
+</li>
+<li>
+ソースファイル内の指定
+
+</li>
+</ul>
+</div>
 </div>
 </div>
 </div>
@@ -195,8 +284,8 @@ puts visitor.build
 <p class="author"> Author: Kensei Nakamura
 <a href="mailto:kensei@dalmore.artifarm.com">&lt;kensei@dalmore.artifarm.com&gt;</a>
 </p>
-<p class="date"> Date: 2010-03-10 11:09:20 JST</p>
-<p class="creator">HTML generated by org-mode 6.34c in emacs 23</p>
+<p class="date"> Date: 2010-03-24 10:38:50 JST</p>
+<p class="creator">HTML generated by org-mode 6.34trans in emacs 23</p>
 </div>
 </div>
 </body>

data/lib/org-parse.rb

@@ -2,7 +2,7 @@
 module OrgParse
 
   # :stopdoc:
-  VERSION = '0.0.2'
+  VERSION = '0.1.2'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/org-parse/node.rb

@@ -234,9 +234,10 @@ module OrgParse
 
   # BLOCK の情報を保持
   class BlockNode < Node
-    attr_reader :indent, :block_name, :syntax, :syntax_theme
+    attr_reader :indent, :block_name, :syntax, :syntax_theme, :filename, :type
     def initialize(vals, children)
       @block_name = vals[0].upcase
+      @line = vals[1]
       @indent = vals[2]
       @syntax = ''
       @syntax_theme = ''
@@ -254,6 +255,15 @@ module OrgParse
         elsif vals[1] =~ /SRC\s*(.+)\s*$/i
           @syntax = $1.downcase
         end
+      when 'DOT'
+        set_to_descendant :set_src
+        if vals[1] =~ /DOT\s+(.+)\s+-T(.*)$/
+          @filename = $1
+          @type = $2
+        else
+          @block_name = 'SRC'
+          @syntax = 'dot'
+        end
       when 'HTML'
         set_to_descendant :set_html
       end

data/lib/org-parse/struct-parser.rb

@@ -22,8 +22,8 @@ module OrgParse
     include InlineUtils
 
     # コンストラクタ
-    def initialize(src, title = '(non title)')
-      @scanner = StructScanner.new(src, title)
+    def initialize(src, opts)
+      @scanner = StructScanner.new(src, opts)
       @variables = []
       @yydebug = true
       set_struct_parser self

data/lib/org-parse/struct-scanner.rb

@@ -24,8 +24,8 @@ module OrgParse
     # コンストラクタ
     # [_src_] ソース文字列（または、文字列の配列）
     #         ソース文字列は、1行単位の配列として @srcに保存する
-    # [_title_] skip:t の場合にタイトルとして使われる
-    def initialize(src, title)
+    # [_opts_] skip:t の場合にタイトルとして使われる
+    def initialize(src, opts)
       @src = (src.is_a? Array) ? src : src.to_a
       @line_idx = 0
       @outline_level = 0
@@ -38,13 +38,15 @@ module OrgParse
         :email => nil,
         :creator => GENERATOR, :timestamp => true,
         :title => nil, :text => [], :language => 'ja', :charset => 'utf-8',
-        :default_title => title, :style => '', :uv => true,
+        :default_title => '(no title)', :style => '', :uv => true,
+        :dot_path => ''
       }
+      opts.each {|k, v| @options[k] = v}
       read_options
-      opt = YAML.dump @options
-      File.open('dot.rc2', "w") {|f|
-        f.write opt
-      }
+      # opt = YAML.dump @options
+      # File.open('dot.rc2', "w") {|f|
+      #  f.write opt
+      # }
       # p @options
     end
 
@@ -196,7 +198,7 @@ module OrgParse
       @token_que << [:DOCUMENT_START, @options]
       while @line_idx < @src.size
         line = @src[@line_idx]
-        if example_flag && line !~ /^\s*#\+end_(example|html|src)/i
+        if example_flag && line !~ /^\s*#\+end_(example|html|src|dot)/i
           @token_que << [:TEXTLINE, [line, get_indent(line)]]
           @line_idx += 1
           next
@@ -240,7 +242,7 @@ module OrgParse
           block_name = $1.upcase
           exit_nests line
           @token_que << [:BLOCK_START, [block_name, line, get_indent(line)]]
-          example_flag = true if ['EXAMPLE', 'HTML', 'SRC'].include? block_name.upcase
+          example_flag = true if ['EXAMPLE', 'HTML', 'SRC', 'DOT'].include? block_name.upcase
         when /^\s*#\+END_([A-Z0-9_]+)/i # BLOCK
           block_name = $1
           exit_nests line

data/lib/org-parse/templates/single.html.erb

@@ -85,7 +85,10 @@ lang="<%= @language %>" xml:lang="<%= @language %>">
 
 <%= @before_text %>
 
-<%= table_of_contents %>
+<div id="table-of-contents">
+  <h2>Table of Contents</h2>
+  <%= table_of_contents %>
+</div>
 
 <%= @body %>
 

data/lib/org-parse/visitor.rb

@@ -2,6 +2,24 @@
 require 'rubygems'
 require 'erb'
 require 'uv'
+require 'graphviz'
+
+#
+# 文字列を受け取ってパースする関数を追加
+#
+class GraphViz
+  class Parser
+    def self.parse_str(str, *hOpts, &block)
+      parser = DotParser.new()
+      tree = parser.parse(str)
+      graph = tree.eval( GraphViz::Parser::Context.new(),  hOpts )
+      yield( graph ) if( block and graph.nil? == false )
+      return graph
+    end
+  end
+end
+
+
 
 module OrgParse
 
@@ -129,20 +147,19 @@ module OrgParse
       toc += "</ul>\n"
       return '' if toc == "<ul>\n</ul>\n"
       ret =<<"EOS"
-<div id="table-of-contents">
-  <h2>Table of Contents</h2>
   <div id="text-table-of-contents">
 #{toc}
   </div>
-</div>
 EOS
     end
 
     def toc_out(node)
       curr_level = node.headline.level
       idx_no = node.section_no
+      idx_label = node.section_no + ' '
+      idx_label = '' unless @options[:num]
       str = toc_headline node.headline
-      ret = %Q|<li><a href="#sec-#{idx_no}">#{idx_no} #{str}</a>|
+      ret = %Q|<li><a href="#sec-#{idx_no}">#{idx_label}#{str}</a>|
       has_child = false
       node.children.each {|node|
         if node.kind == :SECTION
@@ -200,7 +217,11 @@ EOS
     def headline(node)
       level = node.level+1
       index_str = node.parent.section_no
-      %Q|<h#{level} id="sec-#{index_str}"><span class="section-number-#{level}">#{index_str}</span> #{exec_children(node).chomp} </h#{level}>|
+      if @options[:num]
+        %Q|<h#{level} id="sec-#{index_str}"><span class="section-number-#{level}">#{index_str}</span> #{exec_children(node).chomp} </h#{level}>|
+      else
+        %Q|<h#{level} id="sec-#{index_str}">#{exec_children(node).chomp} </h#{level}>|
+      end
     end
 
     # paragraph 
@@ -296,6 +317,17 @@ EOS
       %Q|#{indent}<blockquote>\n#{body.chomp}\n#{indent}</blockquote>\n|
     end
 
+    def graphviz(node)
+      text = exec_children(node)
+      g = GraphViz::Parser.parse_str(text, {})
+      fname = node.filename
+      fname = File.join(@options[:dot_path], node.filename) unless @options[:dot_path].empty?
+      g.output(node.type => fname)
+      ub = ''
+      ub = @options[:dot_url_base] if @options[:dot_url_base]
+      %Q|<img src="#{ub + node.filename}" />|
+    end
+
     def blocks(node)
         case node.block_name
         when 'VERSE'
@@ -306,6 +338,8 @@ EOS
           blockquote node
         when 'HTML'
           html_quote node
+        when 'DOT'
+          graphviz node
         when 'COMMENT'
           ''
         when 'SRC'
@@ -353,7 +387,7 @@ EOS
         if node.uri =~ @image_file_reg
           image_tag(node.uri, a_attr+img_attr)
         else
-          %Q|<a href="#{node.uri.sub(/^file:/,'')}"#{a_attr+img_attr}>node.uri</a>|
+          %Q|<a href="#{node.uri.sub(/^file:/,'')}"#{a_attr+img_attr}>#{node.uri}</a>|
         end
       else
         if desc =~ @image_file_reg

data/org-parse.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{org-parse}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["knb"]
-  s.date = %q{2010-03-23}
+  s.date = %q{2010-03-24}
   s.description = %q{This gem contains libraries for parsing org-mode files and build html or textile format file}
   s.email = %q{knb@artif.org}
   s.executables = ["org-parse", "org-test"]
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "bin/org-parse",
      "bin/org-test",
      "doc/images/org-parse-struct_1ffae50f0c5eb867f9418df6800f40a5cc3d1751.png",
+     "doc/images/org-parse-struct_ca4f70a7189eddf1f60e8486f7d289b294cf8df3.png",
      "doc/org-parse.html",
      "doc/org-parse.org",
      "doc/struct.dot",
@@ -90,7 +91,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/knb/org-parse}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{parse and convert Org-Mode file}
   s.test_files = [
     "test/test_org-parse.rb",

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: org-parse
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - knb
@@ -9,19 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-23 00:00:00 +09:00
+date: 2010-03-24 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ultraviolet
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 description: This gem contains libraries for parsing org-mode files and build html or textile format file
 email: knb@artif.org
 executables: 
@@ -44,6 +51,7 @@ files:
 - bin/org-parse
 - bin/org-test
 - doc/images/org-parse-struct_1ffae50f0c5eb867f9418df6800f40a5cc3d1751.png
+- doc/images/org-parse-struct_ca4f70a7189eddf1f60e8486f7d289b294cf8df3.png
 - doc/org-parse.html
 - doc/org-parse.org
 - doc/struct.dot
@@ -114,18 +122,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: parse and convert Org-Mode file