rtf 0.1.0

data/test/DocumentStyleTest.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'test/unit'
+require 'rtf'
+
+include RTF
+
+# Information class unit test class.
+class DocumentStyleTest < Test::Unit::TestCase
+   def test_basics
+      style = DocumentStyle.new
+
+      assert(style.is_character_style? == false)
+      assert(style.is_document_style? == true)
+      assert(style.is_paragraph_style? == false)
+      assert(style.is_table_style? == false)
+
+      assert(style.prefix(nil, nil) == '\paperw11907\paperh16840\margl1800'\
+                                       '\margr1800\margt1440\margb1440')
+      assert(style.suffix(nil, nil) == nil)
+
+      assert(style.bottom_margin == DocumentStyle::DEFAULT_BOTTOM_MARGIN)
+      assert(style.gutter == nil)
+      assert(style.left_margin == DocumentStyle::DEFAULT_LEFT_MARGIN)
+      assert(style.orientation == DocumentStyle::PORTRAIT)
+      assert(style.paper == Paper::A4)
+      assert(style.right_margin == DocumentStyle::DEFAULT_RIGHT_MARGIN)
+      assert(style.top_margin == DocumentStyle::DEFAULT_TOP_MARGIN)
+   end
+
+  def test_mutators
+     style = DocumentStyle.new
+
+     style.bottom_margin = 200
+     assert(style.bottom_margin == 200)
+
+     style.gutter = 1000
+     assert(style.gutter == 1000)
+
+     style.left_margin = 34
+     assert(style.left_margin == 34)
+
+     style.orientation = DocumentStyle::LANDSCAPE
+     assert(style.orientation == DocumentStyle::LANDSCAPE)
+
+     style.paper = Paper::LETTER
+     assert(style.paper == Paper::LETTER)
+
+     style.right_margin = 345
+     assert(style.right_margin == 345)
+
+     style.top_margin = 819
+     assert(style.top_margin == 819)
+  end
+
+  def test_prefix
+     style   = DocumentStyle.new
+
+     style.left_margin = style.right_margin = 200
+     style.top_margin  = style.bottom_margin = 100
+     style.gutter      = 300
+     style.orientation = DocumentStyle::LANDSCAPE
+     style.paper       = Paper::A5
+
+     assert(style.prefix(nil, nil) == '\paperw11907\paperh8392\margl200'\
+                                      '\margr200\margt100\margb100\gutter300'\
+                                      '\sectd\lndscpsxn')
+  end
+
+  def test_body_method
+     style = DocumentStyle.new
+
+     lr_margin = style.left_margin + style.right_margin
+     tb_margin = style.top_margin + style.bottom_margin
+
+     assert(style.body_width == Paper::A4.width - lr_margin)
+     assert(style.body_height == Paper::A4.height - tb_margin)
+
+     style.orientation = DocumentStyle::LANDSCAPE
+
+     assert(style.body_width == Paper::A4.height - lr_margin)
+     assert(style.body_height == Paper::A4.width - tb_margin)
+  end
+end

