RubyGems - org-parse - Versions diffs - 0.1.1 - Mend

org-parse 0.1.1

Files changed (68) hide show

data/.document +5 -0
data/.gitignore +23 -0
data/ChangeLog +4 -0
data/LICENSE +20 -0
data/README.rdoc +68 -0
data/Rakefile +54 -0
data/VERSION.yml +5 -0
data/bin/org-parse +51 -0
data/bin/org-test +74 -0
data/doc/images/org-parse-struct_1ffae50f0c5eb867f9418df6800f40a5cc3d1751.png +0 -0
data/doc/org-parse.html +203 -0
data/doc/org-parse.org +71 -0
data/doc/struct.dot +10 -0
data/doc/struct.png +0 -0
data/examples/body-only.html.erb +1 -0
data/examples/dot.org-parse-rc +21 -0
data/lib/org-parse/inline-parser.output +945 -0
data/lib/org-parse/inline-parser.rb +219 -0
data/lib/org-parse/inline-parser.ry +77 -0
data/lib/org-parse/inline-parser.tab.rb +411 -0
data/lib/org-parse/node.rb +329 -0
data/lib/org-parse/struct-parser.output +1019 -0
data/lib/org-parse/struct-parser.rb +78 -0
data/lib/org-parse/struct-parser.ry +125 -0
data/lib/org-parse/struct-parser.tab.rb +608 -0
data/lib/org-parse/struct-scanner.rb +272 -0
data/lib/org-parse/templates/single.html.erb +118 -0
data/lib/org-parse/textile-visitor.rb +296 -0
data/lib/org-parse/utils.rb +15 -0
data/lib/org-parse/visitor.rb +542 -0
data/lib/org-parse.rb +46 -0
data/org-parse.gemspec +113 -0
data/rakelib/racc.rake +16 -0
data/test/data/blocks.org +67 -0
data/test/data/emphasis.org +7 -0
data/test/data/footnote.html +136 -0
data/test/data/footnote.org +8 -0
data/test/data/html-export.html +1062 -0
data/test/data/html-export.org +342 -0
data/test/data/images.html +179 -0
data/test/data/images.org +30 -0
data/test/data/index.org +242 -0
data/test/data/lily20100228.jpg +0 -0
data/test/data/lily20100228t.jpg +0 -0
data/test/data/link.org +7 -0
data/test/data/list_before_1st_headline.html +119 -0
data/test/data/list_before_1st_headline.org +7 -0
data/test/data/lists.html +284 -0
data/test/data/lists.org +78 -0
data/test/data/no-headline.org +6 -0
data/test/data/one-headline.org +2 -0
data/test/data/paragraph.org +13 -0
data/test/data/quote.org +15 -0
data/test/data/sections.html +173 -0
data/test/data/sections.org +9 -0
data/test/data/simple-list.org +6 -0
data/test/data/skip_t.org +3 -0
data/test/data/structure.org +53 -0
data/test/data/table.org +14 -0
data/test/data/test-list.org +12 -0
data/test/data/text-bef-hl.org +5 -0
data/test/data/text.org +6 -0
data/test/data/title.html +88 -0
data/test/data/title.org +6 -0
data/test/data/verse.org +48 -0
data/test/helper.rb +31 -0
data/test/test_org-parse.rb +148 -0
metadata +134 -0

data/.document ADDED Viewed

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore ADDED Viewed

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+## TEXTMATE
+*.tmproj
+tmtags
+## EMACS
+*~
+\#*
+.\#*
+## VIM
+*.swp
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+## PROJECT::SPECIFIC
+tmp/**/*
+dot.rc2

data/ChangeLog ADDED Viewed

@@ -0,0 +1,4 @@
+2010-03-10  Kensei Nakamura  <kensei@dalmore.artifarm.com>
+	* lib/org-parse/node.rb (OrgParse):

data/LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2009 kensei nakamura
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc ADDED Viewed

