org-ruby 0.4.2 → 0.5.0

data/spec/html_examples/export-title.html

@@ -0,0 +1,2 @@
+<p class="title">Export Title</p>
+<p>This simple org document should get a title from the <code>TITLE</code> option at the front of the file.</p>

data/spec/html_examples/export-title.org

@@ -0,0 +1,4 @@
+#+TITLE:   Export Title
+
+This simple org document should get a title from the =TITLE= option at
+the front of the file.

data/spec/html_examples/link-features.html

@@ -0,0 +1,8 @@
+<p class="title">link-features.org</p>
+<p>Org-mode export supports a lot of link features. I&#8217;ve covered &#8220;simple&#8221; HTML links elsewhere. Now let&#8217;s cover links to other org files, other sections within documents, etc.</p>
+<h1>Links to other org files</h1>
+<p>This is a link to the <code>code-comment.org</code> file in the same directory. In <code>emacs</code>, if you click it, the other file opens. We want the same behavior in the HTML export.</p>
+<p><a href="code-comment.html">Code Comment</a></p>
+<h1>Search links</h1>
+<p>This is a search link into code-comment.org.</p>
+<p><a href="code-comment.html">Code Comment</a></p>

data/spec/html_examples/link-features.org

@@ -0,0 +1,19 @@
+#+TITLE: link-features.org
+
+Org-mode export supports a lot of link features. I've covered "simple"
+HTML links elsewhere. Now let's cover links to other org files, other
+sections within documents, etc.
+
+* Links to other org files
+
+  This is a link to the ~code-comment.org~ file in the same
+  directory. In ~emacs~, if you click it, the other file opens. We
+  want the same behavior in the HTML export.
+
+  [[file:code-comment.org][Code Comment]]
+
+* Search links
+
+  This is a search link into code-comment.org.
+
+  [[file:code-comment.org::*Code%20Comment][Code Comment]]

data/spec/html_examples/only-table.html

@@ -1,5 +1,5 @@
 <table>
-  <tr><td>One</td><td>Two</td><td>Three</td><td>Four</td></tr>
+  <tr><th>One</th><th>Two</th><th>Three</th><th>Four</th></tr>
   <tr><td>Five</td><td>Six</td><td>Seven</td><td>Eight</td></tr>
   <tr><td>Nine</td><td>Ten</td><td>Eleven</td><td>Twelve</td></tr>
   <tr><td><b>format</b></td><td><i>text</i></td><td><code>in</code></td><td><span style="text-decoration:underline;">cells</span></td></tr>

data/spec/html_examples/skip-header.html

@@ -0,0 +1,3 @@
+<p class="title">skip-header.org</p>
+<h1><span class="heading-number heading-number-1">1 </span>First heading</h1>
+<p>This should be the first text in the output.</p>

data/spec/html_examples/skip-header.org

@@ -0,0 +1,28 @@
+#+TITLE:     skip-header.org
+#+AUTHOR:    
+#+EMAIL:     brian@BRIAN-DESK
+#+DATE:      2009-12-29 Tue
+#+DESCRIPTION: 
+#+KEYWORDS: 
+#+LANGUAGE:  en
+#+OPTIONS:   H:3 num:t toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t
+#+OPTIONS:   TeX:t LaTeX:nil skip:t d:nil todo:t pri:nil tags:not-in-toc
+#+INFOJS_OPT: view:nil toc:nil ltoc:t mouse:underline buttons:0 path:http://orgmode.org/org-info.js
+#+EXPORT_SELECT_TAGS: export
+#+EXPORT_EXCLUDE_TAGS: noexport
+#+LINK_UP:   
+#+LINK_HOME: 
+This is header text.
+It exists in the org-file, but shouldn't show up in the HTML output.
+
+- Same with this list
+- Nope, shouldn't be in the output.
+
+#+BEGIN_EXAMPLE
+Even this code snippet shouldn't be there.
+Like a ninja. You can't see me.
+#+END_EXAMPLE
+
+* First heading
+
+  This should be the first text in the output.

data/spec/html_examples/skip-table.html

@@ -0,0 +1,4 @@
+<p class="title">skip-table.org</p>
+<p>Checking that tables are skipped when directed.</p>
+<p>For grins, here&#8217;s another table without a header. Just keep the bases covered.</p>
+<p>Again, in the HTML output, you should see <b>no tables</b>.</p>

data/spec/html_examples/skip-table.org

@@ -0,0 +1,19 @@
+#+TITLE:     skip-table.org
+#+OPTIONS:   |:nil
+
+Checking that tables are skipped when directed.
+
+| One   | Two   | Three |
+|-------+-------+-------|
+| Four  | Five  | Six   |
+| Seven | Eight | Nine  |
+
+
+For grins, here's another table without a header. Just keep the bases
+covered. 
+
+| One   | Two   | Three |
+| Four  | Five  | Six   |
+| Seven | Eight | Nine  |
+
+Again, in the HTML output, you should see *no tables*. 

