rrtf 1.0.0 → 1.3.1

data/documentation/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Jul 31 21:48:57 2017 by
+  Generated on Wed Aug  2 23:05:14 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.3).
 </div>

data/examples/08.rtf

@@ -7,11 +7,11 @@
 \red255\green0\blue0;
 }
 {\info
-{\createim\yr2017\mo7\dy30\hr23\min44}
+{\createim\yr2017\mo8\dy1\hr11\min6}
 }
 
 \hyphauto1\paperw12247\paperh15819\margl1440\margr1440\margt1440\margb1440
-{\pict \box\brdrdot\brdrw100\brsp240\brdrcf1\picwgoal2880\pichgoal2880\picw500\pich500\bliptag3007171\pngblip
+{\pict \box\brdrdot\brdrw100\brsp240\brdrcf1\picwgoal2880\pichgoal2880\picw500\pich500\bliptag0108171\pngblip
 89504e470d0a1a0a0000000d49484452000001f4000001f40806000000cbd6df8a00000009704859
 73000016250000162501495224f00000200049444154785eec5d077c5455f6fe26939e50549a2288
 8282aeae2b56545ceb2a8a34459705114511e952a45705040ba0880a289d208a8a7f51b161050545

data/examples/09.rtf

@@ -7,7 +7,7 @@
 \red255\green255\blue255;
 }
 {\info
-{\createim\yr2017\mo7\dy31\hr20\min2}
+{\createim\yr2017\mo8\dy1\hr11\min8}
 }
 
 \hyphauto1\paperw12247\paperh15819\margl1440\margr1440\margt1440\margb1440
@@ -22,10 +22,6 @@
 {\sp{\sn fFilled}{\sv 1}}
 {\sp{\sn fillColor}{\sv 13421772}}
 {\sp{\sn fLine}{\sv 0}}
-{\sp{\sn geoLeft}{\sv 0}}
-{\sp{\sn geoTop}{\sv 0}}
-{\sp{\sn geoRight}{\sv 30000}}
-{\sp{\sn geoBottom}{\sv 30000}}
 {\sp{\sn fLineOK}{\sv 1}}
 {\sp{\sn fFillOK}{\sv 1}}
 {\sp{\sn f3DOK}{\sv 1}}
@@ -43,10 +39,10 @@
 {\sp{\sn fLine}{\sv 1}}
 {\sp{\sn lineColor}{\sv 0}}
 {\sp{\sn lineWidth}{\sv 38100}}
-{\sp{\sn geoLeft}{\sv 0}}
-{\sp{\sn geoTop}{\sv 0}}
-{\sp{\sn geoRight}{\sv 30000}}
-{\sp{\sn geoBottom}{\sv 30000}}
+{\sp{\sn dxTextLeft}{\sv 457200}}
+{\sp{\sn dxTextRight}{\sv 457200}}
+{\sp{\sn dyTextTop}{\sv 457200}}
+{\sp{\sn dyTextBottom}{\sv 457200}}
 {\sp{\sn fLineOK}{\sv 1}}
 {\sp{\sn fFillOK}{\sv 1}}
 {\sp{\sn f3DOK}{\sv 1}}
@@ -72,11 +68,11 @@ red
 {\sp{\sn lineColor}{\sv 10027008}}
 {\sp{\sn geoLeft}{\sv 0}}
 {\sp{\sn geoTop}{\sv 0}}
-{\sp{\sn geoRight}{\sv 30000}}
-{\sp{\sn geoBottom}{\sv 30000}}
-{\sp{\sn pVerticies}{\sv 8;6;(0,0);(20000,0);(30000,0);(30000,15000);(30000,30000);(0,0)}}
+{\sp{\sn geoRight}{\sv 21600}}
+{\sp{\sn geoBottom}{\sv 21600}}
+{\sp{\sn pVerticies}{\sv 8;6;(0,0);(14400,0);(21600,0);(21600,10800);(21600,21600);(0,0)}}
 {\sp{\sn pSegmentInfo}{\sv 2;6;16384;1;8193;1;24577;32768}}
-{\sp{\sn pConnectionSites}{\sv 8;4;(0,0);(20000,0);(30000,30000);(0,0)}}
+{\sp{\sn pConnectionSites}{\sv 8;4;(0,0);(14400,0);(21600,21600);(0,0)}}
 {\sp{\sn fLineOK}{\sv 1}}
 {\sp{\sn fFillOK}{\sv 1}}
 {\sp{\sn f3DOK}{\sv 1}}

data/examples/09_shapes.rb

@@ -23,7 +23,8 @@ rtf.geometry(
   "width" => "3in",
   "height" => "3in",
   "horizontal_reference" => "PAGE",
-  "vertical_reference" => "PAGE"
+  "vertical_reference" => "PAGE",
+  "text_margin" => "0.5in"
 ) do |box|
   box.paragraph("foreground_color" => '#ffffff') do |p|
     p << "Should you ever find yourself on a spacefaring vessel wearing a "

data/examples/11.rtf

@@ -0,0 +1,19 @@
+{\rtf1\ansi\deff0\deflang1033\plain\fs24\fet1
+{\fonttbl
+{\f0\fswiss Helvetica;}
+}
+{\info
+{\createim\yr2017\mo8\dy2\hr22\min31}
+}
+
+\hyphauto1\paperw12247\paperh15819\margl1440\margr1440\margt1440\margb1440
+{\pard\ql\ltrpar\rqr\tldot\tx2880
+Engineers
+{\tab}
+10
+{\line}
+Redshirts
+{\tab}
+100
+\par}
+}

data/examples/11_sections.rb

@@ -0,0 +1,11 @@
+require 'rrtf'
+
+DIR = File.dirname(__FILE__)
+
+rtf = RRTF::Document.new
+
+rtf.paragraph << "Redshirt Pocket Guide"
+rtf.section("columns" => 2)
+rtf.paragraph << "Section Text"
+
+File.open(DIR+'/11.rtf', 'w') { |file| file.write(rtf.to_rtf) }

data/examples/12.rtf

@@ -0,0 +1,19 @@
+{\rtf1\ansi\deff0\deflang1033\plain\fs24\fet1
+{\fonttbl
+{\f0\fswiss Helvetica;}
+}
+{\info
+{\createim\yr2017\mo8\dy2\hr22\min32}
+}
+
+\hyphauto1\paperw12247\paperh15819\margl1440\margr1440\margt1440\margb1440
+{\pard\ql\ltrpar\rqr\tldot\tx2880
+Engineers
+{\tab}
+10
+{\line}
+Redshirts
+{\tab}
+100
+\par}
+}

data/examples/12_tabs.rb

@@ -0,0 +1,21 @@
+require 'rrtf'
+
+DIR = File.dirname(__FILE__)
+
+rtf = RRTF::Document.new
+
+rtf.paragraph("tabs" => {
+    "leader" => "DOT",
+    "type" => "FLUSH_RIGHT",
+    "position" => "2in"
+}) do |p|
+  p << "Engineers"
+  p.tab
+  p << "10"
+  p.line_break
+  p << "Redshirts"
+  p.tab
+  p << "100"
+end
+
+File.open(DIR+'/12.rtf', 'w') { |file| file.write(rtf.to_rtf) }

data/lib/rrtf/formatting.rb

@@ -332,6 +332,33 @@ module RRTF::ParagraphFormatting
         end # case
       end,
       "to_rtf" => lambda{ |value, document| value.rtf_formatting(document) unless value.nil? }
+    },
+    "tabs" => {
+      "default" => nil,
+      "from_user" => lambda do |value|
+        case value
+        when Array
+          value.collect do |t|
+            case t
+            when Hash
+              RRTF::TabStyle.new(t)
+            when RRTF::TabStyle
+              t
+            else
+              RRTF::RTFError.fire("Invalid tab '#{t}'.")
+            end # case
+          end # collect
+        when Hash
+          [RRTF::TabStyle.new(value)]
+        when RRTF::TabStyle
+          [value]
+        else
+          RRTF::RTFError.fire("Invalid border '#{value}'.")
+        end # case
+      end,
+      "to_rtf" => lambda do |value, document|
+        value.collect{ |tab| tab.rtf_formatting }.join(' ') unless value.nil?
+      end
     }
   }.freeze
 