@@ -0,0 +1,68 @@
+= org-parse
+A library of Ruby which converts a document of Org-Mode into other formats.
+http://orgmode.org/
+I refer to cords of org-ruby.
+http://orgmode.org/worg/org-tutorials/org-ruby.php
+== using gems
+  ultraviolet (for syntax highlight)
+  shoulda (for test)
+== Usage
+=== command line tool
+Usage: org-parse [options] <file>
+    -h, --help                       Show this message
+    -f, --format FORMAT              Translate the ORG file to the specified format. html(default) or textile
+    -t, --template TEMPLATE          Erb template to build the html output.
+format
+  html (default)
+  textile
+template
+  Erb script.
+   default: lib/org-parse/templates/single.html.erb
+   variables
+    * title -- document title
+    * language -- document language
+    * charset
+    * add_to_head -- additional lines for <head> ... </head>
+    * before_text -- Texts before first section( #+TEXT ...)
+    * body -- body contents
+    * footnotes -- footnote definitions
+    * @options[] -- options
+   function
+    * table_of_contents
+=== as libraly
+    see bin/org-parse
+    Get a parser
+      parser = OrgParse::StructParser.new(data, title)
+        data: Org-Mode document (String)
+        title: Document title (Optional)
+    Do parse
+      root = parser.parse
+    Get a visitor
+      visitor = OrgParse::HtmlVisitor.new(root, template)
+             or
+      visitor = OrgParse::TextileVisitor.new(root)
+      template is optional. default is lib/org-parse/templates/single.html.erb
+    Build output
+      visitor.build
+=== todo
+  * write documents
+  * make tests
+  * impilment meny functions...
+== Copyright
+Copyright (c) 2010 knb. See LICENSE for details.

data/Rakefile ADDED Viewed

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "org-parse"
+    gem.summary = "parse and convert Org-Mode file"
+    gem.description = %Q|This gem contains libraries for parsing org-mode files and build html or textile format file|
+    gem.email = "knb@artif.org"
+    gem.homepage = "http://github.com/knb/org-parse"
+    gem.authors = ["knb"]
+    gem.add_development_dependency "ultraviolet", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+task :test => :check_dependencies
+task :default => :test
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "org-parse #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options = ["--charset", "utf-8"]
+end

data/VERSION.yml ADDED Viewed

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

data/bin/org-parse ADDED Viewed

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# require File.expand_path(
+#    File.join(File.dirname(__FILE__), %w[.. lib org-parse]))
+require 'rubygems'
+require 'org-parse'
+require 'optparse'
+options = {}
+options_parser = OptionParser.new do |opts|
+  options[:help] = false
+  options[:format] = :html
+  options[:template] = nil
+  opts.banner = "Usage: org-parse [options] <file>"
+  opts.on("-h", "--help", "Show this message") do |v|
+    options[:help] = true
+  end
+  opts.on("-f", "--format FORMAT", [:html, :textile],
+          "Translate the ORG file to the specified format. html(default) or textile") do |v|
+    options[:format] = v
+  end
+  opts.on("-t", "--template TEMPLATE",
+          "Erb template to build the html output.") do |v|
+    options[:template] = v
+  end
+end
+begin
+  options_parser.parse!
+  if (ARGV.length == 0) then
+    puts options_parser
+  else
+    data = IO.read(ARGV[0])
+    parser = OrgParse::StructParser.new(data, File.basename(ARGV[0], '.*'))
+    root = parser.parse
+    if options[:format] == :html
+      visitor = OrgParse::HtmlVisitor.new(root, options[:template])
+    elsif
+      visitor = OrgParse::TextileVisitor.new(root)
+    else
+      raise OptionParser::ParseError.new('format error')
+    end
+    puts visitor.build
+  end
+rescue OptionParser::ParseError
+  puts options_parser
+end

data/bin/org-test ADDED Viewed

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib org-parse]))
+#require 'rubygems'
+#require 'org-parse'
+require 'optparse'
+options = {}
+options_parser = OptionParser.new do |opts|
+  options[:help] = false
+  options[:format] = :html
+  options[:template] = nil
+  opts.banner = "Usage: org-parse [options] <file>"
+  opts.on("-h", "--help", "Show this message") do |v|
+    options[:help] = true
+  end
+  opts.on("-f", "--format FORMAT", [:html, :textile],
+          "Translate the ORG file to the specified format.(not yet)") do |v|
+    options[:format] = v
+  end
+  opts.on("-t", "--template TEMPLATE",
+          "Erb template for build the output.") do |v|
+    options[:template] = v
+  end
+end
+def update_test(node, opt = {})
+  cnt = 1;
+  section_no = node.section_no if node.kind == :SECTION
+  node.children.each do |n|
+    n.parent = node
+    if n.kind == :SECTION
+      if node.kind == :ROOT
+        n.section_no = cnt.to_s
+      else
+        n.section_no = section_no + "." + cnt.to_s
+      end
+      cnt += 1
+    end
+    update_test n, opt
+  end
+end
+def disp_toc(node)
+  node.children.each do |n|
+    if n.kind == :SECTION
+      puts n.section_no
+      disp_toc(n)
+    end
+  end
+end
+begin
+  options_parser.parse!
+  if (ARGV.length == 0) then
+    puts options_parser
+  else
+    data = IO.read(ARGV[0])
+    parser = OrgParse::StructParser.new(data, File.basename(ARGV[0], '.*'))
+    root = parser.parse
+    update_test(root)
+    disp_toc(root)
+    # visitor = OrgParse::HtmlVisitor.new(root, options[:template])
+    # puts visitor.build
+  end
+rescue OptionParser::ParseError
+  puts options_parser
+end

