rrtf 0.1.1

data/lib/rrtf/style.rb

@@ -0,0 +1,8 @@
+require 'rrtf/style/formatting'
+require 'rrtf/style/style'
+require 'rrtf/style/paragraph_style'
+require 'rrtf/style/character_style'
+require 'rrtf/style/document_style'
+
+module RRTF
+end

data/lib/rrtf/stylesheet.rb

@@ -0,0 +1,202 @@
+require 'stringio'
+
+module RRTF
+
+  # Class that represents a stylesheet in an RTF document
+  class Stylesheet
+    # An array of styles associated with the stylesheet
+    attr_reader :styles
+
+    # The document to which the stylesheet belongs
+    attr_accessor :document
+
+    def initialize(document, options = {})
+      @options = {
+        "styles" => [],
+        "base_style_handle" => 1,
+        "base_style_priority" => 100,
+        "assign_style_handles" => true,
+        "assign_style_priorities" => true
+      }.merge(options)
+      @document = document
+      @next_styles_hash = {}
+      @base_styles_hash = {}
+      @styles = {}
+      add_styles(@options["styles"])
+    end
+
+    def add_styles(hash_array)
+      hash_array.each { |hash| add_style(hash) }
+    end
+
+    def add_style(options)
+      style = options.delete("style")
+      type = options.delete("type")
+      add_options = extract_add_options(options)
+
+      if !style.nil?
+        # style object given; add directly
+        if !add_style_object(style, add_options)
+          RTFError.fire("#{style.to_s} could not be added to the stylesheet (hint: make sure it's a style object).")
+        end # if
+      elsif !type.nil?
+        # style object not given; create based on type
+        case type
+        when "paragraph"
+          add_style_object(ParagraphStyle.new(options), add_options)
+        when "character"
+          add_style_object(CharacterStyle.new(options), add_options)
+        else
+          RTFError.fire("Unreconized style type '#{type.to_s}'.")
+        end # case
+      else
+        RTFError.fire("A style type or style object must be specified for each style in a stylesheet.")
+      end # if
+    end # add_style_from_hash()
+
+    # Converts the stylesheet to its RTF representation
+    # NOTE calling to_rtf causes all next styles to be updated (to_rtf "commits"
+    # the stylesheet)
+    def to_rtf(options = {})
+      # load default options
+      options = {
+        "uglify" => false,
+        "base_indent" => 0,
+        "child_indent" => 0
+      }.merge(options)
+      # build line prefixes
+      newline_prefix = options["uglify"] ? '' : "\n"
+      base_prefix = options["uglify"] ? '' : " "*options["base_indent"]
+
+      # lookup and set next style handles on component styles
+      substitute_next_style_handles()
+      substitute_base_style_handles()
+
+      rtf = StringIO.new
+
+      rtf << "#{base_prefix}{\\stylesheet"
+      @styles.values.each do |style|
+        rtf << newline_prefix
+        rtf << style.to_rtf(
+          document,
+          "uglify" => options["uglify"],
+          "base_indent" => options["base_indent"]+options["child_indent"]
+        )
+      end
+      rtf << "#{newline_prefix}#{base_prefix}}"
+
+      rtf.string
+    end # to_rtf()
+
+    private
+
+    # Strips options used in adding a style to a stylesheet from a hash
+    # and returns a subhash containing those options
+    def extract_add_options(hash)
+      {
+        "id" => hash.delete("id"),
+        "default" => hash.delete("default") || false,
+        "next_style_id" => hash.delete("next_style") || nil,
+        "base_style_id" => hash.delete("base_style") || nil,
+        "assign_handle" => hash.delete("assign_handle") || @options["assign_style_handles"],
+        "assign_priority" => hash.delete("assign_priority") || @options["assign_style_priorities"]
+      }
+    end # extract_add_options()
+
+    # Adds a style object to the stylesheet
+    def add_style_object(style, options = {})
+      # load default options
+      options = {
+        "id" => nil,
+        "default" => false,
+        "next_style_id" => nil,
+        "base_style_id" => nil,
+        "assign_handle" => true,
+        "assign_priority" => true
+      }.merge(options)
+
+      if style.kind_of?(Style)
+        unless @styles.values.index(style).nil?
+          # style already present in stylesheet
+          return true
+        end # unless
+
+        # Verify ID is present and does not conflict with another style's ID
+        if options["id"].nil? || !options["id"].kind_of?(String) || options["id"].length < 1
+          RTFError.fire("All styles in a stylesheet must have unique non-empty string IDs.")
+        elsif !@styles[options["id"]].nil?
+          RTFError.fire("Multiple styles cannot have the same ID '#{style.id}'.")
+        end # if
+
+        # Auto-assign handle to style if nil
+        if style.handle.nil? && options["assign_handle"]
+          if options["default"]
+            # default style takes on the '0' handle
+            style.handle = 0
+          else
+            max_h = @styles.values.collect(&:handle).max
+            base_h = @options["base_style_handle"]
+            style.handle = (max_h || (base_h - 1)) + 1
+          end # if
+        end # if
+
+        # Auto-assign priority if nil
+        if style.priority.nil? && options["assign_priority"]
+          max_p = @styles.values.collect(&:priority).max
+          base_p = @options["base_style_priority"]
+          style.priority = (max_p || (base_p - 1)) + 1
+        end # if
+
+        # Add key in next styles hash if next style given
+        unless options["next_style_id"].nil?
+          @next_styles_hash[options["id"]] = options["next_style_id"]
+        end # unless
+
+        # Add key in base styles hash if next style given
+        unless options["base_style_id"].nil?
+          @base_styles_hash[options["id"]] = options["base_style_id"]
+        end # unless
+
+        # Add style fonts and colours to respective tables
+        style.push_colours(document.colours)
+        style.push_fonts(document.fonts)
+
+        @styles[options["id"]] = style
+        true
+      else
+        false
+      end # if
+    end # add()
+
+    # Sets the "next style" handle on each style based on the entries in
+    # next_styles_hash (when add is called with the next_style_id option,
+    # an entry in the hash is created with the id of the next style; the hash
+    # maps the ids of styles to the ids of the corresponding "next styles")
+    def substitute_next_style_handles
+      @styles.each do |id,style|
+        next_style_id = @next_styles_hash[id]
+        # skip style if there is not a "next style"
+        next if next_style_id.nil?
+        # raise error if the specified "next style" is not defined
+        if @styles[next_style_id].nil?
+          RTFError.fire("'#{next_style_id}' cannot be the next style for '#{id}' because '#{next_style_id}'' has not been added to the stylesheet.")
+        end # if
+        style.next_style_handle = @styles[next_style_id].handle
+      end # styles each
+    end # substitute_next_style_handles()
+
+    def substitute_base_style_handles
+      @styles.each do |id,style|
+        base_style_id = @base_styles_hash[id]
+        # skip style if there is not a base style
+        next if base_style_id.nil?
+        # raise error if the specified base style is not defined
+        if @styles[base_style_id].nil?
+          RTFError.fire("'#{base_style_id}' cannot be the base style for '#{id}' because '#{base_style_id}'' has not been added to the stylesheet.")
+        end # if
+        style.based_on_style_handle = @styles[base_style_id].handle
+      end # styles each
+    end # substitute_next_style_handles()
+  end # class Stylesheet
+
+end # module RRTF

