rrtf 1.0.0 → 1.3.1

data/lib/rrtf/node/image_node.rb

@@ -1,4 +1,5 @@
 require 'fastimage'
+require 'open-uri'
 
 module RRTF
   # This class represents an image within a RTF document. Currently only the
@@ -60,7 +61,7 @@ module RRTF
      # This is the constructor for the ImageNode class.
      #
      # @param parent [Node] a reference to the node that owns the new image node.
-     # @param source [String, File] a reference to the image source; this must be a String or a File.
+     # @param source [String, File] a reference to the image source; this must be a String, String URL, or a File.
      # @param id [Integer] a unique 32-bit identifier for the image.
      # @param options [Hash] a hash of options.
      # @option options [String] "width" (nil) the display width of the image in twips (can be a string, see {Utilities.value2twips}).
@@ -72,7 +73,7 @@ module RRTF
      #   specified source does not exist or cannot be accessed.
      def initialize(parent, source, id, options = {})
         super(parent)
-        @source = nil
+        @source = source
         @id     = id
 
         # load default options
@@ -95,16 +96,19 @@ module RRTF
         end
 
         # Store path to image.
-        @source = source if source.instance_of?(String) || source.instance_of?(Tempfile)
-        @source = source.path if source.instance_of?(File)
+        if @source.is_a?(String)
+          begin
+            @source = open(@source)
+          rescue OpenURI::HTTPError => error
+            response = error.io
+            RTFError.fire("Could not open '#{@source}'. Server responded with #{response.status.join(',')}.")
+          rescue Exception => error
+            RTFError.fire("Could not open '#{@source}'. #{error.message}.")
+          end # rescue block
+        elsif !@source.respond_to?(:each_byte)
+          RTFError.fire("A string or object that responds to :each_byte must be supplied - '#{@source}' given.")
+        end # unless
 
-        # Check the file's existence and accessibility.
-        if !File.exist?(@source)
-           RTFError.fire("Unable to find the #{File.basename(@source)} file.")
-        end
-        if !File.readable?(@source)
-           RTFError.fire("Access to the #{File.basename(@source)} file denied.")
-        end
         # Attempt to determine image type and dimensions.
         @type, @width, @height = self.class.inspect(@source)
         if @type.nil?
@@ -128,18 +132,16 @@ module RRTF
        text << "\\picw#{@width}\\pich#{@height}\\bliptag#{@id}"
        text << "\\#{@type}\n"
 
-       open_file do |file|
-         file.each_byte do |byte|
-           hex_str = byte.to_s(16)
-           hex_str.insert(0,'0') if hex_str.length == 1
-           text << hex_str
-           count += 1
-           if count == 40
-             text << "\n"
-             count = 0
-           end # if
-         end # each_byte
-       end # open_file
+       @source.each_byte do |byte|
+         hex_str = byte.to_s(16)
+         hex_str.insert(0,'0') if hex_str.length == 1
+         text << hex_str
+         count += 1
+         if count == 40
+           text << "\n"
+           count = 0
+         end # if
+       end # each_byte
        text << "\n}"
 
        text.string
@@ -162,14 +164,6 @@ module RRTF
            [(@width*scale_factor).to_i, (@height*scale_factor).to_i]
          end
        end # case
-     end
-
-     def open_file(&block)
-       if block
-         File.open(@source, 'rb', &block)
-       else
-         File.open(@source, 'rb')
-       end # if
-     end # open_file()
+     end # size_image()
   end # End of the ImageNode class.
 end # module RRTF

data/lib/rrtf/node/section_node.rb

@@ -0,0 +1,21 @@
+module RRTF
+  # This class represents a section within an RTF document. Section nodes
+  # do not contain other nodes; instead, they mark the start of a new section.
+  # @author Wesley Hileman
+  class SectionNode < CommandNode
+    def initialize(parent, style=nil)
+      prefix = '\sect\sectd'
+      prefix << style.prefix(parent.root) unless style.nil?
+
+      super(parent, prefix, '', true, false)
+    end
+
+    # Overrides {ContainerNode#store} to prevent child nodes from being
+    # added to sections.
+    #
+    # @raise [RTFError] whenever called.
+    def store(node)
+      RTFError.fire("Cannot add child nodes to section nodes: tried to add #{node}.")
+    end
+  end
+end

data/lib/rrtf/properties/geometry_properties.rb