data/test/DocumentTest.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'test/unit'
+require 'rtf'
+
+include RTF
+
+# Information class unit test class.
+class DocumentTest < Test::Unit::TestCase
+   def setup
+      @fonts = FontTable.new
+
+      @fonts << Font.new(Font::ROMAN, 'Arial')
+      @fonts << Font.new(Font::MODERN, 'Courier')
+   end
+
+   def test_basics
+      documents = []
+      style     = DocumentStyle.new
+
+      documents << Document.new(@fonts[0])
+      documents << Document.new(@fonts[1], style)
+      documents << Document.new(@fonts[0], nil, Document::CS_MAC)
+      documents << Document.new(@fonts[1], style, Document::CS_PC,
+                                Document::LC_ENGLISH_US)
+
+      lr_margin = DocumentStyle::DEFAULT_LEFT_MARGIN +
+                  DocumentStyle::DEFAULT_RIGHT_MARGIN
+      tb_margin = DocumentStyle::DEFAULT_TOP_MARGIN +
+                  DocumentStyle::DEFAULT_BOTTOM_MARGIN
+
+      fonts     = []
+      fonts << FontTable.new(@fonts[0])
+      fonts << FontTable.new(@fonts[1])
+
+      assert(documents[0].character_set == Document::CS_ANSI)
+      assert(documents[1].character_set == Document::CS_ANSI)
+      assert(documents[2].character_set == Document::CS_MAC)
+      assert(documents[3].character_set == Document::CS_PC)
+
+      assert(documents[0].fonts.size == 1)
+      assert(documents[1].fonts.size == 1)
+      assert(documents[2].fonts.size == 1)
+      assert(documents[3].fonts.size == 1)
+
+      assert(documents[0].fonts[0] == @fonts[0])
+      assert(documents[1].fonts[0] == @fonts[1])
+      assert(documents[2].fonts[0] == @fonts[0])
+      assert(documents[3].fonts[0] == @fonts[1])
+
+      assert(documents[0].colours.size == 0)
+      assert(documents[1].colours.size == 0)
+      assert(documents[2].colours.size == 0)
+      assert(documents[3].colours.size == 0)
+
+      assert(documents[0].language == Document::LC_ENGLISH_UK)
+      assert(documents[1].language == Document::LC_ENGLISH_UK)
+      assert(documents[2].language == Document::LC_ENGLISH_UK)
+      assert(documents[3].language == Document::LC_ENGLISH_US)
+
+      assert(documents[0].style != nil)
+      assert(documents[1].style == style)
+      assert(documents[2].style != nil)
+      assert(documents[3].style == style)
+
+      assert(documents[0].body_width == Paper::A4.width - lr_margin)
+      assert(documents[0].body_height == Paper::A4.height - tb_margin)
+      assert(documents[0].default_font == @fonts[0])
+      assert(documents[0].paper == Paper::A4)
+      assert(documents[0].header == nil)
+      assert(documents[0].header(HeaderNode::UNIVERSAL) == nil)
+      assert(documents[0].header(HeaderNode::LEFT_PAGE) == nil)
+      assert(documents[0].header(HeaderNode::RIGHT_PAGE) == nil)
+      assert(documents[0].header(HeaderNode::FIRST_PAGE) == nil)
+      assert(documents[0].footer == nil)
+      assert(documents[0].footer(FooterNode::UNIVERSAL) == nil)
+      assert(documents[0].footer(FooterNode::LEFT_PAGE) == nil)
+      assert(documents[0].footer(FooterNode::RIGHT_PAGE) == nil)
+      assert(documents[0].footer(FooterNode::FIRST_PAGE) == nil)
+   end
+
+   def test_mutators
+      document = Document.new(@fonts[0])
+
+      document.default_font = @fonts[1]
+      assert(document.default_font == @fonts[1])
+
+      document.character_set = Document::CS_PCA
+      assert(document.character_set == Document::CS_PCA)
+
+      document.language = Document::LC_CZECH
+      assert(document.language == Document::LC_CZECH)
+   end
+
+   def test_page_break
+      document = Document.new(@fonts[0])
+
+      assert(document.page_break == nil)
+      assert(document.size == 1)
+      assert(document[0].prefix == '\page')
+   end
+
+   def test_exceptions
+      document = Document.new(@fonts[0])
+      begin
+         document.parent = document
+         flunk("Successfully change the parent of a Document object.")
+      rescue
+      end
+   end
+end