data/lib/rrtf/version.rb

@@ -0,0 +1,3 @@
+module RRTF
+  VERSION = "0.1.1"
+end

data/lib/rrtf.rb

@@ -0,0 +1,27 @@
+require 'rrtf/version'
+require 'rrtf/font'
+require 'rrtf/colour'
+require 'rrtf/style'
+require 'rrtf/stylesheet'
+require 'rrtf/information'
+require 'rrtf/paper'
+require 'rrtf/node'
+require 'rrtf/list'
+
+module RRTF
+    class RTFError < StandardError
+      def initialize(message=nil)
+        super(message == nil ? 'No error message available.' : message)
+      end
+
+      def RTFError.fire(message=nil)
+        raise RTFError.new(message)
+      end
+    end # class RTFError
+
+    class Utilities
+      def self.constantize(string)
+        string.split('::').inject(Object) {|o,c| o.const_get c}
+      end
+    end # class Utilities
+end # module RRTF

data/rrtf.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rrtf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rrtf"
+  spec.version       = RRTF::VERSION
+  spec.authors       = ["Wesley Hileman"]
+  spec.email         = ["whileman133@gmail.com"]
+
+  spec.summary       = %q{A ruby-based rich text format (RTF) document generator.}
+  spec.homepage      = "https://github.com/whileman133/rrtf"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  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 "byebug"
+  # Required for HTML converter functionality
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "tidy"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: rrtf
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Wesley Hileman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-24 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tidy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- whileman133@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/01.rtf
+- examples/01_mac_libreoffice5_2_3_3.png
+- examples/01_mac_pages6_2.png
+- examples/01_mac_textedit1_12.png
+- examples/01_mac_word15_36.png
+- examples/01_styles_and_paragraphs.rb
+- examples/resources/json/redshirt_styles.json
+- lib/rrtf.rb
+- lib/rrtf/colour.rb
+- lib/rrtf/converters.rb
+- lib/rrtf/converters/html.rb
+- lib/rrtf/font.rb
+- lib/rrtf/information.rb
+- lib/rrtf/list.rb
+- lib/rrtf/node.rb
+- lib/rrtf/paper.rb
+- lib/rrtf/style.rb
+- lib/rrtf/style/character_style.rb
+- lib/rrtf/style/document_style.rb
+- lib/rrtf/style/formatting.rb
+- lib/rrtf/style/paragraph_style.rb
+- lib/rrtf/style/style.rb
+- lib/rrtf/stylesheet.rb
+- lib/rrtf/version.rb
+- rrtf.gemspec
+homepage: https://github.com/whileman133/rrtf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A ruby-based rich text format (RTF) document generator.
+test_files: []