data/doc/images/org-parse-struct_1ffae50f0c5eb867f9418df6800f40a5cc3d1751.png ADDED Viewed

Binary file

data/doc/org-parse.html ADDED Viewed

@@ -0,0 +1,203 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+               "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"
+lang="en" xml:lang="en">
+<head>
+<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="author" content="Kensei Nakamura"/>
+<meta name="description" content=""/>
+<meta name="keywords" content=""/>
+<style type="text/css">
+ <!--/*--><![CDATA[/*><!--*/
+  html { font-family: Times, serif; font-size: 12pt; }
+  .title  { text-align: center; }
+  .todo   { color: red; }
+  .done   { color: green; }
+  .tag    { background-color: #add8e6; font-weight:normal }
+  .target { }
+  .timestamp { color: #bebebe; }
+  .timestamp-kwd { color: #5f9ea0; }
+  p.verse { margin-left: 3% }
+  pre {
+	border: 1pt solid #AEBDCC;
+	background-color: #F3F5F7;
+	padding: 5pt;
+	font-family: courier, monospace;
+        font-size: 90%;
+        overflow:auto;
+  }
+  table { border-collapse: collapse; }
+  td, th { vertical-align: top; }
+  dt { font-weight: bold; }
+  div.figure { padding: 0.5em; }
+  div.figure p { text-align: center; }
+  .linenr { font-size:smaller }
+  .code-highlighted {background-color:#ffff00;}
+  .org-info-js_info-navigation { border-style:none; }
+  #org-info-js_console-label { font-size:10px; font-weight:bold;
+                               white-space:nowrap; }
+  .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
+                                 font-weight:bold; }
+  /*]]>*/-->
+</style>
+<script type="text/javascript">
+<!--/*--><![CDATA[/*><!--*/
+ function CodeHighlightOn(elem, id)
+ {
+   var target = document.getElementById(id);
+   if(null != target) {
+     elem.cacheClassElem = elem.className;
+     elem.cacheClassTarget = target.className;
+     target.className = "code-highlighted";
+     elem.className   = "code-highlighted";
+   }
+ }
+ function CodeHighlightOff(elem, id)
+ {
+   var target = document.getElementById(id);
+   if(elem.cacheClassElem)
+     elem.className = elem.cacheClassElem;
+   if(elem.cacheClassTarget)
+     target.className = elem.cacheClassTarget;
+ }
+/*]]>*///-->
+</script>
+</head>
+<body>
+<div id="content">
+<h1 class="title">OrgParse</h1>
+<div id="table-of-contents">
+<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>
+<ul>
+<li><a href="#sec-3.1">3.1 概要 </a></li>
+</ul>
+</li>
+<li><a href="#sec-4">4 使い方 </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>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div id="outline-container-1" class="outline-2">
+<h2 id="sec-1"><span class="section-number-2">1</span> これは何か？ </h2>
+<div class="outline-text-2" id="text-1">
+<p><a href="http://orgmode.org">Org-Mode</a> で書かれた文書を他のフォーマットに変換するためのライブラリである。
+</p></div>
+</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">
+<p>直接の動機は、Redmine の文書やWikiに、Org-Modeで書いた文書を入れたかったから。
+長文になると、textileで書くのは骨が折れる。Org-Mode のアウトライン操作は快適である。
+</p>
+<p>
+この用途には<a href="http://orgmode.org/worg/org-tutorials/org-ruby.php">Org-ruby</a> が使えそうだけど、日本語の textile 文書との相性が悪かった。
+Org-rubyに手を入れるか自分用を作るか迷ったのだが、Racc の勉強を兼ねて一から作ることにした。
+</p></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>
+<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">
+<p>org-file を、スキャナー、パーサーを通して、構文木を作成する。
+出来上がった構文木から、HTMLや、textile 等のフォーマットの文書を構築する。
+</p>
+<p>
+<img src="images/org-parse-struct_1ffae50f0c5eb867f9418df6800f40a5cc3d1751.png"  alt="images/org-parse-struct_1ffae50f0c5eb867f9418df6800f40a5cc3d1751.png" />
+</p>
+<p>
+RDtool の構成と同じ様な形式である。
+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>
+<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">
+<pre class="example">Usage: org-parse [options] &lt;file&gt;
+  -h, --help                       Show this message
+  -f, --format FORMAT              Translate the ORG file to the specified format.(not yet)
+  -t, --template TEMPLATE          Erb template for build the output.
+</pre>
+</div>
+</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">
+<p>以下の様な感じ。
+</p>
+<pre class="example">data = IO.read(ARGV[0])
+# ソース文字列と、タイトルに使われるファイルのベース名を与える
+parser = OrgParse::StructParser.new(data, File.basename(ARGV[0], '.*'))
+# 構文解析を実行して、構文木を取得する
+root = parser.parse
+# ビジターに構文木を渡す。
+visitor = OrgParse::HtmlVisitor.new(root, options[:template])
+# 結果を得る
+puts visitor.build
+</pre>
+</div>
+</div>
+</div>
+<div id="postamble">
+<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>
+</div>
+</div>
+</body>
+</html>

data/doc/org-parse.org ADDED Viewed

@@ -0,0 +1,71 @@
+OrgParse
+* これは何か？
+  [[http://orgmode.org][Org-Mode]] で書かれた文書を他のフォーマットに変換するためのライブラリである。
+** 何故作ったか。
+  直接の動機は、Redmine の文書やWikiに、Org-Modeで書いた文書を入れたかったから。
+  長文になると、textileで書くのは骨が折れる。Org-Mode のアウトライン操作は快適である。
+  この用途には[[http://orgmode.org/worg/org-tutorials/org-ruby.php][Org-ruby]] が使えそうだけど、日本語の textile 文書との相性が悪かった。
+  Org-rubyに手を入れるか自分用を作るか迷ったのだが、Racc の勉強を兼ねて一から作ることにした。
+  が、構文エラーを出さない方針にしてみると、Racc 等の構文解析ライブラリは使いにくかった。
+  プログラミング言語じゃないから、あまりガチガチにすると使いにくいし、悩ましい所である。
+* 構成
+** 概要
+  org-file を、スキャナー、パーサーを通して、構文木を作成する。
+  出来上がった構文木から、HTMLや、textile 等のフォーマットの文書を構築する。
+#+BEGIN_DOT images/org-parse-struct.png -Tpng
+digraph structure {
+  graph [rankdir = LR];
+  "org-file" [shape = box];
+  output [shape = box];
+  tree [shape = box];
+  "org-file" -> parser;
+  parser -> tree;
+  tree -> visitor;
+  visitor -> output;
+}
+#+END_DOT
+  RDtool の構成と同じ様な形式である。
+  visitor の部分を置き換えることで、様々なフォーマットへ変換出来るようになる（予定）。
+* 使い方
+** org-parse コマンド
+#+begin_example
+  Usage: org-parse [options] <file>
+    -h, --help                       Show this message
+    -f, --format FORMAT              Translate the ORG file to the specified format.(not yet)
+    -t, --template TEMPLATE          Erb template for build the output.
+#+end_example
+** org-parse ライブラリ
+   以下の様な感じ。
+#+begin_example
+    data = IO.read(ARGV[0])
+    # ソース文字列と、タイトルに使われるファイルのベース名を与える
+    parser = OrgParse::StructParser.new(data, File.basename(ARGV[0], '.*'))
+    # 構文解析を実行して、構文木を取得する
+    root = parser.parse
+    # ビジターに構文木を渡す。
+    visitor = OrgParse::HtmlVisitor.new(root, options[:template])
+    # 結果を得る
+    puts visitor.build
+#+end_example
+* MEMO
+  以下は、これからの修正のための覚書
+** オプション類の扱い
+*** プログラム内でのオプションの記憶場所
+   オプションや、セクション番号等の情報は、各Nodeに持たせる。
+   つまり、ビジターで、コンテキストやオプション類の判定を行わないで済む様にする。
+   - セクション番号を、Section Node に持たせる
+   - Verse、Example 等は、各 BlockNode 配下のnode 自体が知っている
+*** オプションの指定方法
+   コマンドラインで指定。
+   コンフィグファイルを作る？(~/.org-parse-rc)
+   文書内での指定を最優先する方が正しいか？
+   [[../examples/dot.org-parse-rc]]
+*** オプションの優先順位
+    - デフォルト設定
+    - .opt-parse
+    - コマンドラインオプション
+    - ソースファイル内の指定

data/doc/struct.dot ADDED Viewed

@@ -0,0 +1,10 @@
+digraph structure {
+  graph [rankdir = LR];
+  "org-file" [shape = box];
+  output [shape = box];
+  tree [shape = box];
+  "org-file" -> parser;
+  parser -> tree;
+  tree -> visitor;
+  visitor -> output;
+}

data/doc/struct.png ADDED Viewed

Binary file

data/examples/body-only.html.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= @body %>

data/examples/dot.org-parse-rc ADDED Viewed

@@ -0,0 +1,21 @@
+# org-parse options
+---
+:author: knb
+:email: knb@artif.org
+:language: ja
+:charset: utf-8
+:skip: false
+:url: http://www.artif.org/
+:default_title: (no title)
+:H: 3
+:toc: true
+:timestamp: true
+:uv: true
+:num: true
+# :style: <link rel="stylesheet" type="text/css" href="css/eiffel.css" />
+# :creator: OrgParse 0.0.2 Powered by Ruby 1.8.7
+# :title:
+:text:
+  - Texts before 1st section.
+  - This must be array.