data/test/FontTableTest.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'rtf'
+
+include RTF
+
+# FontTable class unit test class.
+class FontTableTest < Test::Unit::TestCase
+   def setup
+      @fonts = []
+      @fonts.push(Font.new(Font::MODERN, "Courier New"))
+      @fonts.push(Font.new(Font::ROMAN, "Arial"))
+      @fonts.push(Font.new(Font::SWISS, "Tahoma"))
+      @fonts.push(Font.new(Font::NIL, "La La La"))
+   end
+
+   def test_01
+      tables = []
+      tables.push(FontTable.new)
+      tables.push(FontTable.new(@fonts[0], @fonts[2]))
+      tables.push(FontTable.new(*@fonts))
+      tables.push(FontTable.new(@fonts[0], @fonts[2], @fonts[0]))
+
+      assert(tables[0].size == 0)
+      assert(tables[1].size == 2)
+      assert(tables[2].size == 4)
+      assert(tables[3].size == 2)
+
+      assert(tables[0][2] == nil)
+      assert(tables[1][1] == @fonts[2])
+      assert(tables[2][3] == @fonts[3])
+      assert(tables[3][2] == nil)
+
+      assert(tables[0].index(@fonts[0]) == nil)
+      assert(tables[1].index(@fonts[2]) == 1)
+      assert(tables[2].index(@fonts[2]) == 2)
+      assert(tables[3].index(@fonts[1]) == nil)
+
+      tables[0].add(@fonts[0])
+      assert(tables[0].size == 1)
+      assert(tables[0].index(@fonts[0]) == 0)
+
+      tables[0] << @fonts[1]
+      assert(tables[0].size == 2)
+      assert(tables[0].index(@fonts[1]) == 1)
+
+      tables[0].add(@fonts[0])
+      assert(tables[0].size == 2)
+      assert([tables[0][0], tables[0][1]] == [@fonts[0], @fonts[1]])
+
+      tables[0] << @fonts[1]
+      assert(tables[0].size == 2)
+      assert([tables[0][0], tables[0][1]] == [@fonts[0], @fonts[1]])
+
+      flags = [false, false, false, false]
+      tables[2].each do |font|
+         flags[@fonts.index(font)] = true if @fonts.index(font) != nil
+      end
+      assert(flags.index(false) == nil)
+
+      assert(tables[0].to_s == "Font Table (2 fonts)\n"\
+                               "   Family: modern, Name: Courier New\n"\
+                               "   Family: roman, Name: Arial")
+      assert(tables[1].to_s(6) == "      Font Table (2 fonts)\n"\
+                                  "         Family: modern, Name: Courier New\n"\
+                                  "         Family: swiss, Name: Tahoma")
+      assert(tables[2].to_s(3) == "   Font Table (4 fonts)\n"\
+                                  "      Family: modern, Name: Courier New\n"\
+                                  "      Family: roman, Name: Arial\n"\
+                                  "      Family: swiss, Name: Tahoma\n"\
+                                  "      Family: nil, Name: La La La")
+      assert(tables[3].to_s(-10) == "Font Table (2 fonts)\n"\
+                                    "   Family: modern, Name: Courier New\n"\
+                                    "   Family: swiss, Name: Tahoma")
+
+      assert(tables[0].to_rtf == "{\\fonttbl\n"\
+                                 "{\\f0\\fmodern Courier New;}\n"\
+                                 "{\\f1\\froman Arial;}\n"\
+                                 "}")
+      assert(tables[1].to_rtf(4) == "    {\\fonttbl\n"\
+                                    "    {\\f0\\fmodern Courier New;}\n"\
+                                    "    {\\f1\\fswiss Tahoma;}\n"\
+                                    "    }")
+      assert(tables[2].to_rtf(2) == "  {\\fonttbl\n"\
+                                    "  {\\f0\\fmodern Courier New;}\n"\
+                                    "  {\\f1\\froman Arial;}\n"\
+                                    "  {\\f2\\fswiss Tahoma;}\n"\
+                                    "  {\\f3\\fnil La La La;}\n"\
+                                    "  }")
+      assert(tables[3].to_rtf(-6) == "{\\fonttbl\n"\
+                                     "{\\f0\\fmodern Courier New;}\n"\
+                                     "{\\f1\\fswiss Tahoma;}\n"\
+                                     "}")
+   end
+end

data/test/FontTest.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'rtf'
+
+include RTF
+
+# Font class unit test class.
+class FontTest < Test::Unit::TestCase
+   def test_01
+      fonts = []
+      fonts.push(Font.new(Font::MODERN, "Courier New"))
+      fonts.push(Font.new(Font::ROMAN, "Arial"))
+      fonts.push(Font.new(Font::SWISS, "Tahoma"))
+      fonts.push(Font.new(Font::NIL, "La La La"))
+
+      assert(fonts[0] == fonts[0])
+      assert(!(fonts[0] == fonts[1]))
+      assert(!(fonts[1] == 'a string of text'))
+      assert(fonts[2] == Font.new(Font::SWISS, "Tahoma"))
+
+      assert(fonts[0].family == Font::MODERN)
+      assert(fonts[1].family == Font::ROMAN)
+      assert(fonts[2].family == Font::SWISS)
+      assert(fonts[3].family == Font::NIL)
+
+      assert(fonts[0].name == 'Courier New')
+      assert(fonts[1].name == 'Arial')
+      assert(fonts[2].name == 'Tahoma')
+      assert(fonts[3].name == 'La La La')
+
+      assert(fonts[0].to_s == 'Family: modern, Name: Courier New')
+      assert(fonts[1].to_s(3) == '   Family: roman, Name: Arial')
+      assert(fonts[2].to_s(6) == '      Family: swiss, Name: Tahoma')
+      assert(fonts[3].to_s(-1) == 'Family: nil, Name: La La La')
+
+      assert(fonts[0].to_rtf == '\fmodern Courier New;')
+      assert(fonts[1].to_rtf(2) == '  \froman Arial;')
+      assert(fonts[2].to_rtf(4) == '    \fswiss Tahoma;')
+      assert(fonts[3].to_rtf(-6) == '\fnil La La La;')
+
+      begin
+         Font.new(12345, "Ningy")
+         flunk("Created a Font object with an invalid family setting.")
+      rescue RTFError
+      rescue Test::Unit::AssertionFailedError => error
+         raise error
+      rescue => error
+         flunk("Unexpected exception caught checking font creation with "\
+               "an invalid family. Exception type #{error.class.name}.")
+      end
+   end
+end

