rrtf 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3467d6a2c8f2088bea129baf92e38489313e095a
+  data.tar.gz: e747dbf2f17843d3774d064d7de258b810c03744
+SHA512:
+  metadata.gz: 25846effd9f89636439d227ab600633b50e76ee5a8554bd925367eca05350def4d32b0004dfeaa9d28bfc944270f26d8f1ada2a67b60bf3a3f286f478fc861c2
+  data.tar.gz: 1e6372a0cc1ada21f428d7b7798690e435029e2e17a88d9690d17b7b7063bc0671faceddcc80087018d399d6ca60b122b0010958e34de9d5c6bf7bd87dd46e3b

data/.byebug_history

@@ -0,0 +1,4 @@
+next
+document
+next
+document

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rrtf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,45 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Wesley Hileman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+
+Copyright (c) 2009 Peter Wood
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,110 @@
+# RRTF: Ruby Rich-Text-Format Document Generator
+
+RRTF enables programatic creation of Rich Text Format (RTF) documents in Ruby, focusing on simplifying RTF document assembly and generating clean RTF source code. This gem is founded on the [ifad-rtf gem](https://github.com/clbustos/rtf), but differs in several respects:
+
+- The syntax for creating documents and styles is simpler.
+- Paragraph styles can take on character formatting attributes (in accord to the RTF specification).
+- Document stylesheets can be defined, enabling the end user to easily modify the look larger RTF documents.
+
+The gem was created with reference to the [Microsoft Office RTF Specification (v1.9.1)](https://www.microsoft.com/en-us/download/details.aspx?id=10725).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rrtf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rrtf
+
+## Usage
+
+Define the paragraph and character styles your document is to leverage in
+a hashmap array or JSON file:
+
+```json
+[
+  {
+    "type": "paragraph",
+    "id": "TITLE",
+    "name": "Title",
+    "primary": true,
+    "next_style": "BODY",
+    "justification": "CENTER",
+    "space_after": 100,
+    "bold": true,
+    "underline": "DOUBLE",
+    "uppercase": true,
+    "font_size": 36,
+    "underline_color": "#ff0000"
+  },
+  {
+    "type": "paragraph",
+    "id": "BODY",
+    "name": "Body",
+    "primary": true,
+    "justification": "LEFT",
+    "font_size": 24,
+    "hyphenate": true
+  },
+  {
+    "type": "character",
+    "id": "EMPH",
+    "name": "Emphasis",
+    "additive": true,
+    "italic": true,
+    "bold": true,
+    "foreground_color": "#ff0000"
+  }
+]
+```
+
+(Note that font size is given in _half points_ and spacing in _twentieth points_, or "twips" using the somewhat disagreeable abbreviation, in accord with the RTF specification.)
+
+Create a RTF document object using the settings needed for your document, then build your document and save it in an RTF file:
+
+```ruby
+require 'rrtf'
+require 'JSON'
+
+raw_styles = JSON.parse File.read('styles.json')
+
+rtf = RRTF::Document.new("stylesheet" => raw_styles)
+styles = rtf.stylesheet.styles
+
+rtf.paragraph(styles['TITLE']) << "RedShirts 101"
+rtf.paragraph(styles['BODY']) do |p|
+  p << "Should you ever find yourself on a spacefaring vessel wearing a"
+  p.apply(styles['EMPH']) << " red "
+  p << "shirt, take heed and be on guard, for danger is immanent and you are "
+  p << "likely expendable among the crew..."
+end
+
+File.open('01.rtf', 'w') do |file|
+   file.write(rtf.to_rtf)
+end
+```
+
+![Opened in Word 2016](examples/01_mac_word15_36.png "Opened in Word 2016")
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/whileman133/rrtf.
+
+
+## License
+
+Just like ifad-rtf, this gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rrtf"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/01.rtf

@@ -0,0 +1,45 @@
+{\rtf1\ansi\deff0\deflang1033\plain\fs24\fet1
+{\fonttbl
+{\f0\fswiss Helvetica;}
+}
+{\colortbl
+;
+\red255\green0\blue0;
+}
+{\stylesheet
+{\s1 \qc\sa100\ltrpar \b\uldb\caps\ulc1\fs36 \sbasedon3 \sautoupd \snext3 \sqformat \spriority100 Title;}
+{\s2 \ql\sb200\sa40\ltrpar \b\ul\ulc1\fs24 \snext3 \sqformat \spriority101 Heading 1;}
+{\s3 \ql\hyphpar\ltrpar \fs24 \sqformat \spriority102 Body;}
+{\*\cs4 \b\i\cf1 \additive \spriority103 Emphasis;}
+}
+{\info
+{\createim\yr2017\mo7\dy23\hr19\min18}
+}
+
+\stylesortmethod1\paperw12247\paperh15819\margl1800\margr1800\margt1440\margb1440
+{\pard\s1 \qc\sa100\ltrpar \b\uldb\caps\ulc1\fs36
+RedShirts 101
+\par}
+{\pard\s3 \ql\hyphpar\ltrpar \fs24
+Should you ever find yourself on a spacefaring vessel wearing a
+{\cs4 \b\i\cf1
+ red 
+}
+shirt, take heed and be on guard, for danger is immanent and you are likely expendable among the crew...
+\par}
+{\pard\s2 \ql\sb200\sa40\ltrpar \b\ul\ulc1\fs24
+1. The Danger of Away Missions
+\par}
+{\pard\s3 \ql\hyphpar\ltrpar \fs24
+If you're ever assigned an away mission, its almost certian to be your doom. The optimal stategy is to avoid away missions to begin with...
+\par}
+{\pard\s2 \ql\sb200\sa40\ltrpar \b\ul\ulc1\fs24
+2. Avoiding High-Ranking Officers
+\par}
+{\pard\s3 \ql\hyphpar\ltrpar \fs24
+You're likely to notice an influx of unfortunate outcomes around certian high-ranking officers. Its to your advantage to quickly identify and avoid these officers...
+\par}
+{\pard\s2 \ql\sb200\sa40\ltrpar \b\ul\ulc1\fs24
+3. Miscellaneous Hazards
+\par}
+}

data/examples/01_styles_and_paragraphs.rb

@@ -0,0 +1,33 @@
+require 'rrtf'
+require 'JSON'
+
+DIR = File.dirname(__FILE__)
+
+raw_styles = JSON.parse File.read(DIR+'/resources/json/redshirt_styles.json')
+
+rtf = RRTF::Document.new("stylesheet" => raw_styles)
+styles = rtf.stylesheet.styles
+
+rtf.paragraph(styles['TITLE']) << "RedShirts 101"
+rtf.paragraph(styles['BODY']) do |p|
+  p << "Should you ever find yourself on a spacefaring vessel wearing a"
+  p.apply(styles['EMPH']) << " red "
+  p << "shirt, take heed and be on guard, for danger is immanent and you are "
+  p << "likely expendable among the crew..."
+end
+rtf.paragraph(styles['H1']) << "1. The Danger of Away Missions"
+rtf.paragraph(styles['BODY']) do |p|
+  p << "If you're ever assigned an away mission, its almost certian to be your doom. "
+  p << "The optimal stategy is to avoid away missions to begin with..."
+end
+rtf.paragraph(styles['H1']) << "2. Avoiding High-Ranking Officers"
+rtf.paragraph(styles['BODY']) do |p|
+  p << "You're likely to notice an influx of unfortunate outcomes around "
+  p << "certian high-ranking officers. Its to your advantage to quickly identify and "
+  p << "avoid these officers..."
+end
+
+
+File.open(DIR+'/01.rtf', 'w') do |file|
+   file.write(rtf.to_rtf)
+end

data/examples/resources/json/redshirt_styles.json

@@ -0,0 +1,49 @@
+[
+  {
+    "type": "paragraph",
+    "id": "TITLE",
+    "name": "Title",
+    "primary": true,
+    "auto_update": true,
+    "next_style": "BODY",
+    "base_style": "BODY",
+    "justification": "CENTER",
+    "space_after": 100,
+    "bold": true,
+    "underline": "DOUBLE",
+    "underline_color": "#ff0000",
+    "uppercase": true,
+    "font_size": 36
+  },
+  {
+    "type": "paragraph",
+    "id": "H1",
+    "name": "Heading 1",
+    "primary": true,
+    "next_style": "BODY",
+    "space_after": 40,
+    "space_before": 200,
+    "underline": "SINGLE",
+    "underline_color": "#ff0000",
+    "bold": true,
+    "font_size": 24
+  },
+  {
+    "type": "paragraph",
+    "id": "BODY",
+    "name": "Body",
+    "primary": true,
+    "justification": "LEFT",
+    "font_size": 24,
+    "hyphenate": true
+  },
+  {
+    "type": "character",
+    "id": "EMPH",
+    "name": "Emphasis",
+    "additive": true,
+    "italic": true,
+    "bold": true,
+    "foreground_color": "#ff0000"
+  }
+]

data/lib/rrtf/colour.rb

@@ -0,0 +1,182 @@
+require 'stringio'
+
+module RRTF
+   # This class represents a colour within a RTF document.
+   class Colour
+      # Attribute accessor.
+      attr_reader :red, :green, :blue
+
+
+      # Format: HEX RGB with '#' prefix
+      def self.from_string(str)
+        if str =~ /\#[0-9a-f]{6}/i
+          m = str.match /([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})/i
+          self.new(m[1].hex, m[2].hex, m[3].hex)
+        else
+          RTFError.fire("Unreconized string colour format '#{str}'.")
+        end
+      end
+
+
+      # This is the constructor for the Colour class.
+      #
+      # ==== Parameters
+      # red::    The intensity setting for red in the colour. Must be an
+      #          integer between 0 and 255.
+      # green::  The intensity setting for green in the colour. Must be an
+      #          integer between 0 and 255.
+      # blue::   The intensity setting for blue in the colour. Must be an
+      #          integer between 0 and 255.
+      #
+      # ==== Exceptions
+      # RTFError::  Generated whenever an invalid intensity setting is
+      #             specified for the red, green or blue values.
+      def initialize(red, green, blue)
+         if !red.kind_of?(Integer) || red < 0 || red > 255
+            RTFError.fire("Invalid red intensity setting ('#{red}') specified "\
+                          "for a Colour object.")
+         end
+         if !green.kind_of?(Integer) || green < 0 || green > 255
+            RTFError.fire("Invalid green intensity setting ('#{green}') "\
+                          "specified for a Colour object.")
+         end
+         if !blue.kind_of?(Integer) || blue < 0 || blue > 255
+            RTFError.fire("Invalid blue intensity setting ('#{blue}') "\
+                          "specified for a Colour object.")
+         end
+
+         @red   = red
+         @green = green
+         @blue  = blue
+      end
+
+      # This method overloads the comparison operator for the Colour class.
+      #
+      # ==== Parameters
+      # object::  A reference to the object to be compared with.
+      def ==(object)
+         object.instance_of?(Colour) and
+         object.red   == @red and
+         object.green == @green and
+         object.blue  == @blue
+      end
+
+      # This method returns a textual description for a Colour object.
+      #
+      # ==== Parameters
+      # indent::  The number of spaces to prefix to the lines created by the
+      #           method. Defaults to zero.
+      def to_s(indent=0)
+         prefix = indent > 0 ? ' ' * indent : ''
+         "#{prefix}Colour (#{@red}/#{@green}/#{@blue})"
+      end
+
+      # This method generates the RTF text for a Colour object.
+      #
+      # ==== Parameters
+      # indent::  The number of spaces to prefix to the lines created by the
+      #           method. Defaults to zero.
+      def to_rtf(indent=0)
+         prefix = indent > 0 ? ' ' * indent : ''
+         "#{prefix}\\red#{@red}\\green#{@green}\\blue#{@blue};"
+      end
+   end # End of the Colour class.
+
+
+   # This class represents a table of colours used within a RTF document. This
+   # class need not be directly instantiated as it will be used internally by,
+   # and can be obtained from a Document object.
+   class ColourTable
+      # This is the constructor for the ColourTable class.
+      #
+      # ==== Parameters
+      # *colours::  An array of zero or more colours that make up the colour
+      #             table entries.
+      def initialize(*colours)
+         @colours = []
+         colours.each {|colour| add(colour)}
+      end
+
+      # This method fetches a count of the number of colours within a colour
+      # table.
+      def size
+         @colours.size
+      end
+
+      # This method adds a new colour to a ColourTable object. If the colour
+      # already exists within the table or is not a Colour object then this
+      # method does nothing.
+      #
+      # ==== Parameters
+      # colour::  The colour to be added to the table.
+      def add(colour)
+         if colour.instance_of?(Colour)
+            @colours.push(colour) if @colours.index(colour).nil?
+         end
+         self
+      end
+
+      # This method iterates over the contents of a ColourTable object. This
+      # iteration does not include the implicit default colour entry.
+      def each
+         if block_given?
+            @colours.each {|colour| yield colour}
+         end
+      end
+
+      # This method overloads the array dereference operator for the ColourTable
+      # class. It is not possible to dereference the implicit default colour
+      # using this method. An invalid index will return a nil value.
+      #
+      # ==== Parameters
+      # index::  The index of the colour to be retrieved.
+      def [](index)
+         @colours[index]
+      end
+
+      # This method retrieves the index of a specified colour within the table.
+      # If the colour doesn't exist within the table then nil is returned. It
+      # should be noted that the index of a colour will be one more than its
+      # order of entry to account for the implicit default colour entry.
+      #
+      # ==== Parameters
+      # colour::  The colour to retrieve the index of.
+      def index(colour)
+         index = @colours.index(colour)
+         index.nil? ? index : index + 1
+      end
+
+      # This method generates a textual description for a ColourTable object.
+      #
+      # ==== Parameters
+      # indent::  The number of spaces to prefix to the lines generated by the
+      #           method. Defaults to zero.
+      def to_s(indent=0)
+         prefix = indent > 0 ? ' ' * indent : ''
+         text   = StringIO.new
+
+         text << "#{prefix}Colour Table (#{@colours.size} colours)"
+         @colours.each {|colour| text << "\n#{prefix}   #{colour}"}
+
+         text.string
+      end
+
+      # This method generates the RTF text for a ColourTable object.
+      #
+      # ==== Parameters
+      # indent::  The number of spaces to prefix to the lines generated by the
+      #           method. Defaults to zero.
+      def to_rtf(indent=0)
+         prefix = indent > 0 ? ' ' * indent : ''
+         text   = StringIO.new
+
+         text << "#{prefix}{\\colortbl\n#{prefix};"
+         @colours.each {|colour| text << "\n#{prefix}#{colour.to_rtf}"}
+         text << "\n#{prefix}}"
+
+         text.string
+      end
+
+      alias << add
+   end # End of the ColourTable class.
+end # End of the RTF module.

data/lib/rrtf/converters/html.rb

@@ -0,0 +1,123 @@
+require 'nokogiri'
+require 'tidy'
+
+module RRTF::Converters
+  class HTML
+
+    def initialize(html, options = {})
+      html  = options[:noclean] ? html : clean(html, options[:tidy_options] || {})
+      @html = Nokogiri::HTML::Document.parse(html)
+    end
+
+    def to_rtf(options = {})
+      to_rtf_document(options).to_rtf
+    end
+
+    def to_rtf_document(options = {})
+      font  = Helpers.font(options[:font] || :default)
+      nodes = NodeSet.new @html.css('body').children
+
+      RRTF::Document.new(font).tap do |rtf|
+        nodes.to_rtf(rtf)
+      end
+    end
+
+    protected
+      def clean(html, options = {})
+        defaults = {
+          :doctype          => 'omit',
+          :bare             => true,
+          :clean            => true,
+          :drop_empty_paras => true,
+          :logical_emphasis => true,
+          :lower_literals   => true,
+          :merge_spans      => 1,
+          :merge_divs       => 1,
+          :output_html      => true,
+          :indent           => 0,
+          :wrap             => 0,
+          :char_encoding    => 'utf8'
+        }
+
+        tidy = Tidy.new defaults.merge(options)
+        tidy.clean(html)
+      end
+
+    module Helpers
+      extend self
+
+      def font(key)
+        RRTF::Font.new(*case key
+          when :default   then [RTF::Font::ROMAN,  'Times New Roman']
+          when :monospace then [RTF::Font::MODERN, 'Courier New'    ]
+        end)
+      end
+
+      def style(key)
+        RRTF::CharacterStyle.new.tap do |style|
+          case key.to_sym
+          when :h1
+            style.font_size = 44
+            style.bold = true
+          when :h2
+            style.font_size = 36
+            style.bold = true
+          when :h3
+            style.font_size = 28
+            style.bold = true
+          when :h4
+            style.font_size = 22
+            style.bold = true
+          end
+        end
+      end
+    end
+
+    class NodeSet
+      def initialize(nodeset)
+        @nodeset = nodeset
+      end
+
+      def to_rtf(rtf)
+        @nodeset.each do |node|
+          Node.new(node).to_rtf(rtf)
+        end
+      end
+    end
+
+    class Node # :nodoc:
+      def initialize(node)
+        @node = node
+      end
+
+      def to_rtf(rtf)
+        case @node.name
+        when 'text'                   then rtf << @node.text.gsub(/\n+/, ' ').strip
+        when 'br'                     then rtf.line_break
+        when 'b', 'strong'            then rtf.bold &recurse
+        when 'i', 'em', 'cite'        then rtf.italic &recurse
+        when 'u'                      then rtf.underline &recurse
+        when 'blockquote', 'p', 'div' then rtf.paragraph &recurse
+        when 'span'                   then recurse.call(rtf)
+        when 'sup'                    then rtf.subscript &recurse
+        when 'sub'                    then rtf.superscript &recurse
+        when 'ul'                     then rtf.list :bullets, &recurse
+        when 'ol'                     then rtf.list :decimal, &recurse
+        when 'li'                     then rtf.item &recurse
+        when 'a'                      then rtf.link @node[:href], &recurse
+        when 'h1', 'h2', 'h3', 'h4'   then rtf.apply(Helpers.style(@node.name), &recurse); rtf.line_break
+        when 'code'                   then rtf.font Helpers.font(:monospace), &recurse
+        else
+          #puts "Ignoring #{@node.to_html}"
+        end
+
+        return rtf
+      end
+
+      def recurse
+        lambda {|rtf| NodeSet.new(@node.children).to_rtf(rtf)}
+      end
+    end
+
+  end
+end

data/lib/rrtf/converters.rb

@@ -0,0 +1,5 @@
+require 'rrtf'
+module RRTF::Converters
+  # Empty, for now
+end
+require 'rrtf/converters/html'