@@ -320,10 +320,10 @@ module RRTF
          next if margin.nil?
 
          margin = Page::Margin.new(margin)
-         left = Utilities.value2emu(margin.left+'twip')
-         right = Utilities.value2emu(margin.right+'twip')
-         top = Utilities.value2emu(margin.top+'twip')
-         bottom = Utilities.value2emu(margin.bottom+'twip')
+         left = Utilities.value2emu("#{margin.left}twip")
+         right = Utilities.value2emu("#{margin.right}twip")
+         top = Utilities.value2emu("#{margin.top}twip")
+         bottom = Utilities.value2emu("#{margin.bottom}twip")
 
          instance_variable_set("@#{margin_attr}", margin)
          instance_variable_set("@#{margin_attr}_left", left)

data/lib/rrtf/style.rb

@@ -2,6 +2,8 @@ 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'
+require 'rrtf/style/section_style'

data/lib/rrtf/style/section_style.rb

@@ -0,0 +1,66 @@
+require 'stringio'
+
+module RRTF
+  # This class represents a section style for an RTF document.
+  class SectionStyle < Style
+    include SectionFormatting
+    include PageFormatting
+
+     # This is the constructor for the SectionStyle class.
+     #
+     # @param [Hash] options the section style options.
+     # @option options (see Style#initialize)
+     # @option options (see SectionFormatting#initialize_section_formatting)
+     # @option options (see PageFormatting#initialize_page_formatting)
+     def initialize(options = {})
+        super(options)
+        initialize_section_formatting(options)
+        initialize_page_formatting(options)
+     end
+
+     # Converts the stylesheet character style into its RTF representation
+     # (for stylesheet)
+     def to_rtf(document, options = {})
+       # load default options
+       options = {
+         "uglify" => false,
+         "base_indent" => 0
+       }.merge(options)
+       # build formatting helpers
+       base_prefix = options["uglify"] ? '' : ' '*options["base_indent"]
+       name_prefix = options["uglify"] ? ' ' : ''
+       suffix = options["uglify"] ? '' : ' '
+
+       rtf = StringIO.new
+
+       rtf << base_prefix
+       rtf << "{\\*\\ds#{handle}#{suffix}"
+       rtf << "#{rtf_formatting(document)}#{suffix}"
+       rtf << "\\additive#{suffix}" if @additive
+       rtf << "\\sbasedon#{@based_on_style_handle}#{suffix}" unless @based_on_style_handle.nil?
+       rtf << "\\sautoupd#{suffix}" if @auto_update
+       rtf << "\\snext#{@next_style_handle}#{suffix}" unless @next_style_handle.nil?
+       rtf << "\\sqformat#{suffix}" if @primary
+       rtf << "\\spriority#{@priority}#{suffix}" unless @priority.nil?
+       rtf << "\\shidden#{suffix}" if @hidden
+       rtf << "#{name_prefix}#{name};}"
+
+       rtf.string
+     end
+
+     # This method generates a string containing the prefix associated with the
+     # style object.
+     def prefix(document)
+       text = StringIO.new
+
+       text << "\\ds#{handle} " unless handle.nil?
+       text << rtf_formatting
+
+       text.string
+     end
+
+     def rtf_formatting
+       "#{section_formatting_to_rtf} #{page_formatting_to_rtf}"
+     end
+  end # End of the CharacterStyle class.
+end # module RRTF

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.0.0"
+  VERSION = "1.3.1"
 end

data/rrtf.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
   spec.add_development_dependency "byebug"
   # Required for HTML converter functionality
   spec.add_dependency "nokogiri"

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: rrtf
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Wesley Hileman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -231,6 +235,10 @@ files:
 - examples/09_shapes.rb
 - examples/10.rtf
 - 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
@@ -257,6 +265,7 @@ files:
 - lib/rrtf/node/list_text_node.rb
 - lib/rrtf/node/node.rb
 - lib/rrtf/node/paragraph_node.rb
+- lib/rrtf/node/section_node.rb
 - lib/rrtf/node/table_cell_node.rb
 - lib/rrtf/node/table_node.rb
 - lib/rrtf/node/table_row_node.rb
@@ -274,8 +283,10 @@ files:
 - lib/rrtf/style/character_style.rb
 - lib/rrtf/style/paragraph_style.rb
 - lib/rrtf/style/position_style.rb
+- 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
@@ -299,8 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A ruby-based rich text format (RTF) document generator.