clbustos-rtf 0.3.0 → 0.3.1

data/CHANGES

@@ -1,5 +1,8 @@
 == CHANGES
 
+0.3.1
+  * Added the #subscript helper to the CommandNode class [vjt]
+
 0.3.0
   * Resolve problems on Ruby 1.9.1 with ImageNode#read_source. Peter uses IO#getc, which returns a String on Ruby 1.9.1, not a Integer, so I replaced with getbyte. [clbustos]
   * Deleted duplicated definition of ImageNode#style= with attr_writer and def. [clbustos]

data/{README → README.rdoc}

@@ -58,8 +58,6 @@ you are already familiar with the Ruby language. So, for a start, consider...
    require 'rubygems'
    require 'rtf'
 
-   include RTF
-
 The first thing to look at here at the are the first two lines. The RTF library
 is provided as a Ruby gem and these two lines load the libraries functionality
 into the script. The third line of code includes the RTF module into the current
@@ -67,7 +65,7 @@ name space. This is a convenience mechanism that saves on specifically having
 to refer to the module when accessing the RTF library. Next we want to create
 an RTF document and that is done like this...
 
-   document = Document.new(Font.new(Font::ROMAN, 'Times New Roman'))
+   document = RTF::Document.new(RTF::Font::ROMAN)
 
 This line of code creates a new Document object, specifying that the default
 font for the document will the the Times New Roman font. So we have a document,
@@ -93,74 +91,69 @@ some code into the document. We want the code to appear in the document slightly
 indented on the left hand side, in a non-proportionately space font and we want
 it in bold text. Heres the code that shows how to do that...
 
-   01 styles = {}
-   02 styles['PS_CODE'] = ParagraphStyle.new
-   03 styles['CS_CODE'] = CharacterStyle.new
-   04
-   05 styles['PS_CODE'].left_indent = 200
-   06 styles['CS_CODE'].font        = Font.new(Font::MODERN, 'Courier')
-   07 styles['CS_CODE'].bold        = true
-   08
-   09 document.paragraph(styles['PS_CODE']) do |n1|
-   10    n1.apply(styles['CS_CODE']) do |n2|
-   11       n2 << "count = 0"
-   12       n2.line_break
-   13       n2 << "File.open('file.txt', 'r') do |file|"
-   14       n2.line_break
-   15       n2 << "   file.each_line {|line| count += 1}"
-   16       n2.line_break
-   17       n2 << "end"
-   18       n2.line_break
-   19       n2 << "puts \"File contains \#{count} lines.\""
-   20    end
-   21 end
+   01 code_para = ParagraphStyle.new
+   02 code_para.left_indent = 200
+   03
+   04 code_char = CharacterStyle.new
+   05 code_char.font = RTF::Font::MODERN
+   06 code_char.bold = true
+   07
+   08 document.paragraph(code_para) do |p|
+   09   p.apply(code_char) do |c|
+   10     c << "count = 0"
+   11     c.line_break
+   12     c << "File.open('file.txt', 'r') do |file|"
+   13     c.line_break
+   14     c << "   file.each_line {|line| count += 1}"
+   15     c.line_break
+   16     c << "end"
+   17     c.line_break
+   18     c << "puts \"File contains \#{count} lines.\""
+   19   end
+   20 end
 
 This is a much larger piece of code and covers a number of topics that need to
 be addressed. I have included line numbers with code so that individual elements
-can be referenced. Lines 1 to 3 are the first new elements. Here we create a
-Hash and assign it to a variable called styles. On the next two lines we create
+can be referenced. Lines 1 to 6 are the first new elements. Here we create
 two style objects, one that can be applied to paragraphs and one that applies
 to characters.
 
-On lines 5 to 7 we update settings on the style objects we've created. We set
-the left indentation value of the paragraph style to 200. The 200 in this case
-refers to a measurement of twips. A twip is a type setting measurement that
-equates to one twentieth of a point (about a fifty seventh of a millimetre or
-one seventy second of an inch). This is the measurement scale used by RTF
-documents so it is also employed in the library.
+On line 2 we set the left indentation value of the paragraph style to 200 *twips*.
+A twip is a type setting measurement that equates to one twentieth of a point
+(about a fifty seventh of a millimetre or one seventy second of an inch). This is
+the measurement scale used by RTF documents.
+
+On lines 5 and 6 we update the character style to use a courier font and to
+apply bold styling to the text.
 
