wallyqs-org-ruby 0.6.1

data/spec/parser_spec.rb

@@ -0,0 +1,152 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Orgmode::Parser do
+  it "should open ORG files" do
+    parser = Orgmode::Parser.load(RememberFile)
+  end
+
+  it "should fail on non-existant files" do
+    lambda { parser = Orgmode::Parser.load("does-not-exist.org") }.should raise_error
+  end
+
+  it "should load all of the lines" do
+    parser = Orgmode::Parser.load(RememberFile)
+    parser.lines.length.should eql(53)
+  end
+
+  it "should find all headlines" do
+    parser = Orgmode::Parser.load(RememberFile)
+    parser.should have(12).headlines
+  end
+
+  it "can find a headline by index" do
+    parser = Orgmode::Parser.load(RememberFile)
+    parser.headlines[1].line.should eql("** YAML header in Webby\n")
+  end
+
+  it "should determine headline levels" do
+    parser = Orgmode::Parser.load(RememberFile)
+    parser.headlines[0].level.should eql(1)
+    parser.headlines[1].level.should eql(2)
+  end
+
+  it "should put body lines in headlines" do
+    parser = Orgmode::Parser.load(RememberFile)
+    parser.headlines[0].should have(1).body_lines
+    parser.headlines[1].should have(7).body_lines
+  end
+
+  it "should understand lines before the first headline" do
+    parser = Orgmode::Parser.load(FreeformFile)
+    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 "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 "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)
+    files.each do |file|
+      basename = File.basename(file, ".org")
+      textile_name = File.join(data_directory, basename + ".textile")
+      textile_name = File.expand_path(textile_name)
+
+      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
+
+  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)
+    files.each do |file|
+      basename = File.basename(file, ".org")
+      textile_name = File.join(data_directory, basename + ".html")
+      textile_name = File.expand_path(textile_name)
+
+      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/regexp_helper_spec.rb

@@ -0,0 +1,57 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Orgmode::RegexpHelper do
+  it "should recognize simple markup" do
+    e = Orgmode::RegexpHelper.new
+    total = 0
+    e.match_all("/italic/") do |border, string|
+      border.should eql("/")
+      string.should eql("italic")
+      total += 1
+    end
+    total.should eql(1)
+
+    total = 0
+    borders = %w[* / ~]
+    strings = %w[bold italic verbatim]
+    e.match_all("This string contains *bold*, /italic/, and ~verbatim~ text.")\
+    do |border, str|
+      border.should eql(borders[total])
+      str.should eql(strings[total])
+      total += 1
+    end
+    total.should eql(3)
+  end
+
+  it "should not get confused by links" do
+    e = Orgmode::RegexpHelper.new
+    total = 0
+    # Make sure the slashes in these links aren't treated as italics
+    e.match_all("[[http://www.bing.com/twitter]]") do |border, str|
+      total += 1
+    end
+    total.should eql(0)
+  end
+
+  it "should correctly perform substitutions" do
+    e = Orgmode::RegexpHelper.new
+    map = {
+      "*" => "strong",
+      "/" => "i",
+      "~" => "pre"
+    }
+    n = e.rewrite_emphasis("This string contains *bold*, /italic/, and ~verbatim~ text.") do |border, str|
+      "<#{map[border]}>#{str}</#{map[border]}>"
+    end
+    n.should eql("This string contains <strong>bold</strong>, <i>italic</i>, and <pre>verbatim</pre> text.")
+  end
+
+  it "should allow link rewriting" do
+    e = Orgmode::RegexpHelper.new
+    str = e.rewrite_links("[[http://www.bing.com]]") do |link,text|
+      text ||= link
+      "\"#{text}\":#{link}"
+    end
+    str.should eql("\"http://www.bing.com\":http://www.bing.com")
+  end
+end                             # describe Orgmode::RegexpHelper

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib org-ruby]))
+
+
+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])
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+

data/spec/textile_examples/block_code.org

@@ -0,0 +1,35 @@
+* Block Code
+
+I need to get block code examples working. In =orgmode=, they look
+like this:
+
+#+BEGIN_EXAMPLE
+
+    def initialize(output)
+      @output = output
+      @buffer = ""
+      @output_type = :start
+      @list_indent_stack = []
+      @paragraph_modifier = nil
+
+      @logger = Logger.new(STDERR)
+      @logger.level = Logger::WARN
+    end
+
+#+END_EXAMPLE
+
+And now I should be back to normal text.
+
+Putting in another paragraph for good measure.
+
+
+Code should also get cancelled by a list, thus:
+
+#+BEGIN_EXAMPLE
+This is my code!
+
+Another line!
+#+END_EXAMPLE
+
+- My list should cancel this.
+- Another list line.

