org-ruby 0.5.3 → 0.6.0

data/org-ruby.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{org-ruby}
+  s.version = "0.6.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Brian Dewey}]
+  s.date = %q{2011-09-03}
+  s.description = %q{This gem contains Ruby routines for parsing org-mode files.The most
+significant thing this library does today is convert org-mode files to
+HTML or textile. Currently, you cannot do much to customize the
+conversion. The supplied textile conversion is optimized for
+extracting "content" from the orgfile as opposed to "metadata." }
+  s.email = %q{bdewey@gmail.com}
+  s.executables = [%q{org-ruby}]
+  s.extra_rdoc_files = [%q{History.txt}, %q{README.rdoc}, %q{bin/org-ruby}]
+  s.files = [%q{.bnsignore}, %q{History.txt}, %q{README.rdoc}, %q{Rakefile}, %q{TAGS}, %q{bin/org-ruby}, %q{lib/org-ruby.rb}, %q{lib/org-ruby/headline.rb}, %q{lib/org-ruby/html_output_buffer.rb}, %q{lib/org-ruby/html_symbol_replace.rb}, %q{lib/org-ruby/line.rb}, %q{lib/org-ruby/output_buffer.rb}, %q{lib/org-ruby/parser.rb}, %q{lib/org-ruby/regexp_helper.rb}, %q{lib/org-ruby/textile_output_buffer.rb}, %q{lib/org-ruby/textile_symbol_replace.rb}, %q{spec/data/freeform-example.org}, %q{spec/data/freeform.org}, %q{spec/data/hyp-planning.org}, %q{spec/data/remember.org}, %q{spec/headline_spec.rb}, %q{spec/html_examples/advanced-code.html}, %q{spec/html_examples/advanced-code.org}, %q{spec/html_examples/advanced-lists.html}, %q{spec/html_examples/advanced-lists.org}, %q{spec/html_examples/block_code.html}, %q{spec/html_examples/block_code.org}, %q{spec/html_examples/blockcomment.html}, %q{spec/html_examples/blockcomment.org}, %q{spec/html_examples/blockquote.html}, %q{spec/html_examples/blockquote.org}, %q{spec/html_examples/center.html}, %q{spec/html_examples/center.org}, %q{spec/html_examples/code-comment.html}, %q{spec/html_examples/code-comment.org}, %q{spec/html_examples/custom-seq-todo.html}, %q{spec/html_examples/custom-seq-todo.org}, %q{spec/html_examples/custom-todo.html}, %q{spec/html_examples/custom-todo.org}, %q{spec/html_examples/custom-typ-todo.html}, %q{spec/html_examples/custom-typ-todo.org}, %q{spec/html_examples/deflist.html}, %q{spec/html_examples/deflist.org}, %q{spec/html_examples/entities.html}, %q{spec/html_examples/entities.org}, %q{spec/html_examples/escape-pre.html}, %q{spec/html_examples/escape-pre.org}, %q{spec/html_examples/export-exclude-only.html}, %q{spec/html_examples/export-exclude-only.org}, %q{spec/html_examples/export-keywords.html}, %q{spec/html_examples/export-keywords.org}, %q{spec/html_examples/export-tags.html}, %q{spec/html_examples/export-tags.org}, %q{spec/html_examples/export-title.html}, %q{spec/html_examples/export-title.org}, %q{spec/html_examples/footnotes.html}, %q{spec/html_examples/footnotes.org}, %q{spec/html_examples/html-literal.html}, %q{spec/html_examples/html-literal.org}, %q{spec/html_examples/inline-formatting.html}, %q{spec/html_examples/inline-formatting.org}, %q{spec/html_examples/inline-images.html}, %q{spec/html_examples/inline-images.org}, %q{spec/html_examples/link-features.html}, %q{spec/html_examples/link-features.org}, %q{spec/html_examples/lists.html}, %q{spec/html_examples/lists.org}, %q{spec/html_examples/metadata-comment.html}, %q{spec/html_examples/metadata-comment.org}, %q{spec/html_examples/only-list.html}, %q{spec/html_examples/only-list.org}, %q{spec/html_examples/only-table.html}, %q{spec/html_examples/only-table.org}, %q{spec/html_examples/skip-header.html}, %q{spec/html_examples/skip-header.org}, %q{spec/html_examples/skip-table.html}, %q{spec/html_examples/skip-table.org}, %q{spec/html_examples/subsupscript-nil.html}, %q{spec/html_examples/subsupscript-nil.org}, %q{spec/html_examples/subsupscript.html}, %q{spec/html_examples/subsupscript.org}, %q{spec/html_examples/tables.html}, %q{spec/html_examples/tables.org}, %q{spec/html_examples/text.html}, %q{spec/html_examples/text.org}, %q{spec/line_spec.rb}, %q{spec/output_buffer_spec.rb}, %q{spec/parser_spec.rb}, %q{spec/regexp_helper_spec.rb}, %q{spec/spec_helper.rb}, %q{spec/textile_examples/block_code.org}, %q{spec/textile_examples/block_code.textile}, %q{spec/textile_examples/blockquote.org}, %q{spec/textile_examples/blockquote.textile}, %q{spec/textile_examples/center.org}, %q{spec/textile_examples/center.textile}, %q{spec/textile_examples/footnotes.org}, %q{spec/textile_examples/footnotes.textile}, %q{spec/textile_examples/keywords.org}, %q{spec/textile_examples/keywords.textile}, %q{spec/textile_examples/links.org}, %q{spec/textile_examples/links.textile}, %q{spec/textile_examples/lists.org}, %q{spec/textile_examples/lists.textile}, %q{spec/textile_examples/single-space-plain-list.org}, %q{spec/textile_examples/single-space-plain-list.textile}, %q{spec/textile_examples/tables.org}, %q{spec/textile_examples/tables.textile}, %q{spec/textile_output_buffer_spec.rb}, %q{tasks/test_case.rake}, %q{test/test_orgmode_parser.rb}, %q{util/gen-special-replace.el}]
+  s.homepage = %q{http://github.com/bdewey/org-ruby}
+  s.rdoc_options = [%q{--main}, %q{README.rdoc}]
+  s.require_paths = [%q{lib}]
+  s.rubyforge_project = %q{org-ruby}
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{This gem contains Ruby routines for parsing org-mode files.}
+  s.test_files = [%q{test/test_orgmode_parser.rb}]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rubypants>, [">= 0.2.0"])
+      s.add_development_dependency(%q<bones>, [">= 3.7.1"])
+    else
+      s.add_dependency(%q<rubypants>, [">= 0.2.0"])
+      s.add_dependency(%q<bones>, [">= 3.7.1"])
+    end
+  else
+    s.add_dependency(%q<rubypants>, [">= 0.2.0"])
+    s.add_dependency(%q<bones>, [">= 3.7.1"])
+  end
+end

