rrtf 1.2.0 → 1.3.0

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/11.rtf

@@ -3,16 +3,17 @@
 {\f0\fswiss Helvetica;}
 }
 {\info
-{\createim\yr2017\mo8\dy2\hr9\min41}
+{\createim\yr2017\mo8\dy2\hr22\min31}
 }
 
 \hyphauto1\paperw12247\paperh15819\margl1440\margr1440\margt1440\margb1440
-{\pard
-Redshirt Pocket Guide
-\par}
-\sect\sectd\cols2 \paperw12247\paperh15819\margl1440\margr1440\margt1440\margb1440
-
-{\pard
-Section Text
+{\pard\ql\ltrpar\rqr\tldot\tx2880
+Engineers
+{\tab}
+10
+{\line}
+Redshirts
+{\tab}
+100
 \par}
 }

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
 

data/lib/rrtf/node/command_node.rb

@@ -172,6 +172,14 @@ module RRTF
         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

data/lib/rrtf/style.rb

@@ -2,6 +2,7 @@ require 'rrtf/style/anonymous_style'
 require 'rrtf/style/border_style'
 require 'rrtf/style/position_style'
 require 'rrtf/style/shading_style'
+require 'rrtf/style/tab_style'
 require 'rrtf/style/style'
 require 'rrtf/style/paragraph_style'
 require 'rrtf/style/character_style'

data/lib/rrtf/style/tab_style.rb

@@ -0,0 +1,55 @@
+require 'stringio'
+
+module RRTF
+  # Represents a set of formatting that can be applied to paragraph and table
+  # borders
+  class TabStyle < AnonymousStyle
+
+    TYPE_DICTIONARY = {
+      "FLUSH_RIGHT"     => 'rqr',
+      "CENTERED"        => 'tqc',
+      "DECIMAL"         => 'tqdec'
+    }.freeze
+
+    LEADER_DICTIONARY = {
+      "DOT"             => 'tldot',
+      "MIDDLE_DOT"      => 'tlmdot',
+      "HYPHEN"          => 'tlhyph',
+      "UNDERLINE"       => 'tlul',
+      "THICK_LINE"      => 'tlth',
+      "EQUAL"           => 'tleq'
+    }.freeze
+
+    attr_accessor :type, :leader, :position
+
+    # This is the constructor for the BorderStyle class.
+    #
+    # @param [Hash] options the tab style options.
+    # @option options (see AnonymousStyle#initialize)
+    # @option options [String] "type" (nil) the tab type ("FLUSH_RIGHT", "CENTERED", or "DECIMAL").
+    # @option options [String] "leader" (nil) the leader type ("DOT", "MIDDLE_DOT","HYPHEN", "UNDERLINE", "THICK_LINE", or "EQUAL").
+    # @option options [String, Integer] "position" (720) the position of the tab stop from the left margin in twips (can be a string, see {Utilities.value2twips}).
+    def initialize(options = {})
+       super(options)
+       @type = TYPE_DICTIONARY[options.delete("type")]
+       @leader = LEADER_DICTIONARY[options.delete("leader")]
+       @position = Utilities.value2twips(options.delete("position")) || 720
+    end
+
+    # This method generates a string containing the prefix associated with the
+    # style object. Equivalent to {#rtf_formatting} for the TabStyle class.
+    def prefix(document)
+      rtf_formatting
+    end
+
+    def rtf_formatting
+      rtf = StringIO.new
+
+      rtf << "\\#{@type}"       unless @type.nil?
+      rtf << "\\#{@leader}"     unless @leader.nil?
+      rtf << "\\tx#{@position}"
+
+      rtf.string
+    end
+  end # class TabStyle
+end # module RRTF

data/lib/rrtf/version.rb

@@ -1,3 +1,3 @@
 module RRTF
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rrtf
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Wesley Hileman
@@ -188,10 +188,14 @@ files:
 - documentation/RRTF/PositionStyle.html
 - documentation/RRTF/Properties.html
 - documentation/RRTF/RTFError.html
+- documentation/RRTF/SectionFormatting.html
+- documentation/RRTF/SectionNode.html
+- documentation/RRTF/SectionStyle.html
 - documentation/RRTF/ShadingFormatting.html
 - documentation/RRTF/ShadingStyle.html
 - documentation/RRTF/Style.html
 - documentation/RRTF/Stylesheet.html
+- documentation/RRTF/TabStyle.html
 - documentation/RRTF/TableCellNode.html
 - documentation/RRTF/TableNode.html
 - documentation/RRTF/TableRowNode.html
@@ -233,6 +237,8 @@ files:
 - examples/10_stylesheet.rb
 - examples/11.rtf
 - examples/11_sections.rb
+- examples/12.rtf
+- examples/12_tabs.rb
 - examples/resources/images/redshirt.png
 - examples/resources/images/redshirts.jpg
 - examples/resources/json/redshirt_styles.json
@@ -280,6 +286,7 @@ files:
 - lib/rrtf/style/section_style.rb
 - lib/rrtf/style/shading_style.rb
 - lib/rrtf/style/style.rb
+- lib/rrtf/style/tab_style.rb
 - lib/rrtf/stylesheet.rb
 - lib/rrtf/utilities.rb
 - lib/rrtf/version.rb