-On lines 6 and 7 we update the character style to use a courier font and to
-apply bold styling to the text. On line 9 we start a new paragraph in our
-document. This differs from our previous use of this method in that we specify
-a style that will be applied to the paragraph created, the paragraph style we
-had prepared earlier.
+On line 8 we start a new paragraph in our document. This differs from our previous
+use of this method in that we specify a style that will be applied to the paragraph
+using the one we prepared earlier.
 
 The block accompanying the paragraph method takes the single parameter that we
 have seen previously. At this point its probably a good idea to point out that
 the elements that make up an RTF document created with the library are all
-stored as nodes in a tree. We've named the one passed to the paragraph method as
-n1 to reflect this.
+stored as nodes in a tree.
+
+Within the block, the +apply+ method applies a character style, and we're using
+the one we prepared earlier.
 
-Within the block we've called a method on the paragraph node called apply. This
-method applies a character style and we're using the one we prepared earlier.
 Like the call to the paragraph method, the apply method is passed a block. All
-text added to the blocks node (n2 in this case) will have the styling we've
-defined (bold courier font) applied to it.
+text added to the blocks node will have the styling we've defined (bold courier
+font) applied to it.
 
-Note, that within the apply block we could still use the n1 node. Any text we
-added to this would appear in the paragraph but wouldn't be styled and, it
-should be noted, will appear before any text added to n2 (as the n2 node only
-becomes part of the document when the apply block completes).
+Note, that within the apply block we could still use the previous (p) node. Any
+text we added to this would appear in the paragraph but wouldn't be styled and,
+it should be noted, will appear before any text added to c, as the c node only
+becomes part of the document when the apply block completes.
 
-Within the apply method block we add some lines of text to the n2 node. Note
+Within the apply method block we add some lines of text to the c node. Note
 that, as this is all encompassed within the parapgraph block, all the text is
 part of a single paragraph. To get each of the lines of code to appear on a
 line of their own we have used the line_break method which inserts a carriage
 return into the document. Note you should use this method to insert line breaks
 rather than trying to add a string containing "\n". RTF is a text based standard
-and won't treat "\n" as you're expecting. You should note also that we've had to
-escape the '#' in one of the code lines to stop Ruby considering it as an
-interpolated value.
+and won't treat "\n" as you're expecting.
 
 Okay, so we've seen have the basics of creating a document and adding elements
 to that document. How do we get what we've created to a file. Well thats
@@ -183,4 +176,4 @@ Chris O'Sullivan
 COPYRIGHT
 =========
 
-Copyright (c) 2009-2010 Peter Wood. See LICENSE for details.
+Copyright (c) 2009-2010 Peter Wood. See LICENSE for details.

data/Rakefile

@@ -1,3 +1,4 @@
+$:.unshift(File.dirname(__FILE__))
 require 'rake'
 
 begin

data/VERSION.yml

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

data/lib/rtf/node.rb

@@ -6,14 +6,10 @@ module RTF
    # This class represents an element within an RTF document. The class provides
    # a base class for more specific node types.
    class Node
-      # Attribute accessor.
-      attr_reader :parent
-
-      # Attribute mutator.
-      attr_writer :parent
-
-
-      # This is the constructor for the Node class.
+      # Node parent.
+      attr_accessor :parent
+      
+      # Constructor for the Node class.
       #
       # ==== Parameters
       # parent::  A reference to the Node that owns the new Node. May be nil
@@ -118,7 +114,13 @@ module RTF
       # This method generates the RTF equivalent for a TextNode object. This
       # method escapes any special sequences that appear in the text.
       def to_rtf