data/spec/headline_spec.rb

@@ -26,6 +26,11 @@ describe Orgmode::Headline do
     end
   end
 
+  it "should properly determine headline level with offset" do
+    h = Orgmode::Headline.new("* one", nil, 1)
+    h.level.should eql(2)
+  end
+
   it "should find simple headline text" do
     h = Orgmode::Headline.new "*** sample"
     h.headline_text.should eql("sample")

data/spec/html_examples/advanced-code.html

@@ -34,3 +34,13 @@ END:
       end
     end
 </pre>
+<p>Now let&#8217;s test case-insensitive code blocks.</p>
+<pre class="src">
+    # Finds all emphasis matches in a string.
+    # Supply a block that will get the marker and body as parameters.
+    def match_all(str)
+      str.scan(@org_emphasis_regexp) do |match|
+        yield $2, $3
+      end
+    end
+</pre>

data/spec/html_examples/advanced-code.org

@@ -51,3 +51,16 @@ And this:
       end
     end
 #+END_SRC
+
+Now let's test case-insensitive code blocks.
+
+#+begin_src ruby
+    # Finds all emphasis matches in a string.
+    # Supply a block that will get the marker and body as parameters.
+    def match_all(str)
+      str.scan(@org_emphasis_regexp) do |match|
+        yield $2, $3
+      end
+    end
+#+end_src
+

data/spec/html_examples/blockcomment.html

@@ -0,0 +1,3 @@
+<p class="title">BLOCKCOMMENT</p>
+<p>Testing that the next part is ignored</p>
+<p>And now back to normal!</p>

data/spec/html_examples/blockcomment.org

@@ -0,0 +1,15 @@
+BLOCKCOMMENT
+
+Testing that the next part is ignored
+
+#+BEGIN_COMMENT
+
+/Foo/
+
+#+BEGIN_SRC c++
+int main() { }
+#+END_SRC
+
+#+END_COMMENT
+
+And now back to normal!