data/test/FooterNodeTest.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'test/unit'
+require 'rtf'
+
+include RTF
+
+# Information class unit test class.
+class FooterNodeTest < Test::Unit::TestCase
+   def setup
+      @document = Document.new(Font.new(Font::ROMAN, 'Arial'))
+   end
+
+   def test_basics
+      footers = []
+
+      footers << FooterNode.new(@document)
+      footers << FooterNode.new(@document, FooterNode::LEFT_PAGE)
+
+      assert(footers[0].parent == @document)
+      assert(footers[1].parent == @document)
+
+      assert(footers[0].type == FooterNode::UNIVERSAL)
+      assert(footers[1].type == FooterNode::LEFT_PAGE)
+   end
+
+   def test_exceptions
+      footer = FooterNode.new(@document)
+      begin
+         footer.footnote("La la la.")
+         flunk("Successfully added a footnote to a footer.")
+      rescue
+      end
+   end
+end

data/test/HeaderNodeTest.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'test/unit'
+require 'rtf'
+
+include RTF
+
+# Information class unit test class.
+class HeaderNodeTest < Test::Unit::TestCase
+   def setup
+      @document = Document.new(Font.new(Font::ROMAN, 'Arial'))
+   end
+
+   def test_basics
+      headers = []
+
+      headers << HeaderNode.new(@document)
+      headers << HeaderNode.new(@document, HeaderNode::LEFT_PAGE)
+
+      assert(headers[0].parent == @document)
+      assert(headers[1].parent == @document)
+
+      assert(headers[0].type == HeaderNode::UNIVERSAL)
+      assert(headers[1].type == HeaderNode::LEFT_PAGE)
+   end
+
+   def test_exceptions
+      headers = HeaderNode.new(@document)
+      begin
+         headers.footnote("La la la.")
+         flunk("Successfully added a footnote to a header.")
+      rescue
+      end
+   end
+end

data/test/InformationTest.rb