@@ -872,6 +899,91 @@ module RRTF::DocumentFormatting
   end
 end # module DocumentFormatting
 
+# Section formatting attributes and methods.
+# @author Wesley Hileman
+# @since 1.0.0
+module RRTF::SectionFormatting
+  # Formatting attributes that can be applied to an RTF document section.
+  # @return [Hash<String, Hash>] a hash mapping each attribute to a hash that
+  #  describes (1) the attribute's default value, (2) how to parse the attribute
+  #  from the user, and (3) how to convert the attribute to an RTF sequence.
+  SECTION_ATTRIBUTES = {
+    "columns" => {
+      "default" => nil,
+      "to_rtf" => lambda{ |value| "\\cols#{value}" unless value.nil? }
+    },
+    "column_spacing" => {
+      "default" => nil,
+      "from_user" => lambda{ |value| RRTF::Utilities.value2twips(value) },
+      "to_rtf" => lambda{ |value| "\\colsx#{value}" unless value.nil? }
+    },
+    "mirror_margins" => {
+      "default" => nil,
+      "to_rtf" => lambda{ |value| "\\margmirrorsxn" if value }
+    }
+  }.freeze
+
+  # Generates attribute accessors for all section attributes when the module
+  # is included in another module or class.
+  def self.included(base)
+    # define accessors in base for document attributes
+    base.class_eval do
+      SECTION_ATTRIBUTES.each do |key, options|
+        attr_accessor :"#{key}"
+      end # each
+    end # class_eval
+  end
+
+  # Initializes section formatting attributes.
+  #
+  # @param [Hash] options the section formatting options.
+  # @option options [Integer] "columns" (nil) the number of columns in the section.
+  # @option options [String, Integer] "column_spacing" (nil) the column spacing in twips (can also be a string, see {Utilities.value2twips}).
+  # @option options [Boolean] "mirror_margins" (nil) whether or not to enable mirrored margins (when facing pages is enabled) in the document.
+  def initialize_section_formatting(options = {})
+    # load default attribute values
+    SECTION_ATTRIBUTES.each do |key, options|
+      send("#{key}=", options["default"])
+    end # each
+    # overwrite default attribute values with given values
+    set_section_formatting_from_hashmap(options)
+  end
+
+  # Sets section formatting attributes according to the supplied hashmap.
+  # @see #initialize_section_formatting
+  def set_section_formatting_from_hashmap(hash)
+    hash.each do |attribute, value|
+      # skip unreconized attributes
+      next unless(SECTION_ATTRIBUTES.keys.include?(attribute))
+      # preprocess value if nessesary
+      if SECTION_ATTRIBUTES[attribute].has_key?("from_user")
+        value = SECTION_ATTRIBUTES[attribute]["from_user"].call(value)
+      elsif SECTION_ATTRIBUTES[attribute].has_key?("dictionary") && value.is_a?(String)
+        value = SECTION_ATTRIBUTES[attribute]["dictionary"][value]
+      end # if
+      # set attribute value
+      send("#{attribute}=", value)
+    end # each
+  end
+
+  # Generates an RTF string representing all applied section formatting.
+  #
+  # @return [String] RTF string.
+  def section_formatting_to_rtf
+    text = StringIO.new
+
+    # accumulate RTF representations of section attributes
+    SECTION_ATTRIBUTES.each do |key, options|
+      if options.has_key?("to_rtf")
+        rtf = options["to_rtf"].call(send(key))
+        text << rtf unless rtf.nil?
+      end # if
+    end # each
+
+    text.string
+  end
+end # module SectionFormatting
+
 # Page formatting attributes and methods.
 # @author Wesley Hileman
 # @since 1.0.0