data/spec/html_examples/tables.html

@@ -13,7 +13,7 @@
 <p>And here&#8217;s some paragraph content. The line breaks will need to get removed here, but not for the tables.</p>
 <h1>Table with header</h1>
 <table>
-  <tr><td>One</td><td>Two</td><td>Three</td></tr>
+  <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>

data/spec/line_spec.rb

@@ -106,4 +106,39 @@ describe Orgmode::Line do
       l.paragraph_type.should eql(value)
     end
   end
+
+  it "should parse in-buffer settings" do
+    cases = {
+      "#+ARCHIVE: %s_done" => { :key => "ARCHIVE", :value => "%s_done" },
+      "#+CATEGORY: foo" => { :key => "CATEGORY", :value => "foo"},
+      "#+BEGIN_EXAMPLE:" => { :key => "BEGIN_EXAMPLE", :value => "" },
+      "#+A:" => { :key => "A", :value => "" } # Boundary: Smallest keyword is one letter
+    }
+    cases.each_pair do |key, value|
+      l = Orgmode::Line.new key
+      l.in_buffer_setting?.should be_true
+      called = nil
+      l.in_buffer_setting? do |k, v|
+        k.should eql(value[:key])
+        v.should eql(value[:value])
+        called = true
+      end
+      called.should be_true
+    end
+  end
+
+  it "should reject ill-formed settings" do
+    cases = [
+             "##+ARCHIVE: blah",
+             "#CATEGORY: foo",
+             "",
+             "\n",
+             "   #+BEGIN_EXAMPLE:\n"
+            ]
+
+    cases.each do |c|
+      l = Orgmode::Line.new c
+      l.in_buffer_setting?.should be_nil
+    end
+  end
 end

data/spec/parser_spec.rb

@@ -42,12 +42,86 @@ describe Orgmode::Parser do
     parser.should have(19).header_lines
   end
 
+  it "should load in-buffer settings" do
+    parser = Orgmode::Parser.load(FreeformFile)
+    parser.should have(12).in_buffer_settings
+    parser.in_buffer_settings["TITLE"].should eql("Freeform")
+    parser.in_buffer_settings["EMAIL"].should eql("bdewey@gmail.com")
+    parser.in_buffer_settings["LANGUAGE"].should eql("en")
+  end
+
+  it "should understand OPTIONS" do
+    parser = Orgmode::Parser.load(FreeformFile)
+    parser.should have(19).options
+    parser.options["TeX"].should eql("t")
+    parser.options["todo"].should eql("t")
+    parser.options["\\n"].should eql("nil")
+    parser.export_todo?.should be_true
+    parser.options.delete("todo")
+    parser.export_todo?.should be_false
+  end
+
+  it "computes outline level numbering" do
+    parser = Orgmode::Parser.new ""
+    parser.get_next_headline_number(1).should eql("1")
+    parser.get_next_headline_number(1).should eql("2")
+    parser.get_next_headline_number(1).should eql("3")
+    parser.get_next_headline_number(1).should eql("4")
+    parser.get_next_headline_number(2).should eql("4.1")
+    parser.get_next_headline_number(2).should eql("4.2")
+    parser.get_next_headline_number(1).should eql("5")
+    parser.get_next_headline_number(2).should eql("5.1")
+    parser.get_next_headline_number(2).should eql("5.2")
+    parser.get_next_headline_number(4).should eql("5.2.0.1")
+  end
+
+  it "should skip in-buffer settings inside EXAMPLE blocks" do
+    parser = Orgmode::Parser.load(FreeformExampleFile)
+    parser.should have(0).in_buffer_settings
+  end
+
   it "should return a textile string" do
     parser = Orgmode::Parser.load(FreeformFile)
     parser.to_textile.should be_kind_of(String)
   end
 
-  it "can translate textile files" do
+  it "should understand export table option" do
+    fname = File.join(File.dirname(__FILE__), %w[html_examples skip-table.org])
+    data = IO.read(fname)
+    p = Orgmode::Parser.new(data)
+    p.export_tables?.should be_false
+  end
+
+  describe "Custom keyword parser" do
+    fname = File.join(File.dirname(__FILE__), %w[html_examples custom-todo.org])
+    p = Orgmode::Parser.load(fname)
+    valid_keywords = %w[TODO INPROGRESS WAITING DONE CANCELED]
+    invalid_keywords = %w[TODOX todo inprogress Waiting done cANCELED NEXT |]
+    valid_keywords.each do |kw|
+      it "should match custom keyword #{kw}" do
+        (kw =~ p.custom_keyword_regexp).should be_true
+      end
+    end
+    invalid_keywords.each do |kw|
+      it "should not match custom keyword #{kw}" do
+        (kw =~ p.custom_keyword_regexp).should be_nil
+      end
+    end
+    it "should not match blank as a custom keyword" do
+      ("" =~ p.custom_keyword_regexp).should be_nil
+    end
+  end
+
+  describe "Custom include/exclude parser" do
+    fname = File.join(File.dirname(__FILE__), %w[html_examples export-tags.org])
+    p = Orgmode::Parser.load(fname)
+    it "should load tags" do
+      p.should have(2).export_exclude_tags
+      p.should have(1).export_select_tags
+    end
+  end
+
+  describe "Export to Textile test cases" do
     data_directory = File.join(File.dirname(__FILE__), "textile_examples")
     org_files = File.expand_path(File.join(data_directory, "*.org" ))
     files = Dir.glob(org_files)