-         @text == nil ? '' : @text.gsub("{", "\\{").gsub("}", "\\}").gsub("\\", "\\\\")
+        rtf=(@text == nil ? '' : @text.gsub("{", "\\{").gsub("}", "\\}").gsub("\\", "\\\\"))
+        # Encode as Unicode.
+        if RUBY_VERSION>"1.9.0"
+          rtf.encode("UTF-16LE").each_codepoint.map {|cp|
+            cp < 128 ? cp.chr : "\\u#{cp}\\'3f"
+          }.join("")
+        end
       end
    end # End of the TextNode class.
 
@@ -392,6 +394,21 @@ module RTF
          end
       end
 
+      # This method provides a short cut means of creating a subscript command
+      # node. The method accepts a block that will be passed a single parameter
+      # which will be a reference to the subscript node created. After the
+      # block is complete the subscript node is appended to the end of the
+      # child nodes on the object that the method is call against.
+      def subscript
+         style           = CharacterStyle.new
+         style.subscript = true
+         if block_given?
+            apply(style) {|node| yield node}
+         else
+            apply(style)
+         end
+      end
+
       # This method provides a short cut means of creating a superscript command
       # node. The method accepts a block that will be passed a single parameter
       # which will be a reference to the superscript node created. After the
@@ -407,6 +424,21 @@ module RTF
          end
       end
 
+      # This method provides a short cut means of creating a strike command
+      # node. The method accepts a block that will be passed a single parameter
+      # which will be a reference to the strike node created. After the
+      # block is complete the strike node is appended to the end of the
+      # child nodes on the object that the method is call against.
+      def strike
+         style        = CharacterStyle.new
+         style.strike = true
+         if block_given?
+            apply(style) {|node| yield node}
+         else
+            apply(style)
+         end
+      end
+
       # This method provides a short cut means of creating a font command node.
       # The method accepts a block that will be passed a single parameter which
       # will be a reference to the font node created. After the block is
@@ -1660,4 +1692,4 @@ module RTF
          text.string
       end
    end # End of the Document class.
-end # End of the RTF module.
+end # End of the RTF module.

data/test/command_node_test.rb

@@ -156,6 +156,16 @@ class CommandNodeTest < Test::Unit::TestCase
       assert(node.prefix == '\super')
       assert(node.suffix == nil)
       assert(node == root[-1])
+
+      node = root.subscript
+      assert(node.prefix == '\sub')
+      assert(node.suffix == nil)
+      assert(node == root[-1])
+
+      node = root.strike
+      assert(node.prefix == '\strike')
+      assert(node.suffix == nil)
+      assert(node == root[-1])
    end
 
    # Test text node addition.

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Peter Wood
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-03 00:00:00 -04:00
+date: 2010-09-14 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -26,11 +26,11 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README
+- README.rdoc
 files: 
 - CHANGES
 - LICENSE
-- README
+- README.rdoc
 - Rakefile
 - VERSION.yml
 - examples/example01.rb
@@ -106,28 +106,28 @@ signing_key:
 specification_version: 3
 summary: Ruby library to create rich text format documents.
 test_files: 
-- test/table_row_node_test.rb
-- test/font_table_test.rb
+- test/node_test.rb
+- test/information_test.rb
+- test/container_node_test.rb
+- test/table_cell_node_test.rb
+- test/character_style_test.rb
 - test/paragraph_style_test.rb
-- test/document_style_test.rb
 - test/font_test.rb
-- test/header_node_test.rb
-- test/node_test.rb
-- test/colour_table_test.rb
-- test/test_helper.rb
 - test/document_test.rb
-- test/footer_node_test.rb
-- test/command_node_test.rb
 - test/style_test.rb
-- test/character_style_test.rb
+- test/font_table_test.rb
 - test/text_node_test.rb
+- test/table_node_test.rb
+- test/colour_table_test.rb
 - test/image_node_test.rb
+- test/document_style_test.rb
+- test/test_helper.rb
+- test/footer_node_test.rb
+- test/table_row_node_test.rb
 - test/colour_test.rb
-- test/container_node_test.rb
-- test/information_test.rb
-- test/table_node_test.rb
-- test/table_cell_node_test.rb
-- examples/example02.rb
+- test/header_node_test.rb
+- test/command_node_test.rb
 - examples/example01.rb
+- examples/example02.rb
 - examples/example03.rb
 - examples/example04.rb