@@ -0,0 +1,133 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'rtf'
+require 'stringio'
+
+include RTF
+
+# Information class unit test class.
+class InformationTest < Test::Unit::TestCase
+   def test_01
+      date = Time.local(1985, 6, 22, 14, 33, 22)
+      info = []
+      info.push(Information.new)
+      info.push(Information.new('Title 1'))
+      info.push(Information.new('Title 2', 'Peter Wood'))
+      info.push(Information.new('La la la', '', 'Nowhere Ltd.'))
+      info.push(Information.new('', 'N. O. Body', 'Oobly', 'Joobly'))
+      info.push(Information.new('Title 5', 'J. Bloggs', '', '', date))
+      info.push(Information.new('Title 6', 'J. Bloggs', '', '', '1985-06-22 14:33:22 GMT'))
+
+      assert(info[0].title == nil)
+      assert(info[0].author == nil)
+      assert(info[0].company == nil)
+      assert(info[0].comments == nil)
+
+      assert(info[1].title == 'Title 1')
+      assert(info[1].author == nil)
+      assert(info[1].company == nil)
+      assert(info[1].comments == nil)
+
+      assert(info[2].title == 'Title 2')
+      assert(info[2].author == 'Peter Wood')
+      assert(info[2].company == nil)
+      assert(info[2].comments == nil)
+
+      assert(info[3].title == 'La la la')
+      assert(info[3].author == '')
+      assert(info[3].company == 'Nowhere Ltd.')
+      assert(info[3].comments == nil)
+
+      assert(info[4].title == '')
+      assert(info[4].author == 'N. O. Body')
+      assert(info[4].company == 'Oobly')
+      assert(info[4].comments == 'Joobly')
+
+      assert(info[5].title == 'Title 5')
+      assert(info[5].author == 'J. Bloggs')
+      assert(info[5].company == '')
+      assert(info[5].comments == '')
+      assert(info[5].created == date)
+
+      assert(info[6].title == 'Title 6')
+      assert(info[6].author == 'J. Bloggs')
+      assert(info[6].company == '')
+      assert(info[6].comments == '')
+      assert(info[6].created == date)
+
+      info[6].title = 'Alternative Title'
+      assert(info[6].title == 'Alternative Title')
+
+      info[6].author = 'A. Person'
+      assert(info[6].author == 'A. Person')
+
+      info[6].company = nil
+      assert(info[6].company == nil)
+
+      info[6].comments = 'New information comment text.'
+      assert(info[6].comments == 'New information comment text.')
+
+      date = Time.new
+      info[6].created = date
+      assert(info[6].created == date)
+
+      date = Time.local(1985, 6, 22, 14, 33, 22)
+      info[6].created = '1985-06-22 14:33:22 GMT'
+      assert(info[6].created == date)
+
+      assert(info[0].to_s(2) == "  Information\n     Created:  "\
+                                "#{info[0].created}")
+      assert(info[1].to_s(4) == "    Information\n       Title:    Title 1\n"\
+                                "       Created:  #{info[1].created}")
+      assert(info[2].to_s(-10) == "Information\n   Title:    Title 2\n   "\
+                                  "Author:   Peter Wood\n   Created:  "\
+                                  "#{info[2].created}")
+      assert(info[3].to_s == "Information\n   Title:    La la la\n   "\
+                             "Author:   \n   Company:  Nowhere Ltd.\n   "\
+                             "Created:  #{info[3].created}")
+      assert(info[4].to_s == "Information\n   Title:    \n   Author:   "\
+                             "N. O. Body\n   Company:  Oobly\n   Comments: "\
+                             "Joobly\n   Created:  #{info[4].created}")
+      assert(info[5].to_s == "Information\n   Title:    Title 5\n   Author:   "\
+                             "J. Bloggs\n   Company:  \n   Comments: \n   "\
+                             "Created:  #{date}")
+      assert(info[6].to_s == "Information\n   Title:    Alternative Title"\
+                             "\n   Author:   A. Person\n   Comments: New "\
+                             "information comment text.\n   Created:  #{date}")
+
+      assert(info[0].to_rtf(3) == "   {\\info\n   #{to_rtf(info[0].created)}"\
+                                  "\n   }")
+      assert(info[1].to_rtf(6) == "      {\\info\n      {\\title Title 1}\n"\
+                                  "      #{to_rtf(info[1].created)}\n      }")
+      assert(info[2].to_rtf(-5) == "{\\info\n{\\title Title 2}\n"\
+                                   "{\\author Peter Wood}\n"\
+                                   "#{to_rtf(info[2].created)}\n}")
+      assert(info[3].to_rtf == "{\\info\n{\\title La la la}\n"\
+                               "{\\author }\n"\
+                               "{\\company Nowhere Ltd.}\n"\
+                               "#{to_rtf(info[3].created)}\n}")
+      assert(info[4].to_rtf == "{\\info\n{\\title }\n"\
+                               "{\\author N. O. Body}\n"\
+                               "{\\company Oobly}\n"\
+                               "{\\doccomm Joobly}\n"\
+                               "#{to_rtf(info[4].created)}\n}")
+      assert(info[5].to_rtf(3) == "   {\\info\n   {\\title Title 5}\n"\
+                                  "   {\\author J. Bloggs}\n"\
+                                  "   {\\company }\n"\
+                                  "   {\\doccomm }\n"\
+                                  "   #{to_rtf(date)}\n   }")
+      assert(info[6].to_rtf == "{\\info\n{\\title Alternative Title}\n"\
+                               "{\\author A. Person}\n"\
+                               "{\\doccomm New information comment text.}\n"\
+                               "#{to_rtf(date)}\n}")
+   end
+
+   def to_rtf(time)
+      text = StringIO.new
+      text << "{\\createim\\yr#{time.year}"
+      text << "\\mo#{time.month}\\dy#{time.day}"
+      text << "\\hr#{time.hour}\\min#{time.min}}"
+      text.string
+   end
+end