@@ -888,25 +1000,60 @@ module RRTF::PageFormatting
         "PORTRAIT" => :portrait,
         "LANDSCAPE" => :landscape
       },
-      "to_rtf" => lambda{ |value| "\\landscape" if value == :landscape }
+      "to_rtf" => lambda do |value, targ|
+        case targ
+        when :document
+          "\\landscape" if value == :landscape
+        when :section
+          "\\lndscpsxn" if value == :landscape
+        end # case
+      end
     },
     "size" => {
       "default" => RRTF::Page::Size.new,
       "from_user" => lambda{ |value| RRTF::Page::Size.new(value) },
-      "to_rtf" => lambda{ |value| "\\paperw#{value.width}\\paperh#{value.height}" }
+      "to_rtf" => lambda do |value, targ|
+        case targ
+        when :document
+          "\\paperw#{value.width}\\paperh#{value.height}"
+        when :section
+          "\\pgwsxn#{value.width}\\pghsxn#{value.height}"
+        end # case
+      end
     },
     "margin" => {
       "default" => RRTF::Page::Margin.new,
       "from_user" => lambda{ |value| RRTF::Page::Margin.new(value) },
-      "to_rtf" => lambda{ |value| "\\margl#{value.left}\\margr#{value.right}\\margt#{value.top}\\margb#{value.bottom}" }
+      "to_rtf" => lambda do |value, targ|
+        case targ
+        when :document
+          "\\margl#{value.left}\\margr#{value.right}\\margt#{value.top}\\margb#{value.bottom}"
+        when :section
+          "\\marglsxn#{value.left}\\margrsnx#{value.right}\\margtsxn#{value.top}\\margbsnx#{value.bottom}"
+        end # case
+      end
     },
     "gutter" => {
       "default" => nil,
       "from_user" => lambda{ |value| RRTF::Utilities.value2twips(value) },
-      "to_rtf" => lambda{ |value| "\\gutter#{value}" unless value.nil? }
+      "to_rtf" => lambda do |value, targ|
+        case targ
+        when :document
+          "\\gutter#{value}" unless value.nil?
+        when :section
+          "\\guttersxn#{value}" unless value.nil?
+        end # case
+      end
     }
   }.freeze
 