data/spec/html_examples/center.html

@@ -0,0 +1,6 @@
+<p class="title">Fou</p>
+<p>not center</p>
+<div style="text-align: center">
+  <p>center</p>
+</div>
+<p>not center, again</p>

data/spec/html_examples/center.org

@@ -0,0 +1,7 @@
+#+TITLE: Fou
+
+not center
+#+BEGIN_CENTER
+center
+#+END_CENTER
+not center, again

data/spec/html_examples/deflist.html

@@ -0,0 +1,6 @@
+<p class="title">Hallo</p>
+<dl>
+  <dt>a</dt><dd>hello</dd>
+  <dt>b</dt><dd>world</dd>
+</dl>
+<p>Text</p>

data/spec/html_examples/deflist.org

@@ -0,0 +1,6 @@
+#+TITLE: Hallo
+
+- a :: hello
+- b :: world
+
+Text

data/spec/html_examples/footnotes.html

@@ -0,0 +1,10 @@
+<p class="title">Footnotes</p>
+<p>Hello<sup><a class="footref" name="fnr.abc" href="#fn.abc">abc</a></sup> World<sup><a class="footref" name="fnr.abc" href="#fn.abc">abc</a></sup></p>
+<p>Bfoo<sup><a class="footref" name="fnr.1" href="#fn.1">1</a></sup></p>
+<div id="footnotes">
+<h2 class="footnotes">Footnotes: </h2>
+<div id="text-footnotes">
+<p class="footnote"><sup><a class="footnum" name="fn.abc" href="#fnr.abc">abc</a></sup>definition of abc</p>
+<p class="footnote"><sup><a class="footnum" name="fn.1" href="#fnr.1">1</a></sup><b>blub</b></p>
+</div>
+</div>

data/spec/html_examples/footnotes.org

@@ -0,0 +1,7 @@
+#+TITLE: Footnotes
+#+OPTIONS: f:t
+
+Hello[fn:abc]
+World[fn:abc:definition of abc]
+
+Bfoo[fn:1:*blub*]

data/spec/html_examples/inline-formatting.html

@@ -8,3 +8,11 @@
 </ul>
 <p>Note the last one <b>is not</b> a link, as the source doesn&#8217;t include it in double-brackets and I don&#8217;t auto-recognize URLs.</p>
 <p>I should also handle links with <a href="http://www.xkcd.com">helpful text</a>.</p>
+<p>Helpful addition from <a href="https://github.com/punchagan">punchagan</a>, we now recognize when the link goes to an image and make the link anchor be the image, like this:</p>
+<ul>
+  <li><a href="http://farm7.static.flickr.com/6078/6084185195_552aa270b2.jpg"><img src="http://farm7.static.flickr.com/6078/6084185195_552aa270b2.jpg" /></a></li>
+</ul>
+<p>Also, if you make the descriptive text be an image, then it will get formatted with an image tag, like so:</p>
+<ul>
+  <li><a href="http://www.xkcd.com"><img src="http://imgs.xkcd.com/comics/t_cells.png" /></a></li>
+</ul>

data/spec/html_examples/inline-formatting.org