@@ -56,16 +130,20 @@ describe Orgmode::Parser do
       textile_name = File.join(data_directory, basename + ".textile")
       textile_name = File.expand_path(textile_name)
 
-      expected = IO.read(textile_name)
-      expected.should be_kind_of(String)
-      parser = Orgmode::Parser.new(IO.read(file))
-      actual = parser.to_textile
-      actual.should be_kind_of(String)
-      actual.should == expected
+      it "should convert #{basename}.org to Textile" do
+        expected = IO.read(textile_name)
+        expected.should be_kind_of(String)
+        parser = Orgmode::Parser.new(IO.read(file))
+        actual = parser.to_textile
+        actual.should be_kind_of(String)
+        actual.should == expected
+      end
     end
   end
 
-  it "can translate to html" do
+  describe "Export to HTML test cases" do
+    # Dynamic generation of examples from each *.org file in html_examples.
+    # Each of these files is convertable to HTML.
     data_directory = File.join(File.dirname(__FILE__), "html_examples")
     org_files = File.expand_path(File.join(data_directory, "*.org" ))
     files = Dir.glob(org_files)
@@ -74,12 +152,14 @@ describe Orgmode::Parser do
       textile_name = File.join(data_directory, basename + ".html")
       textile_name = File.expand_path(textile_name)
 
-      expected = IO.read(textile_name)
-      expected.should be_kind_of(String)
-      parser = Orgmode::Parser.new(IO.read(file))
-      actual = parser.to_html
-      actual.should be_kind_of(String)
-      actual.should == expected
+      it "should convert #{basename}.org to HTML" do
+        expected = IO.read(textile_name)
+        expected.should be_kind_of(String)
+        parser = Orgmode::Parser.new(IO.read(file))
+        actual = parser.to_html
+        actual.should be_kind_of(String)
+        actual.should == expected
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require File.expand_path(
 
 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|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: org-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors: 
 - Brian Dewey
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-29 00:00:00 -08:00
+date: 2009-12-30 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,6 +60,7 @@ files:
 - lib/org-ruby/parser.rb
 - lib/org-ruby/regexp_helper.rb
 - lib/org-ruby/textile_output_buffer.rb
+- spec/data/freeform-example.org
 - spec/data/freeform.org
 - spec/data/hyp-planning.org
 - spec/data/remember.org
@@ -72,14 +73,30 @@ files:
 - spec/html_examples/blockquote.org
 - spec/html_examples/code-comment.html
 - spec/html_examples/code-comment.org
+- spec/html_examples/custom-seq-todo.html
+- spec/html_examples/custom-seq-todo.org
+- spec/html_examples/custom-todo.html
+- spec/html_examples/custom-todo.org
+- spec/html_examples/custom-typ-todo.html
+- spec/html_examples/custom-typ-todo.org
 - spec/html_examples/entities.html
 - spec/html_examples/entities.org
 - spec/html_examples/escape-pre.html
 - spec/html_examples/escape-pre.org
+- spec/html_examples/export-exclude-only.html
+- spec/html_examples/export-exclude-only.org
+- spec/html_examples/export-keywords.html
+- spec/html_examples/export-keywords.org
+- spec/html_examples/export-tags.html
+- spec/html_examples/export-tags.org
+- spec/html_examples/export-title.html
+- spec/html_examples/export-title.org
 - spec/html_examples/html-literal.html
 - spec/html_examples/html-literal.org
 - spec/html_examples/inline-formatting.html
 - spec/html_examples/inline-formatting.org
+- spec/html_examples/link-features.html
+- spec/html_examples/link-features.org
 - spec/html_examples/lists.html
 - spec/html_examples/lists.org
 - spec/html_examples/metadata-comment.html
@@ -88,6 +105,10 @@ files:
 - spec/html_examples/only-list.org
 - spec/html_examples/only-table.html
 - spec/html_examples/only-table.org
+- spec/html_examples/skip-header.html
+- spec/html_examples/skip-header.org
+- spec/html_examples/skip-table.html
+- spec/html_examples/skip-table.org
 - spec/html_examples/tables.html
 - spec/html_examples/tables.org
 - spec/html_examples/text.html