+  PAGE_FORMATTING_TARGET_DICTIONARY = {
+    "DOCUMENT"      => :document,
+    "SECTION"       => :section
+  }.freeze
+
+  attr_accessor :target
+
   # Generates attribute accessors for all page attributes when the module
   # is included in another module or class.
   def self.included(base)
@@ -927,7 +1074,9 @@ module RRTF::PageFormatting
   # @option options [String, Page::Size] "size" (Page::Size.new) the size of the paper (object or string; see {Page::Size#initialize}).
   # @option options [String, Page::Margin] "margin" (Page::Margin.new) the paper margin (object or string; see {Page::Margin#initialize}).
   # @option options [String] "gutter" (nil) the page gutter width (specify a string, see {Utilities.value2twips}).
-  def initialize_page_formatting(options = {})
+  def initialize_page_formatting(options = {}, target = "DOCUMENT")
+    @target = PAGE_FORMATTING_TARGET_DICTIONARY[target]
+
     # load default attribute values
     PAGE_ATTRIBUTES.each do |key, options|
       send("#{key}=", options["default"])
@@ -962,27 +1111,11 @@ module RRTF::PageFormatting
     # accumulate RTF representations of page attributes
     PAGE_ATTRIBUTES.each do |key, options|
       if options.has_key?("to_rtf")
-        rtf = options["to_rtf"].call(send(key))
+        rtf = options["to_rtf"].call(send(key), @target)
         text << rtf unless rtf.nil?
       end # if
     end # each
 
     text.string
   end
-
-  def body_width
-     if orientation == :portrait
-        size.width - (margin.left + margin.right)
-     else
-        size.height - (margin.top + margin.bottom)
-     end
-  end
-
-  def body_height
-     if orientation == :portrait
-        size.height - (margin.top + margin.bottom)
-     else
-        size.width - (margin.left + margin.right)
-     end
-  end
 end

data/lib/rrtf/node.rb

@@ -2,6 +2,7 @@ require 'rrtf/node/node'
 require 'rrtf/node/text_node'
 require 'rrtf/node/container_node'
 require 'rrtf/node/command_node'
+require 'rrtf/node/section_node'
 require 'rrtf/node/paragraph_node'
 require 'rrtf/node/list_node'
 require 'rrtf/node/list_level_node'

data/lib/rrtf/node/command_node.rb

@@ -68,6 +68,24 @@ module RRTF
         text.string
      end
 
+     def section(style = nil)
+       # parse style
+       case style
+       when Hash
+         style = SectionStyle.new(style)
+       when SectionStyle
+         # use without modification
+       when nil
+         # allow nil style
+       else
+         RTFError.fire("Invalid section style '#{style}'.")
+       end # case
+
+       node = SectionNode.new(self, style)
+       yield node if block_given?
+       self.store(node)
+     end
+
      # This method provides a short cut means of creating a paragraph command
      # node. The method accepts a block that will be passed a single parameter
      # which will be a reference to the paragraph node created. After the
@@ -84,7 +102,7 @@ module RRTF
      #   rtf.paragraph("bold" => true, "font" => "SWISS:Arial") do |p|
      #     p << "Paragraph formatted with an anonymous style."
      #   end
-     def paragraph(style=nil)
+     def paragraph(style = nil)
        # parse style
        case style
        when Hash
@@ -101,9 +119,9 @@ module RRTF
        style.push_colours(root.colours) unless style.nil?
        style.push_fonts(root.fonts) unless style.nil?
 
-        node = ParagraphNode.new(self, style)
-        yield node if block_given?
-        self.store(node)
+       node = ParagraphNode.new(self, style)
+       yield node if block_given?
+       self.store(node)
      end
 
      # This method provides a short cut means of creating a new ordered or
@@ -146,6 +164,22 @@ module RRTF
         nil
      end
 
+     # This method provides a short cut means of creating a column break command
+     # node. This command node does not take a block and may possess no other
+     # content.
+     def column_break
+        self.store(CommandNode.new(self, '\column', nil, false))
+        nil
+     end
+
+     # This method provides a short cut means of creating a tab command
+     # node. This command node does not take a block and may possess no other
+     # content.
+     def tab
+        self.store(CommandNode.new(self, '\tab', nil, false))
+        nil
+     end
+
      # This method inserts a footnote at the current position in a node.
      #
      # ==== Parameters