@@ -15,3 +15,13 @@ double-brackets and I don't auto-recognize URLs.
 
 I should also handle links with [[http://www.xkcd.com][helpful text]].
 
+Helpful addition from [[https://github.com/punchagan][punchagan]], we now
+recognize when the link goes to an image and make the link anchor be the
+image, like this:
+
+- [[http://farm7.static.flickr.com/6078/6084185195_552aa270b2.jpg]]
+
+Also, if you make the descriptive text be an image, then it will get formatted
+with an image tag, like so:
+
+- [[http://www.xkcd.com][http://imgs.xkcd.com/comics/t_cells.png]]

data/spec/html_examples/inline-images.html

@@ -1,6 +1,6 @@
 <p class="title">Inline Images</p>
 <p>Per the org-mode <a href="http://orgmode.org/manual/Images-and-tables.html#Images-and-tables">spec</a>, you can include inline images as links without any descriptive link text, like this:</p>
-<p><img src="http://farm5.static.flickr.com/4049/4358074549_5efb8b4903.jpg" /></p>
+<p><a href="http://farm5.static.flickr.com/4049/4358074549_5efb8b4903.jpg"><img src="http://farm5.static.flickr.com/4049/4358074549_5efb8b4903.jpg" /></a></p>
 <p>I currently do not support the caption/link syntax, but I can include the inline image. I recognize the following image file types:</p>
 <ul>
   <li>.jpg</li>

data/spec/html_examples/lists.html

@@ -17,3 +17,7 @@
   <li>This is a single-line list.</li>
 </ul>
 <p>And this is a <b>separate paragraph.</b> Note the indentation in the org file.</p>
+<h2>Invalid lists</h2>
+<p>Note that spaces are required to denote lists. Thus, none of the following should get recognized as lists.</p>
+<p>-This isn&#8217;t a list. -And this isn&#8217;t a list.</p>
+<p>1.And this isn&#8217;t a list. 2.And this isn&#8217;t a list.</p>

data/spec/html_examples/lists.org

@@ -34,3 +34,14 @@ And this is a paragraph *after* the list.
    - This is a single-line list.
    And this is a *separate paragraph.* Note the indentation in the org
    file.
+   
+** Invalid lists
+
+   Note that spaces are required to denote lists. Thus, none of the following
+   should get recognized as lists.
+   
+   -This isn't a list.
+   -And this isn't a list.
+   
+   1.And this isn't a list.
+   2.And this isn't a list.

data/spec/html_examples/subsupscript-nil.html

@@ -0,0 +1,3 @@
+<p class="title">SUBSUPSCRIPT</p>
+<p>a^{b}</p>
+<p>a_{b}</p>

data/spec/html_examples/subsupscript-nil.org

@@ -0,0 +1,6 @@
+#+OPTIONS: ^:nil
+SUBSUPSCRIPT
+
+a^{b}
+
+a_{b}

data/spec/html_examples/subsupscript.html

@@ -0,0 +1,3 @@
+<p class="title">SUBSUPSCRIPT</p>
+<p>a<sup>b</sup></p>
+<p>a<sub>b</sub></p>

data/spec/html_examples/subsupscript.org

@@ -0,0 +1,5 @@
+SUBSUPSCRIPT
+
+a^{b}
+
+a_{b}

data/spec/html_examples/tables.html

@@ -18,3 +18,18 @@
   <tr><td>Seven</td><td>Eight</td><td>Nine</td></tr>
 </table>
 <p>The separator row should not get printed out.</p>
+<h1>Table with complete box</h1>
+<table>
+  <tr><th>One</th><th>Two</th><th>Three</th></tr>
+  <tr><td>Four</td><td>Five</td><td>Six</td></tr>
+  <tr><td>Seven</td><td>Eight</td><td>Nine</td></tr>
+</table>
+<p>Only the first row should be a header row.</p>
+<h1>Table with extra lines</h1>
+<table>
+  <tr><th>One</th><th>Two</th><th>Three</th></tr>
+  <tr><td>Four</td><td>Five</td><td>Six</td></tr>
+  <tr><td>Seven</td><td>Eight</td><td>Nine</td></tr>
+  <tr><td>Ten</td><td>Eleven</td><td>Twelve</td></tr>
+</table>
+<p>Only the first row should be a header row.</p>

data/spec/html_examples/tables.org

@@ -24,3 +24,27 @@ Different types of ORG tables.
   | Seven | Eight | Nine  |
 
   The separator row should not get printed out.
+
+* Table with complete box
+
+  |-------+-------+-------|
+  | One   | Two   | Three |
+  |-------+-------+-------|
+  | Four  | Five  | Six   |
+  | Seven | Eight | Nine  |
+  |-------+-------+-------|
+
+  Only the first row should be a header row.
+
+* Table with extra lines
+
+  |-------+--------+--------|
+  | One   | Two    | Three  |
+  |-------+--------+--------|
+  | Four  | Five   | Six    |
+  | Seven | Eight  | Nine   |
+  |-------+--------+--------|
+  | Ten   | Eleven | Twelve |
+  |-------+--------+--------|
+
+  Only the first row should be a header row.

data/spec/line_spec.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), %w[spec_helper])
 describe Orgmode::Line do
 
   it "should tell comments" do
-    comments = ["# hello", "#hello", "   #hello", "\t#hello\n"]
+    comments = ["# hello", "#hello" ]
     comments.each do |c|
       line = Orgmode::Line.new c
       line.comment?.should be_true
@@ -29,20 +29,26 @@ describe Orgmode::Line do
       Orgmode::Line.new(inline_example).inline_example?.should be_true
     end
   end
-    
-
-  it "should recognize plain lists" do
-    list_formats = ["-",
-                    "+",
-                    "  -",
-                    "  +",
-                    " 1.",
-                    " 2)"]
-    list_formats.each do |list|
+
+  list_formats = ["- ",
+                  "+ ",
+                  "  - ",
+                  "  + ",
+                  " 1. ",
+                  " 2) "]
+  list_formats.each do |list|
+    it "should recognize this list format: '#{list}'" do
       line = Orgmode::Line.new list
       line.plain_list?.should be_true
     end
   end
+  
+  ["-foo", "+foo", "1.foo", "2.foo"].each do |invalid_list|
+    it "should not recognize this invalid list: '#{invalid_list}'" do
+      line = Orgmode::Line.new invalid_list
+      line.plain_list?.should_not be_true
+    end
+  end
 
   it "should recognize table rows" do
     Orgmode::Line.new("| One   | Two   | Three |").table_row?.should be_true
@@ -81,14 +87,12 @@ describe Orgmode::Line do
 
     begin_examples.each_key do |str|
       line = Orgmode::Line.new str
-      line.comment?.should be_true
       line.begin_block?.should be_true
       line.block_type.should eql(begin_examples[str])
     end
 
     end_examples.each_key do |str|
       line = Orgmode::Line.new str
-      line.comment?.should be_true
       line.end_block?.should be_true
       line.block_type.should eql(end_examples[str])
     end

data/spec/spec_helper.rb

@@ -7,8 +7,7 @@ RememberFile = File.join(File.dirname(__FILE__), %w[data remember.org])
 FreeformFile = File.join(File.dirname(__FILE__), %w[data freeform.org])
 FreeformExampleFile = File.join(File.dirname(__FILE__), %w[data freeform-example.org])
 
-
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   # == Mock Framework
   #
   # RSpec uses it's own mocking framework by default. If you prefer to

data/spec/textile_examples/center.org

@@ -0,0 +1,7 @@
+#+TITLE: Fou
+
+not center
+#+BEGIN_CENTER
+center
+#+END_CENTER
+not center, again

data/spec/textile_examples/center.textile

@@ -0,0 +1,6 @@
+
+not center 
+
+p=. center 
+
+not center, again 

data/spec/textile_examples/footnotes.org

@@ -0,0 +1,7 @@
+#+TITLE: Footnotes
+#+OPTIONS: f:t
+
+Hello[fn:abc]
+World[fn:abc:definition of abc]
+
+Bfoo[fn:1:*blub*]

data/spec/textile_examples/footnotes.textile

@@ -0,0 +1,8 @@
+
+Hello[833038373] World[833038373] 
+
+Bfoo[1] 
+
+fn1. *blub*
+
+fn833038373. definition of abc

data/spec/textile_examples/tables.org

@@ -24,3 +24,27 @@ Different types of ORG tables.
   | Seven | Eight | Nine  |
 
   The separator row should not get printed out.
+
+* Table with complete box
+
+  |-------+-------+-------|
+  | One   | Two   | Three |
+  |-------+-------+-------|
+  | Four  | Five  | Six   |
+  | Seven | Eight | Nine  |
+  |-------+-------+-------|
+
+  Only the first row should be a header row.
+
+* Table with extra lines
+
+  |-------+--------+--------|
+  | One   | Two    | Three  |
+  |-------+--------+--------|
+  | Four  | Five   | Six    |
+  | Seven | Eight  | Nine   |
+  |-------+--------+--------|
+  | Ten   | Eleven | Twelve |
+  |-------+--------+--------|
+
+  Only the first row should be a header row.

data/spec/textile_examples/tables.textile

@@ -21,3 +21,20 @@ h1. Table with header
 | Seven | Eight | Nine  |
 
 The separator row should not get printed out. 
+
+h1. Table with complete box
+
+| One   | Two   | Three |
+| Four  | Five  | Six   |
+| Seven | Eight | Nine  |
+
+Only the first row should be a header row. 
+
+h1. Table with extra lines
+
+| One   | Two    | Three  |
+| Four  | Five   | Six    |
+| Seven | Eight  | Nine   |
+| Ten   | Eleven | Twelve |
+
+Only the first row should be a header row.