data/spec/textile_examples/block_code.textile

@@ -0,0 +1,29 @@
+h1. Block Code
+
+I need to get block code examples working. In @orgmode@, they look like this: 
+
+bc.. 
+    def initialize(output)
+      @output = output
+      @buffer = ""
+      @output_type = :start
+      @list_indent_stack = []
+      @paragraph_modifier = nil
+
+      @logger = Logger.new(STDERR)
+      @logger.level = Logger::WARN
+    end
+
+
+p. And now I should be back to normal text. 
+
+Putting in another paragraph for good measure. 
+
+Code should also get cancelled by a list, thus: 
+
+bc.. This is my code!
+
+Another line!
+
+* My list should cancel this. 
+* Another list line. 

data/spec/textile_examples/blockquote.org

@@ -0,0 +1,13 @@
+BLOCKQUOTE
+
+Testing that I can have block quotes:
+
+#+BEGIN_QUOTE
+
+/Example:/
+
+This is blockquote text.
+
+#+END_QUOTE
+
+And now I'm back to normal text!

data/spec/textile_examples/blockquote.textile

@@ -0,0 +1,11 @@
+BLOCKQUOTE 
+
+Testing that I can have block quotes: 
+
+
+bq. _Example:_ 
+
+bq. This is blockquote text. 
+
+
+And now I'm back to normal text! 

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/keywords.org

@@ -0,0 +1,13 @@
+KEYWORDS
+
+By default, I don't want keywords exported to textile.
+
+* DONE Recognize standard keywords
+  CLOSED: [2009-12-21 Mon 15:23]
+
+  The standard =orgmode= keywords are TODO and DONE. Recognize those.
+
+* TODO Recongize buffer-specific keywords
+
+  There's a way to define a custom keyword list in a buffer. Research
+  that and handle it.

data/spec/textile_examples/keywords.textile

@@ -0,0 +1,11 @@
+KEYWORDS 
+
+By default, I don't want keywords exported to textile. 
+
+h1. Recognize standard keywords
+
+The standard @orgmode@ keywords are TODO and DONE. Recognize those. 
+
+h1. Recongize buffer-specific keywords
+
+There's a way to define a custom keyword list in a buffer. Research that and handle it. 

data/spec/textile_examples/links.org

@@ -0,0 +1,11 @@
+LINKS
+
+[[http://www.bing.com]]
+
+* Supported Link Styles
+
+  - [[http://www.hotmail.com]] => Simple
+  - [[http://www.hotmail.com][Hotmail]] => With link text
+  - [[http://url/with spaces][with spaces]]
+  - [[http://url/with spaces]]
+

data/spec/textile_examples/links.textile

@@ -0,0 +1,10 @@
+LINKS 
+
+"http://www.bing.com":http://www.bing.com 
+
+h1. Supported Link Styles
+
+* "http://www.hotmail.com":http://www.hotmail.com => Simple 
+* "Hotmail":http://www.hotmail.com => With link text 
+* "with spaces":http://url/with%20spaces 
+* "http://url/with spaces":http://url/with%20spaces 

data/spec/textile_examples/lists.org

@@ -0,0 +1,36 @@
+* Lists
+
+I want to make sure I have great support for lists.
+
+- This is an unordered list
+- This continues the unordered list
+
+And this is a paragraph *after* the list.
+
+** Wrapping within the list
+
+   - This is a single-line list item in the org file.
+   - Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
+     nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam
+     erat, sed diam voluptua. At vero eos et accusam et justo duo
+     dolores et ea rebum. Stet clita kasd gubergren, no sea takimata
+     sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit
+     amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor
+     invidunt ut labore et dolore magna aliquyam erat, sed diam
+     voluptua. At vero eos et accusam et justo duo dolores et ea
+     rebum. Stet clita kasd gubergren, no sea takimata sanctus est
+     Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet,
+     consetetur sadipscing elitr, sed diam nonumy eirmod tempor
+     invidunt ut labore et dolore magna aliquyam erat, sed diam
+     voluptua. At vero eos et accusam et justo duo dolores et ea
+     rebum. Stet clita kasd gubergren, no sea takimata sanctus est
+     Lorem ipsum dolor sit amet.
+   - And this is the next item. The previous item needs to be on one
+     line to keep =textile= happy.
+   - Ditto the previous line, actually.
+
+** Edge cases
+
+   - This is a single-line list.
+   And this is a *separate paragraph.* Note the indentation in the org
+   file.